dd-trace-js
dd-trace-js copied to clipboard
chore: change dsm hashing algorithm to match other tracers
What does this PR do?
Makes DSM hashing consistent with other languages. Not a breaking change. Hashing algo has been changes to use fnv1 algorithm. The hashing code was based off the python implementation
Motivation
Plugin Checklist
- [ ] Unit tests.
- [ ] TypeScript definitions.
- [ ] TypeScript tests.
- [ ] API documentation.
- [ ] CircleCI jobs/workflows.
- [ ] Plugin is exported.
Additional Notes
Overall package size
Self size: 6.27 MB Deduped: 60.77 MB No deduping: 61.05 MB
Dependency sizes
| name | version | self size | total size |
|---|---|---|---|
| @datadog/native-iast-taint-tracking | 1.7.0 | 16.71 MB | 16.72 MB |
| @datadog/native-appsec | 7.1.1 | 14.39 MB | 14.4 MB |
| @datadog/pprof | 5.2.0 | 8.84 MB | 9.21 MB |
| protobufjs | 7.2.5 | 2.77 MB | 6.56 MB |
| @datadog/native-iast-rewriter | 2.3.0 | 2.15 MB | 2.24 MB |
| @opentelemetry/core | 1.14.0 | 872.87 kB | 1.47 MB |
| @datadog/native-metrics | 2.0.0 | 898.77 kB | 1.3 MB |
| @opentelemetry/api | 1.4.1 | 780.32 kB | 780.32 kB |
| import-in-the-middle | 1.7.3 | 67.62 kB | 731.01 kB |
| msgpack-lite | 0.1.26 | 201.16 kB | 281.59 kB |
| opentracing | 0.14.7 | 194.81 kB | 194.81 kB |
| semver | 7.5.4 | 93.4 kB | 123.8 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 |
| lru-cache | 7.14.0 | 74.95 kB | 74.95 kB |
| ipaddr.js | 2.1.0 | 60.23 kB | 60.23 kB |
| ignore | 5.2.4 | 51.22 kB | 51.22 kB |
| int64-buffer | 0.1.10 | 49.18 kB | 49.18 kB |
| shell-quote | 1.8.1 | 44.96 kB | 44.96 kB |
| istanbul-lib-coverage | 3.2.0 | 29.34 kB | 29.34 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 |
| node-abort-controller | 3.1.1 | 16.89 kB | 16.89 kB |
| jest-docblock | 29.7.0 | 8.99 kB | 12.76 kB |
| crypto-randomuuid | 1.0.0 | 11.18 kB | 11.18 kB |
| path-to-regexp | 0.1.7 | 6.78 kB | 6.78 kB |
| koalas | 1.0.2 | 6.47 kB | 6.47 kB |
| methods | 1.1.2 | 5.29 kB | 5.29 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 Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 78.79%. Comparing base (
de47a4b) to head (7db89db). Report is 992 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #4222 +/- ##
==========================================
- Coverage 85.23% 78.79% -6.44%
==========================================
Files 247 14 -233
Lines 10961 1066 -9895
Branches 33 33
==========================================
- Hits 9343 840 -8503
+ Misses 1618 226 -1392
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
Benchmarks
Benchmark execution time: 2024-04-09 19:54:04
Comparing candidate commit 7db89db5df9f91dd4140f20b113a886fb2c51841 in PR branch conti/change-dsm-hashing-to-match-other-tracers with baseline commit de47a4b7a1dc3a4d846d3a7c356504f508fe5ca1 in branch master.
Found 0 performance improvements and 0 performance regressions! Performance is the same for 259 metrics, 7 unstable metrics.
LGTM at a glance, but I have a few questions before approving.
First, is this propagated horizontally, and if yes, wouldn't that be a breaking change?
Second, I thought the algorithm didn't matter which is why we went with the one that was simpler for the language. Has that changed?
The backend will handle that correctly, no matter which way the change is deployed. It's true that the hashing algorithm is not critical, Node.js was the only one that was different though, so it's nice to have the consistency :)
This pull request has been marked as stale due to 90 days of inactivity.
If this is still relevant, please update or comment to keep it open.
If this should be kept open indefinitely, please apply the label keep-open.
Otherwise, it will be automatically closed after 14 days.
It's true that the hashing algorithm is not critical, Node.js was the only one that was different though, so it's nice to have the consistency :)
In a case like this I'd prioritize simpler code (so less overhead) instead of consistency if it doesn't otherwise matter.
While I generally believe it's good to align behavior when it deviates, I would not expect the hashing algorithm to be important for someone to handle the value. Any value should be handled in an identical way.
I believe these cases should be checked one by one. In this case, I agree with @rochdev and would just keep it as is. @wconti27 how was the difference actually detected, if I may ask?