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

Adapt static resource handler to aiohttp 3.10 #123166

Merged
merged 4 commits into from
Aug 6, 2024

Conversation

steverep
Copy link
Member

@steverep steverep commented Aug 5, 2024

Proposed change

The static resource handler contains a lot of code copied from aiohttp's base class, manipulated to run file system operations in an executor. Much of this logic has been rewritten in 3.10 to fix several issues, as well as now running any file system calls in an executor. This change strips out all the copied code, and simply wraps the super class method to cache the path resolution and content type lookup as done now.

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.

To help with the load of incoming pull requests:

@steverep steverep requested a review from a team as a code owner August 5, 2024 05:51
@home-assistant
Copy link

home-assistant bot commented Aug 5, 2024

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

Code owner commands

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

@edenhaus edenhaus requested a review from bdraco August 5, 2024 11:20
@bdraco
Copy link
Member

bdraco commented Aug 5, 2024

This is much nicer than #121831 👍

if not isinstance(response, FileResponse):
# Must be directory index; ignore caching
return response
file_path = response._path # noqa: SLF001
Copy link
Member

Choose a reason for hiding this comment

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

It would be nice to do a PR to aiohttp to expose this property as part of the API so we don't have the protected access here.

@bdraco
Copy link
Member

bdraco commented Aug 5, 2024

Thanks @steverep

This is a nice cleanup. Glad 3.10 is going well.

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

Marking request changes so I get the ping back when its ready again

@home-assistant home-assistant bot marked this pull request as draft August 5, 2024 15:49
@home-assistant
Copy link

home-assistant bot commented Aug 5, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

Looks great. Really nice cleanup. Thanks @steverep

The pathlib performance should be a bit better in cpython 3.13 as well
Screenshot 2024-08-06 at 9 16 55 AM

@bdraco bdraco merged commit 9414e6d into home-assistant:dev Aug 6, 2024
40 checks passed
@steverep steverep deleted the revamp-static-handler branch August 6, 2024 18:42
@steverep
Copy link
Member Author

steverep commented Aug 6, 2024

I noticed this didn't make it into b5. Can we put this in the next beta to enable the upstream aiohttp fixes (and also unblock home-assistant/frontend#19838)?

@bdraco bdraco added this to the 2024.8.0 milestone Aug 7, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 8, 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.

3 participants