Update schema and add tests (#12314)

For database event triggers, we remove the before / after logic. We go directly with the properties <img width="211" alt="Capture d’écran 2025-05-27 à 11 40 36" src="https://github.com/user-attachments/assets/a05bd3c1-104b-477b-be52-d56846ce7e63" /> To achieve this without changing the shape of events, we need to handle keys using dots, such: ``` 'properties.after.name': { icon: 'IconBuildingSkyscraper', type: FieldMetadataType.TEXT, label: 'Name', value: 'My text', isLeaf: true, }, ``` This PR: - adds logic to handle the case where the key has dot included - adds tests
2025-05-27 15:57:28 +02:00
parent 78f8562457
commit 4b25aabfa2
9 changed files with 761 additions and 315 deletions
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/generate-fake-object-record-event.spec.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/generate-fake-object-record-event.spec.ts
@ -0,0 +1,131 @@
+import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { generateFakeObjectRecordEvent } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record-event';
+import { generateObjectRecordFields } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields';
+
+jest.mock(
+  'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields',
+);
+
+describe('generateFakeObjectRecordEvent', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  const mockObjectMetadata = {
+    icon: 'test-icon',
+    labelSingular: 'Test Object',
+    description: 'Test Description',
+    nameSingular: 'testObject',
+  } as ObjectMetadataEntity;
+
+  const mockFields = {
+    field1: { type: 'TEXT', value: 'test' },
+    field2: { type: 'NUMBER', value: 123 },
+  };
+
+  beforeEach(() => {
+    (generateObjectRecordFields as jest.Mock).mockReturnValue(mockFields);
+  });
+
+  it('should generate record with "after" prefix for CREATED action', () => {
+    const result = generateFakeObjectRecordEvent(
+      mockObjectMetadata,
+      DatabaseEventAction.CREATED,
+    );
+
+    expect(result).toEqual({
+      object: {
+        isLeaf: true,
+        icon: 'test-icon',
+        label: 'Test Object',
+        value: 'Test Description',
+        nameSingular: 'testObject',
+        fieldIdName: 'properties.after.id',
+      },
+      fields: {
+        'properties.after.field1': { type: 'TEXT', value: 'test' },
+        'properties.after.field2': { type: 'NUMBER', value: 123 },
+      },
+      _outputSchemaType: 'RECORD',
+    });
+  });
+
+  it('should generate record with "after" prefix for UPDATED action', () => {
+    const result = generateFakeObjectRecordEvent(
+      mockObjectMetadata,
+      DatabaseEventAction.UPDATED,
+    );
+
+    expect(result).toEqual({
+      object: {
+        isLeaf: true,
+        icon: 'test-icon',
+        label: 'Test Object',
+        value: 'Test Description',
+        nameSingular: 'testObject',
+        fieldIdName: 'properties.after.id',
+      },
+      fields: {
+        'properties.after.field1': { type: 'TEXT', value: 'test' },
+        'properties.after.field2': { type: 'NUMBER', value: 123 },
+      },
+      _outputSchemaType: 'RECORD',
+    });
+  });
+
+  it('should generate record with "before" prefix for DELETED action', () => {
+    const result = generateFakeObjectRecordEvent(
+      mockObjectMetadata,
+      DatabaseEventAction.DELETED,
+    );
+
+    expect(result).toEqual({
+      object: {
+        isLeaf: true,
+        icon: 'test-icon',
+        label: 'Test Object',
+        value: 'Test Description',
+        nameSingular: 'testObject',
+        fieldIdName: 'properties.before.id',
+      },
+      fields: {
+        'properties.before.field1': { type: 'TEXT', value: 'test' },
+        'properties.before.field2': { type: 'NUMBER', value: 123 },
+      },
+      _outputSchemaType: 'RECORD',
+    });
+  });
+
+  it('should generate record with "before" prefix for DESTROYED action', () => {
+    const result = generateFakeObjectRecordEvent(
+      mockObjectMetadata,
+      DatabaseEventAction.DESTROYED,
+    );
+
+    expect(result).toEqual({
+      object: {
+        isLeaf: true,
+        icon: 'test-icon',
+        label: 'Test Object',
+        value: 'Test Description',
+        nameSingular: 'testObject',
+        fieldIdName: 'properties.before.id',
+      },
+      fields: {
+        'properties.before.field1': { type: 'TEXT', value: 'test' },
+        'properties.before.field2': { type: 'NUMBER', value: 123 },
+      },
+      _outputSchemaType: 'RECORD',
+    });
+  });
+
+  it('should throw error for unknown action', () => {
+    expect(() => {
+      generateFakeObjectRecordEvent(
+        mockObjectMetadata,
+        'UNKNOWN' as DatabaseEventAction,
+      );
+    }).toThrow("Unknown action 'UNKNOWN'");
+  });
+});
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/generate-fake-object-record.spec.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/generate-fake-object-record.spec.ts
@ -0,0 +1,55 @@
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { generateFakeObjectRecord } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record';
+import { generateObjectRecordFields } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields';
+
+jest.mock(
+  'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields',
+  () => ({
+    generateObjectRecordFields: jest.fn().mockReturnValue({
+      field1: { type: 'TEXT', value: 'test' },
+      field2: { type: 'NUMBER', value: 123 },
+    }),
+  }),
+);
+
+describe('generateFakeObjectRecord', () => {
+  it('should generate a record with correct object metadata', () => {
+    const mockObjectMetadata = {
+      icon: 'test-icon',
+      labelSingular: 'Test Object',
+      description: 'Test Description',
+      nameSingular: 'testObject',
+    } as ObjectMetadataEntity;
+
+    const result = generateFakeObjectRecord(mockObjectMetadata);
+
+    expect(result).toEqual({
+      object: {
+        isLeaf: true,
+        icon: 'test-icon',
+        label: 'Test Object',
+        value: 'Test Description',
+        nameSingular: 'testObject',
+        fieldIdName: 'id',
+      },
+      fields: {
+        field1: { type: 'TEXT', value: 'test' },
+        field2: { type: 'NUMBER', value: 123 },
+      },
+      _outputSchemaType: 'RECORD',
+    });
+  });
+
+  it('should call generateObjectRecordFields with the object metadata', () => {
+    const mockObjectMetadata = {
+      icon: 'test-icon',
+      labelSingular: 'Test Object',
+      description: 'Test Description',
+      nameSingular: 'testObject',
+    } as ObjectMetadataEntity;
+
+    generateFakeObjectRecord(mockObjectMetadata);
+
+    expect(generateObjectRecordFields).toHaveBeenCalledWith(mockObjectMetadata);
+  });
+});
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/generate-object-record-fields.spec.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/generate-object-record-fields.spec.ts
@ -0,0 +1,110 @@
+import { FieldMetadataType } from 'twenty-shared/types';
+
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { generateFakeField } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-field';
+import { generateObjectRecordFields } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields';
+import { shouldGenerateFieldFakeValue } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/should-generate-field-fake-value';
+
+jest.mock(
+  'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-field',
+);
+jest.mock(
+  'src/modules/workflow/workflow-builder/workflow-schema/utils/should-generate-field-fake-value',
+);
+
+describe('generateObjectRecordFields', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('should generate fields for valid fields only', () => {
+    const mockFields = [
+      {
+        name: 'field1',
+        type: FieldMetadataType.TEXT,
+        label: 'Field 1',
+        icon: 'icon1',
+        isSystem: false,
+        isActive: true,
+      },
+      {
+        name: 'field2',
+        type: FieldMetadataType.RELATION,
+        label: 'Field 2',
+        icon: 'icon2',
+        isSystem: false,
+        isActive: true,
+      },
+      {
+        name: 'field3',
+        type: FieldMetadataType.NUMBER,
+        label: 'Field 3',
+        icon: 'icon3',
+        isSystem: false,
+        isActive: true,
+      },
+    ];
+
+    const mockObjectMetadata = {
+      fields: mockFields,
+    } as ObjectMetadataEntity;
+
+    (shouldGenerateFieldFakeValue as jest.Mock).mockImplementation(
+      (field) => field.type !== FieldMetadataType.RELATION,
+    );
+
+    (generateFakeField as jest.Mock).mockImplementation(
+      ({ type, label, icon }) => ({
+        type,
+        label,
+        icon,
+        value: `mock-${type}`,
+      }),
+    );
+
+    const result = generateObjectRecordFields(mockObjectMetadata);
+
+    expect(result).toEqual({
+      field1: {
+        type: FieldMetadataType.TEXT,
+        label: 'Field 1',
+        icon: 'icon1',
+        value: 'mock-TEXT',
+      },
+      field3: {
+        type: FieldMetadataType.NUMBER,
+        label: 'Field 3',
+        icon: 'icon3',
+        value: 'mock-NUMBER',
+      },
+    });
+
+    expect(shouldGenerateFieldFakeValue).toHaveBeenCalledTimes(3);
+    expect(generateFakeField).toHaveBeenCalledTimes(2);
+  });
+
+  it('should return empty object when no valid fields', () => {
+    const mockFields = [
+      {
+        name: 'field1',
+        type: FieldMetadataType.RELATION,
+        label: 'Field 1',
+        icon: 'icon1',
+        isSystem: false,
+        isActive: true,
+      },
+    ];
+
+    const mockObjectMetadata = {
+      fields: mockFields,
+    } as ObjectMetadataEntity;
+
+    (shouldGenerateFieldFakeValue as jest.Mock).mockReturnValue(false);
+
+    const result = generateObjectRecordFields(mockObjectMetadata);
+
+    expect(result).toEqual({});
+    expect(shouldGenerateFieldFakeValue).toHaveBeenCalledTimes(1);
+    expect(generateFakeField).not.toHaveBeenCalled();
+  });
+});
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/should-generate-field-fake-value.spec.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/tests/should-generate-field-fake-value.spec.ts
@ -0,0 +1,61 @@
+import { FieldMetadataType } from 'twenty-shared/types';
+
+import { FieldMetadataEntity } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
+import { shouldGenerateFieldFakeValue } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/should-generate-field-fake-value';
+
+describe('shouldGenerateFieldFakeValue', () => {
+  it('should return true for active non-system fields', () => {
+    const field = {
+      isSystem: false,
+      isActive: true,
+      type: FieldMetadataType.TEXT,
+      name: 'testField',
+    } as FieldMetadataEntity;
+
+    expect(shouldGenerateFieldFakeValue(field)).toBe(true);
+  });
+
+  it('should return true for system id field', () => {
+    const field = {
+      isSystem: true,
+      isActive: true,
+      type: FieldMetadataType.UUID,
+      name: 'id',
+    } as FieldMetadataEntity;
+
+    expect(shouldGenerateFieldFakeValue(field)).toBe(true);
+  });
+
+  it('should return false for inactive fields', () => {
+    const field = {
+      isSystem: false,
+      isActive: false,
+      type: FieldMetadataType.TEXT,
+      name: 'testField',
+    } as FieldMetadataEntity;
+
+    expect(shouldGenerateFieldFakeValue(field)).toBe(false);
+  });
+
+  it('should return false for system fields (except id)', () => {
+    const field = {
+      isSystem: true,
+      isActive: true,
+      type: FieldMetadataType.TEXT,
+      name: 'testField',
+    } as FieldMetadataEntity;
+
+    expect(shouldGenerateFieldFakeValue(field)).toBe(false);
+  });
+
+  it('should return false for relation fields', () => {
+    const field = {
+      isSystem: false,
+      isActive: true,
+      type: FieldMetadataType.RELATION,
+      name: 'testField',
+    } as FieldMetadataEntity;
+
+    expect(shouldGenerateFieldFakeValue(field)).toBe(false);
+  });
+});
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record-event.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record-event.ts
@ -1,97 +1,60 @@
-import { v4 } from 'uuid';
-
 import { DatabaseEventAction } from 'src/engine/api/graphql/graphql-query-runner/enums/database-event-action';
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
-import { BaseOutputSchema } from 'src/modules/workflow/workflow-builder/workflow-schema/types/output-schema.type';
-import { generateFakeObjectRecord } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record';
-import { camelToTitleCase } from 'src/utils/camel-to-title-case';
+import {
+  BaseOutputSchema,
+  RecordOutputSchema,
+} from 'src/modules/workflow/workflow-builder/workflow-schema/types/output-schema.type';
+import { generateObjectRecordFields } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields';
+
+const generateFakeObjectRecordEventWithPrefix = ({
+  objectMetadataEntity,
+  prefix,
+}: {
+  objectMetadataEntity: ObjectMetadataEntity;
+  prefix: string;
+}): RecordOutputSchema => {
+  const recordFields = generateObjectRecordFields(objectMetadataEntity);
+  const prefixedRecordFields = Object.entries(recordFields).reduce(
+    (acc, [key, value]) => {
+      acc[`${prefix}.${key}`] = value;
+
+      return acc;
+    },
+    {} as BaseOutputSchema,
+  );
+
+  return {
+    object: {
+      isLeaf: true,
+      icon: objectMetadataEntity.icon,
+      label: objectMetadataEntity.labelSingular,
+      value: objectMetadataEntity.description,
+      nameSingular: objectMetadataEntity.nameSingular,
+      fieldIdName: `${prefix}.id`,
+    },
+    fields: prefixedRecordFields,
+    _outputSchemaType: 'RECORD',
+  };
+};

 export const generateFakeObjectRecordEvent = (
  objectMetadataEntity: ObjectMetadataEntity,
  action: DatabaseEventAction,
-): BaseOutputSchema => {
-  const recordId = v4();
-  const userId = v4();
-  const workspaceMemberId = v4();
-
-  const after = generateFakeObjectRecord(objectMetadataEntity);
-  const formattedObjectMetadataEntity = Object.entries(
-    objectMetadataEntity,
-  ).reduce((acc: BaseOutputSchema, [key, value]) => {
-    acc[key] = { isLeaf: true, value, label: camelToTitleCase(key) };
-
-    return acc;
-  }, {});
-
-  const baseResult: BaseOutputSchema = {
-    recordId: {
-      isLeaf: true,
-      type: 'string',
-      value: recordId,
-      label: 'Record ID',
-    },
-    userId: { isLeaf: true, type: 'string', value: userId, label: 'User ID' },
-    workspaceMemberId: {
-      isLeaf: true,
-      type: 'string',
-      value: workspaceMemberId,
-      label: 'Workspace Member ID',
-    },
-    objectMetadata: {
-      isLeaf: false,
-      value: formattedObjectMetadataEntity,
-      label: 'Object Metadata',
-    },
-  };
-
-  if (action === DatabaseEventAction.CREATED) {
-    return {
-      ...baseResult,
-      'properties.after': {
-        isLeaf: false,
-        value: after,
-        label: 'Record Fields',
-      },
-    };
+): RecordOutputSchema => {
+  switch (action) {
+    case DatabaseEventAction.CREATED:
+    case DatabaseEventAction.UPDATED:
+      return generateFakeObjectRecordEventWithPrefix({
+        objectMetadataEntity,
+        prefix: 'properties.after',
+      });
+    case DatabaseEventAction.DELETED:
+    case DatabaseEventAction.DESTROYED:
+      return generateFakeObjectRecordEventWithPrefix({
+        objectMetadataEntity,
+        prefix: 'properties.before',
+      });
+    default:
+      throw new Error(`Unknown action '${action}'`);
  }
-
-  const before = generateFakeObjectRecord(objectMetadataEntity);
-
-  if (action === DatabaseEventAction.UPDATED) {
-    return {
-      ...baseResult,
-      properties: {
-        isLeaf: false,
-        value: {
-          before: { isLeaf: false, value: before, label: 'Before Update' },
-          after: { isLeaf: false, value: after, label: 'After Update' },
-        },
-        label: 'Record Fields',
-      },
-    };
-  }
-
-  if (action === DatabaseEventAction.DELETED) {
-    return {
-      ...baseResult,
-      'properties.before': {
-        isLeaf: false,
-        value: before,
-        label: 'Record Fields',
-      },
-    };
-  }
-
-  if (action === DatabaseEventAction.DESTROYED) {
-    return {
-      ...baseResult,
-      'properties.before': {
-        isLeaf: false,
-        value: before,
-        label: 'Record Fields',
-      },
-    };
-  }
-
-  throw new Error(`Unknown action '${action}'`);
 };
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-object-record.ts
@ -1,31 +1,6 @@
 import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
-import {
-  Leaf,
-  Node,
-  RecordOutputSchema,
-} from 'src/modules/workflow/workflow-builder/workflow-schema/types/output-schema.type';
-import { generateFakeField } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-field';
-import { shouldGenerateFieldFakeValue } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/should-generate-field-fake-value';
-
-const generateObjectRecordFields = (
-  objectMetadataEntity: ObjectMetadataEntity,
-) =>
-  objectMetadataEntity.fields.reduce(
-    (acc: Record<string, Leaf | Node>, field) => {
-      if (!shouldGenerateFieldFakeValue(field)) {
-        return acc;
-      }
-
-      acc[field.name] = generateFakeField({
-        type: field.type,
-        label: field.label,
-        icon: field.icon,
-      });
-
-      return acc;
-    },
-    {},
-  );
+import { RecordOutputSchema } from 'src/modules/workflow/workflow-builder/workflow-schema/types/output-schema.type';
+import { generateObjectRecordFields } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields';

 export const generateFakeObjectRecord = (
  objectMetadataEntity: ObjectMetadataEntity,
--- a/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields.ts
+++ b/packages/twenty-server/src/modules/workflow/workflow-builder/workflow-schema/utils/generate-object-record-fields.ts
@ -0,0 +1,21 @@
+import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
+import { BaseOutputSchema } from 'src/modules/workflow/workflow-builder/workflow-schema/types/output-schema.type';
+import { generateFakeField } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/generate-fake-field';
+import { shouldGenerateFieldFakeValue } from 'src/modules/workflow/workflow-builder/workflow-schema/utils/should-generate-field-fake-value';
+
+export const generateObjectRecordFields = (
+  objectMetadataEntity: ObjectMetadataEntity,
+): BaseOutputSchema =>
+  objectMetadataEntity.fields.reduce((acc: BaseOutputSchema, field) => {
+    if (!shouldGenerateFieldFakeValue(field)) {
+      return acc;
+    }
+
+    acc[field.name] = generateFakeField({
+      type: field.type,
+      label: field.label,
+      icon: field.icon,
+    });
+
+    return acc;
+  }, {} as BaseOutputSchema);