add automated neon postgres database setup

This commit is contained in:
Aman Varshney
2025-04-11 09:01:53 +05:30
parent bca3ec81f5
commit 0868672050
11 changed files with 260 additions and 17 deletions

View File

@@ -0,0 +1,194 @@
import path from "node:path";
import { cancel, isCancel, log, spinner, text } from "@clack/prompts";
import { execa } from "execa";
import fs from "fs-extra";
import pc from "picocolors";
import type { ProjectPackageManager } from "../types";
type NeonConfig = {
connectionString: string;
projectId: string;
dbName: string;
roleName: string;
};
function buildNeonCommand(
packageManager: string,
args: string[],
): { cmd: string; cmdArgs: string[] } {
let cmd: string;
let cmdArgs: string[];
switch (packageManager) {
case "pnpm":
cmd = "pnpm";
cmdArgs = ["dlx", "neonctl", ...args];
break;
case "bun":
cmd = "bunx";
cmdArgs = ["neonctl", ...args];
break;
default:
cmd = "npx";
cmdArgs = ["neonctl", ...args];
}
return { cmd, cmdArgs };
}
async function executeNeonCommand(
packageManager: string,
args: string[],
spinnerText?: string,
) {
const s = spinnerText ? spinner() : null;
try {
const { cmd, cmdArgs } = buildNeonCommand(packageManager, args);
if (s) s.start(spinnerText);
const result = await execa(cmd, cmdArgs);
if (s) s.stop();
return result;
} catch (error) {
if (s) s.stop(pc.red(`Failed: ${spinnerText}`));
throw error;
}
}
async function isNeonAuthenticated(packageManager: string) {
try {
const { stdout } = await executeNeonCommand(packageManager, [
"projects",
"list",
]);
return !stdout.includes("not authenticated") && !stdout.includes("error");
} catch {
return false;
}
}
async function authenticateWithNeon(packageManager: string) {
try {
await executeNeonCommand(
packageManager,
["auth"],
"Authenticating with Neon...",
);
log.success("Authenticated with Neon successfully!");
return true;
} catch (error) {
log.error(pc.red("Failed to authenticate with Neon"));
throw error;
}
}
async function createNeonProject(
projectName: string,
packageManager: string,
): Promise<NeonConfig | null> {
try {
const { stdout } = await executeNeonCommand(
packageManager,
["projects", "create", "--name", projectName, "--output", "json"],
`Creating Neon project "${projectName}"...`,
);
const response = JSON.parse(stdout);
if (
response.project &&
response.connection_uris &&
response.connection_uris.length > 0
) {
const projectId = response.project.id;
const connectionUri = response.connection_uris[0].connection_uri;
const params = response.connection_uris[0].connection_parameters;
return {
connectionString: connectionUri,
projectId: projectId,
dbName: params.database,
roleName: params.role,
};
}
log.error(pc.red("Failed to extract connection information from response"));
return null;
} catch (error) {
log.error(pc.red("Failed to create Neon project"));
throw error;
}
}
async function writeEnvFile(projectDir: string, config?: NeonConfig) {
const envPath = path.join(projectDir, "apps/server", ".env");
const envContent = config
? `DATABASE_URL="${config.connectionString}"`
: `DATABASE_URL="postgresql://postgres:postgres@localhost:5432/mydb?schema=public"`;
await fs.ensureDir(path.dirname(envPath));
await fs.writeFile(envPath, envContent);
return true;
}
function displayManualSetupInstructions() {
log.info(`Manual Neon PostgreSQL Setup Instructions:
1. Visit https://neon.tech and create an account
2. Create a new project from the dashboard
3. Get your connection string
4. Add the database URL to the .env file in apps/server/.env
DATABASE_URL="your_connection_string"`);
}
export async function setupNeonPostgres(
projectDir: string,
packageManager: ProjectPackageManager,
) {
const s = spinner();
try {
const isAuthenticated = await isNeonAuthenticated(packageManager);
if (!isAuthenticated) {
log.info("Please authenticate with Neon to continue:");
await authenticateWithNeon(packageManager);
}
const suggestedProjectName = path.basename(projectDir);
const projectName = await text({
message: "Enter a name for your Neon project:",
defaultValue: suggestedProjectName,
initialValue: suggestedProjectName,
});
if (isCancel(projectName)) {
cancel(pc.red("Operation cancelled"));
process.exit(0);
}
const config = await createNeonProject(
projectName as string,
packageManager,
);
if (!config) {
throw new Error(
"Failed to create project - couldn't get connection information",
);
}
await fs.ensureDir(path.join(projectDir, "apps/server"));
await writeEnvFile(projectDir, config);
log.success("Neon database configured successfully!");
} catch (error) {
s.stop(pc.red("Neon PostgreSQL setup failed"));
if (error instanceof Error) {
log.error(pc.red(error.message));
}
await writeEnvFile(projectDir);
displayManualSetupInstructions();
}
}