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

Limit rainbird aiohttp client session to a single connection #112146

Merged
merged 1 commit into from Mar 4, 2024

Conversation

allenporter
Copy link
Contributor

@allenporter allenporter commented Mar 3, 2024

Proposed change

Limit rainbird aiohttp client session to a single connection so that any concurrent requests are queued rather than issued in parallel. This should fix any issues with rainbird stability due to concurrent requests either from the data coordinator, UI, or automations.

Manually tested:

  • Without this change: If you spam the sprinkler switch on and off over and over again it will fail with an error due to the device being busy
  • With the change: If you spam the sprinkler switch on and off over and over again it always succeeds.

Additionally manually tested config flows, adding and removing/disabling the config entries, etc and verifying all connections are closed properly.

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

  • 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

home-assistant bot commented Mar 3, 2024

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

Code owner commands

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

@balloob balloob merged commit 5cb5a11 into home-assistant:dev Mar 4, 2024
22 of 23 checks passed
@@ -36,9 +35,11 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:

hass.data.setdefault(DOMAIN, {})

clientsession = async_create_clientsession()
entry.async_on_unload(clientsession.close)
Copy link
Member

Choose a reason for hiding this comment

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

Probably close the session on Home Assistant stop too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I considered this, but intentionally left this out because it seemed like a lot of code with unclear benefit to me. I think it makes sense for a connection pool with thousands of connections, but for a single connection it seemed fine to just wait for unload? I've sent PR #112292 however since you've asked for it.

Copy link
Member

Choose a reason for hiding this comment

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

What do you mean "to just wait for unload"?

@balloob balloob added this to the 2024.3.0 milestone Mar 4, 2024
balloob pushed a commit that referenced this pull request Mar 4, 2024
Limit rainbird to a single open http connection
@github-actions github-actions bot locked and limited conversation to collaborators Mar 6, 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.

Rainbird integration is loosing connection when switches are used in automation
3 participants