import findUp from 'next/dist/compiled/find-up' import fsPromise from 'fs/promises' import child_process from 'child_process' import assert from 'assert' import os from 'os' import { createInterface } from 'readline' import { createReadStream } from 'fs' import path from 'path' const COMMON_ALLOWED_EVENTS = ['memory-usage'] // Predefined set of the event names to be included in the trace. // If the trace span's name matches to one of the event names in the set, // it'll up uploaded to the trace server. const DEV_ALLOWED_EVENTS = new Set([ ...COMMON_ALLOWED_EVENTS, 'client-hmr-latency', 'hot-reloader', 'webpack-invalid-client', 'webpack-invalidated-server', 'navigation-to-hydration', 'start-dev-server', 'compile-path', 'memory-usage', 'server-restart-close-to-memory-threshold', ]) const BUILD_ALLOWED_EVENTS = new Set([ ...COMMON_ALLOWED_EVENTS, 'next-build', 'run-turbopack-compiler', 'webpack-compilation', 'run-webpack-compiler', 'create-entrypoints', 'worker-main-edge-server', 'worker-main-client', 'worker-main-server', 'server', 'make', 'seal', 'chunk-graph', 'optimize-modules', 'optimize-chunks', 'optimize', 'optimize-tree', 'optimize-chunk-modules', 'module-hash', 'client', 'static-check', 'node-file-trace-build', 'static-generation', 'next-export', 'verify-typescript-setup', 'verify-and-lint', ]) const { NEXT_TRACE_UPLOAD_DEBUG, // An external env to allow to upload full trace without picking up the relavant spans. // This is mainly for the debugging purpose, to allwo manual audit for full trace for the given build. // [NOTE] This may fail if build is large and generated trace is excessively large. NEXT_TRACE_UPLOAD_FULL, } = process.env const isDebugEnabled = !!NEXT_TRACE_UPLOAD_DEBUG || !!NEXT_TRACE_UPLOAD_FULL const shouldUploadFullTrace = !!NEXT_TRACE_UPLOAD_FULL const [ , , traceUploadUrl, mode, projectDir, distDir, _isTurboSession, traceId, anonymousId, sessionId, ] = process.argv const isTurboSession = _isTurboSession === 'true' type TraceRequestBody = { metadata: TraceMetadata traces: TraceEvent[][] } interface TraceEvent { traceId: string parentId?: number name: string id: number startTime: number timestamp: number duration: number tags: Record } interface TraceMetadata { anonymousId: string arch: string commit: string cpus: number isTurboSession: boolean mode: string nextVersion: string pkgName: string platform: string sessionId: string } ;(async function upload() { const nextVersion = JSON.parse( await fsPromise.readFile( path.resolve(__dirname, '../../package.json'), 'utf8' ) ).version const projectPkgJsonPath = await findUp('package.json') assert(projectPkgJsonPath) const projectPkgJson = JSON.parse( await fsPromise.readFile(projectPkgJsonPath, 'utf-8') ) const pkgName = projectPkgJson.name const commit = child_process .spawnSync( os.platform() === 'win32' ? 'git.exe' : 'git', ['rev-parse', 'HEAD'], { shell: true } ) .stdout.toString() .trimEnd() const readLineInterface = createInterface({ input: createReadStream(path.join(projectDir, distDir, 'trace')), crlfDelay: Infinity, }) const sessionTrace = [] for await (const line of readLineInterface) { const lineEvents: TraceEvent[] = JSON.parse(line) for (const event of lineEvents) { if (event.traceId !== traceId) { // Only consider events for the current session continue } if ( // Always include root spans event.parentId === undefined || shouldUploadFullTrace || (mode === 'dev' ? DEV_ALLOWED_EVENTS.has(event.name) : BUILD_ALLOWED_EVENTS.has(event.name)) ) { sessionTrace.push(event) } } } const body: TraceRequestBody = { metadata: { anonymousId, arch: os.arch(), commit, cpus: os.cpus().length, isTurboSession, mode, nextVersion, pkgName, platform: os.platform(), sessionId, }, // The trace file can contain events spanning multiple sessions. // Only submit traces for the current session, as the metadata we send is // intended for this session only. traces: [sessionTrace], } if (isDebugEnabled) { console.log('Sending request with body', JSON.stringify(body, null, 2)) } let res = await fetch(traceUploadUrl, { method: 'POST', headers: { 'Content-Type': 'application/json', 'x-trace-transfer-mode': shouldUploadFullTrace ? 'full' : 'default', }, body: JSON.stringify(body), }) if (isDebugEnabled) { console.log('Received response', res.status, await res.json()) } })()