@sifxprime/krouter 0.5.166 → 0.5.167

package/app/node_modules/next/dist/server/dynamic-rendering-utils.js

@@ -6,18 +6,24 @@ Object.defineProperty(exports, "__esModule", {
     ClientHookDynamicError: null,
     RENDER_STAGES_BY_DATA_KIND: null,
     applyOwnerStack: null,
+    createPrerenderDataTracking: null,
+    finishPrerenderDataTracking: null,
     isClientHookDynamicError: null,
     isHangingPromiseRejectionError: null,
     makeClientHookHangingPromise: null,
     makeDevtoolsIOAwarePromise: null,
     makeDynamicHangingPromise: null,
     makeFallbackParamsHangingPromise: null,
+    makePrefetchHangingPromise: null,
     makePromiseFromTrigger: null,
-    makeRuntimeHangingPromise: null,
-    makeStageHangingPromise: null,
+    makeSessionDataHangingPromise: null,
+    makeURLDataHangingPromise: null,
+    makeUnknownRuntimeDataHangingPromise: null,
     makeUntrackedHangingPromise: null,
     trackFallbackParamsAccessed: null,
-    trackRuntimeDataAccessed: null
+    trackIncompatibleShellContent: null,
+    trackPromiseUsed: null,
+    trackURLDataAccessed: null
 });
 function _export(target, all) {
     for(var name in all)Object.defineProperty(target, name, {
@@ -35,6 +41,12 @@ _export(exports, {
     applyOwnerStack: function() {
         return applyOwnerStack;
     },
+    createPrerenderDataTracking: function() {
+        return createPrerenderDataTracking;
+    },
+    finishPrerenderDataTracking: function() {
+        return finishPrerenderDataTracking;
+    },
     isClientHookDynamicError: function() {
         return isClientHookDynamicError;
     },
@@ -53,14 +65,20 @@ _export(exports, {
     makeFallbackParamsHangingPromise: function() {
         return makeFallbackParamsHangingPromise;
     },
+    makePrefetchHangingPromise: function() {
+        return makePrefetchHangingPromise;
+    },
     makePromiseFromTrigger: function() {
         return makePromiseFromTrigger;
     },
-    makeRuntimeHangingPromise: function() {
-        return makeRuntimeHangingPromise;
+    makeSessionDataHangingPromise: function() {
+        return makeSessionDataHangingPromise;
     },
-    makeStageHangingPromise: function() {
-        return makeStageHangingPromise;
+    makeURLDataHangingPromise: function() {
+        return makeURLDataHangingPromise;
+    },
+    makeUnknownRuntimeDataHangingPromise: function() {
+        return makeUnknownRuntimeDataHangingPromise;
     },
     makeUntrackedHangingPromise: function() {
         return makeUntrackedHangingPromise;
@@ -68,11 +86,21 @@ _export(exports, {
     trackFallbackParamsAccessed: function() {
         return trackFallbackParamsAccessed;
     },
-    trackRuntimeDataAccessed: function() {
-        return trackRuntimeDataAccessed;
+    trackIncompatibleShellContent: function() {
+        return trackIncompatibleShellContent;
+    },
+    trackPromiseUsed: function() {
+        return trackPromiseUsed;
+    },
+    trackURLDataAccessed: function() {
+        return trackURLDataAccessed;
     }
 });
+const _invarianterror = require("../shared/lib/invariant-error");
+const _promisewithresolvers = require("../shared/lib/promise-with-resolvers");
+const _ensurestatic = require("./app-render/segment-config/ensure-static");
 const _stagedrendering = require("./app-render/staged-rendering");
+const _workasyncstorageexternal = require("./app-render/work-async-storage.external");
 const _workunitasyncstorageexternal = require("./app-render/work-unit-async-storage.external");
 const _runtimereactsexternal = require("./runtime-reacts.external");
 function isHangingPromiseRejectionError(err) {
@@ -91,11 +119,6 @@ const CLIENT_HOOK_DYNAMIC = 'CLIENT_HOOK_DYNAMIC';
 class ClientHookDynamicError extends Error {
     constructor(route, expression){
         super(`Route "${route}": Next.js encountered URL data \`${expression}\` in a Client Component outside of \`<Suspense>\`.\n\n` + `This blocks prerendering because the value is only available at runtime.\n\n` + `Ways to fix this:\n` + `  - [stream] Wrap the component in \`<Suspense fallback={...}>\` so the hook value streams in after prerendering\n` + `  - [block] Set \`export const instant = false\` to allow a blocking route\n\n` + `Learn more: https://nextjs.org/docs/messages/blocking-prerender-client-hook`), this.digest = CLIENT_HOOK_DYNAMIC;
-        Object.defineProperty(this, "__NEXT_ERROR_CODE", {
-            value: "E1433",
-            enumerable: false,
-            configurable: true
-        });
     }
 }
 function isClientHookDynamicError(err) {
@@ -111,57 +134,154 @@ function makeDynamicHangingPromise(signal, route, expression) {
 function makeUntrackedHangingPromise(signal, route, expression) {
     return makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
 }
-function makeRuntimeHangingPromise(signal, route, expression, workUnitStore) {
-    if (workUnitStore !== null) {
-        trackRuntimeDataAccessed(workUnitStore);
+function makeSessionDataHangingPromise(signal, route, expression, workUnitStore) {
+    const promise = makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
+    return trackPromiseUsed(promise, trackSessionDataAccessed.bind(null, workUnitStore, expression));
+}
+function makeURLDataHangingPromise(signal, route, expression, workUnitStore) {
+    const promise = makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
+    if (workUnitStore === null) {
+        return promise;
     }
-    return makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
+    return trackPromiseUsed(promise, trackURLDataAccessed.bind(null, workUnitStore, expression));
+}
+function makeUnknownRuntimeDataHangingPromise(signal, route, expression, workUnitStore) {
+    // We don't know if this is session or URL data, i.e. if it should affect the shell
+    // or only the prefetch. Track it conservatively as affecting both.
+    return makeSessionDataHangingPromise(signal, route, expression, workUnitStore);
+}
+function makePrefetchHangingPromise(signal, route, expression) {
+    return makeUntrackedHangingPromise(signal, route, expression);
 }
 function makeFallbackParamsHangingPromise(signal, route, expression, workUnitStore) {
-    if (workUnitStore !== null) {
-        trackFallbackParamsAccessed(workUnitStore);
+    const promise = makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
+    if (workUnitStore === null) {
+        return promise;
     }
-    return makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
+    return trackPromiseUsed(promise, trackFallbackParamsAccessed.bind(null, workUnitStore, expression));
 }
-function makeStageHangingPromise(signal, route, expression, workUnitStore) {
-    trackRuntimeDataAccessed(workUnitStore);
-    return makeHangingPromiseWithError(signal, new HangingPromiseRejectionError(route, expression));
+function createPrerenderDataTracking() {
+    return {
+        runtimeDataAccessed: (0, _promisewithresolvers.createPromiseWithResolvers)(),
+        shouldAttemptStaticShell: true,
+        shouldAttemptStaticPrefetch: true
+    };
 }
-function trackRuntimeDataAccessed(workUnitStore) {
-    trackRuntimeDataAccessedImpl(workUnitStore, false);
+function finishPrerenderDataTracking(prerenderDataTracking) {
+    // If a runtime data access already resolved this promise, this is a no-op.
+    prerenderDataTracking.runtimeDataAccessed.resolve(false);
 }
-function trackFallbackParamsAccessed(workUnitStore) {
-    trackRuntimeDataAccessedImpl(workUnitStore, true);
+/**
+ * Records on a static prerender store that the render accessed a data source
+ * which would have resolved in a runtime shell (or runtime prefetch).
+ * No-op for all other store types.
+ *
+ * Prefer `makeRuntimeHangingPromise`. Use this function only when implementing
+ * similar tracking and that one is not enough.
+ */ function trackSessionDataAccessed(workUnitStore, expression) {
+    trackRuntimeDataAccessed(workUnitStore, 1, expression);
 }
-function trackRuntimeDataAccessedImpl(workUnitStore, isFallbackParamAccess) {
+function trackURLDataAccessed(workUnitStore, expression) {
+    trackRuntimeDataAccessed(workUnitStore, 2, expression);
+}
+function trackFallbackParamsAccessed(workUnitStore, expression) {
+    trackRuntimeDataAccessed(workUnitStore, 3, expression);
+}
+function trackRuntimeDataAccessed(workUnitStore, dataKind, expression) {
     switch(workUnitStore.type){
         case 'prerender':
             {
-                var // Response-level flag (the payload's `u`, forwarded to segment
-                // responses as `needsRuntimeRequest`): resolved for every kind of
-                // access — a pre-upgrade fallback response must keep reporting that
-                // a runtime request would return more. The fulfillment row lands at
-                // the current position in the Flight stream, which is what makes the
-                // value rewindable per stage. Promise resolution is idempotent, so
-                // repeated accesses are free.
-                _workUnitStore_runtimeDataAccessed;
-                (_workUnitStore_runtimeDataAccessed = workUnitStore.runtimeDataAccessed) == null ? void 0 : _workUnitStore_runtimeDataAccessed.resolve(true);
-                // Hint cell (holds the build-constant
-                // PrefetchHint.ShouldAttemptStaticPrefetch value directly): a
-                // fallback-param access is transient when the route is
-                // fallback-upgradeable — ISR later produces the concrete prerender a
-                // static prefetch attempt would hit — so it leaves the hint intact.
-                // (Until that upgrade, the response-level flag above keeps directing
-                // the client to a runtime fallback; the hint only costs a wasted
-                // static attempt in the interim.) Every other access clears it.
-                const hintCell = workUnitStore.shouldAttemptStaticPrefetch;
-                if (hintCell !== null && (!isFallbackParamAccess || !workUnitStore.isFallbackUpgradeable)) {
-                    hintCell.current = false;
+                const { prerenderDataTracking, stagedRendering } = workUnitStore;
+                if (!prerenderDataTracking || !stagedRendering) {
+                    return;
+                }
+                const { currentStage } = stagedRendering;
+                if (currentStage === _stagedrendering.RenderStage.Before) {
+                    console.error(new _invarianterror.InvariantError('Unexpected trackRuntimeDataAccessed in the Before stage.'));
+                    return;
+                }
+                if (currentStage >= _stagedrendering.RenderStage.NavigationStatic) {
+                    // Ignore any accesses that happen after `navigation()` resolves.
+                    // The purpose of this tracking is to judge whether a runtime prefetch
+                    // would give us a more complete result than a static one.
+                    // But `navigation()` wouldn't have resolved in a runtime prefetch,
+                    // so e.g. `await navigation(); await cookies()` wouldn't have more content
+                    // in those, and we shouldn't count it.
+                    return;
+                }
+                const ensureStaticLevel = workUnitStore.ensureStaticLevel ?? _ensurestatic.EnsureStaticLevel.None;
+                // NOTE: In general, we keep hints in sync with `needsRuntimeRequest`, but they
+                // don't have to always match. The client re-uses hints for the entire route,
+                // while `needsRuntimeRequest` can vary across individual prerendered param values
+                // (e.g. if cookies are accessed depending on a param value).
+                // Hints can also become outdated if a route only starts using runtime data
+                // after a revalidation, so we have to expect this and be resilient to it.
+                // Also see the upgradeable fallback params case below, which deliberately
+                // puts them out of sync.
+                switch(dataKind){
+                    case 1:
+                        {
+                            // Potentially deopt both the shell and the prefetch,
+                            // because if the shell accessed runtime data, so does the prefetch.
+                            // However, if we're already past the shell stage, the shell is not affected.
+                            // (which makes e.g. `await prefetch(); await cookies()` only affect the prefetch)
+                            let firstAffectedStage = null;
+                            if (currentStage <= _stagedrendering.RenderStage.ShellStatic && // Only track if we're not forcing the shell to be static.
+                            ensureStaticLevel < _ensurestatic.EnsureStaticLevel.Shell) {
+                                prerenderDataTracking.shouldAttemptStaticShell = false;
+                                firstAffectedStage ??= _stagedrendering.RenderStage.ShellStatic;
+                                logRuntimeDeopt == null ? void 0 : logRuntimeDeopt(expression, 'shell');
+                            }
+                            if (currentStage <= _stagedrendering.RenderStage.PrefetchStatic && // Only track if we're not forcing the prefetch to be static.
+                            ensureStaticLevel < _ensurestatic.EnsureStaticLevel.Prefetch) {
+                                prerenderDataTracking.shouldAttemptStaticPrefetch = false;
+                                // NOTE: if the shell is affected, don't override it.
+                                firstAffectedStage ??= _stagedrendering.RenderStage.PrefetchStatic;
+                                logRuntimeDeopt == null ? void 0 : logRuntimeDeopt(expression, 'prefetch');
+                            }
+                            if (firstAffectedStage !== null) {
+                                markRuntimeDataAccessWhenStageReached(prerenderDataTracking, stagedRendering, firstAffectedStage);
+                            }
+                            break;
+                        }
+                    case 3:
+                        {
+                            if (workUnitStore.isFallbackUpgradeable) {
+                                // An fallback-param access is transient when the route is
+                                // fallback-upgradeable (i.e. ISR later produces the concrete prerender a
+                                // static prefetch would hit) so it does not indicate the need for a runtime
+                                // request and thus does not affect the static hints.
+                                //
+                                // If runtime prefetches are not disallowed by `ensureStatic`, then we still
+                                // set `runtimeDataAccessed` (while keeping the hints static). This means that
+                                // if the concrete prerender isn't ready yet and we served the fallback, then
+                                // the client knows it can use a *runtime* prefetch for speculative links --
+                                // a runtime prefetch can provide the same content (or more) as the concrete
+                                // prerender would.
+                                if (ensureStaticLevel < _ensurestatic.EnsureStaticLevel.Prefetch) {
+                                    markRuntimeDataAccessWhenStageReached(prerenderDataTracking, stagedRendering, // `params` are URL data, so they only affect the prefetch
+                                    _stagedrendering.RenderStage.PrefetchStatic);
+                                    logRuntimeUpgradeableFallback == null ? void 0 : logRuntimeUpgradeableFallback();
+                                }
+                                break;
+                            }
+                        // not an upgradeable fallback param access, so we treat it as URL data.
+                        // intentional fallthrough
+                        }
+                    case 2:
+                        {
+                            // Only deopt the prefetch, not the shell, which cannot access URL data anyway.
+                            if (currentStage <= _stagedrendering.RenderStage.PrefetchStatic && ensureStaticLevel < _ensurestatic.EnsureStaticLevel.Prefetch) {
+                                prerenderDataTracking.shouldAttemptStaticPrefetch = false;
+                                logRuntimeDeopt == null ? void 0 : logRuntimeDeopt(expression, 'prefetch');
+                                markRuntimeDataAccessWhenStageReached(prerenderDataTracking, stagedRendering, _stagedrendering.RenderStage.PrefetchStatic);
+                            }
+                            break;
+                        }
                 }
                 break;
             }
         case 'prerender-client':
-        case 'prerender-ppr':
         case 'prerender-legacy':
         case 'prerender-runtime':
         case 'validation-client':
@@ -169,12 +289,68 @@ function trackRuntimeDataAccessedImpl(workUnitStore, isFallbackParamAccess) {
         case 'cache':
         case 'private-cache':
         case 'unstable-cache':
-        case 'generate-static-params':
+        case 'build-time-generator':
             break;
         default:
             workUnitStore;
     }
 }
+/**
+ * Tracks a runtime data access on the `runtimeDataAccessed` promise,
+ * but with a delay until `targetStage`.
+ *
+ * When we encounter a URL data access like `await params`, we need to mark the
+ * *prefetch* as needing runtime data, but the *shell* should remain unaffected
+ * (because it cannot access params anyway).
+ *
+ * However, the shell and the prefetch share one `runtimeDataAccessed` promise,
+ * and it needs to be accurately rewindable by the client
+ * In other words, we need to make sure that it reads as `false` when rewound
+ * to a shell, but as `true` in the final response (the prefetch).
+ *
+ * This means that if the `await params` is encountered during the shell stage, we
+ * cannot resolve `runtimeDataAccessed` immediately.
+ * Instead, we delay the resolution until the PrefetchStatic stage, so the promise
+ * will remain unresolved when rewound to the shell stage (which reads as `false`).
+ */ function markRuntimeDataAccessWhenStageReached(prerenderDataTracking, stageController, targetStage) {
+    const { runtimeDataAccessed } = prerenderDataTracking;
+    // NOTE: If we're already in or past the target stage, we can avoid allocating a closure,
+    // because `onStage` would've executed the callback immediately anyway.
+    if (stageController.currentStage >= targetStage) {
+        runtimeDataAccessed.resolve(true);
+    } else {
+        stageController.onStage(targetStage, runtimeDataAccessed.resolve.bind(null, true));
+    }
+}
+const logRuntimeDeopt = process.env.NEXT_PRIVATE_DEBUG_RUNTIME_DATA ? (expression, kind)=>{
+    const { route } = _workasyncstorageexternal.workAsyncStorage.getStore();
+    console.log(`Route '${route}': deopting to a runtime ${kind} because it used ${expression}`);
+} : undefined;
+const logRuntimeUpgradeableFallback = process.env.NEXT_PRIVATE_DEBUG_RUNTIME_DATA ? ()=>{
+    const { route } = _workasyncstorageexternal.workAsyncStorage.getStore();
+    console.log(`Route '${route}': marking upgradeable fallback as runtime prefetchable`);
+} : undefined;
+function trackIncompatibleShellContent(workUnitStore, reason) {
+    const { stagedRendering } = workUnitStore;
+    if (!stagedRendering) {
+        return;
+    }
+    // TODO(app-shells): optimize this to only consider stages that are relevant for validation.
+    // We should only track incompatible content when it can affect them.
+    // For now, we simply exclude everything that happens in the dynamic stage.
+    // (Note that we also need to account for cache misses that move things to a
+    // different stage -- those should also preemptively set `hasIncompatibleShellContent`
+    // because there's a chance that a render with warm caches would set it)
+    const { currentStage } = stagedRendering;
+    if (currentStage === _stagedrendering.RenderStage.Dynamic || currentStage === _stagedrendering.RenderStage.Abandoned) {
+        return;
+    }
+    if (process.env.NEXT_PRIVATE_DEBUG_VALIDATION) {
+        const workStore = _workasyncstorageexternal.workAsyncStorage.getStore();
+        console.log(`Route ${workStore.route}: Incompatible shell content: ${reason}`);
+    }
+    workUnitStore.hasIncompatibleShellContent = true;
+}
 function makeClientHookHangingPromise(signal, error) {
     return makeHangingPromiseWithError(signal, error);
 }
@@ -228,10 +404,78 @@ function makeDevtoolsIOAwarePromise(underlying, requestStore, stage) {
         }, 0);
     });
 }
+function trackPromiseUsed(promise, onUse) {
+    // We can instrument `.then()/.catch()/.finally()` in one go by using a Promise subclass
+    // that implements a custom `.then()`, because `catch` and `finally` delegate to it.
+    //
+    // Alternative implementation ideas that were tried and rejected:
+    //
+    // 1. Patching the methods directly via `promise.then = (..args) => { ... }`:
+    //   doesn't work, because Node does not call the monkeypatched methods for native `await`:
+    //   > Native Promise [...]: The promise is directly used and awaited natively, without calling `then()`.
+    //   > https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#description
+    //
+    // 2. Wrapping in a proxy that returns a custom `then/catch/finally`:
+    //   breaks async stacks in React's IO tracking (stack becomes `Promise.then`)
+    return TrackedPromise.from(promise, onUse);
+}
+class TrackedPromise extends Promise {
+    #onUse;
+    // We don't need derived promises to also be a TrackedPromise.
+    // We only care about the first level of `.then()`.
+    static get [Symbol.species]() {
+        return Promise;
+    }
+    static from(promise, onUse) {
+        // Whenever the promise we're tracking resolves/rejects, we should follow.
+        const tracked = new TrackedPromise(promise.then.bind(promise));
+        tracked.#onUse = onUse;
+        // Hanging promises catch rejections when created. Tracked promises are generally derived
+        // from promises that may hang & reject, so we need to do the same.
+        // However, we have to bypass the tracking we do in `TrackedPromise.then`.
+        // (we're using `then` directly, because `catch` ends up delegating `TrackedPromise.then`)
+        Promise.prototype.then.call(tracked, undefined, ignoreReject);
+        return tracked;
+    }
+    then(onFulfilled, onRejected) {
+        const onUse = this.#onUse;
+        if (onUse) {
+            try {
+                onUse();
+            } catch (err) {
+                // We don't want to break the method even if our tracking errored.
+                console.error(err);
+            }
+        }
+        return Promise.prototype.then.call(this, onFulfilled, onRejected);
+    }
+    constructor(...args){
+        super(...args), this.#onUse = null;
+    }
+}
 const RENDER_STAGES_BY_DATA_KIND = {
     sessionData: _stagedrendering.RenderStage.ShellRuntime,
-    staticLinkData: _stagedrendering.RenderStage.Static,
-    runtimeLinkData: _stagedrendering.RenderStage.Runtime
+    /**
+   * Statically-prerenderable URL data, like static `params`.
+   * It may need to be pushed to a runtime stage in a runtime prerender,
+   * but it's semantically distinct from `runtimeUrlData` like `searchParams`,
+   * which is always excluded from static prerenders.
+   * */ staticUrlData: {
+        /**
+     * From that app's point of view, `prefetch()` is semantically the same as
+     * `staticUrlData`, because it does not resolve in a shell but resolves in
+     * a prefetch (even a static one).
+     * We handle it separately to provide a specialized error in validation renders.
+     */ prefetchApi: {
+            static: _stagedrendering.RenderStage.PrefetchStatic_prefetchApi,
+            runtime: _stagedrendering.RenderStage.PrefetchRuntime_prefetchApi
+        },
+        static: _stagedrendering.RenderStage.PrefetchStatic,
+        runtime: _stagedrendering.RenderStage.PrefetchRuntime
+    },
+    /**
+   * URL data that is never statically-prerenderable, like static `searchParams`.
+   * */ runtimeUrlData: _stagedrendering.RenderStage.PrefetchRuntime
 };
 function applyOwnerStack(error) {
     if (process.env.NODE_ENV !== 'production') {
@@ -252,12 +496,11 @@ function applyOwnerStack(error) {
             case 'unstable-cache':
             case 'request':
             case 'prerender':
-            case 'prerender-ppr':
             case 'prerender-legacy':
             case 'prerender-runtime':
             case 'prerender-client':
             case 'validation-client':
-            case 'generate-static-params':
+            case 'build-time-generator':
             case undefined:
                 ownerStack = innerOwnerStack;
                 break;