test(e2e): Add e2e test for AWS lambda in ESM mode (#12833)

Add an E2E test app that simulates running an AWS lambda
function in ESM mode. At the same time, this test app represents the
state of how to manually use the `@sentry/aws-serverless` SDK for
ESM-based lambda functions.

Author: Lms24

.github/workflows/build.yml

@@ -995,6 +995,7 @@ jobs:
             'angular-17',
             'angular-18',
             'aws-lambda-layer-cjs',
+            'aws-serverless-esm',
             'node-express',
             'create-react-app',
             'create-next-app',

dev-packages/e2e-tests/package.json

@@ -23,7 +23,8 @@
     "esbuild": "0.20.0",
     "glob": "8.0.3",
     "ts-node": "10.9.1",
-    "yaml": "2.2.2"
+    "yaml": "2.2.2",
+    "rimraf": "^5.0.0"
   },
   "volta": {
     "extends": "../../package.json",

dev-packages/e2e-tests/test-applications/aws-serverless-esm/.npmrc

@@ -0,0 +1,2 @@
+@sentry:registry=http://127.0.0.1:4873
+@sentry-internal:registry=http://127.0.0.1:4873

dev-packages/e2e-tests/test-applications/aws-serverless-esm/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "node-express-app",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "start": "node src/run.mjs",
+    "test": "playwright test",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
+    "test:build": "pnpm install",
+    "test:assert": "pnpm test"
+  },
+  "dependencies": {
+    "@sentry/aws-serverless": "* || latest"
+  },
+  "devDependencies": {
+    "@sentry-internal/test-utils": "link:../../../test-utils",
+    "@playwright/test": "^1.41.1",
+    "wait-port": "1.0.4"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

dev-packages/e2e-tests/test-applications/aws-serverless-esm/playwright.config.ts

@@ -0,0 +1,27 @@
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
+
+// Fix urls not resolving to localhost on Node v17+
+// See: https://github.com/axios/axios/issues/3821#issuecomment-1413727575
+import { setDefaultResultOrder } from 'dns';
+setDefaultResultOrder('ipv4first');
+
+const eventProxyPort = 3031;
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+const config = getPlaywrightConfig(
+  { startCommand: '' },
+  {
+    /* Run your local dev server before starting the tests */
+    webServer: [
+      {
+        command: `node start-event-proxy.mjs && pnpm wait-port ${eventProxyPort}`,
+        port: eventProxyPort,
+        stdout: 'pipe',
+      },
+    ],
+  },
+);
+
+export default config;

dev-packages/e2e-tests/test-applications/aws-serverless-esm/src/lambda-function.mjs

@@ -0,0 +1,26 @@
+import * as http from 'node:http';
+import * as Sentry from '@sentry/aws-serverless';
+
+const handler = Sentry.wrapHandler(async () => {
+  await new Promise(resolve => {
+    const req = http.request(
+      {
+        host: 'example.com',
+      },
+      res => {
+        res.on('data', d => {
+          process.stdout.write(d);
+        });
+
+        res.on('end', () => {
+          resolve();
+        });
+      },
+    );
+    req.end();
+  });
+
+  Sentry.startSpan({ name: 'manual-span', op: 'manual' }, () => {});
+});
+
+export { handler };

dev-packages/e2e-tests/test-applications/aws-serverless-esm/src/package.json

@@ -0,0 +1,5 @@
+{
+  "//": "This is a mock package.json file which is usually created by AWS when deploying the lambda. OTEL instrumentation tries to read this file to get the lambda version",
+  "name": "lambda",
+  "version": "1.0.0"
+}

dev-packages/e2e-tests/test-applications/aws-serverless-esm/src/run-lambda.mjs

@@ -0,0 +1,10 @@
+import { handler } from './lambda-function.mjs';
+
+// Simulate minimal event and context objects being passed to the handler by the AWS runtime
+const event = {};
+const context = {
+  invokedFunctionArn: 'arn:aws:lambda:us-east-1:123453789012:function:my-lambda',
+  functionName: 'my-lambda',
+};
+
+await handler(event, context);

dev-packages/e2e-tests/test-applications/aws-serverless-esm/src/run.mjs

@@ -0,0 +1,16 @@
+import child_process from 'child_process';
+
+child_process.execSync('node ./src/run-lambda.mjs', {
+  stdio: 'inherit',
+  env: {
+    ...process.env,
+    // On AWS, LAMBDA_TASK_ROOT is usually /var/task but for testing, we set it to the CWD to correctly apply our handler
+    LAMBDA_TASK_ROOT: process.cwd(),
+    _HANDLER: 'src/lambda-function.handler',
+
+    NODE_OPTIONS: '--import @sentry/aws-serverless/awslambda-auto',
+    SENTRY_DSN: 'http://public@localhost:3031/1337',
+    SENTRY_TRACES_SAMPLE_RATE: '1.0',
+  },
+  cwd: process.cwd(),
+});

dev-packages/e2e-tests/test-applications/aws-serverless-esm/start-event-proxy.mjs

@@ -0,0 +1,7 @@
+import { startEventProxyServer } from '@sentry-internal/test-utils';
+
+startEventProxyServer({
+  port: 3031,
+  proxyServerName: 'aws-serverless-esm',
+  forwardToSentry: false,
+});