Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core): Do not save credential overwrites data into the database #13170

Merged
merged 4 commits into from
Feb 10, 2025

Conversation

netroy
Copy link
Member

@netroy netroy commented Feb 10, 2025

Summary

During oauth flows we update the credentials in the DB a few times. At some point we switched to rewriting the credentials data in the DB, with the data including defaults and overwrites.
This PR updated this code to do partial updates and deleted on credentials data to ensure that we only change the relevant parts of the data, and never include that did not come from the user or the 3rd party service.

Related Linear tickets, Github issues, and Community forum posts

CAT-634

Review / Merge checklist

  • PR title and summary are descriptive. (conventions)
  • Docs updated or follow-up ticket created.
  • Tests included.
  • PR Labeled with release/backport (if the PR is an urgent fix that needs to be backported)

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

Attention: Patch coverage is 91.66667% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
.../controllers/oauth/oauth2-credential.controller.ts 85.71% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@n8n-assistant n8n-assistant bot added core Enhancement outside /nodes-base and /editor-ui n8n team Authored by the n8n team labels Feb 10, 2025
tomi
tomi previously approved these changes Feb 10, 2025
Copy link
Collaborator

@tomi tomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Couple minor suggestions. I'll build a custom image of this and test this

packages/core/src/credentials.ts Outdated Show resolved Hide resolved
packages/core/src/credentials.ts Outdated Show resolved Hide resolved
@netroy netroy requested a review from tomi February 10, 2025 15:14
tomi
tomi previously approved these changes Feb 10, 2025
Copy link
Collaborator

@tomi tomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

Copy link
Contributor

⚠️ Some Cypress E2E specs are failing, please fix them before merging

Copy link

cypress bot commented Feb 10, 2025

n8n    Run #9218

Run Properties:  status check passed Passed #9218  •  git commit d96f7b5334: 🌳 🖥️ browsers:node18.12.0-chrome107 🤖 netroy 🗃️ e2e/*
Project n8n
Branch Review CAT-634-do-not-save-credential-overwrites-data-in-db
Run status status check passed Passed #9218
Run duration 04m 35s
Commit git commit d96f7b5334: 🌳 🖥️ browsers:node18.12.0-chrome107 🤖 netroy 🗃️ e2e/*
Committer कारतोफ्फेलस्क्रिप्ट™
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 1
Tests that did not run due to a developer annotating a test with .skip  Pending 5
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 435
View all changes introduced in this branch ↗︎

Copy link
Collaborator

@tomi tomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

Copy link
Contributor

⚠️ Some Cypress E2E specs are failing, please fix them before merging

Copy link
Contributor

✅ All Cypress E2E specs passed

@netroy netroy merged commit 298a7b0 into master Feb 10, 2025
38 checks passed
@netroy netroy deleted the CAT-634-do-not-save-credential-overwrites-data-in-db branch February 10, 2025 16:24
@github-actions github-actions bot mentioned this pull request Feb 13, 2025
@janober
Copy link
Member

janober commented Feb 13, 2025

Got released with [email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Enhancement outside /nodes-base and /editor-ui n8n team Authored by the n8n team Released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants