-
Notifications
You must be signed in to change notification settings - Fork 8.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(core): Fix validation of items returned in the task runner (#11897)
- Loading branch information
Showing
2 changed files
with
111 additions
and
1 deletion.
There are no files selected for viewing
110 changes: 110 additions & 0 deletions
110
packages/@n8n/task-runner/src/js-task-runner/__tests__/result-validation.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
import { ValidationError } from '@/js-task-runner/errors/validation-error'; | ||
import { | ||
validateRunForAllItemsOutput, | ||
validateRunForEachItemOutput, | ||
} from '@/js-task-runner/result-validation'; | ||
|
||
describe('result validation', () => { | ||
describe('validateRunForAllItemsOutput', () => { | ||
it('should throw an error if the output is not an object', () => { | ||
expect(() => { | ||
validateRunForAllItemsOutput(undefined); | ||
}).toThrowError(ValidationError); | ||
}); | ||
|
||
it('should throw an error if the output is an array and at least one item has a non-n8n key', () => { | ||
expect(() => { | ||
validateRunForAllItemsOutput([{ json: {} }, { json: {}, unknownKey: {} }]); | ||
}).toThrowError(ValidationError); | ||
}); | ||
|
||
it('should not throw an error if the output is an array and all items are json wrapped', () => { | ||
expect(() => { | ||
validateRunForAllItemsOutput([{ json: {} }, { json: {} }, { json: {} }]); | ||
}).not.toThrow(); | ||
}); | ||
|
||
test.each([ | ||
['binary', {}], | ||
['pairedItem', {}], | ||
['error', {}], | ||
])( | ||
'should not throw an error if the output item has %s key in addition to json', | ||
(key, value) => { | ||
expect(() => { | ||
validateRunForAllItemsOutput([{ json: {} }, { json: {}, [key]: value }]); | ||
}).not.toThrow(); | ||
}, | ||
); | ||
|
||
it('should not throw an error if the output is an array and all items are not json wrapped', () => { | ||
expect(() => { | ||
validateRunForAllItemsOutput([ | ||
{ | ||
id: 1, | ||
name: 'test3', | ||
}, | ||
{ | ||
id: 2, | ||
name: 'test4', | ||
}, | ||
{ | ||
id: 3, | ||
name: 'test5', | ||
}, | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
] as any); | ||
}).not.toThrow(); | ||
}); | ||
|
||
it('should throw if json is not an object', () => { | ||
expect(() => { | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
validateRunForAllItemsOutput([{ json: 1 } as any]); | ||
}).toThrowError(ValidationError); | ||
}); | ||
}); | ||
|
||
describe('validateRunForEachItemOutput', () => { | ||
const index = 0; | ||
|
||
it('should throw an error if the output is not an object', () => { | ||
expect(() => { | ||
validateRunForEachItemOutput(undefined, index); | ||
}).toThrowError(ValidationError); | ||
}); | ||
|
||
it('should throw an error if the output is an array', () => { | ||
expect(() => { | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
validateRunForEachItemOutput([] as any, index); | ||
}).toThrowError(ValidationError); | ||
}); | ||
|
||
it('should throw if json is not an object', () => { | ||
expect(() => { | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
validateRunForEachItemOutput({ json: 1 } as any, index); | ||
}).toThrowError(ValidationError); | ||
}); | ||
|
||
it('should throw an error if the output is an array and at least one item has a non-n8n key', () => { | ||
expect(() => { | ||
validateRunForEachItemOutput({ json: {}, unknownKey: {} }, index); | ||
}).toThrowError(ValidationError); | ||
}); | ||
|
||
test.each([ | ||
['binary', {}], | ||
['pairedItem', {}], | ||
['error', {}], | ||
])( | ||
'should not throw an error if the output item has %s key in addition to json', | ||
(key, value) => { | ||
expect(() => { | ||
validateRunForEachItemOutput({ json: {}, [key]: value }, index); | ||
}).not.toThrow(); | ||
}, | ||
); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters