Skip to content

Fix utility meter next_reset shifting forward on entity rename#170957

Merged
balloob merged 3 commits into
devfrom
frenck-2026-0556
May 17, 2026
Merged

Fix utility meter next_reset shifting forward on entity rename#170957
balloob merged 3 commits into
devfrom
frenck-2026-0556

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented May 17, 2026

Proposed change

When a utility meter entity is renamed (or otherwise restored), next_reset shifts forward by one period. This happens because _program_reset() was called before state restoration in async_added_to_hass, so the CronSim scheduler started from now() instead of from the restored last_reset. Any reset that should have occurred between last_reset and now() was silently skipped.

The fix moves _program_reset() to after state restoration and reconfigures the scheduler from the restored last_reset when available. This ensures the scheduler picks up any missed resets (which then fire as catch-ups) rather than skipping them.

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

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:

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 17, 2026 09:34
@frenck frenck requested a review from dgomes as a code owner May 17, 2026 09:34
@home-assistant home-assistant Bot added bugfix cla-signed has-tests integration: utility_meter small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage labels May 17, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

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

Code owner commands

Code owners of utility_meter 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 utility_meter 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.

@frenck frenck added this to the 2026.5.3 milestone May 17, 2026
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

Fixes a bug where renaming (or otherwise restoring) a utility meter entity caused next_reset to skip forward by one period because the cron scheduler was programmed before state restoration, starting from now() and missing the catch-up reset between last_reset and now().

Changes:

  • _config_scheduler now accepts an optional start_time argument and uses it as the CronSim anchor when provided.
  • In async_added_to_hass, _program_reset() is moved to after state restoration, and the scheduler is reconfigured from the restored last_reset so missed resets fire as catch-ups.
  • Adds a regression test verifying that after restore with a stale last_reset, the meter performs the missed reset.

Reviewed changes

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

File Description
homeassistant/components/utility_meter/sensor.py Reorder scheduler programming after restore and anchor scheduler at restored last_reset.
tests/components/utility_meter/test_sensor.py New test asserting last_reset advances on restore when a reset was missed.

Comment thread homeassistant/components/utility_meter/sensor.py Outdated
@frenck frenck marked this pull request as draft May 17, 2026 09:40
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@frenck frenck marked this pull request as ready for review May 17, 2026 10:12
Copilot AI review requested due to automatic review settings May 17, 2026 10:12
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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

Comment thread homeassistant/components/utility_meter/sensor.py Outdated
Comment thread homeassistant/components/utility_meter/sensor.py
Comment thread tests/components/utility_meter/test_sensor.py Outdated
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

Looks good. Somewhat surprised that we serialize decimal that way but it is what it is.

@balloob balloob merged commit ff7964b into dev May 17, 2026
33 checks passed
@balloob balloob deleted the frenck-2026-0556 branch May 17, 2026 14:31
Copilot AI pushed a commit to AlCalzone/homeassistant-core that referenced this pull request May 17, 2026
…assistant#170957)

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: AlCalzone <17641229+AlCalzone@users.noreply.github.com>
@github-actions github-actions Bot locked and limited conversation to collaborators May 18, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bugfix cherry-picked cla-signed has-tests integration: utility_meter Quality Scale: internal small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Utility meter next_reset shifts after entity ID rename

5 participants