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

Turbopack: log telemetry events when `TurbopackInternalError`s occur (#77660)

Note: **This does not include any error content aside from that the
error is a `TurbopackInternalError`.**

This adds a function, `TurbopackInternalError.createAndRecordTelemetry`
that both creates the `TurbopackInternalError` instance and logs that it
occurred to telemetry. This telemetry event only includes 1) that an
error occurred once and 2) the error code or error name of the error, in
this case `TurbopackInternalError`.

Test Plan: Added a unit test, `TurbopackInternalError.test.ts`

Manual test plan:
- Insert a panic into Turbopack source in `analyse_ecmascript_module`.
- Run `NEXT_TELEMETRY_DEBUG=1 NODE_OPTIONS="--trace-deprecation
--enable-source-maps" pnpm next "build" "--turbo"
"test/e2e/app-dir/app/“`.
- Verify telemetry debugging shows an event called `NEXT_ERROR_THROWN`
with `errorCode` of `TurbopackInternalError`.
- Do the same with `NEXT_TELEMETRY_DEBUG=1
NODE_OPTIONS="--trace-deprecation --enable-source-maps" pnpm next "dev"
"--turbo" "test/e2e/app-dir/app/“`
parent 6acd29d6
...@@ -669,5 +669,6 @@ ...@@ -669,5 +669,6 @@
"668": "Internal Next.js error: Router action dispatched before initialization.", "668": "Internal Next.js error: Router action dispatched before initialization.",
"669": "Invariant: --turbopack is set but the build used Webpack", "669": "Invariant: --turbopack is set but the build used Webpack",
"670": "Invariant: --turbopack is not set but the build used Turbopack. Add --turbopack to \"next start\".", "670": "Invariant: --turbopack is not set but the build used Turbopack. Add --turbopack to \"next start\".",
"671": "Specified images.remotePatterns must have protocol \"http\" or \"https\" received \"%s\"." "671": "Specified images.remotePatterns must have protocol \"http\" or \"https\" received \"%s\".",
"672": "Expected `telemetry` to be set in globals"
} }
...@@ -509,7 +509,7 @@ function bindingToApi( ...@@ -509,7 +509,7 @@ function bindingToApi(
try { try {
return await fn() return await fn()
} catch (nativeError: any) { } catch (nativeError: any) {
throw new TurbopackInternalError(nativeError) throw TurbopackInternalError.createAndRecordTelemetry(nativeError)
} }
} }
...@@ -577,7 +577,7 @@ function bindingToApi( ...@@ -577,7 +577,7 @@ function bindingToApi(
} catch (e) { } catch (e) {
if (e === cancel) return if (e === cancel) return
if (e instanceof Error) { if (e instanceof Error) {
throw new TurbopackInternalError(e) throw TurbopackInternalError.createAndRecordTelemetry(e)
} }
throw e throw e
} finally { } finally {
......
...@@ -50,6 +50,7 @@ import { NEXT_PATCH_SYMBOL } from './patch-fetch' ...@@ -50,6 +50,7 @@ import { NEXT_PATCH_SYMBOL } from './patch-fetch'
import type { ServerInitResult } from './render-server' import type { ServerInitResult } from './render-server'
import { filterInternalHeaders } from './server-ipc/utils' import { filterInternalHeaders } from './server-ipc/utils'
import { blockCrossSite } from './router-utils/block-cross-site' import { blockCrossSite } from './router-utils/block-cross-site'
import { traceGlobals } from '../../trace/shared'
const debug = setupDebug('next:router-server:main') const debug = setupDebug('next:router-server:main')
const isNextFont = (pathname: string | null) => const isNextFont = (pathname: string | null) =>
...@@ -122,6 +123,8 @@ export async function initialize(opts: { ...@@ -122,6 +123,8 @@ export async function initialize(opts: {
const telemetry = new Telemetry({ const telemetry = new Telemetry({
distDir: path.join(opts.dir, config.distDir), distDir: path.join(opts.dir, config.distDir),
}) })
traceGlobals.set('telemetry', telemetry)
const { pagesDir, appDir } = findPagesDir(opts.dir) const { pagesDir, appDir } = findPagesDir(opts.dir)
const { setupDevBundler } = const { setupDevBundler } =
......
...@@ -3,6 +3,7 @@ import type { ...@@ -3,6 +3,7 @@ import type {
StyledString, StyledString,
TurbopackResult, TurbopackResult,
} from '../../../build/swc/types' } from '../../../build/swc/types'
import { bold, green, magenta, red } from '../../../lib/picocolors' import { bold, green, magenta, red } from '../../../lib/picocolors'
import isInternal from '../is-internal' import isInternal from '../is-internal'
import { import {
...@@ -13,6 +14,8 @@ import type { EntryKey } from './entry-key' ...@@ -13,6 +14,8 @@ import type { EntryKey } from './entry-key'
import * as Log from '../../../build/output/log' import * as Log from '../../../build/output/log'
import type { NextConfigComplete } from '../../../server/config-shared' import type { NextConfigComplete } from '../../../server/config-shared'
import loadJsConfig from '../../../build/load-jsconfig' import loadJsConfig from '../../../build/load-jsconfig'
import { eventErrorThrown } from '../../../telemetry/events'
import { traceGlobals } from '../../../trace/shared'
type IssueKey = `${Issue['severity']}-${Issue['filePath']}-${string}-${string}` type IssueKey = `${Issue['severity']}-${Issue['filePath']}-${string}-${string}`
export type IssuesMap = Map<IssueKey, Issue> export type IssuesMap = Map<IssueKey, Issue>
...@@ -30,6 +33,22 @@ export class ModuleBuildError extends Error { ...@@ -30,6 +33,22 @@ export class ModuleBuildError extends Error {
export class TurbopackInternalError extends Error { export class TurbopackInternalError extends Error {
name = 'TurbopackInternalError' name = 'TurbopackInternalError'
// Manually set this as this isn't statically determinable
__NEXT_ERROR_CODE = 'TurbopackInternalError'
static createAndRecordTelemetry(cause: Error) {
const error = new TurbopackInternalError(cause)
const telemetry = traceGlobals.get('telemetry')
if (telemetry) {
telemetry.record(eventErrorThrown(error))
} else {
console.error('Expected `telemetry` to be set in globals')
}
return error
}
constructor(cause: Error) { constructor(cause: Error) {
super(cause.message) super(cause.message)
this.stack = cause.stack this.stack = cause.stack
......
import type { TelemetryPlugin } from '../../build/webpack/plugins/telemetry-plugin/telemetry-plugin' import type { TelemetryPlugin } from '../../build/webpack/plugins/telemetry-plugin/telemetry-plugin'
import type { SWC_TARGET_TRIPLE } from '../../build/webpack/plugins/telemetry-plugin/telemetry-plugin' import type { SWC_TARGET_TRIPLE } from '../../build/webpack/plugins/telemetry-plugin/telemetry-plugin'
import type { UseCacheTrackerKey } from '../../build/webpack/plugins/telemetry-plugin/use-cache-tracker-utils' import type { UseCacheTrackerKey } from '../../build/webpack/plugins/telemetry-plugin/use-cache-tracker-utils'
import { extractNextErrorCode } from '../../lib/error-telemetry-utils'
const REGEXP_DIRECTORY_DUNDER = const REGEXP_DIRECTORY_DUNDER =
/[\\/]__[^\\/]+(?<![\\/]__(?:tests|mocks))__[\\/]/i /[\\/]__[^\\/]+(?<![\\/]__(?:tests|mocks))__[\\/]/i
...@@ -212,3 +213,21 @@ export function eventPackageUsedInGetServerSideProps( ...@@ -212,3 +213,21 @@ export function eventPackageUsedInGetServerSideProps(
}, },
})) }))
} }
export const ERROR_THROWN_EVENT = 'NEXT_ERROR_THROWN'
type ErrorThrownEvent = {
eventName: typeof ERROR_THROWN_EVENT
payload: {
errorCode: string | undefined
}
}
// Creates a Telemetry event for errors. For privacy, only includes the error code.
export function eventErrorThrown(error: Error): ErrorThrownEvent {
return {
eventName: ERROR_THROWN_EVENT,
payload: {
errorCode: extractNextErrorCode(error) || 'Unknown',
},
}
}
import path from 'path'
import os from 'os'
import { TurbopackInternalError } from 'next/dist/shared/lib/turbopack/utils'
import { Telemetry } from 'next/dist/telemetry/storage'
import { setGlobal } from 'next/dist/trace'
import { traceGlobals } from 'next/dist/trace/shared'
describe('TurbopackInternalError', () => {
it('sends a telemetry event when TurbopackInternalError.createAndRecordTelemetry() is called', async () => {
const oldTelemetry = traceGlobals.get('telemetry')
try {
const distDir = path.join(os.tmpdir(), 'next-telemetry')
const telemetry = new Telemetry({ distDir })
setGlobal('telemetry', telemetry)
const submitRecord = jest
// @ts-ignore
.spyOn(telemetry, 'submitRecord')
// @ts-ignore
.mockImplementation(() => Promise.resolve())
TurbopackInternalError.createAndRecordTelemetry(new Error('test error'))
expect(submitRecord).toHaveBeenCalledWith({
eventName: 'NEXT_ERROR_THROWN',
payload: {
errorCode: 'TurbopackInternalError',
},
})
} finally {
setGlobal('telemetry', oldTelemetry)
}
})
})
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