Merge pull request #388 from supertokens/fix/ep-userroles-tenantid

fix: Set tenant_id as None by default in ep and userroles functions

Author: KShivendu

supertokens_python/recipe/emailpassword/asyncio/__init__.py

@@ -66,7 +66,7 @@ async def get_user_by_id(
 
 async def get_user_by_email(
     email: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> Union[User, None]:
     if user_context is None:
@@ -78,7 +78,7 @@ async def get_user_by_email(
 
 async def create_reset_password_token(
     user_id: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     if user_context is None:
@@ -91,7 +91,7 @@ async def create_reset_password_token(
 async def reset_password_using_token(
     token: str,
     new_password: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     if user_context is None:
@@ -104,7 +104,7 @@ async def reset_password_using_token(
 async def sign_in(
     email: str,
     password: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     if user_context is None:
@@ -117,7 +117,7 @@ async def sign_in(
 async def sign_up(
     email: str,
     password: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     if user_context is None:

supertokens_python/recipe/emailpassword/syncio/__init__.py

@@ -51,7 +51,7 @@ def get_user_by_id(
 
 def get_user_by_email(
     email: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> Union[None, User]:
     from supertokens_python.recipe.emailpassword.asyncio import get_user_by_email
@@ -61,7 +61,7 @@ def get_user_by_email(
 
 def create_reset_password_token(
     user_id: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     from supertokens_python.recipe.emailpassword.asyncio import (
@@ -74,7 +74,7 @@ def create_reset_password_token(
 def reset_password_using_token(
     token: str,
     new_password: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     from supertokens_python.recipe.emailpassword.asyncio import (
@@ -89,7 +89,7 @@ def reset_password_using_token(
 def sign_in(
     email: str,
     password: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ) -> Union[SignInOkResult, SignInWrongCredentialsError]:
     from supertokens_python.recipe.emailpassword.asyncio import sign_in
@@ -100,7 +100,7 @@ def sign_in(
 def sign_up(
     email: str,
     password: str,
-    tenant_id: Optional[str],
+    tenant_id: Optional[str] = None,
     user_context: Union[None, Dict[str, Any]] = None,
 ):
     from supertokens_python.recipe.emailpassword.asyncio import sign_up

supertokens_python/recipe/userroles/asyncio/__init__.py

@@ -18,9 +18,9 @@
 
 
 async def add_role_to_user(
-    tenant_id: Optional[str],
     user_id: str,
     role: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> Union[AddRoleToUserOkResult, UnknownRoleError]:
     if user_context is None:
@@ -31,9 +31,9 @@ async def add_role_to_user(
 
 
 async def remove_user_role(
-    tenant_id: Optional[str],
     user_id: str,
     role: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> Union[RemoveUserRoleOkResult, UnknownRoleError]:
     if user_context is None:
@@ -44,8 +44,8 @@ async def remove_user_role(
 
 
 async def get_roles_for_user(
-    tenant_id: Optional[str],
     user_id: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> GetRolesForUserOkResult:
     if user_context is None:
@@ -58,8 +58,8 @@ async def get_roles_for_user(
 
 
 async def get_users_that_have_role(
-    tenant_id: Optional[str],
     role: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]:
     if user_context is None:

supertokens_python/recipe/userroles/syncio/__init__.py

@@ -31,45 +31,45 @@
 
 
 def add_role_to_user(
-    tenant_id: Optional[str],
     user_id: str,
     role: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> Union[AddRoleToUserOkResult, UnknownRoleError]:
     from supertokens_python.recipe.userroles.asyncio import add_role_to_user
 
-    return sync(add_role_to_user(tenant_id, user_id, role, user_context))
+    return sync(add_role_to_user(user_id, role, tenant_id, user_context))
 
 
 def remove_user_role(
-    tenant_id: Optional[str],
     user_id: str,
     role: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> Union[RemoveUserRoleOkResult, UnknownRoleError]:
     from supertokens_python.recipe.userroles.asyncio import remove_user_role
 
-    return sync(remove_user_role(tenant_id, user_id, role, user_context))
+    return sync(remove_user_role(user_id, role, tenant_id, user_context))
 
 
 def get_roles_for_user(
-    tenant_id: Optional[str],
     user_id: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> GetRolesForUserOkResult:
     from supertokens_python.recipe.userroles.asyncio import get_roles_for_user
 
-    return sync(get_roles_for_user(tenant_id, user_id, user_context))
+    return sync(get_roles_for_user(user_id, tenant_id, user_context))
 
 
 def get_users_that_have_role(
-    tenant_id: Optional[str],
     role: str,
+    tenant_id: Optional[str] = None,
     user_context: Union[Dict[str, Any], None] = None,
 ) -> Union[GetUsersThatHaveRoleOkResult, UnknownRoleError]:
     from supertokens_python.recipe.userroles.asyncio import get_users_that_have_role
 
-    return sync(get_users_that_have_role(tenant_id, role, user_context))
+    return sync(get_users_that_have_role(role, tenant_id, user_context))
 
 
 def create_new_role_or_add_permissions(

tests/emailpassword/test_multitenancy.py

@@ -11,14 +11,11 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-import setup
-
 from pytest import mark
 from supertokens_python.recipe import session, userroles, emailpassword, multitenancy
 from supertokens_python import init
 from supertokens_python.recipe.multitenancy.asyncio import (
     create_or_update_tenant,
-    associate_user_to_tenant,
 )
 from supertokens_python.recipe.emailpassword.asyncio import (
     sign_up,
@@ -28,14 +25,14 @@
     create_reset_password_token,
     reset_password_using_token,
 )
-from supertokens_python.recipe.multitenancy.interfaces import TenantConfig
-from supertokens_python.recipe.userroles.asyncio import (
-    create_new_role_or_add_permissions,
-    add_role_to_user,
-    get_roles_for_user,
+from supertokens_python.recipe.emailpassword.interfaces import (
+    SignUpOkResult,
+    SignInOkResult,
+    CreateResetPasswordOkResult,
 )
+from supertokens_python.recipe.multitenancy.interfaces import TenantConfig
 
-from tests.sessions.claims.utils import get_st_init_args
+from tests.utils import get_st_init_args
 from tests.utils import setup_function, teardown_function, setup_multitenancy_feature
 
 
@@ -55,16 +52,20 @@ async def test_multitenancy_in_user_roles():
             multitenancy.init(),
         ]
     )
-    init(**args)
+    init(**args)  # type: ignore
     setup_multitenancy_feature()
 
     await create_or_update_tenant("t1", TenantConfig(email_password_enabled=True))
     await create_or_update_tenant("t2", TenantConfig(email_password_enabled=True))
     await create_or_update_tenant("t3", TenantConfig(email_password_enabled=True))
 
-    user1 = await sign_up("t1", "[email protected]", "password1")
-    user2 = await sign_up("t2", "[email protected]", "password2")
-    user3 = await sign_up("t3", "[email protected]", "password3")
+    user1 = await sign_up("[email protected]", "password1", "t1")
+    user2 = await sign_up("[email protected]", "password2", "t2")
+    user3 = await sign_up("[email protected]", "password3", "t3")
+
+    assert isinstance(user1, SignUpOkResult)
+    assert isinstance(user2, SignUpOkResult)
+    assert isinstance(user3, SignUpOkResult)
 
     assert user1.user.user_id != user2.user.user_id
     assert user2.user.user_id != user3.user.user_id
@@ -75,9 +76,13 @@ async def test_multitenancy_in_user_roles():
     assert user3.user.tenant_ids == ["t3"]
 
     # sign in
-    ep_user1 = await sign_in("t1", "[email protected]", "password1")
-    ep_user2 = await sign_in("t2", "[email protected]", "password1")
-    ep_user3 = await sign_in("t3", "[email protected]", "password1")
+    ep_user1 = await sign_in("[email protected]", "password1", "t1")
+    ep_user2 = await sign_in("[email protected]", "password1", "t2")
+    ep_user3 = await sign_in("[email protected]", "password1", "t3")
+
+    assert isinstance(ep_user1, SignInOkResult)
+    assert isinstance(ep_user2, SignInOkResult)
+    assert isinstance(ep_user3, SignInOkResult)
 
     assert ep_user1.user.user_id == user2.user.user_id == user3.user.user_id
 
@@ -91,32 +96,40 @@ async def test_multitenancy_in_user_roles():
     assert g_user3 == user3.user
 
     # get user by email:
-    by_email_user1 = await get_user_by_email("t1", "[email protected]")
-    by_email_user2 = await get_user_by_email("t2", "[email protected]")
-    by_email_user3 = await get_user_by_email("t3", "[email protected]")
+    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
 
     # create password reset token:
-    pless_reset_link1 = await create_reset_password_token("t1", user1.user.user_id)
-    pless_reset_link2 = await create_reset_password_token("t2", user1.user.user_id)
-    pless_reset_link3 = await create_reset_password_token("t3", user1.user.user_id)
+    pless_reset_link1 = await create_reset_password_token(user1.user.user_id, "t1")
+    pless_reset_link2 = await create_reset_password_token(user1.user.user_id, "t2")
+    pless_reset_link3 = await create_reset_password_token(user1.user.user_id, "t3")
+
+    assert isinstance(pless_reset_link1, CreateResetPasswordOkResult)
+    assert isinstance(pless_reset_link2, CreateResetPasswordOkResult)
+    assert isinstance(pless_reset_link3, CreateResetPasswordOkResult)
 
     assert pless_reset_link1.token is not None
     assert pless_reset_link2.token is not None
     assert pless_reset_link3.token is not None
 
     # reset password using token:
-    await reset_password_using_token("t1", pless_reset_link1.token, "newpassword1")
-    await reset_password_using_token("t2", pless_reset_link1.token, "newpassword2")
-    await reset_password_using_token("t3", pless_reset_link1.token, "newpassword3")
+    await reset_password_using_token(pless_reset_link1.token, "newpassword1", "t1")
+    await reset_password_using_token(pless_reset_link2.token, "newpassword2", "t2")
+    await reset_password_using_token(pless_reset_link3.token, "newpassword3", "t3")
 
     # new password should work:
-    s_user1 = await sign_in("t1", "[email protected]", "newpassword1")
-    s_user2 = await sign_in("t2", "[email protected]", "newpassword2")
-    s_user3 = await sign_in("t3", "[email protected]", "newpassword3")
+    s_user1 = await sign_in("[email protected]", "newpassword1", "t1")
+    s_user2 = await sign_in("[email protected]", "newpassword2", "t2")
+    s_user3 = await sign_in("[email protected]", "newpassword3", "t3")
+
+    assert isinstance(s_user1, SignInOkResult)
+    assert isinstance(s_user2, SignInOkResult)
+    assert isinstance(s_user3, SignInOkResult)
 
     assert s_user1.user == user1.user
     assert s_user2.user == user2.user

tests/thirdparty/test_multitenancy.py

@@ -27,7 +27,7 @@
 )
 from supertokens_python.recipe.multitenancy.interfaces import TenantConfig
 
-from tests.sessions.claims.utils import get_st_init_args
+from tests.utils import get_st_init_args
 from tests.utils import setup_function, teardown_function, setup_multitenancy_feature
 
 
@@ -40,7 +40,7 @@
 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)
+    init(**args)  # type: ignore
     setup_multitenancy_feature()
 
     await create_or_update_tenant("t1", TenantConfig(third_party_enabled=True))