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

[ASM] multer instrumentation #4781

Merged
merged 21 commits into from
Oct 29, 2024
Merged

[ASM] multer instrumentation #4781

merged 21 commits into from
Oct 29, 2024

Conversation

iunanua
Copy link
Contributor

@iunanua iunanua commented Oct 15, 2024

What does this PR do?

multer instrumentation

Motivation

be able to handle multipart request bodies parsed with multer

ST: DataDog/system-tests#3249

Plugin Checklist

Additional Notes

Copy link

github-actions bot commented Oct 15, 2024

Overall package size

Self size: 7.61 MB
Deduped: 64.47 MB
No deduping: 64.81 MB

Dependency sizes | name | version | self size | total size | |------|---------|-----------|------------| | @datadog/native-appsec | 8.2.1 | 19.18 MB | 19.19 MB | | @datadog/native-iast-taint-tracking | 3.2.0 | 13.9 MB | 13.91 MB | | @datadog/pprof | 5.4.1 | 9.76 MB | 10.13 MB | | protobufjs | 7.2.5 | 2.77 MB | 5.16 MB | | @datadog/native-iast-rewriter | 2.5.0 | 2.51 MB | 2.65 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.11.2 | 112.74 kB | 826.22 kB | | msgpack-lite | 0.1.26 | 201.16 kB | 281.59 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 | | 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 | | rfdc | 1.3.1 | 25.21 kB | 25.21 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 | | koalas | 1.0.2 | 6.47 kB | 6.47 kB | | path-to-regexp | 0.1.10 | 6.38 kB | 6.38 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

@pr-commenter
Copy link

pr-commenter bot commented Oct 15, 2024

Benchmarks

Benchmark execution time: 2024-10-25 13:09:26

Comparing candidate commit a19cade in PR branch igor/multer with baseline commit c007354 in branch master.

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

@iunanua iunanua marked this pull request as ready for review October 23, 2024 07:25
@iunanua iunanua requested review from a team as code owners October 23, 2024 07:25
@iunanua iunanua changed the title multer instrumentation [ASM] multer instrumentation Oct 23, 2024
Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.09%. Comparing base (fd0f570) to head (5f48710).
Report is 24 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #4781       +/-   ##
===========================================
+ Coverage   68.58%   98.09%   +29.51%     
===========================================
  Files          12        1       -11     
  Lines         818      105      -713     
===========================================
- Hits          561      103      -458     
+ Misses        257        2      -255     

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

Comment on lines +32 to +33
const nextResource = new AsyncResource('bound-anonymous-fn')
arguments[2] = nextResource.bind(publishRequestBodyAndNext(req, res, next))
Copy link
Collaborator

Choose a reason for hiding this comment

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

why are we checking this multerReadCh.hasSubscribers in line 14 and not here? imo, we should prevent creating AsyncResource when appsec/iast is not enabled.

Suggested change
const nextResource = new AsyncResource('bound-anonymous-fn')
arguments[2] = nextResource.bind(publishRequestBodyAndNext(req, res, next))
if (multerReadCh.hasSubscribers) {
const nextResource = new AsyncResource('bound-anonymous-fn')
arguments[2] = nextResource.bind(publishRequestBodyAndNext(req, res, next))
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i was inspired by body-parser instrumentation

@iunanua iunanua merged commit e94c682 into master Oct 29, 2024
208 checks passed
@iunanua iunanua deleted the igor/multer branch October 29, 2024 11:17
rochdev pushed a commit that referenced this pull request Oct 31, 2024
* multer instrumentation

* clean up test

* unsubscribe multer

* multer CI tests

* multer CI plugins tests

* Change multer version range

* Specify the version

* second try

* third

* multer request blocking integration test

* include iast tainting multer body test

* fix test

* Update integration-tests/multer.spec.js

Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>

* Move taint multipart body test to the integration test

* delete test

* Move multer tests inside appsec

* Include test not using multer middleware

---------

Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>
rochdev pushed a commit that referenced this pull request Oct 31, 2024
* multer instrumentation

* clean up test

* unsubscribe multer

* multer CI tests

* multer CI plugins tests

* Change multer version range

* Specify the version

* second try

* third

* multer request blocking integration test

* include iast tainting multer body test

* fix test

* Update integration-tests/multer.spec.js

Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>

* Move taint multipart body test to the integration test

* delete test

* Move multer tests inside appsec

* Include test not using multer middleware

---------

Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>
rochdev pushed a commit that referenced this pull request Oct 31, 2024
* multer instrumentation

* clean up test

* unsubscribe multer

* multer CI tests

* multer CI plugins tests

* Change multer version range

* Specify the version

* second try

* third

* multer request blocking integration test

* include iast tainting multer body test

* fix test

* Update integration-tests/multer.spec.js

Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>

* Move taint multipart body test to the integration test

* delete test

* Move multer tests inside appsec

* Include test not using multer middleware

---------

Co-authored-by: Ugaitz Urien <ugaitz.urien@datadoghq.com>
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.

5 participants