Skip to content

The open alternative to Salesforce, designed for AI.

feat(usage): meter API complexity as the max record fields a query can return (#27155)

Etiennedb3f4936125a
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-base-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-base-query-runner.service.ts
index def65408a87..4d4263913c4 100644
--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-base-query-runner.service.ts
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-base-query-runner.service.ts
@@ -1,5 +1,6 @@
import { Inject, Injectable } from '@nestjs/common';
+import { QUERY_MAX_RECORDS_FROM_RELATION } from 'twenty-shared/constants';
import { FieldMetadataType, type ObjectRecord } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
@@ -20,6 +21,7 @@ import {
} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
import { buildMutationQueryBuilder } from 'src/engine/api/common/common-query-runners/utils/build-mutation-query-builder.util';
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
import { isRecordFilterEmpty } from 'src/engine/api/common/common-query-runners/utils/is-record-filter-empty.util';
import { CommonResultGettersService } from 'src/engine/api/common/common-result-getters/common-result-getters.service';
import { CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';
@@ -141,14 +143,20 @@ export abstract class CommonBaseQueryRunnerService<
selectedFieldsResult,
} as CommonExtendedInput<Args>;
- const queryComplexity = this.validateQueryComplexity(
+ this.validateQueryComplexity(
selectedFieldsResult,
processedArgs,
queryRunnerContext,
);
if (isRootOperation) {
- this.recordApiComplexityUsage(authContext, queryComplexity);
+ this.recordApiComplexityUsage(authContext, () =>
+ this.computeQueryComplexityV2(
+ selectedFieldsResult,
+ processedArgs,
+ queryRunnerContext,
+ ),
+ );
}
const results = await this.workspaceOrmManager.executeInWorkspaceContext(
@@ -202,6 +210,26 @@ export abstract class CommonBaseQueryRunnerService<
return selectedFieldsComplexity;
}
+ protected computeQueryComplexityV2(
+ selectedFieldsResult: CommonSelectedFieldsResult,
+ _args: CommonExtendedInput<Args>,
+ queryRunnerContext: CommonBaseQueryRunnerContext,
+ ): number {
+ const {
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ } = queryRunnerContext;
+
+ return computeMaxFieldCountPerRecord({
+ selectedFieldsResult,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation: QUERY_MAX_RECORDS_FROM_RELATION,
+ });
+ }
+
private async processArgs(
args: CommonInput<Args>,
queryRunnerContext: CommonBaseQueryRunnerContext,
@@ -488,18 +516,18 @@ export abstract class CommonBaseQueryRunnerService<
private recordApiComplexityUsage(
authContext: WorkspaceAuthContext,
- queryComplexity: number,
+ computeQueryComplexity: () => number,
) {
const apiType = getApiType();
- if (!isDefined(apiType)) {
+ if (!isDefined(apiType) || !this.usageRecorderService.isEnabled()) {
return;
}
this.usageRecorderService.accumulate(authContext.workspace.id, {
resourceType: UsageResourceType.API,
operationType: UsageOperationType.API_REQUEST,
- quantity: queryComplexity,
+ quantity: computeQueryComplexity() || 1,
unit: UsageUnit.COMPLEXITY,
resourceContext: apiType,
spenders: buildUsageSpendersFromAuthContext(authContext),
@@ -563,7 +591,7 @@ export abstract class CommonBaseQueryRunnerService<
selectedFieldsResult: CommonSelectedFieldsResult,
args: CommonExtendedInput<Args>,
queryRunnerContext: CommonBaseQueryRunnerContext,
- ): number {
+ ): void {
const maximumComplexity = this.twentyConfigService.get(
'COMMON_QUERY_COMPLEXITY_LIMIT',
);
@@ -593,7 +621,5 @@ export abstract class CommonBaseQueryRunnerService<
},
);
}
-
- return queryComplexity;
}
}
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-many-query-runner/common-create-many-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-many-query-runner/common-create-many-query-runner.service.ts
index 117118f1ae1..2a449443e5f 100644
--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-many-query-runner/common-create-many-query-runner.service.ts
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-many-query-runner/common-create-many-query-runner.service.ts
@@ -23,6 +23,7 @@ import {
CommonQueryRunnerExceptionCode,
} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
import { CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';
import { CommonExtendedQueryRunnerContext } from 'src/engine/api/common/types/common-extended-query-runner-context.type';
import {
@@ -804,4 +805,27 @@ export class CommonCreateManyQueryRunnerService extends CommonBaseQueryRunnerSer
return recordWithoutCreatedByUpdate;
}
+
+ protected override computeQueryComplexityV2(
+ selectedFieldsResult: CommonSelectedFieldsResult,
+ args: CommonExtendedInput<CreateManyQueryArgs>,
+ queryRunnerContext: CommonBaseQueryRunnerContext,
+ ): number {
+ const {
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ } = queryRunnerContext;
+
+ return (
+ args.data.length *
+ computeMaxFieldCountPerRecord({
+ selectedFieldsResult,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation: args.upsert ? QUERY_MAX_RECORDS : 0,
+ })
+ );
+ }
}
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-one-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-one-query-runner.service.ts
index f0a60345d89..870241a0876 100644
--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-one-query-runner.service.ts
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-create-one-query-runner.service.ts
@@ -1,9 +1,11 @@
import { Injectable } from '@nestjs/common';
+import { QUERY_MAX_RECORDS } from 'twenty-shared/constants';
import { type ObjectRecord } from 'twenty-shared/types';
import { CommonBaseQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-base-query-runner.service';
import { CommonCreateManyQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-create-many-query-runner/common-create-many-query-runner.service';
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
import { CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';
import { CommonExtendedQueryRunnerContext } from 'src/engine/api/common/types/common-extended-query-runner-context.type';
import {
@@ -13,6 +15,7 @@ import {
CreateManyQueryArgs,
CreateOneQueryArgs,
} from 'src/engine/api/common/types/common-query-args.type';
+import { CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-selected-fields-result.type';
import { assertIsValidUuid } from 'src/engine/api/graphql/workspace-query-runner/utils/assert-is-valid-uuid.util';
import { WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
import { FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
@@ -102,4 +105,24 @@ export class CommonCreateOneQueryRunnerService extends CommonBaseQueryRunnerServ
assertIsValidUuid(args.data.id);
}
}
+
+ protected override computeQueryComplexityV2(
+ selectedFieldsResult: CommonSelectedFieldsResult,
+ args: CommonExtendedInput<CreateOneQueryArgs>,
+ queryRunnerContext: CommonBaseQueryRunnerContext,
+ ): number {
+ const {
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ } = queryRunnerContext;
+
+ return computeMaxFieldCountPerRecord({
+ selectedFieldsResult,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation: args.upsert ? QUERY_MAX_RECORDS : 0,
+ });
+ }
}
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-duplicates-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-duplicates-query-runner.service.ts
index 5170b589c38..f111dd344bd 100644
--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-duplicates-query-runner.service.ts
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-duplicates-query-runner.service.ts
@@ -6,7 +6,7 @@ import {
QUERY_MAX_RECORDS_FROM_RELATION,
} from 'twenty-shared/constants';
import { ObjectRecord, OrderByDirection } from 'twenty-shared/types';
-import { isDefined } from 'twenty-shared/utils';
+import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
import { FindOptionsRelations, In, ObjectLiteral } from 'typeorm';
import { WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
@@ -16,6 +16,7 @@ import {
CommonQueryRunnerExceptionCode,
} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
import { CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';
import { CommonExtendedQueryRunnerContext } from 'src/engine/api/common/types/common-extended-query-runner-context.type';
import { CommonFindDuplicatesOutputItem } from 'src/engine/api/common/types/common-find-duplicates-output-item.type';
@@ -25,6 +26,7 @@ import {
CommonQueryNames,
FindDuplicatesQueryArgs,
} from 'src/engine/api/common/types/common-query-args.type';
+import { CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-selected-fields-result.type';
import { getPageInfo } from 'src/engine/api/common/utils/get-page-info.util';
import { buildColumnsToSelect } from 'src/engine/api/graphql/graphql-query-runner/utils/build-columns-to-select';
import { buildDuplicateSourceColumnsToSelect } from 'src/engine/api/common/common-query-runners/utils/build-duplicate-source-columns-to-select.util';
@@ -278,4 +280,32 @@ export class CommonFindDuplicatesQueryRunnerService extends CommonBaseQueryRunne
);
}
}
+
+ protected override computeQueryComplexityV2(
+ selectedFieldsResult: CommonSelectedFieldsResult,
+ args: CommonExtendedInput<FindDuplicatesQueryArgs>,
+ queryRunnerContext: CommonBaseQueryRunnerContext,
+ ): number {
+ const {
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ } = queryRunnerContext;
+
+ const inputRecordCount = isNonEmptyArray(args.ids)
+ ? args.ids.length
+ : (args.data?.length ?? 0);
+
+ return (
+ inputRecordCount *
+ QUERY_MAX_RECORDS *
+ computeMaxFieldCountPerRecord({
+ selectedFieldsResult,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation: QUERY_MAX_RECORDS_FROM_RELATION,
+ })
+ );
+ }
}
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-many-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-many-query-runner.service.ts
index 508cbd86265..c855e2f9448 100644
--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-many-query-runner.service.ts
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-many-query-runner.service.ts
@@ -22,6 +22,7 @@ import {
CommonQueryRunnerExceptionCode,
} from 'src/engine/api/common/common-query-runners/errors/common-query-runner.exception';
import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
import { CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';
import { CommonExtendedQueryRunnerContext } from 'src/engine/api/common/types/common-extended-query-runner-context.type';
import { CommonFindManyOutput } from 'src/engine/api/common/types/common-find-many-output.type';
@@ -376,4 +377,27 @@ export class CommonFindManyQueryRunnerService extends CommonBaseQueryRunnerServi
return baseComplexity + orderByRelationCount;
}
+
+ protected override computeQueryComplexityV2(
+ selectedFieldsResult: CommonSelectedFieldsResult,
+ args: CommonExtendedInput<FindManyQueryArgs>,
+ queryRunnerContext: CommonBaseQueryRunnerContext,
+ ): number {
+ const {
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ } = queryRunnerContext;
+
+ return (
+ (args.first ?? args.last ?? QUERY_MAX_RECORDS) *
+ computeMaxFieldCountPerRecord({
+ selectedFieldsResult,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation: QUERY_MAX_RECORDS_FROM_RELATION,
+ })
+ );
+ }
}
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-group-by-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-group-by-query-runner.service.ts
index 3633c22f9f6..05c1a287916 100644
--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-group-by-query-runner.service.ts
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-group-by-query-runner.service.ts
@@ -25,6 +25,7 @@ import {
import { STANDARD_ERROR_MESSAGE } from 'src/engine/api/common/common-query-runners/errors/standard-error-message.constant';
import { GroupByDefinition } from 'src/engine/api/common/common-query-runners/types/group-by-definition.type';
import { GroupByField } from 'src/engine/api/common/common-query-runners/types/group-by-field.type';
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
import { getGroupByDefinitions } from 'src/engine/api/common/common-query-runners/utils/get-group-by-definitions.util';
import { getObjectAlias } from 'src/engine/api/common/common-query-runners/utils/get-object-alias-for-group-by.util';
import { isGroupByRelationField } from 'src/engine/api/common/common-query-runners/utils/is-group-by-relation-field.util';
@@ -41,6 +42,10 @@ import { CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-s
import { GraphqlQueryParser } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/graphql-query.parser';
import { formatResultWithGroupByDimensionValues } from 'src/engine/api/graphql/graphql-query-runner/group-by/resolvers/utils/format-result-with-group-by-dimension-values.util';
import { GroupByWithRecordsService } from 'src/engine/api/graphql/graphql-query-runner/group-by/services/group-by-with-records.service';
+import {
+ RECORDS_PER_GROUP_LIMIT,
+ RELATIONS_PER_RECORD_LIMIT,
+} from 'src/engine/api/graphql/graphql-query-runner/group-by/services/group-by-with-records.constants';
import { getGroupLimit } from 'src/engine/api/graphql/graphql-query-runner/group-by/utils/get-group-limit.util';
import { ProcessAggregateHelper } from 'src/engine/api/graphql/graphql-query-runner/helpers/process-aggregate.helper';
import { getFlatFieldsFromFlatObjectMetadata } from 'src/engine/api/graphql/workspace-schema-builder/utils/get-flat-fields-for-flat-object-metadata.util';
@@ -463,4 +468,37 @@ export class CommonGroupByQueryRunnerService extends CommonBaseQueryRunnerServic
selectedFieldsComplexity * getGroupLimit(args.limit)
: groupByQueryComplexity;
}
+
+ protected override computeQueryComplexityV2(
+ selectedFieldsResult: CommonSelectedFieldsResult,
+ args: CommonExtendedInput<GroupByQueryArgs>,
+ queryRunnerContext: CommonBaseQueryRunnerContext,
+ ): number {
+ const {
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ } = queryRunnerContext;
+
+ const aggregateCount = Object.keys(selectedFieldsResult.aggregate).filter(
+ (aggregateName) =>
+ !isDefined(selectedFieldsResult.relations[aggregateName]),
+ ).length;
+
+ const recordFieldCount = args.includeRecords
+ ? RECORDS_PER_GROUP_LIMIT *
+ computeMaxFieldCountPerRecord({
+ selectedFieldsResult,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation: RELATIONS_PER_RECORD_LIMIT,
+ })
+ : 0;
+
+ return (
+ getGroupLimit(args.limit) *
+ (args.groupBy.length + aggregateCount + recordFieldCount)
+ );
+ }
}
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/utils/__tests__/compute-max-field-count-per-record.util.spec.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/utils/__tests__/compute-max-field-count-per-record.util.spec.ts
new file mode 100644
index 00000000000..26b343fdfce
--- /dev/null
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/utils/__tests__/compute-max-field-count-per-record.util.spec.ts
@@ -0,0 +1,127 @@
+import { FieldMetadataType, RelationType } from 'twenty-shared/types';
+
+import { computeMaxFieldCountPerRecord } from 'src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util';
+import { type CommonSelectedFields } from 'src/engine/api/common/types/common-selected-fields-result.type';
+import { createEmptyFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/constant/create-empty-flat-entity-maps.constant';
+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import { addFlatEntityToFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/add-flat-entity-to-flat-entity-maps-or-throw.util';
+import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
+import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
+
+const buildFlatEntityMaps = <
+ TFlatEntity extends FlatFieldMetadata | FlatObjectMetadata,
+>(
+ flatEntities: TFlatEntity[],
+): FlatEntityMaps<TFlatEntity> =>
+ flatEntities.reduce(
+ (flatEntityMaps, flatEntity) =>
+ addFlatEntityToFlatEntityMapsOrThrow({ flatEntity, flatEntityMaps }),
+ createEmptyFlatEntityMaps() as FlatEntityMaps<TFlatEntity>,
+ );
+
+const peopleField = getFlatFieldMetadataMock({
+ universalIdentifier: 'company-people',
+ objectMetadataId: 'company',
+ type: FieldMetadataType.RELATION,
+ name: 'people',
+ settings: { relationType: RelationType.ONE_TO_MANY },
+ relationTargetObjectMetadataId: 'person',
+});
+
+const companyField = getFlatFieldMetadataMock({
+ universalIdentifier: 'person-company',
+ objectMetadataId: 'person',
+ type: FieldMetadataType.RELATION,
+ name: 'company',
+ settings: { relationType: RelationType.MANY_TO_ONE },
+ relationTargetObjectMetadataId: 'company',
+});
+
+const company = getFlatObjectMetadataMock({
+ id: 'company',
+ universalIdentifier: 'company',
+ fieldIds: [peopleField.id],
+});
+
+const person = getFlatObjectMetadataMock({
+ id: 'person',
+ universalIdentifier: 'person',
+ fieldIds: [companyField.id],
+});
+
+const flatObjectMetadataMaps = buildFlatEntityMaps([company, person]);
+const flatFieldMetadataMaps = buildFlatEntityMaps([peopleField, companyField]);
+
+const computeFor = (
+ flatObjectMetadata: FlatObjectMetadata,
+ select: CommonSelectedFields,
+ relations: CommonSelectedFields,
+ recordLimitPerOneToManyRelation = 60,
+) =>
+ computeMaxFieldCountPerRecord({
+ selectedFieldsResult: { select, relations },
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation,
+ });
+
+describe('computeMaxFieldCountPerRecord', () => {
+ it('should count each selected field of the record', () => {
+ expect(computeFor(company, { id: true, name: true }, {})).toBe(2);
+ });
+
+ it('should count nothing when no field is selected', () => {
+ expect(computeFor(company, {}, {})).toBe(0);
+ });
+
+ it('should add the fields of a to-one relation once', () => {
+ expect(
+ computeFor(
+ person,
+ { id: true, company: { id: true, name: true } },
+ { company: {} },
+ ),
+ ).toBe(3);
+ });
+
+ it('should multiply the fields of a one-to-many relation by its limit', () => {
+ expect(
+ computeFor(company, { id: true, people: { id: true } }, { people: {} }),
+ ).toBe(61);
+ });
+
+ it('should multiply fields nested under a one-to-many relation by its limit', () => {
+ expect(
+ computeFor(
+ company,
+ { id: true, people: { id: true, company: { id: true, name: true } } },
+ { people: { company: {} } },
+ ),
+ ).toBe(181);
+ });
+
+ it('should use the given one-to-many limit', () => {
+ expect(
+ computeFor(
+ company,
+ { id: true, people: { id: true } },
+ { people: {} },
+ 5,
+ ),
+ ).toBe(6);
+ });
+
+ it('should count no one-to-many record when the limit is zero', () => {
+ expect(
+ computeFor(
+ company,
+ { id: true, people: { id: true } },
+ { people: {} },
+ 0,
+ ),
+ ).toBe(1);
+ });
+});
diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util.ts
new file mode 100644
index 00000000000..f7b2d741947
--- /dev/null
+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/utils/compute-max-field-count-per-record.util.ts
@@ -0,0 +1,72 @@
+import { RelationType } from 'twenty-shared/types';
+import { isPlainObject } from 'twenty-shared/utils';
+
+import { type CommonSelectedFieldsResult } from 'src/engine/api/common/types/common-selected-fields-result.type';
+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';
+import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
+import { type OrmFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/orm-flat-field-metadata.type';
+import { buildFieldMapsFromFlatObjectMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/build-field-maps-from-flat-object-metadata.util';
+import { isMorphOrRelationFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';
+import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
+
+export const computeMaxFieldCountPerRecord = ({
+ selectedFieldsResult: { select, relations },
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation,
+}: {
+ selectedFieldsResult: Pick<
+ CommonSelectedFieldsResult,
+ 'select' | 'relations'
+ >;
+ flatObjectMetadata: FlatObjectMetadata;
+ flatObjectMetadataMaps: FlatEntityMaps<FlatObjectMetadata>;
+ flatFieldMetadataMaps: FlatEntityMaps<OrmFlatFieldMetadata>;
+ recordLimitPerOneToManyRelation: number;
+}): number => {
+ const relationNames = Object.keys(relations);
+
+ return relationNames.reduce(
+ (fieldCount, relationName) => {
+ const relationField = findFlatEntityByIdInFlatEntityMapsOrThrow({
+ flatEntityId: buildFieldMapsFromFlatObjectMetadata(
+ flatFieldMetadataMaps,
+ flatObjectMetadata,
+ ).fieldIdByName[relationName],
+ flatEntityMaps: flatFieldMetadataMaps,
+ });
+ const relationSelect = select[relationName];
+ const nestedRelations = relations[relationName];
+
+ if (
+ !isMorphOrRelationFlatFieldMetadata(relationField) ||
+ !isPlainObject(relationSelect) ||
+ !isPlainObject(nestedRelations)
+ ) {
+ return fieldCount;
+ }
+
+ return (
+ fieldCount +
+ (relationField.settings.relationType === RelationType.ONE_TO_MANY
+ ? recordLimitPerOneToManyRelation
+ : 1) *
+ computeMaxFieldCountPerRecord({
+ selectedFieldsResult: {
+ select: relationSelect,
+ relations: nestedRelations,
+ },
+ flatObjectMetadata: findFlatEntityByIdInFlatEntityMapsOrThrow({
+ flatEntityId: relationField.relationTargetObjectMetadataId,
+ flatEntityMaps: flatObjectMetadataMaps,
+ }),
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ recordLimitPerOneToManyRelation,
+ })
+ );
+ },
+ Object.keys(select).length - relationNames.length,
+ );
+};
diff --git a/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts b/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts
index 53d7ea059f5..2c07177af0a 100644
--- a/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/usage/services/usage-recorder.service.ts
@@ -65,8 +65,12 @@ export class UsageRecorderService implements OnModuleInit, OnModuleDestroy {
await this.flush();
}
+ isEnabled(): boolean {
+ return this.eventLogEmitterService.isEnabled();
+ }
+
async record(workspaceId: string, inputs: RecordUsageInput[]): Promise<void> {
- if (!this.eventLogEmitterService.isEnabled() || inputs.length === 0) {
+ if (!this.isEnabled() || inputs.length === 0) {
return;
}
@@ -83,7 +87,7 @@ export class UsageRecorderService implements OnModuleInit, OnModuleDestroy {
}
accumulate(workspaceId: string, input: RecordUsageInput): void {
- if (!this.eventLogEmitterService.isEnabled()) {
+ if (!this.isEnabled()) {
return;
}