test invalid claims response with and without reason

Author: KShivendu

supertokens_python/recipe/session/exceptions.py

@@ -13,7 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import Union, Any, List, Dict
+from typing import Union, Any, List, Dict, Optional
 
 from supertokens_python.exceptions import SuperTokensError
 
@@ -56,13 +56,18 @@ class TryRefreshTokenError(SuperTokensSessionError):
 class InvalidClaimsError(SuperTokensSessionError):
     def __init__(self, msg: str, payload: List[ClaimValidationError]):
         super().__init__(msg)
-        self.payload = [
-            p.__dict__ for p in payload
-        ]  # Must be JSON serializable as it will be used in response
+        self.payload: List[Dict[str, Any]] = []
+        for p in payload:
+            res = (
+                p.__dict__.copy()
+            )  # Must be JSON serializable as it will be used in response
+            if p.reason is None:
+                res.pop("reason")
+            self.payload.append(res)
 
 
 class ClaimValidationError:
-    def __init__(self, id_: str, reason: Dict[str, Any]):
+    def __init__(self, id_: str, reason: Optional[Dict[str, Any]]):
         self.id = id_
         self.reason = reason
 

supertokens_python/recipe/session/utils.py

@@ -565,8 +565,6 @@ async def validate_claims_in_payload(
             json.dumps(claim_validation_res.__dict__),
         )
         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)
             )

tests/sessions/claims/test_verify_session.py

@@ -1,4 +1,4 @@
-from typing import List, Any, Dict, Union
+from typing import List, Any, Dict, Union, Optional
 from unittest.mock import patch
 
 from fastapi import FastAPI, Depends
@@ -99,13 +99,14 @@ def should_refetch(self, payload: JSONObject, user_context: Dict[str, Any]):
 
 
 class AlwaysInvalidValidator(SessionClaimValidator):
-    def __init__(self):
+    def __init__(self, reason: Optional[Dict[str, Any]]):
         super().__init__("always-invalid-validator", TrueClaim)
+        self.reason = reason
 
     async def validate(
         self, payload: JSONObject, user_context: Union[Dict[str, Any], None] = None
     ) -> ClaimValidationResult:
-        return ClaimValidationResult(is_valid=False, reason={"message": "foo"})
+        return ClaimValidationResult(is_valid=False, reason=self.reason)
 
     def should_refetch(self, payload: JSONObject, user_context: Dict[str, Any]) -> bool:
         return True
@@ -290,10 +291,28 @@ async def test_should_allow_with_custom_validator_returning_true(
     assert "-" in res.json()["handle"]
 
 
-async def test_should_reject_with_custom_validator_returning_false(
+async def test_should_reject_with_custom_validator_returning_false_without_reason(
     fastapi_client: TestClient,
 ):
-    custom_validator = AlwaysInvalidValidator()
+    custom_validator = AlwaysInvalidValidator(reason=None)
+
+    st_init_args = st_init_generator_with_claim_validator(custom_validator)
+    init(**st_init_args)  # type: ignore
+    start_st()
+
+    create_session(fastapi_client)
+    response = fastapi_client.get("/default-claims")
+    assert response.status_code == 403
+    assert response.json() == {
+        "message": "invalid claim",
+        "claimValidationErrors": [{"id": "always-invalid-validator"}],
+    }
+
+
+async def test_should_reject_with_custom_validator_returning_false_with_reason(
+    fastapi_client: TestClient,
+):
+    custom_validator = AlwaysInvalidValidator(reason={"message": "foo"})
 
     st_init_args = st_init_generator_with_claim_validator(custom_validator)
     init(**st_init_args)  # type: ignore
@@ -310,9 +329,6 @@ async def test_should_reject_with_custom_validator_returning_false(
     }
 
 
-# should reject with validator returning false with reason (Leaving this. It's exactly same as prev.)
-
-
 async def test_should_reject_if_assert_claims_returns_an_error(
     fastapi_client: TestClient,
 ):
@@ -440,7 +456,9 @@ async def test_should_reject_with_custom_claim_returning_false(
 ):
     # This gets overriden by override_global_claim_validators passed to verify_session()
     # in "/refetched-claim-isvalid-false" api
-    cv = AlwaysInvalidValidator()
+    cv = AlwaysInvalidValidator(
+        reason={"message": "does not matter because of override"}
+    )
     st_init_args = st_init_generator_with_claim_validator(cv)
     init(**st_init_args)  # type: ignore
     start_st()