myst/packages/cli/src/commands/doctor.ts
ZTatman a3c202a662 feat(cli): add config print, verify, and doctor commands for config validation
- myst config print: show current config with redacted secrets
- myst verify: verify Forgejo connectivity and API token
- myst doctor: comprehensive validation of config and connectivity
- add start script to service package.json
2026-04-09 20:40:55 -04:00

226 lines
5.7 KiB
TypeScript

import fs from "node:fs";
import path from "node:path";
import * as c from "yoctocolors";
import * as p from "@clack/prompts";
interface MystConfig {
publicUrl?: string;
adminUrl?: string;
databaseUrl?: string;
forgejoBaseUrl?: string;
forgejoBotUsername?: string;
forgejoPat?: string;
grantTokenSecret?: string;
}
function parseEnvFile(envPath: string): MystConfig {
const config: MystConfig = {};
const content = fs.readFileSync(envPath, "utf-8");
const lines = content.split("\n");
for (const line of lines) {
const trimmed = line.trim();
if (!trimmed || trimmed.startsWith("#")) continue;
const [key, ...valueParts] = trimmed.split("=");
if (!key) continue;
const value = valueParts.join("=").trim();
switch (key) {
case "MYST_PUBLIC_URL":
config.publicUrl = value;
break;
case "MYST_ADMIN_URL":
config.adminUrl = value;
break;
case "DATABASE_URL":
config.databaseUrl = value;
break;
case "FORGEJO_BASE_URL":
config.forgejoBaseUrl = value;
break;
case "FORGEJO_BOT_USERNAME":
config.forgejoBotUsername = value;
break;
case "FORGEJO_PAT":
config.forgejoPat = value;
break;
case "GRANT_TOKEN_SECRET":
config.grantTokenSecret = value;
break;
}
}
return config;
}
type CheckResult = {
name: string;
success: boolean;
message?: string;
};
async function checkForgejoReachability(baseUrl: string): Promise<CheckResult> {
try {
const response = await fetch(baseUrl, { method: "GET" });
if (response.ok || response.status === 200) {
return { name: "Forgejo reachability", success: true };
}
return {
name: "Forgejo reachability",
success: false,
message: `HTTP ${response.status}`,
};
} catch (error) {
const message = error instanceof Error ? error.message : "Unknown error";
return {
name: "Forgejo reachability",
success: false,
message,
};
}
}
async function checkForgejoApi(
baseUrl: string,
pat: string,
): Promise<CheckResult> {
try {
const response = await fetch(`${baseUrl}/api/v1/user`, {
method: "GET",
headers: {
Authorization: `Bearer ${pat}`,
},
});
if (response.status === 401) {
return {
name: "Forgejo API token",
success: false,
message: "Invalid or expired token",
};
}
if (!response.ok) {
return {
name: "Forgejo API token",
success: false,
message: `HTTP ${response.status}`,
};
}
const user = (await response.json()) as { login: string };
return {
name: "Forgejo API token",
success: true,
message: `Authenticated as ${c.green(user.login)}`,
};
} catch (error) {
const message = error instanceof Error ? error.message : "Unknown error";
return {
name: "Forgejo API token",
success: false,
message,
};
}
}
export async function doctorCommand(): Promise<void> {
p.intro(c.bold("myst doctor"));
const envPath = path.join(process.cwd(), ".env");
const results: CheckResult[] = [];
let config: MystConfig;
try {
config = parseEnvFile(envPath);
} catch (error) {
const err = error as NodeJS.ErrnoException;
if (err.code === "ENOENT") {
p.cancel(`${c.red("Error:")} .env file not found in ${process.cwd()}`);
process.exitCode = 1;
return;
}
throw error;
}
function addResult(name: string, success: boolean, message?: string) {
results.push({ name, success, ...(message && { message }) });
}
addResult("Config file exists", true, envPath);
const requiredFields = [
{ key: "publicUrl", name: "MYST_PUBLIC_URL" },
{ key: "adminUrl", name: "MYST_ADMIN_URL" },
{ key: "databaseUrl", name: "DATABASE_URL" },
{ key: "forgejoBaseUrl", name: "FORGEJO_BASE_URL" },
{ key: "forgejoBotUsername", name: "FORGEJO_BOT_USERNAME" },
{ key: "forgejoPat", name: "FORGEJO_PAT" },
{ key: "grantTokenSecret", name: "GRANT_TOKEN_SECRET" },
];
for (const field of requiredFields) {
const value = config[field.key as keyof MystConfig];
addResult(`${field.name} set`, !!value, value ? "configured" : "missing");
}
if (config.databaseUrl) {
try {
const url = new URL(config.databaseUrl);
const valid = url.protocol === "postgres:" ||
url.protocol === "postgresql:";
addResult("Database URL format", valid, valid ? "valid" : "invalid");
} catch {
addResult("Database URL format", false, "invalid format");
}
}
if (config.forgejoBaseUrl && config.forgejoPat) {
const reachability = await checkForgejoReachability(config.forgejoBaseUrl);
results.push(reachability);
if (reachability.success) {
const apiToken = await checkForgejoApi(
config.forgejoBaseUrl,
config.forgejoPat,
);
results.push(apiToken);
}
}
const s = p.spinner();
try {
s.start("Running diagnostics");
s.stop("Diagnostics complete");
const lines = results.map((r) => {
const icon = r.success ? c.green("✓") : c.red("✗");
const msg = r.message ? ` ${r.message}` : "";
return `${icon} ${r.name}${msg}`;
});
p.note(lines.join("\n"), c.yellow("Results"));
const failures = results.filter((r) => !r.success);
if (failures.length > 0) {
p.outro(c.red(`${failures.length} issue(s) found`));
process.exitCode = 1;
return;
}
p.outro(c.green("All checks passed"));
} catch (error) {
s.stop();
const message = error instanceof Error ? error.message : "Unknown error";
p.cancel(`${c.red("Error:")} ${message}`);
process.exitCode = 1;
}
}