@uniformdev/next-app-router-upgrade 0.0.0-stage → 0.2.0

package/src/report.js

@@ -0,0 +1,44 @@
+const ORDER = { error: 0, warning: 1, info: 2 };
+const LABEL = { error: "CODE CHANGE NEEDED", warning: "REVIEW", info: "NOTE" };
+
+export const TARGET_VERSION = "20.81.1-alpha.41.sha-adcf82dedd";
+
+export function verdict(findings, { strict = false } = {}) {
+  const errors = findings.filter((f) => f.severity === "error").length;
+  const warnings = findings.filter((f) => f.severity === "warning").length;
+  if (errors || (strict && warnings)) return { safe: false, label: "CODE CHANGES NEEDED", errors, warnings };
+  return { safe: true, label: warnings ? "SAFE TO INSTALL (review the behavior changes)" : "SAFE TO INSTALL", errors, warnings };
+}
+
+export function formatText({ project, findings }, result, { color = true } = {}) {
+  const c = (code, s) => (color ? `\u001b[${code}m${s}\u001b[0m` : s);
+  const sev = { error: (s) => c("31;1", s), warning: (s) => c("33;1", s), info: (s) => c("36", s) };
+  const lines = [];
+
+  lines.push(c("1", "Uniform Next.js App Router SDK upgrade check"));
+  lines.push(`Target version: ${TARGET_VERSION}`);
+  lines.push(`Project: ${project.name ?? "(no name)"} at ${project.root}`);
+  lines.push(`Installed @uniformdev/next-app-router: ${project.sdkVersion ?? "not found"}`);
+  lines.push(`Files scanned: ${project.filesScanned}`);
+  lines.push("");
+
+  const sorted = [...findings].sort((a, b) => ORDER[a.severity] - ORDER[b.severity] || (a.file ?? "").localeCompare(b.file ?? "") || (a.line ?? 0) - (b.line ?? 0));
+  let current;
+  for (const f of sorted) {
+    if (f.severity !== current) {
+      current = f.severity;
+      lines.push(sev[current](`${LABEL[current]}`));
+    }
+    const where = f.file ? `${f.file}${f.line ? `:${f.line}` : ""}` : "";
+    lines.push(`  ${sev[f.severity]("•")} ${f.title}${where ? c("2", `  (${where})`) : ""}`);
+    lines.push(`    ${f.message}`);
+    lines.push(`    Fix: ${f.fix}`);
+    lines.push(c("2", `    Docs: ${f.docs}`));
+  }
+  if (!findings.length) lines.push("No findings.");
+
+  lines.push("");
+  lines.push(`Errors: ${result.errors}   Warnings: ${result.warnings}   Notes: ${findings.length - result.errors - result.warnings}`);
+  lines.push(c(result.safe ? "32;1" : "31;1", `Verdict: ${result.label}`));
+  return lines.join("\n");
+}

package/src/rules.js

@@ -0,0 +1,176 @@
+// Each rule describes one change between the stable @uniformdev/next-app-router (20.82 to 20.85)
+// and the developer preview (20.81.1-alpha.41). "error" rules fail to compile or break at
+// runtime. "warning" rules change behavior. "info" rules need no change.
+
+const DOCS = "https://docs.uniform.app/docs/sdk/nextjs-app-router";
+const UPGRADE = `${DOCS}/upgrade-to-developer-preview`;
+
+export const REMOVED_EXPORTS = {
+  "@uniformdev/next-app-router": {
+    DataClient: "Resolve the composition on the page and change it before render.",
+    DefaultDataClient: "Resolve the composition on the page and change it before render.",
+    EnhanceRouteOptions: "Resolve the composition on the page and change it before render.",
+    GetRouteOptions: "No replacement.",
+    GetRouteFromMiddlewareOptions: "No replacement.",
+    GetRouteFromPageStateOptions: "No replacement.",
+    RewriteRouteOptions: "No replacement.",
+    RewriteRouteResult: "No replacement.",
+    expireMiddlewareCacheTag: "Use the onRevalidateTags option of createPreviewPOSTRouteHandler.",
+    precomputeComposition: "Use edge mode: the edge chooses the variants of each visitor.",
+  },
+  "@uniformdev/next-app-router-shared": {
+    getRuleId: "No replacement.",
+    resolveComponentFromPageState: "No replacement.",
+    resolveRuleFromPageState: "No replacement.",
+    PageStateComponent: "No replacement.",
+    PageStateComponentFields: "No replacement.",
+  },
+  "@uniformdev/next-app-router-client": {
+    ClientContextTestTransfer: "No replacement.",
+  },
+};
+
+export const REMOVED_OPTIONS = {
+  dataClient: "Remove it. Resolve the composition on the page and change it before render.",
+  pathPatternsWithVariations: "Remove it. The middleware no longer evaluates variants.",
+};
+
+export const REMOVED_CONFIG_KEYS = {
+  middlewareRuntimeCache: "Remove it. The middleware makes no API calls.",
+  disableSwrMiddlewareCache: "Remove experimental.disableSwrMiddlewareCache. The middleware makes no API calls.",
+};
+
+export const REMOVED_PAGE_STATE_FIELDS = ["components", "rules", "quirks", "isPrefetch", "requestPath"];
+
+export const RULES = {
+  "removed-export": {
+    severity: "error",
+    title: "Import of an API that the developer preview removes",
+    docs: `${UPGRADE}#step-5-replace-the-removed-apis`,
+  },
+  "removed-option": {
+    severity: "error",
+    title: "Option or prop that the developer preview removes",
+    docs: `${UPGRADE}#step-2-remove-the-removed-middleware-options`,
+  },
+  "removed-config-key": {
+    severity: "error",
+    title: "Server configuration option that the developer preview removes",
+    docs: `${UPGRADE}#step-4-clean-up-the-server-configuration`,
+  },
+  "removed-page-state-field": {
+    severity: "error",
+    title: "Page state field that the developer preview removes",
+    docs: `${UPGRADE}#step-5-replace-the-removed-apis`,
+  },
+  "result-code": {
+    severity: "error",
+    title: "Use of result.code from a route resolver",
+    docs: `${UPGRADE}#step-5-replace-the-removed-apis`,
+  },
+  "old-page-code": {
+    severity: "error",
+    title: "Hard-coded page code in the old format (2~)",
+    docs: `${UPGRADE}#behavior-changes`,
+  },
+  "next-version": {
+    severity: "error",
+    title: "Next.js version is lower than 16.0.7",
+    docs: `${DOCS}#prerequisites`,
+  },
+  "context-composition-metadata": {
+    severity: "error",
+    title: "compositionMetadata in a custom client context component",
+    docs: `${DOCS}/client-context`,
+  },
+  "context-storage-options": {
+    severity: "error",
+    title: "Visitor data option of 20.85 that the developer preview does not have",
+    docs: `${DOCS}/client-context`,
+  },
+  "uniform-context-props": {
+    severity: "error",
+    title: "UniformContext with result or children (changed after alpha.25)",
+    docs: `${DOCS}/client-context`,
+  },
+  "vercel-functions-transitive": {
+    severity: "error",
+    title: "@vercel/functions is imported but not a dependency",
+    docs: `${UPGRADE}#step-7-install-the-vercel-functions-package`,
+  },
+  "route-union": {
+    severity: "warning",
+    title: "Direct access to route.compositionApiResponse",
+    docs: `${DOCS}/resolving-compositions#the-result`,
+  },
+  "placement-props": {
+    severity: "warning",
+    title: "Use of PersonalizeProps or TestProps",
+    docs: `${UPGRADE}#behavior-changes`,
+  },
+  "lite-mode-flicker": {
+    severity: "warning",
+    title: "Personalizations and tests change from middleware evaluation to the browser (lite mode)",
+    docs: `${DOCS}/edge-personalization`,
+  },
+  "project-map-query-strings": {
+    severity: "warning",
+    title: "Project map nodes with query strings",
+    docs: `${DOCS}/middleware#keep-query-strings-in-the-route`,
+  },
+  "visibility-rules": {
+    severity: "warning",
+    title: "Components with visibility rules are not in the server HTML",
+    docs: `${DOCS}/personalization#visibility-rules`,
+  },
+  "not-found-page": {
+    severity: "warning",
+    title: "Missing routes no longer rewrite to /404",
+    docs: `${DOCS}/recipes/not-found`,
+  },
+  "not-found-html": {
+    severity: "warning",
+    title: "The HTML of the 404 page is empty until hydration",
+    docs: `${DOCS}/recipes/not-found`,
+  },
+  "per-request-consent": {
+    severity: "warning",
+    title: "defaultConsent is set for each request in the middleware",
+    docs: `${DOCS}/incremental-static-regeneration-isr#consent-and-edge-mode-values`,
+  },
+  "uniform-version-mismatch": {
+    severity: "warning",
+    title: "@uniformdev packages have different versions",
+    docs: `${UPGRADE}#step-1-install-the-packages`,
+  },
+  "prerelease-peer-range": {
+    severity: "warning",
+    title: "A package has a peer range that does not accept prerelease versions",
+    docs: `${UPGRADE}#step-1-install-the-packages`,
+  },
+  "cached-resolver": {
+    severity: "info",
+    title: "The 'use cache' resolver now caches only published content",
+    docs: `${DOCS}/caching#cache-components`,
+  },
+  "static-params": {
+    severity: "info",
+    title: "createUniformStaticParams makes one code for each path",
+    docs: `${DOCS}/incremental-static-regeneration-isr`,
+  },
+  "context-edge-dependency": {
+    severity: "info",
+    title: "@uniformdev/context-edge is no longer necessary",
+    docs: `${UPGRADE}#step-1-install-the-packages`,
+  },
+  "playground-path": {
+    severity: "info",
+    title: "The middleware accepts processPlaygroundPath",
+    docs: `${DOCS}/preview`,
+  },
+  "redirect-status": {
+    severity: "info",
+    title: "Uniform redirects now come from the page (308 or 307)",
+    docs: `${UPGRADE}#behavior-changes`,
+  },
+};