@samebase/convex-hosting 0.3.2 → 0.4.1

package/src/cli/deploy.ts

@@ -1,336 +0,0 @@
-#!/usr/bin/env node
-/**
- * One-shot deployment command that deploys both Convex backend and static files.
- *
- * Usage:
- *   npx @samebase/convex-hosting deploy [options]
- *
- * This command:
- * 1. Builds the frontend with the correct VITE_CONVEX_URL
- * 2. Deploys the Convex backend (npx convex deploy)
- * 3. Deploys static files to Convex storage
- *
- * The goal is to minimize the inconsistency window between backend and frontend.
- */
-
-import { existsSync } from "fs";
-import { resolve } from "path";
-import { runConvex, spawnConvex, spawnShell, spawnStaticHostingCli } from "./commands.js";
-import { buildDeployUploadArgs, parseDeployArgs, type DeployArgs } from "./args.js";
-import {
-  buildEnvironment,
-  buildEnvironmentChanged,
-  type DeploymentUrls,
-} from "./deployEnvironment.js";
-import {
-  componentNameCandidates,
-  isLegacyAutoDetected,
-  legacyComponentNameWarning,
-} from "./componentName.js";
-
-function showHelp(): void {
-  console.log(`
-Usage: npx @samebase/convex-hosting deploy [options]
-
-One-shot deployment: builds frontend, deploys Convex backend, then deploys static files.
-Minimizes the inconsistency window between backend and frontend updates.
-
-Options:
-  -d, --dist <path>           Path to dist directory (default: ./dist)
-  -c, --component <name>      Convex component name (default: hosting)
-      --skip-build            Skip the build step (use existing dist)
-      --skip-convex           Skip Convex backend deployment
-      --build-command <cmd>   Build command to run (default: 'npm run build')
-      --no-spa                Disable SPA fallback (404 instead of /index.html)
-      --spa                   Enable SPA fallback (default)
-      --cdn                   Use the legacy convex-fs integration
-      --cdn-delete-function <name>  Legacy app function that deletes CDN blobs
-  -h, --help                  Show this help message
-
-Deployment Flow:
-  1. Build frontend with production VITE_CONVEX_URL
-  2. Deploy Convex backend (npx convex deploy)
-  3. Rebuild if the backend changed the static mount path
-  4. Deploy static files to Convex storage
-
-Examples:
-  # Full deployment
-  npx @samebase/convex-hosting deploy
-
-  # Skip build (if already built)
-  npx @samebase/convex-hosting deploy --skip-build
-
-  # Only deploy static files (skip Convex backend)
-  npx @samebase/convex-hosting deploy --skip-convex
-`);
-}
-
-/**
- * Resolve the component's deployment URLs (siteUrl + cloudUrl). Returns null
- * if the component isn't reachable yet; on first deploy the backend may not
- * exist, in which case the caller should deploy it first and retry.
- */
-function tryFetchUrls(componentName: string): DeploymentUrls | null {
-  try {
-    const out = runConvex([
-      "run",
-      "--component",
-      componentName,
-      "lib:getUrls",
-      "{}",
-      "--prod",
-      "--typecheck=disable",
-      "--codegen=disable",
-    ]);
-    return JSON.parse(out);
-  } catch {
-    return null;
-  }
-}
-
-interface ResolvedComponent {
-  urls: DeploymentUrls;
-  componentName: string;
-}
-
-// The legacy-name warning is printed at most once per invocation.
-let warnedLegacyName = false;
-
-/**
- * Resolve the deployment URLs and the instance name that answered. When the
- * caller relied on the default name we also probe the @convex-dev/static-hosting
- * name, so an app that kept that instance works without `--component staticHosting`. Returns
- * null if no candidate is deployed yet (the caller may deploy the backend and
- * retry).
- */
-function tryResolveComponent(requested: string): ResolvedComponent | null {
-  for (const componentName of componentNameCandidates(requested)) {
-    const urls = tryFetchUrls(componentName);
-    if (urls) {
-      if (isLegacyAutoDetected(requested, componentName) && !warnedLegacyName) {
-        console.warn(legacyComponentNameWarning(componentName));
-        warnedLegacyName = true;
-      }
-      return { urls, componentName };
-    }
-  }
-  return null;
-}
-
-function resolveComponentOrExit(requested: string): ResolvedComponent {
-  const resolved = tryResolveComponent(requested);
-  if (!resolved) {
-    const names = componentNameCandidates(requested)
-      .map((name) => `"${name}"`)
-      .join(" or ");
-    console.error(
-      `Could not reach component ${names}. Deploy the Convex backend first (npx convex deploy) and ensure --component matches the name in convex.config.ts.`,
-    );
-    process.exit(1);
-  }
-  return resolved;
-}
-
-/**
- * Run the Convex storage upload flow
- */
-async function uploadToConvexStorage(args: DeployArgs): Promise<boolean> {
-  console.log("");
-  console.log(
-    args.cdn
-      ? "📦 Uploading static files (HTML to Convex, assets to CDN)..."
-      : "📦 Uploading static files to Convex storage...",
-  );
-  console.log("");
-
-  const result = spawnStaticHostingCli(buildDeployUploadArgs(args));
-
-  return result === 0;
-}
-
-function runFrontendBuild(args: DeployArgs, urls: DeploymentUrls): void {
-  const environment = buildEnvironment(urls);
-  console.log(`   Build command: ${args.buildCommand}`);
-  console.log(`   VITE_CONVEX_URL=${environment.cloudUrl}`);
-  console.log(`   CONVEX_HOSTING_BASE_PATH=${environment.basePath}`);
-  console.log("");
-
-  const buildResult = spawnShell(args.buildCommand, {
-    ...process.env,
-    VITE_CONVEX_URL: environment.cloudUrl,
-    CONVEX_HOSTING_BASE_PATH: environment.basePath,
-  });
-  if (buildResult !== 0) {
-    throw new Error("Frontend build failed");
-  }
-}
-
-async function main(): Promise<void> {
-  const args = parseDeployArgs(process.argv.slice(2));
-
-  if (args.help) {
-    showHelp();
-    process.exit(0);
-  }
-
-  console.log("");
-  console.log("🚀 Convex + Static Files Deployment");
-  console.log("═══════════════════════════════════════════════════════════");
-
-  const startTime = Date.now();
-
-  // Step 1: Get deployment URLs (needed for build)
-  console.log("");
-  console.log("Step 1: Getting deployment URLs...");
-
-  let resolved = tryResolveComponent(args.component);
-  let urls = resolved?.urls ?? null;
-  // Falls back to the requested name until the backend is deployed and a real
-  // instance answers; re-resolved after each deploy below.
-  let componentName = resolved?.componentName ?? args.component;
-  const shouldDeployBackend = !args.skipConvex;
-  let backendAlreadyDeployed = false;
-
-  if (!urls && !args.skipConvex) {
-    console.log("   Component not yet deployed. Will fetch URLs after deploying backend.");
-  } else if (urls) {
-    console.log(`   ✓ ${urls.siteUrl}`);
-  }
-
-  // Step 2: Build frontend
-  if (!args.skipBuild) {
-    console.log("");
-    console.log("Step 2: Building frontend...");
-
-    // If the component isn't deployed yet, deploy the backend first so we
-    // can ask it for the URLs.
-    if (!urls && shouldDeployBackend) {
-      console.log("   Deploying Convex backend first to get URLs...");
-      console.log("");
-
-      const convexResult = spawnConvex(["deploy"]);
-
-      if (convexResult !== 0) {
-        console.error("");
-        console.error("❌ Convex deployment failed");
-        process.exit(1);
-      }
-
-      resolved = resolveComponentOrExit(args.component);
-      urls = resolved.urls;
-      componentName = resolved.componentName;
-      console.log("");
-      console.log(`   ✓ Site URL: ${urls.siteUrl}`);
-      backendAlreadyDeployed = true;
-    }
-
-    if (!urls) {
-      console.error("");
-      console.error("❌ Could not determine deployment URLs for build");
-      console.error("   Run 'npx convex deploy' first or remove --skip-convex");
-      process.exit(1);
-    }
-
-    try {
-      runFrontendBuild(args, urls);
-    } catch {
-      console.error("");
-      console.error("❌ Build failed");
-      process.exit(1);
-    }
-
-    console.log("");
-    console.log("   ✓ Build complete");
-  } else {
-    console.log("");
-    console.log("Step 2: Skipping build (--skip-build)");
-  }
-
-  // Step 3: Deploy Convex backend
-  if (shouldDeployBackend && !backendAlreadyDeployed) {
-    console.log("");
-    console.log("Step 3: Deploying Convex backend...");
-    console.log("");
-
-    const convexResult = spawnConvex(["deploy"]);
-
-    if (convexResult !== 0) {
-      console.error("");
-      console.error("❌ Convex deployment failed");
-      process.exit(1);
-    }
-
-    console.log("");
-    console.log("   ✓ Convex backend deployed");
-
-    const deployedComponent = resolveComponentOrExit(args.component);
-    const deployedUrls = deployedComponent.urls;
-    componentName = deployedComponent.componentName;
-    if (!args.skipBuild) {
-      if (!urls || buildEnvironmentChanged(urls, deployedUrls)) {
-        console.log("");
-        console.log(
-          "   Site URL changed after backend deployment. Rebuilding with the new environment...",
-        );
-        try {
-          runFrontendBuild(args, deployedUrls);
-        } catch {
-          console.error("");
-          console.error("❌ Rebuild failed after backend URL change");
-          process.exit(1);
-        }
-        console.log("");
-        console.log("   ✓ Rebuild complete");
-      }
-    }
-    urls = deployedUrls;
-  } else {
-    console.log("");
-    console.log("Step 3: Skipping Convex deployment (--skip-convex or already deployed)");
-  }
-
-  // Step 4: Deploy static files
-  console.log("");
-  console.log("Step 4: Deploying static files to Convex storage...");
-
-  const distDir = resolve(args.dist);
-
-  if (!existsSync(distDir)) {
-    console.error("");
-    console.error(`❌ Dist directory not found: ${distDir}`);
-    console.error("   Run build first or check --dist path");
-    process.exit(1);
-  }
-
-  // Pass the resolved instance name to the upload subprocess so it targets the
-  // same component (and doesn't re-probe or re-warn).
-  const staticDeploySuccess = await uploadToConvexStorage({
-    ...args,
-    dist: distDir,
-    component: componentName,
-  });
-
-  if (!staticDeploySuccess) {
-    console.error("");
-    console.error("❌ Static file upload failed");
-    process.exit(1);
-  }
-
-  // Done!
-  const duration = ((Date.now() - startTime) / 1000).toFixed(1);
-
-  console.log("");
-  console.log("═══════════════════════════════════════════════════════════");
-  console.log(`✨ Deployment complete! (${duration}s)`);
-  console.log("");
-
-  const finalUrls = urls ?? resolveComponentOrExit(args.component).urls;
-  console.log(`Frontend: ${finalUrls.siteUrl}`);
-
-  console.log("");
-}
-
-main().catch((error) => {
-  console.error("Deployment failed:", error);
-  process.exit(1);
-});

package/src/cli/deployEnvironment.test.ts

@@ -1,27 +0,0 @@
-import { describe, expect, test } from "vite-plus/test";
-import { buildEnvironmentChanged } from "./deployEnvironment.js";
-
-describe("deploy build environment", () => {
-  test("detects a mount-prefix change after backend deployment", () => {
-    expect(
-      buildEnvironmentChanged(
-        {
-          siteUrl: "https://example.convex.site/old/",
-          cloudUrl: "https://example.convex.cloud",
-        },
-        {
-          siteUrl: "https://example.convex.site/new/",
-          cloudUrl: "https://example.convex.cloud",
-        },
-      ),
-    ).toBe(true);
-  });
-
-  test("does not rebuild when the build environment is unchanged", () => {
-    const urls = {
-      siteUrl: "https://example.convex.site/app/",
-      cloudUrl: "https://example.convex.cloud",
-    };
-    expect(buildEnvironmentChanged(urls, urls)).toBe(false);
-  });
-});

package/src/cli/deployEnvironment.ts

@@ -1,17 +0,0 @@
-export interface DeploymentUrls {
-  siteUrl: string;
-  cloudUrl: string;
-}
-
-export function buildEnvironment(urls: DeploymentUrls) {
-  return {
-    cloudUrl: urls.cloudUrl,
-    basePath: new URL(urls.siteUrl).pathname || "/",
-  };
-}
-
-export function buildEnvironmentChanged(before: DeploymentUrls, after: DeploymentUrls): boolean {
-  const previous = buildEnvironment(before);
-  const next = buildEnvironment(after);
-  return previous.cloudUrl !== next.cloudUrl || previous.basePath !== next.basePath;
-}

package/src/cli/index.ts

@@ -1,65 +0,0 @@
-#!/usr/bin/env node
-/**
- * CLI for Convex Hosting
- *
- * Commands:
- *   deploy              One-shot deployment (Convex backend + static files)
- *   upload              Upload static files to Convex storage
- */
-
-const command = process.argv[2];
-
-async function main() {
-  switch (command) {
-    case "deploy":
-      // Pass remaining args to deploy command
-      process.argv.splice(2, 1);
-      await import("./deploy.js");
-      break;
-
-    case "upload":
-      // Pass remaining args to upload command
-      process.argv.splice(2, 1);
-      await import("./upload.js");
-      break;
-
-    case "--help":
-    case "-h":
-    case undefined:
-      printHelp();
-      break;
-
-    default:
-      console.error(`Unknown command: ${command}`);
-      console.log("");
-      printHelp();
-      process.exit(1);
-  }
-}
-
-function printHelp() {
-  console.log(`
-Convex Hosting CLI
-
-Usage:
-  npx @samebase/convex-hosting <command> [options]
-
-Commands:
-  deploy              One-shot deployment (Convex backend + static files)
-  upload              Upload static files to Convex storage
-
-Examples:
-  # One-shot deployment
-  npx @samebase/convex-hosting deploy
-
-  # Upload only (no Convex backend deploy)
-  npx @samebase/convex-hosting upload --build --prod
-
-Run '<command> --help' for more information on a specific command.
-`);
-}
-
-main().catch((err) => {
-  console.error("Error:", err);
-  process.exit(1);
-});