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(oauth): Handle updates to the OAuth config #31777

Merged
merged 4 commits into from
Jan 10, 2025

Conversation

Vitor-Avila
Copy link
Contributor

@Vitor-Avila Vitor-Avila commented Jan 10, 2025

SUMMARY

The masked_encrypted_extra value is passed as a string during the database update API call. The code was currently throwing an error when trying to .get() a key from it (as it wasn't loaded as a dict).

This PR fixes this issue, and also perform a few modifications:

  • Avoids validating OAuth changes if masked_encrypted_extra is not part of the API payload.
  • Purges OAuth tokens in case the connection configuration is removed.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

No UI changes.

TESTING INSTRUCTIONS

Unit tests added.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Description by Korbit AI

What change is being made?

Enhance the handling of OAuth2 updates in the database update command to properly manage encrypted_extra masking and ensure personal OAuth2 tokens are purged when necessary, including added unit tests for these changes.

Why are these changes being made?

These changes improve the robustness of database updates involving OAuth2 configurations by accurately unmasking encrypted_extra, ensuring existing tokens are purged when changes occur, and adding comprehensive tests to prevent regression. This approach ensures that personal tokens remain valid according to the latest configuration, enhancing security and maintaining updated permissions.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

@dosubot dosubot bot added the authentication Related to authentication label Jan 10, 2025
@Vitor-Avila Vitor-Avila changed the title Fix/handle oauth updates fix(OAuth): Handle updates to the OAuth config Jan 10, 2025
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

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

I've completed my review and didn't find any issues.

Files scanned
File Path Reviewed
superset/commands/database/update.py

Explore our documentation to understand the languages and file types we support and the files we ignore.

Need a new review? Comment /korbit-review on this PR and I'll review your latest changes.

Korbit Guide: Usage and Customization

Interacting with Korbit

  • You can manually ask Korbit to review your PR using the /korbit-review command in a comment at the root of your PR.
  • You can ask Korbit to generate a new PR description using the /korbit-generate-pr-description command in any comment on your PR.
  • Too many Korbit comments? I can resolve all my comment threads if you use the /korbit-resolve command in any comment on your PR.
  • Chat with Korbit on issues we post by tagging @korbit-ai in your reply.
  • Help train Korbit to improve your reviews by giving a 👍 or 👎 on the comments Korbit posts.

Customizing Korbit

  • Check out our docs on how you can make Korbit work best for you and your team.
  • Customize Korbit for your organization through the Korbit Console.

Current Korbit Configuration

General Settings
Setting Value
Review Schedule Automatic excluding drafts
Max Issue Count 10
Automatic PR Descriptions
Issue Categories
Category Enabled
Naming
Database Operations
Documentation
Logging
Error Handling
Systems and Environment
Objects and Data Structures
Readability and Maintainability
Asynchronous Processing
Design Patterns
Third-Party Libraries
Performance
Security
Functionality

Feedback and Support

Note

Korbit Pro is free for open source projects 🎉

Looking to add Korbit to your team? Get started with a free 2 week trial here

@Vitor-Avila Vitor-Avila changed the title fix(OAuth): Handle updates to the OAuth config fix: Handle updates to the OAuth config Jan 10, 2025
@Vitor-Avila Vitor-Avila changed the title fix: Handle updates to the OAuth config fix(oauth): Handle updates to the OAuth config Jan 10, 2025
@Antonio-RiveroMartnez Antonio-RiveroMartnez changed the title fix(oauth): Handle updates to the OAuth config fix(oauth): Handle updates to the OAuth config Jan 10, 2025
Copy link
Member

@betodealmeida betodealmeida left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this!

@Vitor-Avila Vitor-Avila force-pushed the fix/handle-oauth-updates branch from a6ca9fd to b3b70ae Compare January 10, 2025 18:18
@Vitor-Avila Vitor-Avila merged commit 41ed37a into master Jan 10, 2025
42 checks passed
@sadpandajoe sadpandajoe deleted the fix/handle-oauth-updates branch January 10, 2025 19:03
hainenber pushed a commit to hainenber/superset that referenced this pull request Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication Related to authentication size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants