mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: Fix console log handling in JS task runner (no-changelog) (#11147)

Browse source
This commit is contained in:
Tomi Turtiainen 2024-10-08 16:32:50 +03:00 committed by GitHub
parent 606eedbf1b
commit 18c0c8612c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 12 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
packages/@n8n/task-runner/src/js-task-runner/__tests__/js-task-runner.test.ts
View file

@ -1,4 +1,4 @@
import type { CodeExecutionMode, IDataObject, WorkflowExecuteMode } from 'n8n-workflow'; import type { CodeExecutionMode, IDataObject } from 'n8n-workflow';
import { ValidationError } from '@/js-task-runner/errors/validation-error'; import { ValidationError } from '@/js-task-runner/errors/validation-error';
import { import {
@ -31,30 +31,13 @@ describe('JsTaskRunner', () => {
}); });
describe('console', () => { describe('console', () => {
test.each<[CodeExecutionMode, WorkflowExecuteMode]>([ test.each<[CodeExecutionMode]>([['runOnceForAllItems'], ['runOnceForEachItem']])(
['runOnceForAllItems', 'cli'], 'should make an rpc call for console log in %s mode',
['runOnceForAllItems', 'error'], async (nodeMode) => {
['runOnceForAllItems', 'integrated'],
['runOnceForAllItems', 'internal'],
['runOnceForAllItems', 'retry'],
['runOnceForAllItems', 'trigger'],
['runOnceForAllItems', 'webhook'],
['runOnceForEachItem', 'cli'],
['runOnceForEachItem', 'error'],
['runOnceForEachItem', 'integrated'],
['runOnceForEachItem', 'internal'],
['runOnceForEachItem', 'retry'],
['runOnceForEachItem', 'trigger'],
['runOnceForEachItem', 'webhook'],
])(
'should make an rpc call for console log in %s mode when workflow mode is %s',
async (nodeMode, workflowMode) => {
jest.spyOn(console, 'log').mockImplementation(() => {});
jest.spyOn(jsTaskRunner, 'makeRpcCall').mockResolvedValue(undefined); jest.spyOn(jsTaskRunner, 'makeRpcCall').mockResolvedValue(undefined);
const task = newTaskWithSettings({ const task = newTaskWithSettings({
code: "console.log('Hello', 'world!'); return {}", code: "console.log('Hello', 'world!'); return {}",
nodeMode, nodeMode,
workflowMode,
}); });
await execTaskWithParams({ await execTaskWithParams({
@ -62,34 +45,11 @@ describe('JsTaskRunner', () => {
taskData: newAllCodeTaskData([wrapIntoJson({})]), taskData: newAllCodeTaskData([wrapIntoJson({})]),
}); });
expect(console.log).toHaveBeenCalledWith('[JS Code]', 'Hello world!');
expect(jsTaskRunner.makeRpcCall).toHaveBeenCalledWith(task.taskId, 'logNodeOutput', [ expect(jsTaskRunner.makeRpcCall).toHaveBeenCalledWith(task.taskId, 'logNodeOutput', [
'Hello world!', 'Hello world!',
]); ]);
}, },
); );
test.each<[CodeExecutionMode, WorkflowExecuteMode]>([
['runOnceForAllItems', 'manual'],
['runOnceForEachItem', 'manual'],
])(
"shouldn't make an rpc call for console log in %s mode when workflow mode is %s",
async (nodeMode, workflowMode) => {
jest.spyOn(jsTaskRunner, 'makeRpcCall').mockResolvedValue(undefined);
const task = newTaskWithSettings({
code: "console.log('Hello', 'world!'); return {}",
nodeMode,
workflowMode,
});
await execTaskWithParams({
task,
taskData: newAllCodeTaskData([wrapIntoJson({})]),
});
expect(jsTaskRunner.makeRpcCall).not.toHaveBeenCalled();
},
);
}); });
describe('runOnceForAllItems', () => { describe('runOnceForAllItems', () => {

20
packages/@n8n/task-runner/src/js-task-runner/js-task-runner.ts
View file

@ -74,8 +74,6 @@ type CustomConsole = {
log: (...args: unknown[]) => void; log: (...args: unknown[]) => void;
}; };
const noop = () => {};
export class JsTaskRunner extends TaskRunner { export class JsTaskRunner extends TaskRunner {
constructor( constructor(
taskType: string, taskType: string,
@ -110,16 +108,14 @@ export class JsTaskRunner extends TaskRunner {
}); });
const customConsole = { const customConsole = {
log: // Send log output back to the main process. It will take care of forwarding
settings.workflowMode === 'manual' // it to the UI or printing to console.
? noop log: (...args: unknown[]) => {
: (...args: unknown[]) => { const logOutput = args
const logOutput = args .map((arg) => (typeof arg === 'object' && arg !== null ? JSON.stringify(arg) : arg))
.map((arg) => (typeof arg === 'object' && arg !== null ? JSON.stringify(arg) : arg)) .join(' ');
.join(' '); void this.makeRpcCall(task.taskId, 'logNodeOutput', [logOutput]);
console.log('[JS Code]', logOutput); },
void this.makeRpcCall(task.taskId, 'logNodeOutput', [logOutput]);
},
}; };
const result = const result =