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

Fix stack trace collection for appsec events #4410

Merged
merged 6 commits into from
Jun 21, 2024

Conversation

CarlesDD
Copy link
Contributor

@CarlesDD CarlesDD commented Jun 18, 2024

What does this PR do?

Fix and address some issues with stack trace collection.

  • Improve testing
  • Avoid failing when frame has no filename
  • Handle non-array CallsiteList

Motivation

Have a more robust stack trace collection

Copy link

github-actions bot commented Jun 18, 2024

Overall package size

Self size: 6.71 MB
Deduped: 61.96 MB
No deduping: 62.24 MB

Dependency sizes

name version self size total size
@datadog/native-appsec 8.0.1 15.59 MB 15.6 MB
@datadog/native-iast-taint-tracking 2.1.0 14.91 MB 14.92 MB
@datadog/pprof 5.3.0 9.85 MB 10.22 MB
protobufjs 7.2.5 2.77 MB 6.56 MB
@datadog/native-iast-rewriter 2.3.1 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.8.0 1.21 MB 1.21 MB
import-in-the-middle 1.7.4 70.19 kB 739.86 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
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
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
module-details-from-path 1.0.3 4.47 kB 4.47 kB

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

@CarlesDD CarlesDD force-pushed the ccapell/fix-stack-trace-collection branch from 5f98e21 to 8ed8192 Compare June 18, 2024 14:28
Copy link

codecov bot commented Jun 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.19%. Comparing base (5278b1c) to head (8ed8192).
Report is 7 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #4410       +/-   ##
===========================================
- Coverage   80.42%   69.19%   -11.24%     
===========================================
  Files           3        1        -2     
  Lines         373      198      -175     
  Branches       33       33               
===========================================
- Hits          300      137      -163     
+ Misses         73       61       -12     

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

@pr-commenter
Copy link

pr-commenter bot commented Jun 18, 2024

Benchmarks

Benchmark execution time: 2024-06-18 15:04:57

Comparing candidate commit 8ed8192 in PR branch ccapell/fix-stack-trace-collection with baseline commit 3b479d0 in branch master.

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

scenario:plugin-graphql-with-depth-and-collapse-on-18

  • 🟩 max_rss_usage [-146.458MB; -125.506MB] or [-15.089%; -12.930%]

@CarlesDD CarlesDD marked this pull request as ready for review June 18, 2024 15:19
@CarlesDD CarlesDD requested a review from a team as a code owner June 18, 2024 15:19
@@ -27,19 +27,17 @@ function getCallSiteList (maxDepth = 100) {
}

function filterOutFramesFromLibrary (callSiteList) {
return callSiteList.filter(callSite => !callSite.getFileName().includes(ddBasePath))
return callSiteList.filter(callSite => !callSite.getFileName()?.startsWith(ddBasePath))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding that optional chaining has a side effect:
if startsWith is not a method of the intermediary value, that means it's probably not a string, so null or undefined ? if that's the case the ! at the start of the arrow function will turn it into a true, and filter() will keep it in the array, i don't think that's intended right ? or what was your thought behind adding the optional chaining ?

Copy link
Contributor Author

@CarlesDD CarlesDD Jun 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's intended. There are some frames - like the ones the call take place in code defined by a call to eval - for what getFileName() returns null.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And do we want to keep those in callSiteList ?

@CarlesDD CarlesDD merged commit e695e44 into master Jun 21, 2024
134 checks passed
@CarlesDD CarlesDD deleted the ccapell/fix-stack-trace-collection branch June 21, 2024 06:53
juan-fernandez pushed a commit that referenced this pull request Jul 10, 2024
* Fix null filename on frame filtering

* Use startsWith instead of includes on callSite filename check

* Rework stack trace reporting when callistelist is undefined

* Avoid checking for max stack trace depth twice

* Use Array(n).fill() instead of [...Array(n).keys()]

* Fix linting
juan-fernandez pushed a commit that referenced this pull request Jul 10, 2024
* Fix null filename on frame filtering

* Use startsWith instead of includes on callSite filename check

* Rework stack trace reporting when callistelist is undefined

* Avoid checking for max stack trace depth twice

* Use Array(n).fill() instead of [...Array(n).keys()]

* Fix linting
juan-fernandez pushed a commit that referenced this pull request Jul 11, 2024
* Fix null filename on frame filtering

* Use startsWith instead of includes on callSite filename check

* Rework stack trace reporting when callistelist is undefined

* Avoid checking for max stack trace depth twice

* Use Array(n).fill() instead of [...Array(n).keys()]

* Fix linting
juan-fernandez pushed a commit that referenced this pull request Jul 11, 2024
* Fix null filename on frame filtering

* Use startsWith instead of includes on callSite filename check

* Rework stack trace reporting when callistelist is undefined

* Avoid checking for max stack trace depth twice

* Use Array(n).fill() instead of [...Array(n).keys()]

* Fix linting
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