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

Add coverage for combining an existing query string with params #9065

Merged
merged 2 commits into from
Sep 8, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Sep 8, 2024

Add coverage for combining an existing query string with params.

I expected the change in #9062 would have failed the CI, and turns out the complex query string construction there is needed, but there is no coverage for it.

When we have multiple query strings, we don't want to overwrite keys, since some applications will want multiple values for the same key. Ie name=X&name=Y&name=Z is used to indicate there are 3 payloads, etc.

The complex logic we have to combine query strings should be handled in yarl. Currently we only have a way to update the query string but that overwrites values. We need a way to extend the query string and take advantage of multidict's ability to have the same key.

            q = MultiDict(url.query)
            url2 = url.with_query(params)
            q.extend(url2.query)
            url = url.with_query(q)

@bdraco bdraco added bot:chronographer:skip This PR does not need to include a change note backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Sep 8, 2024
Copy link

codecov bot commented Sep 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.30%. Comparing base (11a96fc) to head (acb9806).
Report is 1 commits behind head on master.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9065   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files         107      107           
  Lines       34371    34390   +19     
  Branches     4072     4075    +3     
=======================================
+ Hits        33787    33806   +19     
  Misses        412      412           
  Partials      172      172           
Flag Coverage Δ
CI-GHA 98.19% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.85% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.27% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.53% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.63% <100.00%> (+<0.01%) ⬆️
Py-3.10.14 97.56% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.79% <100.00%> (+<0.01%) ⬆️
Py-3.12.5 97.91% <100.00%> (-0.01%) ⬇️
Py-3.9.13 97.52% <100.00%> (+<0.01%) ⬆️
Py-3.9.19 97.46% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.07% <100.00%> (-0.01%) ⬇️
VM-macos 97.53% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 97.85% <100.00%> (+<0.01%) ⬆️
VM-windows 96.27% <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.

@bdraco bdraco marked this pull request as ready for review September 8, 2024 17:35
@bdraco bdraco merged commit b6196e7 into master Sep 8, 2024
34 of 35 checks passed
@bdraco bdraco deleted the query_extend_tests branch September 8, 2024 17:35
Copy link
Contributor

patchback bot commented Sep 8, 2024

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

❌ Failed to cleanly apply b6196e7 on top of patchback/backports/3.10/b6196e77f394e68a4cce5af72fde066194fb94ac/pr-9065

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

Copy link
Contributor

patchback bot commented Sep 8, 2024

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

❌ Failed to cleanly apply b6196e7 on top of patchback/backports/3.11/b6196e77f394e68a4cce5af72fde066194fb94ac/pr-9065

Backporting merged PR #9065 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/b6196e77f394e68a4cce5af72fde066194fb94ac/pr-9065 upstream/3.11
  4. Now, cherry-pick PR Add coverage for combining an existing query string with params #9065 contents into that branch:
    $ git cherry-pick -x b6196e77f394e68a4cce5af72fde066194fb94ac
    If it'll yell at you with something like fatal: Commit b6196e77f394e68a4cce5af72fde066194fb94ac is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x b6196e77f394e68a4cce5af72fde066194fb94ac
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add coverage for combining an existing query string with params #9065 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/b6196e77f394e68a4cce5af72fde066194fb94ac/pr-9065
  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 added a commit that referenced this pull request Sep 8, 2024
bdraco added a commit that referenced this pull request Sep 8, 2024
bdraco added a commit that referenced this pull request Sep 8, 2024
bdraco added a commit that referenced this pull request Sep 8, 2024
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 backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant