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

Add a guard against selecting all entities in state_changes_during_period #91585

Merged
merged 1 commit into from
Apr 18, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Apr 18, 2023

Proposed change

If an entity id that doesn't exist was passed to state_changes_during_period we would return history for all entities during the period because the filter would not be applied. In some cases this could be 100000 of rows.

It was too easy to accidentally select all entity ids which is exactly what is happening here.

This cannot happen in dev/2023.5.x because we require entity ids after #90992 because we were worried about this case. The change in dev is not back-portable so this PR is to rc

In the report below, a history stats sensor for a non-existent entity id is what triggered the issue
https://discord.com/channels/330944238910963714/332167321311510530/1097789540657266758

We have tests for this case in dev that were added as part of #90992 but thats not in 2023.4.x The tests can't be backported because the design has changed.

This is effectively

for rc

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 Black (black --fast 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:

…riod

This cannot happen in `dev` because we require entity ids
@bdraco bdraco requested a review from a team as a code owner April 18, 2023 07:51
@home-assistant home-assistant bot added bugfix cla-signed core integration: recorder merging-to-rc This PR is merging into the RC branch and should probably change the branch to `dev`. small-pr PRs with less than 30 lines. Quality Scale: internal labels Apr 18, 2023
@home-assistant
Copy link

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

Code owner commands

Code owners of recorder 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 recorder Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@bdraco bdraco added this to the 2023.4.6 milestone Apr 18, 2023
@balloob balloob merged commit 03c517b into rc Apr 18, 2023
@balloob balloob deleted the guard_selecting_all_entities branch April 18, 2023 13:26
@github-actions github-actions bot locked and limited conversation to collaborators Apr 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bugfix cherry-picked cla-signed core integration: recorder merging-to-rc This PR is merging into the RC branch and should probably change the branch to `dev`. Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants