@opentelemetry/instrumentation/hook.mjs crashes when loading a module containing export * from syntax

[jaydenseric]

What happened?

Steps to Reproduce

Create a Node.js project with a package.json with the dependency @opentelemetry/instrumentation v0.49.1 properly installed.

Then, in a.mjs:

export const a = 1;
export const b = 2;

In b.mjs:

export * from "./a.mjs";

Then, with the the current version of the Node.js CLI (i.e. Node.js v21.7.1) run:

node --experimental-loader=@opentelemetry/instrumentation/hook.mjs b.mjs

Expected Result

Node.js script runs and exits without an error.

Actual Result

The Node.js script exits with an error, and this console output:

(node:33595) ExperimentalWarning: `--experimental-loader` may be removed in the future; instead use `register()`:
--import 'data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from "node:url"; register("%40opentelemetry/instrumentation/hook.mjs", pathToFileURL("./"));'
(Use `node --trace-warnings ...` to show where the warning was created)
file://[redacted]/b.mjs?iitm=true:6
let $* = namespace.*
     ^

SyntaxError: Unexpected token '*'
    at ModuleLoader.moduleStrategy (node:internal/modules/esm/translators:168:18)
    at callTranslator (node:internal/modules/esm/loader:279:14)
    at ModuleLoader.moduleProvider (node:internal/modules/esm/loader:285:30)
    at async link (node:internal/modules/esm/module_job:78:21)

Node.js v21.7.1

Additional Details

This is a really critical bug that's blocking us from instrumenting a Node.js project at work; it makes it impossible to instrument ESM dependencies like koa via @opentelemetry/instrumentation-koa in an ESM project.

OpenTelemetry Setup Code

// instrumentation.mts

import { AzureMonitorTraceExporter } from "@azure/monitor-opentelemetry-exporter";
import { createAzureSdkInstrumentation } from "@azure/opentelemetry-instrumentation-azure-sdk";
import { registerInstrumentations } from "@opentelemetry/instrumentation";
import { GraphQLInstrumentation } from "@opentelemetry/instrumentation-graphql";
import { HttpInstrumentation } from "@opentelemetry/instrumentation-http";
import { KoaInstrumentation } from "@opentelemetry/instrumentation-koa";
import { Resource } from "@opentelemetry/resources";
import { SimpleSpanProcessor } from "@opentelemetry/sdk-trace-base";
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { SEMRESATTRS_SERVICE_NAME } from "@opentelemetry/semantic-conventions";

import getOpenTelemetryServiceName from "../env/getOpenTelemetryServiceName.mjs";

const OTEL_SERVICE_NAME = getOpenTelemetryServiceName();

const tracerProvider = new NodeTracerProvider({
  resource: new Resource({
    // The OpenTelemetry “service name” becomes the Azure Application Insights
    // “cloud role name”.
    // https://learn.microsoft.com/en-us/javascript/api/overview/azure/monitor-opentelemetry-readme?view=azure-node-latest#set-the-cloud-role-name-and-the-cloud-role-instance
    [SEMRESATTRS_SERVICE_NAME]: OTEL_SERVICE_NAME,
  }),
});

tracerProvider.addSpanProcessor(
  new SimpleSpanProcessor(new AzureMonitorTraceExporter()),
);

tracerProvider.register();

registerInstrumentations({
  instrumentations: [
    new HttpInstrumentation(),
    new KoaInstrumentation(),
    new GraphQLInstrumentation(),
    createAzureSdkInstrumentation(),
  ],
  tracerProvider,
});

package.json

No response

Relevant log output

No response

[pichlermarc]

@jaydenseric thanks for reaching out.

Unfortunately we currently do not support instrumenting ESM in these Node.js versions as support for these versions has only been added in [email protected] and [email protected]. However, we currently cannot update as both of these new import-in-the-middle versions break our ESM instrumentations (see nodejs/import-in-the-middle#57)

I've opened a series of issues (one in this repo #4553) just now to better explain how a solution to the problem may come about. We're happy to accept contributions on the matter.

Further context:

• @@toStringTag property not present on modules passed to hookFn  nodejs/import-in-the-middle#57
• [instrumentation] support ESM instrumentation for Node.js v18.19, v20, v21 #4553 (just created earlier to give better visibility to the problem, contributions welcome)
• [all] support ESM instrumentation for Node.js v18.19, v20, v21 opentelemetry-js-contrib#2021 (just created earlier to give better visibility to the problem, contributions welcome)
• ESM tests are failing with Node v18.19.0 opentelemetry-js-contrib#1872

[bmxpiku]

@pichlermarc till which version it should work for ESM project?

[pichlermarc]

@pichlermarc till which version it should work for ESM project?

AFAIK only Node.js v18.18.2 is working at this point in time.