feat: add clean suspended workspaces command (#9808)

closes [283
sub-issue](https://github.com/twentyhq/core-team-issues/issues/283) -
[parent issue
](https://github.com/orgs/twentyhq/projects/1/views/3?filterQuery=sprint%3A%40current+assignee%3Aetiennejouan&pane=issue&itemId=93520456&issue=twentyhq%7Ccore-team-issues%7C179)

---------

Co-authored-by: etiennejouan <jouan.etienne@gmail.com>

packages/twenty-server/src/engine/core-modules/billing/billing.module.ts

@@ -26,6 +26,7 @@ import { BillingWebhookSubscriptionService } from 'src/engine/core-modules/billi
 import { DomainManagerModule } from 'src/engine/core-modules/domain-manager/domain-manager.module';
 import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
 import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
+import { MessageQueueModule } from 'src/engine/core-modules/message-queue/message-queue.module';
 import { UserWorkspace } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 
@@ -34,6 +35,7 @@ import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
     FeatureFlagModule,
     StripeModule,
     DomainManagerModule,
+    MessageQueueModule,
     TypeOrmModule.forFeature(
       [
         BillingSubscription,

packages/twenty-server/src/engine/core-modules/billing/webhooks/services/billing-webhook-subscription.service.ts

@@ -13,7 +13,28 @@ import { StripeCustomerService } from 'src/engine/core-modules/billing/stripe/se
 import { transformStripeSubscriptionEventToDatabaseCustomer } from 'src/engine/core-modules/billing/webhooks/utils/transform-stripe-subscription-event-to-database-customer.util';
 import { transformStripeSubscriptionEventToDatabaseSubscriptionItem } from 'src/engine/core-modules/billing/webhooks/utils/transform-stripe-subscription-event-to-database-subscription-item.util';
 import { transformStripeSubscriptionEventToDatabaseSubscription } from 'src/engine/core-modules/billing/webhooks/utils/transform-stripe-subscription-event-to-database-subscription.util';
+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 { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+import {
+  CleanWorkspaceDeletionWarningUserVarsJob,
+  CleanWorkspaceDeletionWarningUserVarsJobData,
+} from 'src/engine/workspace-manager/workspace-cleaner/jobs/clean-workspace-deletion-warning-user-vars.job';
+
+const BILLING_SUBSCRIPTION_STATUS_BY_WORKSPACE_ACTIVATION_STATUS = {
+  [WorkspaceActivationStatus.ACTIVE]: [
+    SubscriptionStatus.Active,
+    SubscriptionStatus.Trialing,
+    SubscriptionStatus.PastDue,
+  ],
+  [WorkspaceActivationStatus.SUSPENDED]: [
+    SubscriptionStatus.Canceled,
+    SubscriptionStatus.Unpaid,
+    SubscriptionStatus.Paused,
+  ],
+};
+
 @Injectable()
 export class BillingWebhookSubscriptionService {
   protected readonly logger = new Logger(
@@ -21,6 +42,8 @@ export class BillingWebhookSubscriptionService {
   );
   constructor(
     private readonly stripeCustomerService: StripeCustomerService,
+    @InjectMessageQueue(MessageQueue.workspaceQueue)
+    private readonly messageQueueService: MessageQueueService,
     @InjectRepository(BillingSubscription, 'core')
     private readonly billingSubscriptionRepository: Repository<BillingSubscription>,
     @InjectRepository(BillingSubscriptionItem, 'core')
@@ -62,14 +85,28 @@ export class BillingWebhookSubscriptionService {
       },
     );
 
-    const billingSubscription =
-      await this.billingSubscriptionRepository.findOneOrFail({
-        where: { stripeSubscriptionId: data.object.id },
-      });
+    const billingSubscriptions = await this.billingSubscriptionRepository.find({
+      where: { workspaceId },
+    });
+
+    const updatedBillingSubscription = billingSubscriptions.find(
+      (subscription) => subscription.stripeSubscriptionId === data.object.id,
+    );
+
+    if (!updatedBillingSubscription) {
+      throw new Error('Billing subscription not found');
+    }
+
+    const hasActiveWorkspaceCompatibleSubscription = billingSubscriptions.some(
+      (subscription) =>
+        BILLING_SUBSCRIPTION_STATUS_BY_WORKSPACE_ACTIVATION_STATUS[
+          WorkspaceActivationStatus.ACTIVE
+        ].includes(subscription.status),
+    );
 
     await this.billingSubscriptionItemRepository.upsert(
       transformStripeSubscriptionEventToDatabaseSubscriptionItem(
-        billingSubscription.id,
+        updatedBillingSubscription.id,
         data,
       ),
       {
@@ -79,9 +116,10 @@ export class BillingWebhookSubscriptionService {
     );
 
     if (
-      data.object.status === SubscriptionStatus.Canceled ||
-      data.object.status === SubscriptionStatus.Unpaid ||
-      data.object.status === SubscriptionStatus.Paused
+      BILLING_SUBSCRIPTION_STATUS_BY_WORKSPACE_ACTIVATION_STATUS[
+        WorkspaceActivationStatus.SUSPENDED
+      ].includes(data.object.status as SubscriptionStatus) &&
+      !hasActiveWorkspaceCompatibleSubscription
     ) {
       await this.workspaceRepository.update(workspaceId, {
         activationStatus: WorkspaceActivationStatus.SUSPENDED,
@@ -89,14 +127,19 @@ export class BillingWebhookSubscriptionService {
     }
 
     if (
-      (data.object.status === SubscriptionStatus.Active ||
-        data.object.status === SubscriptionStatus.Trialing ||
-        data.object.status === SubscriptionStatus.PastDue) &&
+      BILLING_SUBSCRIPTION_STATUS_BY_WORKSPACE_ACTIVATION_STATUS[
+        WorkspaceActivationStatus.ACTIVE
+      ].includes(data.object.status as SubscriptionStatus) &&
       workspace.activationStatus == WorkspaceActivationStatus.SUSPENDED
     ) {
       await this.workspaceRepository.update(workspaceId, {
         activationStatus: WorkspaceActivationStatus.ACTIVE,
       });
+
+      await this.messageQueueService.add<CleanWorkspaceDeletionWarningUserVarsJobData>(
+        CleanWorkspaceDeletionWarningUserVarsJob.name,
+        { workspaceId },
+      );
     }
 
     await this.stripeCustomerService.updateCustomerMetadataWorkspaceId(

packages/twenty-server/src/engine/core-modules/environment/environment-variables.ts

@@ -371,12 +371,17 @@ export class EnvironmentVariables {
       '"WORKSPACE_INACTIVE_DAYS_BEFORE_NOTIFICATION" should be strictly lower that "WORKSPACE_INACTIVE_DAYS_BEFORE_DELETION"',
   })
   @ValidateIf((env) => env.WORKSPACE_INACTIVE_DAYS_BEFORE_DELETION > 0)
-  WORKSPACE_INACTIVE_DAYS_BEFORE_NOTIFICATION = 30;
+  WORKSPACE_INACTIVE_DAYS_BEFORE_NOTIFICATION = 7;
 
   @CastToPositiveNumber()
   @IsNumber()
   @ValidateIf((env) => env.WORKSPACE_INACTIVE_DAYS_BEFORE_NOTIFICATION > 0)
-  WORKSPACE_INACTIVE_DAYS_BEFORE_DELETION = 60;
+  WORKSPACE_INACTIVE_DAYS_BEFORE_DELETION = 14;
+
+  @CastToPositiveNumber()
+  @IsNumber()
+  @ValidateIf((env) => env.MAX_NUMBER_OF_WORKSPACES_DELETED_PER_EXECUTION > 0)
+  MAX_NUMBER_OF_WORKSPACES_DELETED_PER_EXECUTION = 5;
 
   @IsEnum(CaptchaDriverType)
   @IsOptional()

packages/twenty-server/src/engine/core-modules/message-queue/jobs.module.ts

@@ -7,11 +7,13 @@ import { DataSeedDemoWorkspaceJob } from 'src/database/commands/data-seed-demo-w
 import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
 import { AuthModule } from 'src/engine/core-modules/auth/auth.module';
 import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
+import { BillingSubscription } from 'src/engine/core-modules/billing/entities/billing-subscription.entity';
 import { UpdateSubscriptionQuantityJob } from 'src/engine/core-modules/billing/jobs/update-subscription-quantity.job';
 import { StripeModule } from 'src/engine/core-modules/billing/stripe/stripe.module';
 import { EmailSenderJob } from 'src/engine/core-modules/email/email-sender.job';
 import { EmailModule } from 'src/engine/core-modules/email/email.module';
 import { UserWorkspaceModule } from 'src/engine/core-modules/user-workspace/user-workspace.module';
+import { UserVarsModule } from 'src/engine/core-modules/user/user-vars/user-vars.module';
 import { UserModule } from 'src/engine/core-modules/user/user.module';
 import { HandleWorkspaceMemberDeletedJob } from 'src/engine/core-modules/workspace/handle-workspace-member-deleted.job';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
@@ -19,6 +21,8 @@ import { WorkspaceModule } from 'src/engine/core-modules/workspace/workspace.mod
 import { DataSourceModule } from 'src/engine/metadata-modules/data-source/data-source.module';
 import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadata/object-metadata.module';
 import { CleanInactiveWorkspaceJob } from 'src/engine/workspace-manager/workspace-cleaner/crons/clean-inactive-workspace.job';
+import { CleanSuspendedWorkspacesJob } from 'src/engine/workspace-manager/workspace-cleaner/crons/clean-suspended-workspaces.job';
+import { CleanWorkspaceDeletionWarningUserVarsJob } from 'src/engine/workspace-manager/workspace-cleaner/jobs/clean-workspace-deletion-warning-user-vars.job';
 import { CalendarEventParticipantManagerModule } from 'src/modules/calendar/calendar-event-participant-manager/calendar-event-participant-manager.module';
 import { CalendarModule } from 'src/modules/calendar/calendar.module';
 import { AutoCompaniesAndContactsCreationJobModule } from 'src/modules/contact-creation-manager/jobs/auto-companies-and-contacts-creation-job.module';
@@ -31,11 +35,12 @@ import { WorkflowModule } from 'src/modules/workflow/workflow.module';
 
 @Module({
   imports: [
-    TypeOrmModule.forFeature([Workspace], 'core'),
+    TypeOrmModule.forFeature([Workspace, BillingSubscription], 'core'),
     DataSourceModule,
     ObjectMetadataModule,
     TypeORMModule,
     UserModule,
+    UserVarsModule,
     EmailModule,
     DataSeedDemoWorkspaceModule,
     BillingModule,
@@ -55,10 +60,12 @@ import { WorkflowModule } from 'src/modules/workflow/workflow.module';
   ],
   providers: [
     CleanInactiveWorkspaceJob,
+    CleanSuspendedWorkspacesJob,
     EmailSenderJob,
     DataSeedDemoWorkspaceJob,
     UpdateSubscriptionQuantityJob,
     HandleWorkspaceMemberDeletedJob,
+    CleanWorkspaceDeletionWarningUserVarsJob,
   ],
 })
 export class JobsModule {