@uniformdev/next-app-router-upgrade 0.1.0 → 0.2.0

package/src/scan.js

@@ -2,6 +2,7 @@ import fs from "node:fs";
 import path from "node:path";
 import ts from "typescript";
 
+import { COMPOSITION_METADATA, findClientContextIssues, STABLE_CONTEXT_OPTIONS } from "./client-context.js";
 import {
   REMOVED_CONFIG_KEYS,
   REMOVED_EXPORTS,
@@ -16,6 +17,7 @@ const SDK = "@uniformdev/next-app-router";
 const RESOLVERS = new Set(["resolveRouteFromCode", "resolvePlaygroundRoute"]);
 const LITE_MIDDLEWARE = new Set(["uniformMiddleware", "handleUniformRoute"]);
 const MIN_NEXT = [16, 0, 7];
+const STABLE = "The stable SDK (20.82 to 20.85)";
 
 /**
  * Scans the project at `root` and returns { project, findings }.
@@ -34,6 +36,7 @@ export function scanProject(root, { uniformDataDir, contents } = {}) {
     name: pkg?.name,
     sdkVersion: deps[SDK],
     usesV1: Boolean(deps["@uniformdev/canvas-next-rsc"]),
+    usesAkamaiWorker: false,
     filesScanned: 0,
     compositionsWithPersonalization: 0,
   };
@@ -46,12 +49,21 @@ export function scanProject(root, { uniformDataDir, contents } = {}) {
   for (const file of files) {
     scanSourceFile(root, file, add, state, read);
   }
+  project.usesAkamaiWorker = Boolean(state.usesAkamaiWorker);
+
+  if (state.processPlaygroundPath && !state.middlewarePassesPlaygroundPath) {
+    add("playground-path", {
+      ...state.processPlaygroundPath,
+      message: "createPreviewGETRouteHandler gets processPlaygroundPath. The middleware of the developer preview accepts the same option, so that it finds the playground path for the locale.",
+      fix: "Give the same processPlaygroundPath function to the middleware.",
+    });
+  }
 
   if (state.importsVercelFunctions.length && !deps["@vercel/functions"]) {
     for (const where of state.importsVercelFunctions) {
       add("vercel-functions-transitive", {
         ...where,
-        message: "The app imports @vercel/functions, but package.json does not list it. Version 20.82 installed it as a dependency of the SDK. The developer preview makes it an optional peer dependency.",
+        message: `The app imports @vercel/functions, but package.json does not list it. ${STABLE} installs it as a dependency of the SDK. The developer preview makes it an optional peer dependency.`,
         fix: "Add @vercel/functions to the dependencies in package.json.",
       });
     }
@@ -65,16 +77,16 @@ export function scanProject(root, { uniformDataDir, contents } = {}) {
     add("lite-mode-flicker", {
       ...state.liteMiddlewareLocation,
       message:
-        "Version 20.82 chose personalization and test variants in the middleware. With uniformMiddleware or handleUniformRoute, the developer preview renders the default variants on the server, and the browser changes them after hydration." +
+        `${STABLE} chooses personalization and test variants in the middleware. With uniformMiddleware or handleUniformRoute, the developer preview renders the default variants on the server, and the browser changes them after hydration.` +
         (count ? ` The uniform-data folder has ${count} composition(s) with a personalization or a test.` : ""),
-      fix: "No code change is required. To keep the first paint correct, change to vercelUniformEdgeMiddleware (edge mode).",
+      fix: "No code change is required. To keep the first paint correct, turn on edge mode: migrate --edge <host>.",
     });
   }
 
   if (project.sdkVersion) {
     add("not-found-html", {
       message:
-        "Version 20.82 rewrote missing routes to /404 in the middleware. The developer preview calls notFound() while the page renders. The response is still 404, but Next.js sends an empty HTML shell, and the 404 content (also app/not-found.tsx) shows only after hydration. Tested with Next.js 16.2.10 and 16.4.0.",
+        `${STABLE} rewrites missing routes to /404 in the middleware. The developer preview calls notFound() while the page renders. The response is still 404, but Next.js sends an empty HTML shell, and the 404 content (also app/not-found.tsx) shows only after hydration. Tested with Next.js 16.2.10 and 16.4.0.`,
       fix: "No code change is required. Visitors without JavaScript see an empty 404 page.",
     });
     add("redirect-status", {
@@ -143,7 +155,7 @@ function checkPackageJson(pkg, deps, add) {
   if (deps["@uniformdev/context-edge"]) {
     add("context-edge-dependency", {
       ...where,
-      message: "The edge and vercel entry points of @uniformdev/next-app-router contain @uniformdev/context-edge.",
+      message: "The edge, vercel, cf-vinext and akamai entry points of @uniformdev/next-app-router contain @uniformdev/context-edge.",
       fix: "You can remove @uniformdev/context-edge from package.json, if the app does not import it.",
     });
   }
@@ -201,6 +213,7 @@ function scanSourceFile(root, file, add, state, read) {
     }
     if (!module.startsWith(SDK)) continue;
     importsSdk = true;
+    if (module === `${SDK}/akamai`) state.usesAkamaiWorker = true;
 
     if (module === `${SDK}/cache`) {
       add("cached-resolver", {
@@ -224,6 +237,9 @@ function scanSourceFile(root, file, add, state, read) {
   }
 
   if (isConfigFile) importsSdk = true;
+  if (isMiddlewareFile && text.includes("processPlaygroundPath")) state.middlewarePassesPlaygroundPath = true;
+
+  scanClientContext(sf, sdkLocals, add, at);
 
   const resultVariables = new Set();
 
@@ -243,6 +259,13 @@ function scanSourceFile(root, file, add, state, read) {
       if (name && REMOVED_CONFIG_KEYS[name] && (isConfigFile || isServerConfigContext(node))) {
         add("removed-config-key", { ...at(node), message: `The server configuration option "${name}" is removed.`, fix: REMOVED_CONFIG_KEYS[name] });
       }
+      if (name && STABLE_CONTEXT_OPTIONS[name] && (isConfigFile || isServerConfigContext(node))) {
+        add("context-storage-options", {
+          ...at(node),
+          message: `The server configuration option "context.${name}" came in 20.85.0. The developer preview does not have it.`,
+          fix: `Remove it. ${STABLE_CONTEXT_OPTIONS[name]}`,
+        });
+      }
       if (name === "defaultConsent" && isMiddlewareFile && !isBooleanLiteral(node)) {
         add("per-request-consent", {
           ...at(node),
@@ -252,6 +275,30 @@ function scanSourceFile(root, file, add, state, read) {
       }
     }
 
+    // createPreviewGETRouteHandler({ processPlaygroundPath })
+    if (ts.isCallExpression(node) && ts.isIdentifier(node.expression) && sdkLocals.get(node.expression.text)?.imported === "createPreviewGETRouteHandler") {
+      const options = node.arguments[0];
+      const option = options && ts.isObjectLiteralExpression(options) && options.properties.find((p) => p.name && propertyName(p.name) === "processPlaygroundPath");
+      if (option) state.processPlaygroundPath ??= at(option);
+    }
+
+    // <UniformContext result={result}>...</UniformContext>, the API of 20.81.1-alpha.25.
+    if (ts.isJsxElement(node) || ts.isJsxSelfClosingElement(node)) {
+      const opening = ts.isJsxElement(node) ? node.openingElement : node;
+      const local = ts.isIdentifier(opening.tagName) ? sdkLocals.get(opening.tagName.text) : undefined;
+      if (local?.imported === "UniformContext" && local.module.startsWith(SDK)) {
+        const hasResult = opening.attributes.properties.some((p) => ts.isJsxAttribute(p) && p.name.getText(sf) === "result");
+        const hasChildren = ts.isJsxElement(node) && node.children.some((child) => !(ts.isJsxText(child) && child.containsOnlyTriviaWhiteSpaces));
+        if (hasResult || hasChildren) {
+          add("uniform-context-props", {
+            ...at(node),
+            message: "UniformContext no longer takes result or children. Render it once after the compositions of the page, or in the root layout. The primary composition sets the composition metadata and the default consent.",
+            fix: "Render the compositions, then <UniformContext />. Add pageComposition to the UniformResolvedComposition of the page.",
+          });
+        }
+      }
+    }
+
     // <UniformComposition dataClient={...} />
     if (ts.isJsxAttribute(node) && importsSdk) {
       const name = node.name.getText(sf);
@@ -331,6 +378,39 @@ function scanSourceFile(root, file, add, state, read) {
   visit(sf);
 }
 
+function scanClientContext(sf, sdkLocals, add, at) {
+  const { hookArguments, props, options } = findClientContextIssues(sf, sdkLocals);
+  for (const { argument } of hookArguments) {
+    add("context-composition-metadata", {
+      ...at(argument),
+      message: "useInitUniformContext takes only the callback now. The SDK sends the composition metadata of the page composition to the Context.",
+      fix: "Remove the second argument of useInitUniformContext.",
+    });
+  }
+  for (const { element, name } of props) {
+    if (name === COMPOSITION_METADATA) {
+      add("context-composition-metadata", {
+        ...at(element),
+        message: "ClientContextComponentProps no longer has compositionMetadata.",
+        fix: "Remove the prop. Do not give it to useInitUniformContext.",
+      });
+    } else {
+      add("context-storage-options", {
+        ...at(element),
+        message: `ClientContextComponentProps has no "${name}" in the developer preview. It came in 20.85.0.`,
+        fix: `Remove the prop. ${STABLE_CONTEXT_OPTIONS[name]}`,
+      });
+    }
+  }
+  for (const { property, name } of options) {
+    add("context-storage-options", {
+      ...at(property),
+      message: `createClientUniformContext has no "${name}" option in the developer preview. It came in 20.85.0.`,
+      fix: `Remove the option. ${STABLE_CONTEXT_OPTIONS[name]}`,
+    });
+  }
+}
+
 function checkImportedName(module, imported, node, add, at) {
   const removed = REMOVED_EXPORTS[module]?.[imported];
   if (removed) {
@@ -436,7 +516,7 @@ function scanNotFoundRoutes(root, files, add) {
   for (const file of notFoundRoutes) {
     add("not-found-page", {
       file: path.relative(root, file),
-      message: "Version 20.82 rewrote missing routes to /404. The developer preview calls notFound() on the page, so this route no longer renders for missing pages.",
+      message: `${STABLE} rewrites missing routes to /404. The developer preview calls notFound() on the page, so this route no longer renders for missing pages.`,
       fix: "Move the 404 content to app/not-found.tsx.",
     });
   }

package/src/session.js

@@ -129,7 +129,11 @@ export async function executeMigration({ root, edge, dryRun, yes, allowDirty, co
     "Install the new versions: npm install (or pnpm install, or yarn).",
     ...(manual.length + steps.length ? [`Do the ${manual.length + steps.length} manual change(s) above.`] : []),
     `Run the check again: ${NAME} check`,
-    edge ? "Build and start the app, and do the edge mode test of the docs: next build && next start" : "Build and test the app: next build",
+    edge === "vercel"
+      ? "Build and start the app, and do the edge mode test of the docs: next build && next start"
+      : edge
+        ? `Build and deploy the app${edge === "akamai" ? " and the EdgeWorker" : ""}, and do the edge mode test of the docs.`
+        : "Build and test the app: next build",
     "Read the changes: git diff",
   ];
   next.forEach((step, i) => console.log(`  ${i + 1}. ${step}`));
@@ -189,6 +193,14 @@ export function projectStatus(root, { uniformData } = {}) {
     sdkVersion: deps["@uniformdev/next-app-router"],
     atTarget: deps["@uniformdev/next-app-router"] === TARGET_VERSION,
     phase1Pending: phase1.changes.length,
-    edgeMode: /vercelUniformEdgeMiddleware/.test(middleware) ? "vercel" : /uniformEdgeMiddleware|handleUniformEdgeRoute/.test(middleware) ? "custom" : undefined,
+    edgeMode: /vercelUniformEdgeMiddleware/.test(middleware)
+      ? "vercel"
+      : /cfVinextUniformEdgeMiddleware/.test(middleware)
+        ? "cloudflare"
+        : scan.project.usesAkamaiWorker
+          ? "akamai"
+          : /uniformEdgeMiddleware|handleUniformEdgeRoute/.test(middleware)
+            ? "custom"
+            : undefined,
   };
 }