Skip to content

The open alternative to Salesforce, designed for AI.

fix(filter): enforce conjunctive multi-token matching for composite name filters (#24260) (#24380)

jihadMo17b690940053
diff --git a/packages/twenty-server/test/integration/graphql/suites/filter-by-composite-name-field.integration-spec.ts b/packages/twenty-server/test/integration/graphql/suites/filter-by-composite-name-field.integration-spec.ts
new file mode 100644
index 00000000000..6aaf6939e15
--- /dev/null
+++ b/packages/twenty-server/test/integration/graphql/suites/filter-by-composite-name-field.integration-spec.ts
@@ -0,0 +1,71 @@
+import { generateILikeFiltersForCompositeFields } from 'twenty-shared/utils';
+
+import { createManyOperationFactory } from 'test/integration/graphql/utils/create-many-operation-factory.util';
+import { makeGraphqlAPIRequest } from 'test/integration/graphql/utils/make-graphql-api-request.util';
+import { deleteAllRecords } from 'test/integration/utils/delete-all-records';
+import { findRecordNodesByFilter } from 'test/integration/utils/find-records-by-filter.util';
+
+type PersonNode = {
+ name: { firstName: string; lastName: string };
+};
+
+const PERSON_GQL_FIELDS = `
+ id
+ name {
+ firstName
+ lastName
+ }
+`;
+
+const JOHN_DOE_ID = '20202020-8f4a-4a3f-9c1b-000000000001';
+const JANE_SMITH_ID = '20202020-8f4a-4a3f-9c1b-000000000002';
+const JOHN_SMITH_ID = '20202020-8f4a-4a3f-9c1b-000000000003';
+
+const findPeopleMatching = async (filterString: string) => {
+ const nodes = await findRecordNodesByFilter<PersonNode>(
+ 'person',
+ 'people',
+ PERSON_GQL_FIELDS,
+ {
+ or: generateILikeFiltersForCompositeFields(filterString, 'name', [
+ 'firstName',
+ 'lastName',
+ ]),
+ },
+ );
+
+ return nodes.map((node) => `${node.name.firstName} ${node.name.lastName}`);
+};
+
+describe('filter by composite name field (integration)', () => {
+ beforeAll(async () => {
+ await deleteAllRecords('person');
+
+ const graphqlOperation = createManyOperationFactory({
+ objectMetadataSingularName: 'person',
+ objectMetadataPluralName: 'people',
+ gqlFields: PERSON_GQL_FIELDS,
+ data: [
+ { id: JOHN_DOE_ID, name: { firstName: 'John', lastName: 'Doe' } },
+ { id: JANE_SMITH_ID, name: { firstName: 'Jane', lastName: 'Smith' } },
+ { id: JOHN_SMITH_ID, name: { firstName: 'John', lastName: 'Smith' } },
+ ],
+ });
+
+ const response = await makeGraphqlAPIRequest(graphqlOperation);
+
+ expect(response.body.data.createPeople).toHaveLength(3);
+ });
+
+ afterAll(async () => {
+ await deleteAllRecords('person');
+ });
+
+ it('should only return people matching every token when filtering on last and first name', async () => {
+ expect(await findPeopleMatching('Doe John')).toEqual(['John Doe']);
+ });
+
+ it('should return people matching a single token when filtering on last name only', async () => {
+ expect(await findPeopleMatching('Doe')).toEqual(['John Doe']);
+ });
+});
diff --git a/packages/twenty-shared/src/utils/filter/utils/__tests__/generateILikeFiltersForCompositeFields.test.ts b/packages/twenty-shared/src/utils/filter/utils/__tests__/generateILikeFiltersForCompositeFields.test.ts
index bc5ae9c2c5a..7a26c0f08e4 100644
--- a/packages/twenty-shared/src/utils/filter/utils/__tests__/generateILikeFiltersForCompositeFields.test.ts
+++ b/packages/twenty-shared/src/utils/filter/utils/__tests__/generateILikeFiltersForCompositeFields.test.ts
@@ -24,7 +24,7 @@ describe('generateILikeFiltersForCompositeFields', () => {
},
]);
});
- it('should format composite filters for complex filter string', () => {
+ it('should require every token to match a subfield for complex filter string', () => {
expect(
generateILikeFiltersForCompositeFields('john doe', 'name', [
'firstName',
@@ -32,32 +32,90 @@ describe('generateILikeFiltersForCompositeFields', () => {
]),
).toEqual([
{
- name: {
- firstName: {
- ilike: '%john%',
+ and: [
+ {
+ or: [
+ { name: { firstName: { ilike: '%john%' } } },
+ { name: { lastName: { ilike: '%john%' } } },
+ ],
},
- },
- },
- {
- name: {
- lastName: {
- ilike: '%john%',
+ {
+ or: [
+ { name: { firstName: { ilike: '%doe%' } } },
+ { name: { lastName: { ilike: '%doe%' } } },
+ ],
},
- },
+ ],
},
+ ]);
+ });
+
+ it('should be insensitive to token order', () => {
+ expect(
+ generateILikeFiltersForCompositeFields('doe john', 'name', [
+ 'firstName',
+ 'lastName',
+ ]),
+ ).toEqual([
{
- name: {
- firstName: {
- ilike: '%doe%',
+ and: [
+ {
+ or: [
+ { name: { firstName: { ilike: '%doe%' } } },
+ { name: { lastName: { ilike: '%doe%' } } },
+ ],
},
- },
+ {
+ or: [
+ { name: { firstName: { ilike: '%john%' } } },
+ { name: { lastName: { ilike: '%john%' } } },
+ ],
+ },
+ ],
},
+ ]);
+ });
+
+ it('should normalize surrounding and repeated whitespace', () => {
+ expect(
+ generateILikeFiltersForCompositeFields(' john doe ', 'name', [
+ 'firstName',
+ 'lastName',
+ ]),
+ ).toEqual(
+ generateILikeFiltersForCompositeFields('john doe', 'name', [
+ 'firstName',
+ 'lastName',
+ ]),
+ );
+ });
+
+ it('should not tokenize a single token padded with whitespace', () => {
+ expect(
+ generateILikeFiltersForCompositeFields(' john ', 'name', [
+ 'firstName',
+ 'lastName',
+ ]),
+ ).toEqual([
+ { name: { firstName: { ilike: '%john%' } } },
+ { name: { lastName: { ilike: '%john%' } } },
+ ]);
+ });
+
+ it('should keep returning per-subfield emptiness checks when emptyCheck is set', () => {
+ expect(
+ generateILikeFiltersForCompositeFields(
+ 'john doe',
+ 'name',
+ ['firstName'],
+ true,
+ ),
+ ).toEqual([
{
- name: {
- lastName: {
- ilike: '%doe%',
- },
- },
+ or: [
+ { name: { firstName: { is: 'NULL' } } },
+ { name: { firstName: { ilike: '' } } },
+ ],
},
]);
});
diff --git a/packages/twenty-shared/src/utils/filter/utils/generateILikeFiltersForCompositeFields.ts b/packages/twenty-shared/src/utils/filter/utils/generateILikeFiltersForCompositeFields.ts
index b11e4b806ba..4e6fb2c96e2 100644
--- a/packages/twenty-shared/src/utils/filter/utils/generateILikeFiltersForCompositeFields.ts
+++ b/packages/twenty-shared/src/utils/filter/utils/generateILikeFiltersForCompositeFields.ts
@@ -5,7 +5,7 @@ export const generateILikeFiltersForCompositeFields = (
baseFieldName: string,
subFields: string[],
emptyCheck = false,
-) => {
+): RecordGqlOperationFilter[] => {
if (emptyCheck) {
return subFields.map((subField) => {
return {
@@ -29,20 +29,35 @@ export const generateILikeFiltersForCompositeFields = (
});
}
- return filterString
- .split(' ')
- .reduce((previousValue: RecordGqlOperationFilter[], currentValue) => {
- return [
- ...previousValue,
- ...subFields.map((subField) => {
- return {
- [baseFieldName]: {
- [subField]: {
- ilike: `%${currentValue}%`,
+ const tokens = filterString.trim().split(/\s+/).filter(Boolean);
+
+ if (tokens.length <= 1) {
+ return subFields.map((subField) => {
+ return {
+ [baseFieldName]: {
+ [subField]: {
+ ilike: `%${tokens[0] ?? ''}%`,
+ },
+ },
+ };
+ });
+ }
+
+ return [
+ {
+ and: tokens.map((token) => {
+ return {
+ or: subFields.map((subField) => {
+ return {
+ [baseFieldName]: {
+ [subField]: {
+ ilike: `%${token}%`,
+ },
},
- },
- };
- }),
- ];
- }, []);
+ };
+ }),
+ };
+ }),
+ },
+ ];
};