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

fix(asm): improve BlockingException catch for fastapi #12413

Conversation

christophe-papazian
Copy link
Contributor

@christophe-papazian christophe-papazian commented Feb 19, 2025

APPSEC-56814

Fastapi middleware use BaseExceptionGroup on python 3.11. With a custom middleware, this mechanism could encapsulate BlockingException raised by our blocking mechanism, preventing it to be properly caught to generate a proper blocking response.

This will be tested permanently by the fastapi weblog, as DataDog/system-tests#4125 adds a custom middleware to simulate ATO automatic instrumentation.

Due to our mandatory compatibility with previous python version, we can't use syntaxic sugar to handle exception group.

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

Copy link
Contributor

github-actions bot commented Feb 19, 2025

CODEOWNERS have been resolved as:

releasenotes/notes/fix_blocking_on_fastapi_with_middleware-08ac58a6b112e29f.yaml  @DataDog/apm-python
ddtrace/contrib/internal/asgi/middleware.py                             @DataDog/apm-core-python @DataDog/apm-idm-python

@pr-commenter
Copy link

pr-commenter bot commented Feb 19, 2025

Benchmarks

Benchmark execution time: 2025-02-19 17:02:51

Comparing candidate commit 49effc0 in PR branch christophe-papazian/fix_fastapi_blocking_with_custom_middleware with baseline commit 89689b8 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 358 metrics, 2 unstable metrics.

@christophe-papazian christophe-papazian merged commit f3e0eb3 into main Feb 19, 2025
342 of 343 checks passed
@christophe-papazian christophe-papazian deleted the christophe-papazian/fix_fastapi_blocking_with_custom_middleware branch February 19, 2025 20:05
github-actions bot pushed a commit that referenced this pull request Feb 19, 2025
Fastapi middleware use BaseExceptionGroup on python 3.11. With a custom
middleware, this mechanism could encapsulate BlockingException raised by
our blocking mechanism, preventing it to be properly caught to generate
a proper blocking response.

This will be tested permanently by the `fastapi` weblog, as
DataDog/system-tests#4125 adds a custom
middleware to simulate ATO automatic instrumentation.

Due to our mandatory compatibility with previous python version, we
can't use syntaxic sugar to handle exception group.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

(cherry picked from commit f3e0eb3)
github-actions bot pushed a commit that referenced this pull request Feb 19, 2025
Fastapi middleware use BaseExceptionGroup on python 3.11. With a custom
middleware, this mechanism could encapsulate BlockingException raised by
our blocking mechanism, preventing it to be properly caught to generate
a proper blocking response.

This will be tested permanently by the `fastapi` weblog, as
DataDog/system-tests#4125 adds a custom
middleware to simulate ATO automatic instrumentation.

Due to our mandatory compatibility with previous python version, we
can't use syntaxic sugar to handle exception group.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

(cherry picked from commit f3e0eb3)
github-actions bot pushed a commit that referenced this pull request Feb 19, 2025
Fastapi middleware use BaseExceptionGroup on python 3.11. With a custom
middleware, this mechanism could encapsulate BlockingException raised by
our blocking mechanism, preventing it to be properly caught to generate
a proper blocking response.

This will be tested permanently by the `fastapi` weblog, as
DataDog/system-tests#4125 adds a custom
middleware to simulate ATO automatic instrumentation.

Due to our mandatory compatibility with previous python version, we
can't use syntaxic sugar to handle exception group.

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

(cherry picked from commit f3e0eb3)
emmettbutler pushed a commit that referenced this pull request Feb 20, 2025
…#12424)

Backport f3e0eb3 from #12413 to 2.21.

Fastapi middleware use BaseExceptionGroup on python 3.11. With a custom
middleware, this mechanism could encapsulate BlockingException raised by
our blocking mechanism, preventing it to be properly caught to generate
a proper blocking response.

This will be tested permanently by the `fastapi` weblog, as
DataDog/system-tests#4125 adds a custom
middleware to simulate ATO automatic instrumentation.

Due to our mandatory compatibility with previous python version, we
can't use syntaxic sugar to handle exception group.


## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

Co-authored-by: Christophe Papazian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants