refactor: Fix circular dependency error in emailverification recipe and fix tests failures

Author: KShivendu

supertokens_python/recipe/emailpassword/recipe.py

@@ -115,10 +115,11 @@ def __init__(
         )
 
         def callback():
-            email_veriifcation_recipe = EmailVerificationRecipe.get_instance()
-            email_veriifcation_recipe.add_get_email_for_user_id_func(
-                self.get_email_for_user_id
-            )
+            ev_recipe = EmailVerificationRecipe.get_instance_optional()
+            if ev_recipe:
+                ev_recipe.add_get_email_for_user_id_func(
+                    self.get_email_for_user_id
+                )
 
         PostSTInitCallbacks.add_post_init_callback(callback)
 

supertokens_python/recipe/emailverification/__init__.py

@@ -15,17 +15,17 @@
 
 from typing import TYPE_CHECKING, Callable
 
-from supertokens_python.recipe.emailverification import ev_claim
 from . import exceptions as ex
 from . import utils
 from .emaildelivery import services as emaildelivery_services
-from .recipe import EmailVerificationRecipe
+from . import recipe
 
 InputOverrideConfig = utils.OverrideConfig
 ParentRecipeEmailVerificationConfig = utils.ParentRecipeEmailVerificationConfig
 exception = ex
 SMTPService = emaildelivery_services.SMTPService
-EmailVerificationClaim = ev_claim.EmailVerificationClaim
+EmailVerificationClaim = recipe.EmailVerificationClaim
+EmailVerificationRecipe = recipe.EmailVerificationRecipe
 
 
 if TYPE_CHECKING:

supertokens_python/recipe/emailverification/api/implementation.py

@@ -13,137 +13,7 @@
 # under the License.
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Dict, Union, Optional
-
-from supertokens_python.logger import log_debug_message
-from supertokens_python.recipe.emailverification import (
-    EmailVerificationRecipe,
-    EmailVerificationClaim,
-)
-from supertokens_python.recipe.emailverification.interfaces import (
-    APIInterface,
-    CreateEmailVerificationTokenEmailAlreadyVerifiedError,
-    EmailVerifyPostInvalidTokenError,
-    EmailVerifyPostOkResult,
-    GenerateEmailVerifyTokenPostEmailAlreadyVerifiedError,
-    GenerateEmailVerifyTokenPostOkResult,
-    IsEmailVerifiedGetOkResult,
-    VerifyEmailUsingTokenOkResult,
-    EmailDoesnotExistError,
-    GetEmailForUserIdOkResult,
-)
-from supertokens_python.recipe.session.interfaces import SessionContainer
+from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from supertokens_python.recipe.emailverification.interfaces import APIOptions
-
-from supertokens_python.recipe.emailverification.types import (
-    VerificationEmailTemplateVarsUser,
-    VerificationEmailTemplateVars,
-)
-
-
-class APIImplementation(APIInterface):
-    async def email_verify_post(
-        self,
-        token: str,
-        api_options: APIOptions,
-        user_context: Dict[str, Any],
-        session: Optional[SessionContainer] = None,
-    ) -> Union[EmailVerifyPostOkResult, EmailVerifyPostInvalidTokenError]:
-        response = await api_options.recipe_implementation.verify_email_using_token(
-            token, user_context
-        )
-        if isinstance(response, VerifyEmailUsingTokenOkResult):
-            if session is not None:
-                await session.fetch_and_set_claim(EmailVerificationClaim, user_context)
-
-            return EmailVerifyPostOkResult(response.user)
-        return EmailVerifyPostInvalidTokenError()
-
-    async def is_email_verified_get(
-        self,
-        api_options: APIOptions,
-        user_context: Dict[str, Any],
-        session: Optional[SessionContainer] = None,
-    ) -> IsEmailVerifiedGetOkResult:
-        if session is None:
-            raise Exception("Session is undefined. Should not come here.")
-        await session.fetch_and_set_claim(EmailVerificationClaim, user_context)
-        is_verified = await session.get_claim_value(
-            EmailVerificationClaim, user_context
-        )
-        # TODO: Type of is_verified should be bool. It's any for now.
-
-        if is_verified is None:
-            raise Exception(
-                "Should never come here: EmailVerificationClaim failed to set value"
-            )
-
-        return IsEmailVerifiedGetOkResult(is_verified)
-
-    async def generate_email_verify_token_post(
-        self,
-        api_options: APIOptions,
-        user_context: Dict[str, Any],
-        session: SessionContainer,
-    ) -> Union[
-        GenerateEmailVerifyTokenPostOkResult,
-        GenerateEmailVerifyTokenPostEmailAlreadyVerifiedError,
-    ]:
-        if session is None:
-            raise Exception("Session is undefined. Should not come here.")
-
-        user_id = session.get_user_id(user_context)
-        email_info = await EmailVerificationRecipe.get_instance().get_email_for_user_id(
-            user_id, user_context
-        )
-
-        if isinstance(email_info, EmailDoesnotExistError):
-            log_debug_message(
-                "Email verification email not sent to user %s because it doesn't have an email address.",
-                user_id,
-            )
-            return GenerateEmailVerifyTokenPostEmailAlreadyVerifiedError()
-        if isinstance(email_info, GetEmailForUserIdOkResult):
-            response = (
-                await api_options.recipe_implementation.create_email_verification_token(
-                    user_id,
-                    email_info.email,
-                    user_context,
-                )
-            )
-
-            if isinstance(
-                response, CreateEmailVerificationTokenEmailAlreadyVerifiedError
-            ):
-                log_debug_message(
-                    "Email verification email not sent to %s because it is already verified.",
-                    email_info.email,
-                )
-                return GenerateEmailVerifyTokenPostEmailAlreadyVerifiedError()
-
-            email_verify_link = (
-                api_options.app_info.website_domain.get_as_string_dangerous()
-                + api_options.app_info.website_base_path.get_as_string_dangerous()
-                + "/verify-email/"
-                + "?token="
-                + response.token
-                + "&rid="
-                + api_options.recipe_id
-            )
-
-            log_debug_message("Sending email verification email to %s", email_info)
-            email_verification_email_delivery_input = VerificationEmailTemplateVars(
-                user=VerificationEmailTemplateVarsUser(user_id, email_info.email),
-                email_verify_link=email_verify_link,
-                user_context=user_context,
-            )
-            await api_options.email_delivery.ingredient_interface_impl.send_email(
-                email_verification_email_delivery_input, user_context
-            )
-            return GenerateEmailVerifyTokenPostOkResult()
-
-        raise Exception(
-            "Should never come here: UNKNOWN_USER_ID or invalid result from get_email_for_user_id"
-        )
+    pass

supertokens_python/recipe/emailverification/ev_claim.py

@@ -14,11 +14,6 @@
 from __future__ import annotations
 from typing import Dict, Any
 
-from supertokens_python.recipe.emailverification import EmailVerificationRecipe
-from supertokens_python.recipe.emailverification.interfaces import (
-    GetEmailForUserIdOkResult,
-    EmailDoesnotExistError,
-)
 from supertokens_python.recipe.session.claim_base_classes.boolean_claim import (
     BooleanClaim,
     BooleanClaimValidators,
@@ -71,28 +66,3 @@ def is_verified(
         return IsVerifiedSCV(
             self.claim, has_value_res, refetch_time_on_false_in_seconds
         )
-
-
-class EmailVerificationClaimClass(BooleanClaim):
-    def __init__(self):
-        async def fetch_value(user_id: str, user_context: Dict[str, Any]) -> bool:
-            recipe = EmailVerificationRecipe.get_instance()
-            email_info = await recipe.get_email_for_user_id(user_id, user_context)
-
-            if isinstance(email_info, GetEmailForUserIdOkResult):
-                return await recipe.recipe_implementation.is_email_verified(
-                    user_id, email_info.email, user_context
-                )
-            if isinstance(email_info, EmailDoesnotExistError):
-                # we consider people without email addresses as validated
-                return True
-            raise Exception(
-                "Should never come here: UNKNOWN_USER_ID or invalid result from get_email_for_user"
-            )
-
-        super().__init__("st-ev", fetch_value)
-
-        self.validators = EmailVerificationClaimValidators(claim=self)
-
-
-EmailVerificationClaim = EmailVerificationClaimClass()