feat: Add tests and types for multitenancy

Author: KShivendu

supertokens_python/recipe/emailpassword/types.py

@@ -30,7 +30,7 @@ def __init__(
         self.time_joined = time_joined
         self.tenant_ids = tenant_ids
 
-    def __eq__(self, other: "User"):  # type: ignore
+    def __eq__(self, other: object):
         return (
             isinstance(other, self.__class__)
             and self.user_id == other.user_id

supertokens_python/recipe/passwordless/types.py

@@ -40,6 +40,16 @@ def __init__(
         self.time_joined = time_joined
         self.tenant_ids = tenant_ids
 
+    def __eq__(self, other: object) -> bool:
+        return (
+            isinstance(other, self.__class__)
+            and self.user_id == other.user_id
+            and self.email == other.email
+            and self.phone_number == other.phone_number
+            and self.time_joined == other.time_joined
+            and self.tenant_ids == other.tenant_ids
+        )
+
 
 class DeviceCode:
     def __init__(self, code_id: str, time_created: str, code_life_time: int):

supertokens_python/recipe/thirdparty/types.py

@@ -21,6 +21,13 @@ def __init__(self, third_party_user_id: str, third_party_id: str):
         self.user_id = third_party_user_id
         self.id = third_party_id
 
+    def __eq__(self, other: object) -> bool:
+        return (
+            isinstance(other, self.__class__)
+            and self.user_id == other.user_id
+            and self.id == other.id
+        )
+
 
 class RawUserInfoFromProvider:
     def __init__(
@@ -47,6 +54,16 @@ def __init__(
         self.tenant_ids = tenant_ids
         self.third_party_info: ThirdPartyInfo = third_party_info
 
+    def __eq__(self, other: object) -> bool:
+        return (
+            isinstance(other, self.__class__)
+            and self.user_id == other.user_id
+            and self.email == other.email
+            and self.time_joined == other.time_joined
+            and self.tenant_ids == other.tenant_ids
+            and self.third_party_info == other.third_party_info
+        )
+
 
 class UserInfoEmail:
     def __init__(self, email: str, email_verified: bool):

supertokens_python/recipe/thirdpartypasswordless/recipeimplementation/implementation.py

@@ -287,7 +287,7 @@ async def thirdparty_manually_create_or_update_user(
         if self.tp_manually_create_or_update_user is None:
             raise Exception("No thirdparty provider configured")
         return await self.tp_manually_create_or_update_user(
-            third_party_id, third_party_user_id, tenant_id, email, user_context
+            third_party_id, third_party_user_id, email, tenant_id, user_context
         )
 
     async def thirdparty_get_provider(

tests/passwordless/test_mutlitenancy.py

@@ -0,0 +1,115 @@
+# 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 pytest import mark
+from supertokens_python.recipe import session, multitenancy, passwordless
+from supertokens_python import init
+from supertokens_python.recipe.multitenancy.asyncio import (
+    create_or_update_tenant,
+)
+from supertokens_python.recipe.passwordless.asyncio import (
+    create_code,
+    consume_code,
+    get_user_by_id,
+    get_user_by_email,
+    ConsumeCodeOkResult,
+)
+from supertokens_python.recipe.multitenancy.interfaces import TenantConfig
+
+from tests.sessions.claims.utils import get_st_init_args
+from tests.utils import setup_function, teardown_function, setup_multitenancy_feature
+
+
+_ = setup_function
+_ = teardown_function
+
+pytestmark = mark.asyncio
+
+
+async def test_multitenancy_functions():
+    # test that different roles can be assigned for the same user for each tenant
+    args = get_st_init_args(
+        [
+            session.init(),
+            passwordless.init(
+                contact_config=passwordless.ContactEmailOnlyConfig(),
+                flow_type="USER_INPUT_CODE_AND_MAGIC_LINK",
+            ),
+            multitenancy.init(),
+        ]
+    )
+    init(**args)
+    setup_multitenancy_feature()
+
+    await create_or_update_tenant("t1", TenantConfig(passwordless_enabled=True))
+    await create_or_update_tenant("t2", TenantConfig(passwordless_enabled=True))
+    await create_or_update_tenant("t3", TenantConfig(passwordless_enabled=True))
+
+    code1 = await create_code(
+        email="[email protected]", user_input_code="123456", tenant_id="t1"
+    )
+    code2 = await create_code(
+        email="[email protected]", user_input_code="456789", tenant_id="t2"
+    )
+    code3 = await create_code(
+        email="[email protected]", user_input_code="789123", tenant_id="t3"
+    )
+
+    user1 = await consume_code(
+        pre_auth_session_id=code1.pre_auth_session_id,
+        device_id=code1.device_id,
+        user_input_code="123456",
+        tenant_id="t1",
+    )
+    user2 = await consume_code(
+        pre_auth_session_id=code2.pre_auth_session_id,
+        device_id=code2.device_id,
+        user_input_code="456789",
+        tenant_id="t2",
+    )
+    user3 = await consume_code(
+        pre_auth_session_id=code3.pre_auth_session_id,
+        device_id=code3.device_id,
+        user_input_code="789123",
+        tenant_id="t3",
+    )
+
+    assert isinstance(user1, ConsumeCodeOkResult)
+    assert isinstance(user2, ConsumeCodeOkResult)
+    assert isinstance(user3, ConsumeCodeOkResult)
+
+    assert user1.user.user_id != user2.user.user_id
+    assert user2.user.user_id != user3.user.user_id
+    assert user3.user.user_id != user1.user.user_id
+
+    assert user1.user.tenant_ids == ["t1"]
+    assert user2.user.tenant_ids == ["t2"]
+    assert user3.user.tenant_ids == ["t3"]
+
+    # get user by id:
+    g_user1 = await get_user_by_id(user1.user.user_id)
+    g_user2 = await get_user_by_id(user2.user.user_id)
+    g_user3 = await get_user_by_id(user3.user.user_id)
+
+    assert g_user1 == user1.user
+    assert g_user2 == user2.user
+    assert g_user3 == user3.user
+
+    # get user by email:
+    by_email_user1 = await get_user_by_email("[email protected]", "t1")
+    by_email_user2 = await get_user_by_email("[email protected]", "t2")
+    by_email_user3 = await get_user_by_email("[email protected]", "t3")
+
+    assert by_email_user1 == user1.user
+    assert by_email_user2 == user2.user
+    assert by_email_user3 == user3.user

tests/thirdparty/test_multitenancy.py

@@ -0,0 +1,181 @@
+# 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 pytest import mark
+from supertokens_python.recipe import session, multitenancy, thirdparty
+from supertokens_python import init
+from supertokens_python.recipe.multitenancy.asyncio import (
+    create_or_update_tenant,
+    create_or_update_third_party_config,
+)
+from supertokens_python.recipe.thirdparty.asyncio import (
+    manually_create_or_update_user,
+    get_user_by_id,
+    get_users_by_email,
+    get_user_by_third_party_info,
+    get_provider,
+)
+from supertokens_python.recipe.multitenancy.interfaces import TenantConfig
+
+from tests.sessions.claims.utils import get_st_init_args
+from tests.utils import setup_function, teardown_function, setup_multitenancy_feature
+
+
+_ = setup_function
+_ = teardown_function
+
+pytestmark = mark.asyncio
+
+
+async def test_multitenancy_functions():
+    # test that different roles can be assigned for the same user for each tenant
+    args = get_st_init_args([session.init(), thirdparty.init(), multitenancy.init()])
+    init(**args)
+    setup_multitenancy_feature()
+
+    await create_or_update_tenant("t1", TenantConfig(third_party_enabled=True))
+    await create_or_update_tenant("t2", TenantConfig(third_party_enabled=True))
+    await create_or_update_tenant("t3", TenantConfig(third_party_enabled=True))
+
+    # sign up:
+    user1a = await manually_create_or_update_user(
+        "google", "googleid1", "[email protected]", "t1"
+    )
+    user1b = await manually_create_or_update_user(
+        "facebook", "fbid1", "[email protected]", "t1"
+    )
+    user2a = await manually_create_or_update_user(
+        "google", "googleid1", "[email protected]", "t2"
+    )
+    user2b = await manually_create_or_update_user(
+        "facebook", "fbid1", "[email protected]", "t2"
+    )
+    user3a = await manually_create_or_update_user(
+        "google", "googleid1", "[email protected]", "t3"
+    )
+    user3b = await manually_create_or_update_user(
+        "facebook", "fbid1", "[email protected]", "t3"
+    )
+
+    assert user1a.user.tenant_ids == ["t1"]
+    assert user1b.user.tenant_ids == ["t1"]
+    assert user2a.user.tenant_ids == ["t2"]
+    assert user2b.user.tenant_ids == ["t2"]
+    assert user3a.user.tenant_ids == ["t3"]
+    assert user3b.user.tenant_ids == ["t3"]
+
+    # get user by id:
+    g_user1a = await get_user_by_id(user1a.user.user_id)
+    g_user1b = await get_user_by_id(user1b.user.user_id)
+    g_user2a = await get_user_by_id(user2a.user.user_id)
+    g_user2b = await get_user_by_id(user2b.user.user_id)
+    g_user3a = await get_user_by_id(user3a.user.user_id)
+    g_user3b = await get_user_by_id(user3b.user.user_id)
+
+    assert g_user1a == user1a.user
+    assert g_user1b == user1b.user
+    assert g_user2a == user2a.user
+    assert g_user2b == user2b.user
+    assert g_user3a == user3a.user
+    assert g_user3b == user3b.user
+
+    # get user by email:
+    by_email_user1 = await get_users_by_email("[email protected]", "t1")
+    by_email_user2 = await get_users_by_email("[email protected]", "t2")
+    by_email_user3 = await get_users_by_email("[email protected]", "t3")
+
+    assert by_email_user1 == [user1a.user, user1b.user]
+    assert by_email_user2 == [user2a.user, user2b.user]
+    assert by_email_user3 == [user3a.user, user3b.user]
+
+    # get user by thirdparty id:
+    g_user_by_tpid1a = await get_user_by_third_party_info("google", "googleid1", "t1")
+    g_user_by_tpid1b = await get_user_by_third_party_info("facebook", "fbid1", "t1")
+    g_user_by_tpid2a = await get_user_by_third_party_info("google", "googleid1", "t2")
+    g_user_by_tpid2b = await get_user_by_third_party_info("facebook", "fbid1", "t2")
+    g_user_by_tpid3a = await get_user_by_third_party_info("google", "googleid1", "t3")
+    g_user_by_tpid3b = await get_user_by_third_party_info("facebook", "fbid1", "t3")
+
+    assert g_user_by_tpid1a == user1a.user
+    assert g_user_by_tpid1b == user1b.user
+    assert g_user_by_tpid2a == user2a.user
+    assert g_user_by_tpid2b == user2b.user
+    assert g_user_by_tpid3a == user3a.user
+    assert g_user_by_tpid3b == user3b.user
+
+
+async def test_get_provider():
+    args = get_st_init_args([session.init(), thirdparty.init(), multitenancy.init()])
+    init(**args)
+    setup_multitenancy_feature()
+
+    await create_or_update_tenant("t1", TenantConfig(third_party_enabled=True))
+    await create_or_update_tenant("t1", TenantConfig(third_party_enabled=True))
+    await create_or_update_tenant("t1", TenantConfig(third_party_enabled=True))
+
+    await create_or_update_third_party_config(
+        "t1",
+        thirdparty.ProviderConfig(
+            "google", clients=[thirdparty.ProviderClientConfig("a")]
+        ),
+    )
+    await create_or_update_third_party_config(
+        "t1",
+        thirdparty.ProviderConfig(
+            "facebook", clients=[thirdparty.ProviderClientConfig("a")]
+        ),
+    )
+
+    await create_or_update_third_party_config(
+        "t2",
+        thirdparty.ProviderConfig(
+            "facebook", clients=[thirdparty.ProviderClientConfig("a")]
+        ),
+    )
+    await create_or_update_third_party_config(
+        "t2",
+        thirdparty.ProviderConfig(
+            "discord", clients=[thirdparty.ProviderClientConfig("a")]
+        ),
+    )
+
+    await create_or_update_third_party_config(
+        "t3",
+        thirdparty.ProviderConfig(
+            "discord", clients=[thirdparty.ProviderClientConfig("a")]
+        ),
+    )
+    await create_or_update_third_party_config(
+        "t3",
+        thirdparty.ProviderConfig(
+            "linkedin", clients=[thirdparty.ProviderClientConfig("a")]
+        ),
+    )
+
+    provider1 = await get_provider("google", None, "t1")
+    assert provider1.provider.config.thirdparty_id == "google"
+
+    provider2 = await get_provider("facebook", None, "t1")
+    assert provider2.provider.config.thirdparty_id == "facebook"
+
+    provider3 = await get_provider("facebook", None, "t2")
+    assert provider3.provider.config.thirdparty_id == "facebook"
+
+    provider4 = await get_provider("discord", None, "t2")
+    assert provider4.provider.config.thirdparty_id == "discord"
+
+    provider5 = await get_provider("discord", None, "t3")
+    assert provider5.provider.config.thirdparty_id == "discord"
+
+    provider6 = await get_provider("linkedin", None, "t3")
+    assert provider6.provider.config.thirdparty_id == "linkedin"