refactor(core): Rename some runners files and classes for clarity (#12410)

packages/cli/src/task-runners/__tests__/task-runner-process.test.ts

@@ -0,0 +1,121 @@
+import { TaskRunnersConfig } from '@n8n/config';
+import { mock } from 'jest-mock-extended';
+import { Logger } from 'n8n-core';
+import type { ChildProcess, SpawnOptions } from 'node:child_process';
+
+import type { TaskRunnerAuthService } from '@/task-runners/auth/task-runner-auth.service';
+import { TaskRunnerProcess } from '@/task-runners/task-runner-process';
+import { mockInstance } from '@test/mocking';
+
+import type { TaskRunnerLifecycleEvents } from '../task-runner-lifecycle-events';
+
+const spawnMock = jest.fn(() =>
+	mock<ChildProcess>({
+		stdout: {
+			pipe: jest.fn(),
+		},
+		stderr: {
+			pipe: jest.fn(),
+		},
+	}),
+);
+require('child_process').spawn = spawnMock;
+
+describe('TaskRunnerProcess', () => {
+	const logger = mockInstance(Logger);
+	const runnerConfig = mockInstance(TaskRunnersConfig);
+	runnerConfig.enabled = true;
+	runnerConfig.mode = 'internal';
+	const authService = mock<TaskRunnerAuthService>();
+	let taskRunnerProcess = new TaskRunnerProcess(logger, runnerConfig, authService, mock());
+
+	afterEach(async () => {
+		spawnMock.mockClear();
+	});
+
+	describe('constructor', () => {
+		it('should throw if runner mode is external', () => {
+			runnerConfig.mode = 'external';
+
+			expect(() => new TaskRunnerProcess(logger, runnerConfig, authService, mock())).toThrow();
+
+			runnerConfig.mode = 'internal';
+		});
+
+		it('should register listener for `runner:failed-heartbeat-check` event', () => {
+			const runnerLifecycleEvents = mock<TaskRunnerLifecycleEvents>();
+			new TaskRunnerProcess(logger, runnerConfig, authService, runnerLifecycleEvents);
+
+			expect(runnerLifecycleEvents.on).toHaveBeenCalledWith(
+				'runner:failed-heartbeat-check',
+				expect.any(Function),
+			);
+		});
+
+		it('should register listener for `runner:timed-out-during-task` event', () => {
+			const runnerLifecycleEvents = mock<TaskRunnerLifecycleEvents>();
+			new TaskRunnerProcess(logger, runnerConfig, authService, runnerLifecycleEvents);
+
+			expect(runnerLifecycleEvents.on).toHaveBeenCalledWith(
+				'runner:timed-out-during-task',
+				expect.any(Function),
+			);
+		});
+	});
+
+	describe('start', () => {
+		beforeEach(() => {
+			taskRunnerProcess = new TaskRunnerProcess(logger, runnerConfig, authService, mock());
+		});
+
+		test.each([
+			'PATH',
+			'NODE_FUNCTION_ALLOW_BUILTIN',
+			'NODE_FUNCTION_ALLOW_EXTERNAL',
+			'N8N_SENTRY_DSN',
+			'N8N_VERSION',
+			'ENVIRONMENT',
+			'DEPLOYMENT_NAME',
+			'GENERIC_TIMEZONE',
+		])('should propagate %s from env as is', async (envVar) => {
+			jest.spyOn(authService, 'createGrantToken').mockResolvedValue('grantToken');
+			process.env[envVar] = 'custom value';
+
+			await taskRunnerProcess.start();
+
+			// @ts-expect-error The type is not correct
+			const options = spawnMock.mock.calls[0][2] as SpawnOptions;
+			expect(options.env).toEqual(
+				expect.objectContaining({
+					[envVar]: 'custom value',
+				}),
+			);
+		});
+
+		it('should pass NODE_OPTIONS env if maxOldSpaceSize is configured', async () => {
+			jest.spyOn(authService, 'createGrantToken').mockResolvedValue('grantToken');
+			runnerConfig.maxOldSpaceSize = '1024';
+
+			await taskRunnerProcess.start();
+
+			// @ts-expect-error The type is not correct
+			const options = spawnMock.mock.calls[0][2] as SpawnOptions;
+			expect(options.env).toEqual(
+				expect.objectContaining({
+					NODE_OPTIONS: '--max-old-space-size=1024',
+				}),
+			);
+		});
+
+		it('should not pass NODE_OPTIONS env if maxOldSpaceSize is not configured', async () => {
+			jest.spyOn(authService, 'createGrantToken').mockResolvedValue('grantToken');
+			runnerConfig.maxOldSpaceSize = '';
+
+			await taskRunnerProcess.start();
+
+			// @ts-expect-error The type is not correct
+			const options = spawnMock.mock.calls[0][2] as SpawnOptions;
+			expect(options.env).not.toHaveProperty('NODE_OPTIONS');
+		});
+	});
+});