forked from twentyhq/twenty
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add command to run cleaning suspended workspaces job (twentyhq#9895)
Co-authored-by: etiennejouan <[email protected]>
- Loading branch information
1 parent
4edeb7f
commit 1b3181b
Showing
6 changed files
with
344 additions
and
269 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 33 additions & 0 deletions
33
...engine/workspace-manager/workspace-cleaner/commands/clean-suspended-workspaces.command.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| import { InjectRepository } from '@nestjs/typeorm'; | ||
|
|
||
| import { Command } from 'nest-commander'; | ||
| import { Repository } from 'typeorm'; | ||
|
|
||
| import { ActiveWorkspacesCommandRunner } from 'src/database/commands/active-workspaces.command'; | ||
| import { BaseCommandOptions } from 'src/database/commands/base.command'; | ||
| import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity'; | ||
| import { CleanerWorkspaceService } from 'src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service'; | ||
|
|
||
| @Command({ | ||
| name: 'workspace:clean', | ||
| description: 'Clean suspended workspace', | ||
| }) | ||
| export class CleanSuspendedWorkspacesCommand extends ActiveWorkspacesCommandRunner { | ||
| constructor( | ||
| private readonly cleanerWorkspaceService: CleanerWorkspaceService, | ||
| @InjectRepository(Workspace, 'core') | ||
| protected readonly workspaceRepository: Repository<Workspace>, | ||
| ) { | ||
| super(workspaceRepository); | ||
| } | ||
|
|
||
| async executeActiveWorkspacesCommand( | ||
| _passedParam: string[], | ||
| _options: BaseCommandOptions, | ||
| workspaceIds: string[], | ||
| ): Promise<void> { | ||
| await this.cleanerWorkspaceService.batchWarnOrCleanSuspendedWorkspaces( | ||
| workspaceIds, | ||
| ); | ||
| } | ||
| } |
278 changes: 11 additions & 267 deletions
278
...er/src/engine/workspace-manager/workspace-cleaner/crons/clean-suspended-workspaces.job.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,289 +1,33 @@ | ||
| import { Logger } from '@nestjs/common'; | ||
| import { InjectRepository } from '@nestjs/typeorm'; | ||
|
|
||
| import { render } from '@react-email/components'; | ||
| import chunk from 'lodash.chunk'; | ||
| import { | ||
| CleanSuspendedWorkspaceEmail, | ||
| WarnSuspendedWorkspaceEmail, | ||
| } from 'twenty-emails'; | ||
| import { WorkspaceActivationStatus } from 'twenty-shared'; | ||
| import { Repository } from 'typeorm'; | ||
|
|
||
| import { BillingSubscription } from 'src/engine/core-modules/billing/entities/billing-subscription.entity'; | ||
| import { EmailService } from 'src/engine/core-modules/email/email.service'; | ||
| import { EnvironmentService } from 'src/engine/core-modules/environment/environment.service'; | ||
| import { Process } from 'src/engine/core-modules/message-queue/decorators/process.decorator'; | ||
| import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator'; | ||
| import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants'; | ||
| import { UserService } from 'src/engine/core-modules/user/services/user.service'; | ||
| import { UserVarsService } from 'src/engine/core-modules/user/user-vars/services/user-vars.service'; | ||
| import { WorkspaceService } from 'src/engine/core-modules/workspace/services/workspace.service'; | ||
| import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity'; | ||
| import { USER_WORKSPACE_DELETION_WARNING_SENT_KEY } from 'src/engine/workspace-manager/workspace-cleaner/constants/user-workspace-deletion-warning-sent-key.constant'; | ||
| import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity'; | ||
|
|
||
| const MILLISECONDS_IN_ONE_DAY = 1000 * 3600 * 24; | ||
| import { CleanerWorkspaceService } from 'src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service'; | ||
|
|
||
| @Processor(MessageQueue.cronQueue) | ||
| export class CleanSuspendedWorkspacesJob { | ||
| private readonly logger = new Logger(CleanSuspendedWorkspacesJob.name); | ||
| private readonly inactiveDaysBeforeDelete: number; | ||
| private readonly inactiveDaysBeforeWarn: number; | ||
| private readonly maxNumberOfWorkspacesDeletedPerExecution: number; | ||
|
|
||
| constructor( | ||
| private readonly workspaceService: WorkspaceService, | ||
| private readonly environmentService: EnvironmentService, | ||
| private readonly userService: UserService, | ||
| private readonly userVarsService: UserVarsService, | ||
| private readonly emailService: EmailService, | ||
| @InjectRepository(BillingSubscription, 'core') | ||
| private readonly billingSubscriptionRepository: Repository<BillingSubscription>, | ||
| private readonly cleanerWorkspaceService: CleanerWorkspaceService, | ||
| @InjectRepository(Workspace, 'core') | ||
| private readonly workspaceRepository: Repository<Workspace>, | ||
| ) { | ||
| this.inactiveDaysBeforeDelete = this.environmentService.get( | ||
| 'WORKSPACE_INACTIVE_DAYS_BEFORE_DELETION', | ||
| ); | ||
| this.inactiveDaysBeforeWarn = this.environmentService.get( | ||
| 'WORKSPACE_INACTIVE_DAYS_BEFORE_NOTIFICATION', | ||
| ); | ||
| this.maxNumberOfWorkspacesDeletedPerExecution = this.environmentService.get( | ||
| 'MAX_NUMBER_OF_WORKSPACES_DELETED_PER_EXECUTION', | ||
| ); | ||
| } | ||
|
|
||
| async computeWorkspaceBillingInactivity( | ||
| workspace: Workspace, | ||
| ): Promise<number | null> { | ||
| try { | ||
| const lastSubscription = | ||
| await this.billingSubscriptionRepository.findOneOrFail({ | ||
| where: { workspaceId: workspace.id }, | ||
| order: { updatedAt: 'DESC' }, | ||
| }); | ||
|
|
||
| const daysSinceBillingInactivity = Math.floor( | ||
| (new Date().getTime() - lastSubscription.updatedAt.getTime()) / | ||
| MILLISECONDS_IN_ONE_DAY, | ||
| ); | ||
|
|
||
| return daysSinceBillingInactivity; | ||
| } catch { | ||
| this.logger.error( | ||
| `No billing subscription found for workspace ${workspace.id} ${workspace.displayName}`, | ||
| ); | ||
|
|
||
| return null; | ||
| } | ||
| } | ||
|
|
||
| async checkIfWorkspaceMembersWarned( | ||
| workspaceMembers: WorkspaceMemberWorkspaceEntity[], | ||
| workspaceId: string, | ||
| ) { | ||
| for (const workspaceMember of workspaceMembers) { | ||
| const workspaceMemberWarned = | ||
| (await this.userVarsService.get({ | ||
| userId: workspaceMember.userId, | ||
| workspaceId: workspaceId, | ||
| key: USER_WORKSPACE_DELETION_WARNING_SENT_KEY, | ||
| })) === true; | ||
|
|
||
| if (workspaceMemberWarned) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| async sendWarningEmail( | ||
| workspaceMember: WorkspaceMemberWorkspaceEntity, | ||
| workspaceDisplayName: string | undefined, | ||
| daysSinceInactive: number, | ||
| ) { | ||
| const emailData = { | ||
| daysSinceInactive, | ||
| inactiveDaysBeforeDelete: this.inactiveDaysBeforeDelete, | ||
| userName: `${workspaceMember.name.firstName} ${workspaceMember.name.lastName}`, | ||
| workspaceDisplayName: `${workspaceDisplayName}`, | ||
| }; | ||
| const emailTemplate = WarnSuspendedWorkspaceEmail(emailData); | ||
| const html = render(emailTemplate, { | ||
| pretty: true, | ||
| }); | ||
| const text = render(emailTemplate, { | ||
| plainText: true, | ||
| }); | ||
|
|
||
| this.emailService.send({ | ||
| to: workspaceMember.userEmail, | ||
| bcc: this.environmentService.get('EMAIL_SYSTEM_ADDRESS'), | ||
| from: `${this.environmentService.get( | ||
| 'EMAIL_FROM_NAME', | ||
| )} <${this.environmentService.get('EMAIL_FROM_ADDRESS')}>`, | ||
| subject: 'Action needed to prevent workspace deletion', | ||
| html, | ||
| text, | ||
| }); | ||
| } | ||
|
|
||
| async warnWorkspaceMembers(workspace: Workspace, daysSinceInactive: number) { | ||
| const workspaceMembers = | ||
| await this.userService.loadWorkspaceMembers(workspace); | ||
|
|
||
| const workspaceMembersWarned = await this.checkIfWorkspaceMembersWarned( | ||
| workspaceMembers, | ||
| workspace.id, | ||
| ); | ||
|
|
||
| if (workspaceMembersWarned) { | ||
| this.logger.log( | ||
| `Workspace ${workspace.id} ${workspace.displayName} already warned`, | ||
| ); | ||
|
|
||
| return; | ||
| } else { | ||
| this.logger.log( | ||
| `Sending ${workspace.id} ${ | ||
| workspace.displayName | ||
| } suspended since ${daysSinceInactive} days emails to users ['${workspaceMembers | ||
| .map((workspaceUser) => workspaceUser.userEmail) | ||
| .join(', ')}']`, | ||
| ); | ||
|
|
||
| const workspaceMembersChunks = chunk(workspaceMembers, 5); | ||
|
|
||
| for (const workspaceMembersChunk of workspaceMembersChunks) { | ||
| await Promise.all( | ||
| workspaceMembersChunk.map(async (workspaceMember) => { | ||
| await this.userVarsService.set({ | ||
| userId: workspaceMember.userId, | ||
| workspaceId: workspace.id, | ||
| key: USER_WORKSPACE_DELETION_WARNING_SENT_KEY, | ||
| value: true, | ||
| }); | ||
|
|
||
| await this.sendWarningEmail( | ||
| workspaceMember, | ||
| workspace.displayName, | ||
| daysSinceInactive, | ||
| ); | ||
| }), | ||
| ); | ||
| } | ||
|
|
||
| return; | ||
| } | ||
| } | ||
|
|
||
| async sendCleaningEmail( | ||
| workspaceMember: WorkspaceMemberWorkspaceEntity, | ||
| workspaceDisplayName: string | undefined, | ||
| ) { | ||
| const emailData = { | ||
| inactiveDaysBeforeDelete: this.inactiveDaysBeforeDelete, | ||
| userName: `${workspaceMember.name.firstName} ${workspaceMember.name.lastName}`, | ||
| workspaceDisplayName: `${workspaceDisplayName}`, | ||
| }; | ||
| const emailTemplate = CleanSuspendedWorkspaceEmail(emailData); | ||
| const html = render(emailTemplate, { | ||
| pretty: true, | ||
| }); | ||
| const text = render(emailTemplate, { | ||
| plainText: true, | ||
| }); | ||
|
|
||
| this.emailService.send({ | ||
| to: workspaceMember.userEmail, | ||
| bcc: this.environmentService.get('EMAIL_SYSTEM_ADDRESS'), | ||
| from: `${this.environmentService.get( | ||
| 'EMAIL_FROM_NAME', | ||
| )} <${this.environmentService.get('EMAIL_FROM_ADDRESS')}>`, | ||
| subject: 'Your workspace has been deleted', | ||
| html, | ||
| text, | ||
| }); | ||
| } | ||
|
|
||
| async informWorkspaceMembersAndDeleteWorkspace(workspace: Workspace) { | ||
| const workspaceMembers = | ||
| await this.userService.loadWorkspaceMembers(workspace); | ||
|
|
||
| this.logger.log( | ||
| `Sending workspace ${workspace.id} ${ | ||
| workspace.displayName | ||
| } deletion emails to users ['${workspaceMembers | ||
| .map((workspaceUser) => workspaceUser.userEmail) | ||
| .join(', ')}']`, | ||
| ); | ||
|
|
||
| const workspaceMembersChunks = chunk(workspaceMembers, 5); | ||
|
|
||
| for (const workspaceMembersChunk of workspaceMembersChunks) { | ||
| await Promise.all( | ||
| workspaceMembersChunk.map(async (workspaceMember) => { | ||
| await this.userVarsService.delete({ | ||
| userId: workspaceMember.userId, | ||
| workspaceId: workspace.id, | ||
| key: USER_WORKSPACE_DELETION_WARNING_SENT_KEY, | ||
| }); | ||
|
|
||
| await this.sendCleaningEmail(workspaceMember, workspace.displayName); | ||
| }), | ||
| ); | ||
| } | ||
|
|
||
| await this.workspaceService.deleteWorkspace(workspace.id); | ||
| this.logger.log( | ||
| `Cleaning Workspace ${workspace.id} ${workspace.displayName}`, | ||
| ); | ||
| } | ||
| ) {} | ||
|
|
||
| @Process(CleanSuspendedWorkspacesJob.name) | ||
| async handle(): Promise<void> { | ||
| this.logger.log(`Job running...`); | ||
|
|
||
| const suspendedWorkspaces = await this.workspaceRepository.find({ | ||
| where: { activationStatus: WorkspaceActivationStatus.SUSPENDED }, | ||
| const suspendedWorkspaceIds = await this.workspaceRepository.find({ | ||
| select: ['id'], | ||
| where: { | ||
| activationStatus: WorkspaceActivationStatus.SUSPENDED, | ||
| }, | ||
| }); | ||
|
|
||
| const suspendedWorkspacesChunks = chunk(suspendedWorkspaces, 5); | ||
|
|
||
| let deletedWorkspacesCount = 0; | ||
|
|
||
| for (const suspendedWorkspacesChunk of suspendedWorkspacesChunks) { | ||
| await Promise.all( | ||
| suspendedWorkspacesChunk.map(async (workspace) => { | ||
| const workspaceInactivity = | ||
| await this.computeWorkspaceBillingInactivity(workspace); | ||
|
|
||
| if ( | ||
| workspaceInactivity && | ||
| workspaceInactivity > this.inactiveDaysBeforeDelete && | ||
| deletedWorkspacesCount <= | ||
| this.maxNumberOfWorkspacesDeletedPerExecution | ||
| ) { | ||
| await this.informWorkspaceMembersAndDeleteWorkspace(workspace); | ||
| deletedWorkspacesCount++; | ||
|
|
||
| return; | ||
| } | ||
| if ( | ||
| workspaceInactivity && | ||
| workspaceInactivity > this.inactiveDaysBeforeWarn && | ||
| workspaceInactivity <= this.inactiveDaysBeforeDelete | ||
| ) { | ||
| await this.warnWorkspaceMembers(workspace, workspaceInactivity); | ||
|
|
||
| return; | ||
| } | ||
| }), | ||
| ); | ||
| } | ||
|
|
||
| this.logger.log(`Job done!`); | ||
| await this.cleanerWorkspaceService.batchWarnOrCleanSuspendedWorkspaces( | ||
| suspendedWorkspaceIds.map((workspace) => workspace.id), | ||
| ); | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
.../src/engine/workspace-manager/workspace-cleaner/exceptions/workspace-cleaner.exception.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import { CustomException } from 'src/utils/custom-exception'; | ||
|
|
||
| export class WorkspaceCleanerException extends CustomException { | ||
| code: WorkspaceCleanerExceptionCode; | ||
| constructor(message: string, code: WorkspaceCleanerExceptionCode) { | ||
| super(message, code); | ||
| } | ||
| } | ||
|
|
||
| export enum WorkspaceCleanerExceptionCode { | ||
| BILLING_SUBSCRIPTION_NOT_FOUND = 'BILLING_SUBSCRIPTION_NOT_FOUND', | ||
| } |
Oops, something went wrong.