The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
feat(server): route findOne through the ORM v2 read path (#24077)
Charles Bochetbcdac3e8245f
diff --git a/.github/workflows/ci-server.yaml b/.github/workflows/ci-server.yamlindex 45803c25c98..7e4f9f2f2fb 100644--- a/.github/workflows/ci-server.yaml+++ b/.github/workflows/ci-server.yaml@@ -311,7 +311,7 @@ jobs:SHARD_COUNTER: 16AUTH_COOKIE_SESSIONS_ENABLED: ${{ contains(github.event.pull_request.labels.*.name, 'ci:auth-cookie-sessions') }}TEST_FORCED_FEATURE_FLAGS: ${{ matrix.orm-v2 && 'IS_ORM_V2_READ_PATH_ENABLED' || '' }}- ORM_V2_TEST_PATH_PATTERN: '(find-many|composite-field-pagination|filter-by-relation-field|order-by-relation-field|nested-relation|soft-deleted-relation|relation-join-rls)'+ ORM_V2_TEST_PATH_PATTERN: '(find-many|find-one|composite-field-pagination|filter-by-relation-field|order-by-relation-field|nested-relation|soft-deleted-relation|relation-join-rls)'steps:- name: Fetch custom Github Actions and base branch historyuses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1diff --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.tsindex 0fdd9107f38..a185e700fc3 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,6 +1,8 @@import { Inject, Injectable } from '@nestjs/common';import { type PermissionFlagType } from 'twenty-shared/constants';+import { FeatureFlagKey } from 'twenty-shared/types';+import { type ObjectLiteral } from 'typeorm';import { QueryResultFieldValue } from 'src/engine/api/graphql/workspace-query-runner/factories/query-result-getters/interfaces/query-result-field-value';@@ -54,9 +56,11 @@ import {} from 'src/engine/metadata-modules/permissions/permissions.exception';import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';import { GlobalWorkspaceOrmManager } from 'src/engine/twenty-orm/global-workspace-datasource/global-workspace-orm.manager';+import { type WorkspaceRepository } from 'src/engine/twenty-orm/repository/workspace.repository';import { getWorkspaceContext } from 'src/engine/twenty-orm/storage/orm-workspace-context.storage';import { resolveRolePermissionConfig } from 'src/engine/twenty-orm/utils/resolve-role-permission-config.util';import { WorkspaceDataSourceV2Service } from 'src/engine/twenty-orm-v2/datasource/workspace-data-source-v2.service';+import { type WorkspaceRepositoryV2 } from 'src/engine/twenty-orm-v2/repository/workspace-repository-v2';import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';@Injectable()@@ -355,6 +359,31 @@ export abstract class CommonBaseQueryRunnerService<};}+ // Behind IS_ORM_V2_READ_PATH_ENABLED, reads go through the ORM v2 repository.+ // useReplica follows isReadOnly so the v2 datasource matches the v1 one the+ // base context already picked (replica for read-only runners, primary+ // otherwise), keeping the root read and nested-relation loading consistent.+ protected getReadRepository({+ repository,+ rolePermissionConfig,+ flatObjectMetadata,+ featureFlagsMap,+ }: Pick<+ CommonExtendedQueryRunnerContext,+ | 'repository'+ | 'rolePermissionConfig'+ | 'flatObjectMetadata'+ | 'featureFlagsMap'+ >): WorkspaceRepository<ObjectLiteral> | WorkspaceRepositoryV2 {+ if (!featureFlagsMap[FeatureFlagKey.IS_ORM_V2_READ_PATH_ENABLED]) {+ return repository;+ }++ return this.workspaceDataSourceV2Service+ .getDataSource({ useReplica: this.isReadOnly })+ .getRepository(flatObjectMetadata.nameSingular, rolePermissionConfig);+ }+private async throttleQueryExecution(authContext: WorkspaceAuthContext) {await this.throttleApiKeyQueryExecution(authContext);await this.throttleApplicationQueryExecution(authContext);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.tsindex bd2d0af69d7..1e271b07d69 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@@ -7,11 +7,7 @@ import {QUERY_MAX_RECORDS,QUERY_MAX_RECORDS_FROM_RELATION,} from 'twenty-shared/constants';-import {- FeatureFlagKey,- ObjectRecord,- OrderByDirection,-} from 'twenty-shared/types';+import { ObjectRecord, OrderByDirection } from 'twenty-shared/types';import { FindOptionsRelations, ObjectLiteral } from 'typeorm';import {@@ -66,7 +62,6 @@ export class CommonFindManyQueryRunnerService extends CommonBaseQueryRunnerServiqueryRunnerContext: CommonExtendedQueryRunnerContext,): Promise<CommonFindManyOutput> {const {- repository,authContext,rolePermissionConfig,flatObjectMetadata,@@ -74,16 +69,9 @@ export class CommonFindManyQueryRunnerService extends CommonBaseQueryRunnerServiflatFieldMetadataMaps,workspaceDataSource,commonQueryParser,- featureFlagsMap,} = queryRunnerContext;- const readRepository = featureFlagsMap[- FeatureFlagKey.IS_ORM_V2_READ_PATH_ENABLED- ]- ? this.workspaceDataSourceV2Service- .getDataSource({ useReplica: true })- .getRepository(flatObjectMetadata.nameSingular, rolePermissionConfig)- : repository;+ const readRepository = this.getReadRepository(queryRunnerContext);const queryBuilder: ReadRecordQueryBuilder =readRepository.createQueryBuilder(flatObjectMetadata.nameSingular);diff --git a/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-one-query-runner.service.ts b/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-one-query-runner.service.tsindex e10101b7b07..736d229974b 100644--- a/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-one-query-runner.service.ts+++ b/packages/twenty-server/src/engine/api/common/common-query-runners/common-find-one-query-runner.service.ts@@ -40,7 +40,6 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServicqueryRunnerContext: CommonExtendedQueryRunnerContext,): Promise<ObjectRecord> {const {- repository,authContext,rolePermissionConfig,workspaceDataSource,@@ -50,7 +49,9 @@ export class CommonFindOneQueryRunnerService extends CommonBaseQueryRunnerServiccommonQueryParser,} = queryRunnerContext;- const queryBuilder = repository.createQueryBuilder(+ const readRepository = this.getReadRepository(queryRunnerContext);++ const queryBuilder = readRepository.createQueryBuilder(flatObjectMetadata.nameSingular,);diff --git a/packages/twenty-server/src/engine/twenty-orm-v2/README.md b/packages/twenty-server/src/engine/twenty-orm-v2/README.mdindex 322b456cc45..20efe35b05a 100644--- a/packages/twenty-server/src/engine/twenty-orm-v2/README.md+++ b/packages/twenty-server/src/engine/twenty-orm-v2/README.md@@ -101,7 +101,8 @@ factories), `setParameters`, `setFindOptions({ select })`, `addSelect`, `orderByThe surface stops there on purpose: anything findMany cannot reach (`getCount`,`getRawMany`, `groupBy`, `take` / `skip`) is left to v1 until a runner needs it.-Wired into `CommonFindManyQueryRunnerService` only. Other runners keep `repository`.+Wired into `CommonFindManyQueryRunnerService` and `CommonFindOneQueryRunnerService`.+Other runners keep `repository`.## Not covered yet