fix: Update serialization keys and add tests

Author: KShivendu

supertokens_python/recipe/multitenancy/recipe_implementation.py

@@ -52,6 +52,7 @@ def parse_tenant_config(tenant: Dict[str, Any]) -> TenantConfigResponse:
         UserInfoMap,
         UserFields,
         ProviderClientConfig,
+        ProviderConfig,
     )
 
     providers: List[ProviderConfig] = []
@@ -76,33 +77,33 @@ def parse_tenant_config(tenant: Dict[str, Any]) -> TenantConfigResponse:
         providers.append(
             ProviderConfig(
                 third_party_id=p["thirdPartyId"],
-                name=p["name"],
+                name=p.get("name"),
                 clients=[
                     ProviderClientConfig(
                         client_id=c["clientId"],
-                        client_secret=c["clientSecret"],
-                        client_type=c["clientType"],
-                        scope=c["scope"],
-                        force_pkce=c["forcePkce"],
-                        additional_config=c["additionalConfig"],
+                        client_secret=c.get("clientSecret"),
+                        client_type=c.get("clientType"),
+                        scope=c.get("scope"),
+                        force_pkce=c.get("forcePKCE", False),
+                        additional_config=c.get("additionalConfig"),
                     )
                     for c in p["clients"]
                 ],
-                authorization_endpoint=p["authorizationEndpoint"],
-                authorization_endpoint_query_params=p[
+                authorization_endpoint=p.get("authorizationEndpoint"),
+                authorization_endpoint_query_params=p.get(
                     "authorizationEndpointQueryParams"
-                ],
-                token_endpoint=p["tokenEndpoint"],
-                token_endpoint_body_params=p["tokenEndpointBodyParams"],
-                user_info_endpoint=p["userInfoEndpoint"],
-                user_info_endpoint_query_params=p["userInfoEndpointQueryParams"],
-                user_info_endpoint_headers=p["userInfoEndpointHeaders"],
-                jwks_uri=p["jwksUri"],
-                oidc_discovery_endpoint=p["oidcDiscoveryEndpoint"],
+                ),
+                token_endpoint=p.get("tokenEndpoint"),
+                token_endpoint_body_params=p.get("tokenEndpointBodyParams"),
+                user_info_endpoint=p.get("userInfoEndpoint"),
+                user_info_endpoint_query_params=p.get("userInfoEndpointQueryParams"),
+                user_info_endpoint_headers=p.get("userInfoEndpointHeaders"),
+                jwks_uri=p.get("jwksURI"),
+                oidc_discovery_endpoint=p.get("oidcDiscoveryEndpoint"),
                 user_info_map=user_info_map,
-                require_email=p["requireEmail"],
-                validate_id_token_payload=p["validateIdTokenPayload"],
-                generate_fake_email=p["generateFakeEmail"],
+                require_email=p.get("requireEmail", True),
+                validate_id_token_payload=None,
+                generate_fake_email=None,
             )
         )
 

supertokens_python/recipe/thirdparty/provider.py

@@ -103,7 +103,7 @@ def to_json(self) -> Dict[str, Any]:
             "clientSecret": self.client_secret,
             "clientType": self.client_type,
             "scope": self.scope,
-            "forcePkce": self.force_pkce,
+            "forcePKCE": self.force_pkce,
             "additionalConfig": self.additional_config,
         }
 
@@ -261,7 +261,7 @@ def to_json(self) -> Dict[str, Any]:
             "userInfoEndpoint": self.user_info_endpoint,
             "userInfoEndpointQueryParams": self.user_info_endpoint_query_params,
             "userInfoEndpointHeaders": self.user_info_endpoint_headers,
-            "jwksUri": self.jwks_uri,
+            "jwksURI": self.jwks_uri,
             "oidcDiscoveryEndpoint": self.oidc_discovery_endpoint,
             "userInfoMap": self.user_info_map.to_json()
             if self.user_info_map is not None

tests/multitenancy/test_tenants_crud.py

@@ -14,6 +14,7 @@
 from fastapi import FastAPI
 from pytest import mark, fixture
 from starlette.testclient import TestClient
+from typing import Any, Dict
 
 from supertokens_python import init
 from supertokens_python.framework.fastapi import get_middleware
@@ -47,6 +48,8 @@
 from supertokens_python.recipe.thirdparty.provider import (
     ProviderConfig,
     ProviderClientConfig,
+    UserInfoMap,
+    UserFields,
 )
 
 
@@ -130,28 +133,100 @@ async def test_tenant_thirdparty_config():
     tenant_config = await get_tenant("t1")
 
     assert len(tenant_config.third_party.providers) == 1
-    assert tenant_config.third_party.providers[0].third_party_id == "google"
-    assert tenant_config.third_party.providers[0].clients is not None
-    assert len(tenant_config.third_party.providers[0].clients) == 1
-    assert tenant_config.third_party.providers[0].clients[0].client_id == "abcd"
+    provider = tenant_config.third_party.providers[0]
+    assert provider.third_party_id == "google"
+    assert provider.clients is not None
+    assert len(provider.clients) == 1
+    assert provider.clients[0].client_id == "abcd"
+    assert provider.clients[0].client_secret is None
+    assert provider.clients[0].force_pkce is False
+    assert provider.require_email is True
+
+    async def validate_id_token_payload(
+        _: Dict[str, Any], __: Any, ___: Dict[str, Any]
+    ):
+        return
+
+    async def generate_fake_email(_: str, __: Dict[str, Any]):
+        return "[email protected]"
 
     # update thirdparty config
     await create_or_update_third_party_config(
         "t1",
         ProviderConfig(
             third_party_id="google",
             name="Custom name",
-            clients=[ProviderClientConfig(client_id="efgh")],
+            clients=[
+                ProviderClientConfig(
+                    client_id="efgh",
+                    client_secret="ijkl",
+                    scope=["m", "n"],
+                    force_pkce=True,
+                    additional_config={"o": "p"},
+                )
+            ],
+            authorization_endpoint="http://localhost:8080/auth",
+            authorization_endpoint_query_params={"a": "b"},
+            token_endpoint="http://localhost:8080/token",
+            token_endpoint_body_params={"c": "d"},
+            user_info_endpoint="http://localhost:8080/userinfo",
+            user_info_endpoint_query_params={"e": "f"},
+            user_info_endpoint_headers={"g": "h"},
+            jwks_uri="http://localhost:8080/.well-known/jwks.json",
+            oidc_discovery_endpoint="http://localhost:8080/.well-known/openid-configuration",
+            user_info_map=UserInfoMap(
+                from_id_token_payload=UserFields(
+                    user_id="userid",
+                    email="email",
+                    email_verified="is_verified",
+                ),
+                from_user_info_api=UserFields(),
+            ),
+            require_email=False,
+            validate_id_token_payload=validate_id_token_payload,
+            generate_fake_email=generate_fake_email,
         ),
     )
 
     tenant_config = await get_tenant("t1")
     assert len(tenant_config.third_party.providers) == 1
-    assert tenant_config.third_party.providers[0].third_party_id == "google"
-    assert tenant_config.third_party.providers[0].name == "Custom name"
-    assert tenant_config.third_party.providers[0].clients is not None
-    assert len(tenant_config.third_party.providers[0].clients) == 1
-    assert tenant_config.third_party.providers[0].clients[0].client_id == "efgh"
+    provider = tenant_config.third_party.providers[0]
+    assert provider.third_party_id == "google"
+    assert provider.name == "Custom name"
+    assert provider.clients is not None
+    assert len(provider.clients) == 1
+    assert provider.clients[0].client_id == "efgh"
+    assert provider.clients[0].client_secret == "ijkl"
+    assert provider.clients[0].scope == ["m", "n"]
+    assert provider.clients[0].force_pkce is True
+    assert provider.clients[0].additional_config == {"o": "p"}
+
+    assert provider.name == "Custom name"
+    assert provider.authorization_endpoint == "http://localhost:8080/auth"
+    assert provider.authorization_endpoint_query_params == {"a": "b"}
+    assert provider.token_endpoint == "http://localhost:8080/token"
+    assert provider.token_endpoint_body_params == {"c": "d"}
+    assert provider.user_info_endpoint == "http://localhost:8080/userinfo"
+    assert provider.user_info_endpoint_query_params == {"e": "f"}
+    assert provider.user_info_endpoint_headers == {"g": "h"}
+    assert provider.jwks_uri == "http://localhost:8080/.well-known/jwks.json"
+    assert (
+        provider.oidc_discovery_endpoint
+        == "http://localhost:8080/.well-known/openid-configuration"
+    )
+
+    assert provider.user_info_map is not None
+    assert provider.user_info_map.from_id_token_payload.user_id == "userid"
+    assert provider.user_info_map.from_id_token_payload.email == "email"
+    assert provider.user_info_map.from_id_token_payload.email_verified == "is_verified"
+    assert provider.user_info_map.from_user_info_api is not None
+    assert provider.user_info_map.from_user_info_api.user_id is None
+    assert provider.user_info_map.from_user_info_api.email is None
+    assert provider.user_info_map.from_user_info_api.email_verified is None
+
+    assert provider.require_email is False
+    assert provider.validate_id_token_payload is None
+    assert provider.generate_fake_email is None
 
     # delete thirdparty config
     await delete_third_party_config("t1", "google")