The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(workspace cleaning) - Enqueue suspended workspace destruction instead of running it inside the cron (#26354)
Etienneda97578aff65
diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-onboarding-workspaces.cron.pattern.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-onboarding-workspaces.cron.pattern.tsindex 8e7638c91f8..5e46c468b11 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-onboarding-workspaces.cron.pattern.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-onboarding-workspaces.cron.pattern.ts@@ -1 +1 @@-export const cleanOnboardingWorkspacesCronPattern = '0 * * * *'; // Every hour at minute 0+export const cleanOnboardingWorkspacesCronPattern = '30 * * * *'; // Every hour at minute 30diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-suspended-workspaces.job.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-suspended-workspaces.job.tsindex 1130e2928a0..1fadeb5595a 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-suspended-workspaces.job.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/crons/clean-suspended-workspaces.job.ts@@ -35,7 +35,6 @@ export class CleanSuspendedWorkspacesJob {@SentryCronMonitor(CleanSuspendedWorkspacesJob.name,cleanSuspendedWorkspaceCronPattern,- { maxRuntimeInMinutes: 15 },)async handle(): Promise<void> {const advisoryLockResult =diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/jobs/destroy-soft-deleted-workspace.job.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/jobs/destroy-soft-deleted-workspace.job.tsnew file mode 100644index 00000000000..a0d07fe39d5--- /dev/null+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/jobs/destroy-soft-deleted-workspace.job.ts@@ -0,0 +1,54 @@+import { Injectable, Logger } from '@nestjs/common';+import { InjectRepository } from '@nestjs/typeorm';++import { Repository } from 'typeorm';++import { MetricsService } from 'src/engine/core-modules/metrics/metrics.service';+import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';+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 { WorkspaceService } from 'src/engine/core-modules/workspace/services/workspace.service';+import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';++export type DestroySoftDeletedWorkspaceJobData = {+ workspaceId: string;+};++@Injectable()+@Processor(MessageQueue.workspaceQueue)+export class DestroySoftDeletedWorkspaceJob {+ private readonly logger = new Logger(DestroySoftDeletedWorkspaceJob.name);++ constructor(+ @InjectRepository(WorkspaceEntity)+ private readonly workspaceRepository: Repository<WorkspaceEntity>,+ private readonly workspaceService: WorkspaceService,+ private readonly metricsService: MetricsService,+ ) {}++ @Process(DestroySoftDeletedWorkspaceJob.name)+ async handle({+ workspaceId,+ }: DestroySoftDeletedWorkspaceJobData): Promise<void> {+ const isWorkspaceStillPresent = await this.workspaceRepository.exists({+ where: { id: workspaceId },+ withDeleted: true,+ });++ if (!isWorkspaceStillPresent) {+ this.logger.log(`Workspace ${workspaceId} is already destroyed`);++ return;+ }++ this.logger.log(`Destroying workspace ${workspaceId}`);++ await this.workspaceService.deleteWorkspace(workspaceId);++ void this.metricsService.incrementCounterForEvent({+ key: MetricsKeys.CronJobDeletedWorkspace,+ shouldStoreInCache: false,+ });+ }+}diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service.tsindex be3d7810721..37f5d6b0417 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service.ts@@ -23,8 +23,9 @@ import {import { WorkspaceDomainsService } from 'src/engine/core-modules/domain/workspace-domains/services/workspace-domains.service';import { EmailService } from 'src/engine/core-modules/email/email.service';import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';-import { MetricsService } from 'src/engine/core-modules/metrics/metrics.service';-import { MetricsKeys } from 'src/engine/core-modules/metrics/types/metrics-keys.type';+import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';+import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';+import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';import { UserWorkspaceEntity } from 'src/engine/core-modules/user-workspace/user-workspace.entity';import { UserService } from 'src/engine/core-modules/user/services/user.service';@@ -34,6 +35,11 @@ import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entimport { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';import { WorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/workspace-scoped-repository';import { USER_WORKSPACE_DELETION_WARNING_SENT_KEY } from 'src/engine/workspace-manager/workspace-cleaner/constants/user-workspace-deletion-warning-sent-key.constant';+import {+ DestroySoftDeletedWorkspaceJob,+ type DestroySoftDeletedWorkspaceJobData,+} from 'src/engine/workspace-manager/workspace-cleaner/jobs/destroy-soft-deleted-workspace.job';+import { hasPassedDestroyGracePeriod } from 'src/engine/workspace-manager/workspace-cleaner/utils/has-passed-destroy-grace-period.util';import { WorkspaceMemberWorkspaceEntity } from 'src/modules/workspace-member/standard-objects/workspace-member.workspace-entity';export const CLEAN_SUSPENDED_WORKSPACES_OPERATIONS = [@@ -74,8 +80,9 @@ export class CleanerWorkspaceService {@InjectRepository(UserWorkspaceEntity)private readonly userWorkspaceRepository: Repository<UserWorkspaceEntity>,private readonly i18nService: I18nService,- private readonly metricsService: MetricsService,private readonly workspaceDomainsService: WorkspaceDomainsService,+ @InjectMessageQueue(MessageQueue.workspaceQueue)+ private readonly messageQueueService: MessageQueueService,) {this.inactiveDaysBeforeSoftDelete = this.twentyConfigService.get('WORKSPACE_INACTIVE_DAYS_BEFORE_SOFT_DELETION',@@ -332,49 +339,6 @@ export class CleanerWorkspaceService {}}- async destroySoftDeletedWorkspace({- workspace,- ignoreGracePeriod = false,- dryRun = false,- }: {- ignoreGracePeriod?: boolean;- dryRun?: boolean;- workspace: WorkspaceEntity;- }): Promise<WorkspaceEntity | undefined> {- if (!isDefined(workspace.deletedAt)) {- return;- }-- const daysSinceSoftDeleted = workspace.deletedAt- ? differenceInDays(new Date(), workspace.deletedAt)- : 0;-- const hasPassedGracePeriod =- daysSinceSoftDeleted >- this.inactiveDaysBeforeDelete - this.inactiveDaysBeforeSoftDelete;-- const canHardDelete = ignoreGracePeriod || hasPassedGracePeriod;-- if (!canHardDelete) {- return;- }-- this.logger.log(- `${dryRun ? 'DRY RUN - ' : ''}Destroying workspace ${workspace.id} ${workspace.displayName}`,- );- if (dryRun) {- return;- }-- await this.workspaceService.deleteWorkspace(workspace.id);- void this.metricsService.incrementCounterForEvent({- key: MetricsKeys.CronJobDeletedWorkspace,- shouldStoreInCache: false,- });-- return workspace;- }-async batchWarnOrCleanSuspendedWorkspaces({workspaceIds,dryRun = false,@@ -405,7 +369,7 @@ export class CleanerWorkspaceService {warnedUserVars.map((userVar) => userVar.workspaceId),);- let deletedWorkspacesCount = 0;+ let enqueuedWorkspacesCount = 0;for (const [index, workspace] of workspaces.entries()) {this.logger.log(@@ -415,7 +379,7 @@ export class CleanerWorkspaceService {try {const isSoftDeletedWorkspace = isDefined(workspace.deletedAt);const isWithinDeletionLimit =- deletedWorkspacesCount <+ enqueuedWorkspacesCount <this.maxNumberOfWorkspacesDeletedPerExecution;if (@@ -423,17 +387,35 @@ export class CleanerWorkspaceService {isSoftDeletedWorkspace &&isWithinDeletionLimit) {- const result = await this.destroySoftDeletedWorkspace({- workspace,- dryRun,- ignoreGracePeriod: ignoreDestroyGracePeriod,- });+ const canDestroy =+ ignoreDestroyGracePeriod ||+ hasPassedDestroyGracePeriod({+ workspace,+ gracePeriodInDays:+ this.inactiveDaysBeforeDelete -+ this.inactiveDaysBeforeSoftDelete,+ });- if (isDefined(result)) {- deletedWorkspacesCount++;+ if (canDestroy) {this.logger.log(- `Destroyed ${deletedWorkspacesCount} workspaces on ${this.maxNumberOfWorkspacesDeletedPerExecution} limit durings this execution`,+ `${dryRun ? 'DRY RUN - ' : ''}Enqueuing destruction of workspace ${workspace.id} ${workspace.displayName}`,);++ if (!dryRun) {+ const jobId =+ await this.messageQueueService.add<DestroySoftDeletedWorkspaceJobData>(+ DestroySoftDeletedWorkspaceJob.name,+ { workspaceId: workspace.id },+ { id: `destroy-soft-deleted-workspace-${workspace.id}` },+ );++ if (isDefined(jobId)) {+ enqueuedWorkspacesCount++;+ this.logger.log(+ `Enqueued ${enqueuedWorkspacesCount} workspaces on ${this.maxNumberOfWorkspacesDeletedPerExecution} limit during this execution`,+ );+ }+ }}continue;}diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/utils/__tests__/has-passed-destroy-grace-period.util.spec.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/utils/__tests__/has-passed-destroy-grace-period.util.spec.tsnew file mode 100644index 00000000000..d446b6b4972--- /dev/null+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/utils/__tests__/has-passed-destroy-grace-period.util.spec.ts@@ -0,0 +1,49 @@+import { hasPassedDestroyGracePeriod } from 'src/engine/workspace-manager/workspace-cleaner/utils/has-passed-destroy-grace-period.util';++const NOW = new Date('2026-09-22T09:00:00.000Z');+const GRACE_PERIOD_IN_DAYS = 15;++const daysBeforeNow = (days: number) =>+ new Date(NOW.getTime() - days * 24 * 60 * 60 * 1000);++describe('hasPassedDestroyGracePeriod', () => {+ beforeEach(() => {+ jest.setSystemTime(NOW);+ });++ it('should return false when the workspace is not soft deleted', () => {+ expect(+ hasPassedDestroyGracePeriod({+ workspace: { deletedAt: undefined },+ gracePeriodInDays: GRACE_PERIOD_IN_DAYS,+ }),+ ).toBe(false);+ });++ it('should return false when the workspace is still within the grace period', () => {+ expect(+ hasPassedDestroyGracePeriod({+ workspace: { deletedAt: daysBeforeNow(5) },+ gracePeriodInDays: GRACE_PERIOD_IN_DAYS,+ }),+ ).toBe(false);+ });++ it('should return false on the last day of the grace period', () => {+ expect(+ hasPassedDestroyGracePeriod({+ workspace: { deletedAt: daysBeforeNow(GRACE_PERIOD_IN_DAYS) },+ gracePeriodInDays: GRACE_PERIOD_IN_DAYS,+ }),+ ).toBe(false);+ });++ it('should return true once the grace period has passed', () => {+ expect(+ hasPassedDestroyGracePeriod({+ workspace: { deletedAt: daysBeforeNow(GRACE_PERIOD_IN_DAYS + 1) },+ gracePeriodInDays: GRACE_PERIOD_IN_DAYS,+ }),+ ).toBe(true);+ });+});diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/utils/has-passed-destroy-grace-period.util.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/utils/has-passed-destroy-grace-period.util.tsnew file mode 100644index 00000000000..d35c512e543--- /dev/null+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/utils/has-passed-destroy-grace-period.util.ts@@ -0,0 +1,14 @@+import { differenceInDays } from 'date-fns';+import { isDefined } from 'twenty-shared/utils';++import { type WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';++export const hasPassedDestroyGracePeriod = ({+ workspace,+ gracePeriodInDays,+}: {+ workspace: Pick<WorkspaceEntity, 'deletedAt'>;+ gracePeriodInDays: number;+}): boolean =>+ isDefined(workspace.deletedAt) &&+ differenceInDays(new Date(), workspace.deletedAt) > gracePeriodInDays;diff --git a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/workspace-cleaner.module.ts b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/workspace-cleaner.module.tsindex cc78c39658c..d9ea261dbf5 100644--- a/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/workspace-cleaner.module.ts+++ b/packages/twenty-server/src/engine/workspace-manager/workspace-cleaner/workspace-cleaner.module.ts@@ -18,6 +18,7 @@ import { CleanOnboardingWorkspacesCronCommand } from 'src/engine/workspace-managimport { CleanSuspendedWorkspacesCommand } from 'src/engine/workspace-manager/workspace-cleaner/commands/clean-suspended-workspaces.command';import { CleanSuspendedWorkspacesCronCommand } from 'src/engine/workspace-manager/workspace-cleaner/commands/clean-suspended-workspaces.cron.command';import { DestroyWorkspaceCommand } from 'src/engine/workspace-manager/workspace-cleaner/commands/destroy-workspace.command';+import { DestroySoftDeletedWorkspaceJob } from 'src/engine/workspace-manager/workspace-cleaner/jobs/destroy-soft-deleted-workspace.job';import { CleanerWorkspaceService } from 'src/engine/workspace-manager/workspace-cleaner/services/cleaner.workspace-service';@Module({@@ -43,6 +44,7 @@ import { CleanerWorkspaceService } from 'src/engine/workspace-manager/workspace-CleanOnboardingWorkspacesCommand,CleanOnboardingWorkspacesCronCommand,CleanerWorkspaceService,+ DestroySoftDeletedWorkspaceJob,provideWorkspaceScopedRepository(BillingSubscriptionEntity),],exports: [