File size: 3,546 Bytes
4514571
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
diff --git a/test/e2e/opentelemetry/instrumentation/middleware-parent.test.ts b/test/e2e/opentelemetry/instrumentation/middleware-parent.test.ts
new file mode 100644
index 0000000000..6631d2b0fd
--- /dev/null
+++ b/test/e2e/opentelemetry/instrumentation/middleware-parent.test.ts
@@ -0,0 +1,82 @@
+import { FileRef, nextTestSetup } from 'e2e-utils'
+import { retry } from 'next-test-utils'
+import path from 'path'
+
+import { type Collector, connectCollector } from './collector'
+
+const COLLECTOR_PORT = 9001
+const EXTERNAL_TRACE_ID = 'ee75cd9e534ff5e9ed78b4a0c706f0f2'
+const EXTERNAL_SPAN_ID = '0f6a325411bdc432'
+
+describe('Node.js middleware OpenTelemetry parent context', () => {
+  let collector: Collector
+
+  beforeEach(async () => {
+    collector = await connectCollector({ port: COLLECTOR_PORT })
+  })
+
+  afterEach(async () => {
+    await collector.shutdown()
+  })
+
+  const { next, skipped } = nextTestSetup({
+    files: __dirname,
+    skipDeployment: true,
+    dependencies: require('./package.json').dependencies,
+    env: {
+      TEST_OTEL_COLLECTOR_PORT: String(COLLECTOR_PORT),
+      NEXT_TELEMETRY_DISABLED: '1',
+    },
+    overrideFiles: {
+      'middleware.ts': new FileRef(path.join(__dirname, 'middleware-node.ts')),
+    },
+  })
+
+  if (skipped) return
+
+  it.each([
+    {
+      context: 'without an incoming trace',
+      fetchInit: undefined,
+      expectedParentId: undefined,
+      expectedTraceId: undefined,
+    },
+    {
+      context: 'with an incoming trace',
+      fetchInit: {
+        headers: {
+          traceparent: `00-${EXTERNAL_TRACE_ID}-${EXTERNAL_SPAN_ID}-01`,
+        },
+      },
+      expectedParentId: EXTERNAL_SPAN_ID,
+      expectedTraceId: EXTERNAL_TRACE_ID,
+    },
+  ])('$context', async ({ fetchInit, expectedParentId, expectedTraceId }) => {
+    const response = await next.fetch('/behind-middleware', fetchInit)
+    expect(response.status).toBe(200)
+
+    await retry(() => {
+      const spans = collector.getSpans()
+      const requestSpan = spans.find(
+        (span) =>
+          span.attributes?.['next.span_type'] === 'BaseServer.handleRequest' &&
+          span.attributes?.['http.target'] === '/behind-middleware'
+      )
+      const middlewareSpan = spans.find(
+        (span) =>
+          span.attributes?.['next.span_type'] === 'Middleware.execute' &&
+          span.attributes?.['http.target'] === '/behind-middleware'
+      )
+
+      expect(requestSpan).toBeDefined()
+      expect(middlewareSpan).toBeDefined()
+      expect(requestSpan?.parentId).toBe(expectedParentId)
+      expect(middlewareSpan?.parentId).toBe(expectedParentId)
+      expect(middlewareSpan?.parentId).not.toBe(requestSpan?.id)
+      if (expectedTraceId) {
+        expect(requestSpan?.traceId).toBe(expectedTraceId)
+        expect(middlewareSpan?.traceId).toBe(expectedTraceId)
+      }
+    })
+  })
+})
diff --git a/test/e2e/opentelemetry/instrumentation/middleware-node.ts b/test/e2e/opentelemetry/instrumentation/middleware-node.ts
new file mode 100644
index 0000000000..7c90ccaa2e
--- /dev/null
+++ b/test/e2e/opentelemetry/instrumentation/middleware-node.ts
@@ -0,0 +1,14 @@
+import type { NextRequest, NextFetchEvent } from 'next/server'
+import { NextResponse } from 'next/server'
+
+export const config = {
+  matcher: ['/behind-middleware', '/behind-middleware/:path*'],
+  runtime: 'nodejs',
+}
+
+export async function middleware(
+  request: NextRequest,
+  event?: NextFetchEvent
+): Promise<Response> {
+  return NextResponse.next()
+}