feat: Multi-tenancy / Add support for multiple tenants #561

mkleszcz · 2024-05-17T13:52:04Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines
Tests for the changes have been added (for bug fixes/features)
Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce?

Closes #382
Add multi tenancy feature to SB. Feature is described in issue #382

Does this PR introduce a breaking change?

Yes.

* Add multitenancy app with some basic model configuration * Add creation of signup tenant and add it in currentUser query schema. * Add tests * Add short documentation for multi tenancy manager * PR fixes & linter fix * Add migration * Documentation grammar

* feat: Add crud for Tenants & middleware for current tenant and user role * Add missing migration * Add documentation * Reformat docs * Add batch creation of tenants to tests * Change the omitting rule for test coverage * PR fixes * Slug generation refactor * Refactor tenant model tests

* Working invitation flow * Add migration * Fix existing tests * Add tests and connect existing invitations to newly created memberships * Add tenants queries with permission specific fields * Fix & add tests * Add invitation token & tests * Add some basic documentation * Handle invitation accepted at date * PR fixes

* Add first name, last name, email and avatar to TenantMembershipType * Add mutations for update/delete tenant membership. Introduce validation for having at least one owner in tenant, and block inviting to default type tenant

* Change subscribtion customer model to Tenant * Fix tests * Add billing model

* Fix enum type converter * Remove type for role field, make it default * Add migration * Fix migrations conflict

* Make tenant dependent example CRUD demo item model * Remove redundant function * Possibly fix test * Send notifictions about CRUD item changes to tenant owners

* feat: allow the user to change membership role * chore: update tenant membership graphql adjustments * chore: update unit tests * chore: membership entry test refactor * chore: MembershipEntry tests refactor * feat: add onCompleted handler * chore: add toast test * chore: refactor membership entry tests * feat: add fil message, update tests * chore: snapshot update

* Add notifications for created, accepted and declined invitation * Make tenantId required

* feat: multi tenancy subscription plan adjustments * chore: refactor tests * chore: Modify `webapp-finances` rendering utils to include tenant providers * chore: adjust routing, tests fixes * chore: fix type error --------- Co-authored-by: Michal Kleszcz <[email protected]>

Add TenantRoleAccess component, fix subscriptions routing, add Subscription tab to tenant settings page

* feat: add a danger zone into General Settings of the organization with removal mutation --------- Co-authored-by: Michal Kleszcz <[email protected]>

* Add delete tenant validation and subscription cancellation to mutation * Add test for tenant with free plan (nothing to cancel)

# Conflicts: # packages/webapp-libs/webapp-finances/src/utils/storybook.tsx # packages/webapp/package.json # pnpm-lock.yaml

Add multi tenancy notifications, Add reloadCommonQuery trigger to the notifications

Fix test coverage for webapp-tenants

Add additional info in the personal settings' members tab

# Conflicts: # pnpm-lock.yaml

# Conflicts: # packages/webapp-libs/webapp-core/package.json # pnpm-lock.yaml

sdrejkarz · 2024-05-20T10:36:48Z

package.json

@@ -8,7 +8,7 @@
    "postinstall": "node packages/internal/cli/scripts/build.js"
  },
  "devDependencies": {
-    "@apollo/client": "^3.8.8",
+    "@apollo/client": "^3.9.6",


Is this update on purpose?

hmmm... Interesting. I think it should go with the newer version

sdrejkarz · 2024-05-20T11:14:06Z

...ibs/webapp-crud-demo/src/routes/crudDemoItem/editCrudDemoItem/editCrudDemoItem.component.tsx

-  const { data, loading } = useQuery(editCrudDemoItemQuery, { variables: { id: id ?? '' } });
+  const { data, loading } = useQuery(editCrudDemoItemQuery, {
+    variables: { id: id ?? '', tenantId: currentTenant?.id ?? '' },
+    skip: !currentTenant,


I believe it should be skipped also when !id

sdrejkarz · 2024-05-20T11:23:44Z

packages/webapp-libs/webapp-tenants/src/components/tenantDangerZone/tenantDangerZone.hook.ts

+
+  const successDeleteMessage = intl.formatMessage({
+    id: 'Tenant form / DeleteTenant / Success message',
+    defaultMessage: '🎉 Tenant deleted successfully!',


I think we should use Organization here, same for failed

sdrejkarz · 2024-05-20T12:29:16Z

packages/webapp-libs/webapp-tenants/src/routes/addTenantForm/addTenantForm.component.tsx

+
+  const successMessage = intl.formatMessage({
+    id: 'Tenant form / AddTenant / Success message',
+    defaultMessage: '🎉 Tenant added successfully!',


Organization copy

sdrejkarz · 2024-05-20T12:32:03Z

...-tenants/src/routes/tenantSettings/tenantGeneralSettings/tenantGeneralSettings.component.tsx

+
+  const successMessage = intl.formatMessage({
+    id: 'Tenant form / UpdateTenant / Success message',
+    defaultMessage: '🎉 Tenant updated successfully!',


I'm thinking about it because it can be triggered inside of organization and personal account. Maybe we could notify without this tenant?

You are right. The copy could be better

I'm thinking of leaving it as an Organization, as there are a lot of copies inside of this settings suggesting its organization.
@mkleszcz

sdrejkarz · 2024-05-20T12:33:46Z

...bapp-libs/webapp-tenants/src/routes/tenantSettings/tenantMembers/tenantMembers.component.tsx

+  const navigate = useNavigate();
+  const isPersonal = useCurrentTenant().data?.type === TenantType.PERSONAL;
+
+  const handleLastInvitationClick = () => {


I've made a typo before. It should be handleNewTenantClick

BREAKING CHANGE: Important migration instructions Before running the multi-tenancy migrations on your existing codebase or database, it is crucial to follow these steps to avoid any issues: 1. Remove or comment `DJSTRIPE_SUBSCRIBER_MODEL` setting 2. Run the migrations 3. Revert the change: After the migrations have successfully completed, revert the change by uncommenting or re-adding the `DJSTRIPE_SUBSCRIBER_MODEL` setting.

wojcikmat and others added 30 commits March 7, 2024 09:06

feat: Add admin panel for multitenancy (#499)

c4d4653

feat: Add tenant invitation notification (#497)

bcb633f

Make all tenants query public (#503)

433bb89

feat: multi tenancy refactor membership type (#506)

0c2c41e

* Add first name, last name, email and avatar to TenantMembershipType * Add mutations for update/delete tenant membership. Introduce validation for having at least one owner in tenant, and block inviting to default type tenant

feat: multi tenancy subscriptions (#509)

2a6d85b

* Change subscribtion customer model to Tenant * Fix tests * Add billing model

fix: multi tenancy enum type (#511)

9433ca2

* Fix enum type converter * Remove type for role field, make it default * Add migration * Fix migrations conflict

feat: Add initial multi-tenancy logic to the webapp (#504)

2aebe4a

feat: Create tenant form (#505)

746360e

feat: Make tenant dependent example CRUD demo item model (#512)

1dcb2d2

* Make tenant dependent example CRUD demo item model * Remove redundant function * Possibly fix test * Send notifictions about CRUD item changes to tenant owners

feat: Organization settings page and invitation to the tenant (#513)

bf26a59

feat: User membership delete feature (#517)

6ed8325

feat: #463 Tenant update feature (#518)

96bc8a3

feat: multi tenancy invitation notifications (#516)

cb687bb

* Add notifications for created, accepted and declined invitation * Make tenantId required

fix: Fix invalid URL in tenant invitation email (#521)

da0e893

fix: Fix issue with showing invalid active tenant in selector (#520)

6f1f589

feat: Add TenantAuthRoute component and tenant role checks (#522)

cc77d19

Fix tenant related queries and tests for finances app (#524)

76d4641

Fix update and delete for not accepted tenant memberships (#523)

f55519c

Change schema to avoid duplicated types in FE schema (#525)

091183a

feat: Multi-tenancy CRUD adjustments (#535)

9943c91

feat: Adjust subscriptions routing (#539)

cb0040f

Add TenantRoleAccess component, fix subscriptions routing, add Subscription tab to tenant settings page

feat: multi tenancy - add tenant removal form (#542)

8faf88e

* feat: add a danger zone into General Settings of the organization with removal mutation --------- Co-authored-by: Michal Kleszcz <[email protected]>

feat: multi tenancy delete tenant validation (#543)

0018fe5

* Add delete tenant validation and subscription cancellation to mutation * Add test for tenant with free plan (nothing to cancel)

Merge branch 'master' into feat/multi-tenancy

0ab5c17

# Conflicts: # packages/webapp-libs/webapp-finances/src/utils/storybook.tsx # packages/webapp/package.json # pnpm-lock.yaml

chore: Update webapp-tenants package.json to support pnpm 9+

365d438

wojcikmat and others added 7 commits May 13, 2024 13:27

docs: Multi tenancy feature description (#547)

c0888d5

fix: Fix type-check errors

bfa26b1

feat: Add API reference docs for webapp-tenants (#548)

b43f3f0

feat: add multi tenancy notifications (#550)

b4bc9a5

Add multi tenancy notifications, Add reloadCommonQuery trigger to the notifications

fix: test coverage of webapp-tenants (#556)

361a728

Fix test coverage for webapp-tenants

feat: add additional info in the personal settings' members tab (#558)

48f019b

Add additional info in the personal settings' members tab

Merge branch 'refs/heads/master' into feat/multi-tenancy

6127c1c

# Conflicts: # pnpm-lock.yaml

mkleszcz added this to the 3.0.0 milestone May 17, 2024

mkleszcz requested a review from pziemkowski May 17, 2024 13:52

mkleszcz and others added 2 commits May 20, 2024 10:07

Merge branch 'master' into feat/multi-tenancy

9065ca3

# Conflicts: # packages/webapp-libs/webapp-core/package.json # pnpm-lock.yaml

fix: Coherent organization naming (#562)

c2ca5b3

sdrejkarz requested changes May 20, 2024

View reviewed changes

fix: copies

302e04a

sdrejkarz approved these changes May 20, 2024

View reviewed changes

mkleszcz merged commit 0ff33d9 into master May 20, 2024
54 of 56 checks passed

mkleszcz deleted the feat/multi-tenancy branch May 20, 2024 14:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Multi-tenancy / Add support for multiple tenants #561

feat: Multi-tenancy / Add support for multiple tenants #561

mkleszcz commented May 17, 2024

sdrejkarz May 20, 2024 •

edited

Loading

mkleszcz May 20, 2024

sdrejkarz May 20, 2024

sdrejkarz May 20, 2024

sdrejkarz May 20, 2024

sdrejkarz May 20, 2024

mkleszcz May 20, 2024

sdrejkarz May 20, 2024 •

edited

Loading

sdrejkarz May 20, 2024

feat: Multi-tenancy / Add support for multiple tenants #561

feat: Multi-tenancy / Add support for multiple tenants #561

Conversation

mkleszcz commented May 17, 2024

Please check if the PR fulfills these requirements

What kind of change does this PR introduce?

Does this PR introduce a breaking change?

sdrejkarz May 20, 2024 • edited Loading

Choose a reason for hiding this comment

mkleszcz May 20, 2024

Choose a reason for hiding this comment

sdrejkarz May 20, 2024

Choose a reason for hiding this comment

sdrejkarz May 20, 2024

Choose a reason for hiding this comment

sdrejkarz May 20, 2024

Choose a reason for hiding this comment

sdrejkarz May 20, 2024

Choose a reason for hiding this comment

mkleszcz May 20, 2024

Choose a reason for hiding this comment

sdrejkarz May 20, 2024 • edited Loading

Choose a reason for hiding this comment

sdrejkarz May 20, 2024

Choose a reason for hiding this comment

sdrejkarz May 20, 2024 •

edited

Loading

sdrejkarz May 20, 2024 •

edited

Loading