test(e2e): Enable ESM loader test (#12020)

mydea · web-flow · commit 42e9b239e961 · 2024-05-15T14:38:33.000+02:00
Supersedes #11912 I just cleaned up and renamed this to align with other things
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1003,7 +1003,7 @@ jobs:
             'create-remix-app-express',
             'create-remix-app-express-vite-dev',
             'debug-id-sourcemaps',
-            # 'esm-loader-node-express-app', # This is currently broken for upstream reasons. See https://github.com/getsentry/sentry-javascript/pull/11338#issuecomment-2025450675
+            'node-express-esm-loader',
             'nextjs-app-dir',
             'nextjs-14',
             'react-create-hash-router',
diff --git a/dev-packages/e2e-tests/test-applications/angular-17/package.json b/dev-packages/e2e-tests/test-applications/angular-17/package.json
@@ -11,7 +11,7 @@
     "test": "playwright test",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:assert": "playwright test",
-    "clean": "npx rimraf .angular,node_modules,pnpm-lock.yaml,dist"
+    "clean": "npx rimraf .angular node_modules pnpm-lock.yaml dist"
   },
   "private": true,
   "dependencies": {
diff --git a/dev-packages/e2e-tests/test-applications/cloudflare-astro/package.json b/dev-packages/e2e-tests/test-applications/cloudflare-astro/package.json
@@ -7,7 +7,7 @@
     "astro": "astro",
     "build": "astro build",
     "build:bundle": "astro build",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "dev": "astro dev",
     "preview": "astro preview",
     "start": "astro dev",
diff --git a/dev-packages/e2e-tests/test-applications/create-next-app/package.json b/dev-packages/e2e-tests/test-applications/create-next-app/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "build": "next build",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:prod": "TEST_ENV=prod playwright test",
     "test:dev": "TEST_ENV=dev playwright test",
     "test:build": "pnpm install && npx playwright install && pnpm build",
diff --git a/dev-packages/e2e-tests/test-applications/create-react-app/package.json b/dev-packages/e2e-tests/test-applications/create-react-app/package.json
@@ -22,7 +22,7 @@
     "build": "react-scripts build",
     "test": "react-scripts test",
     "eject": "react-scripts eject",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && pnpm build",
     "test:build-ts3.8": "pnpm install && pnpm add typescript@3.8 && pnpm build",
     "test:build-canary": "pnpm install && pnpm add react@canary react-dom@canary && pnpm build",
diff --git a/dev-packages/e2e-tests/test-applications/create-remix-app-express-vite-dev/package.json b/dev-packages/e2e-tests/test-applications/create-remix-app-express-vite-dev/package.json
@@ -7,7 +7,7 @@
     "lint": "eslint --ignore-path .gitignore --cache --cache-location ./node_modules/.cache/eslint .",
     "start": "cross-env NODE_ENV=production node ./server.mjs",
     "typecheck": "tsc",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:assert": "pnpm playwright test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/create-remix-app-express/package.json b/dev-packages/e2e-tests/test-applications/create-remix-app-express/package.json
@@ -8,7 +8,7 @@
     "lint": "eslint --ignore-path .gitignore --cache --cache-location ./node_modules/.cache/eslint .",
     "start": "cross-env NODE_ENV=production node ./server.mjs",
     "typecheck": "tsc",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:assert": "pnpm playwright test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/create-remix-app-v2/package.json b/dev-packages/e2e-tests/test-applications/create-remix-app-v2/package.json
@@ -6,7 +6,7 @@
     "dev": "remix dev",
     "start": "remix-serve build/index.js",
     "typecheck": "tsc",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:assert": "pnpm playwright test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/create-remix-app/package.json b/dev-packages/e2e-tests/test-applications/create-remix-app/package.json
@@ -6,7 +6,7 @@
     "dev": "remix dev",
     "start": "remix-serve build",
     "typecheck": "tsc",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:assert": "pnpm playwright test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/debug-id-sourcemaps/package.json b/dev-packages/e2e-tests/test-applications/debug-id-sourcemaps/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "build": "rollup --config rollup.config.mjs",
     "test": "vitest run",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && pnpm build",
     "test:assert": "pnpm test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/esm-loader-node-express-app/tests/server.test.ts b/dev-packages/e2e-tests/test-applications/esm-loader-node-express-app/tests/server.test.ts
diff --git a/dev-packages/e2e-tests/test-applications/nextjs-14/package.json b/dev-packages/e2e-tests/test-applications/nextjs-14/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "build": "next build > .tmp_build_stdout 2> .tmp_build_stderr || (cat .tmp_build_stdout && cat .tmp_build_stderr && exit 1)",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:prod": "TEST_ENV=production playwright test",
     "test:dev": "TEST_ENV=development playwright test",
     "test:build": "pnpm install && npx playwright install && pnpm build",
diff --git a/dev-packages/e2e-tests/test-applications/nextjs-app-dir/package.json b/dev-packages/e2e-tests/test-applications/nextjs-app-dir/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "build": "next build > .tmp_build_stdout 2> .tmp_build_stderr || (cat .tmp_build_stdout && cat .tmp_build_stderr && exit 1)",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:prod": "TEST_ENV=production playwright test",
     "test:dev": "TEST_ENV=development playwright test",
     "test:build": "pnpm install && npx playwright install && pnpm build",
diff --git a/dev-packages/e2e-tests/test-applications/node-exports-test-app/package.json b/dev-packages/e2e-tests/test-applications/node-exports-test-app/package.json
@@ -7,7 +7,7 @@
     "build": "tsc",
     "start": "pnpm build && bun run ./dist/consistentExports.js",
     "test": " bun run ./dist/consistentExports.js",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml,dist",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml dist",
     "test:build": "pnpm install && pnpm build",
     "test:assert": "pnpm test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/.npmrc b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/.npmrc
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/package.json b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/package.json
@@ -1,20 +1,17 @@
 {
-  "name": "node-express-app",
+  "name": "node-express-esm-loader",
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "start": "node --import=@sentry/node/import-hook src/app.mjs",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "start": "node --import ./src/instrument.mjs src/app.mjs",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install",
     "test:assert": "playwright test"
   },
   "dependencies": {
     "@sentry/node": "latest || *",
-    "@sentry/types": "latest || *",
-    "express": "4.19.2",
-    "@types/express": "4.17.17",
-    "@types/node": "18.15.1",
-    "typescript": "4.9.5"
+    "@sentry/opentelemetry": "latest || *",
+    "express": "4.19.2"
   },
   "devDependencies": {
     "@sentry-internal/event-proxy-server": "link:../../../event-proxy-server",
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/playwright.config.ts b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/playwright.config.ts
@@ -55,6 +55,8 @@ const config: PlaywrightTestConfig = {
     {
       command: 'node start-event-proxy.mjs',
       port: eventProxyPort,
+      stdout: 'pipe',
+      stderr: 'pipe',
     },
     {
       command: 'pnpm start',
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/src/app.mjs b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/src/app.mjs
@@ -1,13 +1,6 @@
-import * as Sentry from '@sentry/node';
-
-Sentry.init({
-  environment: 'qa', // dynamic sampling bias to keep transactions
-  dsn: process.env.E2E_TEST_DSN,
-  debug: true,
-  tunnel: `http://localhost:3031/`, // proxy server
-  tracesSampleRate: 1,
-});
+// @ts-check
 
+import * as Sentry from '@sentry/node';
 import express from 'express';
 
 const app = express();
@@ -36,7 +29,6 @@ app.get('/test-error', function (req, res) {
 
 Sentry.setupExpressErrorHandler(app);
 
-// @ts-ignore
 app.use(function onError(err, req, res, next) {
   // The error id is attached to `res.sentry` to be returned
   // and optionally displayed to the user for support.
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/src/instrument.mjs b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/src/instrument.mjs
@@ -0,0 +1,8 @@
+import * as Sentry from '@sentry/node';
+
+Sentry.init({
+  environment: 'qa', // dynamic sampling bias to keep transactions
+  dsn: process.env.E2E_TEST_DSN,
+  tunnel: `http://localhost:3031/`, // proxy server
+  tracesSampleRate: 1,
+});
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/start-event-proxy.mjs b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/start-event-proxy.mjs
@@ -2,5 +2,5 @@ import { startEventProxyServer } from '@sentry-internal/event-proxy-server';
 
 startEventProxyServer({
   port: 3031,
-  proxyServerName: 'esm-loader-node-express-app',
+  proxyServerName: 'node-express-esm-loader',
 });
diff --git a/dev-packages/e2e-tests/test-applications/node-express-esm-loader/tests/server.test.ts b/dev-packages/e2e-tests/test-applications/node-express-esm-loader/tests/server.test.ts
@@ -0,0 +1,117 @@
+import { expect, test } from '@playwright/test';
+import { waitForError, waitForTransaction } from '@sentry-internal/event-proxy-server';
+
+test('Should record exceptions captured inside handlers', async ({ request }) => {
+  const errorEventPromise = waitForError('node-express-esm-loader', errorEvent => {
+    return !!errorEvent?.exception?.values?.[0]?.value?.includes('This is an error');
+  });
+
+  await request.get('/test-error');
+
+  await expect(errorEventPromise).resolves.toBeDefined();
+});
+
+test('Should record a transaction for a parameterless route', async ({ request }) => {
+  const transactionEventPromise = waitForTransaction('node-express-esm-loader', transactionEvent => {
+    return transactionEvent?.transaction === 'GET /test-success';
+  });
+
+  await request.get('/test-success');
+
+  await expect(transactionEventPromise).resolves.toBeDefined();
+});
+
+test('Should record a transaction for route with parameters', async ({ request }) => {
+  const transactionEventPromise = waitForTransaction('node-express-esm-loader', transactionEvent => {
+    return transactionEvent.contexts?.trace?.data?.['http.target'] === '/test-transaction/1';
+  });
+
+  await request.get('/test-transaction/1');
+
+  const transactionEvent = await transactionEventPromise;
+
+  expect(transactionEvent).toBeDefined();
+  expect(transactionEvent.transaction).toEqual('GET /test-transaction/:param');
+  expect(transactionEvent.contexts?.trace?.data).toEqual(
+    expect.objectContaining({
+      'http.flavor': '1.1',
+      'http.host': 'localhost:3030',
+      'http.method': 'GET',
+      'http.response.status_code': 200,
+      'http.route': '/test-transaction/:param',
+      'http.scheme': 'http',
+      'http.status_code': 200,
+      'http.status_text': 'OK',
+      'http.target': '/test-transaction/1',
+      'http.url': 'http://localhost:3030/test-transaction/1',
+      'http.user_agent': expect.any(String),
+      'net.host.ip': expect.any(String),
+      'net.host.name': 'localhost',
+      'net.host.port': 3030,
+      'net.peer.ip': expect.any(String),
+      'net.peer.port': expect.any(Number),
+      'net.transport': 'ip_tcp',
+      'otel.kind': 'SERVER',
+      'sentry.op': 'http.server',
+      'sentry.origin': 'auto.http.otel.http',
+      'sentry.sample_rate': 1,
+      'sentry.source': 'route',
+      url: 'http://localhost:3030/test-transaction/1',
+    }),
+  );
+
+  const spans = transactionEvent.spans || [];
+  expect(spans).toContainEqual({
+    data: {
+      'express.name': 'query',
+      'express.type': 'middleware',
+      'http.route': '/',
+      'otel.kind': 'INTERNAL',
+      'sentry.origin': 'auto.http.otel.express',
+    },
+    description: 'middleware - query',
+    origin: 'auto.http.otel.express',
+    parent_span_id: expect.any(String),
+    span_id: expect.any(String),
+    start_timestamp: expect.any(Number),
+    status: 'ok',
+    timestamp: expect.any(Number),
+    trace_id: expect.any(String),
+  });
+
+  expect(spans).toContainEqual({
+    data: {
+      'express.name': 'expressInit',
+      'express.type': 'middleware',
+      'http.route': '/',
+      'otel.kind': 'INTERNAL',
+      'sentry.origin': 'auto.http.otel.express',
+    },
+    description: 'middleware - expressInit',
+    origin: 'auto.http.otel.express',
+    parent_span_id: expect.any(String),
+    span_id: expect.any(String),
+    start_timestamp: expect.any(Number),
+    status: 'ok',
+    timestamp: expect.any(Number),
+    trace_id: expect.any(String),
+  });
+
+  expect(spans).toContainEqual({
+    data: {
+      'express.name': '/test-transaction/:param',
+      'express.type': 'request_handler',
+      'http.route': '/test-transaction/:param',
+      'otel.kind': 'INTERNAL',
+      'sentry.origin': 'auto.http.otel.express',
+    },
+    description: 'request handler - /test-transaction/:param',
+    origin: 'auto.http.otel.express',
+    parent_span_id: expect.any(String),
+    span_id: expect.any(String),
+    start_timestamp: expect.any(Number),
+    status: 'ok',
+    timestamp: expect.any(Number),
+    trace_id: expect.any(String),
+  });
+});
diff --git a/dev-packages/e2e-tests/test-applications/node-express/package.json b/dev-packages/e2e-tests/test-applications/node-express/package.json
@@ -6,7 +6,7 @@
     "build": "tsc",
     "start": "node dist/app.js",
     "test": "playwright test",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && pnpm build",
     "test:assert": "pnpm test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/node-hapi/package.json b/dev-packages/e2e-tests/test-applications/node-hapi/package.json
@@ -6,7 +6,7 @@
     "build": "tsc",
     "start": "node src/app.js",
     "test": "playwright test",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install",
     "test:assert": "pnpm test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/node-koa/package.json b/dev-packages/e2e-tests/test-applications/node-koa/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "start": "node index.js",
     "test": "playwright test",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install",
     "test:assert": "pnpm test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/node-nestjs/package.json b/dev-packages/e2e-tests/test-applications/node-nestjs/package.json
@@ -9,7 +9,7 @@
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test": "playwright test",
     "test:build": "pnpm install",
     "test:assert": "pnpm test"
diff --git a/dev-packages/e2e-tests/test-applications/react-create-hash-router/package.json b/dev-packages/e2e-tests/test-applications/react-create-hash-router/package.json
@@ -22,7 +22,7 @@
     "build": "react-scripts build",
     "start": "serve -s build",
     "test": "playwright test",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:build-canary": "pnpm install && pnpm add react@canary react-dom@canary && npx playwright install && pnpm build",
     "test:assert": "pnpm test"
diff --git a/dev-packages/e2e-tests/test-applications/react-router-5/package.json b/dev-packages/e2e-tests/test-applications/react-router-5/package.json
@@ -26,7 +26,7 @@
     "build": "react-scripts build",
     "start": "serve -s build",
     "test": "playwright test",
-    "clean": "npx rimraf node_modules,pnpm-lock.yaml",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
     "test:build": "pnpm install && npx playwright install && pnpm build",
     "test:assert": "pnpm test"
   },
diff --git a/dev-packages/e2e-tests/test-applications/react-router-6-use-routes/package.json b/dev-packages/e2e-tests/test-applications/react-router-6-use-routes/package.json
diff --git a/dev-packages/e2e-tests/test-applications/standard-frontend-react/package.json b/dev-packages/e2e-tests/test-applications/standard-frontend-react/package.json
diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2-svelte-5/package.json b/dev-packages/e2e-tests/test-applications/sveltekit-2-svelte-5/package.json
diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2/package.json b/dev-packages/e2e-tests/test-applications/sveltekit-2/package.json
diff --git a/dev-packages/e2e-tests/test-applications/sveltekit/package.json b/dev-packages/e2e-tests/test-applications/sveltekit/package.json
diff --git a/dev-packages/e2e-tests/test-applications/vue-3/package.json b/dev-packages/e2e-tests/test-applications/vue-3/package.json
diff --git a/dev-packages/event-proxy-server/package.json b/dev-packages/event-proxy-server/package.json
