Fix api timeout (#6401)

twentyhq · Jul 25, 2024 · 7c6ca0e · 7c6ca0e
1 parent 082d55b
commit 7c6ca0e
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/...ty-server/src/engine/api/graphql/workspace-query-runner/workspace-query-runner.service.ts b/...ty-server/src/engine/api/graphql/workspace-query-runner/workspace-query-runner.service.ts
@@ -643,7 +643,9 @@ export class WorkspaceQueryRunnerService {
       );
     } catch (error) {
       if (isQueryTimeoutError(error)) {
-        throw new RequestTimeoutException(error.message);
+        throw new RequestTimeoutException(
+          'The SQL request took too long to process, resulting in a query read timeout. To resolve this issue, consider modifying your query by reducing the depth of relationships or limiting the number of records being fetched.',
+        );
       }
 
       throw error;

diff --git a/...src/engine/api/rest/core/query-builder/utils/map-field-metadata-to-graphql-query.utils.ts b/...src/engine/api/rest/core/query-builder/utils/map-field-metadata-to-graphql-query.utils.ts
@@ -1,7 +1,7 @@
 import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/field-metadata.entity';
 import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
 
-const DEFAULT_DEPTH_VALUE = 2;
+const DEFAULT_DEPTH_VALUE = 1;
 
 // TODO: Should be properly type and based on composite type definitions
 export const mapFieldMetadataToGraphqlQuery = (

diff --git a/...s/twenty-server/src/engine/core-modules/open-api/utils/__tests__/parameters.utils.spec.ts b/...s/twenty-server/src/engine/core-modules/open-api/utils/__tests__/parameters.utils.spec.ts
@@ -69,6 +69,7 @@ describe('computeParameters', () => {
         schema: {
           type: 'integer',
           enum: [0, 1, 2],
+          default: 1,
         },
       });
     });

diff --git a/packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts b/packages/twenty-server/src/engine/core-modules/open-api/utils/parameters.utils.ts
@@ -60,6 +60,7 @@ export const computeDepthParameters = (): OpenAPIV3_1.ParameterObject => {
     schema: {
       type: 'integer',
       enum: [0, 1, 2],
+      default: 1,
     },
   };
 };