openship 0.1.0 → 0.1.1

package/apps/api/src/modules/deployments/deployment.service.ts

@@ -1,23 +1,190 @@
 /**
- * Deployment service — orchestrates builds and deployments via adapters.
+ * Deployment service — deployment CRUD and runtime operations.
+ *
+ * Build pipeline logic lives in build.service.ts.
+ * SSL operations live in ssl.service.ts.
  */
 
-export async function queueDeployment(projectId: string, opts: { branch?: string }) {
-  // TODO: Create deployment record, push to BullMQ queue
+import { repos } from "@repo/db";
+import { NotFoundError, ForbiddenError } from "@repo/core";
+import type { LogEntry } from "@repo/adapters";
+import { platform } from "../../lib/controller-helpers";
+
+// ─── List deployments ────────────────────────────────────────────────────────
+
+export async function listDeployments(
+  userId: string,
+  opts: { projectId?: string; environment?: string; page?: number; perPage?: number },
+) {
+  if (opts.projectId) {
+    const project = await repos.project.findById(opts.projectId);
+    if (!project || project.userId !== userId) {
+      throw new NotFoundError("Project", opts.projectId);
+    }
+    return repos.deployment.listByProject(opts.projectId, {
+      page: opts.page,
+      perPage: opts.perPage,
+      environment: opts.environment,
+    });
+  }
+
+  // No projectId — return all deployments for this user, enriched with project names
+  const result = await repos.deployment.listByUser(userId, {
+    page: opts.page,
+    perPage: opts.perPage,
+  });
+
+  const projectIds = [...new Set(result.rows.map((d) => d.projectId))];
+  const projectMap = new Map<string, string>();
+  for (const pid of projectIds) {
+    const p = await repos.project.findById(pid);
+    if (p) projectMap.set(pid, p.name);
+  }
+
+  const enriched = result.rows.map((d) => ({
+    ...d,
+    projectName: projectMap.get(d.projectId) ?? "Unknown",
+  }));
+
+  return { ...result, rows: enriched };
 }
 
-export async function processDeployment(deploymentId: string) {
-  // TODO: Pull adapter (Docker / Oblien), build, deploy
+// ─── Get deployment ──────────────────────────────────────────────────────────
+
+export async function getDeployment(deploymentId: string, userId: string) {
+  const dep = await repos.deployment.findById(deploymentId);
+  if (!dep) throw new NotFoundError("Deployment", deploymentId);
+
+  const project = await repos.project.findById(dep.projectId);
+  if (!project || project.userId !== userId) {
+    throw new NotFoundError("Deployment", deploymentId);
+  }
+
+  return dep;
 }
 
-export async function getDeploymentLogs(deploymentId: string) {
-  // TODO: Fetch logs from adapter or storage
+// ─── Delete deployment ───────────────────────────────────────────────────────
+
+export async function deleteDeployment(deploymentId: string, userId: string) {
+  const dep = await getDeployment(deploymentId, userId);
+
+  if (["queued", "building", "deploying"].includes(dep.status)) {
+    throw new ForbiddenError("Cannot delete a deployment that is in progress. Cancel it first.");
+  }
+
+  // Stop and destroy running container if any
+  if (dep.containerId) {
+    const { runtime } = platform();
+    await runtime.stop(dep.containerId).catch(() => {});
+    await runtime.destroy(dep.containerId).catch(() => {});
+  }
+
+  // If this is the active deployment, clear it from the project
+  const project = await repos.project.findById(dep.projectId);
+  if (project && project.activeDeploymentId === deploymentId) {
+    await repos.project.setActiveDeployment(project.id, null);
+  }
+
+  await repos.deployment.deleteDeployment(deploymentId);
 }
 
-export async function rollbackDeployment(deploymentId: string) {
-  // TODO: Re-activate a previous deployment
+// ─── Rollback deployment ─────────────────────────────────────────────────────
+
+export async function rollbackDeployment(deploymentId: string, userId: string) {
+  const dep = await getDeployment(deploymentId, userId);
+
+  if (dep.status !== "ready") {
+    throw new ForbiddenError("Can only rollback to a successful deployment");
+  }
+
+  const project = await repos.project.findById(dep.projectId);
+  if (!project) throw new NotFoundError("Project", dep.projectId);
+
+  if (project.activeDeploymentId && project.activeDeploymentId !== deploymentId) {
+    const current = await repos.deployment.findById(project.activeDeploymentId);
+    if (current?.containerId) {
+      const { runtime } = platform();
+      await runtime.stop(current.containerId).catch(() => {});
+    }
+  }
+
+  await repos.project.setActiveDeployment(project.id, deploymentId);
+
+  if (dep.containerId) {
+    const { runtime } = platform();
+    await runtime.start(dep.containerId);
+  }
+
+  return dep;
 }
 
-export async function cancelDeployment(deploymentId: string) {
-  // TODO: Signal adapter to stop build
+// ─── Deployment logs ─────────────────────────────────────────────────────────
+
+export async function getDeploymentLogs(deploymentId: string, userId: string, tail?: number) {
+  const dep = await getDeployment(deploymentId, userId);
+
+  const buildSessions = await repos.deployment.findBuildSession(deploymentId);
+  if (buildSessions?.logs) {
+    return buildSessions.logs as LogEntry[];
+  }
+
+  if (dep.containerId) {
+    const { runtime } = platform();
+    return runtime.getRuntimeLogs(dep.containerId, tail);
+  }
+
+  return [];
+}
+
+// ─── Restart deployment ──────────────────────────────────────────────────────
+
+export async function restartDeployment(deploymentId: string, userId: string) {
+  const dep = await getDeployment(deploymentId, userId);
+
+  if (dep.status !== "ready") {
+    throw new ForbiddenError("Can only restart a running deployment");
+  }
+  if (!dep.containerId) {
+    throw new ForbiddenError("Deployment has no container");
+  }
+
+  const { runtime } = platform();
+  await runtime.stop(dep.containerId);
+  await runtime.start(dep.containerId);
+
+  return dep;
+}
+
+// ─── Container info ──────────────────────────────────────────────────────────
+
+export async function getContainerInfo(deploymentId: string, userId: string) {
+  const dep = await getDeployment(deploymentId, userId);
+  if (!dep.containerId) {
+    throw new ForbiddenError("Deployment has no container");
+  }
+  const { runtime } = platform();
+  return runtime.getContainerInfo(dep.containerId);
+}
+
+// ─── Container usage ─────────────────────────────────────────────────────────
+
+export async function getContainerUsage(deploymentId: string, userId: string) {
+  const dep = await getDeployment(deploymentId, userId);
+  if (!dep.containerId) {
+    throw new ForbiddenError("Deployment has no container");
+  }
+  const { runtime } = platform();
+  return runtime.getUsage(dep.containerId);
+}
+
+// ─── Build logs ──────────────────────────────────────────────────────────────
+
+export async function getBuildLogs(deploymentId: string, userId: string) {
+  await getDeployment(deploymentId, userId);
+
+  const buildSession = await repos.deployment.findBuildSession(deploymentId);
+  if (!buildSession?.logs) {
+    return [];
+  }
+  return buildSession.logs as LogEntry[];
 }

package/apps/api/src/modules/deployments/preflight.ts

@@ -0,0 +1,280 @@
+/**
+ * Pre-deploy checks — validate prerequisites before the build pipeline starts.
+ *
+ * Called after the user clicks Deploy but BEFORE any build work begins.
+ * If any check fails, the deployment is rejected with actionable errors —
+ * no resources are provisioned, no build session started.
+ *
+ * Checks are mode-aware (determined by snapshot flags):
+ *   - hasBuild=true:   validate install/build commands
+ *   - hasServer=true:  validate port + start command
+ *   - Both false:      plain static files, minimal checks
+ *
+ * Domain check: if a custom domain is provided, verifies the CNAME record
+ * points to edge.openship.io before allowing the build to start.
+ */
+
+import type { DeploymentConfigSnapshot } from "./build.service";
+import { platform } from "../../lib/controller-helpers";
+import type { CloudRuntime } from "@repo/adapters";
+import { SYSTEM } from "@repo/core";
+
+// ─── Types ───────────────────────────────────────────────────────────────────
+
+export interface PreflightCheck {
+    id: string;
+    label: string;
+    status: "pass" | "fail" | "warn";
+    message?: string;
+}
+
+export interface PreflightResult {
+    ok: boolean;
+    checks: PreflightCheck[];
+}
+
+export interface PreflightOptions {
+    customDomain?: string;
+    /** Free subdomain slug to validate format (e.g. "my-app" → my-app.opsh.io) */
+    slug?: string;
+}
+
+// ─── Individual checks ──────────────────────────────────────────────────────
+
+/** Validate that all required config fields are present based on mode. */
+function checkConfig(snapshot: DeploymentConfigSnapshot): PreflightCheck {
+    const missing: string[] = [];
+
+    if (!snapshot.repoUrl && !snapshot.localPath) missing.push("repository URL or local path");
+    if (!snapshot.branch && !snapshot.localPath) missing.push("branch");
+    if (!snapshot.buildImage) missing.push("build image");
+
+    // Build mode requires install command
+    if (snapshot.hasBuild) {
+        if (!snapshot.installCommand) missing.push("install command");
+    }
+
+    // Server mode requires start command and port
+    if (snapshot.hasServer) {
+        if (!snapshot.startCommand) missing.push("start command");
+        if (!snapshot.port) missing.push("port");
+    }
+
+    if (missing.length > 0) {
+        return {
+            id: "config",
+            label: "Build configuration",
+            status: "fail",
+            message: `Missing required fields: ${missing.join(", ")}`,
+        };
+    }
+
+    return { id: "config", label: "Build configuration", status: "pass" };
+}
+
+/** Validate stack-specific requirements based on hasBuild + hasServer. */
+function checkStack(snapshot: DeploymentConfigSnapshot): PreflightCheck {
+    if (!snapshot.hasServer && snapshot.startCommand) {
+        return {
+            id: "stack",
+            label: "Stack configuration",
+            status: "warn",
+            message: "Static site has a start command configured — it will be ignored. Files will be served from the edge.",
+        };
+    }
+
+    if (snapshot.hasBuild && !snapshot.buildCommand) {
+        return {
+            id: "stack",
+            label: "Stack configuration",
+            status: "warn",
+            message: "Build is enabled but no build command configured — deployment will use source files directly.",
+        };
+    }
+
+    if (!snapshot.hasBuild && snapshot.buildCommand) {
+        return {
+            id: "stack",
+            label: "Stack configuration",
+            status: "warn",
+            message: "Build is disabled but a build command exists — it will be skipped.",
+        };
+    }
+
+    return { id: "stack", label: "Stack configuration", status: "pass" };
+}
+
+/**
+ * Check subdomain slug availability via Oblien's checkSlug API.
+ * Cloud only — skipped in self-hosted mode.
+ */
+async function checkSlug(slug: string): Promise<PreflightCheck> {
+    const { target, runtime } = platform();
+    if (target !== "cloud") {
+        return { id: "slug-available", label: "Subdomain availability", status: "pass" };
+    }
+
+    try {
+        const cloud = runtime as CloudRuntime;
+        const result = await cloud.checkSlug(slug);
+
+        console.log("Slug check result:", result);
+        if (result.available) {
+            return { id: "slug-available", label: "Subdomain availability", status: "pass" };
+        }
+
+        return {
+            id: "slug-available",
+            label: "Subdomain availability",
+            status: "fail",
+            message: `"${slug}.${SYSTEM.DOMAINS.CLOUD_DOMAIN}" is already taken. Choose a different subdomain.`,
+        };
+    } catch {
+        // Don't block deploy if the check itself fails — conflict will surface at expose time
+        return { id: "slug-available", label: "Subdomain availability", status: "warn", message: "Could not verify subdomain availability" };
+    }
+}
+
+/**
+ * Verify a custom domain's DNS configuration via Oblien's verify API.
+ * Falls back to local DNS CNAME check in self-hosted mode.
+ */
+async function checkCustomDomain(customDomain: string): Promise<PreflightCheck> {
+    const { target, runtime } = platform();
+
+    // Cloud mode: use Oblien SDK for DNS validation
+    if (target === "cloud") {
+        try {
+            const cloud = runtime as CloudRuntime;
+            const result = await cloud.verifyDomain(customDomain);
+
+            if (result.verified) {
+                return { id: "domain", label: "Domain DNS", status: "pass" };
+            }
+
+            const errorMsg = result.errors.length > 0
+                ? result.errors.join("; ")
+                : `DNS not configured for ${customDomain}. Add a CNAME record pointing to ${result.requiredRecords.cname.target}`;
+
+            return {
+                id: "domain",
+                label: "Domain DNS",
+                status: "fail",
+                message: errorMsg,
+            };
+        } catch {
+            // Fall through to local check if Oblien validation fails
+        }
+    }
+
+    // Self-hosted / fallback: local DNS CNAME check
+    try {
+        const dns = await import("node:dns/promises");
+        const records = await dns.resolveCname(customDomain);
+        const pointsToEdge = records.some(
+            (r) => r.toLowerCase() === "edge.openship.io",
+        );
+
+        if (pointsToEdge) {
+            return { id: "domain", label: "Domain DNS", status: "pass" };
+        }
+
+        return {
+            id: "domain",
+            label: "Domain DNS",
+            status: "fail",
+            message: `CNAME for ${customDomain} does not point to edge.openship.io. Current target: ${records.join(", ") || "none"}`,
+        };
+    } catch {
+        return {
+            id: "domain",
+            label: "Domain DNS",
+            status: "fail",
+            message: `No CNAME record found for ${customDomain}. Add a CNAME record pointing to edge.openship.io`,
+        };
+    }
+}
+
+// ─── Main entry point ───────────────────────────────────────────────────────
+
+/** Validate slug format for subdomain use (slug.opsh.io). */
+function checkSlugFormat(slug: string): PreflightCheck {
+    if (slug.length < 1 || slug.length > 63) {
+        return {
+            id: "slug",
+            label: "Subdomain",
+            status: "fail",
+            message: `Slug must be between 1 and 63 characters (got ${slug.length}).`,
+        };
+    }
+
+    if (!/^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(slug)) {
+        return {
+            id: "slug",
+            label: "Subdomain",
+            status: "fail",
+            message: `"${slug}" is not a valid subdomain. Use only lowercase letters, numbers, and hyphens. Must start and end with a letter or number.`,
+        };
+    }
+
+    return { id: "slug", label: "Subdomain", status: "pass" };
+}
+
+/** Verify that cloud runtime credentials are valid and the account is active. */
+async function checkCloudRuntime(): Promise<PreflightCheck> {
+    const { target, runtime } = platform();
+    if (target !== "cloud") {
+        return { id: "runtime", label: "Runtime", status: "pass" };
+    }
+
+    try {
+        const cloud = runtime as CloudRuntime;
+        await cloud.getQuota();
+        return { id: "runtime", label: "Cloud runtime", status: "pass" };
+    } catch (err) {
+        const msg = err instanceof Error ? err.message : String(err);
+        return {
+            id: "runtime",
+            label: "Cloud runtime",
+            status: "fail",
+            message: `Cannot connect to cloud runtime: ${msg}`,
+        };
+    }
+}
+
+/**
+ * Run all pre-deploy checks for a config snapshot.
+ *
+ * Returns { ok, checks } — ok is false if ANY check has status "fail".
+ * Warnings don't block deployment.
+ */
+export async function runPreflightChecks(
+    snapshot: DeploymentConfigSnapshot,
+    opts?: PreflightOptions,
+): Promise<PreflightResult> {
+    const checks: PreflightCheck[] = [
+        checkConfig(snapshot),
+        checkStack(snapshot),
+    ];
+
+    // Validate slug format + availability — skip when using custom domain
+    // since the free subdomain won't be exposed
+    if (opts?.slug && !opts?.customDomain) {
+        checks.push(checkSlugFormat(opts.slug));
+        checks.push(await checkSlug(opts.slug));
+    }
+
+    // Verify cloud runtime credentials are working
+    checks.push(await checkCloudRuntime());
+
+    // Verify custom domain DNS records
+    if (opts?.customDomain) {
+        checks.push(await checkCustomDomain(opts.customDomain));
+    }
+    
+
+    return {
+        ok: checks.every((c) => c.status !== "fail"),
+        checks,
+    };
+}