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

Remember hidden detailed energy device statistics #21406

Merged
merged 2 commits into from
Jul 19, 2024

Conversation

jpbede
Copy link
Member

@jpbede jpbede commented Jul 16, 2024

Proposed change

If the statistics of an individual device was hidden on the energy dashboard, this filter is currently reset when the page is reloaded.

This PR now stores the hidden statistics in the local storage to survive a page reload.

Bildschirmaufnahme.2024-07-16.um.08.19.45.mov

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

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

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
    • Improved management of hidden statistics in the energy devices detail graph card, providing a more consistent user experience with state persistence.

Copy link
Contributor

coderabbitai bot commented Jul 16, 2024

Walkthrough

Walkthrough

The changes introduce a storage decorator for the _hiddenStats property in the HuiEnergyDevicesDetailGraphCard component, enabling automatic state persistence and management of hidden statistics. This enhances functionality by allowing hidden stats to be retained across sessions. The _datasetHidden and _datasetUnhidden methods are updated to work with the new array-based structure, ensuring efficient updates and retrieval of hidden stats during rendering.

Changes

File Path Change Summary
src/panels/lovelace/cards/energy/hui-energy-devices-detail-graph-card.ts Introduced a storage decorator for _hiddenStats, updated its type from Set<string> to string[], and modified the logic in _datasetHidden and _datasetUnhidden methods to utilize the new array structure for managing hidden statistics.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HuiEnergyDevicesDetailGraphCard
    participant StorageManager

    User ->> HuiEnergyDevicesDetailGraphCard: Hide Dataset
    HuiEnergyDevicesDetailGraphCard ->> StorageManager: Update _hiddenStats
    StorageManager -->> HuiEnergyDevicesDetailGraphCard: Persist Change
    HuiEnergyDevicesDetailGraphCard -->> User: Update Visuals

    User ->> HuiEnergyDevicesDetailGraphCard: Unhide Dataset
    HuiEnergyDevicesDetailGraphCard ->> StorageManager: Update _hiddenStats
    StorageManager -->> HuiEnergyDevicesDetailGraphCard: Persist Change
    HuiEnergyDevicesDetailGraphCard -->> User: Update Visuals
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b9b13b0 and 98cd641.

Files selected for processing (1)
  • src/panels/lovelace/cards/energy/hui-energy-devices-detail-graph-card.ts (4 hunks)
Additional comments not posted (4)
src/panels/lovelace/cards/energy/hui-energy-devices-detail-graph-card.ts (4)

68-73: LGTM! Storage decorator is correctly defined and applied.

The storage decorator is well-configured to persist the _hiddenStats property.


159-162: LGTM! _datasetUnhidden method correctly updates _hiddenStats.

The method correctly filters the _hiddenStats array to remove the specified statistic.


349-349: LGTM! _processDataSet method correctly uses includes to check hidden statistics.

The method correctly uses the includes method to check if a statistic is hidden.


152-155: Ensure no duplicates in _hiddenStats.

The method _datasetHidden currently adds statistics directly to _hiddenStats. Consider checking for duplicates before adding to prevent the same stat from being hidden multiple times.

- this._hiddenStats = [...this._hiddenStats, this._data!.prefs.device_consumption[ev.detail.index].stat_consumption];
+ if (!this._hiddenStats.includes(this._data!.prefs.device_consumption[ev.detail.index].stat_consumption)) {
+   this._hiddenStats = [...this._hiddenStats, this._data!.prefs.device_consumption[ev.detail.index].stat_consumption];
+ }

Likely invalid or redundant comment.


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 Configuration 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: 1

Comment on lines +152 to +155
this._hiddenStats = [
...this._hiddenStats,
this._data!.prefs.device_consumption[ev.detail.index].stat_consumption,
];
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure no duplicates in _hiddenStats.

The method _datasetHidden currently adds statistics directly to _hiddenStats. Consider checking for duplicates before adding to prevent the same stat from being hidden multiple times.

- this._hiddenStats = [...this._hiddenStats, this._data!.prefs.device_consumption[ev.detail.index].stat_consumption];
+ if (!this._hiddenStats.includes(this._data!.prefs.device_consumption[ev.detail.index].stat_consumption)) {
+   this._hiddenStats = [...this._hiddenStats, this._data!.prefs.device_consumption[ev.detail.index].stat_consumption];
+ }
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
this._hiddenStats = [
...this._hiddenStats,
this._data!.prefs.device_consumption[ev.detail.index].stat_consumption,
];
if (!this._hiddenStats.includes(this._data!.prefs.device_consumption[ev.detail.index].stat_consumption)) {
this._hiddenStats = [
...this._hiddenStats,
this._data!.prefs.device_consumption[ev.detail.index].stat_consumption,
];
}

@storage({
key: "energy-devices-hidden-stats",
state: true,
subscribe: true,
Copy link
Member

Choose a reason for hiding this comment

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

subscribe means that it will change in all browser tabs if it is changed in 1 tab, is that really what we want here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Right, does not really make sense here

@bramkragten bramkragten merged commit 1749725 into home-assistant:dev Jul 19, 2024
13 checks passed
@jpbede jpbede deleted the remember-hidden-energy-devices branch July 19, 2024 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants