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

Remove blocking IO for static resources and refactor exception handling #8507

Merged
merged 13 commits into from
Jul 21, 2024

Conversation

steverep
Copy link
Member

@steverep steverep commented Jul 16, 2024

What do these changes do?

Refactors the static resource handler to run all IO methods in an executor. Also revamps the exception handling to be less confusing and throw client exceptions only for known scenarios. The current handling clearly was designed prior to python 3.6, where Path.resolve() was called strictly - see #8182 (comment) for details.

Are there changes in behavior for the user?

I doubt these would be noticed, but:

  1. PermissionError will now always lead to a 403 response (previously there was a mix of 403 and 404 depending on the scenario).
  2. "Unknown" exceptions are not caught and logged as before. Instead they will raise up and be logged as server 500 errors as they should.

Is it a substantial burden for the maintainers to support this?

No

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder
    • name it <issue_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

    • if you don't have an issue number, change it to the pull request
      number after creating the PR

      • .bugfix: A bug fix for something the maintainers deemed an
        improper undesired behavior that got corrected to match
        pre-agreed expectations.
      • .feature: A new behavior, public APIs. That sort of stuff.
      • .deprecation: A declaration of future API removals and breaking
        changes in behavior.
      • .breaking: When something public is removed in a breaking way.
        Could be deprecated in an earlier release.
      • .doc: Notable updates to the documentation structure or build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and tooling. Changes in the test invocation considerations and
        runtime assumptions.
      • .contrib: Stuff that affects the contributor experience. e.g.
        Running tests, building the docs, setting up the development
        environment.
      • .misc: Changes that are hard to assign to any of the above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      Use the past tense or the present tense a non-imperative mood,
      referring to what's changed compared to the last released version
      of this project.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jul 16, 2024
@steverep steverep force-pushed the fix-blocking-static-handler branch from 5d70fcb to 210d8f5 Compare July 16, 2024 04:33
Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.63%. Comparing base (bbe90e5) to head (aa4f92e).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8507   +/-   ##
=======================================
  Coverage   97.62%   97.63%           
=======================================
  Files         107      107           
  Lines       33262    33282   +20     
  Branches     3905     3908    +3     
=======================================
+ Hits        32472    32494   +22     
+ Misses        571      569    -2     
  Partials      219      219           
Flag Coverage Δ
CI-GHA 97.54% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.21% <100.00%> (+<0.01%) ⬆️
OS-Windows 95.64% <91.22%> (-0.02%) ⬇️
OS-macOS 96.88% <100.00%> (+0.01%) ⬆️
Py-3.10.11 97.02% <100.00%> (+<0.01%) ⬆️
Py-3.10.14 96.97% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.19% <100.00%> (+<0.01%) ⬆️
Py-3.12.4 97.32% <100.00%> (+<0.01%) ⬆️
Py-3.8.10 95.41% <91.22%> (-0.02%) ⬇️
Py-3.8.18 96.86% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.01% <100.00%> (+0.01%) ⬆️
Py-3.9.19 96.96% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 96.53% <100.00%> (+<0.01%) ⬆️
VM-macos 96.88% <100.00%> (+0.01%) ⬆️
VM-ubuntu 97.21% <100.00%> (+<0.01%) ⬆️
VM-windows 95.64% <91.22%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CHANGES/8507.misc.rst Outdated Show resolved Hide resolved
@bdraco bdraco added the backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot label Jul 16, 2024
CHANGES/8507.bugfix.rst Outdated Show resolved Hide resolved
@steverep steverep changed the title Fix blocking IO for static resources and refactor exception handling Remove blocking IO for static resources and refactor exception handling Jul 17, 2024
CHANGES/8507.bugfix.rst Outdated Show resolved Hide resolved
steverep and others added 2 commits July 17, 2024 18:10
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
@steverep steverep force-pushed the fix-blocking-static-handler branch from 7e86a47 to 213199d Compare July 17, 2024 22:50
@steverep steverep requested a review from bdraco July 18, 2024 19:13
CHANGES/8507.bugfix.rst Outdated Show resolved Hide resolved
@bdraco
Copy link
Member

bdraco commented Jul 20, 2024

Looks like this is ready for manual testing

@bdraco
Copy link
Member

bdraco commented Jul 20, 2024

Testing this on production now

@bdraco
Copy link
Member

bdraco commented Jul 20, 2024

Manual testing looks good. As soon as the coverage issue is addressed, I think this is good to go.

steverep and others added 2 commits July 20, 2024 12:56
Co-authored-by: J. Nick Koston <nick@koston.org>
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.

Thanks @steverep

@bdraco
Copy link
Member

bdraco commented Jul 21, 2024

Ran fine in production overnight.

@bdraco bdraco merged commit c9d09f1 into aio-libs:master Jul 21, 2024
37 of 38 checks passed
Copy link
Contributor

patchback bot commented Jul 21, 2024

Backport to 3.10: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply c9d09f1 on top of patchback/backports/3.10/c9d09f11d71e878984f7a528d414b059d4f4d9bd/pr-8507

Backporting merged PR #8507 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.10/c9d09f11d71e878984f7a528d414b059d4f4d9bd/pr-8507 upstream/3.10
  4. Now, cherry-pick PR Remove blocking IO for static resources and refactor exception handling #8507 contents into that branch:
    $ git cherry-pick -x c9d09f11d71e878984f7a528d414b059d4f4d9bd
    If it'll yell at you with something like fatal: Commit c9d09f11d71e878984f7a528d414b059d4f4d9bd is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x c9d09f11d71e878984f7a528d414b059d4f4d9bd
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Remove blocking IO for static resources and refactor exception handling #8507 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.10/c9d09f11d71e878984f7a528d414b059d4f4d9bd/pr-8507
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

bdraco pushed a commit that referenced this pull request Jul 21, 2024
…ng (#8507)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: J. Nick Koston <nick@koston.org>
(cherry picked from commit c9d09f1)
bdraco added a commit that referenced this pull request Jul 21, 2024
…urces and refactor exception handling (#8521)

Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко)
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: Steve Repsher <steverep@users.noreply.github.com>
@steverep steverep deleted the fix-blocking-static-handler branch July 21, 2024 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants