twenty/packages/twenty-server/test/integration/metadata/suites/field-metadata/enum/successful-update-one-enum-field-metadata.integration-spec.ts

import { UPDATE_ENUM_FIELD_METADATA_TEST_CASES } from 'test/integration/metadata/suites/field-metadata/enum/common/update-enum-field-metadata-test-cases';
import { type CreateOneFieldFactoryInput } from 'test/integration/metadata/suites/field-metadata/utils/create-one-field-metadata-query-factory.util';
import { createOneFieldMetadata } from 'test/integration/metadata/suites/field-metadata/utils/create-one-field-metadata.util';
import { updateOneFieldMetadata } from 'test/integration/metadata/suites/field-metadata/utils/update-one-field-metadata.util';
import { createOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/create-one-object-metadata.util';
import { deleteOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { updateOneObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/update-one-object-metadata.util';
import { updateFeatureFlag } from 'test/integration/metadata/suites/utils/update-feature-flag.util';
import { FieldMetadataType } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';

import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
import {
  type FieldMetadataComplexOption,
  type FieldMetadataDefaultOption,
} from 'src/engine/metadata-modules/field-metadata/dtos/options.input';
import { fieldMetadataEnumTypes } from 'src/engine/metadata-modules/field-metadata/utils/is-enum-field-metadata-type.util';

describe.each(fieldMetadataEnumTypes)(
  'Successful update field metadata %s tests suite',
  (testedFieldMetadataType) => {
    let createdObjectMetadataId: string;
    let createdFieldMetadataId: string;
    const testCases =
      UPDATE_ENUM_FIELD_METADATA_TEST_CASES[testedFieldMetadataType];

    if (!isDefined(testCases)) {
      return;
    }
    const { successful: successfulTestCases } = testCases;

    beforeAll(async () => {
      await updateFeatureFlag({
        expectToFail: false,
        featureFlag: FeatureFlagKey.IS_WORKSPACE_MIGRATION_V2_ENABLED,
        value: false,
      });
    });

    afterAll(async () => {
      await updateFeatureFlag({
        expectToFail: false,
        featureFlag: FeatureFlagKey.IS_WORKSPACE_MIGRATION_V2_ENABLED,
        value: true,
      });
    });

    const initialOptions: CreateOneFieldFactoryInput['options'] = [
      {
        label: 'Option 1',
        value: 'OPTION_1',
        color: 'green',
        position: 1,
      },
      {
        label: 'Option 2',
        value: 'OPTION_2',
        color: 'green',
        position: 2,
      },
    ];

    beforeEach(async () => {
      const { data } = await createOneObjectMetadata({
        expectToFail: false,
        input: {
          labelSingular: 'successUpdateEnumField',
          labelPlural: 'successUpdateEnumFields',
          nameSingular: 'successUpdateEnumField',
          namePlural: 'successUpdateEnumFields',
          icon: 'IconBuildingSkyscraper',
          isLabelSyncedWithName: false,
        },
      });

      createdObjectMetadataId = data.createOneObject.id;

      const {
        data: { createOneField },
      } = await createOneFieldMetadata({
        expectToFail: false,
        input: {
          objectMetadataId: createdObjectMetadataId,
          type: testedFieldMetadataType,
          name: 'testField',
          label: 'Test Field',
          isLabelSyncedWithName: false,
          options: initialOptions,
        },
        gqlFields: `
          id
          type
          `,
      });

      createdFieldMetadataId = createOneField.id;
    });

    afterEach(async () => {
      await updateOneObjectMetadata({
        expectToFail: false,
        input: {
          idToUpdate: createdObjectMetadataId,
          updatePayload: {
            isActive: false,
          },
        },
      });
      await deleteOneObjectMetadata({
        expectToFail: false,
        input: { idToDelete: createdObjectMetadataId },
      });
    });

    it('Should update default value to null even if it was set before', async () => {
      const isMultiSelect =
        testedFieldMetadataType === FieldMetadataType.MULTI_SELECT;
      const rawDefaultValue = `'${initialOptions[0].value}'`;
      const expectedDefaultValue = isMultiSelect
        ? [rawDefaultValue]
        : rawDefaultValue;

      const { data: firstUpdate } = await updateOneFieldMetadata({
        input: {
          idToUpdate: createdFieldMetadataId,
          updatePayload: {
            defaultValue: expectedDefaultValue,
          },
        },
        gqlFields: `
        id
        defaultValue
        `,
      });

      expect(firstUpdate.updateOneField.defaultValue).toEqual(
        expectedDefaultValue,
      );

      const updatedOptions = initialOptions.slice(1);
      const { data: secondUpdate, errors } = await updateOneFieldMetadata({
        input: {
          idToUpdate: createdFieldMetadataId,
          updatePayload: {
            defaultValue: null,
            options: updatedOptions,
          },
        },
        gqlFields: `
        id
        options
        defaultValue
        `,
      });

      expect(errors).toBeUndefined();
      expect(secondUpdate.updateOneField.defaultValue).toBeNull();
      expect(secondUpdate.updateOneField.options).toMatchObject(updatedOptions);
    });

    test.each(successfulTestCases)(
      'Update $title',
      async ({ context: { input, expectedOptions } }) => {
        const { ...updatePayload } = input;

        const { data, errors } = await updateOneFieldMetadata({
          input: {
            idToUpdate: createdFieldMetadataId,
            updatePayload,
          },
          gqlFields: `
        id
        options
        defaultValue
        `,
        });

        expect(data.updateOneField).toBeDefined();
        const updatedOptions:
          | FieldMetadataComplexOption[]
          | FieldMetadataDefaultOption[]
          | null = data.updateOneField.options;

        expect(updatedOptions).toBeDefined();
        if (!isDefined(updatedOptions))
          throw new Error(
            'Should never occur, type invariant post test assertion',
          );

        expect(errors).toBeUndefined();
        updatedOptions.forEach((option) => expect(option.id).toBeDefined());

        const optionsToCompare = expectedOptions ?? input.options ?? [];

        expect(updatedOptions.length).toBe(optionsToCompare.length);
        expect(updatedOptions).toMatchObject(optionsToCompare);

        if (isDefined(input.defaultValue)) {
          expect(data.updateOneField.defaultValue).toEqual(input.defaultValue);
        }
      },
    );
  },
);