fix(core): Fix validation of items returned in the task runner (no-changelog) #11897
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
ivov
approved these changes
Nov 26, 2024
| @@ -9,7 +9,7 @@ export const REQUIRED_N8N_ITEM_KEYS = new Set(['json', 'binary', 'pairedItem', ' | |||
| function validateTopLevelKeys(item: INodeExecutionData, itemIndex: number) { | |||
| for (const key in item) { | |||
| if (Object.prototype.hasOwnProperty.call(item, key)) { | |||
| if (REQUIRED_N8N_ITEM_KEYS.has(key)) return; | |||
| if (REQUIRED_N8N_ITEM_KEYS.has(key)) continue; | |||
There was a problem hiding this comment.
Lucky we caught this early!
- I notice that there is some duplication between
./packages/@n8n/task-runner/src/js-task-runner/result-validation.tsand./packages/@n8n/task-runner/src/js-task-runner/result-validation.ts. The versions risk drifting apart as validation is updated in the Code node. Should this validation exist only once inn8n-coreand be imported into the runner and into the Code node sandbox? - I also notice the runner and the Code node sandbox do not share all validation, e.g.
Access the properties of an item under .json, e.g. item.jsonandIn the returned data, every key named 'json' must point to an object.are duplicated, butPlease return an array of objects, one for each item you would like to outputandPlease return an object representing the output item. ('${executionResult}' was returned instead.)exist only in the Code node sandbox. Is this an issue also?
There was a problem hiding this comment.
💯! Very good questions!
- I assume you mean between task runner and the Code Node Sandbox? The Sandbox should eventually go away entirely, so that duplication will be solved by that.
- I couldn't find any mismatches between the two. E.g. the
Please return an array of objectsis in Sandbox and also in the runner. Maybe you missed it because the code doesn't match 1:1 (the Sandbox uses some interpolation)
n8n
|
||||||||||||||||||||||||||||
| Project |
n8n
|
| Branch Review |
master
|
| Run status |
|
| Run duration | 04m 40s |
| Commit |
|
| Committer | Tomi Turtiainen |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
1
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
478
|
| View all changes introduced in this branch ↗︎ | |
|
✅ All Cypress E2E specs passed |
tomi
deleted the
cat-363-adding-a-property-to-the-item-top-level-does-not-throw
branch
tomi
changed the title
Merged
|
Got released with |
despairblue
pushed a commit
that referenced
this pull request
Nov 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fix validation and add tests
Related Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/CAT-363/adding-a-property-to-the-item-top-level-does-not-throw
Review / Merge checklist
release/backport(if the PR is an urgent fix that needs to be backported)