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

chore(di): guard against mutable module container #10841

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

P403n1x87
Copy link
Contributor

@P403n1x87 P403n1x87 commented Sep 26, 2024

When disovering functions on module import, we look at the module as a container of function-like objects. If the module is partially loaded, its __dict__ might mutate. We ensure to iterate over a copy of the module's __dict__ when iterating over it. We expect the original module to mutate dynamically at runtime, so by the time we make a copy of its underlying lookup dict, we are able to detected at the very least everything that corresponds to the actual source code.

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

When disovering functions on module import, we look at the module as a
container of function-like objects. If the module is partially loaded,
its `__dict__` might mutate. We ensure to iterate over a copy of the
module's `__dict__` when iterating over it. We expect the original
module to mutate dynamically at runtime, so by the time we make a copy
of its underlying lookup dict, we are able to detected at the very least
everything that corresponds to the actual source code.
@P403n1x87 P403n1x87 added changelog/no-changelog A changelog entry is not required for this PR. Dynamic Instrumentation Dynamic Instrumentation/Live Debugger labels Sep 26, 2024
@P403n1x87 P403n1x87 self-assigned this Sep 26, 2024
@P403n1x87 P403n1x87 requested a review from a team as a code owner September 26, 2024 20:35
Copy link
Contributor

CODEOWNERS have been resolved as:

ddtrace/debugging/_function/discovery.py                                @DataDog/debugger-python

@pr-commenter
Copy link

pr-commenter bot commented Sep 26, 2024

Benchmarks

Benchmark execution time: 2024-09-30 14:35:56

Comparing candidate commit 5bec53b in PR branch chore/di-guard-mutable-module-container with baseline commit 7e8eb0b in branch main.

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

@P403n1x87 P403n1x87 enabled auto-merge (squash) September 27, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR. Dynamic Instrumentation Dynamic Instrumentation/Live Debugger
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants