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

Fix last_reported_timestamp not being updated when last_reported is changed #118341

Merged
merged 6 commits into from
May 29, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented May 29, 2024

Proposed change

When a state is created, last_update is always the same as last_reported, and we only update it later if it changes so we can pre-set the cached property to avoid it being run when the recorder accesses it later.

There was a bug here where if last_reported_timestamp had been called, and than last_reported was updated, last_reported_timestamp would report the cached value. This has been fixed.

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:

Checklist

  • 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.

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:

When a state is created, last_update is always the same
as last_reported, and we only update it later if it changes
so we can pre-set the cached property to avoid it being
run when the recorder accesses it later.
@bdraco bdraco requested a review from a team as a code owner May 29, 2024 01:58
@@ -2282,6 +2287,7 @@ def async_set(
# mypy does not understand this is only possible if old_state is not None
old_last_reported = old_state.last_reported # type: ignore[union-attr]
old_state.last_reported = now # type: ignore[union-attr]
old_state.last_reported_timestamp = timestamp # type: ignore[union-attr]
Copy link
Member Author

Choose a reason for hiding this comment

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

This was actually a bug, but it went unnoticed before because it worked the first time

@bdraco bdraco changed the title Reduce number of calls to last_reported_timestamp Fix last_reported_timestamp not being updated when last_reported is changed May 29, 2024
@bdraco
Copy link
Member Author

bdraco commented May 29, 2024

@coderabbitai review

Copy link

coderabbitai bot commented May 29, 2024

Walkthrough

The recent changes in the Home Assistant core involve refining timestamp management within the Core class. Specifically, the __init__ and async_set methods were updated to handle last_updated_timestamp, last_changed_timestamp, and last_reported_timestamp more accurately. Additionally, a new test function was introduced to ensure the async_set method correctly updates the last_reported and last_reported_timestamp properties.

Changes

File Path Change Summary
homeassistant/core.py Updated __init__ and async_set methods to refine timestamp handling.
tests/test_core.py Added test_async_set_updates_last_reported to verify timestamp updates.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant HomeAssistant as Home Assistant
    participant Core

    User->>HomeAssistant: Initialize Core
    HomeAssistant->>Core: __init__ method
    Core-->>HomeAssistant: Set initial timestamps

    User->>HomeAssistant: Update state
    HomeAssistant->>Core: async_set method
    Core-->>HomeAssistant: Update last_reported and last_reported_timestamp
Loading

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 Configration 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.

@bdraco
Copy link
Member Author

bdraco commented May 29, 2024

Something is broken at github today. It keeps showing that I cancelled the test runs but I haven't

@bdraco
Copy link
Member Author

bdraco commented May 29, 2024

And github just started over again running the PR....

@bdraco
Copy link
Member Author

bdraco commented May 29, 2024

doing another run in #118348 to verify this is a github issue

@bdraco bdraco merged commit 76aa504 into dev May 29, 2024
67 of 69 checks passed
@bdraco bdraco deleted the last_reported_is_always_same_init branch May 29, 2024 05:03
raman325 added a commit to raman325/home-assistant that referenced this pull request May 29, 2024
* dev: (751 commits)
  Use runtime_data in ping (home-assistant#118332)
  Fix last_reported_timestamp not being updated when last_reported is changed (home-assistant#118341)
  Replace pop calls with del where the result is discarded in restore_state (home-assistant#118339)
  Improve websocket message coalescing to handle thundering herds better (home-assistant#118268)
  Add cache to more complex entity filters (home-assistant#118344)
  Reduce the intent response data sent to LLMs (home-assistant#118346)
  Small speed up to connecting dispatchers (home-assistant#118342)
  Tweak Assist LLM API prompt (home-assistant#118343)
  Add Conversation command to timers (home-assistant#118325)
  LLM Assist API to ignore intents if not needed for exposed entities or calling device (home-assistant#118283)
  Replace pop calls with del where the result is discarded in entity (home-assistant#118340)
  Replace pop calls with del where the result is discarded in mqtt (home-assistant#118338)
  Use del instead of pop in the entity platform remove (home-assistant#118337)
  Update the recommended model for Google Gen AI (home-assistant#118323)
  Fix source_change not triggering an update (home-assistant#118312)
  Several fixes for the Matter climate platform (home-assistant#118322)
  Use None default for traccar server battery level sensor (home-assistant#118324)
  [esphome] 100% voice assistant test coverage (home-assistant#118334)
  Mark sonos group update a background task (home-assistant#118333)
  Filter timers more when pausing/unpausing (home-assistant#118331)
  ...
raman325 added a commit to raman325/home-assistant that referenced this pull request May 29, 2024
* dev: (8244 commits)
  Update zwave_js WS APIs for provisioning (home-assistant#117400)
  Add OSO Energy binary sensors (home-assistant#117174)
  Add august open action (home-assistant#113795)
  Add smoke detector temperature to Yale Smart Alarm (home-assistant#116306)
  Don't report entities with invalid unique id when loading the entity registry (home-assistant#118290)
  Fix epic_games_store mystery game URL (home-assistant#118314)
  Use runtime_data in ping (home-assistant#118332)
  Fix last_reported_timestamp not being updated when last_reported is changed (home-assistant#118341)
  Replace pop calls with del where the result is discarded in restore_state (home-assistant#118339)
  Improve websocket message coalescing to handle thundering herds better (home-assistant#118268)
  Add cache to more complex entity filters (home-assistant#118344)
  Reduce the intent response data sent to LLMs (home-assistant#118346)
  Small speed up to connecting dispatchers (home-assistant#118342)
  Tweak Assist LLM API prompt (home-assistant#118343)
  Add Conversation command to timers (home-assistant#118325)
  LLM Assist API to ignore intents if not needed for exposed entities or calling device (home-assistant#118283)
  Replace pop calls with del where the result is discarded in entity (home-assistant#118340)
  Replace pop calls with del where the result is discarded in mqtt (home-assistant#118338)
  Use del instead of pop in the entity platform remove (home-assistant#118337)
  Update the recommended model for Google Gen AI (home-assistant#118323)
  ...
raman325 added a commit to raman325/home-assistant that referenced this pull request May 29, 2024
* dev: (1785 commits)
  Update zwave_js WS APIs for provisioning (home-assistant#117400)
  Add OSO Energy binary sensors (home-assistant#117174)
  Add august open action (home-assistant#113795)
  Add smoke detector temperature to Yale Smart Alarm (home-assistant#116306)
  Don't report entities with invalid unique id when loading the entity registry (home-assistant#118290)
  Fix epic_games_store mystery game URL (home-assistant#118314)
  Use runtime_data in ping (home-assistant#118332)
  Fix last_reported_timestamp not being updated when last_reported is changed (home-assistant#118341)
  Replace pop calls with del where the result is discarded in restore_state (home-assistant#118339)
  Improve websocket message coalescing to handle thundering herds better (home-assistant#118268)
  Add cache to more complex entity filters (home-assistant#118344)
  Reduce the intent response data sent to LLMs (home-assistant#118346)
  Small speed up to connecting dispatchers (home-assistant#118342)
  Tweak Assist LLM API prompt (home-assistant#118343)
  Add Conversation command to timers (home-assistant#118325)
  LLM Assist API to ignore intents if not needed for exposed entities or calling device (home-assistant#118283)
  Replace pop calls with del where the result is discarded in entity (home-assistant#118340)
  Replace pop calls with del where the result is discarded in mqtt (home-assistant#118338)
  Use del instead of pop in the entity platform remove (home-assistant#118337)
  Update the recommended model for Google Gen AI (home-assistant#118323)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators May 30, 2024
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.

2 participants