Skip to content

Self-hosted, plugin-based server management.

4.3 KB
Raw Blame
import type { DatabaseDialect } from "./dialect.js";
import type { PortableDatabase } from "../repositories/database-context.js";

export const DATABASE_URL_ENV = "DATABASE_URL";
export const DATABASE_POOL_MAX_ENV = "DATABASE_POOL_MAX";
export const DATABASE_SSL_ENV = "DATABASE_SSL";

const DEFAULT_POOL_MAX = 10;

/**
 * Pool size. Both drivers default to 10; this exists so an install that runs
 * several replicas against one server can keep the total connection count under
 * the server's own limit, which is the usual thing to hit first.
 */
export function poolMax(env: NodeJS.ProcessEnv = process.env): number {
  const raw = env[DATABASE_POOL_MAX_ENV]?.trim();
  if (!raw) return DEFAULT_POOL_MAX;

  const parsed = Number(raw);
  if (!Number.isInteger(parsed) || parsed < 1) {
    throw new Error(
      `${DATABASE_POOL_MAX_ENV} must be a positive integer, got "${raw}".`,
    );
  }
  return parsed;
}

/**
 * TLS mode.
 *
 * "require" verifies the server certificate; "no-verify" encrypts without
 * checking it, which is what a self-signed certificate on a private network
 * needs. Unset means no TLS, preserving the behaviour of every install that
 * predates this setting.
 */
export function sslOption(
  env: NodeJS.ProcessEnv = process.env,
): false | { rejectUnauthorized: boolean } {
  const raw = env[DATABASE_SSL_ENV]?.trim().toLowerCase();
  if (!raw || raw === "false" || raw === "disable") return false;

  if (raw === "true" || raw === "require") return { rejectUnauthorized: true };
  if (raw === "no-verify") return { rejectUnauthorized: false };

  throw new Error(
    `Unsupported ${DATABASE_SSL_ENV}: "${raw}". Expected require, no-verify, or disable.`,
  );
}

/**
 * Opens a connection to a client-server engine.
 *
 * SQLite is not handled here, it has its own lifecycle in db/index.ts, where
 * the database is decrypted into memory and serialised back to a file. This
 * covers the engines that connect to something already running.
 *
 * The returned handle is typed as PortableDatabase; see the note there on why
 * that is an approximation and what guarantees it.
 */
export function databaseUrl(env: NodeJS.ProcessEnv = process.env): string | null {
  const url = env[DATABASE_URL_ENV]?.trim();
  return url ? url : null;
}

/**
 * Checks the connection string suits the configured engine before trying to
 * open it, so a mismatch fails with something readable rather than a driver
 * error thirty frames down.
 */
export function assertUrlMatchesDialect(
  url: string,
  dialect: DatabaseDialect,
): void {
  const scheme = url.split("://", 1)[0].toLowerCase();

  const expected: Record<string, readonly string[]> = {
    postgres: ["postgres", "postgresql"],
    mysql: ["mysql", "mariadb"],
  };

  const allowed = expected[dialect];
  if (!allowed) {
    throw new Error(`${dialect} does not use ${DATABASE_URL_ENV}`);
  }

  if (!allowed.includes(scheme)) {
    throw new Error(
      `${DATABASE_URL_ENV} is a "${scheme}://" URL but DATABASE_DIALECT is "${dialect}". ` +
        `Expected one of ${allowed.map((s) => `${s}://`).join(", ")}.`,
    );
  }
}

export async function connectRemoteDatabase(
  dialect: DatabaseDialect,
  env: NodeJS.ProcessEnv = process.env,
): Promise<PortableDatabase> {
  const url = databaseUrl(env);
  if (!url) {
    throw new Error(
      `${DATABASE_URL_ENV} must be set when DATABASE_DIALECT is "${dialect}".`,
    );
  }

  assertUrlMatchesDialect(url, dialect);

  const max = poolMax(env);
  const ssl = sslOption(env);

  // No `schema` option: it only feeds drizzle's relational query API
  // (`db.query.*`), which nothing here uses. The query builder takes its table
  // names and value encoders from the table objects the repositories import,
  // see the note in schema.pg.ts on why the generated schemas are DDL-only.
  if (dialect === "postgres") {
    const { drizzle } = await import("drizzle-orm/node-postgres");
    return drizzle({
      connection: { connectionString: url, max, ...(ssl ? { ssl } : {}) },
    }) as unknown as PortableDatabase;
  }

  // mysql2 names the pool limit differently and wants no `ssl` key at all when
  // TLS is off, passing false is not the same as omitting it.
  const { drizzle } = await import("drizzle-orm/mysql2");
  return drizzle({
    connection: {
      uri: url,
      connectionLimit: max,
      ...(ssl ? { ssl } : {}),
    },
  }) as unknown as PortableDatabase;
}