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

Fixed bug that lead to infinite wait for dns futures #10529

Merged
merged 6 commits into from
Mar 15, 2025

Conversation

Logioniz
Copy link
Contributor

@Logioniz Logioniz commented Mar 8, 2025

What do these changes do?

Fixed bug that lead to infinite wait for dns futures when exception occured in trace.send_dns_cache_miss call.

Are there changes in behavior for the user?

No

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

No

Related issue number

No issue.

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`.

Sorry, something went wrong.

@Logioniz Logioniz requested a review from asvetlov as a code owner March 8, 2025 20:18
Copy link

codspeed-hq bot commented Mar 8, 2025

CodSpeed Performance Report

Merging #10529 will not alter performance

Comparing Logioniz:master (21f6af2) with master (55c5f1f)

Summary

✅ 47 untouched benchmarks

Copy link

codecov bot commented Mar 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.69%. Comparing base (6d205da) to head (21f6af2).
Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #10529      +/-   ##
==========================================
- Coverage   98.70%   98.69%   -0.01%     
==========================================
  Files         122      122              
  Lines       37230    37268      +38     
  Branches     2064     2065       +1     
==========================================
+ Hits        36748    36783      +35     
- Misses        335      338       +3     
  Partials      147      147              
Flag Coverage Δ
CI-GHA 98.58% <100.00%> (-0.01%) ⬇️
OS-Linux 98.24% <100.00%> (-0.01%) ⬇️
OS-Windows 96.18% <100.00%> (-0.01%) ⬇️
OS-macOS 97.36% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.27% <100.00%> (-0.01%) ⬇️
Py-3.10.16 97.81% <100.00%> (+<0.01%) ⬆️
Py-3.11.11 97.89% <100.00%> (-0.01%) ⬇️
Py-3.11.9 97.35% <100.00%> (+<0.01%) ⬆️
Py-3.12.8 ?
Py-3.12.9 98.35% <100.00%> (+<0.01%) ⬆️
Py-3.13.1 ?
Py-3.13.2 98.34% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.15% <100.00%> (+<0.01%) ⬆️
Py-3.9.21 97.68% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 86.69% <100.00%> (-4.92%) ⬇️
VM-macos 97.36% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 98.24% <100.00%> (-0.01%) ⬇️
VM-windows 96.18% <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 added backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot backport-3.12 Trigger automatic backporting to the 3.12 release branch by Patchback robot labels Mar 8, 2025
Logioniz added 2 commits March 9, 2025 01:34
@Logioniz Logioniz requested a review from webknjaz as a code owner March 8, 2025 20:35
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Mar 8, 2025
@Logioniz
Copy link
Contributor Author

Logioniz commented Mar 8, 2025

I'm not sure, but it looks like the same problem (endless waiting for dns queries) could occur if an exception is thrown in this part of the code:

coro = self._resolve_host_with_throttle(key, host, port, futures, traces)
loop = asyncio.get_running_loop()
if sys.version_info >= (3, 12):
# Optimization for Python 3.12, try to send immediately
resolved_host_task = asyncio.Task(coro, loop=loop, eager_start=True)
else:
resolved_host_task = loop.create_task(coro)
if not resolved_host_task.done():
self._resolve_host_tasks.add(resolved_host_task)
resolved_host_task.add_done_callback(self._resolve_host_tasks.discard)

I want to say that asyncio.get_running_loop, asyncio.Task, loop.create_task, asyncio.shield may throw an exception that leads to the same behavior. What do you think?

@bdraco
Copy link
Member

bdraco commented Mar 8, 2025

I'm not sure, but it looks like the same problem (endless waiting for dns queries) could occur if an exception is thrown in this part of the code:

coro = self._resolve_host_with_throttle(key, host, port, futures, traces)
loop = asyncio.get_running_loop()
if sys.version_info >= (3, 12):
# Optimization for Python 3.12, try to send immediately
resolved_host_task = asyncio.Task(coro, loop=loop, eager_start=True)
else:
resolved_host_task = loop.create_task(coro)
if not resolved_host_task.done():
self._resolve_host_tasks.add(resolved_host_task)
resolved_host_task.add_done_callback(self._resolve_host_tasks.discard)

I want to say that asyncio.get_running_loop, asyncio.Task, loop.create_task, asyncio.shield may throw an exception that leads to the same behavior. What do you think?

I think the only one that would be worth worrying about is awaiting resolved_host_task. If the others are throwing an exception, the system is already likely in an unrecoverable state.

@Logioniz
Copy link
Contributor Author

Do I need to do something else in this PR?

@bdraco
Copy link
Member

bdraco commented Mar 14, 2025

Do I need to do something else in this PR?

Did you intend to push another commit for resolved_host_task? Its probably very unlikely to happen but I wasn't sure if you were going to add to this PR or not

@Logioniz
Copy link
Contributor Author

Hmm, i think that i have already fixed resolved_host_task. Looks like i incorrectly understand you. I will try to add changes if you explain what exactly can go wrong with resolved_host_task.

I think that code in finally block clear _throttle_dns_futures dict.

But btw may be exists another situation where new coroutineawait asyncio.shield(resolved_host_task) will not have time to start executing and it will be canceled by another coroutine. So, looks like need to clear _throttle_dns_futures in except CancelledError block. Have you written about this situation?

@Logioniz
Copy link
Contributor Author

It looks like my assumption above is incorrect, since asyncio.shield protects against this situation. So, i don't know any bad situations with resolved_host_task.

@bdraco
Copy link
Member

bdraco commented Mar 14, 2025

It looks like my assumption above is incorrect, since asyncio.shield protects against this situation. So, i don't know any bad situations with resolved_host_task.

I think its very unlikely to be a problem. If we can always address it in a future PR if it is.

I think this PR is fine to merge as-is sans the minor nit I mentioned above

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@bdraco bdraco merged commit 492f63d into aio-libs:master Mar 15, 2025
40 checks passed
Copy link
Contributor

patchback bot commented Mar 15, 2025

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/492f63dc252e76ce892e459081286fb46bde87cf/pr-10529

Backported as #10559

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

patchback bot pushed a commit that referenced this pull request Mar 15, 2025
<!-- Thank you for your contribution! -->

## What do these changes do?

Fixed bug that lead to infinite wait for dns futures when exception
occured in trace.send_dns_cache_miss call.

## Are there changes in behavior for the user?

No

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

No

## Related issue number

No issue.

## Checklist

- [x] I think the code is well written
- [x] Unit tests for the changes exist
- [x] Documentation reflects the changes
- [x] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [x] 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:
    ```rst
    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    ```

---------

Co-authored-by: J. Nick Koston <nick+github@koston.org>
(cherry picked from commit 492f63d)
Copy link
Contributor

patchback bot commented Mar 15, 2025

Backport to 3.12: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.12/492f63dc252e76ce892e459081286fb46bde87cf/pr-10529

Backported as #10560

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

patchback bot pushed a commit that referenced this pull request Mar 15, 2025
<!-- Thank you for your contribution! -->

## What do these changes do?

Fixed bug that lead to infinite wait for dns futures when exception
occured in trace.send_dns_cache_miss call.

## Are there changes in behavior for the user?

No

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

No

## Related issue number

No issue.

## Checklist

- [x] I think the code is well written
- [x] Unit tests for the changes exist
- [x] Documentation reflects the changes
- [x] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [x] 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:
    ```rst
    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    ```

---------

Co-authored-by: J. Nick Koston <nick+github@koston.org>
(cherry picked from commit 492f63d)
bdraco pushed a commit that referenced this pull request Mar 16, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
…ait for dns futures (#10559)

**This is a backport of PR #10529 as merged into master
(492f63d).**

<!-- Thank you for your contribution! -->

## What do these changes do?

Fixed bug that lead to infinite wait for dns futures when exception
occured in trace.send_dns_cache_miss call.

## Are there changes in behavior for the user?

No

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

No

## Related issue number

No issue. 

## Checklist

- [x] I think the code is well written
- [x] Unit tests for the changes exist
- [x] Documentation reflects the changes
- [x] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [x] 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:
    ```rst
    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    ```

Co-authored-by: Alexey Stavrov <logioniz@ya.ru>
bdraco pushed a commit that referenced this pull request Mar 16, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
…ait for dns futures (#10560)

**This is a backport of PR #10529 as merged into master
(492f63d).**

<!-- Thank you for your contribution! -->

## What do these changes do?

Fixed bug that lead to infinite wait for dns futures when exception
occured in trace.send_dns_cache_miss call.

## Are there changes in behavior for the user?

No

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

No

## Related issue number

No issue. 

## Checklist

- [x] I think the code is well written
- [x] Unit tests for the changes exist
- [x] Documentation reflects the changes
- [x] If you provide code modification, please add yourself to
`CONTRIBUTORS.txt`
  * The format is &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [x] 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:
    ```rst
    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    ```

Co-authored-by: Alexey Stavrov <logioniz@ya.ru>
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 backport-3.12 Trigger automatic backporting to the 3.12 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.

None yet

2 participants