refactor(core): Move first batch of repositories to @n8n/db (#15130)

Author: ivov

packages/@n8n/db/package.json

@@ -26,13 +26,16 @@
     "@n8n/permissions": "workspace:^",
     "@n8n/typeorm": "catalog:",
     "class-validator": "0.14.0",
+    "flatted": "catalog:",
+    "lodash": "catalog:",
     "n8n-core": "workspace:^",
     "n8n-workflow": "workspace:^",
     "nanoid": "catalog:",
     "reflect-metadata": "catalog:",
     "xss": "catalog:"
   },
   "devDependencies": {
-    "@n8n/typescript-config": "workspace:*"
+    "@n8n/typescript-config": "workspace:*",
+    "@types/lodash": "catalog:"
   }
 }

packages/@n8n/db/src/entities/types-db.ts

@@ -1,4 +1,5 @@
 import type { GlobalRole, Scope } from '@n8n/permissions';
+import type { FindOperator } from '@n8n/typeorm';
 import type {
 	ICredentialsEncrypted,
 	IRunExecutionData,
@@ -308,3 +309,45 @@ export type MockedNodeItem = {
 export type RunningMode = 'dry' | 'live';
 
 export type SyncStatus = 'success' | 'error';
+
+/** @deprecated This is tech debt. Do not rely on request-level types in repositories. */
+export namespace ListQuery {
+	export type Options = {
+		filter?: Record<string, unknown>;
+		select?: Record<string, true>;
+		skip?: number;
+		take?: number;
+		sortBy?: string;
+	};
+}
+
+export type ProjectRole =
+	| 'project:personalOwner'
+	| 'project:admin'
+	| 'project:editor'
+	| 'project:viewer';
+
+export interface IGetExecutionsQueryFilter {
+	id?: FindOperator<string> | string;
+	finished?: boolean;
+	mode?: string;
+	retryOf?: string;
+	retrySuccessId?: string;
+	status?: ExecutionStatus[];
+	workflowId?: string;
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	waitTill?: FindOperator<any> | boolean;
+	metadata?: Array<{ key: string; value: string }>;
+	startedAfter?: string;
+	startedBefore?: string;
+}
+
+export type ResourceType = 'folder' | 'workflow';
+
+export type WorkflowFolderUnionFull = (
+	| ListQueryDb.Workflow.Plain
+	| ListQueryDb.Workflow.WithSharing
+	| FolderWithWorkflowAndSubFolderCount
+) & {
+	resource: ResourceType;
+};

packages/@n8n/db/src/index.ts

@@ -18,3 +18,5 @@ export * from './entities';
 export * from './entities/types-db';
 export { NoXss } from './utils/validators/no-xss.validator';
 export { NoUrl } from './utils/validators/no-url.validator';
+
+export * from './repositories';

packages/cli/src/databases/repositories/annotation-tag-mapping.repository.ee.ts renamed to packages/@n8n/db/src/repositories/annotation-tag-mapping.repository.ee.ts

@@ -1,7 +1,8 @@
-import { AnnotationTagMapping } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { AnnotationTagMapping } from '../entities';
+
 @Service()
 export class AnnotationTagMappingRepository extends Repository<AnnotationTagMapping> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/annotation-tag.repository.ee.ts renamed to packages/@n8n/db/src/repositories/annotation-tag.repository.ee.ts

@@ -1,7 +1,8 @@
-import { AnnotationTagEntity } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { AnnotationTagEntity } from '../entities';
+
 @Service()
 export class AnnotationTagRepository extends Repository<AnnotationTagEntity> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/api-key.repository.ts renamed to packages/@n8n/db/src/repositories/api-key.repository.ts

@@ -1,7 +1,8 @@
-import { ApiKey } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { ApiKey } from '../entities';
+
 @Service()
 export class ApiKeyRepository extends Repository<ApiKey> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/auth-identity.repository.ts renamed to packages/@n8n/db/src/repositories/auth-identity.repository.ts

@@ -1,7 +1,8 @@
-import { AuthIdentity } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { AuthIdentity } from '../entities';
+
 @Service()
 export class AuthIdentityRepository extends Repository<AuthIdentity> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/auth-provider-sync-history.repository.ts renamed to packages/@n8n/db/src/repositories/auth-provider-sync-history.repository.ts

@@ -1,7 +1,8 @@
-import { AuthProviderSyncHistory } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { AuthProviderSyncHistory } from '../entities';
+
 @Service()
 export class AuthProviderSyncHistoryRepository extends Repository<AuthProviderSyncHistory> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/auth-user.repository.ts renamed to packages/@n8n/db/src/repositories/auth-user.repository.ts

@@ -1,7 +1,8 @@
-import { AuthUser } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { AuthUser } from '../entities';
+
 @Service()
 export class AuthUserRepository extends Repository<AuthUser> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/credentials.repository.ts renamed to packages/@n8n/db/src/repositories/credentials.repository.ts

@@ -1,10 +1,10 @@
-import type { User } from '@n8n/db';
-import { CredentialsEntity } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, In, Repository, Like } from '@n8n/typeorm';
 import type { FindManyOptions } from '@n8n/typeorm';
 
-import type { ListQuery } from '@/requests';
+import { CredentialsEntity } from '../entities';
+import type { User } from '../entities';
+import type { ListQuery } from '../entities/types-db';
 
 @Service()
 export class CredentialsRepository extends Repository<CredentialsEntity> {

packages/cli/src/databases/repositories/event-destinations.repository.ts renamed to packages/@n8n/db/src/repositories/event-destinations.repository.ts

@@ -1,7 +1,8 @@
-import { EventDestinations } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { EventDestinations } from '../entities';
+
 @Service()
 export class EventDestinationsRepository extends Repository<EventDestinations> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/execution-annotation.repository.ts renamed to packages/@n8n/db/src/repositories/execution-annotation.repository.ts

@@ -1,7 +1,8 @@
-import { ExecutionAnnotation } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { ExecutionAnnotation } from '../entities';
+
 @Service()
 export class ExecutionAnnotationRepository extends Repository<ExecutionAnnotation> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/execution-data.repository.ts renamed to packages/@n8n/db/src/repositories/execution-data.repository.ts

@@ -1,9 +1,10 @@
-import { ExecutionData } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, In, Repository } from '@n8n/typeorm';
 import type { EntityManager } from '@n8n/typeorm';
 import type { QueryDeepPartialEntity } from '@n8n/typeorm/query-builder/QueryPartialEntity';
 
+import { ExecutionData } from '../entities';
+
 @Service()
 export class ExecutionDataRepository extends Repository<ExecutionData> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/execution-metadata.repository.ts renamed to packages/@n8n/db/src/repositories/execution-metadata.repository.ts

@@ -1,7 +1,8 @@
-import { ExecutionMetadata } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { DataSource, Repository } from '@n8n/typeorm';
 
+import { ExecutionMetadata } from '../entities';
+
 @Service()
 export class ExecutionMetadataRepository extends Repository<ExecutionMetadata> {
 	constructor(dataSource: DataSource) {

packages/cli/src/databases/repositories/execution.repository.ts renamed to packages/@n8n/db/src/repositories/execution.repository.ts

@@ -1,22 +1,4 @@
 import { GlobalConfig } from '@n8n/config';
-import type {
-	CreateExecutionPayload,
-	IExecutionFlattedDb,
-	IExecutionBase,
-	IExecutionResponse,
-	ExecutionSummaries,
-} from '@n8n/db';
-import {
-	separate,
-	SharedWorkflow,
-	WorkflowEntity,
-	AnnotationTagEntity,
-	AnnotationTagMapping,
-	ExecutionData,
-	ExecutionEntity,
-	ExecutionAnnotation,
-	ExecutionMetadata,
-} from '@n8n/db';
 import { Service } from '@n8n/di';
 import type {
 	FindManyOptions,
@@ -49,9 +31,31 @@ import type {
 	IRunExecutionData,
 } from 'n8n-workflow';
 
-import { PostgresLiveRowsRetrievalError } from '@/errors/postgres-live-rows-retrieval.error';
-
 import { ExecutionDataRepository } from './execution-data.repository';
+import {
+	ExecutionEntity,
+	ExecutionMetadata,
+	ExecutionData,
+	ExecutionAnnotation,
+	AnnotationTagMapping,
+	WorkflowEntity,
+	SharedWorkflow,
+	AnnotationTagEntity,
+} from '../entities';
+import type {
+	CreateExecutionPayload,
+	IExecutionFlattedDb,
+	IExecutionBase,
+	IExecutionResponse,
+	ExecutionSummaries,
+} from '../entities/types-db';
+import { separate } from '../utils/separate';
+
+class PostgresLiveRowsRetrievalError extends UnexpectedError {
+	constructor(rows: unknown) {
+		super('Failed to retrieve live execution rows in Postgres', { extra: { rows } });
+	}
+}
 
 export interface IGetExecutionsQueryFilter {
 	id?: FindOperator<string> | string;
@@ -61,6 +65,7 @@ export interface IGetExecutionsQueryFilter {
 	retrySuccessId?: string;
 	status?: ExecutionStatus[];
 	workflowId?: string;
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	waitTill?: FindOperator<any> | boolean;
 	metadata?: Array<{ key: string; value: string }>;
 	startedAfter?: string;
@@ -989,6 +994,7 @@ export class ExecutionRepository extends Repository<ExecutionEntity> {
 			qb.setParameter('value', value);
 		}
 
+		// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
 		if (annotationTags?.length || vote) {
 			// If there is a filter by one or multiple tags or by vote - we need to join the annotations table
 			qb.innerJoin('execution.annotation', 'annotation');

packages/@n8n/db/src/repositories/index.ts

@@ -0,0 +1,12 @@
+export { AnnotationTagMappingRepository } from './annotation-tag-mapping.repository.ee';
+export { AnnotationTagRepository } from './annotation-tag.repository.ee';
+export { ApiKeyRepository } from './api-key.repository';
+export { AuthIdentityRepository } from './auth-identity.repository';
+export { AuthProviderSyncHistoryRepository } from './auth-provider-sync-history.repository';
+export { AuthUserRepository } from './auth-user.repository';
+export { CredentialsRepository } from './credentials.repository';
+export { ExecutionAnnotationRepository } from './execution-annotation.repository';
+export { ExecutionDataRepository } from './execution-data.repository';
+export { ExecutionMetadataRepository } from './execution-metadata.repository';
+export { ExecutionRepository } from './execution.repository';
+export { EventDestinationsRepository } from './event-destinations.repository';

packages/cli/src/__tests__/active-executions.test.ts

@@ -1,3 +1,4 @@
+import type { ExecutionRepository } from '@n8n/db';
 import { captor, mock } from 'jest-mock-extended';
 import type {
 	IDeferredPromise,
@@ -12,7 +13,6 @@ import { v4 as uuid } from 'uuid';
 import { ActiveExecutions } from '@/active-executions';
 import { ConcurrencyControlService } from '@/concurrency/concurrency-control.service';
 import config from '@/config';
-import type { ExecutionRepository } from '@/databases/repositories/execution.repository';
 import { mockInstance } from '@test/mocking';
 
 jest.mock('n8n-workflow', () => ({

packages/cli/src/__tests__/external-hooks.test.ts

@@ -1,10 +1,10 @@
 import type { GlobalConfig } from '@n8n/config';
+import type { CredentialsRepository } from '@n8n/db';
 import { mock } from 'jest-mock-extended';
 import type { ErrorReporter, Logger } from 'n8n-core';
 import type { IWorkflowBase } from 'n8n-workflow';
 import { UnexpectedError } from 'n8n-workflow';
 
-import type { CredentialsRepository } from '@/databases/repositories/credentials.repository';
 import type { SettingsRepository } from '@/databases/repositories/settings.repository';
 import type { UserRepository } from '@/databases/repositories/user.repository';
 import type { WorkflowRepository } from '@/databases/repositories/workflow.repository';

packages/cli/src/__tests__/wait-tracker.test.ts

@@ -1,12 +1,12 @@
 import type { Project } from '@n8n/db';
 import type { IExecutionResponse } from '@n8n/db';
+import type { ExecutionRepository } from '@n8n/db';
 import { mock } from 'jest-mock-extended';
 import type { InstanceSettings } from 'n8n-core';
 import type { IRun, IWorkflowBase } from 'n8n-workflow';
 import { createDeferredPromise } from 'n8n-workflow';
 
 import type { ActiveExecutions } from '@/active-executions';
-import type { ExecutionRepository } from '@/databases/repositories/execution.repository';
 import type { MultiMainSetup } from '@/scaling/multi-main-setup.ee';
 import type { OwnershipService } from '@/services/ownership.service';
 import { WaitTracker } from '@/wait-tracker';

packages/cli/src/__tests__/workflow-execute-additional-data.test.ts

@@ -1,5 +1,6 @@
 import { GlobalConfig } from '@n8n/config';
 import type { WorkflowEntity } from '@n8n/db';
+import { ExecutionRepository } from '@n8n/db';
 import { Container } from '@n8n/di';
 import { mock } from 'jest-mock-extended';
 import type { IWorkflowBase } from 'n8n-workflow';
@@ -14,7 +15,6 @@ import type PCancelable from 'p-cancelable';
 
 import { ActiveExecutions } from '@/active-executions';
 import { CredentialsHelper } from '@/credentials-helper';
-import { ExecutionRepository } from '@/databases/repositories/execution.repository';
 import { WorkflowRepository } from '@/databases/repositories/workflow.repository';
 import { VariablesService } from '@/environments.ee/variables/variables.service.ee';
 import { EventService } from '@/events/event.service';

packages/cli/src/__tests__/workflow-runner.test.ts

@@ -51,7 +51,7 @@ afterAll(() => {
 });
 
 beforeEach(async () => {
-	await testDb.truncate(['Workflow', 'SharedWorkflow']);
+	await testDb.truncate(['WorkflowEntity', 'SharedWorkflow']);
 	jest.clearAllMocks();
 });
 

packages/cli/src/active-executions.ts

@@ -1,4 +1,5 @@
 import type { CreateExecutionPayload, IExecutionDb } from '@n8n/db';
+import { ExecutionRepository } from '@n8n/db';
 import { Service } from '@n8n/di';
 import { Logger } from 'n8n-core';
 import type {
@@ -12,7 +13,6 @@ import { createDeferredPromise, ExecutionCancelledError, sleep } from 'n8n-workf
 import { strict as assert } from 'node:assert';
 import type PCancelable from 'p-cancelable';
 
-import { ExecutionRepository } from '@/databases/repositories/execution.repository';
 import { ExecutionNotFoundError } from '@/errors/execution-not-found-error';
 import type { IExecutingWorkflowData, IExecutionsCurrentSummary } from '@/interfaces';
 import { isWorkflowIdValid } from '@/utils';

packages/cli/src/commands/community-node.ts

@@ -1,9 +1,9 @@
 import { type InstalledNodes, type InstalledPackages, type User } from '@n8n/db';
+import { CredentialsRepository } from '@n8n/db';
 import { Container } from '@n8n/di';
 import { Flags } from '@oclif/core';
 
 import { CredentialsService } from '@/credentials/credentials.service';
-import { CredentialsRepository } from '@/databases/repositories/credentials.repository';
 import { InstalledNodesRepository } from '@/databases/repositories/installed-nodes.repository';
 import { UserRepository } from '@/databases/repositories/user.repository';
 import { CommunityPackagesService } from '@/services/community-packages.service';

packages/cli/src/commands/export/credentials.ts

@@ -1,12 +1,12 @@
 import type { ICredentialsDb } from '@n8n/db';
+import { CredentialsRepository } from '@n8n/db';
 import { Container } from '@n8n/di';
 import { Flags } from '@oclif/core';
 import fs from 'fs';
 import { Credentials } from 'n8n-core';
 import { UserError } from 'n8n-workflow';
 import path from 'path';
 
-import { CredentialsRepository } from '@/databases/repositories/credentials.repository';
 import type { ICredentialsDecryptedDb } from '@/interfaces';
 
 import { BaseCommand } from '../base-command';

packages/cli/src/commands/ldap/reset.ts

@@ -1,3 +1,4 @@
+import { AuthIdentityRepository, AuthProviderSyncHistoryRepository } from '@n8n/db';
 import { Container } from '@n8n/di';
 // eslint-disable-next-line n8n-local-rules/misplaced-n8n-typeorm-import
 import { In } from '@n8n/typeorm';
@@ -6,8 +7,6 @@ import { UserError } from 'n8n-workflow';
 
 import { UM_FIX_INSTRUCTION } from '@/constants';
 import { CredentialsService } from '@/credentials/credentials.service';
-import { AuthIdentityRepository } from '@/databases/repositories/auth-identity.repository';
-import { AuthProviderSyncHistoryRepository } from '@/databases/repositories/auth-provider-sync-history.repository';
 import { ProjectRelationRepository } from '@/databases/repositories/project-relation.repository';
 import { ProjectRepository } from '@/databases/repositories/project.repository';
 import { SettingsRepository } from '@/databases/repositories/settings.repository';