6431 create new field activationStatus inside workspace table (#6439)

Closes #6431 
- create new field `activationStatus`
- create migration commands
- add logic to update `activationStatus` on workspace activation and on
stripe subscriptionStatus change

---------

Co-authored-by: Charles Bochet <charles@twenty.com>

packages/twenty-server/src/database/commands/upgrade-version/0-23/0-23-set-workspace-activation-status.command.ts

@@ -0,0 +1,124 @@
+import { Logger } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+
+import chalk from 'chalk';
+import { Command, CommandRunner, Option } from 'nest-commander';
+import { Repository } from 'typeorm';
+
+import { TypeORMService } from 'src/database/typeorm/typeorm.service';
+import { BillingService } from 'src/engine/core-modules/billing/billing.service';
+import {
+  Workspace,
+  WorkspaceActivationStatus,
+} from 'src/engine/core-modules/workspace/workspace.entity';
+import { DataSourceService } from 'src/engine/metadata-modules/data-source/data-source.service';
+import { WorkspaceCacheVersionService } from 'src/engine/metadata-modules/workspace-cache-version/workspace-cache-version.service';
+
+interface SetWorkspaceActivationStatusCommandOptions {
+  workspaceId?: string;
+}
+
+@Command({
+  name: 'migrate-0.23:set-workspace-activation-status',
+  description: 'Set workspace activation status',
+})
+export class SetWorkspaceActivationStatusCommand extends CommandRunner {
+  private readonly logger = new Logger(
+    SetWorkspaceActivationStatusCommand.name,
+  );
+  constructor(
+    @InjectRepository(Workspace, 'core')
+    private readonly workspaceRepository: Repository<Workspace>,
+    private readonly typeORMService: TypeORMService,
+    private readonly dataSourceService: DataSourceService,
+    private readonly workspaceCacheVersionService: WorkspaceCacheVersionService,
+    private readonly billingService: BillingService,
+  ) {
+    super();
+  }
+
+  @Option({
+    flags: '-w, --workspace-id [workspace_id]',
+    description: 'workspace id. Command runs on all workspaces if not provided',
+    required: false,
+  })
+  parseWorkspaceId(value: string): string {
+    return value;
+  }
+
+  async run(
+    _passedParam: string[],
+    options: SetWorkspaceActivationStatusCommandOptions,
+  ): Promise<void> {
+    let activeSubscriptionWorkspaceIds: string[] = [];
+
+    if (options.workspaceId) {
+      activeSubscriptionWorkspaceIds = [options.workspaceId];
+    } else {
+      activeSubscriptionWorkspaceIds =
+        await this.billingService.getActiveSubscriptionWorkspaceIds();
+    }
+
+    if (!activeSubscriptionWorkspaceIds.length) {
+      this.logger.log(chalk.yellow('No workspace found'));
+
+      return;
+    } else {
+      this.logger.log(
+        chalk.green(
+          `Running command on ${activeSubscriptionWorkspaceIds.length} workspaces`,
+        ),
+      );
+    }
+
+    for (const workspaceId of activeSubscriptionWorkspaceIds) {
+      try {
+        const dataSourceMetadatas =
+          await this.dataSourceService.getDataSourcesMetadataFromWorkspaceId(
+            workspaceId,
+          );
+
+        for (const dataSourceMetadata of dataSourceMetadatas) {
+          const workspaceDataSource =
+            await this.typeORMService.connectToDataSource(dataSourceMetadata);
+
+          if (workspaceDataSource) {
+            const queryRunner = workspaceDataSource.createQueryRunner();
+
+            await queryRunner.connect();
+            await queryRunner.startTransaction();
+
+            try {
+              await this.workspaceRepository.update(
+                { id: workspaceId },
+                { activationStatus: WorkspaceActivationStatus.ACTIVE },
+              );
+
+              await queryRunner.commitTransaction();
+            } catch (error) {
+              await queryRunner.rollbackTransaction();
+              this.logger.log(
+                chalk.red(`Running command on workspace ${workspaceId} failed`),
+              );
+              throw error;
+            } finally {
+              await queryRunner.release();
+            }
+          }
+        }
+
+        await this.workspaceCacheVersionService.incrementVersion(workspaceId);
+
+        this.logger.log(
+          chalk.green(`Running command on workspace ${workspaceId} done`),
+        );
+      } catch (error) {
+        this.logger.error(
+          `Migration failed for workspace ${workspaceId}: ${error.message}`,
+        );
+      }
+    }
+
+    this.logger.log(chalk.green(`Command completed!`));
+  }
+}

packages/twenty-server/src/database/commands/upgrade-version/0-23/0-23-upgrade-version.command.ts

@@ -3,6 +3,7 @@ import { Command, CommandRunner, Option } from 'nest-commander';
 import { MigrateDomainNameFromTextToLinksCommand } from 'src/database/commands/upgrade-version/0-23/0-23-migrate-domain-to-links.command';
 import { MigrateLinkFieldsToLinksCommand } from 'src/database/commands/upgrade-version/0-23/0-23-migrate-link-fields-to-links.command';
 import { MigrateMessageChannelSyncStatusEnumCommand } from 'src/database/commands/upgrade-version/0-23/0-23-migrate-message-channel-sync-status-enum.command';
+import { SetWorkspaceActivationStatusCommand } from 'src/database/commands/upgrade-version/0-23/0-23-set-workspace-activation-status.command';
 
 interface Options {
   workspaceId?: string;
@@ -17,6 +18,7 @@ export class UpgradeTo0_23Command extends CommandRunner {
     private readonly migrateLinkFieldsToLinks: MigrateLinkFieldsToLinksCommand,
     private readonly migrateDomainNameFromTextToLinks: MigrateDomainNameFromTextToLinksCommand,
     private readonly migrateMessageChannelSyncStatusEnumCommand: MigrateMessageChannelSyncStatusEnumCommand,
+    private readonly setWorkspaceActivationStatusCommand: SetWorkspaceActivationStatusCommand,
   ) {
     super();
   }
@@ -38,5 +40,6 @@ export class UpgradeTo0_23Command extends CommandRunner {
       _passedParam,
       options,
     );
+    await this.setWorkspaceActivationStatusCommand.run(_passedParam, options);
   }
 }

packages/twenty-server/src/database/commands/upgrade-version/0-23/0-23-upgrade-version.module.ts

@@ -4,8 +4,10 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { MigrateDomainNameFromTextToLinksCommand } from 'src/database/commands/upgrade-version/0-23/0-23-migrate-domain-to-links.command';
 import { MigrateLinkFieldsToLinksCommand } from 'src/database/commands/upgrade-version/0-23/0-23-migrate-link-fields-to-links.command';
 import { MigrateMessageChannelSyncStatusEnumCommand } from 'src/database/commands/upgrade-version/0-23/0-23-migrate-message-channel-sync-status-enum.command';
+import { SetWorkspaceActivationStatusCommand } from 'src/database/commands/upgrade-version/0-23/0-23-set-workspace-activation-status.command';
 import { UpgradeTo0_23Command } from 'src/database/commands/upgrade-version/0-23/0-23-upgrade-version.command';
 import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
+import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
 import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
 import { DataSourceModule } from 'src/engine/metadata-modules/data-source/data-source.module';
 import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
@@ -26,11 +28,13 @@ import { ViewModule } from 'src/modules/view/view.module';
     TypeOrmModule.forFeature([ObjectMetadataEntity], 'metadata'),
     TypeORMModule,
     ViewModule,
+    BillingModule,
   ],
   providers: [
     MigrateLinkFieldsToLinksCommand,
     MigrateDomainNameFromTextToLinksCommand,
     MigrateMessageChannelSyncStatusEnumCommand,
+    SetWorkspaceActivationStatusCommand,
     UpgradeTo0_23Command,
   ],
 })

packages/twenty-server/src/database/typeorm/core/migrations/1722256203539-addActivationStatus.ts

@@ -0,0 +1,23 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddActivationStatus1722256203539 implements MigrationInterface {
+  name = 'AddActivationStatus1722256203539';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TYPE "core"."workspace_activationstatus_enum" AS ENUM('ACTIVE', 'INACTIVE')`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "core"."workspace" ADD "activationStatus" "core"."workspace_activationstatus_enum" NOT NULL DEFAULT 'INACTIVE'`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "core"."workspace" DROP COLUMN "activationStatus"`,
+    );
+    await queryRunner.query(
+      `DROP TYPE "core"."workspace_activationstatus_enum"`,
+    );
+  }
+}

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

@@ -19,7 +19,10 @@ import {
 } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
 import { UserWorkspaceService } from 'src/engine/core-modules/user-workspace/user-workspace.service';
 import { User } from 'src/engine/core-modules/user/user.entity';
-import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+import {
+  Workspace,
+  WorkspaceActivationStatus,
+} from 'src/engine/core-modules/workspace/workspace.entity';
 import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
 import { assert } from 'src/utils/assert';
 
@@ -329,5 +332,24 @@ export class BillingWorkspaceService {
       workspaceId,
       key: FeatureFlagKeys.IsFreeAccessEnabled,
     });
+
+    if (
+      data.object.status === SubscriptionStatus.Canceled ||
+      data.object.status === SubscriptionStatus.Unpaid
+    ) {
+      await this.workspaceRepository.update(workspaceId, {
+        activationStatus: WorkspaceActivationStatus.INACTIVE,
+      });
+    }
+
+    if (
+      data.object.status === SubscriptionStatus.Active ||
+      data.object.status === SubscriptionStatus.Trialing ||
+      data.object.status === SubscriptionStatus.PastDue
+    ) {
+      await this.workspaceRepository.update(workspaceId, {
+        activationStatus: WorkspaceActivationStatus.ACTIVE,
+      });
+    }
   }
 }

packages/twenty-server/src/engine/core-modules/workspace/services/workspace.service.ts

@@ -15,7 +15,10 @@ import { UserWorkspaceService } from 'src/engine/core-modules/user-workspace/use
 import { User } from 'src/engine/core-modules/user/user.entity';
 import { ActivateWorkspaceInput } from 'src/engine/core-modules/workspace/dtos/activate-workspace-input';
 import { SendInviteLink } from 'src/engine/core-modules/workspace/dtos/send-invite-link.entity';
-import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+import {
+  Workspace,
+  WorkspaceActivationStatus,
+} from 'src/engine/core-modules/workspace/workspace.entity';
 import { EmailService } from 'src/engine/integrations/email/email.service';
 import { EnvironmentService } from 'src/engine/integrations/environment/environment.service';
 import { WorkspaceManagerService } from 'src/engine/workspace-manager/workspace-manager.service';
@@ -44,6 +47,7 @@ export class WorkspaceService extends TypeOrmQueryService<Workspace> {
     }
     await this.workspaceRepository.update(user.defaultWorkspace.id, {
       displayName: data.displayName,
+      activationStatus: WorkspaceActivationStatus.ACTIVE,
     });
     await this.workspaceManagerService.init(user.defaultWorkspace.id);
     await this.userWorkspaceService.createWorkspaceMember(

packages/twenty-server/src/engine/core-modules/workspace/workspace.entity.ts

@@ -1,4 +1,4 @@
-import { Field, ObjectType } from '@nestjs/graphql';
+import { Field, ObjectType, registerEnumType } from '@nestjs/graphql';
 
 import { IDField, UnPagedRelation } from '@ptc-org/nestjs-query-graphql';
 import {
@@ -11,14 +11,23 @@ import {
   UpdateDateColumn,
 } from 'typeorm';
 
-import { User } from 'src/engine/core-modules/user/user.entity';
-import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
-import { BillingSubscription } from 'src/engine/core-modules/billing/entities/billing-subscription.entity';
-import { UserWorkspace } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
-import { AppToken } from 'src/engine/core-modules/app-token/app-token.entity';
 import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
+import { AppToken } from 'src/engine/core-modules/app-token/app-token.entity';
+import { BillingSubscription } from 'src/engine/core-modules/billing/entities/billing-subscription.entity';
+import { FeatureFlagEntity } from 'src/engine/core-modules/feature-flag/feature-flag.entity';
 import { KeyValuePair } from 'src/engine/core-modules/key-value-pair/key-value-pair.entity';
 import { PostgresCredentials } from 'src/engine/core-modules/postgres-credentials/postgres-credentials.entity';
+import { UserWorkspace } from 'src/engine/core-modules/user-workspace/user-workspace.entity';
+import { User } from 'src/engine/core-modules/user/user.entity';
+
+export enum WorkspaceActivationStatus {
+  ACTIVE = 'ACTIVE',
+  INACTIVE = 'INACTIVE',
+}
+
+registerEnumType(WorkspaceActivationStatus, {
+  name: 'WorkspaceActivationStatus',
+});
 
 @Entity({ name: 'workspace', schema: 'core' })
 @ObjectType('Workspace')
@@ -87,8 +96,13 @@ export class Workspace {
   @Field({ nullable: true })
   workspaceMembersCount: number;
 
-  @Field()
-  activationStatus: 'active' | 'inactive';
+  @Field(() => WorkspaceActivationStatus)
+  @Column({
+    type: 'enum',
+    enum: WorkspaceActivationStatus,
+    default: WorkspaceActivationStatus.INACTIVE,
+  })
+  activationStatus: WorkspaceActivationStatus;
 
   @OneToMany(
     () => BillingSubscription,

packages/twenty-server/src/engine/core-modules/workspace/workspace.resolver.ts

@@ -29,7 +29,7 @@ import { WorkspaceCacheVersionService } from 'src/engine/metadata-modules/worksp
 import { assert } from 'src/utils/assert';
 import { streamToBuffer } from 'src/utils/stream-to-buffer';
 
-import { Workspace } from './workspace.entity';
+import { Workspace, WorkspaceActivationStatus } from './workspace.entity';
 
 import { WorkspaceService } from './services/workspace.service';
 
@@ -100,15 +100,19 @@ export class WorkspaceResolver {
     return this.workspaceService.deleteWorkspace(id);
   }
 
-  @ResolveField(() => String)
+  @ResolveField(() => WorkspaceActivationStatus)
   async activationStatus(
     @Parent() workspace: Workspace,
-  ): Promise<'active' | 'inactive'> {
-    if (await this.workspaceService.isWorkspaceActivated(workspace.id)) {
-      return 'active';
+  ): Promise<WorkspaceActivationStatus> {
+    if (workspace.activationStatus) {
+      return workspace.activationStatus;
     }
 
-    return 'inactive';
+    if (await this.workspaceService.isWorkspaceActivated(workspace.id)) {
+      return WorkspaceActivationStatus.ACTIVE;
+    }
+
+    return WorkspaceActivationStatus.INACTIVE;
   }
 
   @ResolveField(() => String, { nullable: true })