feat(API): Exclude pinned data from workflows #12261
Merged
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
netroy
reviewed
Dec 17, 2024
| @@ -120,6 +121,10 @@ export = { | |||
| return res.status(404).json({ message: 'Not Found' }); | |||
| } | |||
|
|
|||
| if (excludePinnedData) { | |||
There was a problem hiding this comment.
we don't have to fix this here, but maybe we should create a tech-debt ticket to remove this at the query level, instead of using delete on the returned data.
There was a problem hiding this comment.
Created a tech-debt ticket: PAY-2385.
| @@ -199,6 +212,12 @@ export = { | |||
| ...(!config.getEnv('workflowTagsDisabled') && { relations: ['tags'] }), | |||
| }); | |||
|
|
|||
| if (excludePinnedData) { | |||
| workflows.forEach((workflow) => { | |||
| delete workflow.pinData; | |||
n8n-assistant
bot
added
core
…se to make TS happy
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
MarcL
changed the title
netroy
approved these changes
Dec 18, 2024
n8n
|
||||||||||||||||||||||||||||
| Project |
n8n
|
| Branch Review |
pay-2238-option-to-exclude-pinned-data-when-getting-all-workflows
|
| Run status |
|
| Run duration | 04m 34s |
| Commit |
|
| Committer | Marc Littlemore |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
1
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
480
|
| View all changes introduced in this branch ↗︎ | |
|
✅ All Cypress E2E specs passed |
MarcL
deleted the
pay-2238-option-to-exclude-pinned-data-when-getting-all-workflows
branch
Merged
|
Got released with |
riascho
pushed a commit
that referenced
this pull request
Dec 23, 2024
riascho
pushed a commit
that referenced
this pull request
Jan 14, 2025
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
Adds the ability to exclude pinned data when retrieving workflows via the public API. This can be applied to both the retrieval of all workflows and to the retrieval of a single workflow.
To avoid breaking the existing API contract, a query parameter
?excludePinnedData=trueshould be added to explicitly exclude the data. By default, it continues to be included.There was no great approach to excluding the data when making a database query without explicitly creating a
selectoption which includes all data. This would introduce a brittle query that always has to match any changes to the workflow and corresponding joined data. Instead, I've opted to delete the data after retrieval from the DB. Shout if you think there's a better approach.Related Linear tickets, Github issues, and Community forum posts
Fixes: PAY-2238
Review / Merge checklist
release/backport(if the PR is an urgent fix that needs to be backported)