The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Make filter validation errors actionable for AI agents (#27963)
BOHEUS5d39928bbfdc
diff --git a/packages/twenty-server/src/engine/api/common/common-args-processors/filter-arg-processor/filter-arg-processor.service.ts b/packages/twenty-server/src/engine/api/common/common-args-processors/filter-arg-processor/filter-arg-processor.service.tsindex 6678e4211ea..9cba02f7027 100644--- a/packages/twenty-server/src/engine/api/common/common-args-processors/filter-arg-processor/filter-arg-processor.service.ts+++ b/packages/twenty-server/src/engine/api/common/common-args-processors/filter-arg-processor/filter-arg-processor.service.ts@@ -42,6 +42,36 @@ function throwUseJoinColumnInstead(key: string): never {);}+const computeParentRelationHints = ({+ parentRelationFieldMetadata,+}: {+ parentRelationFieldMetadata?: FlatFieldMetadata<+ FieldMetadataType.RELATION | FieldMetadataType.MORPH_RELATION+ >;+}): { relationContext: string; joinColumnHint: string } => {+ if (!isDefined(parentRelationFieldMetadata)) {+ return { relationContext: '', joinColumnHint: '' };+ }++ const relationContext = ` (filtering through relation "${parentRelationFieldMetadata.name}")`;++ if (+ parentRelationFieldMetadata.settings?.relationType !==+ RelationType.MANY_TO_ONE+ ) {+ return { relationContext, joinColumnHint: '' };+ }++ const joinColumnName = computeMorphOrRelationFieldJoinColumnName({+ name: parentRelationFieldMetadata.name,+ });++ return {+ relationContext,+ joinColumnHint: ` To filter by the related record id instead, use "${joinColumnName}".`,+ };+};+@Injectable()export class FilterArgProcessorService {process<T extends ObjectRecordFilter | undefined>({@@ -65,55 +95,69 @@ export class FilterArgProcessorService {flatObjectMetadata,);- return this.validateAndTransformFilter(- filter,+ return this.validateAndTransformFilter({+ filterObject: filter,flatObjectMetadata,flatObjectMetadataMaps,flatFieldMetadataMaps,fieldIdByName,fieldIdByJoinColumnName,- 0,- ) as T;+ depth: 0,+ }) as T;}- private validateAndTransformFilter(- filterObject: ObjectRecordFilter,- flatObjectMetadata: FlatObjectMetadata,- flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata> | undefined,- flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>,- fieldIdByName: Record<string, string>,- fieldIdByJoinColumnName: Record<string, string>,- depth: number,- ): ObjectRecordFilter {+ private validateAndTransformFilter({+ filterObject,+ flatObjectMetadata,+ flatObjectMetadataMaps,+ flatFieldMetadataMaps,+ fieldIdByName,+ fieldIdByJoinColumnName,+ depth,+ parentRelationFieldMetadata,+ }: {+ filterObject: ObjectRecordFilter;+ flatObjectMetadata: FlatObjectMetadata;+ flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata> | undefined;+ flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>;+ fieldIdByName: Record<string, string>;+ fieldIdByJoinColumnName: Record<string, string>;+ depth: number;+ parentRelationFieldMetadata?: FlatFieldMetadata<+ FieldMetadataType.RELATION | FieldMetadataType.MORPH_RELATION+ >;+ }): ObjectRecordFilter {const transformedFilter: ObjectRecordFilter = {};for (const [key, value] of Object.entries(filterObject)) {if (key === 'and' || key === 'or') {transformedFilter[key] = (value as ObjectRecordFilter[]).map((nestedFilter) =>- this.validateAndTransformFilter(- nestedFilter,+ this.validateAndTransformFilter({+ filterObject: nestedFilter,flatObjectMetadata,flatObjectMetadataMaps,flatFieldMetadataMaps,fieldIdByName,fieldIdByJoinColumnName,depth,- ),+ parentRelationFieldMetadata,+ }),);continue;}if (key === 'not') {- transformedFilter[key] = this.validateAndTransformFilter(- value as ObjectRecordFilter,+ transformedFilter[key] = this.validateAndTransformFilter({+ filterObject: value as ObjectRecordFilter,flatObjectMetadata,flatObjectMetadataMaps,flatFieldMetadataMaps,fieldIdByName,fieldIdByJoinColumnName,depth,- );+ parentRelationFieldMetadata,+ });continue;}@@ -136,14 +180,15 @@ export class FilterArgProcessorService {continue;}- transformedFilter[key] = this.validateAndTransformFieldFilter(+ transformedFilter[key] = this.validateAndTransformFieldFilter({key,- value,+ filterValue: value,flatObjectMetadata,flatFieldMetadataMaps,fieldIdByName,fieldIdByJoinColumnName,- );+ parentRelationFieldMetadata,+ });}return transformedFilter;@@ -256,32 +301,47 @@ export class FilterArgProcessorService {targetObjectMetadata,);- return this.validateAndTransformFilter(- filterValue,- targetObjectMetadata,+ return this.validateAndTransformFilter({+ filterObject: filterValue,+ flatObjectMetadata: targetObjectMetadata,flatObjectMetadataMaps,flatFieldMetadataMaps,- targetFieldIdByName,- targetFieldIdByJoinColumnName,- depth + 1,- );+ fieldIdByName: targetFieldIdByName,+ fieldIdByJoinColumnName: targetFieldIdByJoinColumnName,+ depth: depth + 1,+ parentRelationFieldMetadata: fieldMetadata,+ });}- private validateAndTransformFieldFilter(- key: string,- filterValue: Record<string, unknown>,- flatObjectMetadata: FlatObjectMetadata,- flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>,- fieldIdByName: Record<string, string>,- fieldIdByJoinColumnName: Record<string, string>,- ): Record<string, unknown> {+ private validateAndTransformFieldFilter({+ key,+ filterValue,+ flatObjectMetadata,+ flatFieldMetadataMaps,+ fieldIdByName,+ fieldIdByJoinColumnName,+ parentRelationFieldMetadata,+ }: {+ key: string;+ filterValue: Record<string, unknown>;+ flatObjectMetadata: FlatObjectMetadata;+ flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>;+ fieldIdByName: Record<string, string>;+ fieldIdByJoinColumnName: Record<string, string>;+ parentRelationFieldMetadata?: FlatFieldMetadata<+ FieldMetadataType.RELATION | FieldMetadataType.MORPH_RELATION+ >;+ }): Record<string, unknown> {const fieldMetadataId = fieldIdByName[key] ?? fieldIdByJoinColumnName[key];if (!isDefined(fieldMetadataId)) {const nameSingular = flatObjectMetadata.nameSingular;+ const { relationContext, joinColumnHint } = computeParentRelationHints({+ parentRelationFieldMetadata,+ });throw new CommonQueryRunnerException(- `Object ${flatObjectMetadata.nameSingular} doesn't have any "${key}" field.`,+ `Object ${nameSingular} doesn't have any "${key}" field${relationContext}. Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }.${joinColumnHint}`,CommonQueryRunnerExceptionCode.INVALID_ARGS_FILTER,{userFriendlyMessage: msg`Invalid filter : ${nameSingular} object doesn't have any "${key}" field.`,@@ -341,8 +401,12 @@ export class FilterArgProcessorService {);if (!subFieldMetadata) {+ const subFieldNames = compositeType.properties.map(+ (property) => property.name,+ );+throw new CommonQueryRunnerException(- `Sub field "${subFieldKey}" not found for composite type: ${fieldMetadata.type}`,+ `Sub field "${subFieldKey}" not found for composite type: ${fieldMetadata.type}. Available sub fields: ${subFieldNames.join(', ')}.`,CommonQueryRunnerExceptionCode.INVALID_ARGS_FILTER,{ userFriendlyMessage: STANDARD_ERROR_MESSAGE },);diff --git a/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/morph-relation-field-filter-input-validation.integration-spec.ts.snap b/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/morph-relation-field-filter-input-validation.integration-spec.ts.snapindex 3f71a678df1..78042469ba7 100644--- a/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/morph-relation-field-filter-input-validation.integration-spec.ts.snap+++ b/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/morph-relation-field-filter-input-validation.integration-spec.ts.snap@@ -1,12 +1,12 @@// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing-exports[`Filter input validation - MORPH_RELATION Gql filter input - failure MORPH_RELATION field type - should fail with filter : {"manyToOneMorphRelationFieldApiInputValidationTargetTestObject1":{"eq":"6dd71a46-68fe-4420-82b3-0d5b00ad2642"}} 1`] = `"Object apiInputValidationTargetTestObject1 doesn't have any "eq" field."`;+exports[`Filter input validation - MORPH_RELATION Gql filter input - failure MORPH_RELATION field type - should fail with filter : {"manyToOneMorphRelationFieldApiInputValidationTargetTestObject1":{"eq":"6dd71a46-68fe-4420-82b3-0d5b00ad2642"}} 1`] = `"Object apiInputValidationTargetTestObject1 doesn't have any "eq" field (filtering through relation "manyToOneMorphRelationFieldApiInputValidationTargetTestObject1"). Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }. To filter by the related record id instead, use "manyToOneMorphRelationFieldApiInputValidationTargetTestObject1Id"."`;exports[`Filter input validation - MORPH_RELATION Gql filter input - failure MORPH_RELATION field type - should fail with filter : {"manyToOneMorphRelationFieldApiInputValidationTargetTestObject1Id":{"eq":"invalid-uuid"}} 1`] = `"Invalid UUID value 'invalid-uuid' for field "manyToOneMorphRelationFieldApiInputValidationTargetTestObject1Id""`;exports[`Filter input validation - MORPH_RELATION Rest filter input - failure MORPH_RELATION field type - should fail with filter : "manyToOneMorphRelationFieldApiInputValidationTargetTestObject1[eq]:\\"6dd71a46-68fe-4420-82b3-0d5b00ad2642\\"" 1`] = `[- "Object apiInputValidationTargetTestObject1 doesn't have any "eq" field.",+ "Object apiInputValidationTargetTestObject1 doesn't have any "eq" field (filtering through relation "manyToOneMorphRelationFieldApiInputValidationTargetTestObject1"). Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }. To filter by the related record id instead, use "manyToOneMorphRelationFieldApiInputValidationTargetTestObject1Id".",]`;diff --git a/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/relation-field-filter-input-validation.integration-spec.ts.snap b/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/relation-field-filter-input-validation.integration-spec.ts.snapindex 45e9266b371..4fc35e6fa6d 100644--- a/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/relation-field-filter-input-validation.integration-spec.ts.snap+++ b/packages/twenty-server/test/integration/graphql/suites/inputs-validation/filter-validation/__snapshots__/relation-field-filter-input-validation.integration-spec.ts.snap@@ -1,16 +1,16 @@// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing-exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"manyToOneRelationField":{"eq":"6dd71a46-68fe-4420-82b3-0d5b00ad2642"}} 1`] = `"Object apiInputValidationTargetTestObject1 doesn't have any "eq" field."`;+exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"manyToOneRelationField":{"eq":"6dd71a46-68fe-4420-82b3-0d5b00ad2642"}} 1`] = `"Object apiInputValidationTargetTestObject1 doesn't have any "eq" field (filtering through relation "manyToOneRelationField"). Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }. To filter by the related record id instead, use "manyToOneRelationFieldId"."`;exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"manyToOneRelationFieldId":{"eq":"invalid-uuid"}} 1`] = `"Invalid UUID value 'invalid-uuid' for field "manyToOneRelationFieldId""`;-exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"oneToManyRelationField":{"eq":"6dd71a46-68fe-4420-82b3-0d5b00ad2642"}} 1`] = `"Object apiInputValidationTargetTestObject1 doesn't have any "eq" field."`;+exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"oneToManyRelationField":{"eq":"6dd71a46-68fe-4420-82b3-0d5b00ad2642"}} 1`] = `"Object apiInputValidationTargetTestObject1 doesn't have any "eq" field (filtering through relation "oneToManyRelationField"). Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }."`;-exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"oneToManyRelationFieldId":{"eq":"invalid-uuid"}} 1`] = `"Object apiInputValidationTestObject doesn't have any "oneToManyRelationFieldId" field."`;+exports[`Filter input validation - RELATION Gql filter input - failure RELATION field type - should fail with filter : {"oneToManyRelationFieldId":{"eq":"invalid-uuid"}} 1`] = `"Object apiInputValidationTestObject doesn't have any "oneToManyRelationFieldId" field. Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }."`;exports[`Filter input validation - RELATION Rest filter input - failure RELATION field type - should fail with filter : "manyToOneRelationField[eq]:\\"6dd71a46-68fe-4420-82b3-0d5b00ad2642\\"" 1`] = `[- "Object apiInputValidationTargetTestObject1 doesn't have any "eq" field.",+ "Object apiInputValidationTargetTestObject1 doesn't have any "eq" field (filtering through relation "manyToOneRelationField"). Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }. To filter by the related record id instead, use "manyToOneRelationFieldId".",]`;@@ -22,12 +22,12 @@ exports[`Filter input validation - RELATION Rest filter input - failure RELATIONexports[`Filter input validation - RELATION Rest filter input - failure RELATION field type - should fail with filter : "oneToManyRelationFieldId[eq]:\\"6dd71a46-68fe-4420-82b3-0d5b00ad2642\\"" 1`] = `[- "Object apiInputValidationTestObject doesn't have any "oneToManyRelationFieldId" field.",+ "Object apiInputValidationTestObject doesn't have any "oneToManyRelationFieldId" field. Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }.",]`;exports[`Filter input validation - RELATION Rest filter input - failure RELATION field type - should fail with filter : "oneToManyRelationFieldId[eq]:\\"invalid-uuid\\"" 1`] = `[- "Object apiInputValidationTestObject doesn't have any "oneToManyRelationFieldId" field.",+ "Object apiInputValidationTestObject doesn't have any "oneToManyRelationFieldId" field. Filter keys must be field names or and/or/not, with operators nested under a field: { <fieldName>: { <operator>: <value> } }.",]`;