vynte-infra/twenty
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Limit rest api relations depth to 1 (#14453)

Browse Source 
Until we tackle [Implement relations depth 2 for rest
api](https://github.com/twentyhq/twenty/issues/14452), let's remove the
depth 2 query parameter which is not working (times out all the time).
This commit is contained in:
Marie
2025-09-12 15:57:16 +00:00
committed by GitHub
parent 12a5ee6bc4
commit 89254ea9e9
11 changed files with 18 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-server/src/engine/api/rest/core/query-builder/utils/__tests__/compute-depth.utils.spec.ts
+1 -1
View File
@@ -1,7 +1,7 @@
import { computeDepth } from 'src/engine/api/rest/core/query-builder/utils/compute-depth.utils';
describe('computeDepth', () => {
[0, 1, 2].forEach((depth) => {
[0, 1].forEach((depth) => {
it('should compute depth from query', () => {
const request: any = {
query: { depth: `${depth}` },
packages/twenty-server/src/engine/api/rest/core/query-builder/utils/compute-depth.utils.ts
+1 -1
View File
@@ -2,7 +2,7 @@ import { BadRequestException } from '@nestjs/common';
import { type Request } from 'express';
const ALLOWED_DEPTH_VALUES = [0, 1, 2];
const ALLOWED_DEPTH_VALUES = [0, 1];
export const computeDepth = (request: Request): number | undefined => {
if (!request.query.depth) {
packages/twenty-server/src/engine/api/rest/input-factories/depth-input.factory.ts
+1 -1
View File
@@ -6,7 +6,7 @@ export const MAX_DEPTH = 2;
export type Depth = 0 | 1 | 2;
const ALLOWED_DEPTH_VALUES: Depth[] = [0, 1, MAX_DEPTH];
const ALLOWED_DEPTH_VALUES: Depth[] = [0, 1];
@Injectable()
export class DepthInputFactory {
packages/twenty-server/src/engine/core-modules/open-api/utils/__tests__/parameters.utils.spec.ts
+1 -1
View File
@@ -63,7 +63,7 @@ describe('computeParameters', () => {
required: false,
schema: {
type: 'integer',
enum: [0, 1, 2],
enum: [0, 1],
default: 1,
},
});
packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts
+1 -1
View File
@@ -53,7 +53,7 @@ export const computeDepthParameters = (): OpenAPIV3_1.ParameterObject => {
required: false,
schema: {
type: 'integer',
enum: [0, 1, 2],
enum: [0, 1],
default: 1,
},
};
packages/twenty-server/test/integration/rest/suites/rest-api-core-create-many.integration-spec.ts
+2 -21
View File
@@ -178,7 +178,7 @@ describe('Core REST API Create Many endpoint', () => {
});
});
it('should support depth 2 parameter', async () => {
it('should not support depth 2 parameter', async () => {
const requestBody = [
{
id: TEST_PERSON_1_ID,
@@ -194,26 +194,7 @@ describe('Core REST API Create Many endpoint', () => {
method: 'post',
path: `/batch/people?depth=2`,
body: requestBody,
})
.expect(201)
.expect((res) => {
const [createdPerson1, createdPerson2] = res.body.data.createPeople;
expect(createdPerson1.company.people).toBeDefined();
expect(createdPerson2.company.people).toBeDefined();
const depth2Person1 = createdPerson1.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === createdPerson1.id,
);
const depth2Person2 = createdPerson2.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === createdPerson2.id,
);
expect(depth2Person1).toBeDefined();
expect(depth2Person2).toBeDefined();
});
}).expect(400);
});
it('should return a BadRequestException when trying to create a person with an existing ID', async () => {
packages/twenty-server/test/integration/rest/suites/rest-api-core-create-one.integration-spec.ts
+2 -14
View File
@@ -147,7 +147,7 @@ describe('Core REST API Create One endpoint', () => {
});
});
it('should support depth 2 parameter', async () => {
it('should not support depth 2 parameter', async () => {
const personCity = generateRecordName(TEST_PERSON_1_ID);
const requestBody = {
id: TEST_PERSON_1_ID,
@@ -159,19 +159,7 @@ describe('Core REST API Create One endpoint', () => {
method: 'post',
path: `/people?depth=2`,
body: requestBody,
})
.expect(201)
.expect((res) => {
const createdPerson = res.body.data.createPerson;
expect(createdPerson.company.people).toBeDefined();
const depth2Person = createdPerson.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === createdPerson.id,
);
expect(depth2Person).toBeDefined();
});
}).expect(400);
});
it('should return a BadRequestException when trying to create a person with an existing ID', async () => {
packages/twenty-server/test/integration/rest/suites/rest-api-core-find-duplicates.integration-spec.ts
+3 -26
View File
@@ -240,8 +240,8 @@ describe('Core REST API Find Duplicates endpoint', () => {
expect(personDuplicated2.company.people).not.toBeDefined();
});
it('should support depth 2 parameter', async () => {
const response = await makeRestAPIRequest({
it('should not support depth 2 parameter', async () => {
await makeRestAPIRequest({
method: 'post',
path: `/people/duplicates?depth=2`,
body: {
@@ -254,29 +254,6 @@ describe('Core REST API Find Duplicates endpoint', () => {
},
],
},
}).expect(200);
const data = response.body.data;
expect(data.length).toBe(1);
const duplicatesInfo = data[0];
const [personDuplicated1, personDuplicated2] =
duplicatesInfo.personDuplicates;
expect(personDuplicated1.company.people).toBeDefined();
expect(personDuplicated2.company.people).toBeDefined();
const depth2Person1 = personDuplicated1.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === personDuplicated1.id,
);
const depth2Person2 = personDuplicated2.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === personDuplicated2.id,
);
expect(depth2Person1).toBeDefined();
expect(depth2Person2).toBeDefined();
}).expect(400);
});
});
packages/twenty-server/test/integration/rest/suites/rest-api-core-find-many.integration-spec.ts
+3 -14
View File
@@ -490,21 +490,10 @@ describe('Core REST API Find Many endpoint', () => {
expect(person.company.people).not.toBeDefined();
});
it('should support depth 2 parameter', async () => {
const response = await makeRestAPIRequest({
it('should not support depth 2 parameter', async () => {
await makeRestAPIRequest({
method: 'get',
path: '/people?depth=2',
}).expect(200);
const people = response.body.data.people;
const person = people[0];
expect(person.company.people).toBeDefined();
// @ts-expect-error legacy noImplicitAny
const depth2Person = person.company.people.find((p) => p.id === person.id);
expect(depth2Person).toBeDefined();
}).expect(400);
});
});
packages/twenty-server/test/integration/rest/suites/rest-api-core-find-one.integration-spec.ts
+2 -15
View File
@@ -115,23 +115,10 @@ describe('Core REST API Find One endpoint', () => {
});
});
it('should support depth 2 parameter', async () => {
it('should not support depth 2 parameter', async () => {
await makeRestAPIRequest({
method: 'get',
path: `/people/${TEST_PERSON_1_ID}?depth=2`,
})
.expect(200)
.expect((res) => {
const person = res.body.data.person;
expect(person.company.people).toBeDefined();
const depth2Person = person.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === person.id,
);
expect(depth2Person).toBeDefined();
});
}).expect(400);
});
});
packages/twenty-server/test/integration/rest/suites/rest-api-core-update.integration-spec.ts
+1 -14
View File
@@ -110,20 +110,7 @@ describe('Core REST API Update One endpoint', () => {
method: 'patch',
path: `/people/${TEST_PERSON_1_ID}?depth=2`,
body: updatedData,
})
.expect(200)
.expect((res) => {
const updatedPerson = res.body.data.updatePerson;
expect(updatedPerson.company.people).toBeDefined();
const depth2Person = updatedPerson.company.people.find(
// @ts-expect-error legacy noImplicitAny
(p) => p.id === updatedPerson.id,
);
expect(depth2Person).toBeDefined();
});
}).expect(400);
});
it('should return a EntityNotFoundError when trying to update a non-existing person', async () => {