5805 typing issue in rest api (#5818)

Fixed types for: - uuid - email - datetime - date - number - currency.amountMicros - select - multiSelect ## Before ![image](https://github.com/twentyhq/twenty/assets/29927851/4bfa3a6d-a26f-47e4-a46f-7a5582825482) ## After ![image](https://github.com/twentyhq/twenty/assets/29927851/0bbab32f-4172-4525-91d1-76c37f299ac0)
2024-06-11 14:54:02 +02:00
parent 710291238e
commit 5c15fcd249
8 changed files with 342 additions and 62 deletions
--- a/packages/twenty-server/src/engine/api/mocks/object-metadata-item.mock.ts
+++ b/packages/twenty-server/src/engine/api/mocks/object-metadata-item.mock.ts
@ -8,8 +8,8 @@ export const fieldNumberMock = {
  defaultValue: null,
 };

-export const fieldStringMock = {
-  name: 'fieldString',
+export const fieldTextMock = {
+  name: 'fieldText',
  type: FieldMetadataType.TEXT,
  isNullable: true,
  defaultValue: null,
@ -52,15 +52,177 @@ export const fieldSelectMock = {
  ],
 };

+const fieldMultiSelectMock = {
+  name: 'fieldMultiSelect',
+  type: FieldMetadataType.MULTI_SELECT,
+  isNullable: true,
+  defaultValue: "{'OPTION_1'}",
+  options: [
+    {
+      id: '9a519a86-422b-4598-88ae-78751353f683',
+      color: 'red',
+      label: 'Opt 1',
+      value: 'OPTION_1',
+      position: 0,
+    },
+    {
+      id: '33f28d51-bc82-4e1d-ae4b-d9e4c0ed0ab4',
+      color: 'purple',
+      label: 'Opt 2',
+      value: 'OPTION_2',
+      position: 1,
+    },
+  ],
+};
+
+const fieldRelationMock = {
+  name: 'fieldRelation',
+  type: FieldMetadataType.RELATION,
+  fromRelationMetadata: {
+    toObjectMetadata: {
+      nameSingular: 'toObjectMetadataName',
+    },
+  },
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldLinksMock = {
+  name: 'fieldLinks',
+  type: FieldMetadataType.LINKS,
+  isNullable: false,
+  defaultValue: [
+    { primaryLinkLabel: '', primaryLinkUrl: '', secondaryLinks: {} },
+  ],
+};
+
+const fieldUuidMock = {
+  name: 'fieldUuid',
+  type: FieldMetadataType.UUID,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldPhoneMock = {
+  name: 'fieldPhone',
+  type: FieldMetadataType.PHONE,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldEmailMock = {
+  name: 'fieldEmail',
+  type: FieldMetadataType.EMAIL,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldDateTimeMock = {
+  name: 'fieldDateTime',
+  type: FieldMetadataType.DATE_TIME,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldDateMock = {
+  name: 'fieldDate',
+  type: FieldMetadataType.DATE,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldBooleanMock = {
+  name: 'fieldBoolean',
+  type: FieldMetadataType.BOOLEAN,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldNumericMock = {
+  name: 'fieldNumeric',
+  type: FieldMetadataType.NUMERIC,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldProbabilityMock = {
+  name: 'fieldProbability',
+  type: FieldMetadataType.PROBABILITY,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldFullNameMock = {
+  name: 'fieldFullName',
+  type: FieldMetadataType.FULL_NAME,
+  isNullable: true,
+  defaultValue: { firstName: '', lastName: '' },
+};
+
+const fieldRatingMock = {
+  name: 'fieldRating',
+  type: FieldMetadataType.RATING,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldPositionMock = {
+  name: 'fieldPosition',
+  type: FieldMetadataType.POSITION,
+  isNullable: true,
+  defaultValue: null,
+};
+
+const fieldAddressMock = {
+  name: 'fieldAddress',
+  type: FieldMetadataType.ADDRESS,
+  isNullable: true,
+  defaultValue: {
+    addressStreet1: '',
+    addressStreet2: null,
+    addressCity: null,
+    addressState: null,
+    addressCountry: null,
+    addressPostcode: null,
+    addressLat: null,
+    addressLng: null,
+  },
+};
+
+const fieldRawJsonMock = {
+  name: 'fieldRawJson',
+  type: FieldMetadataType.RAW_JSON,
+  isNullable: true,
+  defaultValue: null,
+};
+
+export const fields = [
+  fieldUuidMock,
+  fieldTextMock,
+  fieldPhoneMock,
+  fieldEmailMock,
+  fieldDateTimeMock,
+  fieldDateMock,
+  fieldBooleanMock,
+  fieldNumberMock,
+  fieldNumericMock,
+  fieldProbabilityMock,
+  fieldLinkMock,
+  fieldLinksMock,
+  fieldCurrencyMock,
+  fieldFullNameMock,
+  fieldRatingMock,
+  fieldSelectMock,
+  fieldMultiSelectMock,
+  fieldRelationMock,
+  fieldPositionMock,
+  fieldAddressMock,
+  fieldRawJsonMock,
+];
+
 export const objectMetadataItemMock = {
  targetTableName: 'testingObject',
  nameSingular: 'objectName',
  namePlural: 'objectsName',
-  fields: [
-    fieldNumberMock,
-    fieldStringMock,
-    fieldLinkMock,
-    fieldCurrencyMock,
-    fieldSelectMock,
-  ],
+  fields,
 } as ObjectMetadataEntity;
--- a/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/tests/filter-input.factory.spec.ts
+++ b/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/tests/filter-input.factory.spec.ts
@ -78,12 +78,12 @@ describe('FilterInputFactory', () => {
    it('should create filter parser properly', () => {
      const request: any = {
        query: {
-          filter: 'fieldNumber[eq]:1,fieldString[eq]:"Test"',
+          filter: 'fieldNumber[eq]:1,fieldText[eq]:"Test"',
        },
      };

      expect(service.create(request, objectMetadata)).toEqual({
-        and: [{ fieldNumber: { eq: 1 } }, { fieldString: { eq: 'Test' } }],
+        and: [{ fieldNumber: { eq: 1 } }, { fieldText: { eq: 'Test' } }],
      });
    });

@ -91,21 +91,21 @@ describe('FilterInputFactory', () => {
      const request: any = {
        query: {
          filter:
-            'and(fieldNumber[eq]:1,fieldString[gte]:"Test",not(fieldString[ilike]:"%val%"),or(not(and(fieldString[startsWith]:"test",fieldNumber[in]:[2,4,5])),fieldCurrency.amountMicros[gt]:1))',
+            'and(fieldNumber[eq]:1,fieldText[gte]:"Test",not(fieldText[ilike]:"%val%"),or(not(and(fieldText[startsWith]:"test",fieldNumber[in]:[2,4,5])),fieldCurrency.amountMicros[gt]:1))',
        },
      };

      expect(service.create(request, objectMetadata)).toEqual({
        and: [
          { fieldNumber: { eq: 1 } },
-          { fieldString: { gte: 'Test' } },
-          { not: { fieldString: { ilike: '%val%' } } },
+          { fieldText: { gte: 'Test' } },
+          { not: { fieldText: { ilike: '%val%' } } },
          {
            or: [
              {
                not: {
                  and: [
-                    { fieldString: { startsWith: 'test' } },
+                    { fieldText: { startsWith: 'test' } },
                    { fieldNumber: { in: [2, 4, 5] } },
                  ],
                },
--- a/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/tests/order-by-input.factory.spec.ts
+++ b/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/tests/order-by-input.factory.spec.ts
@ -32,13 +32,13 @@ describe('OrderByInputFactory', () => {
    it('should create order by parser properly', () => {
      const request: any = {
        query: {
-          order_by: 'fieldNumber[AscNullsFirst],fieldString[DescNullsLast]',
+          order_by: 'fieldNumber[AscNullsFirst],fieldText[DescNullsLast]',
        },
      };

      expect(service.create(request, objectMetadata)).toEqual({
        fieldNumber: OrderByDirection.AscNullsFirst,
-        fieldString: OrderByDirection.DescNullsLast,
+        fieldText: OrderByDirection.DescNullsLast,
      });
    });

@ -95,7 +95,7 @@ describe('OrderByInputFactory', () => {
    it('should throw if direction invalid', () => {
      const request: any = {
        query: {
-          order_by: 'fieldString[invalid]',
+          order_by: 'fieldText[invalid]',
        },
      };

--- a/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/filter-utils/tests/parse-filter-content.utils.spec.ts
+++ b/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/filter-utils/tests/parse-filter-content.utils.spec.ts
@ -41,14 +41,14 @@ describe('parseFilterContent', () => {
  });

  it('should parse query filter with comma in value ', () => {
-    expect(parseFilterContent('and(fieldString[eq]:"val,ue")')).toEqual([
-      'fieldString[eq]:"val,ue"',
+    expect(parseFilterContent('and(fieldText[eq]:"val,ue")')).toEqual([
+      'fieldText[eq]:"val,ue"',
    ]);
  });

  it('should parse query filter with comma in value ', () => {
-    expect(parseFilterContent("and(fieldString[eq]:'val,ue')")).toEqual([
-      "fieldString[eq]:'val,ue'",
+    expect(parseFilterContent("and(fieldText[eq]:'val,ue')")).toEqual([
+      "fieldText[eq]:'val,ue'",
    ]);
  });
 });
--- a/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/filter-utils/tests/parse-filter.utils.spec.ts
+++ b/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/factories/input-factories/filter-utils/tests/parse-filter.utils.spec.ts
@ -51,25 +51,25 @@ describe('parseFilter', () => {
  it('should parse string filter test 4', () => {
    expect(
      parseFilter(
-        'and(fieldString[gt]:"val,ue",or(fieldNumber[is]:NOT_NULL,not(fieldString[startsWith]:"val"),and(fieldNumber[eq]:6,fieldString[ilike]:"%val%")),or(fieldNumber[eq]:4,fieldString[is]:NULL))',
+        'and(fieldText[gt]:"val,ue",or(fieldNumber[is]:NOT_NULL,not(fieldText[startsWith]:"val"),and(fieldNumber[eq]:6,fieldText[ilike]:"%val%")),or(fieldNumber[eq]:4,fieldText[is]:NULL))',
        objectMetadataItemMock,
      ),
    ).toEqual({
      and: [
-        { fieldString: { gt: 'val,ue' } },
+        { fieldText: { gt: 'val,ue' } },
        {
          or: [
            { fieldNumber: { is: 'NOT_NULL' } },
-            { not: { fieldString: { startsWith: 'val' } } },
+            { not: { fieldText: { startsWith: 'val' } } },
            {
              and: [
                { fieldNumber: { eq: 6 } },
-                { fieldString: { ilike: '%val%' } },
+                { fieldText: { ilike: '%val%' } },
              ],
            },
          ],
        },
-        { or: [{ fieldNumber: { eq: 4 } }, { fieldString: { is: 'NULL' } }] },
+        { or: [{ fieldNumber: { eq: 4 } }, { fieldText: { is: 'NULL' } }] },
      ],
    });
  });
--- a/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/utils/tests/map-field-metadata-to-graphql-query.utils.spec.ts
+++ b/packages/twenty-server/src/engine/api/rest/rest-api-core-query-builder/utils/tests/map-field-metadata-to-graphql-query.utils.spec.ts
@ -2,7 +2,7 @@ import {
  fieldCurrencyMock,
  fieldLinkMock,
  fieldNumberMock,
-  fieldStringMock,
+  fieldTextMock,
  objectMetadataItemMock,
 } from 'src/engine/api/__mocks__/object-metadata-item.mock';
 import { mapFieldMetadataToGraphqlQuery } from 'src/engine/api/rest/rest-api-core-query-builder/utils/map-field-metadata-to-graphql-query.utils';
@ -13,8 +13,8 @@ describe('mapFieldMetadataToGraphqlQuery', () => {
      mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldNumberMock),
    ).toEqual('fieldNumber');
    expect(
-      mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldStringMock),
-    ).toEqual('fieldString');
+      mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldTextMock),
+    ).toEqual('fieldText');
    expect(
      mapFieldMetadataToGraphqlQuery(objectMetadataItemMock, fieldLinkMock),
    ).toEqual(`