Tree shaking tests fail if ESM build not yet completed

[pichlermarc]

What happened?

Steps to Reproduce

Using Node 18.12.1 (latest) and npm 8.19.2

• git clone https://github.com/open-telemetry/opentelemetry-js.git
• cd opentelemetry-js
• npm install
• npm run compile
• NODE_OPTIONS=--openssl-legacy-provider npm run test

Expected Result

Tests passing, as they do in CI.

Actual Result

@opentelemetry/api tree-shaking tests fail (see "Relevant log output below")

Additional Details

Also failing on Node 16.

OpenTelemetry Setup Code

n/a

package.json

n/a

Relevant log output

tree-shaking
    1) verify MetricsAPI
    2) verify PropagationAPI
    3) verify TraceAPI


  1110 passing (917ms)
  3 failing

  1) tree-shaking
       verify MetricsAPI:

      AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
+ actual - expected

  [
    'MetricsAPI',
+   'PropagationAPI',
+   'TraceAPI'
  ]
      + expected - actual

       [
         "MetricsAPI"
      -  "PropagationAPI"
      -  "TraceAPI"
       ]
      
      at Context.<anonymous> (test/tree-shaking/tree-shaking.test.ts:116:14)

  2) tree-shaking
       verify PropagationAPI:

      AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
+ actual - expected

  [
+   'MetricsAPI',
+   'PropagationAPI',
+   'TraceAPI'
-   'PropagationAPI'
  ]
      + expected - actual

       [
      -  "MetricsAPI"
         "PropagationAPI"
      -  "TraceAPI"
       ]
      
      at Context.<anonymous> (test/tree-shaking/tree-shaking.test.ts:116:14)

  3) tree-shaking
       verify TraceAPI:

      AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
+ actual - expected

  [
+   'MetricsAPI',
+   'PropagationAPI',
    'TraceAPI'
  ]
      + expected - actual

       [
      -  "MetricsAPI"
      -  "PropagationAPI"
         "TraceAPI"
       ]
      
      at Context.<anonymous> (test/tree-shaking/tree-shaking.test.ts:116:14)

[dyladan]

This can happen if the ESM version of the API package is not generated. You have to run npm run compile in the api directory before running tests. The non-esm version cannot be tree shaken at least by these tests

[dyladan]

I see that you actually did run npm run compile... Can you please try again and confirm that you are compiling the ESM versions? Passes for me locally if I run the ESM compile.

[legendecas]

Yeah, this requires the ESM targets are generated with npm run compile in the API directory. I'm experimenting with a dedicated script for managing those tsconfig targets at #3169. But it still needs more time to polish.

[legendecas]

Submitted #3432 to solve this problem. Please have a try on your local environments, thanks! :)