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

Improve group state behavior #116116

Closed
wants to merge 20 commits into from
Closed

Improve group state behavior #116116

wants to merge 20 commits into from

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Apr 24, 2024

Proposed change

Intention is to improve the group state behavior and allow an entity platform to have specific states in case there are more then one on or off states. This prepares for support of lock.open state we want to add. Currently only lock.unlocked is a valid open state.

The PR include the commits of #115866, but this change was reverted. Details of the final behaviour will be added to the PR's documentation

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:

@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 (group) you are listed as a code owner for? Thanks!

Code owner commands

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

@jbouwh jbouwh changed the title Fix group off_on_mapping issue Fix group state mapping issue Apr 24, 2024
@emontnemery
Copy link
Contributor

@jbouwh The PR title is "Fix group off_on_mapping issue", but the description says:

The current code will cause an issue if we need assign on ON state to a OFF state if there are multiple ON states. This was indeed already fixed by #115866. Only the key was still used, not the mapping.

If the issue was fixed by PR #115866, why does it need fixing again?

@jbouwh
Copy link
Contributor Author

jbouwh commented Apr 24, 2024

@jbouwh The PR title is "Fix group off_on_mapping issue", but the description says:

The current code will cause an issue if we need assign on ON state to a OFF state if there are multiple ON states. This was indeed already fixed by #115866. Only the key was still used, not the mapping.

If the issue was fixed by PR #115866, why does it need fixing again?

Title was adjusted. The fix was intended for the lock.on PR #111968 which becomes domain with multiple on states. After all reviews the fix seemed not enough.

@jbouwh jbouwh modified the milestone: 2024.5.0 Apr 24, 2024
@bdraco
Copy link
Member

bdraco commented Apr 25, 2024

For tests, maybe we add a mock platform that has the same issue as #111968 to show the issue is fixed?

@emontnemery emontnemery marked this pull request as draft April 25, 2024 13:46
(vacuum.STATE_RETURNING, vacuum.STATE_CLEANING),
# Only off states, so group state will be off
(vacuum.STATE_PAUSED, vacuum.STATE_IDLE),
(STATE_ON, True),
Copy link
Member

Choose a reason for hiding this comment

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

As written on discord to @jbouwh I don't like this mixin of a generic group state with platform dependent states but probably that's the way this needs to go?

@jbouwh jbouwh changed the title Fix group state mapping issue Improve group state behavior Apr 26, 2024
@jbouwh jbouwh mentioned this pull request Apr 27, 2024
20 tasks
@jbouwh
Copy link
Contributor Author

jbouwh commented Apr 27, 2024

Superseded by #116318

@jbouwh jbouwh closed this Apr 27, 2024
@jbouwh jbouwh deleted the group-fix-off-on-mapping branch April 27, 2024 21:38
@github-actions github-actions bot locked and limited conversation to collaborators Apr 28, 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.

None yet

4 participants