feat(core): Add includeData parameter to GET /credentials
#12220
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
This returns the decrypted data property of credentials if the user has the `credential:update` scope for it.
despairblue
changed the title
GET /credentials
n8n-assistant
bot
added
core
Codecov ReportAttention: Patch coverage is
📢 Thoughts on this report? Let us know! |
tomi
reviewed
Dec 18, 2024
packages/@n8n/api-types/src/dto/credentials/credentials-get-many-request.dto.ts
Outdated
Show resolved
Hide resolved
packages/@n8n/api-types/src/dto/credentials/credentials-get-many-request.dto.ts
Outdated
Show resolved
Hide resolved
packages/@n8n/api-types/src/dto/credentials/credentials-get-one-request.dto.ts
Outdated
Show resolved
Hide resolved
packages/@n8n/api-types/src/dto/credentials/credentials-get-many-request.dto.ts
Outdated
Show resolved
Hide resolved
| credentials = credentials.map((c) => | ||
| this.roleService.addScopes(c, user, projectRelations!), | ||
| ); | ||
| } | ||
|
|
||
| if (includeData) { | ||
| credentials = credentials.map((c: CredentialsEntity & ScopesField) => { | ||
| if (c.scopes.includes('credential:update')) { |
There was a problem hiding this comment.
I don't have all thecontext but why do we include the data only if there is a credential:update scope? Do we test this case?
There was a problem hiding this comment.
It's a convention. The FE only shows the data if the user has the permission to update it. The GET /credentials/:id works the same way.
packages/cli/src/databases/repositories/credentials.repository.ts
Outdated
Show resolved
Hide resolved
netroy
requested changes
Dec 18, 2024
despairblue
force-pushed
the
pay-2376-add-data-property-to-credentials-list-response-try-3
branch
from
9f3a0d6 to
f1c14f6
Compare
netroy
reviewed
Dec 27, 2024
packages/@n8n/api-types/src/dto/credentials/credentials-get-many-request.dto.ts
Outdated
Show resolved
Hide resolved
packages/@n8n/api-types/src/dto/credentials/credentials-get-many-request.dto.ts
Outdated
Show resolved
Hide resolved
packages/@n8n/api-types/src/dto/credentials/credentials-get-many-request.dto.ts
Show resolved
Hide resolved
4 tasks
netroy
reviewed
Dec 30, 2024
netroy
reviewed
Dec 30, 2024
netroy
reviewed
Dec 30, 2024
netroy
previously approved these changes
Dec 30, 2024
There was a problem hiding this comment.
This changes quite a lot of code in CredentialsService, that we should definitely add unit tests for. There are a lot of old and new code branches that have very little protection against regressions.
We should either add those tests in this PR, or create a tech-debt ticket to add unit tests for these.
Comment on lines
+70
to
74
| }: { | ||
| listQueryOptions?: ListQuery.Options & { includeData?: boolean }; | ||
| includeScopes?: boolean; | ||
| includeData?: boolean; | ||
| } = {}, |
There was a problem hiding this comment.
not in this PR, but this could be it's own DTO in the future.
n8n
|
||||||||||||||||||||||||||||
| Project |
n8n
|
| Branch Review |
pay-2376-add-data-property-to-credentials-list-response-try-3
|
| Run status |
|
| Run duration | 04m 42s |
| Commit |
|
| Committer | Danny Martini |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
1
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
484
|
| View all changes introduced in this branch ↗︎ | |
|
✅ All Cypress E2E specs passed |
select is always defined, see condition above
despairblue
force-pushed
the
pay-2376-add-data-property-to-credentials-list-response-try-3
branch
from
3458b67 to
8a1b523
Compare
netroy
reviewed
Dec 30, 2024
netroy
approved these changes
Dec 31, 2024
|
✅ All Cypress E2E specs passed |
despairblue
deleted the
pay-2376-add-data-property-to-credentials-list-response-try-3
branch
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
This allows the FE to find out if a credential has been filled in already or not (empty data property). We want to make use of this to show users all empty credentials after a source control pull operation.
Commits:
GET /credentialsandGET /credentials/:credentialIdincludeDataparameter toGET /credentialsRelated Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/PAY-2376/add-data-property-to-credentials-list-response
Review / Merge checklist
Docs updated or follow-up ticket created.PR Labeled withrelease/backport(if the PR is an urgent fix that needs to be backported)