Improve support for esbuild + esm with DD_BUILD_ESM env var #5888

uurien · 2025-06-12T14:05:46Z

What does this PR do?

Improves support for esbuild + esm with DD_BUILD_ESM env var, fixing the issue with __dirname and __filename.

Motivation

Plugin Checklist

Additional Notes

github-actions · 2025-06-12T14:06:27Z

Overall package size

Self size: 9.7 MB
Deduped: 106.2 MB
No deduping: 106.72 MB

Dependency sizes

| name | version | self size | total size | |------|---------|-----------|------------| | @datadog/libdatadog | 0.7.0 | 35.02 MB | 35.02 MB | | @datadog/native-appsec | 8.5.2 | 19.33 MB | 19.34 MB | | @datadog/native-iast-taint-tracking | 4.0.0 | 11.72 MB | 11.73 MB | | @datadog/pprof | 5.8.2 | 9.56 MB | 9.93 MB | | @opentelemetry/core | 1.30.1 | 908.66 kB | 7.16 MB | | protobufjs | 7.5.3 | 2.95 MB | 5.6 MB | | @datadog/wasm-js-rewriter | 4.0.1 | 2.85 MB | 3.58 MB | | @datadog/native-metrics | 3.1.1 | 1.02 MB | 1.43 MB | | @opentelemetry/api | 1.8.0 | 1.21 MB | 1.21 MB | | import-in-the-middle | 1.14.0 | 120.58 kB | 841.68 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.1 | 109.9 kB | 109.9 kB | | lodash.sortby | 4.7.0 | 75.76 kB | 75.76 kB | | ignore | 5.3.2 | 53.63 kB | 53.63 kB | | istanbul-lib-coverage | 3.2.2 | 34.37 kB | 34.37 kB | | rfdc | 1.4.1 | 27.15 kB | 27.15 kB | | @isaacs/ttlcache | 1.4.1 | 25.2 kB | 25.2 kB | | dc-polyfill | 0.1.9 | 25.11 kB | 25.11 kB | | tlhunter-sorted-set | 0.1.0 | 24.94 kB | 24.94 kB | | shell-quote | 1.8.2 | 23.54 kB | 23.54 kB | | limiter | 1.1.5 | 23.17 kB | 23.17 kB | | retry | 0.13.1 | 18.85 kB | 18.85 kB | | semifies | 1.0.0 | 15.84 kB | 15.84 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 | | mutexify | 1.4.0 | 5.71 kB | 8.74 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.4 | 3.96 kB | 3.96 kB |

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

codecov · 2025-06-12T14:06:39Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.92%. Comparing base (7e95984) to head (7fd2099).
Report is 11 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5888      +/-   ##
==========================================
+ Coverage   80.74%   81.92%   +1.18%     
==========================================
  Files         462      439      -23     
  Lines       19905    19119     -786     
==========================================
- Hits        16073    15664     -409     
+ Misses       3832     3455     -377

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

datadog-datadog-prod-us1 · 2025-06-12T14:14:56Z

Datadog Report

Branch report: ugaitz/fix-esbuild-esm
Commit report: 6ed330d
Test service: dd-trace-js-integration-tests

✅ 0 Failed, 1259 Passed, 0 Skipped, 22m 11.05s Total Time

pr-commenter · 2025-06-13T07:39:48Z

Benchmarks

Benchmark execution time: 2025-06-17 15:52:13

Comparing candidate commit 7fd2099 in PR branch ugaitz/fix-esbuild-esm with baseline commit 7e95984 in branch master.

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

integration-tests/esbuild/index.spec.js

integration-tests/esbuild/package.json

packages/datadog-esbuild/index.js

BridgeAR

This seems to be a good pragmatic approach!
Could you please add a few more test cases for the different options? And the tests should probably not use process.exit() as it would prevent other tests to run.

packages/datadog-esbuild/index.js

Co-authored-by: Ruben Bridgewater <ruben@bridgewater.de>

integration-tests/esbuild/index.spec.js

BridgeAR

LGTM. Would this potentially also fix an open issue?

Tests failing

uurien · 2025-06-17T14:21:42Z

Would this potentially also fix an open issue?

I would say no. I can't find any issue related with esbuild build process with ESM, or esbuild app crashing in the issues.

Checking here:
https://github.com/DataDog/dd-trace-js/issues?q=is%3Aissue%20state%3Aopen%20esbuild

BridgeAR

LGTM. I just left some suggestions that would make things a bit cleaner in my opinion.

BridgeAR · 2025-06-17T14:55:44Z

integration-tests/esbuild/build-and-run.esm-patched-const-banner.js

+}).catch((err) => {
+  console.error(err)
+  process.exit(1)


Nit: calling process.exit(1) is mostly an indicator that something is not working as expected.
Here, if we'd change the files to mjs files, we could just use top level await and things should work as expected.

The same applies to the other files.

BridgeAR · 2025-06-17T14:57:42Z

integration-tests/esbuild/index.spec.js

+      afterEach(() => {
+        fs.rmSync('./out.mjs', { force: true })
+        fs.rmSync('./out.js', { force: true })
+        fs.rmSync('./basic-test.mjs', { force: true })


If we move the cleanup to the file that runs the test by using a finally block, we'd not have to list them here.
That feels a tad cleaner.

There are some tests that are checking the content of the files, like this one: https://github.com/DataDog/dd-trace-js/pull/5888/files/13e26af2feb6a6d3a14d1677cdbebe29bfd08a07

I don't want to move these checks to the file running the tests, imo the test logic is better here. imho build & run are more than enough to have in separate files.

Fix __dirname and __filename in esbuild + esm by adding globals to the banner option.

Add failing test for esbuild esm

d5c2f4b

uurien added the semver-patch label Jun 12, 2025

Possible approach to fix __dirname and __filename in esbuild + esm

bf4d4f5

uurien added 4 commits June 13, 2025 10:49

Fix lint

06baf01

Merge branch 'master' into ugaitz/fix-esbuild-esm

021718c

Use safer var names

819001e

Correct support to process.env.DD_BUILD_ESM

224ff11

uurien changed the title ~~Add failing test for esbuild esm~~ Improve support for esbuild + esm with DD_BUILD_ESM env var Jun 13, 2025

Restore accidentally changed dependency

5d8de00

uurien marked this pull request as ready for review June 13, 2025 14:08

uurien requested a review from a team as a code owner June 13, 2025 14:08

BridgeAR reviewed Jun 13, 2025

View reviewed changes

integration-tests/esbuild/index.spec.js Outdated Show resolved Hide resolved

integration-tests/esbuild/package.json Outdated Show resolved Hide resolved

packages/datadog-esbuild/index.js Outdated Show resolved Hide resolved

Use globals instead of const and stop using env var

62d1d8c

tlhunter reviewed Jun 13, 2025

View reviewed changes

packages/datadog-esbuild/index.js Show resolved Hide resolved

BridgeAR requested changes Jun 14, 2025

View reviewed changes

packages/datadog-esbuild/index.js Outdated Show resolved Hide resolved

uurien and others added 4 commits June 16, 2025 15:43

Update packages/datadog-esbuild/index.js

1fae9cc

Co-authored-by: Ruben Bridgewater <ruben@bridgewater.de>

Add more tests

cd57f71

More tests

cc50961

improve test

2d61d2e

tlhunter reviewed Jun 16, 2025

View reviewed changes

integration-tests/esbuild/index.spec.js Outdated Show resolved Hide resolved

Update integration-tests/esbuild/index.spec.js

185e83f

tlhunter previously approved these changes Jun 16, 2025

View reviewed changes

BridgeAR previously approved these changes Jun 17, 2025

View reviewed changes

Fixing tests

5b172f0

uurien dismissed tlhunter’s stale review via 5b172f0 June 17, 2025 13:56

uurien added 2 commits June 17, 2025 16:07

fix test

f6fdae9

fix lint

13e26af

BridgeAR previously approved these changes Jun 17, 2025

View reviewed changes

Use ESM to use top level await and remove catches with exit

b38d6e1

uurien dismissed BridgeAR’s stale review via b38d6e1 June 17, 2025 15:25

Fix

7fd2099

BridgeAR approved these changes Jun 17, 2025

View reviewed changes

BridgeAR enabled auto-merge (squash) June 17, 2025 16:36

BridgeAR merged commit 65e18d0 into master Jun 17, 2025
618 of 620 checks passed

BridgeAR deleted the ugaitz/fix-esbuild-esm branch June 17, 2025 16:38

dd-trace-js bot pushed a commit that referenced this pull request Jun 18, 2025

Improve support for esbuild + esm with DD_BUILD_ESM env var (#5888)

6827531

Fix __dirname and __filename in esbuild + esm by adding globals to the banner option.

dd-trace-js bot mentioned this pull request Jun 18, 2025

v5.57.0 proposal #5893

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve support for esbuild + esm with DD_BUILD_ESM env var #5888

Improve support for esbuild + esm with DD_BUILD_ESM env var #5888

Uh oh!

uurien commented Jun 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 12, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 12, 2025 •

edited

Loading

Uh oh!

datadog-datadog-prod-us1 bot commented Jun 12, 2025 •

edited

Loading

Uh oh!

pr-commenter bot commented Jun 13, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BridgeAR left a comment

Uh oh!

Uh oh!

Uh oh!

BridgeAR left a comment

Uh oh!

uurien commented Jun 17, 2025

Uh oh!

BridgeAR left a comment

Uh oh!

BridgeAR Jun 17, 2025

Uh oh!

BridgeAR Jun 17, 2025

Uh oh!

uurien Jun 17, 2025

Uh oh!

Uh oh!

Uh oh!

Improve support for esbuild + esm with DD_BUILD_ESM env var #5888

Improve support for esbuild + esm with DD_BUILD_ESM env var #5888

Uh oh!

Conversation

uurien commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Plugin Checklist

Additional Notes

Uh oh!

github-actions bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overall package size

Uh oh!

codecov bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

datadog-datadog-prod-us1 bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Datadog Report

Uh oh!

pr-commenter bot commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmarks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

uurien commented Jun 17, 2025

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

BridgeAR Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

BridgeAR Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

uurien Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

uurien commented Jun 12, 2025 •

edited

Loading

github-actions bot commented Jun 12, 2025 •

edited

Loading

codecov bot commented Jun 12, 2025 •

edited

Loading

datadog-datadog-prod-us1 bot commented Jun 12, 2025 •

edited

Loading

pr-commenter bot commented Jun 13, 2025 •

edited

Loading