Fix MongoDB DBM propagation issue where trace comments are not properly injected into commands by lu-zhengda · Pull Request #5306 · DataDog/dd-trace-js

lu-zhengda · 2025-02-21T21:46:09Z

What does this PR do?

This PR fixes an issue where MongoDB DBM trace comments were not properly injected into the command object. The root cause was that the modified comment was assigned to a new copied object dbmTracedCommand = { ...command }, which did not affect the original ops object outside of start(). This fix ensures that the comment is correctly assigned back to the original ops object to maintain proper DBM propagation.

Motivation

Fix a bug where DBM trace comments were missing from MongoDB commands due to improper reassignment.

Plugin Checklist

Additional Notes

…ommand is modified before execution

github-actions · 2025-02-21T21:47:07Z

Overall package size

Self size: 8.77 MB
Deduped: 94.97 MB
No deduping: 95.48 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.3.0 | 13.77 MB | 13.78 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 | 835.4 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 | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.2 | 53.63 kB | 53.63 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 | | semifies | 1.0.0 | 15.84 kB | 15.84 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}

codecov · 2025-02-21T21:48:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.94%. Comparing base (96bb84a) to head (536e0d6).
Report is 5 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #5306   +/-   ##
=======================================
  Coverage   80.94%   80.94%           
=======================================
  Files         488      488           
  Lines       21844    21848    +4     
=======================================
+ Hits        17681    17685    +4     
  Misses       4163     4163

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

datadog-datadog-prod-us1 · 2025-02-21T21:52:38Z

Datadog Report

Branch report: zhengda.lu/mongo-trace-fix
Commit report: f8ef690
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 666 Passed, 0 Skipped, 11m 4.99s Total Time

pr-commenter · 2025-02-21T22:15:33Z

Benchmarks

Benchmark execution time: 2025-02-24 19:56:59

Comparing candidate commit 536e0d6 in PR branch zhengda.lu/mongo-trace-fix with baseline commit 96bb84a in branch master.

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

BridgeAR

The change itself is LGTM. The tests could AFAIC be a bit more resilient by checking for the change after the start call to verify the input is manipulated accordingly instead of checking for the injectDbmCommand method.

We could probably also just return the promise in the test instead of using promises and callbacks.

lu-zhengda · 2025-02-24T19:50:15Z

@BridgeAR, I updated the tests to inspect ops.comment from start input args to ensure comment is applied to the input arg.

lu-zhengda · 2025-02-24T19:54:19Z

/merge

dd-devflow · 2025-02-24T19:54:24Z

View all feedbacks in Devflow UI.
2025-02-24 19:54:24 UTC ℹ️ Start processing command /merge

2025-02-24 19:54:31 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-02-24 20:21:13 UTC ⚠️ MergeQueue: This merge request was unqueued

zhengda.lu@datadoghq.com unqueued this merge request

lu-zhengda · 2025-02-24T20:21:02Z

/remove

dd-devflow · 2025-02-24T20:21:06Z

View all feedbacks in Devflow UI.
2025-02-24 20:21:06 UTC ℹ️ Start processing command /remove

2025-02-24 20:21:08 UTC ℹ️ Devflow: /remove

…ly injected into commands (#5306) * comment has to be assigned back to the input ops to ensure incoming command is modified before execution * input comment to injectDbmCommand * rename injectDbmCommand to injectDbmComment

comment has to be assigned back to the input ops to ensure incoming c…

f78ff1e

…ommand is modified before execution

lu-zhengda added the semver-patch label Feb 21, 2025

lu-zhengda changed the title ~~Fix MongoDB DBM propagation where trace in comment are not properly injected into the command~~ Fix MongoDB DBM propagation issue where trace comments are not properly injected into commands Feb 21, 2025

input comment to injectDbmCommand

b7ba229

lu-zhengda commented Feb 21, 2025

View reviewed changes

Comment thread packages/datadog-plugin-mongodb-core/src/index.js Outdated

lu-zhengda marked this pull request as ready for review February 21, 2025 22:31

lu-zhengda requested review from a team as code owners February 21, 2025 22:31

BridgeAR reviewed Feb 24, 2025

View reviewed changes

Comment thread packages/datadog-plugin-mongodb-core/src/index.js Outdated

rename injectDbmCommand to injectDbmComment

536e0d6

lu-zhengda requested a review from BridgeAR February 24, 2025 19:51

BridgeAR approved these changes Feb 24, 2025

View reviewed changes

dd-devflow Bot added the mergequeue-status: waiting label Feb 24, 2025

dd-devflow Bot added mergequeue-status: removed and removed mergequeue-status: waiting labels Feb 24, 2025

lu-zhengda merged commit 519fbce into master Feb 24, 2025

lu-zhengda deleted the zhengda.lu/mongo-trace-fix branch February 24, 2025 20:22

watson mentioned this pull request Feb 27, 2025

v5.39.0 proposal #5337

Merged

falzm mentioned this pull request Feb 28, 2025

[BUG]: tracing causes errors with MongoDB server versions < 4.4 #5345

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix MongoDB DBM propagation issue where trace comments are not properly injected into commands#5306

Fix MongoDB DBM propagation issue where trace comments are not properly injected into commands#5306
lu-zhengda merged 3 commits intomasterfrom
zhengda.lu/mongo-trace-fix

lu-zhengda commented Feb 21, 2025 •

edited

Loading

Uh oh!

github-actions Bot commented Feb 21, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Feb 21, 2025 •

edited

Loading

Uh oh!

datadog-datadog-prod-us1 Bot commented Feb 21, 2025 •

edited

Loading

Uh oh!

Uh oh!

pr-commenter Bot commented Feb 21, 2025 •

edited

Loading

Uh oh!

BridgeAR left a comment

Uh oh!

Uh oh!

lu-zhengda commented Feb 24, 2025

Uh oh!

lu-zhengda commented Feb 24, 2025

Uh oh!

dd-devflow Bot commented Feb 24, 2025 •

edited

Loading

Uh oh!

lu-zhengda commented Feb 24, 2025

Uh oh!

dd-devflow Bot commented Feb 24, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

lu-zhengda commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Plugin Checklist

Additional Notes

Uh oh!

github-actions Bot commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overall package size

Uh oh!

codecov Bot commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

datadog-datadog-prod-us1 Bot commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Datadog Report

Uh oh!

Uh oh!

pr-commenter Bot commented Feb 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmarks

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lu-zhengda commented Feb 24, 2025

Uh oh!

lu-zhengda commented Feb 24, 2025

Uh oh!

dd-devflow Bot commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lu-zhengda commented Feb 24, 2025

Uh oh!

dd-devflow Bot commented Feb 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lu-zhengda commented Feb 21, 2025 •

edited

Loading

github-actions Bot commented Feb 21, 2025 •

edited

Loading

codecov Bot commented Feb 21, 2025 •

edited

Loading

datadog-datadog-prod-us1 Bot commented Feb 21, 2025 •

edited

Loading

pr-commenter Bot commented Feb 21, 2025 •

edited

Loading

dd-devflow Bot commented Feb 24, 2025 •

edited

Loading

dd-devflow Bot commented Feb 24, 2025 •

edited

Loading