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 uninstall of add-on on fixup #5142

Merged
merged 1 commit into from
Jun 21, 2024
Merged

Fix uninstall of add-on on fixup #5142

merged 1 commit into from
Jun 21, 2024

Conversation

agners
Copy link
Member

@agners agners commented Jun 21, 2024

Proposed change

The fixup for add-on uninstall was not working correctly. This PR fixes the issue by passing the correct arguments to the uninstall method of the add-on. Conservatively set the remove_config to False, to avoid accidentially deleting valuable user data.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

Summary by CodeRabbit

  • Bug Fixes
    • Fixed an issue where the addon uninstallation did not preserve configuration settings. Addon uninstallation now keeps the configuration by default.

The fixup for add-on uninstall was not working correctly. This PR fixes
the issue by passing the correct arguments to the `uninstall` method of
the add-on. Conservatively set the remove_config to False, to avoid
accidentially deleting valuable user data.
@agners agners added the bugfix A bug fix label Jun 21, 2024
Copy link

coderabbitai bot commented Jun 21, 2024

Walkthrough

Walkthrough

This update focuses on enhancing the uninstall process of an add-on by introducing a new remove_config parameter to the uninstall method. The addition of this parameter, with a default value of False, allows for more controlled removal of configurations during the uninstallation.

Changes

File Change Summary
supervisor/resolution/fixups/addon_execute_remove.py Modified the uninstall method call to include remove_config=False.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant Addon
    User->>System: process_fixup(reference)
    System->>Addon: uninstall(remove_config=False)
    Addon-->>System: Confirmation of uninstallation
    System-->>User: Fixup process completed

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 4829eb8 and ccbdf5b.

Files selected for processing (1)
  • supervisor/resolution/fixups/addon_execute_remove.py (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

LGTM 👍

../Frenck

@frenck frenck merged commit b0cdb91 into main Jun 21, 2024
20 checks passed
@frenck frenck deleted the fix-addon-uninstall-fixup branch June 21, 2024 06:54
@github-actions github-actions bot locked and limited conversation to collaborators Jun 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants