ESM Mode breaks when using openai package

[danilofuchs]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/browser

SDK Version

8.4.0

"openai": "^4.33.1"

Framework Version

Node 8.4.0

Link to Sentry event

No response

SDK Setup

// instrumentation.ts
Sentry.init({
  dsn: "",

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for performance monitoring.
  // We recommend adjusting this value in production
  tracesSampleRate: process.env.NODE_ENV === "prod" ? 0.2 : 1,
  profilesSampleRate: 1, // Relative to tracesSampleRate

  environment: process.env.NODE_ENV,
  enabled: process.env.NODE_ENV === "prod",
});

Steps to Reproduce

https://github.com/danilofuchs/sentry-esm-openai-repro

1. Add openai package
2. Instrument using instrumentation.js file
3. Run with node --import ./build/instrumentation.js build/server.js

Expected Result

Runs with Sentry instrumentation.

Perhaps related to #12059 and #12154 (import-in-the-middle bugs)

Actual Result

> node --import ./build/instrumentation.js build/server.js

file:///home/project/node_modules/openai/resources/beta/assistants/files.mjs:51
    Files.AssistantFilesPage = FilesAPI.AssistantFilesPage;
                                        ^

ReferenceError: Cannot access 'AssistantFilesPage' before initialization
    at file:///project/node_modules/openai/resources/beta/assistants/files.mjs:51:41
    at file:///home/project/node_modules/openai/resources/beta/assistants/files.mjs:52:3
    at ModuleJob.run (node:internal/modules/esm/module_job:222:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:323:24)
    at async loadESM (node:internal/process/esm_loader:28:7)
    at async handleMainPromise (node:internal/modules/run_main:113:12)

Node.js v20.12.2

files.mjs:51:41:

export class AssistantFilesPage extends CursorPage {
}
(function (Files) {
    Files.AssistantFilesPage = FilesAPI.AssistantFilesPage;
})(Files || (Files = {}));
//# sourceMappingURL=files.mjs.map

Obs:
Setting globalThis._sentryEsmLoaderHookRegistered = true; before Sentry.init fixes the crash but disables auto instrumentation

[AbhiPrasad]

I have a feeling that all these wildcard imports/exports does not play well

https://github.com/openai/openai-node/blob/d7d5610d91573740d7e3c27e4afde5650ee6e349/src/resources/beta/assistants.ts#L6-L11

[timfish]

@danilofuchs thank you so much for the minimal reproduction!

I don't get the same error but it's similar enough:

ReferenceError: Cannot access 'BatchesPage' before initialization
    at file:///Users/tim/Documents/Repositories/sentry-esm-openai-repro/node_modules/openai/resources/batches.mjs:35:38
    at file:///Users/tim/Documents/Repositories/sentry-esm-openai-repro/node_modules/openai/resources/batches.mjs:36:3
    at ModuleJob.run (node:internal/modules/esm/module_job:262:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:475:24)
    at async asyncRunEntryPointWithESMLoader (node:internal/modules/run_main:109:5)

My best guess at the moment is that this is a bug in import-in-the-middle caused by a circular reference within the file. For example, batches.mjs imports itself via import * as BatchesAPI from "./batches.mjs":

import { APIResource } from "../resource.mjs";
import { isRequestOptions } from "../core.mjs";
import * as BatchesAPI from "./batches.mjs";
import { CursorPage } from "../pagination.mjs";
export class Batches extends APIResource {
    /** snip implementation  */
}
export class BatchesPage extends CursorPage {
}
(function (Batches) {
    Batches.BatchesPage = BatchesAPI.BatchesPage;
})(Batches || (Batches = {}));

If I remove every circular import * reference (there are maybe 10-15 in the lib), it no longer errors:

    Batches.BatchesPage = BatchesPage;

I'll see if I can fix this in import-in-the-middle!

[timfish]

Here is the import-in-the-middle issue:
nodejs/import-in-the-middle#82

[timfish]

I opened another PR for import-in-the-middle that should fix this.

There is patch available here that combines all the outstanding open PRs.

[danilofuchs]

@timfish the latest patch fixes it for me!

[mydea]

Hello, we've just released v8.8.0, which should hopefully resolve this ESM problem. Let us know if you updated and are still running into problems!