Unverified Commit b3774eae authored by Will Binns-Smith's avatar Will Binns-Smith Committed by GitHub

Trace upload: include experimental flag states (#89845)

This includes the set of experimental flag states in events sent to the
trace upload receiver when `--experimental-trace-upload` is set. It only
includes a subset of experimental flags (so things like the trace upload
flag itself isn't meaninglessly sent).

Since reporting is often limited to the scope of a single span, the flag
state attributes are denormalized and copied onto every descendent span.
Limiting the set of flags prevents this from being unnecessarily large.

Test Plan: Added `test/development` test and built an app and verified
these tags are sent with `NEXT_TRACE_UPLOAD_DEBUG`

---------
Co-authored-by: 's avatarvercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: 's avatarLuke Sandberg <lukesandberg@users.noreply.github.com>
parent 8266e03a
...@@ -914,7 +914,8 @@ export default async function build( ...@@ -914,7 +914,8 @@ export default async function build(
bundler = Bundler.Turbopack, bundler = Bundler.Turbopack,
experimentalBuildMode: 'default' | 'compile' | 'generate' | 'generate-env', experimentalBuildMode: 'default' | 'compile' | 'generate' | 'generate-env',
traceUploadUrl: string | undefined, traceUploadUrl: string | undefined,
debugBuildPaths: { app: string[]; pages: string[] } | undefined debugBuildPaths: { app: string[]; pages: string[] } | undefined,
enabledFeatures: Record<string, unknown> = {}
): Promise<void> { ): Promise<void> {
const isCompileMode = experimentalBuildMode === 'compile' const isCompileMode = experimentalBuildMode === 'compile'
const isGenerateMode = experimentalBuildMode === 'generate' const isGenerateMode = experimentalBuildMode === 'generate'
...@@ -929,6 +930,7 @@ export default async function build( ...@@ -929,6 +930,7 @@ export default async function build(
const nextBuildSpan = trace('next-build', undefined, { const nextBuildSpan = trace('next-build', undefined, {
buildMode: experimentalBuildMode, buildMode: experimentalBuildMode,
version: process.env.__NEXT_VERSION as string, version: process.env.__NEXT_VERSION as string,
...enabledFeatures,
}) })
NextBuildContext.nextBuildSpan = nextBuildSpan NextBuildContext.nextBuildSpan = nextBuildSpan
......
...@@ -123,6 +123,15 @@ const nextBuild = async (options: NextBuildOptions, directory?: string) => { ...@@ -123,6 +123,15 @@ const nextBuild = async (options: NextBuildOptions, directory?: string) => {
} }
} }
const enabledFeatures = Object.fromEntries(
Object.entries({
experimentalDebugMemoryUsage,
experimentalBuildMode:
experimentalBuildMode !== 'default' ? experimentalBuildMode : undefined,
experimentalCpuProf: options.experimentalCpuProf,
}).filter(([_, value]) => value !== undefined && value !== false)
)
return build( return build(
dir, dir,
experimentalAnalyze, experimentalAnalyze,
...@@ -134,7 +143,8 @@ const nextBuild = async (options: NextBuildOptions, directory?: string) => { ...@@ -134,7 +143,8 @@ const nextBuild = async (options: NextBuildOptions, directory?: string) => {
bundler, bundler,
experimentalBuildMode, experimentalBuildMode,
traceUploadUrl, traceUploadUrl,
resolvedBuildPaths resolvedBuildPaths,
enabledFeatures
) )
.catch((err) => { .catch((err) => {
if (experimentalDebugMemoryUsage) { if (experimentalDebugMemoryUsage) {
......
...@@ -35,7 +35,12 @@ import { ...@@ -35,7 +35,12 @@ import {
import os from 'os' import os from 'os'
import { once } from 'node:events' import { once } from 'node:events'
import { clearTimeout } from 'timers' import { clearTimeout } from 'timers'
import { flushAllTraces, trace } from '../trace' import {
flushAllTraces,
trace,
initializeTraceState,
exportTraceState,
} from '../trace'
import { traceId } from '../trace/shared' import { traceId } from '../trace/shared'
import { Bundler, parseBundlerArgs } from '../lib/bundler' import { Bundler, parseBundlerArgs } from '../lib/bundler'
...@@ -248,6 +253,22 @@ const nextDev = async ( ...@@ -248,6 +253,22 @@ const nextDev = async (
traceUploadUrl = options.experimentalUploadTrace traceUploadUrl = options.experimentalUploadTrace
} }
const enabledFeatures = Object.fromEntries(
Object.entries({
experimentalServerFastRefresh: options.experimentalServerFastRefresh,
experimentalCpuProf: options.experimentalCpuProf,
}).filter(([_, value]) => value)
)
for (const [key, value] of Object.entries(enabledFeatures)) {
sessionSpan.setAttribute(`feature.${key}`, value)
}
initializeTraceState({
...exportTraceState(),
defaultParentSpanId: sessionSpan.getId(),
})
const devServerOptions: StartServerOptions = { const devServerOptions: StartServerOptions = {
dir, dir,
port, port,
...@@ -310,6 +331,7 @@ const nextDev = async ( ...@@ -310,6 +331,7 @@ const nextDev = async (
NEXT_PRIVATE_START_TIME: process.env.NEXT_PRIVATE_START_TIME, NEXT_PRIVATE_START_TIME: process.env.NEXT_PRIVATE_START_TIME,
NEXT_PRIVATE_WORKER: '1', NEXT_PRIVATE_WORKER: '1',
NEXT_PRIVATE_TRACE_ID: traceId, NEXT_PRIVATE_TRACE_ID: traceId,
NEXT_PRIVATE_ENABLED_FEATURES: JSON.stringify(enabledFeatures),
NODE_EXTRA_CA_CERTS: startServerOptions.selfSignedCertificate NODE_EXTRA_CA_CERTS: startServerOptions.selfSignedCertificate
? startServerOptions.selfSignedCertificate.rootCA ? startServerOptions.selfSignedCertificate.rootCA
: defaultEnv.NODE_EXTRA_CA_CERTS, : defaultEnv.NODE_EXTRA_CA_CERTS,
......
...@@ -28,7 +28,13 @@ import { ...@@ -28,7 +28,13 @@ import {
} from '../../shared/lib/constants' } from '../../shared/lib/constants'
import { getEnvInfo, logExperimentalInfo, logStartInfo } from './app-info-log' import { getEnvInfo, logExperimentalInfo, logStartInfo } from './app-info-log'
import { validateTurboNextConfig } from '../../lib/turbopack-warning' import { validateTurboNextConfig } from '../../lib/turbopack-warning'
import { type Span, trace, flushAllTraces } from '../../trace' import {
type Span,
trace,
flushAllTraces,
exportTraceState,
initializeTraceState,
} from '../../trace'
import { isIPv6 } from './is-ipv6' import { isIPv6 } from './is-ipv6'
import { AsyncCallbackSet } from './async-callback-set' import { AsyncCallbackSet } from './async-callback-set'
import type { NextServer } from '../next' import type { NextServer } from '../next'
...@@ -557,13 +563,31 @@ if (process.env.NEXT_PRIVATE_WORKER && process.send) { ...@@ -557,13 +563,31 @@ if (process.env.NEXT_PRIVATE_WORKER && process.send) {
msg.nextWorkerOptions && msg.nextWorkerOptions &&
process.send process.send
) { ) {
let enabledFeaturesFromParent = {}
if (process.env.NEXT_PRIVATE_ENABLED_FEATURES) {
const parsed = JSON.parse(process.env.NEXT_PRIVATE_ENABLED_FEATURES)
enabledFeaturesFromParent = Object.fromEntries(
Object.entries(parsed).map(([key, value]) => [
`feature.${key}`,
value,
])
)
}
startServerSpan = trace('start-dev-server', undefined, { startServerSpan = trace('start-dev-server', undefined, {
cpus: String(os.cpus().length), cpus: String(os.cpus().length),
platform: os.platform(), platform: os.platform(),
'memory.freeMem': String(os.freemem()), 'memory.freeMem': String(os.freemem()),
'memory.totalMem': String(os.totalmem()), 'memory.totalMem': String(os.totalmem()),
'memory.heapSizeLimit': String(v8.getHeapStatistics().heap_size_limit), 'memory.heapSizeLimit': String(v8.getHeapStatistics().heap_size_limit),
...enabledFeaturesFromParent,
})
initializeTraceState({
...exportTraceState(),
defaultParentSpanId: startServerSpan.getId(),
}) })
const result = await startServerSpan.traceAsyncFn(() => const result = await startServerSpan.traceAsyncFn(() =>
startServer(msg.nextWorkerOptions) startServer(msg.nextWorkerOptions)
) )
......
...@@ -107,6 +107,7 @@ interface TraceMetadata { ...@@ -107,6 +107,7 @@ interface TraceMetadata {
pkgName: string pkgName: string
platform: string platform: string
sessionId: string sessionId: string
enabledFeatures: Record<string, unknown>
} }
;(async function upload() { ;(async function upload() {
...@@ -140,6 +141,9 @@ interface TraceMetadata { ...@@ -140,6 +141,9 @@ interface TraceMetadata {
}) })
const sessionTrace = [] const sessionTrace = []
let sessionEnabledFeatures: Record<string, unknown> = {}
const spanEnabledFeatures = new Map<number, Record<string, unknown>>()
for await (const line of readLineInterface) { for await (const line of readLineInterface) {
const lineEvents: TraceEvent[] = JSON.parse(line) const lineEvents: TraceEvent[] = JSON.parse(line)
for (const event of lineEvents) { for (const event of lineEvents) {
...@@ -148,6 +152,32 @@ interface TraceMetadata { ...@@ -148,6 +152,32 @@ interface TraceMetadata {
continue continue
} }
// Extract enabled features from the root span (next-dev or next-build)
if (
event.parentId === undefined &&
event.tags &&
(event.name === 'next-dev' || event.name === 'next-build')
) {
for (const [key, value] of Object.entries(event.tags)) {
if (key.startsWith('feature.')) {
sessionEnabledFeatures[key] = value
}
}
}
// Collect feature tags from all events for inheritance
if (event.tags) {
const enabledFeatures: Record<string, unknown> = {}
for (const [key, value] of Object.entries(event.tags)) {
if (key.startsWith('feature.')) {
enabledFeatures[key] = value
}
}
if (Object.keys(enabledFeatures).length > 0) {
spanEnabledFeatures.set(event.id, enabledFeatures)
}
}
if ( if (
// Always include root spans // Always include root spans
event.parentId === undefined || event.parentId === undefined ||
...@@ -161,6 +191,18 @@ interface TraceMetadata { ...@@ -161,6 +191,18 @@ interface TraceMetadata {
} }
} }
// Apply feature tag inheritance to session trace
const sessionTraceWithInheritance = sessionTrace.map((event) => {
if (event.parentId !== undefined) {
const parentFlags = spanEnabledFeatures.get(event.parentId)
if (parentFlags && Object.keys(parentFlags).length > 0) {
// Inherit parent flags, but child's own tags take precedence
return { ...event, tags: { ...parentFlags, ...event.tags } }
}
}
return event
})
const body: TraceRequestBody = { const body: TraceRequestBody = {
metadata: { metadata: {
anonymousId, anonymousId,
...@@ -173,11 +215,12 @@ interface TraceMetadata { ...@@ -173,11 +215,12 @@ interface TraceMetadata {
pkgName, pkgName,
platform: os.platform(), platform: os.platform(),
sessionId, sessionId,
enabledFeatures: sessionEnabledFeatures,
}, },
// The trace file can contain events spanning multiple sessions. // The trace file can contain events spanning multiple sessions.
// Only submit traces for the current session, as the metadata we send is // Only submit traces for the current session, as the metadata we send is
// intended for this session only. // intended for this session only.
traces: [sessionTrace], traces: [sessionTraceWithInheritance],
} }
if (isDebugEnabled) { if (isDebugEnabled) {
......
...@@ -24,14 +24,14 @@ export enum SpanStatus { ...@@ -24,14 +24,14 @@ export enum SpanStatus {
} }
interface Attributes { interface Attributes {
[key: string]: string [key: string]: unknown
} }
export class Span { export class Span {
private name: string private name: string
private id: SpanId private id: SpanId
private parentId?: SpanId private parentId?: SpanId
private attrs: { [key: string]: any } private attrs: { [key: string]: unknown }
private status: SpanStatus private status: SpanStatus
private now: number private now: number
...@@ -126,7 +126,7 @@ export class Span { ...@@ -126,7 +126,7 @@ export class Span {
return this.id return this.id
} }
setAttribute(key: string, value: string) { setAttribute(key: string, value: unknown) {
this.attrs[key] = value this.attrs[key] = value
} }
...@@ -150,7 +150,7 @@ export class Span { ...@@ -150,7 +150,7 @@ export class Span {
export const trace = ( export const trace = (
name: string, name: string,
parentId?: SpanId, parentId?: SpanId,
attrs?: { [key: string]: string } attrs?: { [key: string]: unknown }
) => { ) => {
return new Span({ name, parentId, attrs }) return new Span({ name, parentId, attrs })
} }
......
...@@ -13,6 +13,6 @@ export type TraceEvent = { ...@@ -13,6 +13,6 @@ export type TraceEvent = {
id: SpanId id: SpanId
timestamp: number timestamp: number
duration: number duration: number
tags?: Object tags?: Record<string, unknown>
startTime?: number startTime?: number
} }
import { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default function Page() {
return <p>hello world</p>
}
import { nextTestSetup } from 'e2e-utils'
import { join } from 'path'
import { existsSync, readFileSync } from 'fs'
import { createServer } from 'http'
import { spawn } from 'child_process'
import type { TraceEvent } from 'next/dist/trace'
interface TraceStructure {
events: TraceEvent[]
eventsByName: Map<string, TraceEvent[]>
eventsById: Map<string, TraceEvent>
}
function parseTraceFile(tracePath: string): TraceStructure {
const traceContent = readFileSync(tracePath, 'utf8')
const traceLines = traceContent
.trim()
.split('\n')
.filter((line) => line.trim())
const allEvents: TraceEvent[] = []
for (const line of traceLines) {
const events = JSON.parse(line) as TraceEvent[]
allEvents.push(...events)
}
const eventsByName = new Map<string, TraceEvent[]>()
const eventsById = new Map<string, TraceEvent>()
// Index all events
for (const event of allEvents) {
if (!eventsByName.has(event.name)) {
eventsByName.set(event.name, [])
}
eventsByName.get(event.name)!.push(event)
eventsById.set(event.id.toString(), event)
}
return {
events: allEvents,
eventsByName,
eventsById,
}
}
describe('enabled features in trace', () => {
const { next, isNextDev } = nextTestSetup({
files: __dirname,
startArgs: ['--experimental-server-fast-refresh'],
})
if (!isNextDev) {
it('should be skipped in production', () => {})
return
}
it('should record enabled features on root span', async () => {
const tracePath = join(next.testDir, '.next/dev/trace')
// Trigger page request to generate traces
if (!existsSync(tracePath)) {
const $ = await next.render$('/')
expect($('p').text()).toBe('hello world')
await next.stop('SIGTERM')
await new Promise((resolve) => setTimeout(resolve, 500))
}
const traceStructure = parseTraceFile(tracePath)
// Verify start-dev-server span has feature tags
const startDevServerEvents =
traceStructure.eventsByName.get('start-dev-server')
expect(startDevServerEvents).toBeDefined()
expect(startDevServerEvents!.length).toBeGreaterThan(0)
const startDevServerEvent = startDevServerEvents![0]
expect(startDevServerEvent.tags).toBeDefined()
expect(
startDevServerEvent.tags!['feature.experimentalServerFastRefresh']
).toBe(true)
})
it('should denormalize inherited enabled features during upload', async () => {
const tracePath = join(next.testDir, '.next/dev/trace')
if (!existsSync(tracePath)) {
const $ = await next.render$('/')
expect($('p').text()).toBe('hello world')
await next.stop('SIGTERM')
await new Promise((resolve) => setTimeout(resolve, 500))
}
const fakeServer = await createTestTraceUploadServer()
// Get trace ID from the trace file
const traceContent = readFileSync(tracePath, 'utf8')
const firstLine = traceContent.trim().split('\n')[0]
const firstEvents = JSON.parse(firstLine)
const traceId = firstEvents[0]?.traceId
const uploaderPath = join(
__dirname,
'../../../../packages/next/dist/trace/trace-uploader.js'
)
const uploaderProcess = spawn('node', [
uploaderPath,
fakeServer.url,
'dev',
next.testDir,
'.next/dev',
'true',
traceId,
'test-anonymous-id',
'test-session-id',
])
await new Promise<void>((resolve, reject) => {
uploaderProcess.on('close', (code) => {
if (code === 0) {
resolve()
} else {
reject(new Error(`Uploader exited with code ${code}`))
}
})
uploaderProcess.on('error', reject)
})
const uploadedData = fakeServer.getUploadedData()
fakeServer.close()
// Verify uploaded data has inherited feature tags
expect(uploadedData).toBeDefined()
expect(uploadedData.traces).toHaveLength(1)
const traces = uploadedData.traces[0]
// Find compile-path and render-path events
const compilePathEvent = traces.find((e: any) => e.name === 'compile-path')
const renderPathEvent = traces.find((e: any) => e.name === 'render-path')
// Both should have inherited feature.experimentalServerFastRefresh from their parent
expect(compilePathEvent).toBeDefined()
expect(compilePathEvent.tags['feature.experimentalServerFastRefresh']).toBe(
true
)
expect(renderPathEvent).toBeDefined()
expect(renderPathEvent.tags['feature.experimentalServerFastRefresh']).toBe(
true
)
})
})
async function createTestTraceUploadServer(): Promise<{
url: string
getUploadedData: () => any
close: () => void
}> {
let uploadedData: any = null
const server = createServer((req, res) => {
let body = ''
req.on('data', (chunk) => {
body += chunk.toString()
})
req.on('end', () => {
uploadedData = JSON.parse(body)
res.writeHead(200, { 'Content-Type': 'application/json' })
res.end(JSON.stringify({ success: true }))
})
})
await new Promise<void>((resolve) => {
server.listen(0, () => resolve())
})
const address = server.address()
if (!address || typeof address === 'string') {
throw new Error('Server address is not available')
}
return {
url: `http://localhost:${address.port}`,
getUploadedData: () => uploadedData,
close: () => server.close(),
}
}
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { join } from 'path' import { join } from 'path'
import { existsSync, readFileSync } from 'fs' import { existsSync, readFileSync } from 'fs'
import type { TraceEvent } from 'next/dist/trace'
type SpanId = number
type TraceEvent = {
traceId?: string
parentId?: SpanId
name: string
id: SpanId
timestamp: number
duration: number
tags?: Record<string, unknown>
startTime?: number
}
interface TraceStructure { interface TraceStructure {
events: TraceEvent[] events: TraceEvent[]
......
import { nextTestSetup, isNextDev, isNextStart } from 'e2e-utils' import { nextTestSetup, isNextDev, isNextStart } from 'e2e-utils'
import { join } from 'path' import { join } from 'path'
import { existsSync, readFileSync } from 'fs' import { existsSync, readFileSync } from 'fs'
import type { TraceEvent } from 'next/dist/trace'
type SpanId = number
type TraceEvent = {
traceId?: string
parentId?: SpanId
name: string
id: SpanId
timestamp: number
duration: number
tags?: Object
startTime?: number
}
interface TraceStructure { interface TraceStructure {
events: TraceEvent[] events: TraceEvent[]
......
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