feat: multitenancy #677

alisher-aituarov · 2023-04-21T10:46:02Z

Summary of change

Multitenancy feature

Related issues

SDK changes required for Third party rework
Link to issue1 here

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)

Checklist for important updates

Changelog has been updated
frontendDriverInterfaceSupported.json file has been updated (if needed)
Changes to the version if needed
- In package.json
- In package-lock.json
- In lib/ts/version.ts
Had run npm run build-pretty
Had installed and ran the pre-commit hook
Issue this PR against the latest non released version branch.
- To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
- If no such branch exists, then create one from the latest released branch.
If added a new recipe interface, then make sure that the implementation of it uses NON arrow functions only (like someFunc: function () {..}).
If I added a new recipe, I also added the recipe entry point into the size-limit section of package.json with the size limit set to the current size rounded up.
If I added a new recipe, I also added the recipe entry point into the rollup.config.mjs

Remaining TODOs for this PR

Co-authored-by: Mihály Lengyel <mihaly@lengyel.tech>

porcellus · 2023-05-24T08:59:55Z

Please manually test/add test cases for combination recipes with disabled sub-recipe:

ThirdPartyEmailPassword is the only recipe initialized on the frontend with emailpassword disabled.
The tenant has emailpassword enabled (and optionally thirdparty as well)
Does login using email and password work in this case?
Do something like this for other combinations as well.

alisher-aituarov · 2023-05-25T05:44:33Z

Please manually test/add test cases for combination recipes with disabled sub-recipe:

ThirdPartyEmailPassword is the only recipe initialized on the frontend with emailpassword disabled.

The tenant has emailpassword enabled (and optionally thirdparty as well)

Does login using email and password work in this case?

Do something like this for other combinations as well.

only thirdparty is rendered, using emailpassword and passwordless is not possible, i think thats what we need

porcellus · 2023-05-25T08:55:38Z

lib/ts/recipe/multitenancy/recipe.ts

+            passwordless: { ...passwordless, enabled: false },
+            emailpassword: { ...emailPassword, enabled: true },
+            thirdparty: { ...thirdParty, enabled: true },


This seems wrong..

Isn't this a testing change? It's still there.

lib/ts/recipe/recipeRouter/index.tsx

porcellus · 2023-05-25T09:14:51Z

lib/ts/recipe/thirdpartyemailpassword/components/themes/signInAndUp/index.tsx

@@ -41,11 +41,11 @@ const SignInAndUpTheme: React.FC<ThirdPartyEmailPasswordSignInAndUpThemeProps> =
    const usesDynamicLoginMethods = SuperTokens.usesDynamicLoginMethods;
    const dynamicLoginMethods = Multitenancy.getInstanceOrThrow().getLoadedDynamicLoginMethods();
    const thirdPartyEnabled =
-        (props.config.disableEmailPassword === false && usesDynamicLoginMethods === false) ||
+        usesDynamicLoginMethods === false ||


Why are we not checking the provider count in this case?

do you mean like (usesDynamicLoginMethods === false || providers.length > 0) ?

usesDynamicLoginMethods === false && providers.length > 0

porcellus · 2023-05-25T09:16:43Z

lib/ts/recipe/thirdpartyemailpassword/recipe.tsx

+            SuperTokens.usesDynamicLoginMethods === false &&
+            config.thirdPartyConfig?.signInAndUpFeature.providers.length === 0
+        ) {
+            throw new Error("ThirdParty signInAndUpFeature providers array cannot be empty.");


This can be empty (which means the thirdparty section is disabled) if email password is not disabled.

do you want me to remove this check ?

No. This only needs to throw if all of the following is true:

email password is disabled (this would be passwordless in the thirdpartypasswordless case)

thirdparty provider list is empty

not using dynamic login methods.

porcellus · 2023-05-25T09:18:36Z

lib/ts/recipe/recipeRouter/index.tsx

+        const dynamicLoginMethods = Multitenancy.getInstanceOrThrow().getLoadedDynamicLoginMethods();
+        const possiblyEnabledRecipes = {
+            thirdpartyemailpassword: {
+                enabled: dynamicLoginMethods?.["thirdparty"].enabled && dynamicLoginMethods["emailpassword"].enabled,


I don't think the second case in the ADR examples works as expected.

its working fine

porcellus · 2023-05-25T09:22:52Z

lib/ts/recipe/recipeRouter/index.tsx

+                return matching;
+            }
+        }
+
        // Otherwise, If no recipe Id provided, or if no recipe id matches, return the first matching component.
        return routeComponents[0];


Please throw in this case:

we found no enabled recipes handling the current route

even if we render the route no actions on it will work since the recipe is disabled on the backend.

porcellus · 2023-05-25T09:29:41Z

lib/ts/recipe/multitenancy/utils.ts

@@ -90,11 +90,12 @@ export const mergeProviders = ({
    const providers: Pick<Provider, "id" | "buttonComponent" | "getButton">[] = [];

    for (const tenantProvider of tenantProviders) {
-        // try finding exact match first
+        // try finding exact match or client provider that includes tenant id
        let provider = clientProviders.find((provider) => {
            const { id } = tenantProvider;
            return provider.id === id || provider.id.includes(id);


This includes is a bit strange to me here. Could you point me to the docs about this merging algorithm?

i can remove this include, i dont remember why i added this

porcellus

There are a few older comments that haven't been addressed.

porcellus · 2023-05-25T23:02:56Z

lib/ts/recipe/recipeRouter/index.tsx

@@ -24,7 +24,7 @@ export abstract class RecipeRouter {
        }

        const dynamicLoginMethods = Multitenancy.getInstanceOrThrow().getLoadedDynamicLoginMethods();
-        const possiblyEnabledRecipes = {
+        const componentMatchingRid = {


Suggested change

const componentMatchingRid = {

const possiblyEnabledRecipes = {

porcellus · 2023-05-25T23:03:11Z

lib/ts/recipe/recipeRouter/index.tsx

@@ -33,20 +33,20 @@ export abstract class RecipeRouter {
            },
            ...dynamicLoginMethods,
        };
-        const components = routeComponents.filter((c) => c.matches());
+        const component = routeComponents.find((c) => c.matches());


Suggested change

const component = routeComponents.find((c) => c.matches());

const componentMatchingRid = routeComponents.find((c) => c.matches());

lib/ts/recipe/recipeRouter/index.tsx

* wip: tests * test: additional tests * fix: picking providers logic & types * test: adds test case * fix test & remove redundant test case * fix: minor cleanup/small fix + test extension --------- Co-authored-by: Alisher <alisher@supertokens.com> Co-authored-by: Mihaly Lengyel <mihaly@lengyel.tech>

lib/ts/recipe/multitenancy/types.ts

CHANGELOG.md

rishabhpoddar · 2023-07-19T06:46:53Z

examples/with-cli-login/api-server/index.ts

@@ -36,23 +36,44 @@ supertokens.init({
            providers: [
                // We have provided you with development keys which you can use for testing.
                // IMPORTANT: Please replace them with your own OAuth keys for production use.


undo all changes in example apps.

Alisher and others added 30 commits December 30, 2022 13:10

init web-js recipes, supertokens from auth-react

d481adf

move recipe output type to types.ts

60f483b

make combined recipes use web-js version

23dd3c6

Merge branch '0.29' into feat/eliminate-duplicate-init-call

4a94044

get rid of recipeImplementation for single recipes

7e56a13

add functionOverrides to thirdpartypasswordless recipe

117e3e0

add functionOverrides to thirdpartyemailpassword recipe

ab1c8f7

get rid of one the duplicate setLoginAttemptInfo calls

7d504aa

fix tests

243d326

update changelog

26d5543

fixes after review

ce8fdf5

move initOutput type to root types

b2f1bd4

fix tests

3a4d947

review fixes

ddde0f5

review fixes

632c31f

add build files

7b1ffbe

use normalisedConfig for webjs init in combined recipes

f812c65

remove commented code

6c5d26d

disable isIE check in order to avoid error

156aa27

test fixes caused by utils

3c1a1a1

fix typo

af9b623

rename recipeImpl -> webJSRecipe for all recipes

606db67

add comments

99742af

utils-> normalization_function fix

b42ae70

type changes for recipe member

8c11813

type change, renamein

cbe17b3

move config normalization to init for session

8a1dd92

Update thirdpartypasswordless comments

2432b23

Co-authored-by: Mihály Lengyel <mihaly@lengyel.tech>

Update thirdpartyemailpassword/recipe comments

9e9089a

Co-authored-by: Mihály Lengyel <mihaly@lengyel.tech>

review fixes

3558c78

fixes

d30f585

porcellus requested changes May 25, 2023

View reviewed changes

Alisher added 2 commits May 25, 2023 16:20

fixes

5ba587d

fixes reciperouter

d2bad1e

porcellus requested changes May 25, 2023

View reviewed changes

Alisher and others added 3 commits May 26, 2023 11:08

fixes

23639f5

fix: update to match ADRs & new BE version

a3a1511

rishabhpoddar requested changes Jun 21, 2023

View reviewed changes

lib/ts/recipe/multitenancy/types.ts Outdated Show resolved Hide resolved

porcellus added 2 commits June 21, 2023 15:26

Merge remote-tracking branch 'origin/master' into feat/tp-multitenancy

4756f76

feat: update to latest interfaces and fix tests

0152de1

porcellus changed the base branch from feat/multitenancy to 0.33 June 22, 2023 22:56

porcellus added 8 commits June 23, 2023 01:05

test: updated test asserts to match new behaviour

44641e2

fix: make the interface more consistent with web-js

1d6d26f

feat: improve typing of getClaimValue

93e55d4

feat: update tests to use core + small fixes

af42b9a

test: add tests for tenant id exceptions

9b92977

fix: fixed handling empty provider arrays + missing provider

2ae19e3

fix: fix tests

6e846c5

fix: self-review fixes

07bb414

rishabhpoddar changed the base branch from 0.33 to 0.34 July 18, 2023 05:52

rishabhpoddar requested changes Jul 18, 2023

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

porcellus added 3 commits July 18, 2023 15:34

fix: self-review fixes & chores

0dde491

test: fix react 16 test app

b022edb

docs: update examples

c5d4e5b

rishabhpoddar requested changes Jul 19, 2023

View reviewed changes

rishabhpoddar merged commit 8fcfd18 into 0.34 Jul 19, 2023
3 of 23 checks passed

rishabhpoddar deleted the feat/tp-multitenancy branch July 19, 2023 06:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: multitenancy #677

feat: multitenancy #677

alisher-aituarov commented Apr 21, 2023

porcellus commented May 24, 2023

alisher-aituarov commented May 25, 2023

porcellus May 25, 2023

porcellus May 25, 2023 •

edited

Loading

porcellus May 25, 2023

alisher-aituarov May 25, 2023

porcellus May 25, 2023

porcellus May 25, 2023

alisher-aituarov May 25, 2023

porcellus May 25, 2023

porcellus May 25, 2023

alisher-aituarov May 26, 2023

porcellus May 25, 2023

porcellus May 25, 2023

alisher-aituarov May 26, 2023

porcellus left a comment

porcellus May 25, 2023

porcellus May 25, 2023

rishabhpoddar Jul 19, 2023

	const componentMatchingRid = {
	const possiblyEnabledRecipes = {

	const component = routeComponents.find((c) => c.matches());
	const componentMatchingRid = routeComponents.find((c) => c.matches());

feat: multitenancy #677

feat: multitenancy #677

Conversation

alisher-aituarov commented Apr 21, 2023

Summary of change

Related issues

Test Plan

Documentation changes

Checklist for important updates

Remaining TODOs for this PR

porcellus commented May 24, 2023

alisher-aituarov commented May 25, 2023

Choose a reason for hiding this comment

porcellus May 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

porcellus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

porcellus May 25, 2023 •

edited

Loading