Bug: Dynamic require error with ESM functions

[lukehedger]

Expected Behaviour

ESM Lambda function with Tracer enabled should be invoked without error

Current Behaviour

Lambda invocation error received:

{
  "errorType": "Error",
  "errorMessage": "Dynamic require of \"util\" is not supported",
  "trace": [
    "Error: Dynamic require of \"util\" is not supported",
    "    at file:///var/task/index.mjs:1:382",
    "    at <anonymous> (/node_modules/cls-hooked/context.js:4:14)",
    "    at file:///var/task/index.mjs:1:458",
    "    at <anonymous> (/node_modules/aws-xray-sdk-core/dist/lib/context_utils.js:5:11)",
    "    at file:///var/task/index.mjs:1:458",
    "    at <anonymous> (/node_modules/aws-xray-sdk-core/dist/lib/aws-xray.js:2:20)",
    "    at file:///var/task/index.mjs:1:458",
    "    at <anonymous> (/node_modules/aws-xray-sdk-core/dist/lib/index.js:3:18)",
    "    at file:///var/task/index.mjs:1:458",
    "    at <anonymous> (/node_modules/@aws-lambda-powertools/tracer/lib/esm/provider/ProviderService.js:1:21)"
  ]
}

Code snippet

Lambda function with following configuration in CDK app (some options removed for brevity):

new NodejsFunction(this, "MyFunction", {
  architecture: Architecture.ARM_64,
  bundling: {
    format: OutputFormat.ESM,
  },
  runtime: Runtime.NODEJS_20_X,
  tracing: Tracing.ACTIVE,
})

Steps to Reproduce

1. Deploy an ESM Lambda function with Tracer
2. Invoke function
3. Observe error

Possible Solution

No response

Powertools for AWS Lambda (TypeScript) version

latest

AWS Lambda function runtime

20.x

Packaging format used

npm

Execution logs

No response

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

[dreamorosi]

Hi @lukehedger, unfortunately this is expected and due to the fact that aws-xray-sdk-core - which we depend on - is built as a CommonJS module.

In order to still use it with your ESM functions you'll have to include a banner in the code that creates a polyfill for the require keyword:

import { Stack, type StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { NodejsFunction, OutputFormat } from 'aws-cdk-lib/aws-lambda-nodejs';
import { Runtime } from 'aws-cdk-lib/aws-lambda';

export class MyStack extends Stack {
  public constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const handler = new NodejsFunction(this, 'helloWorldFunction', {
      architecture: Architecture.ARM_64,
      bundling: {
        format: OutputFormat.ESM,
        banner: 
          "import { createRequire } from 'module';const require = createRequire(import.meta.url);", 
      },
      runtime: Runtime.NODEJS_20_X,
      tracing: Tracing.ACTIVE,
    });
  }
}

This is covered in the migration guide and the release notes for v2.

Let me know if adding it fixes the issue.

[lukehedger]

Thanks Andrea - missed this in the docs, works fine now!

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.