From 81295b57ae28cefc51320f4fddccf2bc2426bca1 Mon Sep 17 00:00:00 2001 From: Pranav C Date: Sun, 9 Apr 2023 11:03:55 +0530 Subject: [PATCH] feat: project user apis Signed-off-by: Pranav C --- packages/nocodb-nest/src/app.module.ts | 3 +- .../project-users.controller.spec.ts | 20 ++ .../project-users/project-users.controller.ts | 106 ++++++ .../project-users/project-users.module.ts | 9 + .../project-users.service.spec.ts | 18 + .../project-users/project-users.service.ts | 329 ++++++++++++++++++ .../project-users/ui/auth/emailVerify.ts | 70 ++++ .../project-users/ui/auth/resetPassword.ts | 108 ++++++ .../ui/emailTemplates/forgotPassword.ts | 171 +++++++++ .../project-users/ui/emailTemplates/invite.ts | 208 +++++++++++ .../project-users/ui/emailTemplates/verify.ts | 207 +++++++++++ 11 files changed, 1248 insertions(+), 1 deletion(-) create mode 100644 packages/nocodb-nest/src/modules/project-users/project-users.controller.spec.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/project-users.controller.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/project-users.module.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/project-users.service.spec.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/project-users.service.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/ui/auth/emailVerify.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/ui/auth/resetPassword.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/forgotPassword.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/invite.ts create mode 100644 packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/verify.ts diff --git a/packages/nocodb-nest/src/app.module.ts b/packages/nocodb-nest/src/app.module.ts index c17b143549..0bea052bdd 100644 --- a/packages/nocodb-nest/src/app.module.ts +++ b/packages/nocodb-nest/src/app.module.ts @@ -25,9 +25,10 @@ import { GalleriesModule } from './modules/galleries/galleries.module'; import { FormColumnsModule } from './modules/form-columns/form-columns.module'; import { GridColumnsModule } from './modules/grid-columns/grid-columns.module'; import { MapsModule } from './modules/maps/maps.module'; +import { ProjectUsersModule } from './modules/project-users/project-users.module'; @Module({ - imports: [AuthModule, UsersModule, UtilsModule, ProjectsModule, TablesModule, ViewsModule, FiltersModule, SortsModule, ColumnsModule, ViewColumnsModule, BasesModule, HooksModule, SharedBasesModule, FormsModule, GridsModule, KanbansModule, GalleriesModule, FormColumnsModule, GridColumnsModule, MapsModule], + imports: [AuthModule, UsersModule, UtilsModule, ProjectsModule, TablesModule, ViewsModule, FiltersModule, SortsModule, ColumnsModule, ViewColumnsModule, BasesModule, HooksModule, SharedBasesModule, FormsModule, GridsModule, KanbansModule, GalleriesModule, FormColumnsModule, GridColumnsModule, MapsModule, ProjectUsersModule], controllers: [], providers: [Connection, MetaService, JwtStrategy, ExtractProjectIdMiddleware], exports: [Connection, MetaService], diff --git a/packages/nocodb-nest/src/modules/project-users/project-users.controller.spec.ts b/packages/nocodb-nest/src/modules/project-users/project-users.controller.spec.ts new file mode 100644 index 0000000000..30933a4829 --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/project-users.controller.spec.ts @@ -0,0 +1,20 @@ +import { Test, TestingModule } from '@nestjs/testing'; +import { ProjectUsersController } from './project-users.controller'; +import { ProjectUsersService } from './project-users.service'; + +describe('ProjectUsersController', () => { + let controller: ProjectUsersController; + + beforeEach(async () => { + const module: TestingModule = await Test.createTestingModule({ + controllers: [ProjectUsersController], + providers: [ProjectUsersService], + }).compile(); + + controller = module.get(ProjectUsersController); + }); + + it('should be defined', () => { + expect(controller).toBeDefined(); + }); +}); diff --git a/packages/nocodb-nest/src/modules/project-users/project-users.controller.ts b/packages/nocodb-nest/src/modules/project-users/project-users.controller.ts new file mode 100644 index 0000000000..1c6d335659 --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/project-users.controller.ts @@ -0,0 +1,106 @@ +import { + Controller, + Get, + Param, + Post, + UseGuards, + Request, + Body, + Patch, + Delete, +} from '@nestjs/common'; +import { ProjectUserReqType } from 'nocodb-sdk'; +import { + Acl, + ExtractProjectIdMiddleware, +} from '../../middlewares/extract-project-id/extract-project-id.middleware'; +import { ProjectUsersService } from './project-users.service'; +import { AuthGuard } from '@nestjs/passport'; + +@UseGuards(ExtractProjectIdMiddleware, AuthGuard('jwt')) +@Controller('project-users') +export class ProjectUsersController { + constructor(private readonly projectUsersService: ProjectUsersService) {} + + @Get('/api/v1/db/meta/projects/:projectId/users') + @Acl('userList') + async userList(@Param('projectId') projectId: string, @Request() req) { + return { + users: await this.projectUsersService.userList({ + projectId, + query: req.query, + }), + }; + } + + @Post('/api/v1/db/meta/projects/:projectId/users') + @Acl('userInvite') + async userInvite( + @Param('projectId') projectId: string, + @Request() req, + @Body() body: ProjectUserReqType, + ): Promise { + return await this.projectUsersService.userInvite({ + projectId, + projectUser: body, + req, + }); + } + + @Patch('/api/v1/db/meta/projects/:projectId/users/:userId') + async projectUserUpdate( + @Param('projectId') projectId: string, + @Param('userId') userId: string, + @Request() req, + @Body() + body: ProjectUserReqType & { + project_id: string; + }, + ): Promise { + await this.projectUsersService.projectUserUpdate({ + projectUser: body, + projectId, + userId, + req, + }); + return { + msg: 'The user has been updated successfully', + }; + } + + @Delete('/api/v1/db/meta/projects/:projectId/users/:userId') + @Acl('projectUserDelete') + async projectUserDelete( + @Param('projectId') projectId: string, + @Param('userId') userId: string, + @Request() req, + ): Promise { + await this.projectUsersService.projectUserDelete({ + projectId, + userId, + req, + }); + return { + msg: 'The user has been deleted successfully', + }; + } + + @Post('/api/v1/db/meta/projects/:projectId/users/:userId/resend-invite') + @Acl('projectUserInviteResend') + async projectUserInviteResend( + @Param('projectId') projectId: string, + @Param('userId') userId: string, + @Request() req, + @Body() body: ProjectUserReqType, + ): Promise { + await this.projectUsersService.projectUserInviteResend({ + projectId: projectId, + userId: userId, + projectUser: body, + req, + }); + return { + msg: 'The invitation has been sent to the user', + }; + } +} diff --git a/packages/nocodb-nest/src/modules/project-users/project-users.module.ts b/packages/nocodb-nest/src/modules/project-users/project-users.module.ts new file mode 100644 index 0000000000..0063cc1d46 --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/project-users.module.ts @@ -0,0 +1,9 @@ +import { Module } from '@nestjs/common'; +import { ProjectUsersService } from './project-users.service'; +import { ProjectUsersController } from './project-users.controller'; + +@Module({ + controllers: [ProjectUsersController], + providers: [ProjectUsersService] +}) +export class ProjectUsersModule {} diff --git a/packages/nocodb-nest/src/modules/project-users/project-users.service.spec.ts b/packages/nocodb-nest/src/modules/project-users/project-users.service.spec.ts new file mode 100644 index 0000000000..ca69aaa21c --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/project-users.service.spec.ts @@ -0,0 +1,18 @@ +import { Test, TestingModule } from '@nestjs/testing'; +import { ProjectUsersService } from './project-users.service'; + +describe('ProjectUsersService', () => { + let service: ProjectUsersService; + + beforeEach(async () => { + const module: TestingModule = await Test.createTestingModule({ + providers: [ProjectUsersService], + }).compile(); + + service = module.get(ProjectUsersService); + }); + + it('should be defined', () => { + expect(service).toBeDefined(); + }); +}); diff --git a/packages/nocodb-nest/src/modules/project-users/project-users.service.ts b/packages/nocodb-nest/src/modules/project-users/project-users.service.ts new file mode 100644 index 0000000000..888806eb17 --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/project-users.service.ts @@ -0,0 +1,329 @@ +import { Injectable } from '@nestjs/common'; +import { OrgUserRoles, PluginCategory, ProjectUserReqType } from 'nocodb-sdk'; +import NocoCache from '../../cache/NocoCache'; +import { validatePayload } from '../../helpers'; +import { NcError } from '../../helpers/catchError'; +import NcPluginMgrv2 from '../../helpers/NcPluginMgrv2'; +import { PagedResponseImpl } from '../../helpers/PagedResponse'; +import { randomTokenString } from '../../helpers/stringHelpers'; +import { Audit, ProjectUser, User } from '../../models'; +import { T } from 'nc-help'; +import { v4 as uuidv4 } from 'uuid'; +import * as ejs from 'ejs'; + +import validator from 'validator'; +import Noco from '../../Noco'; +import { CacheGetType, CacheScope, MetaTable } from '../../utils/globals'; + +@Injectable() +export class ProjectUsersService { + async userList(param: { projectId: string; query: any }) { + return new PagedResponseImpl( + await ProjectUser.getUsersList({ + ...param.query, + project_id: param.projectId, + }), + { + ...param.query, + count: await ProjectUser.getUsersCount(param.query), + }, + ); + } + + async userInvite(param: { + projectId: string; + projectUser: ProjectUserReqType; + req: any; + }): Promise { + validatePayload( + 'swagger.json#/components/schemas/ProjectUserReq', + param.projectUser, + ); + + const emails = (param.projectUser.email || '') + .toLowerCase() + .split(/\s*,\s*/) + .map((v) => v.trim()); + + // check for invalid emails + const invalidEmails = emails.filter((v) => !validator.isEmail(v)); + if (!emails.length) { + return NcError.badRequest('Invalid email address'); + } + if (invalidEmails.length) { + NcError.badRequest('Invalid email address : ' + invalidEmails.join(', ')); + } + + const invite_token = uuidv4(); + const error = []; + + for (const email of emails) { + // add user to project if user already exist + const user = await User.getByEmail(email); + + if (user) { + // check if this user has been added to this project + const projectUser = await ProjectUser.get(param.projectId, user.id); + if (projectUser) { + NcError.badRequest( + `${user.email} with role ${projectUser.roles} already exists in this project`, + ); + } + + await ProjectUser.insert({ + project_id: param.projectId, + fk_user_id: user.id, + roles: param.projectUser.roles || 'editor', + }); + + const cachedUser = await NocoCache.get( + `${CacheScope.USER}:${email}___${param.projectId}`, + CacheGetType.TYPE_OBJECT, + ); + + if (cachedUser) { + cachedUser.roles = param.projectUser.roles || 'editor'; + await NocoCache.set( + `${CacheScope.USER}:${email}___${param.projectId}`, + cachedUser, + ); + } + + await Audit.insert({ + project_id: param.projectId, + op_type: 'AUTHENTICATION', + op_sub_type: 'INVITE', + user: param.req.user.email, + description: `invited ${email} to ${param.projectId} project `, + ip: param.req.clientIp, + }); + } else { + try { + // create new user with invite token + const { id } = await User.insert({ + invite_token, + invite_token_expires: new Date(Date.now() + 24 * 60 * 60 * 1000), + email, + roles: OrgUserRoles.VIEWER, + token_version: randomTokenString(), + }); + + // add user to project + await ProjectUser.insert({ + project_id: param.projectId, + fk_user_id: id, + roles: param.projectUser.roles, + }); + + const count = await User.count(); + T.emit('evt', { evt_type: 'project:invite', count }); + + await Audit.insert({ + project_id: param.projectId, + op_type: 'AUTHENTICATION', + op_sub_type: 'INVITE', + user: param.req.user.email, + description: `invited ${email} to ${param.projectId} project `, + ip: param.req.clientIp, + }); + // in case of single user check for smtp failure + // and send back token if failed + if ( + emails.length === 1 && + !(await this.sendInviteEmail(email, invite_token, param.req)) + ) { + return { invite_token, email }; + } else { + this.sendInviteEmail(email, invite_token, param.req); + } + } catch (e) { + console.log(e); + if (emails.length === 1) { + throw e; + } else { + error.push({ email, error: e.message }); + } + } + } + } + + if (emails.length === 1) { + return { + msg: 'The user has been invited successfully', + }; + } else { + return { invite_token, emails, error }; + } + } + + async projectUserUpdate(param: { + userId: string; + // todo: update swagger + projectUser: ProjectUserReqType & { project_id: string }; + // todo: refactor + req: any; + projectId: string; + }): Promise { + validatePayload( + 'swagger.json#/components/schemas/ProjectUserReq', + param.projectUser, + ); + + // todo: use param.projectId + if (!param.projectUser?.project_id) { + NcError.badRequest('Missing project id in request body.'); + } + + if ( + param.req.session?.passport?.user?.roles?.owner && + param.req.session?.passport?.user?.id === param.userId && + param.projectUser.roles.indexOf('owner') === -1 + ) { + NcError.badRequest("Super admin can't remove Super role themselves"); + } + const user = await User.get(param.userId); + + if (!user) { + NcError.badRequest(`User with id '${param.userId}' doesn't exist`); + } + + // todo: handle roles which contains super + if ( + !param.req.session?.passport?.user?.roles?.owner && + param.projectUser.roles.indexOf('owner') > -1 + ) { + NcError.forbidden('Insufficient privilege to add super admin role.'); + } + + await ProjectUser.update( + param.projectId, + param.userId, + param.projectUser.roles, + ); + + await Audit.insert({ + op_type: 'AUTHENTICATION', + op_sub_type: 'ROLES_MANAGEMENT', + user: param.req.user.email, + description: `updated roles for ${user.email} with ${param.projectUser.roles} `, + ip: param.req.clientIp, + }); + + return { + msg: 'User has been updated successfully', + }; + } + + async projectUserDelete(param: { + projectId: string; + userId: string; + // todo: refactor + req: any; + }): Promise { + const project_id = param.projectId; + + if (param.req.session?.passport?.user?.id === param.userId) { + NcError.badRequest("Admin can't delete themselves!"); + } + + if (!param.req.session?.passport?.user?.roles?.owner) { + const user = await User.get(param.userId); + if (user.roles?.split(',').includes('super')) + NcError.forbidden( + 'Insufficient privilege to delete a super admin user.', + ); + + const projectUser = await ProjectUser.get(project_id, param.userId); + if (projectUser?.roles?.split(',').includes('super')) + NcError.forbidden('Insufficient privilege to delete a owner user.'); + } + + await ProjectUser.delete(project_id, param.userId); + return true; + } + + async projectUserInviteResend(param: { + userId: string; + projectUser: ProjectUserReqType; + projectId: string; + // todo: refactor + req: any; + }): Promise { + const user = await User.get(param.userId); + + if (!user) { + NcError.badRequest(`User with id '${param.userId}' not found`); + } + + const invite_token = uuidv4(); + + await User.update(user.id, { + invite_token, + invite_token_expires: new Date(Date.now() + 24 * 60 * 60 * 1000), + }); + + const pluginData = await Noco.ncMeta.metaGet2( + null, + null, + MetaTable.PLUGIN, + { + category: PluginCategory.EMAIL, + active: true, + }, + ); + + if (!pluginData) { + NcError.badRequest( + `No Email Plugin is found. Please go to App Store to configure first or copy the invitation URL to users instead.`, + ); + } + + await this.sendInviteEmail(user.email, invite_token, param.req); + + await Audit.insert({ + op_type: 'AUTHENTICATION', + op_sub_type: 'RESEND_INVITE', + user: user.email, + description: `resent a invite to ${user.email} `, + ip: param.req.clientIp, + project_id: param.projectId, + }); + + return true; + } + + // todo: refactor the whole function + async sendInviteEmail(email: string, token: string, req: any): Promise { + try { + const template = (await import('./ui/emailTemplates/invite')) + .default; + + const emailAdapter = await NcPluginMgrv2.emailAdapter(); + + if (emailAdapter) { + await emailAdapter.mailSend({ + to: email, + subject: 'Verify email', + html: ejs.render(template, { + signupLink: `${req.ncSiteUrl}${ + Noco.getConfig()?.dashboardPath + }#/signup/${token}`, + projectName: req.body?.projectName, + roles: (req.body?.roles || '') + .split(',') + .map((r) => r.replace(/^./, (m) => m.toUpperCase())) + .join(', '), + adminEmail: req.session?.passport?.user?.email, + }), + }); + return true; + } + } catch (e) { + console.log( + 'Warning : `mailSend` failed, Please configure emailClient configuration.', + e.message, + ); + throw e; + } + } +} diff --git a/packages/nocodb-nest/src/modules/project-users/ui/auth/emailVerify.ts b/packages/nocodb-nest/src/modules/project-users/ui/auth/emailVerify.ts new file mode 100644 index 0000000000..f7412b12ba --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/ui/auth/emailVerify.ts @@ -0,0 +1,70 @@ +export default ` + + + NocoDB - Verify Email + + + + + + + +
+ + + + + + Email verified successfully! + + + {{errMsg}} + + + + + + + +
+ + + + + +`; diff --git a/packages/nocodb-nest/src/modules/project-users/ui/auth/resetPassword.ts b/packages/nocodb-nest/src/modules/project-users/ui/auth/resetPassword.ts new file mode 100644 index 0000000000..514fc6d739 --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/ui/auth/resetPassword.ts @@ -0,0 +1,108 @@ +export default ` + + + NocoDB - Reset Password + + + + + + + +
+ + + + + + Password reset successful! + + + + + + +
+ + + + + +`; diff --git a/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/forgotPassword.ts b/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/forgotPassword.ts new file mode 100644 index 0000000000..afb2f5849a --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/forgotPassword.ts @@ -0,0 +1,171 @@ +export default ` + + + + + Simple Transactional Email + + + + + + + + + + + + + +`; diff --git a/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/invite.ts b/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/invite.ts new file mode 100644 index 0000000000..fc81f9409e --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/invite.ts @@ -0,0 +1,208 @@ +export default ` + + + + + Simple Transactional Email + + + + + + + + + + + + + +`; diff --git a/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/verify.ts b/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/verify.ts new file mode 100644 index 0000000000..11702cc659 --- /dev/null +++ b/packages/nocodb-nest/src/modules/project-users/ui/emailTemplates/verify.ts @@ -0,0 +1,207 @@ +export default ` + + + + + Simple Transactional Email + + + + + + + + + + + + + +`;