Module supertokens_python.recipe.thirdparty.recipe
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
from os import environ
from typing import TYPE_CHECKING, Any, Dict, List, Union
from supertokens_python.normalised_url_path import NormalisedURLPath
from supertokens_python.querier import Querier
from supertokens_python.recipe_module import APIHandled, RecipeModule
from .api.implementation import APIImplementation
from .interfaces import APIInterface, APIOptions, RecipeInterface
from .recipe_implementation import RecipeImplementation
from ..emailverification.interfaces import GetEmailForUserIdOkResult, UnknownUserIdError
from ...post_init_callbacks import PostSTInitCallbacks
if TYPE_CHECKING:
from supertokens_python.framework.request import BaseRequest
from supertokens_python.framework.response import BaseResponse
from supertokens_python.supertokens import AppInfo
from .utils import SignInAndUpFeature, InputOverrideConfig
from supertokens_python.exceptions import SuperTokensError, raise_general_exception
from supertokens_python.recipe.emailverification.recipe import EmailVerificationRecipe
from supertokens_python.recipe.multitenancy.recipe import MultitenancyRecipe
from .api import (
handle_apple_redirect_api,
handle_authorisation_url_api,
handle_sign_in_up_api,
)
from .constants import APPLE_REDIRECT_HANDLER, AUTHORISATIONURL, SIGNINUP
from .exceptions import SuperTokensThirdPartyError
from .types import ThirdPartyIngredients
from .utils import validate_and_normalise_user_input
class ThirdPartyRecipe(RecipeModule):
recipe_id = "thirdparty"
__instance = None
def __init__(
self,
recipe_id: str,
app_info: AppInfo,
sign_in_and_up_feature: SignInAndUpFeature,
_ingredients: ThirdPartyIngredients,
override: Union[InputOverrideConfig, None] = None,
):
super().__init__(recipe_id, app_info)
self.config = validate_and_normalise_user_input(
sign_in_and_up_feature,
override,
)
self.providers = self.config.sign_in_and_up_feature.providers
recipe_implementation = RecipeImplementation(
Querier.get_instance(recipe_id), self.providers
)
self.recipe_implementation: RecipeInterface = (
recipe_implementation
if self.config.override.functions is None
else self.config.override.functions(recipe_implementation)
)
api_implementation = APIImplementation()
self.api_implementation: APIInterface = (
api_implementation
if self.config.override.apis is None
else self.config.override.apis(api_implementation)
)
def callback():
ev_recipe = EmailVerificationRecipe.get_instance_optional()
if ev_recipe:
ev_recipe.add_get_email_for_user_id_func(self.get_email_for_user_id)
mt_recipe = MultitenancyRecipe.get_instance_optional()
if mt_recipe:
mt_recipe.static_third_party_providers = self.providers
PostSTInitCallbacks.add_post_init_callback(callback)
def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool:
return isinstance(err, SuperTokensError) and (
isinstance(err, SuperTokensThirdPartyError)
)
def get_apis_handled(self) -> List[APIHandled]:
return [
APIHandled(
NormalisedURLPath(SIGNINUP),
"post",
SIGNINUP,
self.api_implementation.disable_sign_in_up_post,
),
APIHandled(
NormalisedURLPath(AUTHORISATIONURL),
"get",
AUTHORISATIONURL,
self.api_implementation.disable_authorisation_url_get,
),
APIHandled(
NormalisedURLPath(APPLE_REDIRECT_HANDLER),
"post",
APPLE_REDIRECT_HANDLER,
self.api_implementation.disable_apple_redirect_handler_post,
),
]
async def handle_api_request(
self,
request_id: str,
tenant_id: str,
request: BaseRequest,
path: NormalisedURLPath,
method: str,
response: BaseResponse,
user_context: Dict[str, Any],
):
api_options = APIOptions(
request,
response,
self.recipe_id,
self.config,
self.recipe_implementation,
self.providers,
self.app_info,
)
if request_id == SIGNINUP:
return await handle_sign_in_up_api(
self.api_implementation, tenant_id, api_options, user_context
)
if request_id == AUTHORISATIONURL:
return await handle_authorisation_url_api(
self.api_implementation, tenant_id, api_options, user_context
)
if request_id == APPLE_REDIRECT_HANDLER:
return await handle_apple_redirect_api(
self.api_implementation, api_options, user_context
)
return None
async def handle_error(
self,
request: BaseRequest,
err: SuperTokensError,
response: BaseResponse,
user_context: Dict[str, Any],
) -> BaseResponse: # type: ignore
if isinstance(err, SuperTokensThirdPartyError):
raise err
def get_all_cors_headers(self) -> List[str]:
return []
@staticmethod
def init(
sign_in_and_up_feature: SignInAndUpFeature,
override: Union[InputOverrideConfig, None] = None,
):
def func(app_info: AppInfo):
if ThirdPartyRecipe.__instance is None:
ingredients = ThirdPartyIngredients()
ThirdPartyRecipe.__instance = ThirdPartyRecipe(
ThirdPartyRecipe.recipe_id,
app_info,
sign_in_and_up_feature,
ingredients,
override,
)
return ThirdPartyRecipe.__instance
raise_general_exception(
"ThirdParty recipe has already been initialised. Please check your code for bugs."
)
return func
@staticmethod
def get_instance() -> ThirdPartyRecipe:
if ThirdPartyRecipe.__instance is not None:
return ThirdPartyRecipe.__instance
raise_general_exception(
"Initialisation not done. Did you forget to call the SuperTokens.init function?"
)
@staticmethod
def reset():
if ("SUPERTOKENS_ENV" not in environ) or (
environ["SUPERTOKENS_ENV"] != "testing"
):
raise_general_exception("calling testing function in non testing env")
ThirdPartyRecipe.__instance = None
# instance functions below...............
async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any]):
user_info = await self.recipe_implementation.get_user_by_id(
user_id, user_context
)
if user_info is not None:
return GetEmailForUserIdOkResult(user_info.email)
return UnknownUserIdError()
Classes
class ThirdPartyRecipe (recipe_id: str, app_info: AppInfo, sign_in_and_up_feature: SignInAndUpFeature, _ingredients: ThirdPartyIngredients, override: Union[InputOverrideConfig, None] = None)
-
Helper class that provides a standard way to create an ABC using inheritance.
Expand source code
class ThirdPartyRecipe(RecipeModule): recipe_id = "thirdparty" __instance = None def __init__( self, recipe_id: str, app_info: AppInfo, sign_in_and_up_feature: SignInAndUpFeature, _ingredients: ThirdPartyIngredients, override: Union[InputOverrideConfig, None] = None, ): super().__init__(recipe_id, app_info) self.config = validate_and_normalise_user_input( sign_in_and_up_feature, override, ) self.providers = self.config.sign_in_and_up_feature.providers recipe_implementation = RecipeImplementation( Querier.get_instance(recipe_id), self.providers ) self.recipe_implementation: RecipeInterface = ( recipe_implementation if self.config.override.functions is None else self.config.override.functions(recipe_implementation) ) api_implementation = APIImplementation() self.api_implementation: APIInterface = ( api_implementation if self.config.override.apis is None else self.config.override.apis(api_implementation) ) def callback(): ev_recipe = EmailVerificationRecipe.get_instance_optional() if ev_recipe: ev_recipe.add_get_email_for_user_id_func(self.get_email_for_user_id) mt_recipe = MultitenancyRecipe.get_instance_optional() if mt_recipe: mt_recipe.static_third_party_providers = self.providers PostSTInitCallbacks.add_post_init_callback(callback) def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool: return isinstance(err, SuperTokensError) and ( isinstance(err, SuperTokensThirdPartyError) ) def get_apis_handled(self) -> List[APIHandled]: return [ APIHandled( NormalisedURLPath(SIGNINUP), "post", SIGNINUP, self.api_implementation.disable_sign_in_up_post, ), APIHandled( NormalisedURLPath(AUTHORISATIONURL), "get", AUTHORISATIONURL, self.api_implementation.disable_authorisation_url_get, ), APIHandled( NormalisedURLPath(APPLE_REDIRECT_HANDLER), "post", APPLE_REDIRECT_HANDLER, self.api_implementation.disable_apple_redirect_handler_post, ), ] async def handle_api_request( self, request_id: str, tenant_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any], ): api_options = APIOptions( request, response, self.recipe_id, self.config, self.recipe_implementation, self.providers, self.app_info, ) if request_id == SIGNINUP: return await handle_sign_in_up_api( self.api_implementation, tenant_id, api_options, user_context ) if request_id == AUTHORISATIONURL: return await handle_authorisation_url_api( self.api_implementation, tenant_id, api_options, user_context ) if request_id == APPLE_REDIRECT_HANDLER: return await handle_apple_redirect_api( self.api_implementation, api_options, user_context ) return None async def handle_error( self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any], ) -> BaseResponse: # type: ignore if isinstance(err, SuperTokensThirdPartyError): raise err def get_all_cors_headers(self) -> List[str]: return [] @staticmethod def init( sign_in_and_up_feature: SignInAndUpFeature, override: Union[InputOverrideConfig, None] = None, ): def func(app_info: AppInfo): if ThirdPartyRecipe.__instance is None: ingredients = ThirdPartyIngredients() ThirdPartyRecipe.__instance = ThirdPartyRecipe( ThirdPartyRecipe.recipe_id, app_info, sign_in_and_up_feature, ingredients, override, ) return ThirdPartyRecipe.__instance raise_general_exception( "ThirdParty recipe has already been initialised. Please check your code for bugs." ) return func @staticmethod def get_instance() -> ThirdPartyRecipe: if ThirdPartyRecipe.__instance is not None: return ThirdPartyRecipe.__instance raise_general_exception( "Initialisation not done. Did you forget to call the SuperTokens.init function?" ) @staticmethod def reset(): if ("SUPERTOKENS_ENV" not in environ) or ( environ["SUPERTOKENS_ENV"] != "testing" ): raise_general_exception("calling testing function in non testing env") ThirdPartyRecipe.__instance = None # instance functions below............... async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any]): user_info = await self.recipe_implementation.get_user_by_id( user_id, user_context ) if user_info is not None: return GetEmailForUserIdOkResult(user_info.email) return UnknownUserIdError()
Ancestors
- RecipeModule
- abc.ABC
Class variables
var get_tenant_id : Optional[Callable[[str, Dict[str, Any]], Awaitable[str]]]
var recipe_id
Static methods
def get_instance() ‑> ThirdPartyRecipe
-
Expand source code
@staticmethod def get_instance() -> ThirdPartyRecipe: if ThirdPartyRecipe.__instance is not None: return ThirdPartyRecipe.__instance raise_general_exception( "Initialisation not done. Did you forget to call the SuperTokens.init function?" )
def init(sign_in_and_up_feature: SignInAndUpFeature, override: Union[InputOverrideConfig, None] = None)
-
Expand source code
@staticmethod def init( sign_in_and_up_feature: SignInAndUpFeature, override: Union[InputOverrideConfig, None] = None, ): def func(app_info: AppInfo): if ThirdPartyRecipe.__instance is None: ingredients = ThirdPartyIngredients() ThirdPartyRecipe.__instance = ThirdPartyRecipe( ThirdPartyRecipe.recipe_id, app_info, sign_in_and_up_feature, ingredients, override, ) return ThirdPartyRecipe.__instance raise_general_exception( "ThirdParty recipe has already been initialised. Please check your code for bugs." ) return func
def reset()
-
Expand source code
@staticmethod def reset(): if ("SUPERTOKENS_ENV" not in environ) or ( environ["SUPERTOKENS_ENV"] != "testing" ): raise_general_exception("calling testing function in non testing env") ThirdPartyRecipe.__instance = None
Methods
def get_all_cors_headers(self) ‑> List[str]
-
Expand source code
def get_all_cors_headers(self) -> List[str]: return []
def get_apis_handled(self) ‑> List[APIHandled]
-
Expand source code
def get_apis_handled(self) -> List[APIHandled]: return [ APIHandled( NormalisedURLPath(SIGNINUP), "post", SIGNINUP, self.api_implementation.disable_sign_in_up_post, ), APIHandled( NormalisedURLPath(AUTHORISATIONURL), "get", AUTHORISATIONURL, self.api_implementation.disable_authorisation_url_get, ), APIHandled( NormalisedURLPath(APPLE_REDIRECT_HANDLER), "post", APPLE_REDIRECT_HANDLER, self.api_implementation.disable_apple_redirect_handler_post, ), ]
async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any])
-
Expand source code
async def get_email_for_user_id(self, user_id: str, user_context: Dict[str, Any]): user_info = await self.recipe_implementation.get_user_by_id( user_id, user_context ) if user_info is not None: return GetEmailForUserIdOkResult(user_info.email) return UnknownUserIdError()
async def handle_api_request(self, request_id: str, tenant_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any])
-
Expand source code
async def handle_api_request( self, request_id: str, tenant_id: str, request: BaseRequest, path: NormalisedURLPath, method: str, response: BaseResponse, user_context: Dict[str, Any], ): api_options = APIOptions( request, response, self.recipe_id, self.config, self.recipe_implementation, self.providers, self.app_info, ) if request_id == SIGNINUP: return await handle_sign_in_up_api( self.api_implementation, tenant_id, api_options, user_context ) if request_id == AUTHORISATIONURL: return await handle_authorisation_url_api( self.api_implementation, tenant_id, api_options, user_context ) if request_id == APPLE_REDIRECT_HANDLER: return await handle_apple_redirect_api( self.api_implementation, api_options, user_context ) return None
async def handle_error(self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any]) ‑> BaseResponse
-
Expand source code
async def handle_error( self, request: BaseRequest, err: SuperTokensError, response: BaseResponse, user_context: Dict[str, Any], ) -> BaseResponse: # type: ignore if isinstance(err, SuperTokensThirdPartyError): raise err
def is_error_from_this_recipe_based_on_instance(self, err: Exception) ‑> bool
-
Expand source code
def is_error_from_this_recipe_based_on_instance(self, err: Exception) -> bool: return isinstance(err, SuperTokensError) and ( isinstance(err, SuperTokensThirdPartyError) )