core Fix spikes caused by incorrect queue order in statistics integration

Breaking change

Proposed change

Fix bug that causes spikes in time-based average functions in the statistics module.

Type of change

[ ] Dependency upgrade
[x] 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

There is a bug in the current implementation that creates spikes with unreasonable values for time-based statistics functions (averages). This is cause by a race condition, where new values are pushed into an internal queue before the history could be loaded and added. This breaks the order of the queue, which is supposed to be sorted by time, which leads to the incorrect averages.

This PR fixes or closes issue: fixes #119738 #98262 #67627
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:

[ ] Documentation added/updated for www.home-assistant.io

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.

To help with the load of incoming pull requests:

[x] I have reviewed two other open pull requests in this repository.

Oct 02 '24 08:10 unfug-at-github

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

Code owner commands

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

Oct 02 '24 08:10 home-assistant[bot]

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.

Oct 02 '24 12:10 home-assistant[bot]

@joostlek: Is there anything else I need to do to get this going?

Oct 09 '24 05:10 unfug-at-github

I provided a different solution to the same issues that fixes the race conditions in general #128796

Oct 19 '24 18:10 unfug-at-github