@shipvo/cli 0.1.3 → 0.1.5

package/dist/publish.d.ts

@@ -1,4 +1,4 @@
-export declare const PUBLISH_HELP = "Usage: shipvo publish [flags]\n\nBuild, sign and publish an over-the-air release.\n\nFlags (write a value after a space, not =):\n  --bands b0,b1,b2             Cohorts to publish to (default b0,b1,b2)\n  --platform android|ios|all   Platform to publish (default android)\n  --release N                  Release number (default: the next one)\n  --min-shell X.Y.Z            Oldest app shell that can run this release (default: version in app.json)\n  --hermes-bytecode-version V  Refuse bundles built for another Hermes version, for example 96 or 96,98\n  --max-bases N                How many older releases to build patches from (default 6)\n  --skip-export true           Reuse the last build in dist-ota/\n  --skip-web true              Do not publish the web copy for the simulator\n  --dry-run                    Build and sign, write files locally, send nothing\n  --out <dir>                  Where --dry-run writes files (default .shipvo/dry-run)\n  --help                       Show this help\n";
+export declare const PUBLISH_HELP = "Usage: shipvo publish [flags]\n\nBuild, sign and publish an over-the-air release.\n\nFlags (write a value after a space, not =; on/off flags can be bare, or true/false):\n  --bands b0,b1,b2             Cohorts to publish to (default b0,b1,b2)\n  --platform android|ios|all   Platform to publish (default android)\n  --release N                  Release number (default: the next one)\n  --min-shell X.Y.Z            Oldest app shell that can run this release (default: version in app.json)\n  --hermes-bytecode-version V  Refuse bundles built for another Hermes version, for example 96 or 96,98\n  --max-bases N                How many older releases to build patches from (default 6)\n  --skip-export               Reuse the last build in dist-ota/\n  --skip-web                  Do not publish the web copy for the simulator\n  --dry-run                    Build and sign, write files locally, send nothing\n  --dry-run-policy             Check the policy in shipvo.json for these --bands, print the result, publish nothing\n  --out <dir>                  Where --dry-run writes files (default .shipvo/dry-run)\n  --help                       Show this help\n";
 export declare function publish(argv: string[]): Promise<void>;
 /** Bytes in plain units: KB below 1 MB, so a small bundle never reads as 0.00 MB. */
 export declare function formatSize(bytes: number): string;

package/dist/publish.js

@@ -3,9 +3,11 @@
 import { execSync } from "node:child_process";
 import { existsSync, mkdirSync, mkdtempSync, readFileSync, readdirSync, statSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
+import { dirname, join, relative, resolve } from "node:path";
 import { sha256Hex, signBytes } from "./index.js";
 import { checkBundle, parseDeclared } from "./hermes.js";
+import { requiredNativeModules } from "./native.js";
+import { checkPublishPolicy } from "./policy.js";
 import { args as parse, kv as kvFor, loadConfig, seed } from "./config.js";
 const MIME = { ".html": "text/html", ".js": "text/javascript", ".json": "application/json", ".css": "text/css", ".ico": "image/x-icon", ".png": "image/png", ".jpg": "image/jpeg", ".jpeg": "image/jpeg", ".webp": "image/webp", ".ttf": "font/ttf", ".svg": "image/svg+xml" };
 const walk = (d) => readdirSync(d).flatMap((f) => (statSync(join(d, f)).isDirectory() ? walk(join(d, f)) : [join(d, f)]));
@@ -43,6 +45,15 @@ function checkFlags(argv, known) {
         throw new Error(`Unknown flag ${bad.join(", ")}.${hint} Known flags: ${known.map((k) => "--" + k).join(" ")}`);
     }
 }
+/** An on/off flag: bare or "true" is on, "false" is off. Anything else is an error, so a typo never flips it silently. */
+function switchFlag(a, name) {
+    const v = a[name];
+    if (v === undefined || v === "false")
+        return false;
+    if (v === "true")
+        return true;
+    throw new Error(`--${name} is an on/off flag: use --${name}, --${name} true or --${name} false (got "${v}")`);
+}
 /** A store that only writes files under `dir` (key `p/app/1/b0` becomes `dir/p/app/1/b0`). It reads back only what this run wrote (kept in memory), never old files, so the iOS pass can find the web artifact and a dry run never needs a control plane. */
 function localKv(dir) {
     const root = resolve(dir);
@@ -63,21 +74,22 @@ function localKv(dir) {
         },
     };
 }
-const PUBLISH_FLAGS = ["bands", "platform", "release", "min-shell", "hermes-bytecode-version", "max-bases", "skip-export", "skip-web", "dry-run", "out"];
+const PUBLISH_FLAGS = ["bands", "platform", "release", "min-shell", "hermes-bytecode-version", "max-bases", "skip-export", "skip-web", "dry-run", "dry-run-policy", "out"];
 export const PUBLISH_HELP = `Usage: shipvo publish [flags]
 
 Build, sign and publish an over-the-air release.
 
-Flags (write a value after a space, not =):
+Flags (write a value after a space, not =; on/off flags can be bare, or true/false):
   --bands b0,b1,b2             Cohorts to publish to (default b0,b1,b2)
   --platform android|ios|all   Platform to publish (default android)
   --release N                  Release number (default: the next one)
   --min-shell X.Y.Z            Oldest app shell that can run this release (default: version in app.json)
   --hermes-bytecode-version V  Refuse bundles built for another Hermes version, for example 96 or 96,98
   --max-bases N                How many older releases to build patches from (default 6)
-  --skip-export true           Reuse the last build in dist-ota/
-  --skip-web true              Do not publish the web copy for the simulator
+  --skip-export               Reuse the last build in dist-ota/
+  --skip-web                  Do not publish the web copy for the simulator
   --dry-run                    Build and sign, write files locally, send nothing
+  --dry-run-policy             Check the policy in shipvo.json for these --bands, print the result, publish nothing
   --out <dir>                  Where --dry-run writes files (default .shipvo/dry-run)
   --help                       Show this help
 `;
@@ -88,7 +100,17 @@ export async function publish(argv) {
     }
     checkFlags(argv, PUBLISH_FLAGS);
     const a = parse(argv), cfg = loadConfig(), SEED = seed();
-    const dry = a["dry-run"] !== undefined; // a plain switch: any use turns it on
+    if (switchFlag(a, "dry-run-policy")) {
+        const verdict = checkPublishPolicy(cfg.policy, (a.bands || "b0,b1,b2").split(","));
+        if (verdict.ok)
+            console.log(cfg.policy === undefined ? "No policy in shipvo.json: nothing to check." : "Policy allows this publish.");
+        else {
+            console.error(`Refused by policy rule ${verdict.rule}: ${verdict.reason}`);
+            process.exitCode = 1;
+        }
+        return;
+    }
+    const dry = switchFlag(a, "dry-run"), skipExport = switchFlag(a, "skip-export"), skipWeb = switchFlag(a, "skip-web");
     if (a.out !== undefined && !dry)
         throw new Error("--out only works with --dry-run");
     if (a.out === "true")
@@ -100,10 +122,24 @@ export async function publish(argv) {
     if (a["hermes-bytecode-version"] === "true")
         throw new Error("--hermes-bytecode-version needs a value: pass a value like 96 (or 96,98)");
     const declaredHermes = parseDeclared(a["hermes-bytecode-version"] ?? cfg.hermesBytecodeVersion);
+    const skippedNative = [];
+    const nativeModules = requiredNativeModules(".", skippedNative);
+    if (skippedNative.length)
+        console.error(`native modules not recorded (the range is not a plain numeric semver range, so the control plane cannot check it): ${skippedNative.join(", ")}`);
+    if (dry)
+        console.error(`native modules this release requires: ${nativeModules ? Object.entries(nativeModules).map(([n, r]) => `${n}@${r}`).join(", ") : "none found"}`);
     const bands = (a.bands || "b0,b1,b2").split(",");
+    if (dry) {
+        const verdict = checkPublishPolicy(cfg.policy, bands);
+        if (!verdict.ok) {
+            console.error(`Refused by policy rule ${verdict.rule}: ${verdict.reason}`);
+            process.exitCode = 1;
+            return;
+        }
+    }
     const platforms = platformsOf(a);
     const release = Number(a.release || 0) || (await currentRelease(kv, APP, MAJOR)) + 1;
-    const summary = { app: APP, release, bands, min_shell_version: MIN_SHELL, ...(dry ? { dry_run: true, out: outDir } : {}) };
+    const summary = { app: APP, release, bands, min_shell_version: MIN_SHELL, ...(nativeModules ? { required_native_modules: nativeModules } : {}), ...(dry ? { dry_run: true, out: outDir } : {}) };
     if (dry)
         console.error(`dry run: nothing is sent anywhere; files go to ${outDir}. No patches are built offline. Release is ${release}${a.release ? "" : " (pass --release N to match the control plane)"}.`);
     let totalBytes = 0;
@@ -111,7 +147,7 @@ export async function publish(argv) {
     for (const pf of platforms) {
         // Android published alone keeps the original dist-ota/ layout, so existing CI keeps working.
         const root = platforms.length === 1 && pf === "android" ? "dist-ota" : `dist-ota/${pf}`;
-        if (a["skip-export"] !== "true")
+        if (!skipExport)
             execSync(`npx expo export --platform ${pf} --output-dir ${root} --clear`, { stdio: "inherit" });
         const jsDir = `${root}/_expo/static/js/${pf}`;
         const file = readdirSync(jsDir).find((f) => f.endsWith(".hbc")) || readdirSync(jsDir).find((f) => f.endsWith(".js"));
@@ -121,8 +157,8 @@ export async function publish(argv) {
         const hermesVersion = checkBundle(file, bytes, declaredHermes); // fails before anything is uploaded
         const name = bundleName(release, pf), newSha = sha256Hex(bytes);
         await kv.put(`b/${APP}/${name}`, bytes, "application/octet-stream");
-        // Patches: from recent releases (and, on Android, each shell's embedded bundle); devices verify the patched result against the signed sha256.
-        // iOS patches only from earlier iOS releases: the iOS runtime has no embedded-bundle baseline yet.
+        // Patches: from recent releases and each shell's embedded bundle; devices verify the patched result against the signed sha256.
+        // Releases are per platform. Embedded-bundle records are shared under base/<app>/ and tagged with a platform (no tag means Android).
         const patches = [];
         {
             const MAX_BASES = Number(a["max-bases"] || 6);
@@ -136,14 +172,14 @@ export async function publish(argv) {
                 .filter((h) => h && h.release < release).sort((x, y) => y.release - x.release).slice(0, MAX_BASES - 2);
             for (const h of hist)
                 bases.set(h.sha256, `b/${APP}/${bundleName(h.release, pf)}`);
-            if (pf === "android")
-                for (const k of await kv.keys(`base/${APP}/`)) {
-                    try {
-                        const b = JSON.parse((await kv.get(k)));
+            for (const k of await kv.keys(`base/${APP}/`)) {
+                try {
+                    const b = JSON.parse((await kv.get(k)));
+                    if ((b.platform ?? "android") === pf)
                         bases.set(b.sha256, b.key);
-                    }
-                    catch { }
                 }
+                catch { }
+            }
             // Only look for bsdiff4 when there is an older bundle to patch from; a first release needs no patches.
             let bsdiff = false;
             if (bases.size > 0) {
@@ -181,10 +217,10 @@ export async function publish(argv) {
         }
         // The agent-facing web artifact of the same commit, served at /w/<app>/r<N>/ for the simulator (built once, with the first platform).
         let web = null;
-        if (a["skip-web"] !== "true" && pf === platforms[0]) {
-            web = await publishWeb(kv, cfg, APP, release);
+        if (!skipWeb && pf === platforms[0]) {
+            web = await publishWeb(kv, cfg, APP, release, dry ? outDir : undefined);
         }
-        else if (a["skip-web"] !== "true") {
+        else if (!skipWeb) {
             try {
                 web = JSON.parse((await kv.get(`h/${APP}/r${release}`)))?.web ?? null;
             }
@@ -194,10 +230,10 @@ export async function publish(argv) {
         for (const band of bands) {
             const body = JSON.stringify({ schema_version: "1.0", app_id: APP, shell_major: MAJOR, band, ...(pf === "ios" ? { platform: "ios" } : {}), release, issued_at,
                 core: { version: `1.0.${release}`, sha256: newSha, size: bytes.length, url: `b/${APP}/${name}`, patches },
-                addons: [], screens: [], min_shell_version: MIN_SHELL, ...(hermesVersion ? { hermes_bytecode_version: hermesVersion } : {}), ...(web ? { web } : {}) });
+                addons: [], screens: [], min_shell_version: MIN_SHELL, ...(hermesVersion ? { hermes_bytecode_version: hermesVersion } : {}), ...(nativeModules ? { required_native_modules: nativeModules } : {}), ...(web ? { web } : {}) });
             await kv.put(pointerKey(APP, MAJOR, band, pf), JSON.stringify({ body, signature: signBytes(new TextEncoder().encode(body), SEED) }), "application/json");
         }
-        await kv.put(pf === "ios" ? `h/${APP}/ios-r${release}` : `h/${APP}/r${release}`, JSON.stringify({ release, issued_at, sha256: newSha, size: bytes.length, min_shell_version: MIN_SHELL, ...(hermesVersion ? { hermes_bytecode_version: hermesVersion } : {}), web }), "application/json");
+        await kv.put(pf === "ios" ? `h/${APP}/ios-r${release}` : `h/${APP}/r${release}`, JSON.stringify({ release, issued_at, sha256: newSha, size: bytes.length, min_shell_version: MIN_SHELL, ...(hermesVersion ? { hermes_bytecode_version: hermesVersion } : {}), ...(nativeModules ? { required_native_modules: nativeModules } : {}), web }), "application/json");
         totalBytes += bytes.length;
         summary[pf] = { bytes: bytes.length, patches: patches.map((p) => ({ from: p.from_sha256.slice(0, 12), kb: +(p.size / 1024).toFixed(1) })) };
         if (web)
@@ -235,7 +271,7 @@ export function dryRunSummary(release, bytes, outDir, info = { bases: 0, bsdiff:
         lines.push(`Patches built: ${info.patches}.`);
     return lines.join("\n");
 }
-async function publishWeb(kv, cfg, APP, release) {
+async function publishWeb(kv, cfg, APP, release, outDir) {
     execSync("PN_SIM=1 npx expo export --platform web --output-dir dist-web --clear", { stdio: "inherit" });
     const base = `w/${APP}/r${release}`;
     const files = [];
@@ -262,7 +298,9 @@ async function publishWeb(kv, cfg, APP, release) {
     idx.releases = [...new Set([...idx.releases, release])].sort((x, y) => x - y);
     idx.latest = Math.max(...idx.releases);
     await kv.put(idxKey, JSON.stringify(idx), "application/json");
-    console.error(`web artifact: ${files.length} files at /${base}/`);
+    // Show where the files are on disk, relative to this folder: the URL path (/w/...) is not a folder.
+    const where = outDir ? (relative(process.cwd(), resolve(outDir, base)) || ".") + "/" : `/${base}/`;
+    console.error(`web artifact: ${files.length} files at ${where}`);
     // Store listing assets (icon, screenshots) and the release note, read by shipvo.dev/apps and list_apps.
     const L = cfg.listing ?? {};
     const store = `w/${APP}/store`;
@@ -287,16 +325,17 @@ async function publishWeb(kv, cfg, APP, release) {
     return web;
 }
 export async function rollback(argv) {
-    checkFlags(argv, ["to", "bands", "platform"]);
-    const a = parse(argv), cfg = loadConfig(), SEED = seed(), kv = kvFor(cfg);
+    checkFlags(argv, ["to", "bands", "platform", "dry-run"]);
+    const a = parse(argv), dry = a["dry-run"] !== undefined, cfg = loadConfig(), SEED = seed(), kv = kvFor(cfg);
     const APP = cfg.appId, MAJOR = cfg.shellMajor, to = Number(a.to);
     if (!to) {
-        console.error("Usage: shipvo rollback --to <release> [--bands b0,b1,b2] [--platform android|ios|all]");
+        console.error("Usage: shipvo rollback --to <release> [--bands b0,b1,b2] [--platform android|ios|all] [--dry-run]");
         process.exit(2);
     }
     const release = (await currentRelease(kv, APP, MAJOR)) + 1, issued_at = new Date().toISOString();
     let minShell = "1.0.0";
-    for (const pf of platformsOf(a)) {
+    const platforms = platformsOf(a), bands = (a.bands || "b0,b1,b2").split(",");
+    for (const pf of platforms) {
         const bytes = await kv.getBytes(`b/${APP}/${bundleName(to, pf)}`);
         if (!bytes) {
             console.error(`Release ${to} ${pf} bundle not found`);
@@ -309,11 +348,16 @@ export async function rollback(argv) {
             web = h.web ?? undefined;
         }
         catch { }
-        for (const band of (a.bands || "b0,b1,b2").split(",")) {
+        for (const band of bands) {
             const body = JSON.stringify({ schema_version: "1.0", app_id: APP, shell_major: MAJOR, band, ...(pf === "ios" ? { platform: "ios" } : {}), release, issued_at,
                 core: { version: `1.0.${release}`, sha256: sha256Hex(bytes), size: bytes.length, url: `b/${APP}/${bundleName(to, pf)}` }, addons: [], screens: [], min_shell_version: minShell, ...(web ? { web } : {}) });
-            await kv.put(pointerKey(APP, MAJOR, band, pf), JSON.stringify({ body, signature: signBytes(new TextEncoder().encode(body), SEED) }), "application/json");
+            if (!dry)
+                await kv.put(pointerKey(APP, MAJOR, band, pf), JSON.stringify({ body, signature: signBytes(new TextEncoder().encode(body), SEED) }), "application/json");
         }
     }
+    if (dry) {
+        console.log([`Rollback preview for ${APP}:`, `  Rolling back to the code of release ${to}`, `  New release number: ${release}`, `  Platforms: ${platforms.join(", ")}`, `  Bands: ${bands.join(", ")}`, `  Min shell version: ${minShell}`, `Dry run: nothing was written.`].join("\n"));
+        return;
+    }
     console.log(JSON.stringify({ app: APP, rolled_back_to_code_of: to, new_release: release, min_shell_version: minShell, issued_at }));
 }

package/dist/report-md.d.ts

@@ -0,0 +1,26 @@
+type Step = {
+    kind?: string;
+    target?: string;
+    text?: string;
+    enter?: boolean;
+    line?: number;
+};
+type Flow = {
+    name?: string;
+    status?: string;
+    steps?: Step[];
+    failedStep?: Step | null;
+    message?: string | null;
+    screenshots?: string[];
+    screenshot?: string | null;
+};
+export type TestReport = {
+    app?: string | null;
+    commit?: string | null;
+    release?: string | null;
+    time?: string | null;
+    parityLimits?: string[];
+    flows?: Flow[];
+};
+export declare function renderReportMarkdown(report: TestReport): string;
+export {};

package/dist/report-md.js

@@ -0,0 +1,58 @@
+const one = (s) => s.replace(/\s+/g, " ").trim();
+/** Inline code that survives backticks in the text. */
+function code(s) {
+    const t = one(s);
+    const fence = "`".repeat(Math.max(0, ...[...t.matchAll(/`+/g)].map((m) => m[0].length)) + 1);
+    return `${fence}${t.startsWith("`") || t.endsWith("`") ? ` ${t} ` : t}${fence}`;
+}
+function stepText(s) {
+    const kind = s.kind ?? "step";
+    if (kind === "tap")
+        return `tap "${s.target ?? ""}"`;
+    if (kind === "type")
+        return `type "${s.text ?? ""}" into "${s.target ?? ""}"${s.enter ? " and press enter" : ""}`;
+    const arg = s.text ?? s.target;
+    return arg !== undefined ? `${kind} "${arg}"` : kind;
+}
+function block(s) {
+    const fence = "`".repeat(Math.max(2, ...[...s.matchAll(/`+/g)].map((m) => m[0].length)) + 1);
+    return `${fence}\n${s}\n${fence}`;
+}
+export function renderReportMarkdown(report) {
+    const flows = Array.isArray(report.flows) ? report.flows : [];
+    const failed = flows.filter((f) => f.status === "failed");
+    const out = [`# Shipvo test report: ${failed.length ? "failed" : "all flows passed"}`, ""];
+    const meta = [];
+    if (report.app)
+        meta.push(`- App: ${code(report.app)}`);
+    meta.push(`- Release: ${report.release ? code(report.release) : "not set"}`);
+    meta.push(`- Commit: ${report.commit ? code(report.commit) : "unknown"}`);
+    if (report.time)
+        meta.push(`- Time: ${report.time}`);
+    meta.push(`- Flows: ${flows.length - failed.length} passed, ${failed.length} failed`);
+    out.push(...meta, "");
+    if (!failed.length)
+        out.push(flows.length ? `All ${flows.length} flow${flows.length === 1 ? "" : "s"} passed.` : "No flows were run.", "");
+    for (const f of failed) {
+        out.push(`## Failing flow: ${code(f.name ?? "unnamed flow")}`, "");
+        const bad = f.failedStep;
+        if (bad)
+            out.push(`Failed step${bad.line ? ` (line ${bad.line})` : ""}: ${code(stepText(bad))}`, "");
+        if (f.message)
+            out.push("Error:", "", block(f.message), "");
+        const shots = [...(f.screenshots ?? []), ...(f.screenshot ? [f.screenshot] : [])];
+        if (shots.length)
+            out.push(`Screenshots: ${shots.map(code).join(", ")}`, "");
+        if (f.steps?.length) {
+            out.push("Steps:", "");
+            f.steps.forEach((s, i) => {
+                const mark = bad && s.line !== undefined && s.line === bad.line ? " ← failed" : "";
+                out.push(`${i + 1}. ${code(stepText(s))}${mark}`);
+            });
+            out.push("");
+        }
+    }
+    if (report.parityLimits?.length)
+        out.push("## Parity limits", "", ...report.parityLimits.map((l) => `- ${one(l)}`), "");
+    return out.join("\n");
+}

package/dist/run-bridge.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The shared screen rules (`@shipvo/sim`), as source that the page can run. Same copy the simulator uses.
+ * Only plain `export function` / `export const` lines are supported: `export default` and `export {…}` would not be stripped.
+ */
+export declare function screenRulesSource(): string;
+/** The script text served at `/__shipvo/bridge.js`. It reads the session token from its own `data-token` attribute and then removes the attribute. */
+export declare function bridgeScript(rules?: string): string;