Expand server-source-maps scenarios to cover Edge runtime

...and use test patterns more consistently
vercel · Nov 8, 2024 · f2c96cc · f2c96cc
1 parent 98064fa
commit f2c96cc
Show file tree

Hide file tree

Showing 20 changed files with 286 additions and 143 deletions.
diff --git a/test/development/app-render-error-log/app-render-error-log.test.ts b/test/development/app-render-error-log/app-render-error-log.test.ts
diff --git a/test/development/app-render-error-log/app/edge/page.tsx b/test/development/app-render-error-log/app/edge/page.tsx
diff --git a/test/development/app-render-error-log/app/fn.ts b/test/development/app-render-error-log/app/fn.ts
diff --git a/test/development/app-render-error-log/app/layout.tsx b/test/development/app-render-error-log/app/layout.tsx
diff --git a/test/development/app-render-error-log/app/page.tsx b/test/development/app-render-error-log/app/page.tsx
diff --git a/test/development/app-render-error-log/next.config.js b/test/development/app-render-error-log/next.config.js
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/layout.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/layout.js
@@ -1,7 +1,11 @@
+import { Suspense } from 'react'
+
 export default function Root({ children }) {
   return (
     <html>
-      <body>{children}</body>
+      <body>
+        <Suspense>{children}</Suspense>
+      </body>
     </html>
   )
 }
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log-cause/page.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log-cause/page.js
@@ -1,9 +1,13 @@
+import { connection } from 'next/server'
+
 function logError(cause) {
   const error = new Error('Boom', { cause })
   console.error(error)
 }
 
-export default function Page() {
+export default async function Page() {
+  await connection()
+
   const error = new Error('Boom')
   logError(error)
   return null

diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log-custom-name/page.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log-custom-name/page.js
@@ -1,9 +1,13 @@
+import { connection } from 'next/server'
+
 class UnnamedError extends Error {}
 class NamedError extends Error {
   name = 'MyError'
 }
 
-export default function Page() {
+export default async function Page() {
+  await connection()
+
   console.error(new UnnamedError('Foo'))
   console.error(new NamedError('Bar'))
   return null

diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log-ignore-listed/page.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log-ignore-listed/page.js
@@ -1,11 +1,14 @@
+import { connection } from 'next/server'
 import { run } from 'internal-pkg'
 
 function logError() {
   const error = new Error('Boom')
   console.error(error)
 }
 
-export default function Page() {
+export default async function Page() {
+  await connection()
+
   run(() => logError())
   return null
 }
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log/page.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/rsc-error-log/page.js
@@ -1,9 +1,13 @@
+import { connection } from 'next/server'
+
 function logError() {
   const error = new Error('Boom')
   console.error(error)
 }
 
-export default function Page() {
+export default async function Page() {
+  await connection()
+
   logError()
   return null
 }
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/ssr-throw/Thrower.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/ssr-throw/Thrower.js
@@ -0,0 +1,9 @@
+'use client'
+
+function throwError() {
+  throw new Error('Boom')
+}
+
+export function Thrower() {
+  throwError()
+}
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/default/app/ssr-throw/page.js b/test/e2e/app-dir/server-source-maps/fixtures/default/app/ssr-throw/page.js
@@ -0,0 +1,7 @@
+import { connection } from 'next/server'
+import { Thrower } from './Thrower'
+
+export default async function Page() {
+  await connection()
+  return <Thrower />
+}
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/edge/app/layout.js b/test/e2e/app-dir/server-source-maps/fixtures/edge/app/layout.js
@@ -0,0 +1,9 @@
+export const runtime = 'edge'
+
+export default function Root({ children }) {
+  return (
+    <html>
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/...ixtures/default/app/ssr-error-log/page.js → ...s/fixtures/edge/app/rsc-error-log/page.js b/...ixtures/default/app/ssr-error-log/page.js → ...s/fixtures/edge/app/rsc-error-log/page.js
@@ -1,8 +1,5 @@
-'use client'
-
 function logError() {
-  const error = new Error('Boom')
-  console.error(error)
+  console.error(new Error('Boom'))
 }
 
 export default function Page() {

diff --git a/test/e2e/app-dir/server-source-maps/fixtures/edge/app/rsc-throw/page.js b/test/e2e/app-dir/server-source-maps/fixtures/edge/app/rsc-throw/page.js
@@ -0,0 +1,8 @@
+function throwError() {
+  throw new Error('Boom')
+}
+
+export default function Page() {
+  throwError()
+  return null
+}
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/edge/app/ssr-throw/page.js b/test/e2e/app-dir/server-source-maps/fixtures/edge/app/ssr-throw/page.js
@@ -0,0 +1,10 @@
+'use client'
+
+function throwError() {
+  throw new Error('Boom')
+}
+
+export default function Page() {
+  throwError()
+  return null
+}
diff --git a/test/e2e/app-dir/server-source-maps/fixtures/edge/next.config.js b/test/e2e/app-dir/server-source-maps/fixtures/edge/next.config.js
@@ -0,0 +1,10 @@
+/**
+ * @type {import('next').NextConfig}
+ */
+const nextConfig = {
+  experimental: {
+    serverSourceMaps: true,
+  },
+}
+
+module.exports = nextConfig
diff --git a/test/e2e/app-dir/server-source-maps/server-source-maps-edge.test.ts b/test/e2e/app-dir/server-source-maps/server-source-maps-edge.test.ts
@@ -0,0 +1,99 @@
+/* eslint-disable jest/no-standalone-expect */
+import * as path from 'path'
+import { nextTestSetup } from 'e2e-utils'
+import stripAnsi from 'strip-ansi'
+import { retry } from 'next-test-utils'
+
+function normalizeCliOutput(output: string) {
+  return stripAnsi(output)
+}
+
+describe('app-dir - server source maps edge runtime', () => {
+  const { skipped, next, isNextDev, isTurbopack } = nextTestSetup({
+    files: path.join(__dirname, 'fixtures/edge'),
+    // Deploy tests don't have access to runtime logs.
+    // Manually verify that the runtime logs match.
+    skipDeployment: true,
+  })
+
+  if (skipped) return
+
+  it('logged errors have a sourcemapped stack with a codeframe', async () => {
+    const outputIndex = next.cliOutput.length
+    await next.render('/rsc-error-log')
+
+    if (isNextDev) {
+      await retry(() => {
+        expect(next.cliOutput.slice(outputIndex)).toContain('Error: Boom')
+      })
+      expect(normalizeCliOutput(next.cliOutput.slice(outputIndex))).toContain(
+        isTurbopack
+          ? // TODO(veil): Error stack should be printed
+            '\n[Error: Boom]\n'
+          : // TODO(veil): Error stack should be printed
+            '\n[Error: Boom]\n'
+      )
+    } else {
+      // TODO: Test `next build` with `--enable-source-maps`.
+    }
+  })
+
+  it('thrown SSR errors', async () => {
+    const outputIndex = next.cliOutput.length
+    await next.render('/ssr-throw')
+
+    if (isNextDev) {
+      await retry(() => {
+        expect(next.cliOutput.slice(outputIndex)).toContain('Error: Boom')
+      })
+
+      const cliOutput = stripAnsi(next.cliOutput.slice(outputIndex))
+      expect(cliOutput).toContain(
+        isTurbopack
+          ? '\n ⨯ Error: Boom' +
+              '\n    at throwError (./app/ssr-throw/page.js:4:9)' +
+              '\n    at Page (./app/ssr-throw/page.js:8:3)' +
+              '\ndigest: "'
+          : '\n ⨯ Error: Boom' +
+              '\n    at throwError (./app/ssr-throw/page.js:6:11)' +
+              '\n    at Page (./app/ssr-throw/page.js:9:5)' +
+              '\ndigest: "'
+      )
+      expect(cliOutput).toMatch(/digest: "\d+"/)
+    } else {
+      // TODO: Test `next build` with `--enable-source-maps`.
+    }
+  })
+
+  it('should log the correct values on app-render error', async () => {
+    const outputIndex = next.cliOutput.length
+    await next.fetch('/rsc-throw')
+
+    if (isNextDev) {
+      await retry(() => {
+        expect(next.cliOutput.slice(outputIndex)).toMatch(/Error: Boom/)
+      })
+
+      const cliOutput = stripAnsi(next.cliOutput.slice(outputIndex))
+      // TODO(veil): Hide Node.js internal stackframes
+      expect(cliOutput).toContain(
+        isTurbopack
+          ? '\n ⨯ Error: Boom' +
+              '\n    at throwError (./app/rsc-throw/page.js:2:9)' +
+              '\n    at Page (./app/rsc-throw/page.js:6:3)' +
+              // TODO(veil): Hide Node.js internal stackframes
+              '\n    at AsyncLocalStorage.run (node:async_hooks:346:14)' +
+              '\ndigest: "'
+          : '\n ⨯ Error: Boom' +
+              '\n    at throwError (./app/rsc-throw/page.js:6:11)' +
+              '\n    at Page (./app/rsc-throw/page.js:9:5)' +
+              // TODO(veil): Hide Node.js internal stackframes
+              '\n    at AsyncLocalStorage.run (node:async_hooks:346:14)' +
+              '\ndigest: "'
+      )
+      expect(cliOutput).toMatch(/digest: "\d+"/)
+    } else {
+      // TODO: Test `next build` with `--enable-source-maps`.
+    }
+  })
+})