Migrate to a monorepo structure (#2909)

packages/twenty-server/src/metadata/workspace-migration/factories/basic-column-action.factory.ts

@@ -0,0 +1,92 @@
+import { Injectable, Logger } from '@nestjs/common';
+
+import { WorkspaceColumnActionOptions } from 'src/metadata/workspace-migration/interfaces/workspace-column-action-options.interface';
+import { FieldMetadataInterface } from 'src/metadata/field-metadata/interfaces/field-metadata.interface';
+import { FieldMetadataDefaultValue } from 'src/metadata/field-metadata/interfaces/field-metadata-default-value.interface';
+
+import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
+import {
+  WorkspaceMigrationColumnActionType,
+  WorkspaceMigrationColumnAlter,
+  WorkspaceMigrationColumnCreate,
+} from 'src/metadata/workspace-migration/workspace-migration.entity';
+import { serializeDefaultValue } from 'src/metadata/field-metadata/utils/serialize-default-value';
+import { fieldMetadataTypeToColumnType } from 'src/metadata/workspace-migration/utils/field-metadata-type-to-column-type.util';
+import { ColumnActionAbstractFactory } from 'src/metadata/workspace-migration/factories/column-action-abstract.factory';
+
+export type BasicFieldMetadataType =
+  | FieldMetadataType.UUID
+  | FieldMetadataType.TEXT
+  | FieldMetadataType.PHONE
+  | FieldMetadataType.EMAIL
+  | FieldMetadataType.NUMERIC
+  | FieldMetadataType.NUMBER
+  | FieldMetadataType.PROBABILITY
+  | FieldMetadataType.BOOLEAN
+  | FieldMetadataType.DATE_TIME;
+
+@Injectable()
+export class BasicColumnActionFactory extends ColumnActionAbstractFactory<BasicFieldMetadataType> {
+  protected readonly logger = new Logger(BasicColumnActionFactory.name);
+
+  protected handleCreateAction(
+    fieldMetadata: FieldMetadataInterface<BasicFieldMetadataType>,
+    options?: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnCreate {
+    const defaultValue =
+      this.getDefaultValue(fieldMetadata.defaultValue) ?? options?.defaultValue;
+    const serializedDefaultValue = serializeDefaultValue(defaultValue);
+
+    return {
+      action: WorkspaceMigrationColumnActionType.CREATE,
+      columnName: fieldMetadata.targetColumnMap.value,
+      columnType: fieldMetadataTypeToColumnType(fieldMetadata.type),
+      isNullable: fieldMetadata.isNullable,
+      defaultValue: serializedDefaultValue,
+    };
+  }
+
+  protected handleAlterAction(
+    currentFieldMetadata: FieldMetadataInterface<BasicFieldMetadataType>,
+    alteredFieldMetadata: FieldMetadataInterface<BasicFieldMetadataType>,
+    options?: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnAlter {
+    const defaultValue =
+      this.getDefaultValue(alteredFieldMetadata.defaultValue) ??
+      options?.defaultValue;
+    const serializedDefaultValue = serializeDefaultValue(defaultValue);
+
+    return {
+      action: WorkspaceMigrationColumnActionType.ALTER,
+      currentColumnDefinition: {
+        columnName: currentFieldMetadata.targetColumnMap.value,
+        columnType: fieldMetadataTypeToColumnType(currentFieldMetadata.type),
+        isNullable: currentFieldMetadata.isNullable,
+        defaultValue: serializeDefaultValue(
+          this.getDefaultValue(currentFieldMetadata.defaultValue),
+        ),
+      },
+      alteredColumnDefinition: {
+        columnName: alteredFieldMetadata.targetColumnMap.value,
+        columnType: fieldMetadataTypeToColumnType(alteredFieldMetadata.type),
+        isNullable: alteredFieldMetadata.isNullable,
+        defaultValue: serializedDefaultValue,
+      },
+    };
+  }
+
+  private getDefaultValue(
+    defaultValue:
+      | FieldMetadataDefaultValue<BasicFieldMetadataType>
+      | undefined
+      | null,
+  ) {
+    if (!defaultValue) return null;
+
+    if ('type' in defaultValue) {
+      return defaultValue;
+    } else {
+      return defaultValue?.value;
+    }
+  }
+}

packages/twenty-server/src/metadata/workspace-migration/factories/column-action-abstract.factory.ts

@@ -0,0 +1,66 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Logger } from '@nestjs/common';
+
+import { FieldMetadataInterface } from 'src/metadata/field-metadata/interfaces/field-metadata.interface';
+import { WorkspaceColumnActionOptions } from 'src/metadata/workspace-migration/interfaces/workspace-column-action-options.interface';
+import { WorkspaceColumnActionFactory } from 'src/metadata/workspace-migration/interfaces/workspace-column-action-factory.interface';
+
+import {
+  WorkspaceMigrationColumnActionType,
+  WorkspaceMigrationColumnAction,
+  WorkspaceMigrationColumnCreate,
+  WorkspaceMigrationColumnAlter,
+} from 'src/metadata/workspace-migration/workspace-migration.entity';
+import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
+
+export class ColumnActionAbstractFactory<
+  T extends FieldMetadataType | 'default',
+> implements WorkspaceColumnActionFactory<T>
+{
+  protected readonly logger = new Logger(ColumnActionAbstractFactory.name);
+
+  create(
+    action:
+      | WorkspaceMigrationColumnActionType.CREATE
+      | WorkspaceMigrationColumnActionType.ALTER,
+    currentFieldMetadata: FieldMetadataInterface<T> | undefined,
+    alteredFieldMetadata: FieldMetadataInterface<T>,
+    options?: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnAction {
+    switch (action) {
+      case WorkspaceMigrationColumnActionType.CREATE:
+        return this.handleCreateAction(alteredFieldMetadata, options);
+      case WorkspaceMigrationColumnActionType.ALTER: {
+        if (!currentFieldMetadata) {
+          throw new Error('current field metadata is required for alter');
+        }
+
+        return this.handleAlterAction(
+          currentFieldMetadata,
+          alteredFieldMetadata,
+          options,
+        );
+      }
+      default: {
+        this.logger.error(`Invalid action: ${action}`);
+
+        throw new Error('[AbstractFactory]: invalid action');
+      }
+    }
+  }
+
+  protected handleCreateAction(
+    _fieldMetadata: FieldMetadataInterface<T>,
+    _options?: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnCreate {
+    throw new Error('handleCreateAction method not implemented.');
+  }
+
+  protected handleAlterAction(
+    _currentFieldMetadata: FieldMetadataInterface<T>,
+    _alteredFieldMetadata: FieldMetadataInterface<T>,
+    _options?: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnAlter {
+    throw new Error('handleAlterAction method not implemented.');
+  }
+}

packages/twenty-server/src/metadata/workspace-migration/factories/enum-column-action.factory.ts

@@ -0,0 +1,99 @@
+import { Injectable, Logger } from '@nestjs/common';
+
+import { WorkspaceColumnActionOptions } from 'src/metadata/workspace-migration/interfaces/workspace-column-action-options.interface';
+import { FieldMetadataInterface } from 'src/metadata/field-metadata/interfaces/field-metadata.interface';
+
+import { FieldMetadataType } from 'src/metadata/field-metadata/field-metadata.entity';
+import {
+  WorkspaceMigrationColumnActionType,
+  WorkspaceMigrationColumnAlter,
+  WorkspaceMigrationColumnCreate,
+} from 'src/metadata/workspace-migration/workspace-migration.entity';
+import { serializeDefaultValue } from 'src/metadata/field-metadata/utils/serialize-default-value';
+import { fieldMetadataTypeToColumnType } from 'src/metadata/workspace-migration/utils/field-metadata-type-to-column-type.util';
+import { ColumnActionAbstractFactory } from 'src/metadata/workspace-migration/factories/column-action-abstract.factory';
+
+export type EnumFieldMetadataType =
+  | FieldMetadataType.RATING
+  | FieldMetadataType.SELECT
+  | FieldMetadataType.MULTI_SELECT;
+
+@Injectable()
+export class EnumColumnActionFactory extends ColumnActionAbstractFactory<EnumFieldMetadataType> {
+  protected readonly logger = new Logger(EnumColumnActionFactory.name);
+
+  protected handleCreateAction(
+    fieldMetadata: FieldMetadataInterface<EnumFieldMetadataType>,
+    options: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnCreate {
+    const defaultValue =
+      fieldMetadata.defaultValue?.value ?? options?.defaultValue;
+    const serializedDefaultValue = serializeDefaultValue(defaultValue);
+    const enumOptions = fieldMetadata.options
+      ? [...fieldMetadata.options.map((option) => option.value)]
+      : undefined;
+
+    return {
+      action: WorkspaceMigrationColumnActionType.CREATE,
+      columnName: fieldMetadata.targetColumnMap.value,
+      columnType: fieldMetadataTypeToColumnType(fieldMetadata.type),
+      enum: enumOptions,
+      isArray: fieldMetadata.type === FieldMetadataType.MULTI_SELECT,
+      isNullable: fieldMetadata.isNullable,
+      defaultValue: serializedDefaultValue,
+    };
+  }
+
+  protected handleAlterAction(
+    currentFieldMetadata: FieldMetadataInterface<EnumFieldMetadataType>,
+    alteredFieldMetadata: FieldMetadataInterface<EnumFieldMetadataType>,
+    options: WorkspaceColumnActionOptions,
+  ): WorkspaceMigrationColumnAlter {
+    const defaultValue =
+      alteredFieldMetadata.defaultValue?.value ?? options?.defaultValue;
+    const serializedDefaultValue = serializeDefaultValue(defaultValue);
+    const enumOptions = alteredFieldMetadata.options
+      ? [
+          ...alteredFieldMetadata.options.map((option) => {
+            const currentOption = currentFieldMetadata.options?.find(
+              (currentOption) => currentOption.id === option.id,
+            );
+
+            // The id is the same, but the value is different, so we need to alter the enum
+            if (currentOption && currentOption.value !== option.value) {
+              return {
+                from: currentOption.value,
+                to: option.value,
+              };
+            }
+
+            return option.value;
+          }),
+        ]
+      : undefined;
+
+    return {
+      action: WorkspaceMigrationColumnActionType.ALTER,
+      currentColumnDefinition: {
+        columnName: currentFieldMetadata.targetColumnMap.value,
+        columnType: fieldMetadataTypeToColumnType(currentFieldMetadata.type),
+        enum: currentFieldMetadata.options
+          ? [...currentFieldMetadata.options.map((option) => option.value)]
+          : undefined,
+        isArray: currentFieldMetadata.type === FieldMetadataType.MULTI_SELECT,
+        isNullable: currentFieldMetadata.isNullable,
+        defaultValue: serializeDefaultValue(
+          currentFieldMetadata.defaultValue?.value,
+        ),
+      },
+      alteredColumnDefinition: {
+        columnName: alteredFieldMetadata.targetColumnMap.value,
+        columnType: fieldMetadataTypeToColumnType(alteredFieldMetadata.type),
+        enum: enumOptions,
+        isArray: alteredFieldMetadata.type === FieldMetadataType.MULTI_SELECT,
+        isNullable: alteredFieldMetadata.isNullable,
+        defaultValue: serializedDefaultValue,
+      },
+    };
+  }
+}

packages/twenty-server/src/metadata/workspace-migration/factories/factories.ts

@@ -0,0 +1,7 @@
+import { BasicColumnActionFactory } from 'src/metadata/workspace-migration/factories/basic-column-action.factory';
+import { EnumColumnActionFactory } from 'src/metadata/workspace-migration/factories/enum-column-action.factory';
+
+export const workspaceColumnActionFactories = [
+  BasicColumnActionFactory,
+  EnumColumnActionFactory,
+];