Use snapshots to verify error stack traces for dynamic validation errors (#80946)

For now, this is just documenting the current state of affairs with regards to how we print dynamic validation errors during prerendering.

Previously, the tests were run with and without `experimental.serverMinification`. Now, we're running them with and without the `--debug-prerender` CLI flag instead.

In follow-ups, we will add assertions for `next dev`, and also improve the errors for `next build`.

> [!NOTE]  
> This PR is best reviewed with hidden whitespace changes.

Author: unstubbable

test/e2e/app-dir/dynamic-io-errors/dynamic-io-errors.platform-dynamic.test.ts

@@ -1,94 +1,119 @@
 import { nextTestSetup } from 'e2e-utils'
+import { getPrerenderOutput } from './utils'
 
-import { createExpectError } from './utils'
+describe.each([
+  { inDebugMode: true, name: 'With --prerender-debug' },
+  { inDebugMode: false, name: 'Without --prerender-debug' },
+])('Dynamic IO Errors - $name', ({ inDebugMode }) => {
+  describe('Sync Dynamic - With Fallback - Math.random()', () => {
+    const { next, isNextDev, skipped } = nextTestSetup({
+      files: __dirname + '/fixtures/sync-random-with-fallback',
+      skipStart: true,
+      skipDeployment: true,
+      buildOptions: inDebugMode ? ['--debug-prerender'] : undefined,
+    })
 
-function runTests(options: { withMinification: boolean }) {
-  const { withMinification } = options
-  describe(`Dynamic IO Errors - ${withMinification ? 'With Minification' : 'Without Minification'}`, () => {
-    describe('Sync Dynamic - With Fallback - Math.random()', () => {
-      const { next, isNextDev, skipped } = nextTestSetup({
-        files: __dirname + '/fixtures/sync-random-with-fallback',
-        skipStart: true,
-        skipDeployment: true,
-      })
+    if (skipped) {
+      return
+    }
 
-      if (skipped) {
-        return
-      }
+    if (isNextDev) {
+      it('does not run in dev', () => {})
+      return
+    }
 
-      if (isNextDev) {
-        it('does not run in dev', () => {})
-        return
+    it('should not error the build when calling Math.random() if all dynamic access is inside a Suspense boundary', async () => {
+      try {
+        await next.start()
+      } catch {
+        throw new Error('expected build not to fail for fully static project')
       }
 
-      beforeEach(async () => {
-        if (!withMinification) {
-          await next.patchFile('next.config.js', (content) =>
-            content.replace(
-              'serverMinification: true,',
-              'serverMinification: false,'
-            )
-          )
-        }
-      })
-
-      it('should not error the build when calling Math.random() if all dynamic access is inside a Suspense boundary', async () => {
-        try {
-          await next.start()
-        } catch {
-          throw new Error('expected build not to fail for fully static project')
-        }
+      expect(next.cliOutput).toContain('◐ / ')
+      const $ = await next.render$('/')
+      expect($('[data-fallback]').length).toBe(2)
+    })
+  })
 
-        expect(next.cliOutput).toContain('◐ / ')
-        const $ = await next.render$('/')
-        expect($('[data-fallback]').length).toBe(2)
-      })
+  describe('Sync Dynamic - Without Fallback - Math.random()', () => {
+    const { next, isNextDev, isTurbopack, skipped } = nextTestSetup({
+      files: __dirname + '/fixtures/sync-random-without-fallback',
+      skipStart: true,
+      skipDeployment: true,
+      buildOptions: inDebugMode ? ['--debug-prerender'] : undefined,
     })
 
-    describe('Sync Dynamic - Without Fallback - Math.random()', () => {
-      const { next, isNextDev, skipped } = nextTestSetup({
-        files: __dirname + '/fixtures/sync-random-without-fallback',
-        skipStart: true,
-        skipDeployment: true,
-      })
+    if (skipped) {
+      return
+    }
 
-      if (skipped) {
-        return
-      }
+    if (isNextDev) {
+      it('does not run in dev', () => {})
+      return
+    }
 
-      if (isNextDev) {
-        it('does not run in dev', () => {})
-        return
+    it('should error the build if Math.random() happens before some component outside a Suspense boundary is complete', async () => {
+      try {
+        await next.start()
+      } catch {
+        // we expect the build to fail
       }
 
-      beforeEach(async () => {
-        if (!withMinification) {
-          await next.patchFile('next.config.js', (content) =>
-            content.replace(
-              'serverMinification: true,',
-              'serverMinification: false,'
-            )
-          )
-        }
+      const output = getPrerenderOutput(next.cliOutput, {
+        isMinified: !inDebugMode,
       })
 
-      it('should error the build if Math.random() happens before some component outside a Suspense boundary is complete', async () => {
-        try {
-          await next.start()
-        } catch {
-          // we expect the build to fail
+      if (isTurbopack) {
+        if (inDebugMode) {
+          expect(output).toMatchInlineSnapshot(`
+           "Error: Route "/" used \`Math.random()\` outside of \`"use cache"\` and without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-random
+               at RandomReadingComponent (turbopack:///[project]/app/page.tsx:35:22)
+             33 |     use(new Promise((r) => process.nextTick(r)))
+             34 |   }
+           > 35 |   const random = Math.random()
+                |                      ^
+             36 |   return (
+             37 |     <div>
+             38 |       <span id="rand">{random}</span>
+           Error occurred prerendering page "/". Read more: https://nextjs.org/docs/messages/prerender-error
+
+           > Export encountered errors on following paths:
+           	/page: /"
+          `)
+        } else {
+          expect(output).toMatchInlineSnapshot(`
+           "Error: Route "/" used \`Math.random()\` outside of \`"use cache"\` and without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-random
+               at a (<next-dist-dir>)
+           Error occurred prerendering page "/". Read more: https://nextjs.org/docs/messages/prerender-error
+           Export encountered an error on /page: /, exiting the build."
+          `)
         }
-        const expectError = createExpectError(next.cliOutput)
+      } else {
+        if (inDebugMode) {
+          expect(output).toMatchInlineSnapshot(`
+           "Error: Route "/" used \`Math.random()\` outside of \`"use cache"\` and without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-random
+               at RandomReadingComponent (webpack:///app/page.tsx:35:22)
+             33 |     use(new Promise((r) => process.nextTick(r)))
+             34 |   }
+           > 35 |   const random = Math.random()
+                |                      ^
+             36 |   return (
+             37 |     <div>
+             38 |       <span id="rand">{random}</span>
+           Error occurred prerendering page "/". Read more: https://nextjs.org/docs/messages/prerender-error
 
-        expectError(
-          'Error: Route "/" used `Math.random()` outside of `"use cache"` and without explicitly calling `await connection()` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-random'
-        )
-        expectError('Error occurred prerendering page "/"')
-        expectError('exiting the build.')
-      })
+           > Export encountered errors on following paths:
+           	/page: /"
+          `)
+        } else {
+          expect(output).toMatchInlineSnapshot(`
+           "Error: Route "/" used \`Math.random()\` outside of \`"use cache"\` and without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-random
+               at a (<next-dist-dir>)
+           Error occurred prerendering page "/". Read more: https://nextjs.org/docs/messages/prerender-error
+           Export encountered an error on /page: /, exiting the build."
+          `)
+        }
+      }
     })
   })
-}
-
-runTests({ withMinification: true })
-runTests({ withMinification: false })
+})