Merge pull request #302 from supertokens/session-data-rename

porcellus · web-flow · commit dd2622433a4d · 2023-04-06T01:09:58.000+02:00
refactor: Rename session_data related vars to clarify interaction with DB
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## unreleased
 
+### Breaking changes
+
+- Renamed `get_session_data` to `get_session_data_from_database` to clarity that it always hits the DB
+- Renamed `update_session_data` to `update_session_data_in_database`
+- Renamed `session_data` to `session_data_in_database` in `SessionInformation` and the input to `create_new_session`
+
+
 ## [0.12.4] - 2023-03-29
 ### Changed
 - Update all example apps to initialise dashboard recipe
diff --git a/examples/with-django/with-thirdpartyemailpassword/sampleapp/views.py b/examples/with-django/with-thirdpartyemailpassword/sampleapp/views.py
@@ -11,6 +11,6 @@ def get_session_info(request: HttpRequest) -> JsonResponse:
             "sessionHandle": session_.get_handle(),
             "userId": session_.get_user_id(),
             "accessTokenPayload": session_.get_access_token_payload(),
-            # 'sessionData': session_.get_session_data(),
+            # "sessionData": session_.sync_get_session_data_from_database(),
         }
     )
diff --git a/examples/with-fastapi/with-thirdpartyemailpassword/main.py b/examples/with-fastapi/with-thirdpartyemailpassword/main.py
@@ -119,7 +119,7 @@ async def get_session_info(session_: SessionContainer = Depends(verify_session()
             "sessionHandle": session_.get_handle(),
             "userId": session_.get_user_id(),
             "accessTokenPayload": session_.get_access_token_payload(),
-            # 'sessionData': await session_.get_session_data()
+            # "sessionData": await session_.get_session_data_from_database()
         }
     )
 
diff --git a/examples/with-flask/with-thirdpartyemailpassword/app.py b/examples/with-flask/with-thirdpartyemailpassword/app.py
@@ -121,6 +121,7 @@ def get_session_info():
             "sessionHandle": session_.get_handle(),
             "userId": session_.get_user_id(),
             "accessTokenPayload": session_.get_access_token_payload(),
+            # "sessionData": session_.sync_get_session_data_from_database()
         }
     )
 
diff --git a/supertokens_python/recipe/dashboard/interfaces.py b/supertokens_python/recipe/dashboard/interfaces.py
@@ -32,7 +32,7 @@ class SessionInfo:
     def __init__(self, info: SessionInformationResult) -> None:
         self.session_handle = info.session_handle
         self.user_id = info.user_id
-        self.session_data = info.session_data
+        self.session_data_in_database = info.session_data_in_database
         self.expiry = info.expiry
         self.access_token_payload = info.access_token_payload
         self.time_created = info.time_created
@@ -165,7 +165,7 @@ def __init__(self, sessions: List[SessionInfo]):
             {
                 "accessTokenPayload": s.access_token_payload,
                 "expiry": s.expiry,
-                "sessionData": s.session_data,
+                "sessionDataInDatabase": s.session_data_in_database,
                 "status": "OK",
                 "timeCreated": s.time_created,
                 "userId": s.user_id,
diff --git a/supertokens_python/recipe/session/asyncio/__init__.py b/supertokens_python/recipe/session/asyncio/__init__.py
@@ -44,13 +44,13 @@ async def create_new_session(
     request: Any,
     user_id: str,
     access_token_payload: Union[Dict[str, Any], None] = None,
-    session_data: Union[Dict[str, Any], None] = None,
+    session_data_in_database: Union[Dict[str, Any], None] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> SessionContainer:
     if user_context is None:
         user_context = {}
-    if session_data is None:
-        session_data = {}
+    if session_data_in_database is None:
+        session_data_in_database = {}
     if access_token_payload is None:
         access_token_payload = {}
 
@@ -72,7 +72,7 @@ async def create_new_session(
         request,
         user_id,
         final_access_token_payload,
-        session_data,
+        session_data_in_database,
         user_context=user_context,
     )
 
@@ -336,14 +336,14 @@ async def get_session_information(
     )
 
 
-async def update_session_data(
+async def update_session_data_in_database(
     session_handle: str,
     new_session_data: Dict[str, Any],
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> bool:
     if user_context is None:
         user_context = {}
-    return await SessionRecipe.get_instance().recipe_implementation.update_session_data(
+    return await SessionRecipe.get_instance().recipe_implementation.update_session_data_in_database(
         session_handle, new_session_data, user_context
     )
 
diff --git a/supertokens_python/recipe/session/interfaces.py b/supertokens_python/recipe/session/interfaces.py
@@ -64,14 +64,14 @@ def __init__(
         self,
         session_handle: str,
         user_id: str,
-        session_data: Dict[str, Any],
+        session_data_in_database: Dict[str, Any],
         expiry: int,
         access_token_payload: Dict[str, Any],
         time_created: int,
     ):
         self.session_handle: str = session_handle
         self.user_id: str = user_id
-        self.session_data: Dict[str, Any] = session_data
+        self.session_data_in_database: Dict[str, Any] = session_data_in_database
         self.expiry: int = expiry
         self.access_token_payload: Dict[str, Any] = access_token_payload
         self.time_created: int = time_created
@@ -115,7 +115,7 @@ async def create_new_session(
         request: BaseRequest,
         user_id: str,
         access_token_payload: Union[None, Dict[str, Any]],
-        session_data: Union[None, Dict[str, Any]],
+        session_data_in_database: Union[None, Dict[str, Any]],
         user_context: Dict[str, Any],
     ) -> SessionContainer:
         pass
@@ -196,7 +196,7 @@ async def get_session_information(
         pass
 
     @abstractmethod
-    async def update_session_data(
+    async def update_session_data_in_database(
         self,
         session_handle: str,
         new_session_data: Dict[str, Any],
@@ -373,13 +373,13 @@ async def revoke_session(
         pass
 
     @abstractmethod
-    async def get_session_data(
+    async def get_session_data_from_database(
         self, user_context: Optional[Dict[str, Any]] = None
     ) -> Dict[str, Any]:
         pass
 
     @abstractmethod
-    async def update_session_data(
+    async def update_session_data_in_database(
         self,
         new_session_data: Dict[str, Any],
         user_context: Optional[Dict[str, Any]] = None,
@@ -475,10 +475,10 @@ def sync_revoke_session(
     ) -> None:
         return sync(self.revoke_session(user_context=user_context))
 
-    def sync_get_session_data(
+    def sync_get_session_data_from_database(
         self, user_context: Union[Dict[str, Any], None] = None
     ) -> Dict[str, Any]:
-        return sync(self.get_session_data(user_context))
+        return sync(self.get_session_data_from_database(user_context))
 
     def sync_get_time_created(
         self, user_context: Optional[Dict[str, Any]] = None
@@ -505,12 +505,14 @@ def sync_update_access_token_payload(
             self.update_access_token_payload(new_access_token_payload, user_context)
         )
 
-    def sync_update_session_data(
+    def sync_update_session_data_in_database(
         self,
         new_session_data: Dict[str, Any],
         user_context: Optional[Dict[str, Any]] = None,
     ) -> None:
-        return sync(self.update_session_data(new_session_data, user_context))
+        return sync(
+            self.update_session_data_in_database(new_session_data, user_context)
+        )
 
     # Session claims sync functions:
     def sync_assert_claims(
diff --git a/supertokens_python/recipe/session/recipe_implementation.py b/supertokens_python/recipe/session/recipe_implementation.py
@@ -168,7 +168,7 @@ async def create_new_session(
         request: BaseRequest,
         user_id: str,
         access_token_payload: Union[None, Dict[str, Any]],
-        session_data: Union[None, Dict[str, Any]],
+        session_data_in_database: Union[None, Dict[str, Any]],
         user_context: Dict[str, Any],
     ) -> SessionContainer:
         log_debug_message("createNewSession: Started")
@@ -211,7 +211,7 @@ async def create_new_session(
             user_id,
             disable_anti_csrf,
             access_token_payload,
-            session_data,
+            session_data_in_database,
         )
 
         response_mutators: List[ResponseMutator] = []
@@ -698,13 +698,13 @@ async def get_session_information(
     ) -> Union[SessionInformationResult, None]:
         return await session_functions.get_session_information(self, session_handle)
 
-    async def update_session_data(
+    async def update_session_data_in_database(
         self,
         session_handle: str,
         new_session_data: Dict[str, Any],
         user_context: Dict[str, Any],
     ) -> bool:
-        return await session_functions.update_session_data(
+        return await session_functions.update_session_data_in_database(
             self, session_handle, new_session_data
         )
 
diff --git a/supertokens_python/recipe/session/session_class.py b/supertokens_python/recipe/session/session_class.py
@@ -45,7 +45,7 @@ async def revoke_session(self, user_context: Union[Any, None] = None) -> None:
             )
         )
 
-    async def get_session_data(
+    async def get_session_data_from_database(
         self, user_context: Union[Dict[str, Any], None] = None
     ) -> Dict[str, Any]:
         if user_context is None:
@@ -56,16 +56,16 @@ async def get_session_data(
         if session_info is None:
             raise_unauthorised_exception("Session does not exist anymore.")
 
-        return session_info.session_data
+        return session_info.session_data_in_database
 
-    async def update_session_data(
+    async def update_session_data_in_database(
         self,
         new_session_data: Dict[str, Any],
         user_context: Union[Dict[str, Any], None] = None,
     ) -> None:
         if user_context is None:
             user_context = {}
-        updated = await self.recipe_implementation.update_session_data(
+        updated = await self.recipe_implementation.update_session_data_in_database(
             self.session_handle, new_session_data, user_context
         )
         if not updated:
diff --git a/supertokens_python/recipe/session/session_functions.py b/supertokens_python/recipe/session/session_functions.py
@@ -42,10 +42,10 @@ async def create_new_session(
     user_id: str,
     disable_anti_csrf: bool,
     access_token_payload: Union[None, Dict[str, Any]],
-    session_data: Union[None, Dict[str, Any]],
+    session_data_in_database: Union[None, Dict[str, Any]],
 ) -> Dict[str, Any]:
-    if session_data is None:
-        session_data = {}
+    if session_data_in_database is None:
+        session_data_in_database = {}
     if access_token_payload is None:
         access_token_payload = {}
 
@@ -58,7 +58,7 @@ async def create_new_session(
         {
             "userId": user_id,
             "userDataInJWT": access_token_payload,
-            "userDataInDatabase": session_data,
+            "userDataInDatabase": session_data_in_database,
             "enableAntiCsrf": enable_anti_csrf,
         },
     )
@@ -294,7 +294,7 @@ async def revoke_multiple_sessions(
     return response["sessionHandlesRevoked"]
 
 
-async def update_session_data(
+async def update_session_data_in_database(
     recipe_implementation: RecipeImplementation,
     session_handle: str,
     new_session_data: Dict[str, Any],
diff --git a/supertokens_python/recipe/session/syncio/__init__.py b/supertokens_python/recipe/session/syncio/__init__.py
@@ -42,7 +42,7 @@ def create_new_session(
     request: Any,
     user_id: str,
     access_token_payload: Union[Dict[str, Any], None] = None,
-    session_data: Union[Dict[str, Any], None] = None,
+    session_data_in_database: Union[Dict[str, Any], None] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> SessionContainer:
     from supertokens_python.recipe.session.asyncio import (
@@ -54,7 +54,7 @@ def create_new_session(
             request,
             user_id,
             access_token_payload,
-            session_data,
+            session_data_in_database,
             user_context=user_context,
         )
     )
@@ -147,17 +147,19 @@ def get_session_information(
     return sync(async_get_session_information(session_handle, user_context))
 
 
-def update_session_data(
+def update_session_data_in_database(
     session_handle: str,
     new_session_data: Dict[str, Any],
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> bool:
     from supertokens_python.recipe.session.asyncio import (
-        update_session_data as async_update_session_data,
+        update_session_data_in_database as async_update_session_data_in_database,
     )
 
     return sync(
-        async_update_session_data(session_handle, new_session_data, user_context)
+        async_update_session_data_in_database(
+            session_handle, new_session_data, user_context
+        )
     )
 
 
diff --git a/supertokens_python/recipe/session/with_jwt/recipe_implementation.py b/supertokens_python/recipe/session/with_jwt/recipe_implementation.py
@@ -57,7 +57,7 @@ async def create_new_session(
         request: BaseRequest,
         user_id: str,
         access_token_payload: Union[None, Dict[str, Any]],
-        session_data: Union[None, Dict[str, Any]],
+        session_data_in_database: Union[None, Dict[str, Any]],
         user_context: Dict[str, Any],
     ) -> SessionContainer:
         if access_token_payload is None:
@@ -78,7 +78,7 @@ async def create_new_session(
             request,
             user_id,
             access_token_payload,
-            session_data,
+            session_data_in_database,
             user_context=user_context,
         )
         return get_session_with_jwt(session, openid_recipe_implementation)
diff --git a/tests/auth-react/django3x/polls/views.py b/tests/auth-react/django3x/polls/views.py
@@ -68,7 +68,7 @@ async def session_info(request: HttpRequest):  # type: ignore
                 "sessionHandle": session_.get_handle(),
                 "userId": session_.get_user_id(),
                 "jwtPayload": session_.get_access_token_payload(),
-                "sessionData": await session_.get_session_data(),
+                "sessionDataFromDatabase": await session_.get_session_data_from_database(),
             }
         )
 
@@ -111,7 +111,7 @@ def session_info(request: HttpRequest):
                 "sessionHandle": session_.get_handle(),
                 "userId": session_.get_user_id(),
                 "accessTokenPayload": session_.get_access_token_payload(),
-                "sessionData": session_.sync_get_session_data(),
+                "sessionDataFromDatabase": session_.sync_get_session_data_from_database(),
             }
         )
 
diff --git a/tests/auth-react/fastapi-server/app.py b/tests/auth-react/fastapi-server/app.py
@@ -1025,7 +1025,7 @@ async def get_session_info(session_: SessionContainer = Depends(verify_session()
             "sessionHandle": session_.get_handle(),
             "userId": session_.get_user_id(),
             "accessTokenPayload": session_.get_access_token_payload(),
-            "sessionData": await session_.get_session_data(),
+            "sessionDataFromDatabase": await session_.get_session_data_from_database(),
         }
     )
 
diff --git a/tests/auth-react/flask-server/app.py b/tests/auth-react/flask-server/app.py
@@ -996,7 +996,7 @@ def get_session_info():
             "sessionHandle": session_.get_handle(),
             "userId": session_.get_user_id(),
             "accessTokenPayload": session_.get_access_token_payload(),
-            "sessionData": session_.sync_get_session_data(),
+            "sessionDataFromDatabase": session_.sync_get_session_data_from_database(),
         }
     )
 
diff --git a/tests/frontendIntegration/django2x/polls/views.py b/tests/frontendIntegration/django2x/polls/views.py
@@ -239,14 +239,18 @@ async def create_new_session_custom(
         request: BaseRequest,
         user_id: str,
         access_token_payload: Union[Dict[str, Any], None],
-        session_data: Union[Dict[str, Any], None],
+        session_data_in_database: Union[Dict[str, Any], None],
         user_context: Dict[str, Any],
     ) -> SessionContainer:
         if access_token_payload is None:
             access_token_payload = {}
         access_token_payload = {**access_token_payload, "customClaim": "customValue"}
         return await original_create_new_session(
-            request, user_id, access_token_payload, session_data, user_context
+            request,
+            user_id,
+            access_token_payload,
+            session_data_in_database,
+            user_context,
         )
 
     param.create_new_session = create_new_session_custom
diff --git a/tests/frontendIntegration/django3x/polls/views.py b/tests/frontendIntegration/django3x/polls/views.py
diff --git a/tests/frontendIntegration/fastapi-server/app.py b/tests/frontendIntegration/fastapi-server/app.py
diff --git a/tests/frontendIntegration/flask-server/app.py b/tests/frontendIntegration/flask-server/app.py
diff --git a/tests/sessions/claims/utils.py b/tests/sessions/claims/utils.py
diff --git a/tests/test_session.py b/tests/test_session.py
diff --git a/tests/test_user_context.py b/tests/test_user_context.py

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@ def get_session_info(request: HttpRequest) -> JsonResponse:`
`11`	`11`	`"sessionHandle": session_.get_handle(),`
`12`	`12`	`"userId": session_.get_user_id(),`
`13`	`13`	`"accessTokenPayload": session_.get_access_token_payload(),`
`14`		`- # 'sessionData': session_.get_session_data(),`
	`14`	`+ # "sessionData": session_.sync_get_session_data_from_database(),`
`15`	`15`	`}`
`16`	`16`	`)`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ async def get_session_info(session_: SessionContainer = Depends(verify_session()`
`119`	`119`	`"sessionHandle": session_.get_handle(),`
`120`	`120`	`"userId": session_.get_user_id(),`
`121`	`121`	`"accessTokenPayload": session_.get_access_token_payload(),`
`122`		`- # 'sessionData': await session_.get_session_data()`
	`122`	`+ # "sessionData": await session_.get_session_data_from_database()`
`123`	`123`	`}`
`124`	`124`	`)`
`125`	`125`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,7 @@ def get_session_info():`
`121`	`121`	`"sessionHandle": session_.get_handle(),`
`122`	`122`	`"userId": session_.get_user_id(),`
`123`	`123`	`"accessTokenPayload": session_.get_access_token_payload(),`
	`124`	`+ # "sessionData": session_.sync_get_session_data_from_database()`
`124`	`125`	`}`
`125`	`126`	`)`
`126`	`127`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ async def session_info(request: HttpRequest): # type: ignore`
`68`	`68`	`"sessionHandle": session_.get_handle(),`
`69`	`69`	`"userId": session_.get_user_id(),`
`70`	`70`	`"jwtPayload": session_.get_access_token_payload(),`
`71`		`- "sessionData": await session_.get_session_data(),`
	`71`	`+ "sessionDataFromDatabase": await session_.get_session_data_from_database(),`
`72`	`72`	`}`
`73`	`73`	`)`
`74`	`74`
`@@ -111,7 +111,7 @@ def session_info(request: HttpRequest):`
`111`	`111`	`"sessionHandle": session_.get_handle(),`
`112`	`112`	`"userId": session_.get_user_id(),`
`113`	`113`	`"accessTokenPayload": session_.get_access_token_payload(),`
`114`		`- "sessionData": session_.sync_get_session_data(),`
	`114`	`+ "sessionDataFromDatabase": session_.sync_get_session_data_from_database(),`
`115`	`115`	`}`
`116`	`116`	`)`
`117`	`117`
Original file line number	Diff line number	Diff line change
`@@ -1025,7 +1025,7 @@ async def get_session_info(session_: SessionContainer = Depends(verify_session()`
`1025`	`1025`	`"sessionHandle": session_.get_handle(),`
`1026`	`1026`	`"userId": session_.get_user_id(),`
`1027`	`1027`	`"accessTokenPayload": session_.get_access_token_payload(),`
`1028`		`- "sessionData": await session_.get_session_data(),`
	`1028`	`+ "sessionDataFromDatabase": await session_.get_session_data_from_database(),`
`1029`	`1029`	`}`
`1030`	`1030`	`)`
`1031`	`1031`
Original file line number	Diff line number	Diff line change
`@@ -996,7 +996,7 @@ def get_session_info():`
`996`	`996`	`"sessionHandle": session_.get_handle(),`
`997`	`997`	`"userId": session_.get_user_id(),`
`998`	`998`	`"accessTokenPayload": session_.get_access_token_payload(),`
`999`		`- "sessionData": session_.sync_get_session_data(),`
	`999`	`+ "sessionDataFromDatabase": session_.sync_get_session_data_from_database(),`
`1000`	`1000`	`}`
`1001`	`1001`	`)`
`1002`	`1002`