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

Add list_orphaned_database_entities service #752

Merged
merged 5 commits into from
Aug 6, 2024

Conversation

gieljnssns
Copy link
Contributor

@gieljnssns gieljnssns commented May 7, 2024

Description

I have added a service to list all entities that are in your database and not in Home-Assistant anymore.
If you are open to this PR, I will write some documentation for this.

Motivation and Context

When you disable or delete an entity in HA they do not get removed from your database.
So after some time your can free some space in your database

How has this been tested?

I have tested this in the devcontainer.
When I disable some entities and then run this service, the disabled entities get returned as a serviceresponse.
Then you can use this response to recorder.puge_entities, keep_days: 0 to remove them from your database.

Screenshots (if appropriate):

Scherm­afbeelding 2024-05-07 om 09 36 43
Scherm­afbeelding 2024-05-07 om 09 37 06
Scherm­afbeelding 2024-05-07 om 09 37 21
Scherm­afbeelding 2024-05-07 om 09 37 54
Scherm­afbeelding 2024-05-07 om 09 38 12

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@gieljnssns
Copy link
Contributor Author

Sorry to ask, but how can I pass the label check?

@gieljnssns gieljnssns force-pushed the list_orphaned_database_entities branch from c615e08 to 9cc7d7e Compare May 14, 2024 15:28
@frenck
Copy link
Owner

frenck commented May 18, 2024

@coderabbitai review

Copy link

coderabbitai bot commented May 18, 2024

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

coderabbitai bot commented May 18, 2024

Warning

Rate limit exceeded

@frenck has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 16 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 7f34830 and bf135e4.

Walkthrough

Walkthrough

The update brings a new feature to the spook custom component for Home Assistant, allowing users to detect orphaned database entities. This enhancement improves entity management by providing a service to efficiently list and potentially clean up unused entities.

Changes

Files/Paths Change Summary
spook custom component Introduces a service to list orphaned database entities by comparing with current entity IDs.
custom_components/spook/services.yaml Adds services for deleting all orphaned entities and listing orphaned database entities.
documentation/core_extensions.md Expands documentation to cover the new feature for listing orphaned database entities.
documentation/entities.md Adds details about the newly added homeassistant.list_orphaned_database_entities service.

🐇
In the realm of Home Assistant's domain,
Orphaned entities no longer in vain.
Spook emerges, with spectral might,
To reveal them, shining light.
With code and prose, a dance so great,
A tidier abode, a cleaner slate.
👻


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.

@frenck frenck added the new-feature New features or options. label May 18, 2024
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: 4

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 922ea02 and 9cc7d7e.
Files ignored due to path filters (1)
  • documentation/images/entities/list_orphaned_database_entities.png is excluded by !**/*.png
Files selected for processing (4)
  • custom_components/spook/ectoplasms/homeassistant/services/list_orphaned_database_entities.py (1 hunks)
  • custom_components/spook/services.yaml (1 hunks)
  • documentation/core_extensions.md (1 hunks)
  • documentation/entities.md (1 hunks)
Additional Context Used
LanguageTool (5)
documentation/core_extensions.md (2)

Near line 37: Consider using a different adverb to strengthen your wording.
Context: ...rvices. You can even dynamically create completely new areas on the fly. ::: :::{card} D...


Near line 59: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 1618 characters long)
Context: ... more](misc.md) But wait! There is more! If it doesn't fit in any of the above, ...

documentation/entities.md (3)

Near line 144: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...an be particularly useful when you have a lot of entities, and you want to hide some of ...


Near line 369: Possible missing preposition found.
Context: ...ll_orphaned_entities ``` ::: ### List all orphaned database entities Mass clean ...


Near line 446: This expression usually appears with a “please” in front of it.
Context: ...ty, or repairs detection; feel free to [let us know in our discussion forums](https://githu...

Additional comments not posted (2)
custom_components/spook/ectoplasms/homeassistant/services/list_orphaned_database_entities.py (2)

32-33: Ensure the SQL query is optimized for performance, especially if the states_meta table is large.


44-47: Ensure the response format aligns with the expected structure in the Home Assistant frontend.

documentation/core_extensions.md Outdated Show resolved Hide resolved
custom_components/spook/services.yaml Outdated Show resolved Hide resolved
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: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 9cc7d7e and 7f34830.
Files selected for processing (4)
  • custom_components/spook/ectoplasms/homeassistant/services/list_orphaned_database_entities.py (1 hunks)
  • custom_components/spook/services.yaml (1 hunks)
  • documentation/core_extensions.md (1 hunks)
  • documentation/entities.md (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • custom_components/spook/ectoplasms/homeassistant/services/list_orphaned_database_entities.py
  • custom_components/spook/services.yaml
Additional Context Used
LanguageTool (6)
documentation/core_extensions.md (3)

Near line 15: Possible missing comma found.
Context: ... on the fly. Enable/disable polling for updates or ignore all discovered integrations. ...


Near line 37: Consider using a different adverb to strengthen your wording.
Context: ...rvices. You can even dynamically create completely new areas on the fly. ::: :::{card} D...


Near line 59: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 1567 characters long)
Context: ... more](misc.md) But wait! There is more! If it doesn't fit in any of the above, ...

documentation/entities.md (3)

Near line 144: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...an be particularly useful when you have a lot of entities, and you want to hide some of ...


Near line 369: Possible missing preposition found.
Context: ...ll_orphaned_entities ``` ::: ### List all orphaned database entities Mass clean ...


Near line 446: This expression usually appears with a “please” in front of it.
Context: ...ty, or repairs detection; feel free to [let us know in our discussion forums](https://githu...

documentation/core_extensions.md Show resolved Hide resolved
documentation/entities.md Show resolved Hide resolved
Copy link

sonarcloud bot commented Jun 13, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
12.3% Duplication on New Code

See analysis details on SonarCloud

documentation/entities.md Outdated Show resolved Hide resolved
documentation/entities.md Outdated Show resolved Hide resolved
@frenck frenck force-pushed the list_orphaned_database_entities branch from 8d8dd7b to bf135e4 Compare August 6, 2024 16:52
Copy link

sonarcloud bot commented Aug 6, 2024

@frenck
Copy link
Owner

frenck commented Aug 6, 2024

Thanks, @gieljnssns 👍

../Frenck

@frenck frenck merged commit f8f0335 into frenck:main Aug 6, 2024
6 checks passed
@gieljnssns gieljnssns deleted the list_orphaned_database_entities branch August 6, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature New features or options.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants