The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Derive persisted record filter types from field metadata like views (#27754)
Félix Malfait652c47611c49
diff --git a/packages/twenty-front/src/modules/object-record/record-filter/utils/__tests__/getRecordFilterTypeAndLabelFromFieldMetadata.test.ts b/packages/twenty-front/src/modules/object-record/record-filter/utils/__tests__/getRecordFilterTypeAndLabelFromFieldMetadata.test.tsnew file mode 100644index 00000000000..aaaf21e2b56--- /dev/null+++ b/packages/twenty-front/src/modules/object-record/record-filter/utils/__tests__/getRecordFilterTypeAndLabelFromFieldMetadata.test.ts@@ -0,0 +1,70 @@+import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';+import { getRecordFilterTypeAndLabelFromFieldMetadata } from '@/object-record/record-filter/utils/getRecordFilterTypeAndLabelFromFieldMetadata';+import { FieldMetadataType } from 'twenty-shared/types';++const ownerFieldMetadataItem = {+ id: 'owner-field-id',+ name: 'owner',+ label: 'Owner',+ type: FieldMetadataType.MORPH_RELATION,+} as FieldMetadataItem;++const stageFieldMetadataItem = {+ id: 'stage-field-id',+ name: 'stage',+ label: 'Stage',+ type: FieldMetadataType.SELECT,+} as FieldMetadataItem;++const searchVectorFieldMetadataItem = {+ id: 'search-vector-field-id',+ name: 'searchVector',+ label: 'Search vector',+ type: FieldMetadataType.TS_VECTOR,+} as FieldMetadataItem;++const fieldMetadataItems = [+ ownerFieldMetadataItem,+ stageFieldMetadataItem,+ searchVectorFieldMetadataItem,+];++describe('getRecordFilterTypeAndLabelFromFieldMetadata', () => {+ it('should return the relation filter type for a morph relation field', () => {+ expect(+ getRecordFilterTypeAndLabelFromFieldMetadata({+ fieldMetadataId: ownerFieldMetadataItem.id,+ fieldMetadataItems,+ }),+ ).toEqual({ type: 'RELATION', label: 'Owner' });+ });++ it('should use the relation target field for a relation-traversal filter', () => {+ expect(+ getRecordFilterTypeAndLabelFromFieldMetadata({+ fieldMetadataId: ownerFieldMetadataItem.id,+ relationTargetFieldMetadataId: stageFieldMetadataItem.id,+ fieldMetadataItems,+ }),+ ).toEqual({ type: 'SELECT', label: 'Owner → Stage' });+ });++ it('should label the search vector field as Search', () => {+ expect(+ getRecordFilterTypeAndLabelFromFieldMetadata({+ fieldMetadataId: searchVectorFieldMetadataItem.id,+ fieldMetadataItems,+ }),+ ).toEqual({ type: 'TS_VECTOR', label: 'Search' });+ });++ it('should return undefined when the relation target field is unknown', () => {+ expect(+ getRecordFilterTypeAndLabelFromFieldMetadata({+ fieldMetadataId: ownerFieldMetadataItem.id,+ relationTargetFieldMetadataId: 'unknown-field-id',+ fieldMetadataItems,+ }),+ ).toBeUndefined();+ });+});diff --git a/packages/twenty-front/src/modules/object-record/record-filter/utils/__tests__/hydrateRecordFiltersFromFieldMetadata.test.ts b/packages/twenty-front/src/modules/object-record/record-filter/utils/__tests__/hydrateRecordFiltersFromFieldMetadata.test.tsnew file mode 100644index 00000000000..388b63789bf--- /dev/null+++ b/packages/twenty-front/src/modules/object-record/record-filter/utils/__tests__/hydrateRecordFiltersFromFieldMetadata.test.ts@@ -0,0 +1,53 @@+import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';+import { type RecordFilter } from '@/object-record/record-filter/types/RecordFilter';+import { hydrateRecordFiltersFromFieldMetadata } from '@/object-record/record-filter/utils/hydrateRecordFiltersFromFieldMetadata';+import { FieldMetadataType, ViewFilterOperand } from 'twenty-shared/types';++const ownerFieldMetadataItem = {+ id: 'owner-field-id',+ name: 'owner',+ label: 'Owner',+ type: FieldMetadataType.MORPH_RELATION,+} as FieldMetadataItem;++const buildRecordFilter = (overrides: Partial<RecordFilter>): RecordFilter => ({+ id: 'filter-id',+ fieldMetadataId: ownerFieldMetadataItem.id,+ value: '',+ displayValue: '',+ type: 'TEXT',+ operand: ViewFilterOperand.IS_EMPTY,+ label: '',+ ...overrides,+});++describe('hydrateRecordFiltersFromFieldMetadata', () => {+ it('should replace a persisted raw field type and label with the ones derived from field metadata', () => {+ expect(+ hydrateRecordFiltersFromFieldMetadata({+ recordFilters: [+ buildRecordFilter({+ type: FieldMetadataType.MORPH_RELATION as RecordFilter['type'],+ label: 'Stale label',+ }),+ ],+ fieldMetadataItems: [ownerFieldMetadataItem],+ }),+ ).toEqual([buildRecordFilter({ type: 'RELATION', label: 'Owner' })]);+ });++ it('should keep a filter unchanged when its field is unknown', () => {+ const recordFilter = buildRecordFilter({+ fieldMetadataId: 'deleted-field-id',+ type: 'NUMBER',+ label: 'Deleted field',+ });++ expect(+ hydrateRecordFiltersFromFieldMetadata({+ recordFilters: [recordFilter],+ fieldMetadataItems: [ownerFieldMetadataItem],+ }),+ ).toEqual([recordFilter]);+ });+});diff --git a/packages/twenty-front/src/modules/object-record/record-filter/utils/getRecordFilterTypeAndLabelFromFieldMetadata.ts b/packages/twenty-front/src/modules/object-record/record-filter/utils/getRecordFilterTypeAndLabelFromFieldMetadata.tsnew file mode 100644index 00000000000..ec4846909eb--- /dev/null+++ b/packages/twenty-front/src/modules/object-record/record-filter/utils/getRecordFilterTypeAndLabelFromFieldMetadata.ts@@ -0,0 +1,53 @@+import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';+import { type RecordFilter } from '@/object-record/record-filter/types/RecordFilter';+import { isSystemSearchVectorField } from '@/object-record/utils/isSystemSearchVectorField';+import { getFilterTypeFromFieldType, isDefined } from 'twenty-shared/utils';++export const getRecordFilterTypeAndLabelFromFieldMetadata = ({+ fieldMetadataId,+ relationTargetFieldMetadataId,+ fieldMetadataItems,+}: {+ fieldMetadataId: string;+ relationTargetFieldMetadataId?: string | null;+ fieldMetadataItems: FieldMetadataItem[];+}): Pick<RecordFilter, 'type' | 'label'> | undefined => {+ const sourceFieldMetadataItem = fieldMetadataItems.find(+ (fieldMetadataItem) => fieldMetadataItem.id === fieldMetadataId,+ );++ if (!isDefined(sourceFieldMetadataItem)) {+ return undefined;+ }++ const relationTargetFieldMetadataItem = isDefined(+ relationTargetFieldMetadataId,+ )+ ? fieldMetadataItems.find(+ (fieldMetadataItem) =>+ fieldMetadataItem.id === relationTargetFieldMetadataId,+ )+ : undefined;++ // A relation-traversal filter is meaningful only if both ends resolve,+ // otherwise its filterType and label would fall back to the relation+ // source while the dispatcher silently drops the GraphQL filter+ if (+ isDefined(relationTargetFieldMetadataId) &&+ !isDefined(relationTargetFieldMetadataItem)+ ) {+ return undefined;+ }++ const type = getFilterTypeFromFieldType(+ (relationTargetFieldMetadataItem ?? sourceFieldMetadataItem).type,+ );++ const label = isSystemSearchVectorField(sourceFieldMetadataItem.name)+ ? 'Search'+ : isDefined(relationTargetFieldMetadataItem)+ ? `${sourceFieldMetadataItem.label} → ${relationTargetFieldMetadataItem.label}`+ : sourceFieldMetadataItem.label;++ return { type, label };+};diff --git a/packages/twenty-front/src/modules/object-record/record-filter/utils/hydrateRecordFiltersFromFieldMetadata.ts b/packages/twenty-front/src/modules/object-record/record-filter/utils/hydrateRecordFiltersFromFieldMetadata.tsnew file mode 100644index 00000000000..38bdf8d7e0b--- /dev/null+++ b/packages/twenty-front/src/modules/object-record/record-filter/utils/hydrateRecordFiltersFromFieldMetadata.ts@@ -0,0 +1,22 @@+import { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';+import { type RecordFilter } from '@/object-record/record-filter/types/RecordFilter';+import { getRecordFilterTypeAndLabelFromFieldMetadata } from '@/object-record/record-filter/utils/getRecordFilterTypeAndLabelFromFieldMetadata';++// Persisted record filters carry a denormalized type and label that can be+// stale or wrong (e.g. a raw MORPH_RELATION written through the API), so+// derive them from field metadata like view filters are+export const hydrateRecordFiltersFromFieldMetadata = ({+ recordFilters,+ fieldMetadataItems,+}: {+ recordFilters: RecordFilter[];+ fieldMetadataItems: FieldMetadataItem[];+}): RecordFilter[] =>+ recordFilters.map((recordFilter) => ({+ ...recordFilter,+ ...getRecordFilterTypeAndLabelFromFieldMetadata({+ fieldMetadataId: recordFilter.fieldMetadataId,+ relationTargetFieldMetadataId: recordFilter.relationTargetFieldMetadataId,+ fieldMetadataItems,+ }),+ }));diff --git a/packages/twenty-front/src/modules/side-panel/pages/page-layout/components/ChartFiltersSettingsInitializeStateEffect.tsx b/packages/twenty-front/src/modules/side-panel/pages/page-layout/components/ChartFiltersSettingsInitializeStateEffect.tsxindex c92ed490d17..0d0be93069f 100644--- a/packages/twenty-front/src/modules/side-panel/pages/page-layout/components/ChartFiltersSettingsInitializeStateEffect.tsx+++ b/packages/twenty-front/src/modules/side-panel/pages/page-layout/components/ChartFiltersSettingsInitializeStateEffect.tsx@@ -1,9 +1,12 @@+import { flattenedFieldMetadataItemsSelector } from '@/object-metadata/states/flattenedFieldMetadataItemsSelector';import { useSetAdvancedFilterDropdownStates } from '@/object-record/advanced-filter/hooks/useSetAdvancedFilterDropdownAllRowsStates';import { currentRecordFilterGroupsComponentState } from '@/object-record/record-filter-group/states/currentRecordFilterGroupsComponentState';import { currentRecordFiltersComponentState } from '@/object-record/record-filter/states/currentRecordFiltersComponentState';+import { hydrateRecordFiltersFromFieldMetadata } from '@/object-record/record-filter/utils/hydrateRecordFiltersFromFieldMetadata';import { hasInitializedChartFiltersComponentState } from '@/side-panel/pages/page-layout/states/hasInitializedChartFiltersComponentState';import { type ChartFilters } from '@/side-panel/pages/page-layout/types/ChartFilters';import { useAtomComponentState } from '@/ui/utilities/state/jotai/hooks/useAtomComponentState';+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';import { useSetAtomComponentState } from '@/ui/utilities/state/jotai/hooks/useSetAtomComponentState';import { useEffect, useState } from 'react';import { isDefined } from 'twenty-shared/utils';@@ -26,6 +29,10 @@ export const ChartFiltersSettingsInitializeStateEffect = ({currentRecordFilterGroupsComponentState,);+ const flattenedFieldMetadataItems = useAtomStateValue(+ flattenedFieldMetadataItemsSelector,+ );+const { setAdvancedFilterDropdownStates } =useSetAdvancedFilterDropdownStates();@@ -36,7 +43,12 @@ export const ChartFiltersSettingsInitializeStateEffect = ({useEffect(() => {if (!hasInitializedChartFilters && isDefined(initialChartFilters)) {- setCurrentRecordFilters(initialChartFilters.recordFilters ?? []);+ setCurrentRecordFilters(+ hydrateRecordFiltersFromFieldMetadata({+ recordFilters: initialChartFilters.recordFilters ?? [],+ fieldMetadataItems: flattenedFieldMetadataItems,+ }),+ );setCurrentRecordFilterGroups(initialChartFilters.recordFilterGroups ?? [],);@@ -50,6 +62,7 @@ export const ChartFiltersSettingsInitializeStateEffect = ({setHasInitializedChartFilters,hasInitializedChartFilters,initialChartFilters,+ flattenedFieldMetadataItems,]);useEffect(() => {diff --git a/packages/twenty-front/src/modules/views/utils/mapViewFiltersToFilters.ts b/packages/twenty-front/src/modules/views/utils/mapViewFiltersToFilters.tsindex 23b79e6c661..eaf0cbd4ef8 100644--- a/packages/twenty-front/src/modules/views/utils/mapViewFiltersToFilters.ts+++ b/packages/twenty-front/src/modules/views/utils/mapViewFiltersToFilters.ts@@ -2,13 +2,9 @@ import { type RecordFilter } from '@/object-record/record-filter/types/RecordFilimport { type FieldMetadataItem } from '@/object-metadata/types/FieldMetadataItem';-import { isSystemSearchVectorField } from '@/object-record/utils/isSystemSearchVectorField';+import { getRecordFilterTypeAndLabelFromFieldMetadata } from '@/object-record/record-filter/utils/getRecordFilterTypeAndLabelFromFieldMetadata';import { type CompositeFieldSubFieldName } from '@/settings/data-model/types/CompositeFieldSubFieldName';-import {- convertViewFilterValueToString,- getFilterTypeFromFieldType,- isDefined,-} from 'twenty-shared/utils';+import { convertViewFilterValueToString, isDefined } from 'twenty-shared/utils';import { type ViewFilter as GqlViewFilter } from '~/generated-metadata/graphql';import { type ViewFilter } from '@/views/types/ViewFilter';@@ -18,47 +14,19 @@ export const mapViewFiltersToFilters = (): RecordFilter[] => {return viewFilters.map((viewFilter) => {- const sourceFieldMetadataItem = fieldMetadataItems.find(- (fieldMetadataItem) =>- fieldMetadataItem.id === viewFilter.fieldMetadataId,- );-- if (!isDefined(sourceFieldMetadataItem)) {+ const recordFilterTypeAndLabel =+ getRecordFilterTypeAndLabelFromFieldMetadata({+ fieldMetadataId: viewFilter.fieldMetadataId,+ relationTargetFieldMetadataId:+ viewFilter.relationTargetFieldMetadataId,+ fieldMetadataItems,+ });++ if (!isDefined(recordFilterTypeAndLabel)) {// Todo: we don't throw an error yet as we have race condition on view changereturn undefined;}- const relationTargetFieldMetadataItem = isDefined(- viewFilter.relationTargetFieldMetadataId,- )- ? fieldMetadataItems.find(- (fieldMetadataItem) =>- fieldMetadataItem.id === viewFilter.relationTargetFieldMetadataId,- )- : undefined;-- // A relation-traversal filter is meaningful only if both ends- // resolve — drop it otherwise (same race-condition handling as the- // source field above) instead of rendering a chip whose filterType- // and label fall back to the relation source, since the dispatcher- // would silently drop the GraphQL filter anyway.- if (- isDefined(viewFilter.relationTargetFieldMetadataId) &&- !isDefined(relationTargetFieldMetadataItem)- ) {- return undefined;- }-- const filterType = isDefined(relationTargetFieldMetadataItem)- ? getFilterTypeFromFieldType(relationTargetFieldMetadataItem.type)- : getFilterTypeFromFieldType(sourceFieldMetadataItem.type);-- const label = isSystemSearchVectorField(sourceFieldMetadataItem.name)- ? 'Search'- : isDefined(relationTargetFieldMetadataItem)- ? `${sourceFieldMetadataItem.label} → ${relationTargetFieldMetadataItem.label}`- : sourceFieldMetadataItem.label;-const operand = viewFilter.operand;const stringValue = convertViewFilterValueToString(viewFilter.value);@@ -74,8 +42,8 @@ export const mapViewFiltersToFilters = (operand,recordFilterGroupId: viewFilter.viewFilterGroupId ?? undefined,positionInRecordFilterGroup: viewFilter.positionInViewFilterGroup,- label,- type: filterType,+ label: recordFilterTypeAndLabel.label,+ type: recordFilterTypeAndLabel.type,subFieldName: viewFilter.subFieldName as CompositeFieldSubFieldName,relationTargetFieldMetadataId:viewFilter.relationTargetFieldMetadataId ?? null,diff --git a/packages/twenty-front/src/modules/workflow/workflow-steps/workflow-actions/find-records-action/components/WorkflowFindRecordsFiltersEffect.tsx b/packages/twenty-front/src/modules/workflow/workflow-steps/workflow-actions/find-records-action/components/WorkflowFindRecordsFiltersEffect.tsxindex 1284b1a029e..e8b41e6e4e9 100644--- a/packages/twenty-front/src/modules/workflow/workflow-steps/workflow-actions/find-records-action/components/WorkflowFindRecordsFiltersEffect.tsx+++ b/packages/twenty-front/src/modules/workflow/workflow-steps/workflow-actions/find-records-action/components/WorkflowFindRecordsFiltersEffect.tsx@@ -1,7 +1,10 @@+import { flattenedFieldMetadataItemsSelector } from '@/object-metadata/states/flattenedFieldMetadataItemsSelector';import { useSetAdvancedFilterDropdownStates } from '@/object-record/advanced-filter/hooks/useSetAdvancedFilterDropdownAllRowsStates';import { currentRecordFilterGroupsComponentState } from '@/object-record/record-filter-group/states/currentRecordFilterGroupsComponentState';import { currentRecordFiltersComponentState } from '@/object-record/record-filter/states/currentRecordFiltersComponentState';+import { hydrateRecordFiltersFromFieldMetadata } from '@/object-record/record-filter/utils/hydrateRecordFiltersFromFieldMetadata';import { useAtomComponentFamilyState } from '@/ui/utilities/state/jotai/hooks/useAtomComponentFamilyState';+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';import { useSetAtomComponentState } from '@/ui/utilities/state/jotai/hooks/useSetAtomComponentState';import { hasInitializedCurrentRecordFilterGroupsComponentFamilyState } from '@/views/states/hasInitializedCurrentRecordFilterGroupsComponentFamilyState';import { hasInitializedCurrentRecordFiltersComponentFamilyState } from '@/views/states/hasInitializedCurrentRecordFiltersComponentFamilyState';@@ -38,6 +41,10 @@ export const WorkflowFindRecordsFiltersEffect = ({currentRecordFilterGroupsComponentState,);+ const flattenedFieldMetadataItems = useAtomStateValue(+ flattenedFieldMetadataItemsSelector,+ );+const { setAdvancedFilterDropdownStates } =useSetAdvancedFilterDropdownStates();@@ -51,7 +58,12 @@ export const WorkflowFindRecordsFiltersEffect = ({!hasInitializedCurrentRecordFilters &&isDefined(defaultValue?.recordFilters)) {- setCurrentRecordFilters(defaultValue.recordFilters ?? []);+ setCurrentRecordFilters(+ hydrateRecordFiltersFromFieldMetadata({+ recordFilters: defaultValue.recordFilters,+ fieldMetadataItems: flattenedFieldMetadataItems,+ }),+ );setShouldSetAdvancedFilterDropdownStates(true);setHasInitializedCurrentRecordFilters(true);}@@ -60,6 +72,7 @@ export const WorkflowFindRecordsFiltersEffect = ({hasInitializedCurrentRecordFilters,setHasInitializedCurrentRecordFilters,defaultValue?.recordFilters,+ flattenedFieldMetadataItems,]);useEffect(() => {diff --git a/packages/twenty-server/src/modules/dashboard/tools/utils/__tests__/resolve-widget-field-names-to-metadata-ids.util.spec.ts b/packages/twenty-server/src/modules/dashboard/tools/utils/__tests__/resolve-widget-field-names-to-metadata-ids.util.spec.tsindex 8e5682156ef..aa7477695ca 100644--- a/packages/twenty-server/src/modules/dashboard/tools/utils/__tests__/resolve-widget-field-names-to-metadata-ids.util.spec.ts+++ b/packages/twenty-server/src/modules/dashboard/tools/utils/__tests__/resolve-widget-field-names-to-metadata-ids.util.spec.ts@@ -16,6 +16,7 @@ const OBJECT_ID = '11111111-1111-4111-8111-111111111111';const AMOUNT_FIELD_ID = '22222222-2222-4222-8222-222222222222';const STAGE_FIELD_ID = '33333333-3333-4333-8333-333333333333';const CREATED_AT_FIELD_ID = '44444444-4444-4444-8444-444444444444';+const OWNER_FIELD_ID = '55555555-5555-4555-8555-555555555555';const buildMaps = (): DashboardIdentifierMaps => ({objectIdByName: { opportunity: OBJECT_ID, opportunities: OBJECT_ID },@@ -26,11 +27,13 @@ const buildMaps = (): DashboardIdentifierMaps => ({buildFieldByObjectIdAndNameKey(OBJECT_ID, 'createdAt'),CREATED_AT_FIELD_ID,],+ [buildFieldByObjectIdAndNameKey(OBJECT_ID, 'owner'), OWNER_FIELD_ID],]),fieldById: new Map([[AMOUNT_FIELD_ID, { type: FieldMetadataType.CURRENCY }],[STAGE_FIELD_ID, { type: FieldMetadataType.SELECT }],[CREATED_AT_FIELD_ID, { type: FieldMetadataType.DATE_TIME }],+ [OWNER_FIELD_ID, { type: FieldMetadataType.MORPH_RELATION }],]),});@@ -136,6 +139,25 @@ describe('resolveWidgetFieldNamesToIds - chart filters', () => {expect(filter.recordFilters[0].id).toEqual(expect.any(String));});+ it('stores the filter type rather than the raw field type', () => {+ const widget = buildAggregateWidget({+ recordFilters: [+ {+ fieldName: 'owner',+ operand: ViewFilterOperand.IS_EMPTY,+ },+ ],+ });++ const result = resolveWidgetFieldNamesToIds(widget, buildMaps());+ const filter = getResolvedFilter(result.configuration);++ expect(filter.recordFilters[0]).toMatchObject({+ fieldMetadataId: OWNER_FIELD_ID,+ type: 'RELATION',+ });+ });+it('preserves an explicit filter fieldMetadataId', () => {const widget = buildAggregateWidget({recordFilters: [diff --git a/packages/twenty-server/src/modules/dashboard/tools/utils/resolve-widget-field-names-to-metadata-ids.util.ts b/packages/twenty-server/src/modules/dashboard/tools/utils/resolve-widget-field-names-to-metadata-ids.util.tsindex 24746045f2d..38c74b5d7e9 100644--- a/packages/twenty-server/src/modules/dashboard/tools/utils/resolve-widget-field-names-to-metadata-ids.util.ts+++ b/packages/twenty-server/src/modules/dashboard/tools/utils/resolve-widget-field-names-to-metadata-ids.util.ts@@ -4,7 +4,7 @@ import {type ChartRecordFilter,type ChartRecordFilterGroup,} from 'twenty-shared/types';-import { isDefined } from 'twenty-shared/utils';+import { getFilterTypeFromFieldType, isDefined } from 'twenty-shared/utils';import { v4 as uuidv4 } from 'uuid';import { buildFieldByObjectIdAndNameKey } from 'src/engine/metadata-modules/flat-field-metadata/utils/build-field-by-object-id-and-name-key.util';@@ -168,7 +168,7 @@ const resolveChartFilterFieldNamesToIds = (operand: rest.operand,value,displayValue: value,- type: field?.type ?? '',+ type: isDefined(field) ? getFilterTypeFromFieldType(field.type) : '',recordFilterGroupId,positionInRecordFilterGroup,...(isDefined(rest.subFieldName)