CommonJS Support

[Zineeddine07]

Describe the Problem

I'm using this package in a Node.js application that relies on Dynatrace OneAgent for monitoring. However, since this package is ESM-only, Dynatrace attempts to instrument it which results in a [ERR_REQUIRE_ESM] error.

Issue:

Dynatrace OneAgent does not support ES module instrumentation properly.
This prevents applications using Dynatrace from utilizing this package in a CommonJS environment.

Propose a Solution

Would it be possible to add CommonJS support (e.g., by providing dual module support with both ESM and CommonJS exports)? This would allow broader support.

Describe Alternatives

No response

Affected Development Phase

Getting Started

Impact

No Impact

Timeline

No response

Additional Context

No response

[jjtang1985]

Hi @Zineeddine07 ,

Thanks for reaching out.

Could you please share more details about the steps to reproduce the issue, as I've never used the Dynatrace OneAgent.

Also, where did you deploy your application? BTP?

Best regards,
Junjie

[Zineeddine07]

Hi @junjie,

Thank you for your response,

Steps to Reproduce the Issue:

1. Create a sample CommonJS Node.js application that uses @sap-ai-sdk/ai-api.
   • Since this package is ESM-only, it must be dynamically imported using import().
2. Deploy the application on SAP BTP (Cloud Foundry) with Dynatrace OneAgent enabled as a bound service.
3. When the application starts, Dynatrace OneAgent attempts to instrument all loaded modules, including @sap-ai-sdk/ai-api.
4. Since Dynatrace hooks into module loading using require(), it fails with the following error:

   [ERR_REQUIRE_ESM]: require() of ES Module /home/vcap/app/node_modules/@sap-ai-sdk/ai-api/dist/index.js from /home/vcap/app/dist/apps/sample-app/ai-core.service.js not supported.
   

5. This issue prevents applications using Dynatrace from integrating this package unless they are fully ESM-based, which is not always feasible.

What I Tried:

• I injected Dynatrace OneAgent at build time → The issue still occurred.
• I injected Dynatrace OneAgent at runtime → The same error appeared.
• I also attempted using dynamic import(), but Dynatrace still tries to hook into the module and fails.

Deployment Details:

• The application is deployed on SAP BTP (Cloud Foundry) with Dynatrace OneAgent enabled as a bound service.

Let me know if you need any more details. Thanks again for looking into this!