Skip to content

Keep add-on update entity in progress across post-install refresh#168756

Merged
MartinHjelmare merged 2 commits into
devfrom
improve-apps-update-entity
Apr 24, 2026
Merged

Keep add-on update entity in progress across post-install refresh#168756
MartinHjelmare merged 2 commits into
devfrom
improve-apps-update-entity

Conversation

@agners
Copy link
Copy Markdown
Member

@agners agners commented Apr 22, 2026

Breaking change

Proposed change

Supervisor emits the addon_manager_update job done=True WebSocket event a few milliseconds before /store/addons/<slug>/update returns. Clearing _attr_in_progress on that event while the coordinator data still holds the pre-update version caused the UI to briefly flip back to "Update available" before async_install could refresh the coordinator.

Mirror the pattern already used by the Supervisor update entity: snapshot the pre-install version, set _update_ongoing, and clear it only once the coordinator confirms a new installed_version. in_progress OR-combines the ongoing flag with the job-driven _attr_in_progress, so the installing state survives both the WS done event and the base UpdateEntity reset.

This PR is similar to my previous improvement to the Supervisor update entity in #168712, however the window between installation and coordinator data refresh is much narrower.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • 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:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Supervisor emits the `addon_manager_update` job `done=True` WebSocket event
a few milliseconds before `/store/addons/<slug>/update` returns. Clearing
`_attr_in_progress` on that event while the coordinator data still holds
the pre-update version caused the UI to briefly flip back to
"Update available" before `async_install` could refresh the coordinator.

Mirror the pattern already used by the Supervisor update entity: snapshot
the pre-install version, set `_update_ongoing`, and clear it only once the
coordinator confirms a new `installed_version`. `in_progress` OR-combines
the ongoing flag with the job-driven `_attr_in_progress`, so the installing
state survives both the WS done event and the base `UpdateEntity` reset.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @home-assistant/supervisor, mind taking a look at this pull request as it has been labeled with an integration (hassio) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of hassio can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign hassio Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adjusts the Hass.io add-on update entity so the UI “installing” state remains active until the add-ons coordinator refresh confirms the installed version changed, preventing a brief regression to “Update available” when the Supervisor job WS event marks done=True slightly before the HTTP update call returns.

Changes:

  • Add _update_ongoing + _version_before_update tracking to SupervisorAddonUpdateEntity and combine it into the in_progress property.
  • Clear the ongoing flag only when coordinator data shows the installed version differs from the pre-install snapshot.
  • Add tests covering “done=True mid-install” and “installed version changed but latest changed too” scenarios.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
homeassistant/components/hassio/update.py Keeps add-on update in_progress true across WS job completion and until coordinator refresh reflects the new installed version.
tests/components/hassio/test_update.py Adds regression tests to ensure in_progress persists until refresh and clears on any installed-version change.

Comment thread homeassistant/components/hassio/update.py
If a WS progress event has already bumped _attr_update_percentage before
update_addon raises, the entity would otherwise keep showing a stale
percentage after _attr_in_progress has been reset.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@MartinHjelmare MartinHjelmare merged commit a19aebe into dev Apr 24, 2026
48 checks passed
@MartinHjelmare MartinHjelmare deleted the improve-apps-update-entity branch April 24, 2026 16:09
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 25, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants