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

dd-trace-api: don't proxy objects returned from callbacks #5240

Merged
merged 1 commit into from
Feb 10, 2025

Conversation

bengl
Copy link
Collaborator

@bengl bengl commented Feb 10, 2025

Some APIs (pretty much just trace) return whatever value is returned from a callback passed in. Without providing for this, this would trip up the check that returned objects are proxied. We don't want to proxy these objects since they come directly from the caller.

@bengl bengl requested review from a team as code owners February 10, 2025 20:20
Copy link

github-actions bot commented Feb 10, 2025

Overall package size

Self size: 8.63 MB
Deduped: 95.03 MB
No deduping: 95.55 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.4.0 | 29.44 MB | 29.44 MB | | @datadog/native-appsec | 8.4.0 | 19.25 MB | 19.26 MB | | @datadog/native-iast-taint-tracking | 3.2.0 | 13.9 MB | 13.91 MB | | @datadog/pprof | 5.5.1 | 9.79 MB | 10.17 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.8.0 | 2.6 MB | 2.74 MB | | @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB | | @datadog/native-metrics | 3.1.0 | 1.06 MB | 1.46 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.11.2 | 112.74 kB | 826.22 kB | | source-map | 0.7.4 | 226 kB | 226 kB | | opentracing | 0.14.7 | 194.81 kB | 194.81 kB | | lru-cache | 7.18.3 | 133.92 kB | 133.92 kB | | pprof-format | 2.1.0 | 111.69 kB | 111.69 kB | | @datadog/sketches-js | 2.1.0 | 109.9 kB | 109.9 kB | | semver | 7.6.3 | 95.82 kB | 95.82 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.1 | 51.46 kB | 51.46 kB | | shell-quote | 1.8.1 | 44.96 kB | 44.96 kB | | istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 kB | | rfdc | 1.3.1 | 25.21 kB | 25.21 kB | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | dc-polyfill | 0.1.4 | 23.1 kB | 23.1 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB | | crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB | | ttl-set | 1.0.0 | 4.61 kB | 9.69 kB | | path-to-regexp | 0.1.12 | 6.6 kB | 6.6 kB | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | module-details-from-path | 1.0.3 | 4.47 kB | 4.47 kB |

🤖 This report was automatically generated by heaviest-objects-in-the-universe

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.18%. Comparing base (d19540d) to head (af14308).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5240      +/-   ##
==========================================
+ Coverage   81.15%   81.18%   +0.02%     
==========================================
  Files         482      482              
  Lines       21530    21531       +1     
==========================================
+ Hits        17473    17479       +6     
+ Misses       4057     4052       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Feb 10, 2025

Datadog Report

Branch report: bengl/dd-trace-api-no-cb-proxy
Commit report: dda8d69
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 628 Passed, 0 Skipped, 13m 35.92s Total Time

@pr-commenter
Copy link

pr-commenter bot commented Feb 10, 2025

Benchmarks

Benchmark execution time: 2025-02-10 20:50:51

Comparing candidate commit af14308 in PR branch bengl/dd-trace-api-no-cb-proxy with baseline commit d19540d in branch master.

Found 0 performance improvements and 1 performance regressions! Performance is the same for 908 metrics, 24 unstable metrics.

scenario:plugin-graphql-with-async-hooks-22

  • 🟥 max_rss_usage [+97.279MB; +129.789MB] or [+18.103%; +24.153%]

Some APIs (pretty much just trace) return whatever value is returned
from a callback passed in. Without providing for this, this would trip
up the check that returned objects are proxied. We don't want to proxy
these objects since they come directly from the caller.
@bengl bengl force-pushed the bengl/dd-trace-api-no-cb-proxy branch from ee82212 to af14308 Compare February 10, 2025 20:38
@bengl bengl enabled auto-merge (squash) February 10, 2025 20:44
@bengl bengl merged commit 788cb6f into master Feb 10, 2025
358 checks passed
@bengl bengl deleted the bengl/dd-trace-api-no-cb-proxy branch February 10, 2025 20:57
bengl added a commit that referenced this pull request Feb 11, 2025
While #5240 allowed for objects to be returned, it did this by comparing
strict equality. With promises, we add an additional `.then()` call,
removing strict equality. In this change, comparison of _resolved_
values is used.
watson pushed a commit that referenced this pull request Feb 17, 2025
Some APIs (pretty much just trace) return whatever value is returned
from a callback passed in. Without providing for this, this would trip
up the check that returned objects are proxied. We don't want to proxy
these objects since they come directly from the caller.
@watson watson mentioned this pull request Feb 17, 2025
watson pushed a commit that referenced this pull request Feb 17, 2025
Some APIs (pretty much just trace) return whatever value is returned
from a callback passed in. Without providing for this, this would trip
up the check that returned objects are proxied. We don't want to proxy
these objects since they come directly from the caller.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants