[Cache Components] Allow sync IO inside console methods (#83843)

console methods may be patched to do things like add a timestamp to the
log row. While we can't determine the meaning of reading the current
time in arbitrary contexts we can know with reasonable certainty that
any sync IO inside a console method is not being used in the logical
output of the program. To account for this we can make a special
affordance for sync IO inside of these methods that allows them to run
without interrupting the prerender early.

To do this we patch these properties on the console global and set up a
wrapper in the setter. This wrapper will make any assigned function into
another function that exits the `workUnitAsyncStorage` scope before
executing the wrapped function. This will allow `new Date()` and other
sync IO APIs to be called in the internal implementation of these
methods without triggering an error while prerendering.

Fixes NAR-403

Author: gnoff

.vscode/settings.json

@@ -62,6 +62,7 @@
     "packages/next/src/server/app-render/dynamic-access-async-storage-instance.ts",
     "packages/next/src/server/app-render/work-async-storage-instance.ts",
     "packages/next/src/server/app-render/work-unit-async-storage-instance.ts",
+    "packages/next/src/server/app-render/dev-logs-async-storage-instance.ts",
     "packages/next/src/client/components/segment-cache-impl/*"
   ],
   // Disable TypeScript surveys.

packages/next/src/server/app-render/app-render.tsx

@@ -174,6 +174,7 @@ import {
   workUnitAsyncStorage,
   type PrerenderStore,
 } from './work-unit-async-storage.external'
+import { devLogsAsyncStorage } from './dev-logs-async-storage.external'
 import { CacheSignal } from './cache-signal'
 import { getTracedMetadata } from '../lib/trace/utils'
 import { InvariantError } from '../../shared/lib/invariant-error'
@@ -2302,7 +2303,9 @@ async function renderToStream(
         }
       )
 
-      spawnDynamicValidationInDev(
+      devLogsAsyncStorage.run(
+        { dim: true },
+        spawnDynamicValidationInDev,
         resolveValidation,
         tree,
         ctx,

packages/next/src/server/app-render/dev-logs-async-storage-instance.ts

@@ -0,0 +1,5 @@
+import { createAsyncLocalStorage } from './async-local-storage'
+import type { DevLogsAsyncStorage } from './dev-logs-async-storage.external'
+
+export const devLogsAsyncStorageInstance: DevLogsAsyncStorage =
+  createAsyncLocalStorage()

packages/next/src/server/app-render/dev-logs-async-storage.external.ts

@@ -0,0 +1,17 @@
+import type { AsyncLocalStorage } from 'async_hooks'
+
+// Share the instance module in the next-shared layer
+import { devLogsAsyncStorageInstance } from './dev-logs-async-storage-instance' with { 'turbopack-transition': 'next-shared' }
+
+export interface DevLogsStore {
+  /**
+   * if true the color of logs output will be dimmed to indicate the log is
+   * from a repeat or validation render that is not typically relevant to
+   * the primary action the server is taking.
+   */
+  readonly dim: boolean
+}
+
+export type DevLogsAsyncStorage = AsyncLocalStorage<DevLogsStore>
+
+export { devLogsAsyncStorageInstance as devLogsAsyncStorage }

packages/next/src/server/node-environment-extensions/console-dev.tsx

@@ -1,5 +1,5 @@
 import { dim } from '../../lib/picocolors'
-import { workUnitAsyncStorage } from '../app-render/work-unit-async-storage.external'
+import { devLogsAsyncStorage } from '../app-render/dev-logs-async-storage.external'
 
 type InterceptableConsoleMethod =
   | 'error'
@@ -163,25 +163,12 @@ function patchConsoleMethodDEV(methodName: InterceptableConsoleMethod): void {
     const originalMethod = descriptor.value
     const originalName = Object.getOwnPropertyDescriptor(originalMethod, 'name')
     const wrapperMethod = function (this: typeof console, ...args: any[]) {
-      const workUnitStore = workUnitAsyncStorage.getStore()
+      const devLogsStore = devLogsAsyncStorage.getStore()
 
-      switch (workUnitStore?.type) {
-        case 'prerender':
-        case 'prerender-client':
-        case 'prerender-runtime':
-          originalMethod.apply(this, dimConsoleCall(methodName, args))
-          break
-        case 'prerender-ppr':
-        case 'prerender-legacy':
-        case 'request':
-        case 'cache':
-        case 'private-cache':
-        case 'unstable-cache':
-        case undefined:
-          originalMethod.apply(this, args)
-          break
-        default:
-          workUnitStore satisfies never
+      if (devLogsStore?.dim === true) {
+        return originalMethod.apply(this, dimConsoleCall(methodName, args))
+      } else {
+        return originalMethod.apply(this, args)
       }
     }
     if (originalName) {