Merge pull request #225 from supertokens/fix/session-claims

test: Fix failing unit tests

Author: rishabhpoddar

supertokens_python/recipe/session/api/implementation.py

@@ -13,16 +13,17 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Union, List, Callable, Optional
+from typing import TYPE_CHECKING, Callable, List, Optional, Union
 
 from supertokens_python.normalised_url_path import NormalisedURLPath
 from supertokens_python.recipe.session.interfaces import (
     APIInterface,
-    SignOutOkayResponse,
     SessionClaimValidator,
+    SignOutOkayResponse,
 )
 from supertokens_python.types import MaybeAwaitable
 from supertokens_python.utils import normalise_http_method
+
 from ..utils import get_required_claim_validators
 
 if TYPE_CHECKING:

supertokens_python/recipe/session/interfaces.py

@@ -17,20 +17,21 @@
 from typing import (
     TYPE_CHECKING,
     Any,
+    Callable,
     Dict,
     Generic,
     List,
+    Optional,
     TypeVar,
     Union,
-    Callable,
-    Optional,
 )
 
 from supertokens_python.async_to_sync_wrapper import sync
-from supertokens_python.types import APIResponse, MaybeAwaitable
+from supertokens_python.types import APIResponse, GeneralErrorResponse, MaybeAwaitable
+
+from ...utils import resolve
 from .exceptions import ClaimValidationError
 from .utils import SessionConfig
-from ...utils import resolve
 
 if TYPE_CHECKING:
     from supertokens_python.framework import BaseRequest, BaseResponse
@@ -319,7 +320,7 @@ async def signout_post(
         session: Optional[SessionContainer],
         api_options: APIOptions,
         user_context: Dict[str, Any],
-    ) -> SignOutOkayResponse:
+    ) -> Union[SignOutOkayResponse, GeneralErrorResponse]:
         pass
 
     @abstractmethod

tests/auth-react/django3x/mysite/utils.py

@@ -1,17 +1,17 @@
 import os
-from typing import Any, Dict, List, Union, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from dotenv import load_dotenv
 from supertokens_python import InputAppInfo, Supertokens, SupertokensConfig, init
 from supertokens_python.framework.request import BaseRequest
 from supertokens_python.recipe import (
     emailpassword,
+    emailverification,
     passwordless,
     session,
     thirdparty,
     thirdpartyemailpassword,
     thirdpartypasswordless,
-    emailverification,
 )
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
 from supertokens_python.recipe.emailpassword.interfaces import (
@@ -25,10 +25,7 @@
     InputFormField,
     User,
 )
-from supertokens_python.recipe.emailverification.types import User as EVUser
-from supertokens_python.recipe.emailverification import (
-    EmailVerificationRecipe,
-)
+from supertokens_python.recipe.emailverification import EmailVerificationRecipe
 from supertokens_python.recipe.emailverification import (
     InputOverrideConfig as EVInputOverrideConfig,
 )
@@ -38,6 +35,7 @@
 from supertokens_python.recipe.emailverification.interfaces import (
     APIOptions as EVAPIOptions,
 )
+from supertokens_python.recipe.emailverification.types import User as EVUser
 from supertokens_python.recipe.jwt import JWTRecipe
 from supertokens_python.recipe.passwordless import (
     ContactEmailOnlyConfig,
@@ -51,7 +49,7 @@
     APIInterface as PasswordlessAPIInterface,
 )
 from supertokens_python.recipe.passwordless.interfaces import APIOptions as PAPIOptions
-from supertokens_python.recipe.session import SessionRecipe, SessionContainer
+from supertokens_python.recipe.session import SessionContainer, SessionRecipe
 from supertokens_python.recipe.session.interfaces import (
     APIInterface as SessionAPIInterface,
 )
@@ -86,7 +84,7 @@
 from supertokens_python.types import GeneralErrorResponse
 from typing_extensions import Literal
 
-from .store import save_url_with_token, save_code
+from .store import save_code, save_url_with_token
 
 load_dotenv()
 
@@ -592,7 +590,7 @@ async def signout_post(
                 "body", api_options.request
             )
             if is_general_error:
-                raise Exception("general error from signout API")
+                return GeneralErrorResponse("general error from signout API")
             return await original_signout_post(session, api_options, user_context)
 
         original_implementation.signout_post = signout_post
@@ -853,7 +851,7 @@ async def authorisation_url_get(
     recipe_list = [
         session.init(override=session.InputOverrideConfig(apis=override_session_apis)),
         emailverification.init(
-            mode="REQUIRED",
+            mode="OPTIONAL",
             create_and_send_custom_email=ev_create_and_send_custom_email,  # TODO: Is it correct to create a seperate func for this?
             override=EVInputOverrideConfig(apis=override_email_verification_apis),
         ),

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

@@ -661,7 +661,7 @@ async def signout_post(
                 "body", api_options.request
             )
             if is_general_error:
-                raise Exception("general error from signout API")
+                return GeneralErrorResponse("general error from signout API")
             return await original_signout_post(session, api_options, user_context)
 
         original_implementation.signout_post = signout_post
@@ -923,7 +923,7 @@ async def authorisation_url_get(
         userroles.init(),
         session.init(override=session.InputOverrideConfig(apis=override_session_apis)),
         emailverification.init(
-            mode="REQUIRED",
+            mode="OPTIONAL",
             create_and_send_custom_email=ev_create_and_send_custom_email,
             override=EVInputOverrideConfig(apis=override_email_verification_apis),
         ),

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

@@ -12,7 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 import os
-from typing import Any, Dict, List, Union, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from dotenv import load_dotenv
 from flask import Flask, g, jsonify, make_response, request
@@ -28,12 +28,12 @@
 from supertokens_python.framework.request import BaseRequest
 from supertokens_python.recipe import (
     emailpassword,
+    emailverification,
     passwordless,
     session,
     thirdparty,
     thirdpartyemailpassword,
     thirdpartypasswordless,
-    emailverification,
 )
 from supertokens_python.recipe.emailpassword import EmailPasswordRecipe
 from supertokens_python.recipe.emailpassword.interfaces import (
@@ -57,6 +57,7 @@
 from supertokens_python.recipe.emailverification.interfaces import (
     APIOptions as EVAPIOptions,
 )
+from supertokens_python.recipe.emailverification.types import User as EVUser
 from supertokens_python.recipe.jwt import JWTRecipe
 from supertokens_python.recipe.passwordless import (
     ContactEmailOnlyConfig,
@@ -74,9 +75,9 @@
 from supertokens_python.recipe.session.framework.flask import verify_session
 from supertokens_python.recipe.session.interfaces import (
     APIInterface as SessionAPIInterface,
-    SessionContainer,
 )
 from supertokens_python.recipe.session.interfaces import APIOptions as SAPIOptions
+from supertokens_python.recipe.session.interfaces import SessionContainer
 from supertokens_python.recipe.thirdparty import ThirdPartyRecipe
 from supertokens_python.recipe.thirdparty.interfaces import (
     APIInterface as ThirdpartyAPIInterface,
@@ -106,7 +107,6 @@
 )
 from supertokens_python.types import GeneralErrorResponse
 from typing_extensions import Literal
-from supertokens_python.recipe.emailverification.types import User as EVUser
 
 load_dotenv()
 
@@ -614,7 +614,7 @@ async def signout_post(
                 "body", api_options.request
             )
             if is_general_error:
-                raise Exception("general error from signout API")
+                return GeneralErrorResponse("general error from signout API")
             return await original_signout_post(session, api_options, user_context)
 
         original_implementation.signout_post = signout_post
@@ -895,7 +895,7 @@ async def authorisation_url_get(
     recipe_list = [
         session.init(override=session.InputOverrideConfig(apis=override_session_apis)),
         emailverification.init(
-            mode="REQUIRED",
+            mode="OPTIONAL",
             create_and_send_custom_email=ev_create_and_send_custom_email,
             override=EVInputOverrideConfig(apis=override_email_verification_apis),
         ),

tests/sessions/claims/test_verify_session.py

@@ -403,9 +403,12 @@ async def test_should_allow_if_assert_claims_returns_no_error(
         response = fastapi_client.get("/default-claims")
         assert response.status_code == 200
         assert "-" in response.json()["handle"]
-        mock.assert_called_once_with([validator], {})
+        mock.assert_called_once()
+        (validators, ctx), _ = mock.call_args_list[0]
+        assert validators == [validator]
+        assert ctx["_default"]["request"]
         recipe_impl_mock.validate_claims.assert_called_once_with(  # type: ignore
-            "test_user_id", {}, [validator], {}
+            "test_user_id", {}, [validator], ctx
         )