Skip to content

Commit bcc6f0b

Browse files
KShivenduKShivendu
committed
refactor: Rename session_data related vars to clarify interaction with DB
1 parent 1a251e9 commit bcc6f0b

File tree

18 files changed

+94
-62
lines changed

18 files changed

+94
-62
lines changed

‎supertokens_python/recipe/dashboard/interfaces.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class SessionInfo:
3232
def __init__(self, info: SessionInformationResult) -> None:
3333
self.session_handle = info.session_handle
3434
self.user_id = info.user_id
35-
self.session_data = info.session_data
35+
self.session_data_in_database = info.session_data_in_database
3636
self.expiry = info.expiry
3737
self.access_token_payload = info.access_token_payload
3838
self.time_created = info.time_created
@@ -165,7 +165,7 @@ def __init__(self, sessions: List[SessionInfo]):
165165
{
166166
"accessTokenPayload": s.access_token_payload,
167167
"expiry": s.expiry,
168-
"sessionData": s.session_data,
168+
"sessionDataInDatabase": s.session_data_in_database,
169169
"status": "OK",
170170
"timeCreated": s.time_created,
171171
"userId": s.user_id,

‎supertokens_python/recipe/session/asyncio/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ async def create_new_session(
4444
request: Any,
4545
user_id: str,
4646
access_token_payload: Union[Dict[str, Any], None] = None,
47-
session_data: Union[Dict[str, Any], None] = None,
47+
session_data_in_database: Union[Dict[str, Any], None] = None,
4848
user_context: Union[None, Dict[str, Any]] = None,
4949
) -> SessionContainer:
5050
if user_context is None:
5151
user_context = {}
52-
if session_data is None:
53-
session_data = {}
52+
if session_data_in_database is None:
53+
session_data_in_database = {}
5454
if access_token_payload is None:
5555
access_token_payload = {}
5656

@@ -72,7 +72,7 @@ async def create_new_session(
7272
request,
7373
user_id,
7474
final_access_token_payload,
75-
session_data,
75+
session_data_in_database,
7676
user_context=user_context,
7777
)
7878

@@ -336,14 +336,14 @@ async def get_session_information(
336336
)
337337

338338

339-
async def update_session_data(
339+
async def update_session_data_in_database(
340340
session_handle: str,
341341
new_session_data: Dict[str, Any],
342342
user_context: Union[None, Dict[str, Any]] = None,
343343
) -> bool:
344344
if user_context is None:
345345
user_context = {}
346-
return await SessionRecipe.get_instance().recipe_implementation.update_session_data(
346+
return await SessionRecipe.get_instance().recipe_implementation.update_session_data_in_database(
347347
session_handle, new_session_data, user_context
348348
)
349349

‎supertokens_python/recipe/session/interfaces.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ def __init__(
6464
self,
6565
session_handle: str,
6666
user_id: str,
67-
session_data: Dict[str, Any],
67+
session_data_in_database: Dict[str, Any],
6868
expiry: int,
6969
access_token_payload: Dict[str, Any],
7070
time_created: int,
7171
):
7272
self.session_handle: str = session_handle
7373
self.user_id: str = user_id
74-
self.session_data: Dict[str, Any] = session_data
74+
self.session_data_in_database: Dict[str, Any] = session_data_in_database
7575
self.expiry: int = expiry
7676
self.access_token_payload: Dict[str, Any] = access_token_payload
7777
self.time_created: int = time_created
@@ -115,7 +115,7 @@ async def create_new_session(
115115
request: BaseRequest,
116116
user_id: str,
117117
access_token_payload: Union[None, Dict[str, Any]],
118-
session_data: Union[None, Dict[str, Any]],
118+
session_data_in_database: Union[None, Dict[str, Any]],
119119
user_context: Dict[str, Any],
120120
) -> SessionContainer:
121121
pass
@@ -196,7 +196,7 @@ async def get_session_information(
196196
pass
197197

198198
@abstractmethod
199-
async def update_session_data(
199+
async def update_session_data_in_database(
200200
self,
201201
session_handle: str,
202202
new_session_data: Dict[str, Any],
@@ -373,13 +373,13 @@ async def revoke_session(
373373
pass
374374

375375
@abstractmethod
376-
async def get_session_data(
376+
async def get_session_data_from_database(
377377
self, user_context: Optional[Dict[str, Any]] = None
378378
) -> Dict[str, Any]:
379379
pass
380380

381381
@abstractmethod
382-
async def update_session_data(
382+
async def update_session_data_in_database(
383383
self,
384384
new_session_data: Dict[str, Any],
385385
user_context: Optional[Dict[str, Any]] = None,
@@ -475,10 +475,10 @@ def sync_revoke_session(
475475
) -> None:
476476
return sync(self.revoke_session(user_context=user_context))
477477

478-
def sync_get_session_data(
478+
def sync_get_session_data_from_database(
479479
self, user_context: Union[Dict[str, Any], None] = None
480480
) -> Dict[str, Any]:
481-
return sync(self.get_session_data(user_context))
481+
return sync(self.get_session_data_from_database(user_context))
482482

483483
def sync_get_time_created(
484484
self, user_context: Optional[Dict[str, Any]] = None
@@ -505,12 +505,14 @@ def sync_update_access_token_payload(
505505
self.update_access_token_payload(new_access_token_payload, user_context)
506506
)
507507

508-
def sync_update_session_data(
508+
def sync_update_session_data_in_database(
509509
self,
510510
new_session_data: Dict[str, Any],
511511
user_context: Optional[Dict[str, Any]] = None,
512512
) -> None:
513-
return sync(self.update_session_data(new_session_data, user_context))
513+
return sync(
514+
self.update_session_data_in_database(new_session_data, user_context)
515+
)
514516

515517
# Session claims sync functions:
516518
def sync_assert_claims(

‎supertokens_python/recipe/session/recipe_implementation.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ async def create_new_session(
168168
request: BaseRequest,
169169
user_id: str,
170170
access_token_payload: Union[None, Dict[str, Any]],
171-
session_data: Union[None, Dict[str, Any]],
171+
session_data_in_database: Union[None, Dict[str, Any]],
172172
user_context: Dict[str, Any],
173173
) -> SessionContainer:
174174
log_debug_message("createNewSession: Started")
@@ -211,7 +211,7 @@ async def create_new_session(
211211
user_id,
212212
disable_anti_csrf,
213213
access_token_payload,
214-
session_data,
214+
session_data_in_database,
215215
)
216216

217217
response_mutators: List[ResponseMutator] = []
@@ -698,13 +698,13 @@ async def get_session_information(
698698
) -> Union[SessionInformationResult, None]:
699699
return await session_functions.get_session_information(self, session_handle)
700700

701-
async def update_session_data(
701+
async def update_session_data_in_database(
702702
self,
703703
session_handle: str,
704704
new_session_data: Dict[str, Any],
705705
user_context: Dict[str, Any],
706706
) -> bool:
707-
return await session_functions.update_session_data(
707+
return await session_functions.update_session_data_in_database(
708708
self, session_handle, new_session_data
709709
)
710710

‎supertokens_python/recipe/session/session_class.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ async def revoke_session(self, user_context: Union[Any, None] = None) -> None:
4545
)
4646
)
4747

48-
async def get_session_data(
48+
async def get_session_data_from_database(
4949
self, user_context: Union[Dict[str, Any], None] = None
5050
) -> Dict[str, Any]:
5151
if user_context is None:
@@ -56,16 +56,16 @@ async def get_session_data(
5656
if session_info is None:
5757
raise_unauthorised_exception("Session does not exist anymore.")
5858

59-
return session_info.session_data
59+
return session_info.session_data_in_database
6060

61-
async def update_session_data(
61+
async def update_session_data_in_database(
6262
self,
6363
new_session_data: Dict[str, Any],
6464
user_context: Union[Dict[str, Any], None] = None,
6565
) -> None:
6666
if user_context is None:
6767
user_context = {}
68-
updated = await self.recipe_implementation.update_session_data(
68+
updated = await self.recipe_implementation.update_session_data_in_database(
6969
self.session_handle, new_session_data, user_context
7070
)
7171
if not updated:

‎supertokens_python/recipe/session/session_functions.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ async def create_new_session(
4242
user_id: str,
4343
disable_anti_csrf: bool,
4444
access_token_payload: Union[None, Dict[str, Any]],
45-
session_data: Union[None, Dict[str, Any]],
45+
session_data_in_database: Union[None, Dict[str, Any]],
4646
) -> Dict[str, Any]:
47-
if session_data is None:
48-
session_data = {}
47+
if session_data_in_database is None:
48+
session_data_in_database = {}
4949
if access_token_payload is None:
5050
access_token_payload = {}
5151

@@ -58,7 +58,7 @@ async def create_new_session(
5858
{
5959
"userId": user_id,
6060
"userDataInJWT": access_token_payload,
61-
"userDataInDatabase": session_data,
61+
"userDataInDatabase": session_data_in_database,
6262
"enableAntiCsrf": enable_anti_csrf,
6363
},
6464
)
@@ -294,7 +294,7 @@ async def revoke_multiple_sessions(
294294
return response["sessionHandlesRevoked"]
295295

296296

297-
async def update_session_data(
297+
async def update_session_data_in_database(
298298
recipe_implementation: RecipeImplementation,
299299
session_handle: str,
300300
new_session_data: Dict[str, Any],

‎supertokens_python/recipe/session/syncio/__init__.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def create_new_session(
4242
request: Any,
4343
user_id: str,
4444
access_token_payload: Union[Dict[str, Any], None] = None,
45-
session_data: Union[Dict[str, Any], None] = None,
45+
session_data_in_database: Union[Dict[str, Any], None] = None,
4646
user_context: Union[None, Dict[str, Any]] = None,
4747
) -> SessionContainer:
4848
from supertokens_python.recipe.session.asyncio import (
@@ -54,7 +54,7 @@ def create_new_session(
5454
request,
5555
user_id,
5656
access_token_payload,
57-
session_data,
57+
session_data_in_database,
5858
user_context=user_context,
5959
)
6060
)
@@ -147,17 +147,19 @@ def get_session_information(
147147
return sync(async_get_session_information(session_handle, user_context))
148148

149149

150-
def update_session_data(
150+
def update_session_data_in_database(
151151
session_handle: str,
152152
new_session_data: Dict[str, Any],
153153
user_context: Union[None, Dict[str, Any]] = None,
154154
) -> bool:
155155
from supertokens_python.recipe.session.asyncio import (
156-
update_session_data as async_update_session_data,
156+
update_session_data_in_database as async_update_session_data_in_database,
157157
)
158158

159159
return sync(
160-
async_update_session_data(session_handle, new_session_data, user_context)
160+
async_update_session_data_in_database(
161+
session_handle, new_session_data, user_context
162+
)
161163
)
162164

163165

‎supertokens_python/recipe/session/with_jwt/recipe_implementation.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ async def create_new_session(
5757
request: BaseRequest,
5858
user_id: str,
5959
access_token_payload: Union[None, Dict[str, Any]],
60-
session_data: Union[None, Dict[str, Any]],
60+
session_data_in_database: Union[None, Dict[str, Any]],
6161
user_context: Dict[str, Any],
6262
) -> SessionContainer:
6363
if access_token_payload is None:
@@ -78,7 +78,7 @@ async def create_new_session(
7878
request,
7979
user_id,
8080
access_token_payload,
81-
session_data,
81+
session_data_in_database,
8282
user_context=user_context,
8383
)
8484
return get_session_with_jwt(session, openid_recipe_implementation)

‎tests/auth-react/django3x/polls/views.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ async def session_info(request: HttpRequest): # type: ignore
6868
"sessionHandle": session_.get_handle(),
6969
"userId": session_.get_user_id(),
7070
"jwtPayload": session_.get_access_token_payload(),
71-
"sessionData": await session_.get_session_data(),
71+
"sessionDataFromDatabase": await session_.get_session_data_from_database(),
7272
}
7373
)
7474

@@ -111,7 +111,7 @@ def session_info(request: HttpRequest):
111111
"sessionHandle": session_.get_handle(),
112112
"userId": session_.get_user_id(),
113113
"accessTokenPayload": session_.get_access_token_payload(),
114-
"sessionData": session_.sync_get_session_data(),
114+
"sessionDataFromDatabase": session_.sync_get_session_data_from_database(),
115115
}
116116
)
117117

‎tests/auth-react/fastapi-server/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1025,7 +1025,7 @@ async def get_session_info(session_: SessionContainer = Depends(verify_session()
10251025
"sessionHandle": session_.get_handle(),
10261026
"userId": session_.get_user_id(),
10271027
"accessTokenPayload": session_.get_access_token_payload(),
1028-
"sessionData": await session_.get_session_data(),
1028+
"sessionDataFromDatabase": await session_.get_session_data_from_database(),
10291029
}
10301030
)
10311031

‎tests/auth-react/flask-server/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@ def get_session_info():
996996
"sessionHandle": session_.get_handle(),
997997
"userId": session_.get_user_id(),
998998
"accessTokenPayload": session_.get_access_token_payload(),
999-
"sessionData": session_.sync_get_session_data(),
999+
"sessionDataFromDatabase": session_.sync_get_session_data_from_database(),
10001000
}
10011001
)
10021002

‎tests/frontendIntegration/django2x/polls/views.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,14 +239,18 @@ async def create_new_session_custom(
239239
request: BaseRequest,
240240
user_id: str,
241241
access_token_payload: Union[Dict[str, Any], None],
242-
session_data: Union[Dict[str, Any], None],
242+
session_data_in_database: Union[Dict[str, Any], None],
243243
user_context: Dict[str, Any],
244244
) -> SessionContainer:
245245
if access_token_payload is None:
246246
access_token_payload = {}
247247
access_token_payload = {**access_token_payload, "customClaim": "customValue"}
248248
return await original_create_new_session(
249-
request, user_id, access_token_payload, session_data, user_context
249+
request,
250+
user_id,
251+
access_token_payload,
252+
session_data_in_database,
253+
user_context,
250254
)
251255

252256
param.create_new_session = create_new_session_custom

‎tests/frontendIntegration/django3x/polls/views.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,14 +246,18 @@ async def create_new_session_custom(
246246
request: BaseRequest,
247247
user_id: str,
248248
access_token_payload: Union[Dict[str, Any], None],
249-
session_data: Union[Dict[str, Any], None],
249+
session_data_in_database: Union[Dict[str, Any], None],
250250
user_context: Dict[str, Any],
251251
) -> SessionContainer:
252252
if access_token_payload is None:
253253
access_token_payload = {}
254254
access_token_payload = {**access_token_payload, "customClaim": "customValue"}
255255
return await original_create_new_session(
256-
request, user_id, access_token_payload, session_data, user_context
256+
request,
257+
user_id,
258+
access_token_payload,
259+
session_data_in_database,
260+
user_context,
257261
)
258262

259263
param.create_new_session = create_new_session_custom

‎tests/frontendIntegration/fastapi-server/app.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,18 @@ async def create_new_session_custom(
115115
_request: BaseRequest,
116116
user_id: str,
117117
access_token_payload: Union[Dict[str, Any], None],
118-
session_data: Union[Dict[str, Any], None],
118+
session_data_in_database: Union[Dict[str, Any], None],
119119
user_context: Dict[str, Any],
120120
) -> SessionContainer:
121121
if access_token_payload is None:
122122
access_token_payload = {}
123123
access_token_payload = {**access_token_payload, "customClaim": "customValue"}
124124
return await original_create_new_session(
125-
_request, user_id, access_token_payload, session_data, user_context
125+
_request,
126+
user_id,
127+
access_token_payload,
128+
session_data_in_database,
129+
user_context,
126130
)
127131

128132
param.create_new_session = create_new_session_custom

0 commit comments

Comments
 (0)