core icon indicating copy to clipboard operation
core copied to clipboard

Add ability to cache Roborock maps instead of always reloading

Open Lash-L opened this issue 1 year ago • 2 comments

Breaking change

Proposed change

After talking with Paulus, he has multiple maps and the time it takes to startup Roborock is costly (about 40s) because of the nature of how we have to load the images. Now we only have to do that once because they are cached.

lightly relates to #97311 and conversations on caching there.

Type of change

  • [ ] Dependency upgrade
  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New integration (thank you!)
  • [x] New feature (which adds functionality to an existing integration)
  • [ ] Deprecation (breaking change to happen in the future)
  • [ ] 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:

Checklist

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

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

If the code communicates with devices, web services, or third-party tools:

  • [ ] The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • [ ] New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • [ ] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • [ ] Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Lash-L avatar Mar 02 '24 18:03 Lash-L

Hey there @humbertogontijo, mind taking a look at this pull request as it has been labeled with an integration (roborock) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of roborock can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign roborock Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

home-assistant[bot] avatar Mar 02 '24 18:03 home-assistant[bot]

Anything blocking for this? Would love to get it merged in 2024.5 as I have a semi-related issue #108038 and I would like to get this done so I can play around with some other things in image without merge conflicts

Lash-L avatar Apr 22 '24 21:04 Lash-L

With some other features - this MR now adds a bit of complexity that I need feedback on.

We need the rooms for a) the get map info service and b) for the current room sensor #115326

However, if we are getting the result of a map from the cache, then we don't call the original get_rooms. It will update for the currently select room - but not for any maps that aren't selected, as we currently do that when we go through each map.

So I believe I need to cache that as well. Is a text file the ideal way to do that? Or something else - it would essentially just be a dictionary I am saving.

Lash-L avatar May 13 '24 01:05 Lash-L

yeah, you can use our storage helper. create a file <domain>.<config entry ID>.

balloob avatar May 14 '24 20:05 balloob

yeah, you can use our storage helper. create a file <domain>.<config entry ID>.

Marking as draft until i have a chance to do that

Lash-L avatar May 14 '24 20:05 Lash-L

yeah, you can use our storage helper. create a file <domain>.<config entry ID>.

Marking as draft until i have a chance to do that

Finally got around to it. Should be ready for a look over

Lash-L avatar Jul 06 '24 23:07 Lash-L

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

home-assistant[bot] avatar Jul 08 '24 13:07 home-assistant[bot]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes. Thank you for your contribution!

github-actions[bot] avatar Sep 25 '24 20:09 github-actions[bot]