@openstax/ts-utils 1.20.5 → 1.21.1

package/dist/cjs/services/postgresConnection/index.d.ts

@@ -0,0 +1,35 @@
+import postgres, { Sql } from 'postgres';
+import { ConfigProviderForConfig } from '../../config';
+import type { Logger } from '../logger';
+declare type Config = {
+    host: string;
+    readHost: string;
+    port: string;
+    database: string;
+    username: string;
+    password: string;
+};
+interface Initializer<C> {
+    configSpace?: C;
+}
+export declare const postgresConnection: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [key in C]: {
+    host: import("../../config").ConfigValueProvider<string>;
+    readHost: import("../../config").ConfigValueProvider<string>;
+    port: import("../../config").ConfigValueProvider<string>;
+    database: import("../../config").ConfigValueProvider<string>;
+    username: import("../../config").ConfigValueProvider<string>;
+    password: import("../../config").ConfigValueProvider<string>;
+}; }) => (services: {
+    logger: Logger;
+}) => {
+    db: () => Promise<postgres.Sql<{}>>;
+    dbRead: () => Promise<postgres.Sql<{}>>;
+    migrate: (migrations: Migration[]) => Promise<void>;
+    down: () => Promise<void[]>;
+};
+export declare type PostgresConnection = ReturnType<ReturnType<ReturnType<typeof postgresConnection>>>;
+export interface Migration {
+    name: string;
+    up: (db: Sql) => Promise<void>;
+}
+export {};

package/dist/cjs/services/postgresConnection/index.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postgresConnection = void 0;
+const postgres_1 = __importDefault(require("postgres"));
+const assertions_1 = require("../../assertions");
+const config_1 = require("../../config");
+const guards_1 = require("../../guards");
+const helpers_1 = require("../../misc/helpers");
+const postgresConnection = (initializer) => (configProvider) => {
+    const config = configProvider[(0, guards_1.ifDefined)(initializer.configSpace, 'local')];
+    const host = (0, helpers_1.once)(() => (0, config_1.resolveConfigValue)(config.host));
+    const readHost = (0, helpers_1.once)(() => (0, config_1.resolveConfigValue)(config.readHost));
+    const connectionOptions = (0, helpers_1.once)(async () => ({
+        port: (0, assertions_1.assertNotNaN)(parseInt(await (0, config_1.resolveConfigValue)(config.port), 10), new Error('port must be a number')),
+        database: await (0, config_1.resolveConfigValue)(config.database),
+        username: await (0, config_1.resolveConfigValue)(config.username),
+        password: await (0, config_1.resolveConfigValue)(config.password),
+        transform: postgres_1.default.camel,
+    }));
+    const connections = [];
+    const sql = (0, helpers_1.once)(async () => {
+        const options = await connectionOptions();
+        const connection = (0, postgres_1.default)({ ...options, host: await host() });
+        connections.push(connection);
+        return connection;
+    });
+    const sqlRead = (0, helpers_1.once)(async () => {
+        const options = await connectionOptions();
+        const connection = (0, postgres_1.default)({ ...options, host: await readHost() });
+        connections.push(connection);
+        return connection;
+    });
+    return (services) => ({
+        db: sql,
+        dbRead: sqlRead,
+        migrate: async (migrations) => {
+            await migrate(services, await sql(), migrations);
+        },
+        down: () => Promise.all(connections.map(c => c.end()))
+    });
+};
+exports.postgresConnection = postgresConnection;
+async function migrate(services, db, migrations) {
+    await db `
+    CREATE TABLE IF NOT EXISTS migrations (
+      id SERIAL PRIMARY KEY,
+      name TEXT NOT NULL,
+      ran_at TIMESTAMP NOT NULL DEFAULT NOW()
+    )
+  `;
+    const ranMigrations = await db `SELECT name FROM migrations`;
+    for (const migration of migrations) {
+        if (ranMigrations.some(({ name }) => name === migration.name)) {
+            continue;
+        }
+        services.logger.log(`Running migration ${migration.name}`);
+        await migration.up(db);
+        await db `INSERT INTO migrations (name) VALUES (${migration.name})`;
+    }
+}