Module supertokens_python.recipe.emailverification.emaildelivery.services.backward_compatibility

Expand source code
# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

from os import environ
from typing import Any, Dict

from httpx import AsyncClient
from supertokens_python.ingredients.emaildelivery.types import EmailDeliveryInterface
from supertokens_python.logger import log_debug_message
from supertokens_python.recipe.emailverification.types import (
    EmailVerificationUser,
    VerificationEmailTemplateVars,
)
from supertokens_python.supertokens import AppInfo
from supertokens_python.utils import handle_httpx_client_exceptions


async def create_and_send_email_using_supertokens_service(
    app_info: AppInfo, user: EmailVerificationUser, email_verification_url: str
) -> None:
    if ("SUPERTOKENS_ENV" in environ) and (environ["SUPERTOKENS_ENV"] == "testing"):
        return

    data = {
        "email": user.email,
        "appName": app_info.app_name,
        "emailVerifyURL": email_verification_url,
    }
    try:
        async with AsyncClient(timeout=30.0) as client:
            resp = await client.post("https://api.supertokens.io/0/st/auth/email/verify", json=data, headers={"api-version": "0"})  # type: ignore
            resp.raise_for_status()
            log_debug_message("Email verification email sent to %s", user.email)
    except Exception as e:
        log_debug_message("Error sending verification email")
        handle_httpx_client_exceptions(e, data)


class BackwardCompatibilityService(
    EmailDeliveryInterface[VerificationEmailTemplateVars]
):
    def __init__(
        self,
        app_info: AppInfo,
    ) -> None:
        self.app_info = app_info

    async def send_email(
        self,
        template_vars: VerificationEmailTemplateVars,
        user_context: Dict[str, Any],
    ) -> None:
        try:
            email_user = EmailVerificationUser(
                template_vars.user.recipe_user_id, template_vars.user.email
            )
            await create_and_send_email_using_supertokens_service(
                self.app_info, email_user, template_vars.email_verify_link
            )
        except Exception as _:
            pass

Functions

async def create_and_send_email_using_supertokens_service(app_info: AppInfo, user: EmailVerificationUser, email_verification_url: str) ‑> None
Expand source code
async def create_and_send_email_using_supertokens_service(
    app_info: AppInfo, user: EmailVerificationUser, email_verification_url: str
) -> None:
    if ("SUPERTOKENS_ENV" in environ) and (environ["SUPERTOKENS_ENV"] == "testing"):
        return

    data = {
        "email": user.email,
        "appName": app_info.app_name,
        "emailVerifyURL": email_verification_url,
    }
    try:
        async with AsyncClient(timeout=30.0) as client:
            resp = await client.post("https://api.supertokens.io/0/st/auth/email/verify", json=data, headers={"api-version": "0"})  # type: ignore
            resp.raise_for_status()
            log_debug_message("Email verification email sent to %s", user.email)
    except Exception as e:
        log_debug_message("Error sending verification email")
        handle_httpx_client_exceptions(e, data)

Classes

class BackwardCompatibilityService (app_info: AppInfo)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code
class BackwardCompatibilityService(
    EmailDeliveryInterface[VerificationEmailTemplateVars]
):
    def __init__(
        self,
        app_info: AppInfo,
    ) -> None:
        self.app_info = app_info

    async def send_email(
        self,
        template_vars: VerificationEmailTemplateVars,
        user_context: Dict[str, Any],
    ) -> None:
        try:
            email_user = EmailVerificationUser(
                template_vars.user.recipe_user_id, template_vars.user.email
            )
            await create_and_send_email_using_supertokens_service(
                self.app_info, email_user, template_vars.email_verify_link
            )
        except Exception as _:
            pass

Ancestors

Methods

async def send_email(self, template_vars: VerificationEmailTemplateVars, user_context: Dict[str, Any]) ‑> None
Expand source code
async def send_email(
    self,
    template_vars: VerificationEmailTemplateVars,
    user_context: Dict[str, Any],
) -> None:
    try:
        email_user = EmailVerificationUser(
            template_vars.user.recipe_user_id, template_vars.user.email
        )
        await create_and_send_email_using_supertokens_service(
            self.app_info, email_user, template_vars.email_verify_link
        )
    except Exception as _:
        pass