@samebase/convex-hosting 0.3.2 → 0.4.1

package/src/cli/args.test.ts

@@ -1,79 +0,0 @@
-import { describe, expect, test } from "vite-plus/test";
-import { buildDeployUploadArgs, parseDeployArgs, parseUploadArgs } from "./args.js";
-
-describe("CLI argument parsing", () => {
-  test("targets named preview uploads without selecting production", () => {
-    expect(parseUploadArgs([])).toMatchObject({
-      prod: false,
-      previewName: null,
-    });
-    expect(parseUploadArgs(["--preview-name", "feature-routing"])).toMatchObject({
-      prod: false,
-      previewName: "feature-routing",
-    });
-  });
-
-  test.each([
-    ["--prod", "--preview-name", "feature-routing"],
-    ["--preview-name", "feature-routing", "--prod"],
-  ])("rejects conflicting upload destinations: %s", (...args) => {
-    expect(() => parseUploadArgs(args)).toThrow("--prod and --preview-name cannot be combined");
-  });
-
-  test("parses and forwards deploy upload options exactly", () => {
-    const parsed = parseDeployArgs([
-      "--dist",
-      "web-dist",
-      "--component",
-      "site",
-      "--cdn",
-      "--cdn-delete-function",
-      "hosting:deleteCdnBlobs",
-      "--no-spa",
-    ]);
-
-    expect(buildDeployUploadArgs(parsed)).toEqual([
-      "upload",
-      "--dist",
-      "web-dist",
-      "--component",
-      "site",
-      "--prod",
-      "--cdn",
-      "--cdn-delete-function",
-      "hosting:deleteCdnBlobs",
-      "--no-spa",
-    ]);
-  });
-
-  test("parses upload environment and concurrency options", () => {
-    expect(
-      parseUploadArgs([
-        "--prod",
-        "--component",
-        "site",
-        "--concurrency",
-        "8",
-        "--build-command",
-        "npm run build:web",
-      ]),
-    ).toMatchObject({
-      prod: true,
-      component: "site",
-      concurrency: 8,
-      build: true,
-      buildCommand: "npm run build:web",
-    });
-  });
-
-  test.each([
-    ["missing preview name", () => parseUploadArgs(["--preview-name"])],
-    ["invalid preview name", () => parseUploadArgs(["--preview-name", "--prod"])],
-    ["upload", () => parseUploadArgs(["--dist", "--prod"])],
-    ["deploy", () => parseDeployArgs(["--cdn-delete-function", "--no-spa"])],
-    ["unknown upload", () => parseUploadArgs(["--wat"])],
-    ["unknown deploy", () => parseDeployArgs(["--wat"])],
-  ])("rejects malformed %s arguments", (_name, parse) => {
-    expect(parse).toThrow();
-  });
-});

package/src/cli/args.ts

@@ -1,153 +0,0 @@
-export interface UploadArgs {
-  dist: string;
-  component: string;
-  prod: boolean;
-  previewName: string | null;
-  build: boolean;
-  buildCommand: string;
-  cdn: boolean;
-  cdnDeleteFunction: string;
-  concurrency: number;
-  spaFallback: boolean;
-  help: boolean;
-}
-
-export interface DeployArgs {
-  dist: string;
-  component: string;
-  help: boolean;
-  skipBuild: boolean;
-  skipConvex: boolean;
-  cdn: boolean;
-  cdnDeleteFunction: string;
-  spaFallback: boolean;
-  buildCommand: string;
-}
-
-function optionValue(args: string[], index: number, option: string): string {
-  const value = args[index + 1];
-  if (!value || value.startsWith("-")) {
-    throw new Error(`${option} requires a value`);
-  }
-  return value;
-}
-
-export function parseUploadArgs(args: string[]): UploadArgs {
-  const result: UploadArgs = {
-    dist: "./dist",
-    component: "hosting",
-    prod: false,
-    previewName: null,
-    build: false,
-    buildCommand: "npm run build",
-    cdn: false,
-    cdnDeleteFunction: "",
-    concurrency: 5,
-    spaFallback: true,
-    help: false,
-  };
-
-  for (let i = 0; i < args.length; i++) {
-    const arg = args[i];
-    if (arg === "--help" || arg === "-h") {
-      result.help = true;
-    } else if (arg === "--dist" || arg === "-d") {
-      result.dist = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--component" || arg === "-c") {
-      result.component = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--preview-name") {
-      result.previewName = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--prod") {
-      result.prod = true;
-    } else if (arg === "--no-prod" || arg === "--dev") {
-      result.prod = false;
-    } else if (arg === "--build" || arg === "-b") {
-      result.build = true;
-    } else if (arg === "--build-command") {
-      result.buildCommand = optionValue(args, i, arg);
-      result.build = true;
-      i++;
-    } else if (arg === "--no-spa") {
-      result.spaFallback = false;
-    } else if (arg === "--spa") {
-      result.spaFallback = true;
-    } else if (arg === "--cdn") {
-      result.cdn = true;
-    } else if (arg === "--cdn-delete-function") {
-      result.cdnDeleteFunction = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--concurrency" || arg === "-j") {
-      const value = optionValue(args, i, arg);
-      const concurrency = Number(value);
-      if (!Number.isInteger(concurrency) || concurrency <= 0) {
-        throw new Error(`${arg} must be a positive integer`);
-      }
-      result.concurrency = concurrency;
-      i++;
-    } else {
-      throw new Error(`Unknown upload option: ${arg}`);
-    }
-  }
-  if (result.prod && result.previewName !== null)
-    throw new Error("--prod and --preview-name cannot be combined");
-  return result;
-}
-
-export function parseDeployArgs(args: string[]): DeployArgs {
-  const result: DeployArgs = {
-    dist: "./dist",
-    component: "hosting",
-    help: false,
-    skipBuild: false,
-    skipConvex: false,
-    cdn: false,
-    cdnDeleteFunction: "",
-    spaFallback: true,
-    buildCommand: "npm run build",
-  };
-
-  for (let i = 0; i < args.length; i++) {
-    const arg = args[i];
-    if (arg === "--help" || arg === "-h") {
-      result.help = true;
-    } else if (arg === "--dist" || arg === "-d") {
-      result.dist = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--component" || arg === "-c") {
-      result.component = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--skip-build") {
-      result.skipBuild = true;
-    } else if (arg === "--skip-convex") {
-      result.skipConvex = true;
-    } else if (arg === "--cdn") {
-      result.cdn = true;
-    } else if (arg === "--cdn-delete-function") {
-      result.cdnDeleteFunction = optionValue(args, i, arg);
-      i++;
-    } else if (arg === "--no-spa") {
-      result.spaFallback = false;
-    } else if (arg === "--spa") {
-      result.spaFallback = true;
-    } else if (arg === "--build-command") {
-      result.buildCommand = optionValue(args, i, arg);
-      i++;
-    } else {
-      throw new Error(`Unknown deploy option: ${arg}`);
-    }
-  }
-  return result;
-}
-
-export function buildDeployUploadArgs(args: DeployArgs): string[] {
-  const uploadArgs = ["upload", "--dist", args.dist, "--component", args.component, "--prod"];
-  if (args.cdn) uploadArgs.push("--cdn");
-  if (args.cdnDeleteFunction) {
-    uploadArgs.push("--cdn-delete-function", args.cdnDeleteFunction);
-  }
-  if (!args.spaFallback) uploadArgs.push("--no-spa");
-  return uploadArgs;
-}

package/src/cli/argumentChunks.test.ts

@@ -1,27 +0,0 @@
-import { describe, expect, test } from "vite-plus/test";
-import { chunkBySerializedArgument, MAX_CONVEX_ARGUMENT_BYTES } from "./argumentChunks.js";
-
-describe("chunkBySerializedArgument", () => {
-  test("keeps every serialized command argument within the portable limit", () => {
-    const records = Array.from({ length: 200 }, (_, index) => ({
-      path: `/assets/${index}-${"x".repeat(180)}.js`,
-      deploymentId: "deployment",
-    }));
-
-    const chunks = chunkBySerializedArgument(records, (assets) => ({ assets }));
-
-    expect(chunks.length).toBeGreaterThan(1);
-    expect(chunks.flat()).toEqual(records);
-    for (const assets of chunks) {
-      expect(Buffer.byteLength(JSON.stringify({ assets }))).toBeLessThanOrEqual(
-        MAX_CONVEX_ARGUMENT_BYTES,
-      );
-    }
-  });
-
-  test("rejects one record that cannot fit safely", () => {
-    expect(() =>
-      chunkBySerializedArgument(["x".repeat(200)], (values) => ({ values }), 100),
-    ).toThrow("Shorten the asset path");
-  });
-});

package/src/cli/argumentChunks.ts

@@ -1,40 +0,0 @@
-// Windows limits the complete command line to roughly 32 KiB. Keep each JSON
-// argument below 20 KiB so the Node executable, Convex flags, and paths still
-// have comfortable headroom on every supported platform.
-export const MAX_CONVEX_ARGUMENT_BYTES = 20 * 1024;
-
-export function chunkBySerializedArgument<T>(
-  items: T[],
-  makeArgs: (chunk: T[]) => Record<string, unknown>,
-  maxBytes = MAX_CONVEX_ARGUMENT_BYTES,
-): T[][] {
-  const chunks: T[][] = [];
-  let current: T[] = [];
-
-  for (const item of items) {
-    const candidate = [...current, item];
-    const candidateBytes = Buffer.byteLength(JSON.stringify(makeArgs(candidate)));
-    if (candidateBytes <= maxBytes) {
-      current = candidate;
-      continue;
-    }
-
-    if (current.length === 0) {
-      throw new Error(
-        `One upload record needs ${candidateBytes} bytes, which exceeds the safe Convex CLI argument limit of ${maxBytes} bytes. Shorten the asset path.`,
-      );
-    }
-
-    chunks.push(current);
-    current = [item];
-    const singleBytes = Buffer.byteLength(JSON.stringify(makeArgs(current)));
-    if (singleBytes > maxBytes) {
-      throw new Error(
-        `One upload record needs ${singleBytes} bytes, which exceeds the safe Convex CLI argument limit of ${maxBytes} bytes. Shorten the asset path.`,
-      );
-    }
-  }
-
-  if (current.length > 0) chunks.push(current);
-  return chunks;
-}

package/src/cli/collectFiles.test.ts

@@ -1,26 +0,0 @@
-import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "fs";
-import { tmpdir } from "os";
-import { join } from "path";
-import { afterEach, describe, expect, test } from "vite-plus/test";
-import { collectFiles } from "./collectFiles.js";
-
-describe("collectFiles", () => {
-  let distDir: string;
-
-  afterEach(() => {
-    rmSync(distDir, { recursive: true, force: true });
-  });
-
-  test("skips hosting rule files at the root of the build output", () => {
-    distDir = mkdtempSync(join(tmpdir(), "convex-hosting-dist-"));
-    mkdirSync(join(distDir, "docs"));
-    for (const path of ["index.html", "_headers", "_redirects", "docs/_headers"]) {
-      writeFileSync(join(distDir, path), "");
-    }
-
-    const { files, skipped } = collectFiles(distDir);
-
-    expect(files.map((file) => file.path).sort()).toEqual(["/docs/_headers", "/index.html"]);
-    expect(skipped.sort()).toEqual(["/_headers", "/_redirects"]);
-  });
-});

package/src/cli/collectFiles.ts

@@ -1,59 +0,0 @@
-import { readdirSync } from "fs";
-import { extname, join, relative } from "path";
-
-const MIME_TYPES: Record<string, string> = {
-  ".html": "text/html; charset=utf-8",
-  ".js": "application/javascript; charset=utf-8",
-  ".mjs": "application/javascript; charset=utf-8",
-  ".css": "text/css; charset=utf-8",
-  ".json": "application/json; charset=utf-8",
-  ".png": "image/png",
-  ".jpg": "image/jpeg",
-  ".jpeg": "image/jpeg",
-  ".gif": "image/gif",
-  ".svg": "image/svg+xml",
-  ".ico": "image/x-icon",
-  ".webp": "image/webp",
-  ".woff": "font/woff",
-  ".woff2": "font/woff2",
-  ".ttf": "font/ttf",
-  ".txt": "text/plain; charset=utf-8",
-  ".map": "application/json",
-  ".webmanifest": "application/manifest+json",
-  ".xml": "application/xml",
-};
-
-// Cloudflare and Netlify read these files at the root of the build output as hosting rules and
-// never serve them. This package does not apply them, so it does not upload them either.
-const HOSTING_RULE_FILES = new Set(["/_headers", "/_redirects"]);
-
-export type CollectedFile = { path: string; localPath: string; contentType: string };
-
-export function collectFiles(distDir: string): {
-  files: CollectedFile[];
-  skipped: string[];
-} {
-  const files: CollectedFile[] = [];
-  const skipped: string[] = [];
-  const visit = (dir: string) => {
-    for (const entry of readdirSync(dir, { withFileTypes: true })) {
-      const localPath = join(dir, entry.name);
-      if (entry.isDirectory()) {
-        visit(localPath);
-      } else if (entry.isFile()) {
-        const path = "/" + relative(distDir, localPath).replace(/\\/g, "/");
-        if (HOSTING_RULE_FILES.has(path)) {
-          skipped.push(path);
-          continue;
-        }
-        files.push({
-          path,
-          localPath,
-          contentType: MIME_TYPES[extname(localPath).toLowerCase()] || "application/octet-stream",
-        });
-      }
-    }
-  };
-  visit(distDir);
-  return { files, skipped };
-}

package/src/cli/commands.ts

@@ -1,68 +0,0 @@
-import { execFile, execFileSync, spawnSync } from "child_process";
-import { createRequire } from "module";
-import { dirname, join, resolve } from "path";
-import { fileURLToPath } from "url";
-
-const requireFromCwd = createRequire(join(process.cwd(), "package.json"));
-
-function convexBinPath(): string {
-  const packageJsonPath = requireFromCwd.resolve("convex/package.json");
-  return join(dirname(packageJsonPath), "bin", "main.js");
-}
-
-function shellCommand(command: string): { command: string; args: string[] } {
-  return process.platform === "win32"
-    ? { command: "cmd.exe", args: ["/d", "/s", "/c", command] }
-    : { command: "sh", args: ["-c", command] };
-}
-
-export function runConvex(args: string[]): string {
-  return execFileSync(process.execPath, [convexBinPath(), ...args], {
-    encoding: "utf-8",
-    stdio: ["pipe", "pipe", "pipe"],
-  }).trim();
-}
-
-export function runConvexAsync(args: string[], options: { quiet?: boolean } = {}): Promise<string> {
-  return new Promise((resolve, reject) => {
-    execFile(
-      process.execPath,
-      [convexBinPath(), ...args],
-      { encoding: "utf-8" },
-      (error, stdout, stderr) => {
-        if (error) {
-          // Callers that probe optional components (e.g. resolving a legacy
-          // instance name) pass quiet so an expected miss isn't logged as a
-          // failure.
-          if (!options.quiet) {
-            console.error("Convex run failed:", stderr || stdout);
-          }
-          reject(error);
-          return;
-        }
-        resolve(stdout.trim());
-      },
-    );
-  });
-}
-
-export function spawnConvex(args: string[]): number | null {
-  return spawnSync(process.execPath, [convexBinPath(), ...args], {
-    stdio: "inherit",
-  }).status;
-}
-
-export function spawnShell(command: string, env: NodeJS.ProcessEnv = process.env): number | null {
-  const cmd = shellCommand(command);
-  return spawnSync(cmd.command, cmd.args, {
-    env,
-    stdio: "inherit",
-  }).status;
-}
-
-export function spawnStaticHostingCli(args: string[]): number | null {
-  const cliPath = resolve(dirname(fileURLToPath(import.meta.url)), "index.js");
-  return spawnSync(process.execPath, [cliPath, ...args], {
-    stdio: "inherit",
-  }).status;
-}

package/src/cli/componentName.test.ts

@@ -1,41 +0,0 @@
-import { describe, expect, test } from "vite-plus/test";
-import {
-  componentNameCandidates,
-  DEFAULT_COMPONENT_NAME,
-  isLegacyAutoDetected,
-  LEGACY_COMPONENT_NAME,
-  legacyComponentNameWarning,
-} from "./componentName.js";
-
-describe("component name resolution", () => {
-  test("default name also probes the legacy name", () => {
-    expect(componentNameCandidates(DEFAULT_COMPONENT_NAME)).toEqual([
-      DEFAULT_COMPONENT_NAME,
-      LEGACY_COMPONENT_NAME,
-    ]);
-  });
-
-  test("legacy name is used verbatim without expanding", () => {
-    expect(componentNameCandidates(LEGACY_COMPONENT_NAME)).toEqual([LEGACY_COMPONENT_NAME]);
-  });
-
-  test("a custom name is never redirected to another instance", () => {
-    expect(componentNameCandidates("hostingV2")).toEqual(["hostingV2"]);
-  });
-
-  test("only an auto-detected legacy fallback warrants a warning", () => {
-    // Relied on the default, fell back to legacy: warn.
-    expect(isLegacyAutoDetected(DEFAULT_COMPONENT_NAME, LEGACY_COMPONENT_NAME)).toBe(true);
-    // Explicitly requested the legacy name (e.g. deploy forwarding it to the
-    // upload subprocess): stay silent so a single command warns at most once.
-    expect(isLegacyAutoDetected(LEGACY_COMPONENT_NAME, LEGACY_COMPONENT_NAME)).toBe(false);
-    // Resolved the default: nothing to warn about.
-    expect(isLegacyAutoDetected(DEFAULT_COMPONENT_NAME, DEFAULT_COMPONENT_NAME)).toBe(false);
-  });
-
-  test("the legacy warning names the instance and the current default", () => {
-    const warning = legacyComponentNameWarning(LEGACY_COMPONENT_NAME);
-    expect(warning).toContain(LEGACY_COMPONENT_NAME);
-    expect(warning).toContain(DEFAULT_COMPONENT_NAME);
-  });
-});

package/src/cli/componentName.ts

@@ -1,46 +0,0 @@
-/**
- * Component instance name resolution shared by the deploy and upload commands.
- *
- * `@convex-dev/static-hosting` mounted the component as `staticHosting`; this
- * package defaults to `hosting`. An app that switches packages but keeps
- * its existing instance (`app.use(hosting, { name: "staticHosting" })`)
- * keeps its uploaded files and URLs. Without the probe it would have to pass
- * `--component staticHosting` on every command. Instead the CLI probes both
- * names when the caller relied on the default, and warns when it lands on the
- * legacy one.
- */
-export const DEFAULT_COMPONENT_NAME = "hosting";
-export const LEGACY_COMPONENT_NAME = "staticHosting";
-
-/**
- * Instance names to probe, in order, for a requested name.
- *
- * Only the default request expands to include the legacy name. Any other
- * requested name is used verbatim: an explicit custom name must never be
- * silently redirected to a different instance.
- */
-export function componentNameCandidates(requested: string): string[] {
-  if (requested !== DEFAULT_COMPONENT_NAME) return [requested];
-  return [DEFAULT_COMPONENT_NAME, LEGACY_COMPONENT_NAME];
-}
-
-/**
- * Whether resolving `requested` to `resolved` was a legacy-name auto-detection
- * worth warning about. Only true when the caller relied on the default and we
- * fell back to the legacy name — an explicitly requested name (including a
- * command forwarding the resolved name to a subprocess) is left silent so a
- * single `deploy` warns at most once.
- */
-export function isLegacyAutoDetected(requested: string, resolved: string): boolean {
-  return requested === DEFAULT_COMPONENT_NAME && resolved === LEGACY_COMPONENT_NAME;
-}
-
-/** Warning shown once when a command resolves to the legacy instance name. */
-export function legacyComponentNameWarning(name: string): string {
-  return (
-    `⚠️  Using the component instance "${name}" (the @convex-dev/static-hosting ` +
-    `default; this package's default is "${DEFAULT_COMPONENT_NAME}").\n` +
-    `   It keeps working without flags. To use the default, rename the instance ` +
-    `to "${DEFAULT_COMPONENT_NAME}" and upload your files again.`
-  );
-}