Feat: add auth subroutes capabilities by IA-PieroCV · Pull Request #1056 · sparckles/Robyn

IA-PieroCV · 2024-11-26T07:59:54Z

Description

This PR fixes #708

Summary

This PR does handle authentication for subroutes having different levels of precedence:

Endpoint decorators have highest precedence.
include_router has the second highest precedence.
SubRoute instance has the lowest precedence.
If None of the above is specified, the default is False.

This PR change auth logic:

It does add an auth_required parameter for Route objects.
The authentication middleware is evaluated first and added before starting the server.
- This ensures that precedence is made correctly.

Several integration tests were provided. MDX documentation was also updated. To be discussed on #1026

PR Checklist

Please ensure that:

The PR contains a descriptive title
The PR contains a descriptive summary of the changes
You build and test your changes before submitting a PR.
You have added relevant documentation
You have added relevant tests. We prefer integration tests wherever possible

Pre-Commit Instructions:

Ensure that you have run the pre-commit hooks on your PR.

vercel · 2024-11-26T08:00:00Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
robyn	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 26, 2024 8:00am

sansyrox · 2024-11-26T19:31:51Z

Hey @IA-PieroCV 👋

Is the PR still a WIP? Or is it up for review?

IA-PieroCV · 2024-11-26T19:48:15Z

Hey @sansyrox !
I set this PR as draft because I don't really know if the proposal of precedence is correct. I'll change it to "ready for review" in order you to review it. It's functional, but as I said, it changes the way how the authentication register the auth middlewares. Let me know any observation!

sansyrox · 2024-11-26T22:32:33Z

docs_src/src/pages/documentation/api_reference/views.mdx

+def default_secured(request : Request) -> str:
+    return "Authentication is set by include_router!"
+
+app.include_router(sub_router, auth_required=True)


Hey @IA-PieroCV 👋

Thank you for the PR 😄 Overall I like the theme of the PR but will have to a review of the code.

However, why do we need an auth_required flag in include_router? Is it not the same as the SubRouter Class?

Yes, actually it is!
This is just to give developers options for including auth_required due to their own criteria.
Of course we can remove any of the auth_required instance level parameters, from include_router or the SubRoute object instance.

However, include_router have higher precedence. My logic here is because developers face this method more often than the instantiation of the SubRoute. The same logic for endpoint decorators.

@IA-PieroCV , apologies for the late revert. But, I think this is a redundancy. If someone wants to allow auth, they can do it the subrouter class. I'd suggest that we remove it from here.

Let me know if you have anymore thoughts 😄

sansyrox · 2024-12-25T01:57:05Z

docs_src/src/pages/documentation/api_reference/views.mdx

+
+> **Important**: If any of these methods are used, the authentication for the endpoint is set to `False` unless explicitly overridden.
+
+---


I don't think we need this. Right?

sansyrox · 2024-12-25T01:59:38Z

integration_tests/base_routes.py

+    app.include_router(sub_router)
+    app.include_router(di_subrouter)
+    app.include_router(auth_subrouter_endpoint)
+    app.include_router(auth_subrouter_include, auth_required=True)
+    app.include_router(auth_subrouter_instance)
+    app.include_router(auth_subrouter_include_false, auth_required=False)
+    app.include_router(auth_subrouter_include_true, auth_required=True)


@IA-PieroCV , I believe auth_required should either be removed from include_router or the SubRouter() class

@sansyrox @IA-PieroCV
i also think that auth_required should be in SubRouter than in include_router

I was also thinking to create new PR to provide auth_required functionality for all routes under a single router
so user just don't have to set auth_required to every end point, if they want then they can explicitly override the default auth_required setting set by the router, on endpoint itself

sansyrox · 2024-12-25T01:59:53Z

integration_tests/subroutes/auth_subroutes.py

I really like all the test cases!!

sansyrox · 2024-12-25T02:01:53Z

robyn/router.py

+        def inner_handler(request: Request, *args):
+            if not self.authentication_handler:
+                raise AuthenticationNotConfiguredError()
+            identity = self.authentication_handler.authenticate(request)
+            if identity is None:
+                return self.authentication_handler.unauthorized_response
+            request.identity = identity
+            return request  # Proceed to the next middleware or handler
+
+        self.add_route(
+            MiddlewareType.BEFORE_REQUEST,
+            endpoint,
+            inner_handler,
+            injected_dependencies,
+        )


sansyrox

Hey @IA-PieroCV 👋

Thank you for the PR 😄

Overall the changes look great. I just have some suggestions/comments 😄

Merry shipmas! 🎄

recurseml · 2025-05-27T19:24:12Z

⚠️ Only 5 files will be analyzed due to processing limits.

recurseml · 2025-05-27T19:24:23Z

⚠️ Only 5 files will be analyzed due to processing limits.

recurseml · 2025-05-27T19:27:38Z

✨ No issues found! Your code is sparkling clean! ✨

IA-PieroCV added 2 commits November 26, 2024 02:14

feat: add subroute support with precedence level

f3dea14

docs: add authentication docs

6e8f7cf

vercel bot deployed to Preview November 26, 2024 08:00 View deployment

IA-PieroCV marked this pull request as ready for review November 26, 2024 19:48

sansyrox reviewed Nov 26, 2024

View reviewed changes

IA-PieroCV mentioned this pull request Dec 3, 2024

Feat: add async support for auth handler #1045

Draft

6 tasks

sansyrox reviewed Dec 25, 2024

View reviewed changes

integration_tests/subroutes/auth_subroutes.py

Copy link

Member

sansyrox Dec 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like all the test cases!!

sansyrox reviewed Dec 25, 2024

View reviewed changes

sansyrox force-pushed the main branch 5 times, most recently from 07f28de to 0b766c9 Compare January 7, 2025 01:44

sansyrox force-pushed the main branch from 7203268 to 46880c3 Compare January 21, 2025 19:07

sansyrox force-pushed the main branch from 99d413c to e4008f2 Compare June 17, 2025 14:29

sansyrox force-pushed the main branch from 18568e9 to c98d3a0 Compare July 23, 2025 12:49

sansyrox force-pushed the main branch 3 times, most recently from 5fb08e0 to 0472e42 Compare February 15, 2026 06:39


		> Important: If any of these methods are used, the authentication for the endpoint is set to `False` unless explicitly overridden.

		---

Uh oh!

Conversation

IA-PieroCV commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary

PR Checklist

Pre-Commit Instructions:

Uh oh!

vercel bot commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sansyrox commented Nov 26, 2024

Uh oh!

IA-PieroCV commented Nov 26, 2024

Uh oh!

sansyrox Nov 26, 2024

Choose a reason for hiding this comment

Uh oh!

IA-PieroCV Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sansyrox Dec 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sansyrox Dec 25, 2024

Choose a reason for hiding this comment

Uh oh!

sansyrox Dec 25, 2024

Choose a reason for hiding this comment

Uh oh!

thePromger May 23, 2025

Choose a reason for hiding this comment

Uh oh!

sansyrox Dec 25, 2024

Choose a reason for hiding this comment

Uh oh!

sansyrox Dec 25, 2024

Choose a reason for hiding this comment

Uh oh!

sansyrox left a comment

Choose a reason for hiding this comment

Uh oh!

recurseml bot commented May 27, 2025

Uh oh!

recurseml bot commented May 27, 2025

Uh oh!

recurseml bot commented May 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

IA-PieroCV commented Nov 26, 2024 •

edited

Loading

vercel bot commented Nov 26, 2024 •

edited

Loading

IA-PieroCV Nov 27, 2024 •

edited

Loading

sansyrox Dec 22, 2024 •

edited

Loading