refactor(error-overlay): improve server code for webpack/Turbopack middleware

packages/next/src/build/swc/index.ts

@@ -13,6 +13,7 @@ import { isDeepStrictEqual } from 'util'
 import type { DefineEnvPluginOptions } from '../webpack/plugins/define-env-plugin'
 import { getDefineEnv } from '../webpack/plugins/define-env-plugin'
 import type { PageExtensions } from '../page-extensions-type'
+import type { TurbopackStackFrame } from '../../client/components/react-dev-overlay/server/middleware-turbopack'
 
 const nextVersion = process.env.__NEXT_VERSION as string
 
@@ -600,14 +601,6 @@ export interface HmrIdentifiers {
   identifiers: string[]
 }
 
-interface TurbopackStackFrame {
-  column: number | null
-  file: string
-  isServer: boolean
-  line: number
-  methodName: string | null
-}
-
 export type UpdateMessage =
   | {
       updateType: 'start'

packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts

@@ -49,18 +49,21 @@ async function getSourceFrame(
   compilation: any
 ): Promise<{ frame: string; lineNumber: string; column: string }> {
   try {
-    const loc = input.loc
-      ? input.loc
-      : input.dependencies.map((d: any) => d.loc).filter(Boolean)[0]
+    const loc =
+      input.loc || input.dependencies.map((d: any) => d.loc).filter(Boolean)[0]
     const originalSource = input.module.originalSource()
 
     const result = await createOriginalStackFrame({
-      line: loc.start.line,
-      column: loc.start.column,
       source: originalSource,
       rootDirectory: compilation.options.context!,
       modulePath: fileName,
-      frame: {},
+      frame: {
+        arguments: [],
+        file: fileName,
+        methodName: '',
+        lineNumber: loc.start.line,
+        column: loc.start.column,
+      },
     })
 
     return {

packages/next/src/client/components/react-dev-overlay/internal/components/CodeFrame/CodeFrame.tsx

@@ -1,6 +1,6 @@
 import Anser from 'next/dist/compiled/anser'
 import * as React from 'react'
-import type { StackFrame } from 'next/dist/compiled/stacktrace-parser'
+import type { StackFrame } from '../../../server/shared'
 import stripAnsi from 'next/dist/compiled/strip-ansi'
 import { getFrameSource } from '../../helpers/stack-frame'
 import { useOpenInEditor } from '../../helpers/use-open-in-editor'

packages/next/src/client/components/react-dev-overlay/internal/container/RuntimeError/CallStackFrame.tsx

@@ -1,11 +1,11 @@
 import React from 'react'
-import type { StackFrame } from 'next/dist/compiled/stacktrace-parser'
 import {
   getFrameSource,
   type OriginalStackFrame,
 } from '../../helpers/stack-frame'
 import { useOpenInEditor } from '../../helpers/use-open-in-editor'
 import { HotlinkedText } from '../../components/hot-linked-text'
+import type { StackFrame } from '../../../server/shared'
 
 export const CallStackFrame: React.FC<{
   frame: OriginalStackFrame

packages/next/src/client/components/react-dev-overlay/internal/helpers/stack-frame.ts

@@ -1,5 +1,7 @@
-import type { StackFrame } from 'next/dist/compiled/stacktrace-parser'
-import type { OriginalStackFrameResponse } from '../../server/shared'
+import type {
+  OriginalStackFrameResponse,
+  StackFrame,
+} from '../../server/shared'
 
 export interface OriginalStackFrame extends OriginalStackFrameResponse {
   error: boolean

packages/next/src/client/components/react-dev-overlay/server/middleware-turbopack.ts

@@ -1,55 +1,61 @@
 import type { IncomingMessage, ServerResponse } from 'http'
-import { findSourcePackage, type OriginalStackFrameResponse } from './shared'
+import {
+  badRequest,
+  findSourcePackage,
+  getOriginalCodeFrame,
+  internalServerError,
+  json,
+  noContent,
+  type OriginalStackFrameResponse,
+  type StackFrame,
+} from './shared'
 
 import fs, { constants as FS } from 'fs/promises'
-import { codeFrameColumns } from 'next/dist/compiled/babel/code-frame'
 import { launchEditor } from '../internal/helpers/launchEditor'
 
+/** @see https://github.com/vercel/next.js/blob/415cd74b9a220b6f50da64da68c13043e9b02995/packages/next-swc/crates/napi/src/next_api/project.rs#L824-L833 */
+export interface TurbopackStackFrame
+  extends Pick<StackFrame, 'file' | 'methodName'> {
+  isServer: boolean
+  isInternal?: boolean
+  /** 1-indexed, unlike source map tokens */
+  line: number | null
+  /** 1-indexed, unlike source map tokens */
+  column: number | null
+}
+
 interface Project {
   getSourceForAsset(filePath: string): Promise<string | null>
   traceSource(
     stackFrame: TurbopackStackFrame
   ): Promise<TurbopackStackFrame | null>
 }
 
-interface TurbopackStackFrame {
-  // 1-based
-  column: number | null
-  // 1-based
-  file: string
-  isServer: boolean
-  line: number | null
-  methodName: string | null
-  isInternal?: boolean
-}
-
 const currentSourcesByFile: Map<string, Promise<string | null>> = new Map()
 export async function batchedTraceSource(
   project: Project,
   frame: TurbopackStackFrame
-) {
+): Promise<{ frame: StackFrame; source: string | null } | undefined> {
   const file = frame.file ? decodeURIComponent(frame.file) : undefined
-  if (!file) {
-    return
-  }
+  if (!file) return
 
   const sourceFrame = await project.traceSource(frame)
-
-  if (!sourceFrame) {
-    return
-  }
-
-  let source
-  // Don't show code frames for node_modules. These can also often be large bundled files.
-  if (!sourceFrame.file.includes('node_modules') && !sourceFrame.isInternal) {
+  if (!sourceFrame) return
+
+  let source = null
+  // Don't look up source for node_modules or internals. These can often be large bundled files.
+  if (
+    sourceFrame.file &&
+    !(sourceFrame.file.includes('node_modules') || sourceFrame.isInternal)
+  ) {
     let sourcePromise = currentSourcesByFile.get(sourceFrame.file)
     if (!sourcePromise) {
       sourcePromise = project.getSourceForAsset(sourceFrame.file)
       currentSourcesByFile.set(sourceFrame.file, sourcePromise)
       setTimeout(() => {
         // Cache file reads for 100ms, as frames will often reference the same
         // files and can be large.
-        currentSourcesByFile.delete(sourceFrame.file)
+        currentSourcesByFile.delete(sourceFrame.file!)
       }, 100)
     }
 
@@ -64,7 +70,7 @@ export async function batchedTraceSource(
       methodName: sourceFrame.methodName ?? frame.methodName ?? '<unknown>',
       arguments: [],
     },
-    source: source ?? null,
+    source,
   }
 }
 
@@ -74,29 +80,15 @@ export async function createOriginalStackFrame(
 ): Promise<OriginalStackFrameResponse | null> {
   const traced = await batchedTraceSource(project, frame)
   if (!traced) {
-    const sourcePackage = findSourcePackage(frame.file)
+    const sourcePackage = findSourcePackage(frame)
     if (sourcePackage) return { sourcePackage }
     return null
   }
 
   return {
     originalStackFrame: traced.frame,
-    originalCodeFrame:
-      traced.source === null
-        ? null
-        : codeFrameColumns(
-            traced.source,
-            {
-              start: {
-                // 1-based, but -1 means start line without highlighting
-                line: traced.frame.lineNumber ?? -1,
-                // 1-based, but 0 means whole line without column highlighting
-                column: traced.frame.column ?? 0,
-              },
-            },
-            { forceColor: true }
-          ),
-    sourcePackage: findSourcePackage(traced.frame.file),
+    originalCodeFrame: getOriginalCodeFrame(traced.frame, traced.source),
+    sourcePackage: findSourcePackage(traced.frame),
   }
 }
 
@@ -106,7 +98,7 @@ export function getOverlayMiddleware(project: Project) {
 
     const frame = {
       file: searchParams.get('file') as string,
-      methodName: searchParams.get('methodName'),
+      methodName: searchParams.get('methodName') ?? '<unknown>',
       line: parseInt(searchParams.get('lineNumber') ?? '0', 10) || 0,
       column: parseInt(searchParams.get('column') ?? '0', 10) || 0,
       isServer: searchParams.get('isServer') === 'true',
@@ -117,55 +109,32 @@ export function getOverlayMiddleware(project: Project) {
       try {
         originalStackFrame = await createOriginalStackFrame(project, frame)
       } catch (e: any) {
-        res.statusCode = 500
-        res.write(e.message)
-        res.end()
-        return
+        return internalServerError(res, e.message)
       }
 
-      if (originalStackFrame === null) {
+      if (!originalStackFrame) {
         res.statusCode = 404
-        res.write('Unable to resolve sourcemap')
-        res.end()
-        return
+        return res.end('Unable to resolve sourcemap')
       }
 
-      res.statusCode = 200
-      res.setHeader('Content-Type', 'application/json')
-      res.write(Buffer.from(JSON.stringify(originalStackFrame)))
-      res.end()
-      return
+      return json(res, originalStackFrame)
     } else if (pathname === '/__nextjs_launch-editor') {
-      if (!frame.file) {
-        res.statusCode = 400
-        res.write('Bad Request')
-        res.end()
-        return
-      }
+      if (!frame.file) return badRequest(res)
 
       const fileExists = await fs.access(frame.file, FS.F_OK).then(
         () => true,
         () => false
       )
-      if (!fileExists) {
-        res.statusCode = 204
-        res.write('No Content')
-        res.end()
-        return
-      }
+      if (!fileExists) return noContent(res)
 
       try {
         launchEditor(frame.file, frame.line ?? 1, frame.column ?? 1)
       } catch (err) {
         console.log('Failed to launch editor:', err)
-        res.statusCode = 500
-        res.write('Internal Server Error')
-        res.end()
-        return
+        return internalServerError(res)
       }
 
-      res.statusCode = 204
-      res.end()
+      noContent(res)
     }
   }
 }