postgresai 0.14.0-dev.37 → 0.14.0-dev.39

package/bin/postgres-ai.ts

@@ -17,10 +17,68 @@ import { startMcpServer } from "../lib/mcp-server";
 import { fetchIssues, fetchIssueComments, createIssueComment, fetchIssue } from "../lib/issues";
 import { resolveBaseUrls } from "../lib/util";
 import { applyInitPlan, buildInitPlan, connectWithSslFallback, DEFAULT_MONITORING_USER, redactPasswordsInSql, resolveAdminConnection, resolveMonitoringPassword, verifyInitSetup } from "../lib/init";
+import { REPORT_GENERATORS, CHECK_INFO, generateAllReports } from "../lib/checkup";
+import { createCheckupReport, uploadCheckupReportJson, RpcError, formatRpcErrorForDisplay } from "../lib/checkup-api";
 
 const execPromise = promisify(exec);
 const execFilePromise = promisify(execFile);
 
+function expandHomePath(p: string): string {
+  const s = (p || "").trim();
+  if (!s) return s;
+  if (s === "~") return os.homedir();
+  if (s.startsWith("~/") || s.startsWith("~\\")) {
+    return path.join(os.homedir(), s.slice(2));
+  }
+  return s;
+}
+
+function createTtySpinner(
+  enabled: boolean,
+  initialText: string
+): { update: (text: string) => void; stop: (finalText?: string) => void } {
+  if (!enabled) {
+    return {
+      update: () => {},
+      stop: () => {},
+    };
+  }
+
+  const frames = ["|", "/", "-", "\\"];
+  const startTs = Date.now();
+  let text = initialText;
+  let frameIdx = 0;
+  let stopped = false;
+
+  const render = (): void => {
+    if (stopped) return;
+    const elapsedSec = ((Date.now() - startTs) / 1000).toFixed(1);
+    const frame = frames[frameIdx % frames.length]!;
+    frameIdx += 1;
+    process.stdout.write(`\r\x1b[2K${frame} ${text} (${elapsedSec}s)`);
+  };
+
+  const timer = setInterval(render, 120);
+  render(); // immediate feedback
+
+  return {
+    update: (t: string) => {
+      text = t;
+      render();
+    },
+    stop: (finalText?: string) => {
+      if (stopped) return;
+      stopped = true;
+      clearInterval(timer);
+      process.stdout.write("\r\x1b[2K");
+      if (finalText && finalText.trim()) {
+        process.stdout.write(finalText);
+      }
+      process.stdout.write("\n");
+    },
+  };
+}
+
 /**
  * CLI configuration options
  */
@@ -202,6 +260,20 @@ program
     "UI base URL for browser routes (overrides PGAI_UI_BASE_URL)"
   );
 
+program
+  .command("set-default-project <project>")
+  .description("store default project for checkup uploads")
+  .action(async (project: string) => {
+    const value = (project || "").trim();
+    if (!value) {
+      console.error("Error: project is required");
+      process.exitCode = 1;
+      return;
+    }
+    config.writeConfig({ defaultProject: value });
+    console.log(`Default project saved: ${value}`);
+  });
+
 program
   .command("prepare-db [conn]")
   .description("Prepare database for monitoring: create monitoring user, required view(s), and grant permissions (idempotent)")
@@ -529,6 +601,221 @@ program
     }
   });
 
+program
+  .command("checkup [conn]")
+  .description("generate health check reports directly from PostgreSQL (express mode)")
+  .option("--check-id <id>", `specific check to run: ${Object.keys(CHECK_INFO).join(", ")}, or ALL`, "ALL")
+  .option("--node-name <name>", "node name for reports", "node-01")
+  .option("--output <path>", "output directory for JSON files")
+  .option("--upload", "create a remote checkup report and upload JSON results (requires API key)", false)
+  .option("--project <project>", "project name or ID for remote upload (used with --upload; defaults to config defaultProject)")
+  .addHelpText(
+    "after",
+    [
+      "",
+      "Available checks:",
+      ...Object.entries(CHECK_INFO).map(([id, title]) => `  ${id}: ${title}`),
+      "",
+      "Examples:",
+      "  postgresai checkup postgresql://user:pass@host:5432/db",
+      "  postgresai checkup postgresql://user:pass@host:5432/db --check-id A003",
+      "  postgresai checkup postgresql://user:pass@host:5432/db --output ./reports",
+      "  postgresai checkup postgresql://user:pass@host:5432/db --upload --project my_project",
+      "  postgresai set-default-project my_project",
+      "  postgresai checkup postgresql://user:pass@host:5432/db --upload",
+    ].join("\n")
+  )
+  .action(async (conn: string | undefined, opts: {
+    checkId: string;
+    nodeName: string;
+    output?: string;
+    upload?: boolean;
+    project?: string;
+  }, cmd: Command) => {
+    if (!conn) {
+      // No args — show help like other commands do (instead of a bare error).
+      cmd.outputHelp();
+      process.exitCode = 1;
+      return;
+    }
+
+    // Preflight: validate/create output directory BEFORE connecting / running checks.
+    // This avoids waiting on network/DB work only to fail at the very end.
+    let outputPath: string | undefined;
+    if (opts.output) {
+      const outputDir = expandHomePath(opts.output);
+      outputPath = path.isAbsolute(outputDir) ? outputDir : path.resolve(process.cwd(), outputDir);
+      if (!fs.existsSync(outputPath)) {
+        try {
+          fs.mkdirSync(outputPath, { recursive: true });
+        } catch (e) {
+          const errAny = e as any;
+          const code = typeof errAny?.code === "string" ? errAny.code : "";
+          const msg = errAny instanceof Error ? errAny.message : String(errAny);
+          if (code === "EACCES" || code === "EPERM" || code === "ENOENT") {
+            console.error(`Error: Failed to create output directory: ${outputPath}`);
+            console.error(`Reason: ${msg}`);
+            console.error("Tip: choose a writable path, e.g. --output ./reports or --output ~/reports");
+            process.exitCode = 1;
+            return;
+          }
+          throw e;
+        }
+      }
+    }
+
+    // Preflight: validate upload flags/credentials BEFORE connecting / running checks.
+    // This allows "fast-fail" for missing API key / project name.
+    let uploadCfg:
+      | { apiKey: string; apiBaseUrl: string; project: string; epoch: number }
+      | undefined;
+    if (opts.upload) {
+      const rootOpts = program.opts() as CliOptions;
+      const { apiKey } = getConfig(rootOpts);
+      if (!apiKey) {
+        console.error("Error: API key is required for --upload");
+        console.error("Tip: run 'postgresai auth' or pass --api-key / set PGAI_API_KEY");
+        process.exitCode = 1;
+        return;
+      }
+
+      const cfg = config.readConfig();
+      const { apiBaseUrl } = resolveBaseUrls(rootOpts, cfg);
+      const project = ((opts.project || cfg.defaultProject) || "").trim();
+      if (!project) {
+        console.error("Error: --project is required (or set a default via 'postgresai set-default-project <project>')");
+        process.exitCode = 1;
+        return;
+      }
+      const epoch = Math.floor(Date.now() / 1000);
+      uploadCfg = {
+        apiKey,
+        apiBaseUrl,
+        project,
+        epoch,
+      };
+    }
+
+    // Use the same SSL behavior as prepare-db:
+    // - Default: sslmode=prefer (try SSL first, fallback to non-SSL)
+    // - Respect PGSSLMODE env and ?sslmode=... in connection URI
+    const adminConn = resolveAdminConnection({
+      conn,
+      envPassword: process.env.PGPASSWORD,
+    });
+    let client: Client | undefined;
+    const spinnerEnabled = !!process.stdout.isTTY && !!opts.upload;
+    const spinner = createTtySpinner(spinnerEnabled, "Connecting to Postgres");
+
+    try {
+      spinner.update("Connecting to Postgres");
+      const connResult = await connectWithSslFallback(Client, adminConn);
+      client = connResult.client as Client;
+
+      let reports: Record<string, any>;
+      let uploadSummary:
+        | { project: string; reportId: number; uploaded: Array<{ checkId: string; filename: string; chunkId: number }> }
+        | undefined;
+
+      if (opts.checkId === "ALL") {
+        reports = await generateAllReports(client, opts.nodeName, (p) => {
+          spinner.update(`Running ${p.checkId}: ${p.checkTitle} (${p.index}/${p.total})`);
+        });
+      } else {
+        const checkId = opts.checkId.toUpperCase();
+        const generator = REPORT_GENERATORS[checkId];
+        if (!generator) {
+          spinner.stop();
+          console.error(`Unknown check ID: ${opts.checkId}`);
+          console.error(`Available: ${Object.keys(CHECK_INFO).join(", ")}, ALL`);
+          process.exitCode = 1;
+          return;
+        }
+        spinner.update(`Running ${checkId}: ${CHECK_INFO[checkId] || checkId}`);
+        reports = { [checkId]: await generator(client, opts.nodeName) };
+      }
+
+      // Optional: upload to PostgresAI API.
+      if (uploadCfg) {
+        spinner.update("Creating remote checkup report");
+        const created = await createCheckupReport({
+          apiKey: uploadCfg.apiKey,
+          apiBaseUrl: uploadCfg.apiBaseUrl,
+          project: uploadCfg.project,
+          epoch: uploadCfg.epoch,
+        });
+
+        const reportId = created.reportId;
+        // Keep upload progress out of stdout since JSON is output to stdout.
+        const logUpload = (msg: string): void => {
+          console.error(msg);
+        };
+        logUpload(`Created remote checkup report: ${reportId}`);
+
+        const uploaded: Array<{ checkId: string; filename: string; chunkId: number }> = [];
+        for (const [checkId, report] of Object.entries(reports)) {
+          spinner.update(`Uploading ${checkId}.json`);
+          const jsonText = JSON.stringify(report, null, 2);
+          const r = await uploadCheckupReportJson({
+            apiKey: uploadCfg.apiKey,
+            apiBaseUrl: uploadCfg.apiBaseUrl,
+            reportId,
+            filename: `${checkId}.json`,
+            checkId,
+            jsonText,
+          });
+          uploaded.push({ checkId, filename: `${checkId}.json`, chunkId: r.reportChunkId });
+        }
+        logUpload("Upload completed");
+        uploadSummary = { project: uploadCfg.project, reportId, uploaded };
+      }
+
+      spinner.stop();
+      // Output results
+      if (opts.output) {
+        // Write to files
+        // outputPath is preflight-validated above
+        const outDir = outputPath || path.resolve(process.cwd(), expandHomePath(opts.output));
+        for (const [checkId, report] of Object.entries(reports)) {
+          const filePath = path.join(outDir, `${checkId}.json`);
+          fs.writeFileSync(filePath, JSON.stringify(report, null, 2), "utf8");
+          console.log(`✓ ${checkId}: ${filePath}`);
+        }
+      } else if (uploadSummary) {
+        // With --upload: show upload result to stderr, JSON to stdout.
+        console.error("\nCheckup report uploaded");
+        console.error("======================\n");
+        console.error(`Project: ${uploadSummary.project}`);
+        console.error(`Report ID: ${uploadSummary.reportId}`);
+        console.error("View in Console: console.postgres.ai → Support → checkup reports");
+        console.error("");
+        console.error("Files:");
+        for (const item of uploadSummary.uploaded) {
+          console.error(`- ${item.checkId}: ${item.filename}`);
+        }
+        console.log(JSON.stringify(reports, null, 2));
+      } else {
+        // Default: output JSON to stdout
+        console.log(JSON.stringify(reports, null, 2));
+      }
+    } catch (error) {
+      spinner.stop();
+      if (error instanceof RpcError) {
+        for (const line of formatRpcErrorForDisplay(error)) {
+          console.error(line);
+        }
+      } else {
+        const message = error instanceof Error ? error.message : String(error);
+        console.error(`Error: ${message}`);
+      }
+      process.exitCode = 1;
+    } finally {
+      if (client) {
+        await client.end();
+      }
+    }
+  });
+
 /**
  * Stub function for not implemented commands
  */

package/dist/bin/postgres-ai.js

@@ -51,8 +51,61 @@ const mcp_server_1 = require("../lib/mcp-server");
 const issues_1 = require("../lib/issues");
 const util_2 = require("../lib/util");
 const init_1 = require("../lib/init");
+const checkup_1 = require("../lib/checkup");
+const checkup_api_1 = require("../lib/checkup-api");
 const execPromise = (0, util_1.promisify)(child_process_1.exec);
 const execFilePromise = (0, util_1.promisify)(child_process_1.execFile);
+function expandHomePath(p) {
+    const s = (p || "").trim();
+    if (!s)
+        return s;
+    if (s === "~")
+        return os.homedir();
+    if (s.startsWith("~/") || s.startsWith("~\\")) {
+        return path.join(os.homedir(), s.slice(2));
+    }
+    return s;
+}
+function createTtySpinner(enabled, initialText) {
+    if (!enabled) {
+        return {
+            update: () => { },
+            stop: () => { },
+        };
+    }
+    const frames = ["|", "/", "-", "\\"];
+    const startTs = Date.now();
+    let text = initialText;
+    let frameIdx = 0;
+    let stopped = false;
+    const render = () => {
+        if (stopped)
+            return;
+        const elapsedSec = ((Date.now() - startTs) / 1000).toFixed(1);
+        const frame = frames[frameIdx % frames.length];
+        frameIdx += 1;
+        process.stdout.write(`\r\x1b[2K${frame} ${text} (${elapsedSec}s)`);
+    };
+    const timer = setInterval(render, 120);
+    render(); // immediate feedback
+    return {
+        update: (t) => {
+            text = t;
+            render();
+        },
+        stop: (finalText) => {
+            if (stopped)
+                return;
+            stopped = true;
+            clearInterval(timer);
+            process.stdout.write("\r\x1b[2K");
+            if (finalText && finalText.trim()) {
+                process.stdout.write(finalText);
+            }
+            process.stdout.write("\n");
+        },
+    };
+}
 function getDefaultMonitoringProjectDir() {
     const override = process.env.PGAI_PROJECT_DIR;
     if (override && override.trim())
@@ -174,6 +227,19 @@ program
     .option("--api-key <key>", "API key (overrides PGAI_API_KEY)")
     .option("--api-base-url <url>", "API base URL for backend RPC (overrides PGAI_API_BASE_URL)")
     .option("--ui-base-url <url>", "UI base URL for browser routes (overrides PGAI_UI_BASE_URL)");
+program
+    .command("set-default-project <project>")
+    .description("store default project for checkup uploads")
+    .action(async (project) => {
+    const value = (project || "").trim();
+    if (!value) {
+        console.error("Error: project is required");
+        process.exitCode = 1;
+        return;
+    }
+    config.writeConfig({ defaultProject: value });
+    console.log(`Default project saved: ${value}`);
+});
 program
     .command("prepare-db [conn]")
     .description("Prepare database for monitoring: create monitoring user, required view(s), and grant permissions (idempotent)")
@@ -475,6 +541,203 @@ program
         }
     }
 });
+program
+    .command("checkup [conn]")
+    .description("generate health check reports directly from PostgreSQL (express mode)")
+    .option("--check-id <id>", `specific check to run: ${Object.keys(checkup_1.CHECK_INFO).join(", ")}, or ALL`, "ALL")
+    .option("--node-name <name>", "node name for reports", "node-01")
+    .option("--output <path>", "output directory for JSON files")
+    .option("--upload", "create a remote checkup report and upload JSON results (requires API key)", false)
+    .option("--project <project>", "project name or ID for remote upload (used with --upload; defaults to config defaultProject)")
+    .addHelpText("after", [
+    "",
+    "Available checks:",
+    ...Object.entries(checkup_1.CHECK_INFO).map(([id, title]) => `  ${id}: ${title}`),
+    "",
+    "Examples:",
+    "  postgresai checkup postgresql://user:pass@host:5432/db",
+    "  postgresai checkup postgresql://user:pass@host:5432/db --check-id A003",
+    "  postgresai checkup postgresql://user:pass@host:5432/db --output ./reports",
+    "  postgresai checkup postgresql://user:pass@host:5432/db --upload --project my_project",
+    "  postgresai set-default-project my_project",
+    "  postgresai checkup postgresql://user:pass@host:5432/db --upload",
+].join("\n"))
+    .action(async (conn, opts, cmd) => {
+    if (!conn) {
+        // No args — show help like other commands do (instead of a bare error).
+        cmd.outputHelp();
+        process.exitCode = 1;
+        return;
+    }
+    // Preflight: validate/create output directory BEFORE connecting / running checks.
+    // This avoids waiting on network/DB work only to fail at the very end.
+    let outputPath;
+    if (opts.output) {
+        const outputDir = expandHomePath(opts.output);
+        outputPath = path.isAbsolute(outputDir) ? outputDir : path.resolve(process.cwd(), outputDir);
+        if (!fs.existsSync(outputPath)) {
+            try {
+                fs.mkdirSync(outputPath, { recursive: true });
+            }
+            catch (e) {
+                const errAny = e;
+                const code = typeof errAny?.code === "string" ? errAny.code : "";
+                const msg = errAny instanceof Error ? errAny.message : String(errAny);
+                if (code === "EACCES" || code === "EPERM" || code === "ENOENT") {
+                    console.error(`Error: Failed to create output directory: ${outputPath}`);
+                    console.error(`Reason: ${msg}`);
+                    console.error("Tip: choose a writable path, e.g. --output ./reports or --output ~/reports");
+                    process.exitCode = 1;
+                    return;
+                }
+                throw e;
+            }
+        }
+    }
+    // Preflight: validate upload flags/credentials BEFORE connecting / running checks.
+    // This allows "fast-fail" for missing API key / project name.
+    let uploadCfg;
+    if (opts.upload) {
+        const rootOpts = program.opts();
+        const { apiKey } = getConfig(rootOpts);
+        if (!apiKey) {
+            console.error("Error: API key is required for --upload");
+            console.error("Tip: run 'postgresai auth' or pass --api-key / set PGAI_API_KEY");
+            process.exitCode = 1;
+            return;
+        }
+        const cfg = config.readConfig();
+        const { apiBaseUrl } = (0, util_2.resolveBaseUrls)(rootOpts, cfg);
+        const project = ((opts.project || cfg.defaultProject) || "").trim();
+        if (!project) {
+            console.error("Error: --project is required (or set a default via 'postgresai set-default-project <project>')");
+            process.exitCode = 1;
+            return;
+        }
+        const epoch = Math.floor(Date.now() / 1000);
+        uploadCfg = {
+            apiKey,
+            apiBaseUrl,
+            project,
+            epoch,
+        };
+    }
+    // Use the same SSL behavior as prepare-db:
+    // - Default: sslmode=prefer (try SSL first, fallback to non-SSL)
+    // - Respect PGSSLMODE env and ?sslmode=... in connection URI
+    const adminConn = (0, init_1.resolveAdminConnection)({
+        conn,
+        envPassword: process.env.PGPASSWORD,
+    });
+    let client;
+    const spinnerEnabled = !!process.stdout.isTTY && !!opts.upload;
+    const spinner = createTtySpinner(spinnerEnabled, "Connecting to Postgres");
+    try {
+        spinner.update("Connecting to Postgres");
+        const connResult = await (0, init_1.connectWithSslFallback)(pg_1.Client, adminConn);
+        client = connResult.client;
+        let reports;
+        let uploadSummary;
+        if (opts.checkId === "ALL") {
+            reports = await (0, checkup_1.generateAllReports)(client, opts.nodeName, (p) => {
+                spinner.update(`Running ${p.checkId}: ${p.checkTitle} (${p.index}/${p.total})`);
+            });
+        }
+        else {
+            const checkId = opts.checkId.toUpperCase();
+            const generator = checkup_1.REPORT_GENERATORS[checkId];
+            if (!generator) {
+                spinner.stop();
+                console.error(`Unknown check ID: ${opts.checkId}`);
+                console.error(`Available: ${Object.keys(checkup_1.CHECK_INFO).join(", ")}, ALL`);
+                process.exitCode = 1;
+                return;
+            }
+            spinner.update(`Running ${checkId}: ${checkup_1.CHECK_INFO[checkId] || checkId}`);
+            reports = { [checkId]: await generator(client, opts.nodeName) };
+        }
+        // Optional: upload to PostgresAI API.
+        if (uploadCfg) {
+            spinner.update("Creating remote checkup report");
+            const created = await (0, checkup_api_1.createCheckupReport)({
+                apiKey: uploadCfg.apiKey,
+                apiBaseUrl: uploadCfg.apiBaseUrl,
+                project: uploadCfg.project,
+                epoch: uploadCfg.epoch,
+            });
+            const reportId = created.reportId;
+            // Keep upload progress out of stdout since JSON is output to stdout.
+            const logUpload = (msg) => {
+                console.error(msg);
+            };
+            logUpload(`Created remote checkup report: ${reportId}`);
+            const uploaded = [];
+            for (const [checkId, report] of Object.entries(reports)) {
+                spinner.update(`Uploading ${checkId}.json`);
+                const jsonText = JSON.stringify(report, null, 2);
+                const r = await (0, checkup_api_1.uploadCheckupReportJson)({
+                    apiKey: uploadCfg.apiKey,
+                    apiBaseUrl: uploadCfg.apiBaseUrl,
+                    reportId,
+                    filename: `${checkId}.json`,
+                    checkId,
+                    jsonText,
+                });
+                uploaded.push({ checkId, filename: `${checkId}.json`, chunkId: r.reportChunkId });
+            }
+            logUpload("Upload completed");
+            uploadSummary = { project: uploadCfg.project, reportId, uploaded };
+        }
+        spinner.stop();
+        // Output results
+        if (opts.output) {
+            // Write to files
+            // outputPath is preflight-validated above
+            const outDir = outputPath || path.resolve(process.cwd(), expandHomePath(opts.output));
+            for (const [checkId, report] of Object.entries(reports)) {
+                const filePath = path.join(outDir, `${checkId}.json`);
+                fs.writeFileSync(filePath, JSON.stringify(report, null, 2), "utf8");
+                console.log(`✓ ${checkId}: ${filePath}`);
+            }
+        }
+        else if (uploadSummary) {
+            // With --upload: show upload result to stderr, JSON to stdout.
+            console.error("\nCheckup report uploaded");
+            console.error("======================\n");
+            console.error(`Project: ${uploadSummary.project}`);
+            console.error(`Report ID: ${uploadSummary.reportId}`);
+            console.error("View in Console: console.postgres.ai → Support → checkup reports");
+            console.error("");
+            console.error("Files:");
+            for (const item of uploadSummary.uploaded) {
+                console.error(`- ${item.checkId}: ${item.filename}`);
+            }
+            console.log(JSON.stringify(reports, null, 2));
+        }
+        else {
+            // Default: output JSON to stdout
+            console.log(JSON.stringify(reports, null, 2));
+        }
+    }
+    catch (error) {
+        spinner.stop();
+        if (error instanceof checkup_api_1.RpcError) {
+            for (const line of (0, checkup_api_1.formatRpcErrorForDisplay)(error)) {
+                console.error(line);
+            }
+        }
+        else {
+            const message = error instanceof Error ? error.message : String(error);
+            console.error(`Error: ${message}`);
+        }
+        process.exitCode = 1;
+    }
+    finally {
+        if (client) {
+            await client.end();
+        }
+    }
+});
 /**
  * Stub function for not implemented commands
  */