simplify storage.js, adding a bunch of comments for clarity#5203
Merged
simplify storage.js, adding a bunch of comments for clarity#5203
Conversation
Contributor
Overall package sizeSelf size: 8.62 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 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5203 +/- ##
==========================================
+ Coverage 80.62% 81.16% +0.53%
==========================================
Files 464 482 +18
Lines 20932 21522 +590
==========================================
+ Hits 16877 17468 +591
+ Misses 4055 4054 -1 ☔ View full report in Codecov by Sentry. |
rochdev
approved these changes
Feb 4, 2025
Datadog ReportBranch report: ✅ 0 Failed, 616 Passed, 0 Skipped, 15m 31.17s Total Time |
watson
reviewed
Feb 5, 2025
Comment on lines
+5
to
+10
| /// This is exactly the same as AsyncLocalStorage, with the exception that it | ||
| /// uses a WeakMap to store the store object. This is because ALS stores the | ||
| /// store object as a property of the resource object, which causes all sorts | ||
| /// of problems with logging and memory. We substitute the `store` object with | ||
| /// a "handle" object, which is used as a key in a WeakMap, where the values | ||
| /// are the real store objects. |
Collaborator
There was a problem hiding this comment.
I haven't seen this tripple slash commenting style before - is that on purpose?
| super.enterWith(handle) | ||
| } | ||
|
|
||
| // This is method is a passthrough to the real `getStore()`, so that, when we |
Collaborator
There was a problem hiding this comment.
Suggested change
| // This is method is a passthrough to the real `getStore()`, so that, when we | |
| // This method is a passthrough to the real `getStore()`, so that, when we |
rochdev
pushed a commit
that referenced
this pull request
Feb 7, 2025
* Make DatadogStorage extend from AsyncLocalStorage * Add comments everywhere
Merged
rochdev
pushed a commit
that referenced
this pull request
Feb 10, 2025
* Make DatadogStorage extend from AsyncLocalStorage * Add comments everywhere
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Motivation
This file is a confusing chunk of code, and it's worth spending a few minutes now to explain it as best as possible.