feat: Changes suggested in feedback

Author: KShivendu

supertokens_python/recipe/session/asyncio/__init__.py

@@ -22,7 +22,7 @@
     SessionInformationResult,
     SessionClaim,
     SessionClaimValidator,
-    SessionDoesnotExistError,
+    SessionDoesNotExistError,
     ClaimsValidationResult,
     JSONObject,
     GetClaimValueOkResult,
@@ -71,7 +71,7 @@ async def validate_claims_for_session_handle(
         ]
     ] = None,
     user_context: Union[None, Dict[str, Any]] = None,
-) -> Union[SessionDoesnotExistError, ClaimsValidationResult]:
+) -> Union[SessionDoesNotExistError, ClaimsValidationResult]:
     if user_context is None:
         user_context = {}
 
@@ -81,7 +81,7 @@ async def validate_claims_for_session_handle(
     )
 
     if session_info is None:
-        return SessionDoesnotExistError()
+        return SessionDoesNotExistError()
 
     claim_validators_added_by_other_recipes = (
         SessionRecipe.get_claim_validators_added_by_other_recipes()
@@ -169,7 +169,7 @@ async def get_claim_value(
     session_handle: str,
     claim: SessionClaim[_T],
     user_context: Union[None, Dict[str, Any]] = None,
-) -> Union[SessionDoesnotExistError, GetClaimValueOkResult[_T]]:
+) -> Union[SessionDoesNotExistError, GetClaimValueOkResult[_T]]:
     if user_context is None:
         user_context = {}
     return await SessionRecipe.get_instance().recipe_implementation.get_claim_value(
@@ -333,7 +333,7 @@ async def merge_into_access_token_payload(
 ) -> bool:
     if user_context is None:
         user_context = {}
-    # TODO:
+
     return await SessionRecipe.get_instance().recipe_implementation.merge_into_access_token_payload(
         session_handle, new_access_token_payload, user_context
     )

supertokens_python/recipe/session/claim_base_classes/boolean_claim.py

@@ -41,5 +41,4 @@ def __init__(
         ],
     ):
         super().__init__(key, fetch_value)
-        claim = self
-        self.validators = BooleanClaimValidators(claim)
+        self.validators = BooleanClaimValidators(claim=self)

supertokens_python/recipe/session/claim_base_classes/primitive_claim.py

@@ -29,10 +29,9 @@
 
 
 class HasValueSCV(SessionClaimValidator):
-    def __init__(self, id_: str, claim: SessionClaim[_T], params: Dict[str, Any]):
-        super().__init__(id_)
-        self.claim: SessionClaim[_T] = claim
-        self.params = params
+    def __init__(self, id_: str, claim: SessionClaim[_T], val: _T):
+        super().__init__(id_, claim)
+        self.val = val
 
     def should_refetch(
         self,
@@ -46,9 +45,9 @@ async def validate(
         payload: JSONObject,
         user_context: Dict[str, Any],
     ):
-        val = self.params["val"]
+        val = self.val
         claim_val = self.claim.get_value_from_payload(payload, user_context)
-        is_valid = claim_val == val
+        is_valid = claim_val == val  # type: ignore
         if is_valid:
             return ClaimValidationResult(is_valid=True)
 
@@ -63,17 +62,17 @@ async def validate(
 
 
 class HasFreshValueSCV(SessionClaimValidator):
-    def __init__(self, id_: str, claim: SessionClaim[_T], params: Dict[str, Any]):
-        super().__init__(id_)
-        self.claim: SessionClaim[_T] = claim
-        self.params = params
+    def __init__(self, id_: str, claim: SessionClaim[_T], val: _T, max_age_in_sec: int):
+        super().__init__(id_, claim)
+        self.val = val
+        self.max_age_in_sec = max_age_in_sec
 
     def should_refetch(
         self,
         payload: JSONObject,
         user_context: Dict[str, Any],
     ):
-        max_age_in_sec: int = self.params["max_age_in_sec"]
+        max_age_in_sec: int = self.max_age_in_sec
 
         # (claim value is None) OR (value has expired)
         return (self.claim.get_value_from_payload(payload, user_context) is None) or (
@@ -85,8 +84,8 @@ async def validate(
         payload: JSONObject,
         user_context: Dict[str, Any],
     ):
-        val: str = self.params["val"]
-        max_age_in_sec: int = self.params["max_age_in_sec"]
+        val = self.val
+        max_age_in_sec = self.max_age_in_sec
 
         claim_val = self.claim.get_value_from_payload(payload, user_context)
         if claim_val is None:
@@ -113,7 +112,7 @@ async def validate(
                 },
             )
 
-        if claim_val != val:
+        if claim_val != val:  # type: ignore
             return ClaimValidationResult(
                 is_valid=False,
                 reason={
@@ -131,15 +130,16 @@ def __init__(self, claim: SessionClaim[_T]) -> None:
         self.claim = claim
 
     def has_value(self, val: _T, id_: Union[str, None] = None) -> SessionClaimValidator:
-        return HasValueSCV((id_ or self.claim.key), self.claim, {"val": val})
+        return HasValueSCV((id_ or self.claim.key), self.claim, val=val)
 
     def has_fresh_value(
         self, val: _T, max_age_in_sec: int, id_: Union[str, None] = None
     ) -> SessionClaimValidator:
         return HasFreshValueSCV(
             (id_ or (self.claim.key + "-fresh-val")),
             self.claim,
-            {"val": val, "max_age_in_sec": max_age_in_sec},
+            val=val,
+            max_age_in_sec=max_age_in_sec,
         )
 
 

supertokens_python/recipe/session/interfaces.py

@@ -82,7 +82,7 @@ def __init__(
 FetchValueReturnType = Union[_T, None]
 
 
-class SessionDoesnotExistError:
+class SessionDoesNotExistError:
     pass
 
 
@@ -145,7 +145,7 @@ async def validate_claims_for_session_handle(
         session_info: SessionInformationResult,
         claim_validators: List[SessionClaimValidator],
         user_context: Dict[str, Any],
-    ) -> Union[ClaimsValidationResult, SessionDoesnotExistError]:
+    ) -> Union[ClaimsValidationResult, SessionDoesNotExistError]:
         pass
 
     @abstractmethod
@@ -210,7 +210,6 @@ async def update_access_token_payload(
         new_access_token_payload: Dict[str, Any],
         user_context: Dict[str, Any],
     ) -> bool:
-        # TODO: Deprecate this method.
         """DEPRECATED: Use merge_into_access_token_payload instead"""
 
     @abstractmethod
@@ -255,7 +254,7 @@ async def get_claim_value(
         session_handle: str,
         claim: SessionClaim[Any],
         user_context: Dict[str, Any],
-    ) -> Union[SessionDoesnotExistError, GetClaimValueOkResult[Any]]:
+    ) -> Union[SessionDoesNotExistError, GetClaimValueOkResult[Any]]:
         pass
 
     @abstractmethod
@@ -450,7 +449,9 @@ async def get_claim_value(
 
     @abstractmethod
     async def remove_claim(
-        self, claim: SessionClaim[Any], user_context: Union[Dict[str, Any], None] = None
+        self,
+        claim: SessionClaim[_T],  # pyright: ignore[reportInvalidTypeVarUse]
+        user_context: Union[Dict[str, Any], None] = None,
     ) -> None:
         pass
 
@@ -472,6 +473,15 @@ def sync_get_time_created(
     ) -> int:
         return sync(self.get_time_created(user_context))
 
+    def sync_merge_into_access_token_payload(
+        self, access_token_payload_update: Dict[str, Any], user_context: Dict[str, Any]
+    ) -> None:
+        return sync(
+            self.merge_into_access_token_payload(
+                access_token_payload_update, user_context
+            )
+        )
+
     def sync_update_access_token_payload(
         self,
         new_access_token_payload: Dict[str, Any],
@@ -589,20 +599,23 @@ def __init__(self, is_valid: bool, reason: Optional[Dict[str, Any]] = None):
 
 
 class SessionClaimValidator(ABC):
-    def __init__(self, id_: str):
+    def __init__(
+        self,
+        id_: str,
+        claim: SessionClaim[_T],  # pyright: ignore[reportInvalidTypeVarUse]
+    ) -> None:
         self.id = id_
-        self.claim: Optional[
-            SessionClaim[Any]
-        ] = None  # Child class must set this if required.
+        self.claim = claim
 
     @abstractmethod
     async def validate(
         self, payload: JSONObject, user_context: Dict[str, Any]
     ) -> ClaimValidationResult:
         pass
 
-    def should_refetch(  # pylint: disable=no-self-use
+    @abstractmethod
+    def should_refetch(
         self, payload: JSONObject, user_context: Dict[str, Any]
     ) -> MaybeAwaitable[bool]:
-        _, __ = payload, user_context
-        return False
+        # TODO: Confirm that MaybeAwaitable actually makes the function async
+        pass

supertokens_python/recipe/session/recipe_implementation.py

@@ -15,7 +15,6 @@
 
 import json
 from typing import TYPE_CHECKING, Any, Dict, Optional
-
 from supertokens_python.framework.request import BaseRequest
 from supertokens_python.logger import log_debug_message
 from supertokens_python.normalised_url_path import NormalisedURLPath
@@ -26,6 +25,7 @@
     get_timestamp_ms,
     normalise_http_method,
     resolve,
+    deprecated_warn,
 )
 from . import session_functions
 from .cookie_and_header import (
@@ -45,7 +45,7 @@
     SessionInformationResult,
     SessionObj,
     ClaimsValidationResult,
-    SessionDoesnotExistError,
+    SessionDoesNotExistError,
     JSONObject,
     GetClaimValueOkResult,
 )
@@ -193,7 +193,7 @@ async def validate_claims_for_session_handle(
         session_info: SessionInformationResult,
         claim_validators: List[SessionClaimValidator],
         user_context: Dict[str, Any],
-    ) -> Union[ClaimsValidationResult, SessionDoesnotExistError]:
+    ) -> Union[ClaimsValidationResult, SessionDoesNotExistError]:
         original_session_claim_payload_json = json.dumps(
             session_info.access_token_payload
         )
@@ -212,7 +212,7 @@ async def validate_claims_for_session_handle(
                 user_context,
             )
             if res is False:
-                return SessionDoesnotExistError()
+                return SessionDoesNotExistError()
 
         invalid_claims = await validate_claims_in_payload(
             claim_validators,
@@ -402,7 +402,10 @@ async def update_access_token_payload(
         new_access_token_payload: Dict[str, Any],
         user_context: Dict[str, Any],
     ) -> bool:
-        """DEPRECATED: Use merge_into_access_token_payload instead"""
+        deprecated_warn(
+            "update_access_token_payload is deprecated. Use merge_into_access_token_payload instead"
+        )
+
         return await session_functions.update_access_token_payload(
             self, session_handle, new_access_token_payload
         )
@@ -469,10 +472,10 @@ async def get_claim_value(
         session_handle: str,
         claim: SessionClaim[Any],
         user_context: Dict[str, Any],
-    ) -> Union[SessionDoesnotExistError, GetClaimValueOkResult[Any]]:
+    ) -> Union[SessionDoesNotExistError, GetClaimValueOkResult[Any]]:
         session_info = await self.get_session_information(session_handle, user_context)
         if session_info is None:
-            return SessionDoesnotExistError()
+            return SessionDoesNotExistError()
 
         return GetClaimValueOkResult(
             value=claim.get_value_from_payload(

supertokens_python/recipe/session/session_class.py

@@ -62,9 +62,12 @@ async def update_session_data(
 
     async def update_access_token_payload(
         self,
-        new_access_token_payload: Union[Dict[str, Any], None],
-        user_context: Dict[str, Any],
+        new_access_token_payload: Dict[str, Any],
+        user_context: Union[Dict[str, Any], None] = None,
     ) -> None:
+        if user_context is None:
+            user_context = {}
+
         response = await self.recipe_implementation.regenerate_access_token(
             self.access_token, new_access_token_payload, user_context
         )

supertokens_python/recipe/session/syncio/__init__.py

@@ -33,7 +33,7 @@
     SessionClaim,
     JSONObject,
     ClaimsValidationResult,
-    SessionDoesnotExistError,
+    SessionDoesNotExistError,
     GetClaimValueOkResult,
 )
 
@@ -267,7 +267,7 @@ def get_claim_value(
     session_handle: str,
     claim: SessionClaim[_T],
     user_context: Union[None, Dict[str, Any]] = None,
-) -> Union[SessionDoesnotExistError, GetClaimValueOkResult[_T]]:
+) -> Union[SessionDoesNotExistError, GetClaimValueOkResult[_T]]:
     from supertokens_python.recipe.session.asyncio import (
         get_claim_value as async_get_claim_value,
     )
@@ -296,7 +296,7 @@ def validate_claims_for_session_handle(
         ]
     ] = None,
     user_context: Union[None, Dict[str, Any]] = None,
-) -> Union[SessionDoesnotExistError, ClaimsValidationResult]:
+) -> Union[SessionDoesNotExistError, ClaimsValidationResult]:
     from supertokens_python.recipe.session.asyncio import (
         validate_claims_for_session_handle as async_validate_claims_for_session_handle,
     )

supertokens_python/recipe/session/utils.py

@@ -418,6 +418,17 @@ def validate_and_normalise_user_input(
     session_expired_status_code = (
         session_expired_status_code if session_expired_status_code is not None else 401
     )
+
+    invalid_claim_status_code = (
+        invalid_claim_status_code if invalid_claim_status_code is not None else 403
+    )
+
+    if session_expired_status_code == invalid_claim_status_code:
+        raise Exception(
+            "session_expired_status_code and invalid_claim_status_code cannot be the same "
+            f"({invalid_claim_status_code})"
+        )
+
     if anti_csrf is None:
         anti_csrf = "VIA_CUSTOM_HEADER" if cookie_same_site == "none" else "NONE"
 
@@ -463,8 +474,7 @@ def validate_and_normalise_user_input(
         app_info.framework,
         app_info.mode,
         jwt,
-        invalid_claim_status_code if (invalid_claim_status_code is not None) else 403
-        # TODO: above line was marked as TODO in review, not sure why.
+        invalid_claim_status_code,
     )
 
 
@@ -554,10 +564,9 @@ async def validate_claims_in_payload(
             validator.id,
             json.dumps(claim_validation_res.__dict__),
         )
-        if (
-            not claim_validation_res.is_valid
-            and claim_validation_res.reason is not None
-        ):
+        if not claim_validation_res.is_valid:
+            assert claim_validation_res.reason is not None
+
             validation_errors.append(
                 ClaimValidationError(validator.id, claim_validation_res.reason)
             )