@assembly-js/app-foundation 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -19,6 +19,9 @@ A patch release never changes what an app's build requires; a minor release may
 not by hand; see `changes/README.md`. CI fails a PR that changes a check script without a
 `bump: minor` change file.
 
+## 0.12.0
+- [behavior] `check:crons` on a platform update turn now only warns about a cron route the app already had without a schedule; a route added this turn, or one that lost its schedule, still fails.
+
 ## 0.11.0
 - [behavior] `check:record-urls` now checks each surface on its own: a record opened on the client portal needs its own `/c` route or `useUrlState`, and an internal dynamic route no longer exempts it. It also catches a list/detail view switch held in `useState`, so a client's request page keeps its own URL that can be reloaded or shared.
 - [guidance] `assembly-app-inner-location` says the record URL rule applies to the client portal too, with `app/c/[id]/page.tsx` or `?id=` through `useUrlState` as the two valid shapes.

package/bin/check-crons.mjs

@@ -16,7 +16,8 @@
 // as warnings: those paths have no agent who can act on a failure, so failing
 // them would only strand an app that already worked. A below-floor schedule
 // the app shipped before the turn stays a warning even then (see
-// baselineCronSchedules).
+// baselineCronSchedules), as does a cron route the app shipped with no schedule
+// at all (see baselineUnscheduledRoutes).
 import { readFileSync, readdirSync, existsSync } from 'node:fs';
 import { spawnSync } from 'node:child_process';
 import { join, relative, sep } from 'node:path';
@@ -42,7 +43,8 @@ const TURN_BASELINE_ENV = 'ASSEMBLY_TURN_BASELINE_SHA';
 // Set by the turn program on a platform update turn, where the update itself is
 // the mandate to fix whatever is wrong, so findings fail the build whether or
 // not the turn touched the cron wiring.
-const STRICT = process.argv.includes('--strict') || process.env.ASSEMBLY_UPDATE_TURN === '1';
+const UPDATE_TURN = process.env.ASSEMBLY_UPDATE_TURN === '1';
+const STRICT = process.argv.includes('--strict') || UPDATE_TURN;
 const CRON_WIRING_PATHS = ['vercel.json', 'app/api/cron/'];
 
 function report(lines, { fatal }) {
@@ -92,6 +94,44 @@ function baselineCronSchedules() {
   return schedules;
 }
 
+// Cron route files (repo-relative, posix) that existed at the turn baseline with
+// no vercel.json entry invoking them. An update turn has no mandate to schedule
+// work the app never ran, so these only warn. An unreadable baseline yields an
+// empty set, which keeps every unscheduled route fatal.
+function baselineUnscheduledRoutes() {
+  const baseline = (process.env[TURN_BASELINE_ENV] ?? '').trim();
+  const unscheduled = new Set();
+  if (!baseline || !UPDATE_TURN) return unscheduled;
+  const listing = spawnSync('git', ['ls-tree', '-r', '--name-only', baseline, '--', 'app'], {
+    cwd: ROOT,
+    encoding: 'utf8',
+  });
+  if (listing.status !== 0) return unscheduled;
+  // Route groups can hold cron routes too, so list all of app/ and filter by the URL served.
+  const routePaths = listing.stdout
+    .split('\n')
+    .filter((p) => ROUTE_FILE.test(p.split('/').pop()))
+    .filter((p) => ('/' + urlSegments(p.split('/').slice(1)).join('/') + '/').startsWith(CRON_ROUTE_PREFIX));
+  const shown = spawnSync('git', ['show', `${baseline}:vercel.json`], { cwd: ROOT, encoding: 'utf8' });
+  let baselineCrons = [];
+  if (shown.status === 0) {
+    try {
+      const parsed = JSON.parse(shown.stdout).crons;
+      if (Array.isArray(parsed)) baselineCrons = parsed;
+    } catch {
+      // An unparseable baseline file scheduled nothing.
+    }
+  }
+  const scheduledPaths = baselineCrons
+    .filter((c) => typeof c?.path === 'string')
+    .map((c) => c.path.replace(/\/+$/, '').split('/').filter(Boolean));
+  for (const path of routePaths) {
+    const segments = urlSegments(path.split('/').slice(1));
+    if (!scheduledPaths.some((pathSegments) => routeServes(segments, pathSegments))) unscheduled.add(path);
+  }
+  return unscheduled;
+}
+
 function cronKey(entry) {
   return `${entry?.path}\n${typeof entry?.schedule === 'string' ? entry.schedule.trim() : ''}`;
 }
@@ -146,8 +186,11 @@ function routeFiles(dir) {
 // The URL segments a route file serves; route groups `(group)` and parallel
 // slots `@slot` never appear in the URL.
 function urlSegmentsForRouteFile(file) {
-  return relative(APP_DIR, file)
-    .split(sep)
+  return urlSegments(relative(APP_DIR, file).split(sep));
+}
+
+function urlSegments(pathParts) {
+  return pathParts
     .slice(0, -1)
     .filter((seg) => !(seg.startsWith('(') && seg.endsWith(')')) && !seg.startsWith('@'));
 }
@@ -259,6 +302,7 @@ const entries = Array.isArray(crons) ? crons : [];
 const coveredRoutes = new Set();
 const shippedSchedules = baselineCronSchedules();
 const preexistingIntervals = [];
+const unscheduledAtBaseline = baselineUnscheduledRoutes();
 
 entries.forEach((entry, i) => {
   const label = `vercel.json crons[${i}]`;
@@ -296,6 +340,14 @@ entries.forEach((entry, i) => {
 for (const route of cronRoutes) {
   const url = '/' + route.segments.join('/');
   if (!coveredRoutes.has(route.file)) {
+    const rel = relative(ROOT, route.file).split(sep).join('/');
+    if (unscheduledAtBaseline.has(rel)) {
+      preexistingIntervals.push(
+        `${rel} serves ${url} but no vercel.json cron entry invokes it. The app shipped this route unscheduled, ` +
+          `and the update does not add a schedule, so leave it as it is.`,
+      );
+      continue;
+    }
     problems.push(
       `${relative(ROOT, route.file)} serves ${url} but no vercel.json cron entry invokes it — it will never run ` +
         `after publish. Add { "path": "${url}", "schedule": "*/30 * * * *" } to "crons" or remove the route.`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@assembly-js/app-foundation",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Versioned foundation helpers and build context for Assembly generated apps",
   "type": "module",
   "files": [