Merge pull request #395 from supertokens/fix/thirdparty-config-mt

fix: Clean up thirdparty recipe and make it consistent with other python recipes

Author: rishabhpoddar

supertokens_python/recipe/openid/recipe.py

@@ -17,7 +17,6 @@
 from typing import TYPE_CHECKING, List, Union, Optional, Any, Dict
 
 from supertokens_python.querier import Querier
-from supertokens_python.recipe.jwt import JWTRecipe
 
 from .api.implementation import APIImplementation
 from .api.open_id_discovery_configuration_get import open_id_discovery_configuration_get
@@ -49,6 +48,8 @@ def __init__(
         issuer: Union[str, None] = None,
         override: Union[InputOverrideConfig, None] = None,
     ):
+        from supertokens_python.recipe.jwt import JWTRecipe
+
         super().__init__(recipe_id, app_info)
         self.config = validate_and_normalise_user_input(app_info, issuer, override)
         jwt_feature = None

supertokens_python/recipe/session/recipe.py

@@ -28,7 +28,6 @@
     UnauthorisedError,
     InvalidClaimsError,
 )
-from ... import AppInfo
 from ...types import MaybeAwaitable
 
 if TYPE_CHECKING:

supertokens_python/recipe/session/session_request_functions.py

@@ -51,7 +51,6 @@
     TokenTransferMethod,
     get_required_claim_validators,
 )
-from supertokens_python.supertokens import AppInfo
 from supertokens_python.types import MaybeAwaitable
 from supertokens_python.utils import (
     FRAMEWORKS,
@@ -60,10 +59,11 @@
     normalise_http_method,
     set_request_in_user_context_if_not_defined,
 )
-from supertokens_python import Supertokens
+from supertokens_python.supertokens import Supertokens
 
 if TYPE_CHECKING:
     from supertokens_python.recipe.session.recipe import SessionRecipe
+    from supertokens_python.supertokens import AppInfo
 
 LEGACY_ID_REFRESH_TOKEN_COOKIE_NAME = "sIdRefreshToken"
 

supertokens_python/recipe/thirdparty/provider.py

@@ -41,13 +41,15 @@ def __init__(
 
 
 class Provider:
-    def __init__(self, id: str):  # pylint: disable=redefined-builtin
+    def __init__(
+        self, id: str, config: ProviderConfigForClient
+    ):  # pylint: disable=redefined-builtin
         self.id = id
-        self.config = ProviderConfigForClientType("temp")
+        self.config = config
 
     async def get_config_for_client_type(  # pylint: disable=no-self-use
         self, client_type: Optional[str], user_context: Dict[str, Any]
-    ) -> ProviderConfigForClientType:
+    ) -> ProviderConfigForClient:
         _ = client_type
         __ = user_context
         raise NotImplementedError()
@@ -110,60 +112,6 @@ def to_json(self) -> Dict[str, Any]:
         return {k: v for k, v in res.items() if v is not None}
 
 
-class ProviderConfigForClientType:
-    def __init__(
-        self,
-        client_id: str,
-        client_secret: Optional[str] = None,
-        scope: Optional[List[str]] = None,
-        force_pkce: bool = False,
-        additional_config: Optional[Dict[str, Any]] = None,
-        name: Optional[str] = None,
-        authorization_endpoint: Optional[str] = None,
-        authorization_endpoint_query_params: Optional[
-            Dict[str, Union[str, None]]
-        ] = None,
-        token_endpoint: Optional[str] = None,
-        token_endpoint_body_params: Optional[Dict[str, Union[str, None]]] = None,
-        user_info_endpoint: Optional[str] = None,
-        user_info_endpoint_query_params: Optional[Dict[str, Union[str, None]]] = None,
-        user_info_endpoint_headers: Optional[Dict[str, Union[str, None]]] = None,
-        jwks_uri: Optional[str] = None,
-        oidc_discovery_endpoint: Optional[str] = None,
-        user_info_map: Optional[UserInfoMap] = None,
-        require_email: bool = True,
-        generate_fake_email: Optional[
-            Callable[[str, str, Dict[str, Any]], Awaitable[str]]
-        ] = None,
-        validate_id_token_payload: Optional[
-            Callable[
-                [Dict[str, Any], ProviderConfigForClientType, Dict[str, Any]],
-                Awaitable[None],
-            ]
-        ] = None,
-    ):
-        self.client_id = client_id
-        self.client_secret = client_secret
-        self.scope = scope
-        self.force_pkce = force_pkce
-        self.additional_config = additional_config
-
-        self.name = name
-        self.authorization_endpoint = authorization_endpoint
-        self.authorization_endpoint_query_params = authorization_endpoint_query_params
-        self.token_endpoint = token_endpoint
-        self.token_endpoint_body_params = token_endpoint_body_params
-        self.user_info_endpoint = user_info_endpoint
-        self.user_info_endpoint_query_params = user_info_endpoint_query_params
-        self.user_info_endpoint_headers = user_info_endpoint_headers
-        self.jwks_uri = jwks_uri
-        self.oidc_discovery_endpoint = oidc_discovery_endpoint
-        self.user_info_map = user_info_map
-        self.require_email = require_email
-        self.validate_id_token_payload = validate_id_token_payload
-        self.generate_fake_email = generate_fake_email
-
-
 class UserFields:
     def __init__(
         self,
@@ -201,12 +149,11 @@ def to_json(self) -> Dict[str, Any]:
         }
 
 
-class ProviderConfig:
+class CommonProviderConfig:
     def __init__(
         self,
         third_party_id: str,
         name: Optional[str] = None,
-        clients: Optional[List[ProviderClientConfig]] = None,
         authorization_endpoint: Optional[str] = None,
         authorization_endpoint_query_params: Optional[
             Dict[str, Union[str, None]]
@@ -222,7 +169,7 @@ def __init__(
         require_email: bool = True,
         validate_id_token_payload: Optional[
             Callable[
-                [Dict[str, Any], ProviderConfigForClientType, Dict[str, Any]],
+                [Dict[str, Any], ProviderConfigForClient, Dict[str, Any]],
                 Awaitable[None],
             ]
         ] = None,
@@ -232,7 +179,6 @@ def __init__(
     ):
         self.third_party_id = third_party_id
         self.name = name
-        self.clients = clients
         self.authorization_endpoint = authorization_endpoint
         self.authorization_endpoint_query_params = authorization_endpoint_query_params
         self.token_endpoint = token_endpoint
@@ -251,9 +197,6 @@ def to_json(self) -> Dict[str, Any]:
         res = {
             "thirdPartyId": self.third_party_id,
             "name": self.name,
-            "clients": [c.to_json() for c in self.clients]
-            if self.clients is not None
-            else [],
             "authorizationEndpoint": self.authorization_endpoint,
             "authorizationEndpointQueryParams": self.authorization_endpoint_query_params,
             "tokenEndpoint": self.token_endpoint,
@@ -272,6 +215,132 @@ def to_json(self) -> Dict[str, Any]:
         return {k: v for k, v in res.items() if v is not None}
 
 
+class ProviderConfigForClient(ProviderClientConfig, CommonProviderConfig):
+    def __init__(
+        self,
+        # ProviderClientConfig:
+        client_id: str,
+        client_secret: Optional[str] = None,
+        client_type: Optional[str] = None,
+        scope: Optional[List[str]] = None,
+        force_pkce: bool = False,
+        additional_config: Optional[Dict[str, Any]] = None,
+        # CommonProviderConfig:
+        name: Optional[str] = None,
+        authorization_endpoint: Optional[str] = None,
+        authorization_endpoint_query_params: Optional[
+            Dict[str, Union[str, None]]
+        ] = None,
+        token_endpoint: Optional[str] = None,
+        token_endpoint_body_params: Optional[Dict[str, Union[str, None]]] = None,
+        user_info_endpoint: Optional[str] = None,
+        user_info_endpoint_query_params: Optional[Dict[str, Union[str, None]]] = None,
+        user_info_endpoint_headers: Optional[Dict[str, Union[str, None]]] = None,
+        jwks_uri: Optional[str] = None,
+        oidc_discovery_endpoint: Optional[str] = None,
+        user_info_map: Optional[UserInfoMap] = None,
+        require_email: bool = True,
+        validate_id_token_payload: Optional[
+            Callable[
+                [Dict[str, Any], ProviderConfigForClient, Dict[str, Any]],
+                Awaitable[None],
+            ]
+        ] = None,
+        generate_fake_email: Optional[
+            Callable[[str, str, Dict[str, Any]], Awaitable[str]]
+        ] = None,
+    ):
+        ProviderClientConfig.__init__(
+            self,
+            client_id,
+            client_secret,
+            client_type,
+            scope,
+            force_pkce,
+            additional_config,
+        )
+        CommonProviderConfig.__init__(
+            self,
+            "temp",
+            name,
+            authorization_endpoint,
+            authorization_endpoint_query_params,
+            token_endpoint,
+            token_endpoint_body_params,
+            user_info_endpoint,
+            user_info_endpoint_query_params,
+            user_info_endpoint_headers,
+            jwks_uri,
+            oidc_discovery_endpoint,
+            user_info_map,
+            require_email,
+            validate_id_token_payload,
+            generate_fake_email,
+        )
+
+    def to_json(self) -> Dict[str, Any]:
+        d1 = ProviderClientConfig.to_json(self)
+        d2 = CommonProviderConfig.to_json(self)
+        return {**d1, **d2}
+
+
+class ProviderConfig(CommonProviderConfig):
+    def __init__(
+        self,
+        third_party_id: str,
+        name: Optional[str] = None,
+        clients: Optional[List[ProviderClientConfig]] = None,
+        authorization_endpoint: Optional[str] = None,
+        authorization_endpoint_query_params: Optional[
+            Dict[str, Union[str, None]]
+        ] = None,
+        token_endpoint: Optional[str] = None,
+        token_endpoint_body_params: Optional[Dict[str, Union[str, None]]] = None,
+        user_info_endpoint: Optional[str] = None,
+        user_info_endpoint_query_params: Optional[Dict[str, Union[str, None]]] = None,
+        user_info_endpoint_headers: Optional[Dict[str, Union[str, None]]] = None,
+        jwks_uri: Optional[str] = None,
+        oidc_discovery_endpoint: Optional[str] = None,
+        user_info_map: Optional[UserInfoMap] = None,
+        require_email: bool = True,
+        validate_id_token_payload: Optional[
+            Callable[
+                [Dict[str, Any], ProviderConfigForClient, Dict[str, Any]],
+                Awaitable[None],
+            ]
+        ] = None,
+        generate_fake_email: Optional[
+            Callable[[str, str, Dict[str, Any]], Awaitable[str]]
+        ] = None,
+    ):
+        super().__init__(
+            third_party_id,
+            name,
+            authorization_endpoint,
+            authorization_endpoint_query_params,
+            token_endpoint,
+            token_endpoint_body_params,
+            user_info_endpoint,
+            user_info_endpoint_query_params,
+            user_info_endpoint_headers,
+            jwks_uri,
+            oidc_discovery_endpoint,
+            user_info_map,
+            require_email,
+            validate_id_token_payload,
+            generate_fake_email,
+        )
+        self.clients = clients
+
+    def to_json(self) -> Dict[str, Any]:
+        d = CommonProviderConfig.to_json(self)
+
+        if self.clients is not None:
+            d["clients"] = [c.to_json() for c in self.clients]
+
+        return d
+
+
 class ProviderInput:
     def __init__(
         self,

supertokens_python/recipe/thirdparty/providers/active_directory.py

@@ -17,7 +17,7 @@
 from .custom import GenericProvider, NewProvider
 from ..provider import (
     Provider,
-    ProviderConfigForClientType,
+    ProviderConfigForClient,
     ProviderInput,
     UserFields,
     UserInfoMap,
@@ -27,7 +27,7 @@
 class ActiveDirectoryImpl(GenericProvider):
     async def get_config_for_client_type(
         self, client_type: Optional[str], user_context: Dict[str, Any]
-    ) -> ProviderConfigForClientType:
+    ) -> ProviderConfigForClient:
         config = await super().get_config_for_client_type(client_type, user_context)
         if config.oidc_discovery_endpoint is None:
             if (

supertokens_python/recipe/thirdparty/providers/apple.py

@@ -19,14 +19,14 @@
 from time import time
 
 from .custom import GenericProvider, NewProvider
-from ..provider import Provider, ProviderConfigForClientType, ProviderInput
+from ..provider import Provider, ProviderConfigForClient, ProviderInput
 from .utils import get_actual_client_id_from_development_client_id
 
 
 class AppleImpl(GenericProvider):
     async def get_config_for_client_type(
         self, client_type: Optional[str], user_context: Dict[str, Any]
-    ) -> ProviderConfigForClientType:
+    ) -> ProviderConfigForClient:
         config = await super().get_config_for_client_type(client_type, user_context)
 
         if config.scope is None:
@@ -38,7 +38,7 @@ async def get_config_for_client_type(
         return config
 
     async def _get_client_secret(  # pylint: disable=no-self-use
-        self, config: ProviderConfigForClientType
+        self, config: ProviderConfigForClient
     ) -> str:
         if (
             config.additional_config is None

supertokens_python/recipe/thirdparty/providers/boxy_saml.py

@@ -17,7 +17,7 @@
 from .custom import GenericProvider, NewProvider
 from ..provider import (
     Provider,
-    ProviderConfigForClientType,
+    ProviderConfigForClient,
     ProviderInput,
     UserFields,
     UserInfoMap,
@@ -27,7 +27,7 @@
 class BoxySAMLImpl(GenericProvider):
     async def get_config_for_client_type(
         self, client_type: Optional[str], user_context: Dict[str, Any]
-    ) -> ProviderConfigForClientType:
+    ) -> ProviderConfigForClient:
         config = await super().get_config_for_client_type(client_type, user_context)
         if (
             config.additional_config is None

supertokens_python/recipe/thirdparty/providers/config_utils.py

@@ -17,7 +17,7 @@
 
 from ..provider import (
     ProviderConfig,
-    ProviderConfigForClientType,
+    ProviderConfigForClient,
     ProviderInput,
     Provider,
     UserFields,
@@ -216,8 +216,8 @@ async def get_oidc_discovery_info(issuer: str):
 
 
 async def discover_oidc_endpoints(
-    config: ProviderConfigForClientType,
-) -> ProviderConfigForClientType:
+    config: ProviderConfigForClient,
+) -> ProviderConfigForClient:
     if config.oidc_discovery_endpoint is None:
         return config