feat: Multi-tenancy support

bharathkeyvalue · bharathkeyvalue · commit 9d7e7442740d · 2024-12-11T13:01:54.000+05:30
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/authentication/authentication.guard.ts b/src/authentication/authentication.guard.ts
@@ -1,6 +1,7 @@
 import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
 import { GqlExecutionContext } from '@nestjs/graphql';
 import { AuthenticationHelper } from './authentication.helper';
+import { ExecutionManager } from '../util/execution.manager';
 
 @Injectable()
 export class AuthGuard implements CanActivate {
@@ -13,6 +14,7 @@ export class AuthGuard implements CanActivate {
       if (token) {
         const reqAuthToken = token.split(' ')[1];
         ctx.user = this.authenticationHelper.validateAuthToken(reqAuthToken);
+        ExecutionManager.setTenantId(ctx.user.tenantId);
         return true;
       }
     }
diff --git a/src/authentication/authentication.helper.ts b/src/authentication/authentication.helper.ts
@@ -13,9 +13,10 @@ export class AuthenticationHelper {
       this.configService.get('JWT_TOKEN_EXPTIME') * 1 || 60 * 60;
     const secret = this.configService.get('JWT_SECRET') as string;
     const username = userDetails.email || userDetails.phone;
-
+    const tenantId = userDetails.tenantId;
     const dataStoredInToken = {
       username: username,
+      tenantId,
       sub: userDetails.id,
       env: this.configService.get('ENV') || 'local',
     };
diff --git a/src/authorization/entity/abstract.tenant.entity.ts b/src/authorization/entity/abstract.tenant.entity.ts
@@ -0,0 +1,9 @@
+import { PrimaryColumn } from 'typeorm';
+import BaseEntity from './base.entity';
+
+class AbstractTenantEntity extends BaseEntity {
+  @PrimaryColumn({ type: 'uuid' })
+  public tenantId!: string;
+}
+
+export default AbstractTenantEntity;
diff --git a/src/authorization/entity/entity.entity.ts b/src/authorization/entity/entity.entity.ts
@@ -1,9 +1,9 @@
 import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
 @Index('entity_name_unique_idx', { synchronize: false })
-class EntityModel extends BaseEntity {
+class EntityModel extends AbstractTenantEntity {
   @PrimaryGeneratedColumn('uuid')
   public id!: string;
 
diff --git a/src/authorization/entity/entityPermission.entity.ts b/src/authorization/entity/entityPermission.entity.ts
@@ -1,8 +1,8 @@
 import { Entity, PrimaryColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
-class EntityPermission extends BaseEntity {
+class EntityPermission extends AbstractTenantEntity {
   @PrimaryColumn({ type: 'uuid' })
   public permissionId!: string;
 
diff --git a/src/authorization/entity/group.entity.ts b/src/authorization/entity/group.entity.ts
@@ -1,9 +1,9 @@
 import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
 @Index('group_name_unique_idx', { synchronize: false })
-class Group extends BaseEntity {
+class Group extends AbstractTenantEntity {
   @PrimaryGeneratedColumn('uuid')
   public id!: string;
 
diff --git a/src/authorization/entity/groupPermission.entity.ts b/src/authorization/entity/groupPermission.entity.ts
@@ -1,8 +1,8 @@
 import { Entity, PrimaryColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
-class GroupPermission extends BaseEntity {
+class GroupPermission extends AbstractTenantEntity {
   @PrimaryColumn({ type: 'uuid' })
   public permissionId!: string;
 
diff --git a/src/authorization/entity/groupRole.entity.ts b/src/authorization/entity/groupRole.entity.ts
@@ -1,8 +1,8 @@
 import { Entity, PrimaryColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
-class GroupRole extends BaseEntity {
+class GroupRole extends AbstractTenantEntity {
   @PrimaryColumn({ type: 'uuid' })
   public roleId!: string;
 
diff --git a/src/authorization/entity/role.entity.ts b/src/authorization/entity/role.entity.ts
@@ -1,9 +1,9 @@
 import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
 @Index('role_name_unique_idx', { synchronize: false })
-class Role extends BaseEntity {
+class Role extends AbstractTenantEntity {
   @PrimaryGeneratedColumn('uuid')
   public id!: string;
 
diff --git a/src/authorization/entity/rolePermission.entity.ts b/src/authorization/entity/rolePermission.entity.ts
@@ -1,8 +1,8 @@
 import { Entity, PrimaryColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
-class RolePermission extends BaseEntity {
+class RolePermission extends AbstractTenantEntity {
   @PrimaryColumn({ type: 'uuid' })
   public permissionId!: string;
 
diff --git a/src/authorization/entity/tenant.entity.ts b/src/authorization/entity/tenant.entity.ts
@@ -0,0 +1,14 @@
+import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
+import BaseEntity from './base.entity';
+
+@Entity()
+@Index('tenant_name_unique_idx', { synchronize: false })
+class Tenant extends BaseEntity {
+  @PrimaryGeneratedColumn('uuid')
+  public id!: string;
+
+  @Column()
+  public name!: string;
+}
+
+export default Tenant;
diff --git a/src/authorization/entity/user.entity.ts b/src/authorization/entity/user.entity.ts
@@ -1,14 +1,14 @@
 import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm';
 import { Status } from '../../schema/graphql.schema';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
 @Index('user_phone_unique_idx', ['phone'], {
   unique: true,
   where: '"deleted_at" IS NULL',
 })
 @Index('user_email_unique_idx', { synchronize: false })
-class User extends BaseEntity {
+class User extends AbstractTenantEntity {
   @PrimaryGeneratedColumn('uuid')
   public id!: string;
 
diff --git a/src/authorization/entity/userGroup.entity.ts b/src/authorization/entity/userGroup.entity.ts
@@ -1,7 +1,8 @@
 import { Entity, PrimaryColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
+
 @Entity()
-class UserGroup extends BaseEntity {
+class UserGroup extends AbstractTenantEntity {
   @PrimaryColumn({ type: 'uuid' })
   public groupId!: string;
 
diff --git a/src/authorization/entity/userPermission.entity.ts b/src/authorization/entity/userPermission.entity.ts
@@ -1,8 +1,8 @@
 import { Entity, PrimaryColumn } from 'typeorm';
-import BaseEntity from './base.entity';
+import AbstractTenantEntity from './abstract.tenant.entity';
 
 @Entity()
-class UserPermission extends BaseEntity {
+class UserPermission extends AbstractTenantEntity {
   @PrimaryColumn({ type: 'uuid' })
   public permissionId!: string;
 
diff --git a/src/authorization/service/entity.service.ts b/src/authorization/service/entity.service.ts
@@ -14,6 +14,7 @@ import { EntityModelRepository } from '../repository/entity.repository';
 import { EntityPermissionRepository } from '../repository/entityPermission.repository';
 import { PermissionRepository } from '../repository/permission.repository';
 import { EntityServiceInterface } from './entity.service.interface';
+import { ExecutionManager } from '../../util/execution.manager';
 
 @Injectable()
 export class EntityService implements EntityServiceInterface {
@@ -100,9 +101,10 @@ export class EntityService implements EntityServiceInterface {
       );
     }
 
+    const tenantId = ExecutionManager.getTenantId();
     const permissionsToBeRemovedFromEntity: EntityPermission[] = existingPermissionsOfEntity
       .filter((p) => !validPermissionsInRequest.has(p.id))
-      .map((p) => ({ permissionId: p.id, entityId: id }));
+      .map((p) => ({ permissionId: p.id, entityId: id, tenantId }));
 
     const entityPermission = this.entityPermissionRepository.create(
       request.permissions.map((permission) => ({
diff --git a/src/authorization/service/group.service.ts b/src/authorization/service/group.service.ts
@@ -41,6 +41,7 @@ import SearchService from './search.service';
 import { UserCacheServiceInterface } from './usercache.service.interface';
 import { DUPLICATE_ERROR_CODE } from '../../constants/db.error.constants';
 import { LoggerService } from '../../logger/logger.service';
+import { ExecutionManager } from '../../util/execution.manager';
 
 @Injectable()
 export class GroupService implements GroupServiceInterface {
@@ -209,9 +210,10 @@ export class GroupService implements GroupServiceInterface {
       );
     }
 
+    const tenantId = ExecutionManager.getTenantId();
     const permissionsToBeRemovedFromGroup: GroupPermission[] = existingPermissionsOfGroup
       .filter((p) => !validPermissionsInRequest.has(p.id))
-      .map((p) => ({ permissionId: p.id, groupId: id }));
+      .map((p) => ({ permissionId: p.id, groupId: id, tenantId }));
 
     const groupPermission = this.groupPermissionRepository.create(
       request.permissions.map((permission) => ({
@@ -241,9 +243,10 @@ export class GroupService implements GroupServiceInterface {
     const validUsersInRequest = await this.validateUsers(userIds);
     const existingUsersOfGroup = await this.getGroupUsers(id);
 
+    const tenantId = ExecutionManager.getTenantId();
     const usersToBeRemovedFromGroup: UserGroup[] = existingUsersOfGroup
       .filter((user) => !validUsersInRequest.has(user.id))
-      .map((user) => ({ userId: user.id, groupId: id }));
+      .map((user) => ({ userId: user.id, groupId: id, tenantId }));
     const userGroups = this.userGroupRepository.create(
       userIds.map((userId) => ({ userId: userId, groupId: id })),
     );
@@ -306,9 +309,10 @@ export class GroupService implements GroupServiceInterface {
       );
     }
 
+    const tenantId = ExecutionManager.getTenantId();
     const rolesToBeRemovedFromGroup: GroupRole[] = existingRolesOfGroup
       .filter((p) => !validRolesInRequest.has(p.id))
-      .map((r) => ({ groupId: id, roleId: r.id }));
+      .map((r) => ({ groupId: id, roleId: r.id, tenantId }));
 
     const groupRoles = this.groupRoleRepository.create(
       request.roles.map((role) => ({
diff --git a/src/authorization/service/role.service.ts b/src/authorization/service/role.service.ts
@@ -23,6 +23,7 @@ import { RolePermissionRepository } from '../repository/rolePermission.repositor
 import { RoleServiceInterface } from './role.service.interface';
 import { RoleCacheServiceInterface } from './rolecache.service.interface';
 import SearchService from './search.service';
+import { ExecutionManager } from '../../util/execution.manager';
 
 @Injectable()
 export class RoleService implements RoleServiceInterface {
@@ -142,9 +143,10 @@ export class RoleService implements RoleServiceInterface {
       );
     }
 
+    const tenantId = ExecutionManager.getTenantId();
     const permissionsToBeRemovedFromRole: RolePermission[] = existingPermissionsOfRole
       .filter((p) => !validPermissionsInRequest.has(p.id))
-      .map((p) => ({ permissionId: p.id, roleId: id }));
+      .map((p) => ({ permissionId: p.id, roleId: id, tenantId }));
 
     const rolePermissions = this.rolePermissionRepository.create(
       request.permissions.map((permission) => ({
diff --git a/src/authorization/service/user.service.ts b/src/authorization/service/user.service.ts
@@ -32,6 +32,7 @@ import { RoleCacheServiceInterface } from './rolecache.service.interface';
 import SearchService from './search.service';
 import { UserServiceInterface } from './user.service.interface';
 import { UserCacheServiceInterface } from './usercache.service.interface';
+import { ExecutionManager } from '../../util/execution.manager';
 
 @Injectable()
 export class UserService implements UserServiceInterface {
@@ -147,9 +148,10 @@ export class UserService implements UserServiceInterface {
       );
     }
 
+    const tenantId = ExecutionManager.getTenantId();
     const groupsToBeRemovedFromUser: UserGroup[] = existingGroupsOfUser
       .filter((p) => !validGroupsInRequest.has(p.id))
-      .map((g) => ({ userId: id, groupId: g.id }));
+      .map((g) => ({ userId: id, groupId: g.id, tenantId }));
     const userGroups = this.userGroupRepository.create(
       user.groups.map((group) => ({ userId: id, groupId: group })),
     );
@@ -186,10 +188,10 @@ export class UserService implements UserServiceInterface {
         request.permissions.filter((p) => !validPermissions.has(p)).toString(),
       );
     }
-
+    const tenantId = ExecutionManager.getTenantId();
     const userPermissionsToBeRemoved: UserPermission[] = existingUserPermissions
       .filter((p) => !validPermissions.has(p.id))
-      .map((p) => ({ userId: id, permissionId: p.id }));
+      .map((p) => ({ userId: id, permissionId: p.id, tenantId }));
     this.userPermissionRepository.remove(userPermissionsToBeRemoved);
 
     const userPermissionsCreated = this.userPermissionRepository.create(
diff --git a/src/config/migration.config.ts b/src/config/migration.config.ts
@@ -1,6 +1,6 @@
 import { DataSource } from 'typeorm';
 import { SnakeNamingStrategy } from 'typeorm-naming-strategies';
-import dotenv from 'dotenv';
+import * as dotenv from 'dotenv';
 dotenv.config();
 /**
  * Uses env params to configure TypeORM database library
diff --git a/src/migrations/1733833844028-MultiTenantFeature.ts b/src/migrations/1733833844028-MultiTenantFeature.ts
diff --git a/src/util/execution.manager.ts b/src/util/execution.manager.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';`
`2`	`2`	`import { GqlExecutionContext } from '@nestjs/graphql';`
`3`	`3`	`import { AuthenticationHelper } from './authentication.helper';`
	`4`	`+import { ExecutionManager } from '../util/execution.manager';`
`4`	`5`
`5`	`6`	`@Injectable()`
`6`	`7`	`export class AuthGuard implements CanActivate {`
`@@ -13,6 +14,7 @@ export class AuthGuard implements CanActivate {`
`13`	`14`	`if (token) {`
`14`	`15`	`const reqAuthToken = token.split(' ')[1];`
`15`	`16`	`ctx.user = this.authenticationHelper.validateAuthToken(reqAuthToken);`
	`17`	`+ ExecutionManager.setTenantId(ctx.user.tenantId);`
`16`	`18`	`return true;`
`17`	`19`	`}`
`18`	`20`	`}`