[DI] Improve path matching algorithm for probe file paths #5166
Conversation
This file contains 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
Overall package sizeSelf size: 8.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.6.1 | 2.59 MB | 2.73 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 #5166 +/- ##
=======================================
Coverage 81.07% 81.07%
=======================================
Files 479 479
Lines 21342 21342
=======================================
Hits 17303 17303
Misses 4039 4039 ☔ View full report in Codecov by Sentry. |
watson
force-pushed
the
watson/DEBUG-3408/unknown-path-prefix
branch
from
ea0dcd1 to
c5883ec
Compare
BenchmarksBenchmark execution time: 2025-01-31 11:14:09 Comparing candidate commit 1274ab1 in PR branch Found 0 performance improvements and 1 performance regressions! Performance is the same for 909 metrics, 23 unstable metrics. scenario:plugin-graphql-with-async-hooks-22
|
If there's no match for a known script based on the probe file path provided via RC, try to remove the base directory and try to match again. Continue this approach, until there's no more directories in the path. This can happen if the user-provided file path contains a base directory, but this directory isn't part of the deployed code base. This would for example be the case if the files are stored in a sub-directory in the git repo, but deployed into a different directory in production.
watson
force-pushed
the
watson/DEBUG-3408/unknown-path-prefix
branch
2 times, most recently
from
8f2feb8 to
60f46f9
Compare
Datadog ReportBranch report: ✅ 0 Failed, 616 Passed, 0 Skipped, 14m 48.67s Total Time |
watson
force-pushed
the
watson/DEBUG-3408/unknown-path-prefix
branch
from
60f46f9 to
b3ea372
Compare
watson
changed the title
watson
commented
Jan 31, 2025
| * @param {string} path | ||
| * @returns {[string, string] | undefined} | ||
| * @param {string} path - Partial or absolute path to match against loaded scripts | ||
| * @returns {[string, string, string | undefined] | null} - Array containing [url, scriptId, sourceMapURL] |
There was a problem hiding this comment.
Change of return value is partly unrelated to this PR, but the JSDoc return value was out of date, so fixed it while I was here
rochdev
approved these changes
Jan 31, 2025
juan-fernandez
approved these changes
Jan 31, 2025
watson
added a commit
that referenced
this pull request
Jan 31, 2025
Change the path matching algorithm used to match a probe file path against the list of loaded module paths. The new algorithm supports Windows paths and path prefixes and has fewer false positives.
Merged
shatzi
reviewed
Jan 31, 2025
|
|
||
| it('should abort if the path is undefined', testPathNoMatch(undefined)) | ||
|
|
||
| it('should abort if the path is an empty string', testPathNoMatch('')) |
There was a problem hiding this comment.
maybe also check '/' and '\' or 'c:' to ensure there are no errors.
watson
added a commit
that referenced
this pull request
Jan 31, 2025
Change the path matching algorithm used to match a probe file path against the list of loaded module paths. The new algorithm supports Windows paths and path prefixes and has fewer false positives.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
Change the path matching algorithm used to match a probe file path against the list of loaded module paths. The new algorithm supports Windows paths and path prefixes and has fewer false positives.
Motivation
Ensure there's a higher chance of a match given the file path provided via RC.
The problem with path prefixes can occur if the user-provided file path contains a base directory, but this directory isn't part of the deployed code base. This would for example be the case if the files are stored in a sub-directory in the git repo (which is common for mono-repos), but deployed into a different directory in production. Or it can occur if the user copy-pastes the full local path from their development machine.
Plugin Checklist