@antelopejs/dms-frontend 0.7.1 → 0.8.0

package/dist/commands/snapshot.js

@@ -1,55 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cmdSnapshot = cmdSnapshot;
-const commander_1 = require("commander");
-const config_1 = require("../config");
-const cli_1 = require("@antelopejs/core/cli");
-const SNAPSHOT_EXAMPLES = [
-    {
-        description: "With DMS_BOOTSTRAP_SECRET set, after a backend release",
-        command: "ajs dms snapshot -b https://dms.example.com -o dms-snapshot",
-    },
-];
-function cmdSnapshot() {
-    const command = new commander_1.Command("snapshot")
-        .summary("Keep what a build needs from the backend, without its secrets")
-        .description("Fetch the manifest and the layers archive the backend serves, and write them into a directory with every private value emptied, so that ajs dms build --from builds without the backend or any credential. Take it again when the backend's frontend modules change: start says when they no longer match.")
-        .addOption(config_1.Options.backendUrl("Backend URL to take the snapshot from; required, as -b or the variable"))
-        .addOption(new commander_1.Option("-o, --output <dir>", "Directory to write the snapshot to").default("dms-snapshot"))
-        .addOption(config_1.Options.bootstrapSecret())
-        .action(async (options) => (await Promise.resolve().then(() => __importStar(require("./snapshot-action")))).runSnapshot(options));
-    return (0, cli_1.withExamples)(command, SNAPSHOT_EXAMPLES);
-}

package/dist/snapshot.d.ts

@@ -1,25 +0,0 @@
-import type { Manifest, ManifestModule } from "./workspace";
-export declare const SNAPSHOT_FILE = "snapshot.json";
-export declare const SNAPSHOT_LAYERS_DIR = "layers";
-export declare const BUILD_ORIGIN_FILE = ".build-origin.json";
-declare const SNAPSHOT_FORMAT = 1;
-export interface FrontendSnapshot {
-    format: typeof SNAPSHOT_FORMAT;
-    backendUrl: string;
-    takenAt: string;
-    digest: string;
-    manifest: Manifest;
-}
-export interface BuildOrigin {
-    source: "snapshot" | "backend";
-    backendUrl: string;
-    takenAt: string;
-    digest: string;
-    authenticated: boolean;
-}
-export declare function manifestDigest(modules: readonly ManifestModule[]): string;
-export declare function writeSnapshot(dir: string, backendUrl: string, manifest: Manifest, layersSource: string): FrontendSnapshot;
-export declare function readSnapshot(dir: string): FrontendSnapshot;
-export declare function writeBuildOrigin(workspaceDir: string, origin: BuildOrigin): void;
-export declare function readBuildOrigin(workspaceDir: string): BuildOrigin | undefined;
-export {};

package/dist/snapshot.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BUILD_ORIGIN_FILE = exports.SNAPSHOT_LAYERS_DIR = exports.SNAPSHOT_FILE = void 0;
-exports.manifestDigest = manifestDigest;
-exports.writeSnapshot = writeSnapshot;
-exports.readSnapshot = readSnapshot;
-exports.writeBuildOrigin = writeBuildOrigin;
-exports.readBuildOrigin = readBuildOrigin;
-const node_crypto_1 = require("node:crypto");
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const cli_1 = require("@antelopejs/core/cli");
-const config_1 = require("./config");
-const module_set_1 = require("./module-set");
-const private_values_1 = require("./private-values");
-exports.SNAPSHOT_FILE = "snapshot.json";
-exports.SNAPSHOT_LAYERS_DIR = "layers";
-exports.BUILD_ORIGIN_FILE = ".build-origin.json";
-const SNAPSHOT_FORMAT = 1;
-const DIGEST_LENGTH = 16;
-function manifestDigest(modules) {
-    return (0, node_crypto_1.createHash)("sha256")
-        .update((0, module_set_1.moduleSetFingerprint)(modules.map(({ path: _path, ...module }) => module)))
-        .digest("hex")
-        .slice(0, DIGEST_LENGTH);
-}
-function writeSnapshot(dir, backendUrl, manifest, layersSource) {
-    const modules = (0, private_values_1.withoutPrivateValues)(manifest.modules).map(({ path: _path, ...module }) => module);
-    const snapshot = {
-        format: SNAPSHOT_FORMAT,
-        backendUrl: (0, config_1.canonicalizeBackendUrl)(backendUrl),
-        takenAt: new Date().toISOString(),
-        digest: manifestDigest(modules),
-        manifest: { pack: manifest.pack, modules },
-    };
-    (0, node_fs_1.mkdirSync)(dir, { recursive: true });
-    const layers = (0, node_path_1.join)(dir, exports.SNAPSHOT_LAYERS_DIR);
-    (0, node_fs_1.rmSync)(layers, { recursive: true, force: true });
-    (0, node_fs_1.cpSync)(layersSource, layers, { recursive: true });
-    (0, node_fs_1.writeFileSync)((0, node_path_1.join)(dir, exports.SNAPSHOT_FILE), `${JSON.stringify(snapshot, null, 2)}\n`);
-    return snapshot;
-}
-function readSnapshot(dir) {
-    const file = (0, node_path_1.join)(dir, exports.SNAPSHOT_FILE);
-    const refresh = "Take one: ajs dms snapshot -b <backend url> -o <dir>";
-    if (!(0, node_fs_1.existsSync)(file)) {
-        throw new cli_1.CliError({
-            title: `No snapshot in ${dir}`,
-            reason: `${exports.SNAPSHOT_FILE} is missing.`,
-            fixes: [refresh],
-        });
-    }
-    let snapshot;
-    try {
-        snapshot = JSON.parse((0, node_fs_1.readFileSync)(file, "utf8"));
-    }
-    catch (error) {
-        throw new cli_1.CliError({ title: `${file} is not valid JSON`, fixes: [refresh] }, { cause: error });
-    }
-    if (snapshot.format !== SNAPSHOT_FORMAT ||
-        !Array.isArray(snapshot.manifest?.modules) ||
-        typeof snapshot.backendUrl !== "string") {
-        throw new cli_1.CliError({
-            title: `${file} is not a snapshot this loader can build from`,
-            reason: `It needs format ${SNAPSHOT_FORMAT}, a backend URL and a manifest.`,
-            fixes: [refresh],
-        });
-    }
-    if (!(0, node_fs_1.existsSync)((0, node_path_1.join)(dir, exports.SNAPSHOT_LAYERS_DIR))) {
-        throw new cli_1.CliError({
-            title: `The snapshot in ${dir} has no ${exports.SNAPSHOT_LAYERS_DIR} directory`,
-            fixes: [refresh],
-        });
-    }
-    return snapshot;
-}
-function writeBuildOrigin(workspaceDir, origin) {
-    (0, node_fs_1.writeFileSync)((0, node_path_1.join)(workspaceDir, exports.BUILD_ORIGIN_FILE), `${JSON.stringify(origin, null, 2)}\n`);
-}
-function readBuildOrigin(workspaceDir) {
-    try {
-        const origin = JSON.parse((0, node_fs_1.readFileSync)((0, node_path_1.join)(workspaceDir, exports.BUILD_ORIGIN_FILE), "utf8"));
-        return typeof origin.digest === "string"
-            ? origin
-            : undefined;
-    }
-    catch {
-        return undefined;
-    }
-}

package/templates/vue/server/backend-wake.mjs

@@ -1,129 +0,0 @@
-// Waiting out a backend that is waking from sleep or still starting.
-//
-// A platform that scales the backend to zero answers the first requests with
-// a 503 while it starts a replica, marked with the cold-start header and a
-// Retry-After in whole seconds; a DMS backend that listens before it is ready
-// answers 503 with a Retry-After too, without the header. A 503 with a
-// Retry-After in whole seconds is the signal, with or without the header; a
-// 503 without one goes out as it came. Only a GET or a HEAD is repeated; a
-// POST, PATCH or DELETE is sent once.
-//
-// The wait starts with the first waitable answer and lasts at most the
-// budget, the repeated requests included: one still waiting for its answer
-// when the budget runs out is aborted, and no request starts after it. It
-// ends at once when the client leaves.
-//
-// Lives apart from server.mjs so the file stays under the size the linter
-// allows.
-
-import { setTimeout as sleep } from "node:timers/promises";
-
-/** Header a platform marks the 503 of a backend it is waking with. */
-export const COLD_START_HEADER = "x-antelope-cold-start";
-const COLD_START_VALUE = "1";
-const UNAVAILABLE = 503;
-const RETRYABLE_METHODS = new Set(["GET", "HEAD"]);
-const DEFAULT_BUDGET_MS = 30_000;
-const MIN_DELAY_MS = 1_000;
-// Repeats after the first request, so a GET is sent 16 times at most. They
-// are capped as well as the time, so a marked answer with `Retry-After: 0`
-// cannot multiply a GET.
-const MAX_REPEATS = 15;
-const MAX_DELAY_MS = 5_000;
-const MS_PER_SECOND = 1_000;
-const WHOLE_SECONDS = /^\d+$/;
-const WHOLE_MILLISECONDS = /^\d+$/;
-
-/**
- * Whether `response` is a 503 asking to come back after a Retry-After in
- * whole seconds: a platform waking the backend (with the cold-start header)
- * or a backend still starting.
- */
-export function isWaitable(response) {
-  return (
-    response.status === UNAVAILABLE && WHOLE_SECONDS.test(retryAfter(response))
-  );
-}
-
-function retryAfter(response) {
-  return (response.headers.get("retry-after") ?? "").trim();
-}
-
-/**
- * How long a request may wait for a waking backend, from
- * DMS_BACKEND_WAKE_BUDGET_MS. 0 turns the wait off; anything but a whole
- * number of milliseconds keeps the default.
- */
-export function wakeBudgetMs(env = process.env) {
-  const raw = (env.DMS_BACKEND_WAKE_BUDGET_MS ?? "").trim();
-  return WHOLE_MILLISECONDS.test(raw) ? Number(raw) : DEFAULT_BUDGET_MS;
-}
-
-/** The pause a waitable answer's Retry-After asks for, kept between bounds. */
-function retryDelayMs(response) {
-  return Math.min(
-    MAX_DELAY_MS,
-    Math.max(MIN_DELAY_MS, Number(retryAfter(response)) * MS_PER_SECOND),
-  );
-}
-
-/**
- * What the client gets once the budget is spent: the last waitable answer's
- * status, Retry-After and cold-start header if it had one, without the body
- * its pause already discarded.
- */
-function expired(cold) {
-  const headers = { "retry-after": retryAfter(cold) };
-  if (cold.headers.get(COLD_START_HEADER) === COLD_START_VALUE)
-    headers[COLD_START_HEADER] = COLD_START_VALUE;
-  return new Response(null, { status: UNAVAILABLE, headers });
-}
-
-/**
- * Sends one repeat, aborted if no answer has come by `deadline`. Once the
- * answer has come the deadline no longer applies, so a ready backend's body
- * streams for as long as it needs; only the client leaving ends it.
- * Resolves to undefined when the deadline aborted the request.
- */
-async function repeat(url, init, deadline, now) {
-  const late = new AbortController();
-  const timer = setTimeout(() => late.abort(), Math.max(0, deadline - now()));
-  const signal = init.signal
-    ? AbortSignal.any([init.signal, late.signal])
-    : late.signal;
-  try {
-    return await fetch(url, { ...init, signal });
-  } catch (error) {
-    if (late.signal.aborted && !init.signal?.aborted) return undefined;
-    throw error;
-  } finally {
-    clearTimeout(timer);
-  }
-}
-
-/**
- * `fetch`, waiting out waitable 503s to a GET or a HEAD until `budgetMs`
- * from the first of them is spent or MAX_REPEATS repeats are sent. Then the
- * caller gets the 503 with its `Retry-After` to relay. The client
- * leaving, through `init.signal`, ends the wait with its AbortError.
- */
-export async function fetchWaking(
-  url,
-  init = {},
-  { budgetMs = wakeBudgetMs(), now = Date.now } = {},
-) {
-  const method = (init.method ?? "GET").toUpperCase();
-  let response = await fetch(url, init);
-  if (!RETRYABLE_METHODS.has(method)) return response;
-  const deadline = now() + budgetMs;
-  for (let repeats = 0; isWaitable(response); repeats += 1) {
-    const cold = response;
-    const delay = retryDelayMs(cold);
-    if (repeats >= MAX_REPEATS || now() + delay > deadline) return cold;
-    cold.body?.cancel().catch(() => {});
-    await sleep(delay, undefined, { signal: init.signal });
-    if (now() >= deadline) return expired(cold);
-    response = (await repeat(url, init, deadline, now)) ?? expired(cold);
-  }
-  return response;
-}