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

Offer to delete no-longer-recorded statistics #21119

Merged

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented Jun 20, 2024

Proposed change

If a user excludes an entity from recording, they probably don't want to keep the historical statistics anymore. Add deleting them as an option to the FIX dialog.

This just replaces one issue with another (entity no longer recorded -> entity not recorded), but at least it cleans up the DB.

Type of change

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

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features
    • Enhanced confirmation dialogs in developer tools with a destructive property to emphasize irreversible actions.
    • Added detailed information in the dialog content for better user guidance.
    • New information text in settings suggesting the option to delete long-term statistics.

Copy link
Contributor

coderabbitai bot commented Jun 20, 2024

Walkthrough

Walkthrough

The changes made improve the user interaction for deleting long-term statistics in a developer tool. Confirmation dialogs for deletions are now marked as destructive for greater clarity and safety. Additionally, extra information and a new function call enhance the dialog box. A new info text has been added to the English translations to inform users about the option to delete long-term statistics.

Changes

Files/Paths Change Summary
src/panels/developer-tools/statistics/... Updated the HaPanelDevStatistics class to use showConfirmationDialog with destructive: true, enhanced dialog content, and added a new function call upon confirmation.
src/translations/en.json Added info_text_4 to provide guidance on deleting long-term statistics.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI as User Interface
    participant HaPanelDevStatistics

    User->>UI: Initiate deletion process
    UI->>HaPanelDevStatistics: Trigger showConfirmationDialog
    HaPanelDevStatistics->>User: Present destructive confirmation dialog
    User-->>HaPanelDevStatistics: Confirm deletion
    HaPanelDevStatistics->>HaPanelDevStatistics: Execute new function call
Loading

In this diagram, the user initiates the deletion process, and the UI triggers the updated showConfirmationDialog from HaPanelDevStatistics, which now includes the destructive property and supplementary information. Upon confirmation, a new function call is executed to complete the process.


Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 8272bef and db9591f.

Files selected for processing (2)
  • src/panels/developer-tools/statistics/developer-tools-statistics.ts (4 hunks)
  • src/translations/en.json (1 hunks)
Additional context used
Biome
src/panels/developer-tools/statistics/developer-tools-statistics.ts

[error] 205-205: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Gitleaks
src/translations/en.json

6503-6504: Identified a HashiCorp Terraform password field, risking unauthorized infrastructure configuration and security breaches. (hashicorp-tf-password)

Additional comments not posted (2)
src/panels/developer-tools/statistics/developer-tools-statistics.ts (1)

Line range hint 318-349: Ensure that the confirmation dialog for deleting statistics only appears if the entity is truly no longer recorded.

This change aligns with the PR's goal to offer deletion of statistics for entities no longer recorded, enhancing user control over their data.

src/translations/en.json (1)

6748-6748: The new informational text is clear and aligns well with the feature's functionality.


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
Contributor

@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: 2

@@ -381,6 +392,7 @@ class HaPanelDevStatistics extends SubscribeMixin(LitElement) {
{ statistic_id: issue.data.statistic_id }
)}`,
confirmText: this.hass.localize("ui.common.delete"),
destructive: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding a confirmation step or additional user input before executing a destructive action.

Providing a secondary confirmation or more detailed user information before proceeding with data deletion can prevent accidental data loss and improve user experience.

@@ -282,6 +282,7 @@
{ statistic_id: issue.data.statistic_id }
)}`,
confirmText: this.hass.localize("ui.common.delete"),
destructive: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid using non-null assertions as they can lead to runtime errors if not properly handled.

-          destructive: true,
+          destructive: this.hass.states[issue.data.statistic_id] != null,

This change ensures that the destructive property is only set to true when the state actually exists, mitigating potential runtime issues.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
destructive: true,
destructive: this.hass.states[issue.data.statistic_id] != null,

@bramkragten bramkragten merged commit 9960d38 into home-assistant:dev Jun 21, 2024
13 checks passed
@karwosts karwosts deleted the delete-stats-no-longer-recorded branch June 21, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants