Skip to content

Commit

Permalink
fix(core): Allow index as top-level item key for Code node (#12469)
Browse files Browse the repository at this point in the history
  • Loading branch information
ivov authored and riascho committed Jan 14, 2025
1 parent a7f67b2 commit 2ece66c
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ describe('result validation', () => {
['binary', {}],
['pairedItem', {}],
['error', {}],
['index', {}], // temporarily allowed until refactored out
])(
'should not throw an error if the output item has %s key in addition to json',
(key, value) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,19 @@ import type { INodeExecutionData } from 'n8n-workflow';
import { ValidationError } from './errors/validation-error';
import { isObject } from './obj-utils';

export const REQUIRED_N8N_ITEM_KEYS = new Set(['json', 'binary', 'pairedItem', 'error']);
export const REQUIRED_N8N_ITEM_KEYS = new Set([
'json',
'binary',
'pairedItem',
'error',

/**
* The `index` key was added accidentally to Function, FunctionItem, Gong,
* Execute Workflow, and ToolWorkflowV2, so we need to allow it temporarily.
* Once we stop using it in all nodes, we can stop allowing the `index` key.
*/
'index',
]);

function validateTopLevelKeys(item: INodeExecutionData, itemIndex: number) {
for (const key in item) {
Expand Down
14 changes: 13 additions & 1 deletion packages/nodes-base/nodes/Code/Sandbox.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,19 @@ export interface SandboxContext extends IWorkflowDataProxyData {
helpers: IExecuteFunctions['helpers'];
}

export const REQUIRED_N8N_ITEM_KEYS = new Set(['json', 'binary', 'pairedItem', 'error']);
export const REQUIRED_N8N_ITEM_KEYS = new Set([
'json',
'binary',
'pairedItem',
'error',

/**
* The `index` key was added accidentally to Function, FunctionItem, Gong,
* Execute Workflow, and ToolWorkflowV2, so we need to allow it temporarily.
* Once we stop using it in all nodes, we can stop allowing the `index` key.
*/
'index',
]);

export function getSandboxContext(
this: IExecuteFunctions | ISupplyDataFunctions,
Expand Down
7 changes: 7 additions & 0 deletions packages/nodes-base/nodes/Code/test/Code.node.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ describe('Code Node unit test', () => {
[{ json: { count: 42 } }],
[{ json: { count: 42 } }],
],

// temporarily allowed until refactored out
'should handle an index key': [
[{ json: { count: 42 }, index: 0 }],
[{ json: { count: 42 }, index: 0 }],
],

'should handle when returned data is not an array': [
{ json: { count: 42 } },
[{ json: { count: 42 } }],
Expand Down

0 comments on commit 2ece66c

Please sign in to comment.