feat: Add and use email verification claim #215
Conversation
…word recipe in favour of EV claims
…ess recipe in favour of EV claims
…avour of ev claims
…nd fix tests failures
…ecipeEmailVerificationConfig
| # | ||
| # class InputEmailVerificationConfig: | ||
| # def __init__( | ||
| # self, | ||
| # get_email_verification_url: Union[ | ||
| # Callable[[User, Dict[str, Any]], Awaitable[str]], None | ||
| # ] = None, | ||
| # create_and_send_custom_email: Union[ | ||
| # Callable[[User, str, Dict[str, Any]], Awaitable[None]], None | ||
| # ] = None, | ||
| # ): | ||
| # self.get_email_verification_url = get_email_verification_url | ||
| # self.create_and_send_custom_email = create_and_send_custom_email | ||
| # | ||
| # if create_and_send_custom_email: | ||
| # deprecated_warn( | ||
| # "create_and_send_custom_email is deprecated. Please use email delivery config instead" | ||
| # ) |
There was a problem hiding this comment.
remove this. Why commented?
| @@ -371,7 +313,7 @@ def __init__( | |||
| sign_up_feature: SignUpFeature, | |||
| sign_in_feature: SignInFeature, | |||
| reset_password_using_token_feature: ResetPasswordUsingTokenFeature, | |||
| email_verification_feature: ParentRecipeEmailVerificationConfig, | |||
| # email_verification_feature: ParentRecipeEmailVerificationConfig, | |||
There was a problem hiding this comment.
remove this - why commented?
| @@ -380,19 +322,18 @@ def __init__( | |||
| self.sign_up_feature = sign_up_feature | |||
| self.sign_in_feature = sign_in_feature | |||
| self.reset_password_using_token_feature = reset_password_using_token_feature | |||
| self.email_verification_feature = email_verification_feature | |||
| # self.email_verification_feature = email_verification_feature | |||
There was a problem hiding this comment.
remove this - why commented?
| # if email_verification_feature is not None and not isinstance(email_verification_feature, InputEmailVerificationConfig): # type: ignore | ||
| # raise ValueError( | ||
| # "email_verification_feature must be of type InputEmailVerificationConfig or None" | ||
| # ) |
There was a problem hiding this comment.
please remove all things that are commented like this.. not sure why you did this
There was a problem hiding this comment.
Removed this. Looked for more using Ctrl+F. Didn't find any others.
| user, user_context | ||
| ) | ||
| api_options.app_info.website_domain.get_as_string_dangerous() | ||
| + api_options.app_info.website_base_path.get_as_string_dangerous() | ||
| + "?token=" |
There was a problem hiding this comment.
| + "?token=" | |
| + "/reset-password?token=" |
| EmailVerificationClaim = EmailVerificationClaimClass() | ||
|
|
||
|
|
||
| class APIImplementation(APIInterface): |
There was a problem hiding this comment.
why is this moved into this file and not kept in the other file?
There was a problem hiding this comment.
There was a cyclic import error that kept me stuck for hours. I still don't know how to fix it. Generally, this happens because of types so we just use from _future__ import annotations and from typing import TYPE_CHECKING.
But here we are using using the class (not just its type) so the error is really hard to get rid of. I have already struggled with it for hours. The only feasible solution for now was to move the conflicting classes in the same file.
Need some help to fix it.
| self.get_email_for_user_id_funcs_from_other_recipes.append(f) | ||
|
|
||
|
|
||
| class EmailVerificationClaimClass(BooleanClaim): |
There was a problem hiding this comment.
why is this class in this file and not in the ev_claim.py file?
There was a problem hiding this comment.
I had to move the content to avoid cyclic import errors. It's really troublesome this time. Have already wasted hours. Need help to fix it.
|
|
||
| return UnknownUserIdError() | ||
|
|
||
| def add_get_email_for_user_id_func(self, f: Callable[[str, Dict[str, Any]], Any]): |
There was a problem hiding this comment.
why is the f argument so badly typed? Why is the return of it Any?
| self.validators = EmailVerificationClaimValidators(claim=self) | ||
|
|
||
|
|
||
| EmailVerificationClaim = EmailVerificationClaimClass() |
There was a problem hiding this comment.
how will the end user import this in their code (if they want to)?
There was a problem hiding this comment.
from supertokens_python.recipe.emailverification import EmailVerificationClaim
I know EmailVerificationClaim and EmailVerificationClaimClass() shouldn't be in recipe.py. But a nasty cyclic import error comes up if I seperate them. Need help in fixing it.
| is_verified = await session.get_claim_value( | ||
| EmailVerificationClaim, user_context | ||
| ) | ||
| # TODO: Type of is_verified should be bool. It's any for now. |
Summary of change
Add and use email verification claim
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Documentation changes
(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)
Checklist for important updates
coreDriverInterfaceSupported.jsonfile has been updated (if needed)supertokens_python/constants.pyfrontendDriverInterfaceSupported.jsonfile has been updated (if needed)setup.pysupertokens_python/constants.pygit tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.supertokens_python/utils.pyfile to include that in theFRAMEWORKSvariable