Skip to content

Ensure response is fully read to prevent premature connection closure in rest command #148532

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 11, 2025
Merged

Ensure response is fully read to prevent premature connection closure in rest command #148532

merged 2 commits into from
Jul 11, 2025

Conversation

@jpbede
Copy link
Member

@jpbede jpbede commented Jul 10, 2025

Proposed change

Ensure that we read the response fully to prevent premature connection closure. Some servers do not like when the connection is already closed when still sending data. Currently this a race condition and full relay on the network and system to work or not.

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.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings July 10, 2025 06:26
@jpbede jpbede added this to the 2025.7.2 milestone Jul 10, 2025
Copilot AI reviewed Jul 10, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR ensures that the HTTP response body is fully drained before closing the connection when return_response is false, preventing premature connection closure on some servers.

  • Adds an unconditional await response.read() when not returning the service response
  • Includes comments explaining why the response must be fully read
Comments suppressed due to low confidence (1)

homeassistant/components/rest_command/init.py:183

  • No tests have been added to verify that the response body is fully drained when return_response is false. Consider adding a test that simulates a streaming response and asserts that response.read() is invoked to drain the body.
                        await response.read()

@jpbede jpbede marked this pull request as draft July 10, 2025 06:34
@jpbede jpbede marked this pull request as ready for review July 10, 2025 07:14
elupus
elupus approved these changes Jul 11, 2025
View reviewed changes
Copy link
Contributor

@elupus elupus left a comment

Choose a reason for hiding this comment

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

Looks good

@elupus elupus merged commit cd73824 into home-assistant:dev Jul 11, 2025
34 checks passed
@jpbede jpbede deleted the rest-command-always-read-response branch July 11, 2025 07:06
@github-actions github-actions bot locked and limited conversation to collaborators Jul 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot Copilot left review comments

@elupus elupus elupus approved these changes

Assignees

No one assigned

Labels

bugfix by-code-owner cherry-picked cla-signed integration: rest_command Quality Scale: No score small-pr PRs with less than 30 lines.

Projects

None yet

Milestone

2025.7.2

Development

Successfully merging this pull request may close these issues.

rest_command: Document and/or improve early connection close behavior

3 participants

@jpbede @elupus @frenck