test(hono): Add E2E test for Hono on Cloudflare

Author: s1gr1d

dev-packages/e2e-tests/test-applications/hono-4-cf/.gitignore

@@ -29,5 +29,8 @@ yarn-error.log*
 pnpm-debug.log*
 lerna-debug.log*
 
+# test
+test-results
+
 # misc
 .DS_Store

dev-packages/e2e-tests/test-applications/hono-4-cf/.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/hono-4-cf/package.json

@@ -1,15 +1,28 @@
 {
   "name": "hono-4-cf",
   "type": "module",
+  "version": "0.0.0",
+  "private": true,
   "scripts": {
-    "dev": "wrangler dev",
+    "dev": "wrangler dev --var \"E2E_TEST_DSN:$E2E_TEST_DSN\" --log-level=$(test $CI && echo 'none' || echo 'log')",
+    "build": "wrangler deploy --dry-run",
     "deploy": "wrangler deploy --minify",
-    "cf-typegen": "wrangler types --env-interface CloudflareBindings"
+    "cf-typegen": "wrangler types --env-interface CloudflareBindings",
+    "test:build": "pnpm install && pnpm build",
+    "test:assert": "TEST_ENV=production playwright test"
   },
   "dependencies": {
+    "@sentry/hono": "latest || *",
     "hono": "^4.12.14"
   },
   "devDependencies": {
-    "wrangler": "^4.4.0"
+    "@playwright/test": "~1.56.0",
+    "@cloudflare/workers-types": "^4.20240725.0",
+    "@sentry-internal/test-utils": "link:../../../test-utils",
+    "typescript": "^5.5.2",
+    "wrangler": "^4.61.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

dev-packages/e2e-tests/test-applications/hono-4-cf/playwright.config.ts

@@ -0,0 +1,22 @@
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
+
+const testEnv = process.env.TEST_ENV;
+
+if (!testEnv) {
+  throw new Error('No test env defined');
+}
+
+const APP_PORT = 38787;
+
+const config = getPlaywrightConfig(
+  {
+    startCommand: `pnpm dev --port ${APP_PORT}`,
+    port: APP_PORT,
+  },
+  {
+    workers: '100%',
+    retries: 0,
+  },
+);
+
+export default config;

dev-packages/e2e-tests/test-applications/hono-4-cf/src/index.ts

@@ -1,9 +1,35 @@
 import { Hono } from 'hono';
+import { HTTPException } from 'hono/http-exception';
+import { sentry } from '@sentry/hono/cloudflare';
 
-const app = new Hono();
+const app = new Hono<{ Bindings: { E2E_TEST_DSN: string } }>();
+
+app.use(
+  sentry(app, env => ({
+    dsn: env.E2E_TEST_DSN,
+    environment: 'qa',
+    tracesSampleRate: 1.0,
+    tunnel: 'http://localhost:3031/', // proxy server
+  })),
+);
 
 app.get('/', c => {
   return c.text('Hello Hono!');
 });
 
+app.get('/test-param/:paramId', c => {
+  return c.json({ paramId: c.req.param('paramId') });
+});
+
+app.get('/error/:cause', c => {
+  throw new Error('This is a test error for Sentry!', {
+    cause: c.req.param('cause'),
+  });
+});
+
+app.get('/http-exception/:code', c => {
+  const code = Number(c.req.param('code')) as Parameters<typeof HTTPException>[0];
+  throw new HTTPException(code, { message: `HTTPException ${code}` });
+});
+
 export default app;

dev-packages/e2e-tests/test-applications/hono-4-cf/start-event-proxy.mjs

@@ -0,0 +1,6 @@
+import { startEventProxyServer } from '@sentry-internal/test-utils';
+
+startEventProxyServer({
+  port: 3031,
+  proxyServerName: 'hono-4-cf',
+});

dev-packages/e2e-tests/test-applications/hono-4-cf/tests/errors.test.ts

@@ -0,0 +1,52 @@
+import { expect, test } from '@playwright/test';
+import { waitForError } from '@sentry-internal/test-utils';
+
+test('captures error thrown in route handler', async ({ baseURL }) => {
+  const errorWaiter = waitForError('hono-4-cf', event => {
+    return event.exception?.values?.[0]?.value === 'This is a test error for Sentry!';
+  });
+
+  const response = await fetch(`${baseURL}/error/test-cause`);
+  expect(response.status).toBe(500);
+
+  const event = await errorWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('This is a test error for Sentry!');
+});
+
+test('captures HTTPException with 502 status', async ({ baseURL }) => {
+  const errorWaiter = waitForError('hono-4-cf', event => {
+    return event.exception?.values?.[0]?.value === 'HTTPException 502';
+  });
+
+  const response = await fetch(`${baseURL}/http-exception/502`);
+  expect(response.status).toBe(502);
+
+  const event = await errorWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('HTTPException 502');
+});
+
+// TODO: 401 and 404 HTTPExceptions should not be captured by Sentry by default,
+// but currently they are. Fix the filtering and update these tests accordingly.
+test('captures HTTPException with 401 status', async ({ baseURL }) => {
+  const errorWaiter = waitForError('hono-4-cf', event => {
+    return event.exception?.values?.[0]?.value === 'HTTPException 401';
+  });
+
+  const response = await fetch(`${baseURL}/http-exception/401`);
+  expect(response.status).toBe(401);
+
+  const event = await errorWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('HTTPException 401');
+});
+
+test('captures HTTPException with 404 status', async ({ baseURL }) => {
+  const errorWaiter = waitForError('hono-4-cf', event => {
+    return event.exception?.values?.[0]?.value === 'HTTPException 404';
+  });
+
+  const response = await fetch(`${baseURL}/http-exception/404`);
+  expect(response.status).toBe(404);
+
+  const event = await errorWaiter;
+  expect(event.exception?.values?.[0]?.value).toBe('HTTPException 404');
+});

dev-packages/e2e-tests/test-applications/hono-4-cf/tests/tracing.test.ts

@@ -0,0 +1,39 @@
+import { expect, test } from '@playwright/test';
+import { waitForTransaction } from '@sentry-internal/test-utils';
+
+test('sends a transaction for the index route', async ({ baseURL }) => {
+  const transactionWaiter = waitForTransaction('hono-4-cf', event => {
+    return event.transaction === 'GET /';
+  });
+
+  const response = await fetch(`${baseURL}/`);
+  expect(response.status).toBe(200);
+
+  const transaction = await transactionWaiter;
+  expect(transaction.contexts?.trace?.op).toBe('http.server');
+});
+
+test('sends a transaction for a parameterized route', async ({ baseURL }) => {
+  const transactionWaiter = waitForTransaction('hono-4-cf', event => {
+    return event.transaction === 'GET /test-param/:paramId';
+  });
+
+  const response = await fetch(`${baseURL}/test-param/123`);
+  expect(response.status).toBe(200);
+
+  const transaction = await transactionWaiter;
+  expect(transaction.contexts?.trace?.op).toBe('http.server');
+  expect(transaction.transaction).toBe('GET /test-param/:paramId');
+});
+
+test('sends a transaction for a route that throws', async ({ baseURL }) => {
+  const transactionWaiter = waitForTransaction('hono-4-cf', event => {
+    return event.transaction === 'GET /error/:cause';
+  });
+
+  await fetch(`${baseURL}/error/test-cause`);
+
+  const transaction = await transactionWaiter;
+  expect(transaction.contexts?.trace?.op).toBe('http.server');
+  expect(transaction.contexts?.trace?.status).toBe('internal_error');
+});

dev-packages/e2e-tests/test-applications/hono-4-cf/tsconfig.json

@@ -7,6 +7,7 @@
     "skipLibCheck": true,
     "lib": ["ESNext"],
     "jsx": "react-jsx",
-    "jsxImportSource": "hono/jsx"
+    "jsxImportSource": "hono/jsx",
+    "types": ["@cloudflare/workers-types"]
   }
 }

dev-packages/e2e-tests/test-applications/hono-4-cf/wrangler.jsonc

@@ -3,36 +3,5 @@
   "name": "hono-4-cf",
   "main": "src/index.ts",
   "compatibility_date": "2026-04-20",
-  // "compatibility_flags": [
-  //   "nodejs_compat"
-  // ],
-  // "vars": {
-  //   "MY_VAR": "my-variable"
-  // },
-  // "kv_namespaces": [
-  //   {
-  //     "binding": "MY_KV_NAMESPACE",
-  //     "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-  //   }
-  // ],
-  // "r2_buckets": [
-  //   {
-  //     "binding": "MY_BUCKET",
-  //     "bucket_name": "my-bucket"
-  //   }
-  // ],
-  // "d1_databases": [
-  //   {
-  //     "binding": "MY_DB",
-  //     "database_name": "my-database",
-  //     "database_id": ""
-  //   }
-  // ],
-  // "ai": {
-  //   "binding": "AI"
-  // },
-  // "observability": {
-  //   "enabled": true,
-  //   "head_sampling_rate": 1
-  // }
+  "compatibility_flags": ["nodejs_compat"],
 }