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

Disabling retry_persistent_connection in Tests #9396

Merged
merged 21 commits into from
Oct 6, 2024

Conversation

ShubhAgarwal-dev
Copy link
Contributor

@ShubhAgarwal-dev ShubhAgarwal-dev commented Oct 2, 2024

What do these changes do?

It disables retry logic by default in tests.

Are there changes in behavior for the user?

No

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

No

Related issue number

#9141

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Add a new news fragment into the CHANGES/ folder
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 2, 2024
@ShubhAgarwal-dev ShubhAgarwal-dev changed the title Deiabling retry_persistent_connection in Tests Disabling retry_persistent_connection in Tests Oct 2, 2024
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.57%. Comparing base (21f5f92) to head (15c2002).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9396   +/-   ##
=======================================
  Coverage   98.57%   98.57%           
=======================================
  Files         107      107           
  Lines       35048    35063   +15     
  Branches     4150     4151    +1     
=======================================
+ Hits        34547    34562   +15     
  Misses        334      334           
  Partials      167      167           
Flag Coverage Δ
CI-GHA 98.45% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.11% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.53% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.80% <100.00%> (-0.02%) ⬇️
Py-3.10.11 97.67% <100.00%> (+<0.01%) ⬆️
Py-3.10.15 97.60% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.68% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.75% <100.00%> (-0.01%) ⬇️
Py-3.12.6 98.16% <100.00%> (+<0.01%) ⬆️
Py-3.13.0-rc.3 98.15% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.56% <100.00%> (-0.01%) ⬇️
Py-3.9.20 97.50% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.12% <100.00%> (+<0.01%) ⬆️
VM-macos 97.80% <100.00%> (-0.02%) ⬇️
VM-ubuntu 98.11% <100.00%> (+<0.01%) ⬆️
VM-windows 96.53% <100.00%> (+<0.01%) ⬆️

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.

aiohttp/client.py Outdated Show resolved Hide resolved
aiohttp/test_utils.py Outdated Show resolved Hide resolved
aiohttp/client.py Outdated Show resolved Hide resolved
aiohttp/client.py Outdated Show resolved Hide resolved
@ShubhAgarwal-dev
Copy link
Contributor Author

Hi @Dreamsorcerer, I will make all the suggested changes. I saw many tests are using this ClientSession class, should I make these changes everywhere..?

Also, how to pass the Label/Backport Label Check?

Thanks for the inputs

@ShubhAgarwal-dev
Copy link
Contributor Author

Hi @Dreamsorcerer, I have made all the suggested changes.

@Dreamsorcerer Dreamsorcerer added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Oct 3, 2024
@Dreamsorcerer
Copy link
Member

There are a fair number of tests which create a ClientSession directly, but this should cover most tests.

We just want a test now to validate the behaviour in tests.

@Dreamsorcerer
Copy link
Member

We just want a test now to validate the behaviour in tests.

I'll probably take a look at it over the weekend, but if you'd like to give it a try, then I think we want a test that uses the aiohttp_client fixture with an app that has an endpoint which closes the connection (probably request.close()) and then assert that the client only made one request.

@ShubhAgarwal-dev
Copy link
Contributor Author

Ok, I will try to make a test like that. Can you point me to parts where I can take a look for inspiration while writing tests..?

@Dreamsorcerer
Copy link
Member

Probably any test that uses aiohttp_client currently. The test should be added to test_test_utils.py

@ShubhAgarwal-dev
Copy link
Contributor Author

Hi @Dreamsorcerer, I have added the required test, I think it should work

tests/test_test_utils.py Fixed Show fixed Hide fixed
@Dreamsorcerer
Copy link
Member

Thanks, I think that's close to what we want. I'll play with it tomorrow and make some tweaks.

@ShubhAgarwal-dev
Copy link
Contributor Author

Cool

Copy link
Contributor Author

@ShubhAgarwal-dev ShubhAgarwal-dev left a comment

Choose a reason for hiding this comment

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

Please let me know if there is anything else which I can try for hacktoberfest.

@webknjaz
Copy link
Member

webknjaz commented Oct 6, 2024

@ShubhAgarwal-dev while you did successfully change the code, I have feedback regarding using Git, specifically commit message and PR titles and descriptions. This is a very important skill both for yourself and when collaborating on projects with others. Please, check out this collection of articles on the topic: https://gist.github.com/webknjaz/cb7d7bf62c3dda4b1342d639d0e78d79. Following those recommendations will improve the quality of your interactions with Git and git hostings by a lot! Hope this helps :)

Regarding more issues, check out https://github.com/aio-libs/aiohttp/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3AHacktoberfest to see if there's anything you're able to understand the context of.
Additionally, we have a number of aiohttp dependencies in the same @aio-libs org — frozenlist, multidict, propcache, yarl. Those are smaller libraries where you may be able to find something to work on as well.

CHANGES/9141.misc.rst Outdated Show resolved Hide resolved
@ShubhAgarwal-dev
Copy link
Contributor Author

@ShubhAgarwal-dev while you did successfully change the code, I have feedback regarding using Git, specifically commit message and PR titles and descriptions. This is a very important skill both for yourself and when collaborating on projects with others. Please, check out this collection of articles on the topic: https://gist.github.com/webknjaz/cb7d7bf62c3dda4b1342d639d0e78d79. Following those recommendations will improve the quality of your interactions with Git and git hostings by a lot! Hope this helps :)

Regarding more issues, check out https://github.com/aio-libs/aiohttp/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3AHacktoberfest to see if there's anything you're able to understand the context of. Additionally, we have a number of aiohttp dependencies in the same @aio-libs org — frozenlist, multidict, propcache, yarl. Those are smaller libraries where you may be able to find something to work on as well.

Thanks for the comments. I will go through the articles and try to adopt the best practices. Once done, It will be my first-time contributing the changes to such a big open source project.

tests/test_test_utils.py Fixed Show fixed Hide fixed
@Dreamsorcerer
Copy link
Member

Alright, updated test should be good now. I also rewrote the change fragment to focus on what a user will want to know.

@Dreamsorcerer Dreamsorcerer merged commit 6d8562d into aio-libs:master Oct 6, 2024
38 of 39 checks passed
Copy link
Contributor

patchback bot commented Oct 6, 2024

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

❌ Failed to cleanly apply 6d8562d on top of patchback/backports/3.11/6d8562d8420b3e464877b941e04663fdac29a54c/pr-9396

Backporting merged PR #9396 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.11/6d8562d8420b3e464877b941e04663fdac29a54c/pr-9396 upstream/3.11
  4. Now, cherry-pick PR Disabling retry_persistent_connection in Tests #9396 contents into that branch:
    $ git cherry-pick -x 6d8562d8420b3e464877b941e04663fdac29a54c
    If it'll yell at you with something like fatal: Commit 6d8562d8420b3e464877b941e04663fdac29a54c is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 6d8562d8420b3e464877b941e04663fdac29a54c
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Disabling retry_persistent_connection in Tests #9396 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/6d8562d8420b3e464877b941e04663fdac29a54c/pr-9396
  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.

@Dreamsorcerer
Copy link
Member

@ShubhAgarwal-dev Would you mind following the above instructions to create a backport PR? Thanks.

@ShubhAgarwal-dev
Copy link
Contributor Author

Ok Cool I will do the same

@Dreamsorcerer
Copy link
Member

I mean the instructions that were just posted. :P

@Dreamsorcerer
Copy link
Member

#9396 (comment)

Depending on conflicts, sometimes the bot does it directly without human intervention.

ShubhAgarwal-dev added a commit to ShubhAgarwal-dev/aiohttp that referenced this pull request Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.11 Trigger automatic backporting to the 3.11 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.

3 participants