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 [backport 3.0] #12423

Merged
merged 3 commits into from
Feb 21, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Feb 19, 2025

Backport f3e0eb3 from #12413 to 3.0.

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.

APPSEC-56814

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

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 github-actions bot added the ASM Application Security Monitoring label Feb 19, 2025
@github-actions github-actions bot requested review from a team as code owners February 19, 2025 20:05
@pr-commenter
Copy link

pr-commenter bot commented Feb 19, 2025

Benchmarks

Benchmark execution time: 2025-02-21 09:56:38

Comparing candidate commit faf6a21 in PR branch backport-12413-to-3.0 with baseline commit 408d064 in branch 3.0.

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

@emmettbutler emmettbutler enabled auto-merge (squash) February 20, 2025 18:05
Copy link
Contributor Author

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

@emmettbutler emmettbutler merged commit a95e66b into 3.0 Feb 21, 2025
315 of 316 checks passed
@emmettbutler emmettbutler deleted the backport-12413-to-3.0 branch February 21, 2025 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ASM Application Security Monitoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants