Skip to content

fix(di): interaction with external wrapping contexts [backport #13586 to 2.21] #13636

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

Merged
merged 3 commits into from
Jun 13, 2025

Conversation

P403n1x87
Copy link
Contributor

Backport c02a068 from #13586 to 2.21.

We fix an incompatibility within the interaction between Dynamic Instrumentation and external wrapping context (e.g. Code Origin). This was due to a loss of link between a function and its original code object due to a wrapping context being wrapped on a function not retrieved via the function discovery machinery. We make sure that any wrapping via wrapping context preserves the link between the function and its original code object. With the universal wrapping context mechanism, we don't have to worry about potential multiple wrapping, as bytecode is modified only once.

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

We fix an incompatibility within the interaction between Dynamic
Instrumentation and external wrapping context (e.g. Code Origin). This
was due to a loss of link between a function and its original code
object due to a wrapping context being wrapped on a function not
retrieved via the function discovery machinery. We make sure that any
wrapping via wrapping context preserves the link between the function
and its original code object. With the universal wrapping context
mechanism, we don't have to worry about potential multiple wrapping, as
bytecode is modified only once.

- [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))

- [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 c02a068)
@P403n1x87 P403n1x87 requested review from a team as code owners June 10, 2025 13:06
@P403n1x87 P403n1x87 added the Dynamic Instrumentation Dynamic Instrumentation/Live Debugger label Jun 10, 2025
@P403n1x87 P403n1x87 requested a review from a team as a code owner June 10, 2025 13:06
@P403n1x87 P403n1x87 self-assigned this Jun 10, 2025
@P403n1x87 P403n1x87 requested review from Yun-Kim, lievan and juanjux June 10, 2025 13:06
@P403n1x87 P403n1x87 enabled auto-merge (squash) June 10, 2025 13:07
Copy link
Contributor

CODEOWNERS have been resolved as:

releasenotes/notes/fix-di-with-external-wrapping-context-e26b46a6fc7f6a47.yaml  @DataDog/apm-python
ddtrace/debugging/_function/discovery.py                                @DataDog/debugger-python
ddtrace/internal/utils/inspection.py                                    @DataDog/apm-core-python
ddtrace/internal/wrapping/context.py                                    @DataDog/apm-core-python
tests/debugging/conftest.py                                             @DataDog/debugger-python
tests/debugging/function/test_discovery.py                              @DataDog/debugger-python
tests/debugging/test_debugger_span_decoration.py                        @DataDog/debugger-python

@pr-commenter
Copy link

pr-commenter bot commented Jun 13, 2025

Benchmarks

Benchmark execution time: 2025-06-13 21:12:28

Comparing candidate commit af74d37 in PR branch backport-13586-to-2.21 with baseline commit 7fd3c13 in branch 2.21.

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

@P403n1x87 P403n1x87 merged commit ef12149 into 2.21 Jun 13, 2025
871 checks passed
@P403n1x87 P403n1x87 deleted the backport-13586-to-2.21 branch June 13, 2025 21:13
Copy link
Contributor

The backport to 2.21 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.21 2.21
# Navigate to the new working tree
cd .worktrees/backport-2.21
# Create a new branch
git switch --create backport-13636-to-2.21
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ef12149344f543a6694207f2ca47595530cb589b
# Push it to GitHub
git push --set-upstream origin backport-13636-to-2.21
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.21

Then, create a pull request where the base branch is 2.21 and the compare/head branch is backport-13636-to-2.21.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.21 Dynamic Instrumentation Dynamic Instrumentation/Live Debugger
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants