Module supertokens_python.recipe.passwordless.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 __future__ import annotations
import json
from os import environ
from typing import Any, Awaitable, Callable, Dict, Union
from httpx import AsyncClient, HTTPStatusError
from supertokens_python.ingredients.emaildelivery import EmailDeliveryInterface
from supertokens_python.logger import log_debug_message
from supertokens_python.recipe.passwordless.types import \
PasswordlessLoginEmailTemplateVars
from supertokens_python.supertokens import AppInfo
from supertokens_python.utils import handle_httpx_client_exceptions
def default_create_and_send_custom_email(app_info: AppInfo) -> Callable[[PasswordlessLoginEmailTemplateVars, Dict[str, Any]], Awaitable[None]]:
async def func(input_: PasswordlessLoginEmailTemplateVars, _: Dict[str, Any]):
if ('SUPERTOKENS_ENV' in environ) and (environ['SUPERTOKENS_ENV'] == 'testing'):
return
data = {
"email": input_.email,
"appName": app_info.app_name,
"codeLifetime": input_.code_life_time,
}
if input_.url_with_link_code:
data['urlWithLinkCode'] = input_.url_with_link_code
if input_.user_input_code:
data['userInputCode'] = input_.user_input_code
try:
async with AsyncClient() as client:
resp = await client.post('https://api.supertokens.io/0/st/auth/passwordless/login', json=data, headers={'api-version': '0'}) # type: ignore
resp.raise_for_status()
log_debug_message("Passwordless login email sent to %s", input_.email)
except Exception as e:
log_debug_message("Error sending passwordless login email")
handle_httpx_client_exceptions(e, data)
# If the error is thrown from the API:
if isinstance(e, HTTPStatusError):
body: Dict[str, Any] = e.response.json() # type: ignore
if body.get("err"):
msg = body["err"]
else:
msg = json.dumps(body)
raise Exception(msg)
raise e
return func
class BackwardCompatibilityService(EmailDeliveryInterface[PasswordlessLoginEmailTemplateVars]):
def __init__(self,
app_info: AppInfo,
create_and_send_custom_email: Union[
Callable[[PasswordlessLoginEmailTemplateVars, Dict[str, Any]], Awaitable[None]],
None
] = None
) -> None:
self.create_and_send_custom_email = create_and_send_custom_email if create_and_send_custom_email is not None else default_create_and_send_custom_email(app_info)
async def send_email(self, template_vars: PasswordlessLoginEmailTemplateVars, user_context: Dict[str, Any]) -> None:
await self.create_and_send_custom_email(template_vars, user_context) # Note: intentionally not using try-except (unlike other recipes)
Functions
def default_create_and_send_custom_email(app_info: AppInfo) ‑> Callable[[CreateAndSendCustomEmailParameters, Dict[str, Any]], Awaitable[None]]
-
Expand source code
def default_create_and_send_custom_email(app_info: AppInfo) -> Callable[[PasswordlessLoginEmailTemplateVars, Dict[str, Any]], Awaitable[None]]: async def func(input_: PasswordlessLoginEmailTemplateVars, _: Dict[str, Any]): if ('SUPERTOKENS_ENV' in environ) and (environ['SUPERTOKENS_ENV'] == 'testing'): return data = { "email": input_.email, "appName": app_info.app_name, "codeLifetime": input_.code_life_time, } if input_.url_with_link_code: data['urlWithLinkCode'] = input_.url_with_link_code if input_.user_input_code: data['userInputCode'] = input_.user_input_code try: async with AsyncClient() as client: resp = await client.post('https://api.supertokens.io/0/st/auth/passwordless/login', json=data, headers={'api-version': '0'}) # type: ignore resp.raise_for_status() log_debug_message("Passwordless login email sent to %s", input_.email) except Exception as e: log_debug_message("Error sending passwordless login email") handle_httpx_client_exceptions(e, data) # If the error is thrown from the API: if isinstance(e, HTTPStatusError): body: Dict[str, Any] = e.response.json() # type: ignore if body.get("err"): msg = body["err"] else: msg = json.dumps(body) raise Exception(msg) raise e return func
Classes
class BackwardCompatibilityService (app_info: AppInfo, create_and_send_custom_email: Union[Callable[[PasswordlessLoginEmailTemplateVars, Dict[str, Any]], Awaitable[None]], None] = None)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class BackwardCompatibilityService(EmailDeliveryInterface[PasswordlessLoginEmailTemplateVars]): def __init__(self, app_info: AppInfo, create_and_send_custom_email: Union[ Callable[[PasswordlessLoginEmailTemplateVars, Dict[str, Any]], Awaitable[None]], None ] = None ) -> None: self.create_and_send_custom_email = create_and_send_custom_email if create_and_send_custom_email is not None else default_create_and_send_custom_email(app_info) async def send_email(self, template_vars: PasswordlessLoginEmailTemplateVars, user_context: Dict[str, Any]) -> None: await self.create_and_send_custom_email(template_vars, user_context) # Note: intentionally not using try-except (unlike other recipes)
Ancestors
- EmailDeliveryInterface
- abc.ABC
- typing.Generic
Methods
async def send_email(self, template_vars: PasswordlessLoginEmailTemplateVars, user_context: Dict[str, Any]) ‑> None
-
Expand source code
async def send_email(self, template_vars: PasswordlessLoginEmailTemplateVars, user_context: Dict[str, Any]) -> None: await self.create_and_send_custom_email(template_vars, user_context) # Note: intentionally not using try-except (unlike other recipes)