refactor(core): Start modularizing the community packages feature (#17757)

Author: ivov

packages/@n8n/backend-common/tsconfig.json

@@ -8,5 +8,12 @@
 		"experimentalDecorators": true,
 		"emitDecoratorMetadata": true
 	},
-	"include": ["src/**/*.ts"]
+	"include": ["src/**/*.ts"],
+	"references": [
+		{ "path": "../../workflow/tsconfig.build.cjs.json" },
+		{ "path": "../config/tsconfig.build.json" },
+		{ "path": "../constants/tsconfig.build.json" },
+		{ "path": "../decorators/tsconfig.build.json" },
+		{ "path": "../di/tsconfig.build.json" }
+	]
 }

packages/@n8n/config/src/configs/logging.config.ts

@@ -20,6 +20,7 @@ export const LOG_SCOPES = [
 	'workflow-activation',
 	'ssh-client',
 	'cron',
+	'community-nodes',
 ] as const;
 
 export type LogScope = (typeof LOG_SCOPES)[number];

packages/@n8n/config/src/configs/nodes.config.ts

@@ -1,4 +1,4 @@
-import { Config, Env, Nested } from '../decorators';
+import { Config, Env } from '../decorators';
 
 function isStringArray(input: unknown): input is string[] {
 	return Array.isArray(input) && input.every((item) => typeof item === 'string');
@@ -20,33 +20,6 @@ class JsonStringArray extends Array<string> {
 	}
 }
 
-@Config
-class CommunityPackagesConfig {
-	/** Whether to enable community packages */
-	@Env('N8N_COMMUNITY_PACKAGES_ENABLED')
-	enabled: boolean = true;
-
-	/** NPM registry URL to pull community packages from */
-	@Env('N8N_COMMUNITY_PACKAGES_REGISTRY')
-	registry: string = 'https://registry.npmjs.org';
-
-	/** Whether to reinstall any missing community packages */
-	@Env('N8N_REINSTALL_MISSING_PACKAGES')
-	reinstallMissing: boolean = false;
-
-	/** Whether to block installation of not verified packages */
-	@Env('N8N_UNVERIFIED_PACKAGES_ENABLED')
-	unverifiedEnabled: boolean = true;
-
-	/** Whether to enable and show search suggestion of packages verified by n8n */
-	@Env('N8N_VERIFIED_PACKAGES_ENABLED')
-	verifiedEnabled: boolean = true;
-
-	/** Whether to load community packages */
-	@Env('N8N_COMMUNITY_PACKAGES_PREVENT_LOADING')
-	preventLoading: boolean = false;
-}
-
 @Config
 export class NodesConfig {
 	/** Node types to load. Includes all if unspecified. @example '["n8n-nodes-base.hackerNews"]' */
@@ -64,7 +37,4 @@ export class NodesConfig {
 	/** Whether to enable Python execution on the Code node. */
 	@Env('N8N_PYTHON_ENABLED')
 	pythonEnabled: boolean = true;
-
-	@Nested
-	communityPackages: CommunityPackagesConfig;
 }

packages/@n8n/config/test/config.test.ts

@@ -138,14 +138,6 @@ describe('GlobalConfig', () => {
 			files: [],
 		},
 		nodes: {
-			communityPackages: {
-				enabled: true,
-				registry: 'https://registry.npmjs.org',
-				reinstallMissing: false,
-				unverifiedEnabled: true,
-				verifiedEnabled: true,
-				preventLoading: false,
-			},
 			errorTriggerType: 'n8n-nodes-base.errorTrigger',
 			include: [],
 			exclude: [],

packages/cli/src/commands/__tests__/execute-batch.test.ts

@@ -3,11 +3,12 @@ import { GlobalConfig } from '@n8n/config';
 import type { User, WorkflowEntity } from '@n8n/db';
 import { WorkflowRepository, DbConnection } from '@n8n/db';
 import { Container } from '@n8n/di';
-import type { SelectQueryBuilder } from '@n8n/typeorm';
+import { type SelectQueryBuilder } from '@n8n/typeorm';
 import { mock } from 'jest-mock-extended';
 import type { IRun } from 'n8n-workflow';
 
 import { ActiveExecutions } from '@/active-executions';
+import { CommunityPackagesService } from '@/community-packages/community-packages.service';
 import { DeprecationService } from '@/deprecation/deprecation.service';
 import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus';
 import { TelemetryEventRelay } from '@/events/relays/telemetry.event-relay';
@@ -33,6 +34,7 @@ mockInstance(MessageEventBus);
 const posthogClient = mockInstance(PostHogClient);
 const telemetryEventRelay = mockInstance(TelemetryEventRelay);
 const externalHooks = mockInstance(ExternalHooks);
+mockInstance(CommunityPackagesService);
 
 const dbConnection = mockInstance(DbConnection);
 dbConnection.init.mockResolvedValue(undefined);
@@ -69,7 +71,7 @@ test('should start a task runner when task runners are enabled', async () => {
 		GlobalConfig,
 		mock<GlobalConfig>({
 			taskRunners: { enabled: true },
-			nodes: { communityPackages: { enabled: false } },
+			nodes: {},
 		}),
 	);
 

packages/cli/src/commands/__tests__/execute.test.ts

@@ -7,6 +7,7 @@ import { mock } from 'jest-mock-extended';
 import type { IRun } from 'n8n-workflow';
 
 import { ActiveExecutions } from '@/active-executions';
+import { CommunityPackagesService } from '@/community-packages/community-packages.service';
 import { DeprecationService } from '@/deprecation/deprecation.service';
 import { MessageEventBus } from '@/eventbus/message-event-bus/message-event-bus';
 import { TelemetryEventRelay } from '@/events/relays/telemetry.event-relay';
@@ -32,6 +33,7 @@ mockInstance(MessageEventBus);
 const posthogClient = mockInstance(PostHogClient);
 const telemetryEventRelay = mockInstance(TelemetryEventRelay);
 const externalHooks = mockInstance(ExternalHooks);
+mockInstance(CommunityPackagesService);
 
 const dbConnection = mockInstance(DbConnection);
 dbConnection.init.mockResolvedValue(undefined);
@@ -63,7 +65,7 @@ test('should start a task runner when task runners are enabled', async () => {
 		GlobalConfig,
 		mock<GlobalConfig>({
 			taskRunners: { enabled: true },
-			nodes: { communityPackages: { enabled: false } },
+			nodes: {},
 		}),
 	);
 

packages/cli/src/commands/base-command.ts

@@ -37,6 +37,7 @@ import { NodeTypes } from '@/node-types';
 import { PostHogClient } from '@/posthog';
 import { ShutdownService } from '@/shutdown/shutdown.service';
 import { WorkflowHistoryManager } from '@/workflows/workflow-history.ee/workflow-history-manager.ee';
+import { CommunityPackagesConfig } from '@/community-packages/community-packages.config';
 
 export abstract class BaseCommand<F = never> {
 	readonly flags: F;
@@ -132,9 +133,11 @@ export abstract class BaseCommand<F = never> {
 			);
 		}
 
-		const { communityPackages } = this.globalConfig.nodes;
-		if (communityPackages.enabled && this.needsCommunityPackages) {
-			const { CommunityPackagesService } = await import('@/services/community-packages.service');
+		const communityPackagesConfig = Container.get(CommunityPackagesConfig);
+		if (communityPackagesConfig.enabled && this.needsCommunityPackages) {
+			const { CommunityPackagesService } = await import(
+				'@/community-packages/community-packages.service'
+			);
 			await Container.get(CommunityPackagesService).init();
 		}
 

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

@@ -5,7 +5,7 @@ import { Container } from '@n8n/di';
 import { z } from 'zod';
 
 import { CredentialsService } from '@/credentials/credentials.service';
-import { CommunityPackagesService } from '@/services/community-packages.service';
+import { CommunityPackagesService } from '@/community-packages/community-packages.service';
 
 import { BaseCommand } from './base-command';
 

packages/cli/src/commands/start.ts

@@ -33,6 +33,7 @@ import { ExecutionsPruningService } from '@/services/pruning/executions-pruning.
 import { UrlService } from '@/services/url.service';
 import { WaitTracker } from '@/wait-tracker';
 import { WorkflowRunner } from '@/workflow-runner';
+import { CommunityPackagesConfig } from '@/community-packages/community-packages.config';
 
 // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
 const open = require('open');
@@ -178,14 +179,14 @@ export class Start extends BaseCommand<z.infer<typeof flagsSchema>> {
 		}
 
 		const { flags } = this;
-		const { communityPackages } = this.globalConfig.nodes;
+		const communityPackagesConfig = Container.get(CommunityPackagesConfig);
 		// cli flag overrides the config env variable
 		if (flags.reinstallMissingPackages) {
-			if (communityPackages.enabled) {
+			if (communityPackagesConfig.enabled) {
 				this.logger.warn(
 					'`--reinstallMissingPackages` is deprecated: Please use the env variable `N8N_REINSTALL_MISSING_PACKAGES` instead',
 				);
-				communityPackages.reinstallMissing = true;
+				communityPackagesConfig.reinstallMissing = true;
 			} else {
 				this.logger.warn(
 					'`--reinstallMissingPackages` was passed, but community packages are disabled',

…s__/community-node-types.service.test.ts …s__/community-node-types.service.test.tspackages/cli/src/services/__tests__/community-node-types.service.test.ts renamed to packages/cli/src/community-packages/__tests__/community-node-types.service.test.ts packages/cli/src/services/__tests__/community-node-types.service.test.ts renamed to packages/cli/src/community-packages/__tests__/community-node-types.service.test.ts

@@ -1,20 +1,20 @@
 import { inProduction } from '@n8n/backend-common';
 
-import { getCommunityNodeTypes } from '../../utils/community-node-types-utils';
+import { getCommunityNodeTypes } from '../community-node-types-utils';
 import { CommunityNodeTypesService } from '../community-node-types.service';
 
 jest.mock('@n8n/backend-common', () => ({
 	...jest.requireActual('@n8n/backend-common'),
 	inProduction: jest.fn().mockReturnValue(false),
 }));
 
-jest.mock('../../utils/community-node-types-utils', () => ({
+jest.mock('../community-node-types-utils', () => ({
 	getCommunityNodeTypes: jest.fn().mockResolvedValue([]),
 }));
 
 describe('CommunityNodeTypesService', () => {
 	let service: CommunityNodeTypesService;
-	let globalConfigMock: any;
+	let configMock: any;
 	let communityPackagesServiceMock: any;
 	let loggerMock: any;
 
@@ -24,21 +24,13 @@ describe('CommunityNodeTypesService', () => {
 		delete process.env.ENVIRONMENT;
 
 		loggerMock = { error: jest.fn() };
-		globalConfigMock = {
-			nodes: {
-				communityPackages: {
-					enabled: true,
-					verifiedEnabled: true,
-				},
-			},
+		configMock = {
+			enabled: true,
+			verifiedEnabled: true,
 		};
 		communityPackagesServiceMock = {};
 
-		service = new CommunityNodeTypesService(
-			loggerMock,
-			globalConfigMock,
-			communityPackagesServiceMock,
-		);
+		service = new CommunityNodeTypesService(loggerMock, configMock, communityPackagesServiceMock);
 	});
 
 	describe('fetchNodeTypes', () => {