Unverified Commit 53f29cd6 authored by Jan Kaifer's avatar Jan Kaifer Committed by GitHub

Add OTEL tests (#47149)

parent 67aceea7
......@@ -72,6 +72,7 @@
"@next/polyfill-module": "workspace:*",
"@next/polyfill-nomodule": "workspace:*",
"@next/swc": "workspace:*",
"@opentelemetry/api": "1.4.1",
"@svgr/webpack": "5.5.0",
"@swc/cli": "0.1.55",
"@swc/core": "1.2.203",
......
......@@ -87,7 +87,7 @@
"styled-jsx": "5.1.1"
},
"peerDependencies": {
"@opentelemetry/api": "^1.4.0",
"@opentelemetry/api": "^1.4.1",
"fibers": ">= 3.1.0",
"node-sass": "^6.0.0 || ^7.0.0",
"react": "^18.2.0",
......@@ -140,7 +140,7 @@
"@next/react-dev-overlay": "13.2.5-canary.4",
"@next/react-refresh-utils": "13.2.5-canary.4",
"@next/swc": "13.2.5-canary.4",
"@opentelemetry/api": "1.4.0",
"@opentelemetry/api": "1.4.1",
"@segment/ajv-human-errors": "2.1.2",
"@taskr/clear": "1.1.0",
"@taskr/esnext": "1.1.0",
......
......@@ -32,6 +32,7 @@ importers:
'@next/polyfill-module': workspace:*
'@next/polyfill-nomodule': workspace:*
'@next/swc': workspace:*
'@opentelemetry/api': 1.4.1
'@svgr/webpack': 5.5.0
'@swc/cli': 0.1.55
'@swc/core': 1.2.203
......@@ -208,6 +209,7 @@ importers:
'@next/polyfill-module': link:packages/next-polyfill-module
'@next/polyfill-nomodule': link:packages/next-polyfill-nomodule
'@next/swc': link:packages/next-swc
'@opentelemetry/api': 1.4.1
'@svgr/webpack': 5.5.0
'@swc/cli': 0.1.55_@swc+core@1.2.203
'@swc/core': 1.2.203
......@@ -521,7 +523,7 @@ importers:
'@next/react-dev-overlay': 13.2.5-canary.4
'@next/react-refresh-utils': 13.2.5-canary.4
'@next/swc': 13.2.5-canary.4
'@opentelemetry/api': 1.4.0
'@opentelemetry/api': 1.4.1
'@segment/ajv-human-errors': 2.1.2
'@swc/helpers': 0.4.14
'@taskr/clear': 1.1.0
......@@ -737,7 +739,7 @@ importers:
'@next/react-dev-overlay': link:../react-dev-overlay
'@next/react-refresh-utils': link:../react-refresh-utils
'@next/swc': link:../next-swc
'@opentelemetry/api': 1.4.0
'@opentelemetry/api': 1.4.1
'@segment/ajv-human-errors': 2.1.2_ajv@8.11.0
'@taskr/clear': 1.1.0
'@taskr/esnext': 1.1.0
......@@ -6243,8 +6245,8 @@ packages:
'@types/node': 18.11.18
dev: true
/@opentelemetry/api/1.4.0:
resolution: {integrity: sha512-IgMK9i3sFGNUqPMbjABm0G26g0QCKCUBfglhQ7rQq6WcxbKfEHRcmwsoER4hZcuYqJgkYn2OeuoJIv7Jsftp7g==}
/@opentelemetry/api/1.4.1:
resolution: {integrity: sha512-O2yRJce1GOc6PAy3QxFM4NzFiWzvScDC1/5ihYBL6BUEVdq0XMWN01sppE+H6bBXbaFYipjwFLEWLg5PaSOThA==}
engines: {node: '>=8.0.0'}
dev: true
......
# files generated by next.js
tsconfig.json
node_modules/
export async function GET() {
return new Response(JSON.stringify({ test: 'data' }))
}
export default function Layout({ children }: { children: React.ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
// We are fetching our own API
export const dynamic = 'force-dynamic'
export default async function Page() {
const data = await fetch('https://user:pass@vercel.com')
return <pre>{await data.text()}</pre>
}
import { SpanKind } from '@opentelemetry/api'
export const traceFile = 'otel-trace.txt'
export type SavedSpan = {
traceId: string
parentId?: string
traceState: any
name: string
id: string
kind: SpanKind
timestamp: number
duration: number
attributes: Record<string, any>
status: any
events: any[]
links: any[]
}
import { Resource } from '@opentelemetry/resources'
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
import {
NodeTracerProvider,
SimpleSpanProcessor,
SpanExporter,
ReadableSpan,
} from '@opentelemetry/sdk-trace-node'
import {
ExportResult,
ExportResultCode,
hrTimeToMicroseconds,
} from '@opentelemetry/core'
import fs from 'fs-extra'
import { SavedSpan, traceFile } from './constants'
import path from 'path'
import url from 'url'
const serializeSpan = (span: ReadableSpan): SavedSpan => ({
traceId: span.spanContext().traceId,
parentId: span.parentSpanId,
traceState: span.spanContext().traceState?.serialize(),
name: span.name,
id: span.spanContext().spanId,
kind: span.kind,
timestamp: hrTimeToMicroseconds(span.startTime),
duration: hrTimeToMicroseconds(span.duration),
attributes: span.attributes,
status: span.status,
events: span.events,
links: span.links,
})
const __dirname = path.dirname(url.fileURLToPath(import.meta.url))
class TestExporter implements SpanExporter {
async export(
spans: ReadableSpan[],
resultCallback: (result: ExportResult) => void
) {
const traceFullPath = path.join(__dirname, traceFile)
for (const span of spans) {
await fs.appendFile(
traceFullPath,
JSON.stringify(serializeSpan(span)) + '\n'
)
}
resultCallback({ code: ExportResultCode.SUCCESS })
}
shutdown(): Promise<void> {
return Promise.resolve()
}
}
export const register = () => {
const provider = new NodeTracerProvider({
resource: new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: 'test-next-app',
}),
})
provider.addSpanProcessor(new SimpleSpanProcessor(new TestExporter()))
// Make sure to register you provider
provider.register()
// Creating this file will let our tests know that initialization is done
fs.createFileSync('./' + traceFile)
}
import { Resource } from '@opentelemetry/resources'
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
import {
NodeTracerProvider,
SimpleSpanProcessor,
} from '@opentelemetry/sdk-trace-node'
// You can use gRPC exporter instead
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
export function register() {
// Next.js expects you to use to register TraceProvider. It won't work if you use NodeSDK.
// We use registered provider to create traces inside of Next.js internals.
const provider = new NodeTracerProvider({
resource: new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: 'next-app',
}),
})
provider.addSpanProcessor(new SimpleSpanProcessor(new OTLPTraceExporter({})))
// Make sure to register you provider
provider.register()
}
export function register() {
if (process.env.NEXT_RUNTIME === 'nodejs') {
if (process.env.__NEXT_TEST_MODE) {
require('./instrumentation-node-test').register()
} else {
// We use this instrumentation for easier debugging with this test.
// We want this test to be executable with `pnpm next-with-deps`.
require('./instrumentation-node').register()
}
}
}
module.exports = {
experimental: {
instrumentationHook: true,
appDir: true,
},
}
import { createNextDescribe } from 'e2e-utils'
import { check } from 'next-test-utils'
import { SavedSpan, traceFile } from './constants'
createNextDescribe(
'opentelemetry',
{
files: __dirname,
packageJson: require('./package.json'),
},
({ next }) => {
const getTraces = async (): Promise<SavedSpan[]> => {
const traces = await next.readFile(traceFile)
return traces
.split('\n')
.filter(Boolean)
.map((line) => JSON.parse(line))
}
/** There were issues where OTEL might not be initialized for first few requests (this is a bug).
* It made our tests, flaky. This should make tests deterministic.
*/
const waitForOtelToInitialize = async () => {
await check(
async () =>
await next
.readFile(traceFile)
.then(() => 'ok')
.catch(() => 'err'),
'ok'
)
}
const waitForRootSpan = async (numberOfRootTraces: number) => {
await check(async () => {
const spans = await getTraces()
const rootSpans = spans.filter((span) => !span.parentId)
return String(rootSpans.length)
}, String(numberOfRootTraces))
}
/**
* Sanitize (modifies) span to make it ready for snapshot testing.
*/
const sanitizeSpan = (span: SavedSpan) => {
delete span.duration
delete span.id
delete span.links
delete span.timestamp
delete span.traceId
span.parentId = span.parentId === undefined ? undefined : '[parent-id]'
return span
}
const sanitizeSpans = (spans: SavedSpan[]) =>
spans.sort((a, b) => a.name.localeCompare(b.name)).map(sanitizeSpan)
const getSanitizedTraces = async (numberOfRootTraces: number) => {
await waitForRootSpan(numberOfRootTraces)
return sanitizeSpans(await getTraces())
}
const cleanTraces = async () => {
await next.patchFile(traceFile, '')
}
beforeAll(async () => {
await waitForOtelToInitialize()
})
afterEach(async () => {
await cleanTraces()
})
it('should have spans when accessing page', async () => {
await next.fetch('/pages')
expect(await getSanitizedTraces(1)).toMatchInlineSnapshot(`
Array [
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "BaseServer.renderToResponse",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextNodeServer.findPageComponents",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextServer.getRequestHandler",
"parentId": undefined,
"status": Object {
"code": 0,
},
},
]
`)
})
it('should handle route params', async () => {
await next.fetch('/pages/params/stuff')
expect(await getSanitizedTraces(1)).toMatchInlineSnapshot(`
Array [
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "BaseServer.renderToResponse",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextNodeServer.findPageComponents",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextServer.getRequestHandler",
"parentId": undefined,
"status": Object {
"code": 0,
},
},
]
`)
})
it('should handle RSC with fetch', async () => {
await next.fetch('/app/rsc-fetch')
expect(await getSanitizedTraces(1)).toMatchInlineSnapshot(`
Array [
Object {
"attributes": Object {},
"events": Array [],
"kind": 2,
"name": "AppRender.fetch",
"parentId": "[parent-id]",
"status": Object {
"code": 2,
"message": "Request cannot be constructed from a URL that includes credentials: https://user:pass@vercel.com",
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "BaseServer.renderToResponse",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextNodeServer.findPageComponents",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextServer.getRequestHandler",
"parentId": undefined,
"status": Object {
"code": 0,
},
},
]
`)
})
it('should handle getServerSideProps', async () => {
await next.fetch('/pager/getServerSideProps')
expect(await getSanitizedTraces(1)).toMatchInlineSnapshot(`
Array [
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "BaseServer.renderToResponse",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextNodeServer.findPageComponents",
"parentId": "[parent-id]",
"status": Object {
"code": 0,
},
},
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextServer.getRequestHandler",
"parentId": undefined,
"status": Object {
"code": 0,
},
},
]
`)
})
it('should handle route handlers in app router', async () => {
await next.fetch('/api/pages/basic')
expect(await getSanitizedTraces(1)).toMatchInlineSnapshot(`
Array [
Object {
"attributes": Object {},
"events": Array [],
"kind": 0,
"name": "NextServer.getRequestHandler",
"parentId": undefined,
"status": Object {
"code": 0,
},
},
]
`)
})
}
)
{
"dependencies": {
"fs-extra": "^8.0.0",
"@types/fs-extra": "^8.0.0",
"@opentelemetry/api": "^1.0.0",
"@opentelemetry/core": "^1.0.0",
"@opentelemetry/resources": "^1.0.0",
"@opentelemetry/sdk-trace-base": "^1.0.0",
"@opentelemetry/sdk-trace-node": "^1.0.0",
"@opentelemetry/semantic-conventions": "^1.0.0",
"@opentelemetry/exporter-trace-otlp-http": "^0.34.0"
}
}
export default function handler(req, res) {
res.status(200).json({ text: 'hello world' })
}
export default async function Page() {
return <div>Page</div>
}
export function getServerSideProps() {
return {
props: {},
}
}
export default function Page() {
return <p>hello world</p>
}
export default function Page() {
return <p>hello world</p>
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment