feat(context_url): add context url to caller

Author: jbarreau

src/agent_toolkit/forestadmin/agent_toolkit/resources/collections/decorators.py

@@ -1,4 +1,5 @@
 from typing import Any, Awaitable, Callable, TypeVar, Union
+from urllib.parse import unquote
 
 from forestadmin.agent_toolkit.resources.collections.base_collection_resource import BaseCollectionResource
 from forestadmin.agent_toolkit.resources.collections.filter import parse_timezone
@@ -42,6 +43,10 @@ async def _authenticate(
     except JWTError:
         return Response(status=401)
 
+    context_url = None
+    if "Forest-Context-Url" in request.headers:
+        context_url = unquote(request.headers["Forest-Context-Url"])
+
     request.user = User(
         rendering_id=int(user["rendering_id"]),
         user_id=int(user["id"]),
@@ -51,6 +56,7 @@ async def _authenticate(
         last_name=user["last_name"],
         team=user["team"],
         timezone=parse_timezone(request),
+        context_url=context_url,
     )
     return await decorated_fn(self, request)
 

src/agent_toolkit/forestadmin/agent_toolkit/utils/context.py

@@ -32,6 +32,7 @@ class User:
     last_name: str
     team: str
     timezone: ZoneInfo
+    context_url: Optional[str]
     # permission_level
     # role
 

src/agent_toolkit/tests/resources/collections/test_decorators.py

@@ -183,6 +183,39 @@ async def _decorated_fn(resource, request):
 
         self.assertEqual(response, True)
 
+    def test_should_parse_forest_context_url_if_present(self):
+        user = {
+            "rendering_id": "1",
+            "id": "1",
+            "tags": {"test": "tag"},
+            "email": "user@company.com",
+            "first_name": "first_name",
+            "last_name": "last_name",
+            "team": "best_team",
+        }
+        encoded_user = jwt.encode(user, "auth_secret")
+        request = RequestCollection(
+            RequestMethod.GET,
+            self.book_collection,
+            body=None,
+            query={"timezone": "Europe/Paris"},
+            headers={
+                "Authorization": f"Bearer {encoded_user}",
+                "Forest-Context-Url": "http://localhost/?param%3D%2Ftest%2F",
+            },
+        )
+
+        async def _decorated_fn(resource, request):
+            self.assertEqual(request.user.context_url, "http://localhost/?param=/test/")
+
+            return True
+
+        decorated_fn = AsyncMock(wraps=_decorated_fn)
+        response = self.loop.run_until_complete(_authenticate(self.collection_resource, request, decorated_fn))
+        decorated_fn.assert_awaited_once_with(self.collection_resource, request)
+
+        self.assertEqual(response, True)
+
 
 class TestAuthorizeDecorators(TestDecorators):
     @classmethod