@prairielearn/postgres-tools 1.0.0

package/dist/diff.js

@@ -0,0 +1,167 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.diffDirectories = exports.diffDirectoryAndDatabase = exports.diffDatabaseAndDirectory = exports.diffDatabases = void 0;
+// @ts-check
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const node_path_1 = __importDefault(require("node:path"));
+const chalk_1 = __importDefault(require("chalk"));
+const lodash_1 = __importDefault(require("lodash"));
+const diff_1 = require("diff");
+const describe_1 = require("./describe");
+async function diff(db1, db2, options) {
+    function formatText(text, formatter) {
+        if (options.coloredOutput && formatter) {
+            return formatter(text);
+        }
+        return text;
+    }
+    const db2Name = db2.type === 'database' ? db2.name : db2.path;
+    const db2NameBold = formatText(db2Name, chalk_1.default.bold);
+    let result = '';
+    const description1 = await loadDescription(db1);
+    const description2 = await loadDescription(db2);
+    // Determine if both databases have the same tables
+    const tablesMissingFrom1 = lodash_1.default.difference(lodash_1.default.keys(description2.tables), lodash_1.default.keys(description1.tables));
+    const tablesMissingFrom2 = lodash_1.default.difference(lodash_1.default.keys(description1.tables), lodash_1.default.keys(description2.tables));
+    if (tablesMissingFrom1.length > 0) {
+        result += formatText(`Tables added to ${db2NameBold} (${db2.type})\n`, chalk_1.default.underline);
+        result += formatText(tablesMissingFrom1.map((table) => `+ ${table}`).join('\n') + '\n\n', chalk_1.default.green);
+    }
+    if (tablesMissingFrom2.length > 0) {
+        result += formatText(`Tables missing from ${db2NameBold} (${db2.type})\n`, chalk_1.default.underline);
+        result += formatText(tablesMissingFrom2.map((table) => `- ${table}`).join('\n') + '\n\n', chalk_1.default.red);
+    }
+    // Determine if both databases have the same enums
+    const enumsMissingFrom1 = lodash_1.default.difference(lodash_1.default.keys(description2.enums), lodash_1.default.keys(description1.enums));
+    const enumsMissingFrom2 = lodash_1.default.difference(lodash_1.default.keys(description1.enums), lodash_1.default.keys(description2.enums));
+    if (enumsMissingFrom1.length > 0) {
+        result += formatText(`Enums added to ${db2NameBold} (${db1.type})\n`, chalk_1.default.underline);
+        result += formatText(enumsMissingFrom1.map((enumName) => `+ ${enumName}`).join('\n') + '\n\n', chalk_1.default.green);
+    }
+    if (enumsMissingFrom2.length > 0) {
+        result += formatText(`Enums missing from ${db2NameBold} (${db2.type})\n`, chalk_1.default.underline);
+        result += formatText(enumsMissingFrom2.map((enumName) => `- ${enumName}`).join('\n') + '\n\n', chalk_1.default.red);
+    }
+    // Determine if the columns of any table differ
+    const intersection = lodash_1.default.intersection(lodash_1.default.keys(description1.tables), lodash_1.default.keys(description2.tables));
+    lodash_1.default.forEach(intersection, (table) => {
+        // We normalize each blob to end with a newline to make diffs print cleaner
+        const diff = (0, diff_1.diffLines)(description1.tables[table].trim() + '\n', description2.tables[table].trim() + '\n');
+        if (diff.length === 1)
+            return;
+        const boldTable = formatText(table, chalk_1.default.bold);
+        result += formatText(`Differences in ${boldTable} table\n`, chalk_1.default.underline);
+        // Shift around the newlines so that we can cleanly show +/- symbols
+        for (let i = 1; i < diff.length; i++) {
+            const prev = diff[i - 1].value;
+            if (prev[prev.length - 1] === '\n') {
+                diff[i - 1].value = prev.slice(0, -1);
+                diff[i].value = '\n' + diff[i].value;
+            }
+        }
+        lodash_1.default.forEach(diff, (part, index) => {
+            if (index === 0) {
+                part.value = '\n' + part.value;
+            }
+            const mark = part.added ? '+ ' : part.removed ? '- ' : '  ';
+            let change = part.value.split('\n').join(`\n${mark}`);
+            if (index === 0) {
+                change = change.slice(1, change.length);
+            }
+            if (part.added || part.removed) {
+                result += formatText(change, part.added ? chalk_1.default.green : part.removed ? chalk_1.default.red : null);
+            }
+        });
+        result += '\n\n';
+    });
+    // Determine if the values of any enums differ
+    const enumsIntersection = lodash_1.default.intersection(lodash_1.default.keys(description1.enums), lodash_1.default.keys(description2.enums));
+    lodash_1.default.forEach(enumsIntersection, (enumName) => {
+        // We don't need to do a particularly fancy diff here, since
+        // enums are just represented here as strings
+        if (description1.enums[enumName].trim() !== description2.enums[enumName].trim()) {
+            const boldEnum = formatText(enumName, chalk_1.default.bold);
+            result += formatText(`Differences in ${boldEnum} enum\n`);
+            result += formatText(`- ${description1.enums[enumName].trim()}\n`, chalk_1.default.red);
+            result += formatText(`+ ${description2.enums[enumName].trim()}\n`, chalk_1.default.green);
+            result += '\n\n';
+        }
+    });
+    return result;
+}
+async function loadDescriptionFromDisk(dirPath) {
+    const description = {
+        tables: {},
+        enums: {},
+    };
+    const tables = await fs_extra_1.default.readdir(node_path_1.default.join(dirPath, 'tables'));
+    for (const table of tables) {
+        const data = await fs_extra_1.default.readFile(node_path_1.default.join(dirPath, 'tables', table), 'utf8');
+        description.tables[table.replace('.pg', '')] = data;
+    }
+    const enums = await fs_extra_1.default.readdir(node_path_1.default.join(dirPath, 'enums'));
+    for (const enumName of enums) {
+        const data = await fs_extra_1.default.readFile(node_path_1.default.join(dirPath, 'enums', enumName), 'utf8');
+        description.enums[enumName.replace('.pg', '')] = data;
+    }
+    return description;
+}
+async function loadDescriptionFromDatabase(name) {
+    const description = await (0, describe_1.describeDatabase)(name);
+    return (0, describe_1.formatDatabaseDescription)(description, { coloredOutput: false });
+}
+async function loadDescription(db) {
+    if (db.type === 'database') {
+        return loadDescriptionFromDatabase(db.name);
+    }
+    else if (db.type === 'directory') {
+        return loadDescriptionFromDisk(db.path);
+    }
+    else {
+        throw new Error('Invalid database type');
+    }
+}
+async function diffDatabases(database1, database2, options) {
+    return diff({
+        type: 'database',
+        name: database1,
+    }, {
+        type: 'database',
+        name: database2,
+    }, options);
+}
+exports.diffDatabases = diffDatabases;
+async function diffDatabaseAndDirectory(database, directory, options) {
+    return diff({
+        type: 'database',
+        name: database,
+    }, {
+        type: 'directory',
+        path: directory,
+    }, options);
+}
+exports.diffDatabaseAndDirectory = diffDatabaseAndDirectory;
+async function diffDirectoryAndDatabase(directory, database, options) {
+    return diff({
+        type: 'directory',
+        path: directory,
+    }, {
+        type: 'database',
+        name: database,
+    }, options);
+}
+exports.diffDirectoryAndDatabase = diffDirectoryAndDatabase;
+async function diffDirectories(directory1, directory2, options) {
+    return diff({
+        type: 'directory',
+        path: directory1,
+    }, {
+        type: 'directory',
+        path: directory2,
+    }, options);
+}
+exports.diffDirectories = diffDirectories;
+//# sourceMappingURL=diff.js.map

package/dist/diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../src/diff.ts"],"names":[],"mappings":";;;;;;AAAA,YAAY;AACZ,wDAA0B;AAC1B,0DAA6B;AAC7B,kDAA0B;AAC1B,oDAAuB;AACvB,+BAAiC;AAEjC,yCAAyE;AAWzE,KAAK,UAAU,IAAI,CAAC,GAAe,EAAE,GAAe,EAAE,OAAoB;IACxE,SAAS,UAAU,CAAC,IAAY,EAAE,SAA0C;QAC1E,IAAI,OAAO,CAAC,aAAa,IAAI,SAAS,EAAE;YACtC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;SACxB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;IAC9D,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC,GAAG,CAAC,CAAC;IAEhD,mDAAmD;IACnD,MAAM,kBAAkB,GAAG,gBAAC,CAAC,UAAU,CAAC,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAClG,MAAM,kBAAkB,GAAG,gBAAC,CAAC,UAAU,CAAC,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAElG,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,MAAM,IAAI,UAAU,CAAC,mBAAmB,WAAW,KAAK,GAAG,CAAC,IAAI,KAAK,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;QACxF,MAAM,IAAI,UAAU,CAClB,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,EACnE,eAAK,CAAC,KAAK,CACZ,CAAC;KACH;IAED,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;QACjC,MAAM,IAAI,UAAU,CAAC,uBAAuB,WAAW,KAAK,GAAG,CAAC,IAAI,KAAK,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;QAC5F,MAAM,IAAI,UAAU,CAClB,kBAAkB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,EACnE,eAAK,CAAC,GAAG,CACV,CAAC;KACH;IAED,kDAAkD;IAClD,MAAM,iBAAiB,GAAG,gBAAC,CAAC,UAAU,CAAC,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/F,MAAM,iBAAiB,GAAG,gBAAC,CAAC,UAAU,CAAC,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IAE/F,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;QAChC,MAAM,IAAI,UAAU,CAAC,kBAAkB,WAAW,KAAK,GAAG,CAAC,IAAI,KAAK,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;QACvF,MAAM,IAAI,UAAU,CAClB,iBAAiB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,EACxE,eAAK,CAAC,KAAK,CACZ,CAAC;KACH;IAED,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;QAChC,MAAM,IAAI,UAAU,CAAC,sBAAsB,WAAW,KAAK,GAAG,CAAC,IAAI,KAAK,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;QAC3F,MAAM,IAAI,UAAU,CAClB,iBAAiB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,EACxE,eAAK,CAAC,GAAG,CACV,CAAC;KACH;IAED,+CAA+C;IAC/C,MAAM,YAAY,GAAG,gBAAC,CAAC,YAAY,CAAC,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9F,gBAAC,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;QAChC,2EAA2E;QAC3E,MAAM,IAAI,GAAG,IAAA,gBAAS,EACpB,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,EACxC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,IAAI,CACzC,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAE9B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,IAAI,UAAU,CAAC,kBAAkB,SAAS,UAAU,EAAE,eAAK,CAAC,SAAS,CAAC,CAAC;QAE7E,oEAAoE;QACpE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;YAC/B,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE;gBAClC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACtC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;aACtC;SACF;QAED,gBAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC9B,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;aAChC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YAC5D,IAAI,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;YACtD,IAAI,KAAK,KAAK,CAAC,EAAE;gBACf,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;aACzC;YACD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE;gBAC9B,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,eAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;aAC1F;QACH,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,MAAM,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,8CAA8C;IAC9C,MAAM,iBAAiB,GAAG,gBAAC,CAAC,YAAY,CAAC,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,gBAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACjG,gBAAC,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,QAAQ,EAAE,EAAE;QACxC,4DAA4D;QAC5D,6CAA6C;QAC7C,IAAI,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/E,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,eAAK,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,IAAI,UAAU,CAAC,kBAAkB,QAAQ,SAAS,CAAC,CAAC;YAC1D,MAAM,IAAI,UAAU,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,eAAK,CAAC,GAAG,CAAC,CAAC;YAC9E,MAAM,IAAI,UAAU,CAAC,KAAK,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,eAAK,CAAC,KAAK,CAAC,CAAC;YAChF,MAAM,IAAI,MAAM,CAAC;SAClB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,uBAAuB,CAAC,OAAe;IACpD,MAAM,WAAW,GAAgB;QAC/B,MAAM,EAAE,EAAE;QACV,KAAK,EAAE,EAAE;KACV,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC9D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,MAAM,IAAI,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;KACrD;IAED,MAAM,KAAK,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5D,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE;QAC5B,MAAM,IAAI,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,mBAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAC9E,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;KACvD;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,KAAK,UAAU,2BAA2B,CAAC,IAAY;IACrD,MAAM,WAAW,GAAG,MAAM,IAAA,2BAAgB,EAAC,IAAI,CAAC,CAAC;IACjD,OAAO,IAAA,oCAAyB,EAAC,WAAW,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,EAAc;IAC3C,IAAI,EAAE,CAAC,IAAI,KAAK,UAAU,EAAE;QAC1B,OAAO,2BAA2B,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;KAC7C;SAAM,IAAI,EAAE,CAAC,IAAI,KAAK,WAAW,EAAE;QAClC,OAAO,uBAAuB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;KACzC;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;KAC1C;AACH,CAAC;AAEM,KAAK,UAAU,aAAa,CAAC,SAAiB,EAAE,SAAiB,EAAE,OAAoB;IAC5F,OAAO,IAAI,CACT;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;KAChB,EACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;KAChB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAZD,sCAYC;AAEM,KAAK,UAAU,wBAAwB,CAC5C,QAAgB,EAChB,SAAiB,EACjB,OAAoB;IAEpB,OAAO,IAAI,CACT;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,QAAQ;KACf,EACD;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,SAAS;KAChB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAhBD,4DAgBC;AAEM,KAAK,UAAU,wBAAwB,CAC5C,SAAiB,EACjB,QAAgB,EAChB,OAAoB;IAEpB,OAAO,IAAI,CACT;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,SAAS;KAChB,EACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,QAAQ;KACf,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAhBD,4DAgBC;AAEM,KAAK,UAAU,eAAe,CACnC,UAAkB,EAClB,UAAkB,EAClB,OAAoB;IAEpB,OAAO,IAAI,CACT;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,UAAU;KACjB,EACD;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,UAAU;KACjB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAhBD,0CAgBC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { describeDatabase, formatDatabaseDescription } from './describe';
+export { diffDatabases, diffDirectories, diffDatabaseAndDirectory, diffDirectoryAndDatabase, } from './diff';

package/dist/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.diffDirectoryAndDatabase = exports.diffDatabaseAndDirectory = exports.diffDirectories = exports.diffDatabases = exports.formatDatabaseDescription = exports.describeDatabase = void 0;
+var describe_1 = require("./describe");
+Object.defineProperty(exports, "describeDatabase", { enumerable: true, get: function () { return describe_1.describeDatabase; } });
+Object.defineProperty(exports, "formatDatabaseDescription", { enumerable: true, get: function () { return describe_1.formatDatabaseDescription; } });
+var diff_1 = require("./diff");
+Object.defineProperty(exports, "diffDatabases", { enumerable: true, get: function () { return diff_1.diffDatabases; } });
+Object.defineProperty(exports, "diffDirectories", { enumerable: true, get: function () { return diff_1.diffDirectories; } });
+Object.defineProperty(exports, "diffDatabaseAndDirectory", { enumerable: true, get: function () { return diff_1.diffDatabaseAndDirectory; } });
+Object.defineProperty(exports, "diffDirectoryAndDatabase", { enumerable: true, get: function () { return diff_1.diffDirectoryAndDatabase; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAAyE;AAAhE,4GAAA,gBAAgB,OAAA;AAAE,qHAAA,yBAAyB,OAAA;AACpD,+BAKgB;AAJd,qGAAA,aAAa,OAAA;AACb,uGAAA,eAAe,OAAA;AACf,gHAAA,wBAAwB,OAAA;AACxB,gHAAA,wBAAwB,OAAA"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@prairielearn/postgres-tools",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "bin": {
+    "pg-describe": "./dist/bin/pg-describe.js",
+    "pg-diff": "./dist/bin/pg-diff.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PrairieLearn/PrairieLearn.git",
+    "directory": "packages/postgres-tools"
+  },
+  "scripts": {
+    "build": "tsc && copyfiles -u 1 \"./src/**/*.sql\" dist",
+    "dev": "tsc --watch --preserveWatchOutput"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "^0.0.0",
+    "@types/diff": "^5.0.3",
+    "@types/fs-extra": "^11.0.1",
+    "@types/node": "^18.15.11",
+    "copyfiles": "^2.4.1",
+    "typescript": "^4.9.4"
+  },
+  "dependencies": {
+    "@prairielearn/postgres": "^1.6.0",
+    "@types/lodash": "^4.14.192",
+    "chalk": "^4.1.2",
+    "diff": "^5.1.0",
+    "fs-extra": "^11.1.1",
+    "lodash": "^4.17.21"
+  }
+}

package/src/bin/pg-describe.ts

@@ -0,0 +1,106 @@
+#!/usr/bin/env node
+
+import async from 'async';
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import _ from 'lodash';
+import path from 'path';
+import yargs from 'yargs';
+
+import { describeDatabase, formatDatabaseDescription, DatabaseDescription } from '../describe';
+
+const args = yargs
+  .usage('Usage: $0 <database name> [options]')
+  .demandCommand(1)
+  .option('output', {
+    alias: 'o',
+    nargs: 1,
+    string: true,
+    description: 'Specify a directory to output files to',
+  })
+  .option('ignore-tables', {
+    array: true,
+    description: 'a list of tables to ignore',
+  })
+  .option('ignore-enums', {
+    array: true,
+    description: 'a list of enums to ignore',
+  })
+  .option('ignore-columns', {
+    array: true,
+    description: 'a list of columns to ignore, formatted like [table].[column]',
+  })
+  .help('h')
+  .alias('h', 'help')
+  .example('$0 postgres', 'Describe the "postgres" database')
+  .example(
+    '$0 userdb -o db_description --ignore-tables a b --ignore-columns a.col1 a.col2',
+    'Describe the "userdb" database; ignore specific tables and columns'
+  )
+  .strict();
+
+const argv = args.parseSync();
+
+if (argv._.length !== 1) {
+  args.showHelp();
+  process.exit(1);
+}
+
+// Disable color if we're not attached to a tty
+const coloredOutput = !argv.output && process.stdout.isTTY;
+
+const options = {
+  ignoreTables: (argv['ignore-tables'] ?? []).map((table) => table.toString()),
+  ignoreEnums: (argv['ignore-enums'] ?? []).map((enumName) => enumName.toString()),
+  ignoreColumns: (argv['ignore-columns'] ?? []).map((column) => column.toString()),
+};
+
+function formatText(text: string, formatter: (text: string) => string) {
+  if (!argv.output && coloredOutput) {
+    return formatter(text);
+  }
+  return text;
+}
+
+describeDatabase(argv._[0].toString(), options).then(
+  async (description) => {
+    if (argv.output) {
+      await writeDescriptionToDisk(description, argv.output);
+    } else {
+      printDescription(description);
+    }
+    process.exit(0);
+  },
+  (err) => {
+    console.error(err);
+    process.exit(1);
+  }
+);
+
+function printDescription(description: DatabaseDescription) {
+  const formattedDescription = formatDatabaseDescription(description, { coloredOutput });
+  _.forEach(_.sortBy(_.keys(formattedDescription.tables)), (tableName) => {
+    process.stdout.write(formatText(`[table] ${tableName}\n`, chalk.bold));
+    process.stdout.write(formattedDescription.tables[tableName]);
+    process.stdout.write('\n\n');
+  });
+
+  _.forEach(_.sortBy(_.keys(formattedDescription.enums)), (enumName) => {
+    process.stdout.write(formatText(`[enum] ${enumName}\n`, chalk.bold));
+    process.stdout.write(formattedDescription.enums[enumName]);
+    process.stdout.write('\n\n');
+  });
+}
+
+async function writeDescriptionToDisk(description: DatabaseDescription, dir: string) {
+  const formattedDescription = formatDatabaseDescription(description, { coloredOutput: false });
+  await fs.emptyDir(dir);
+  await fs.mkdir(path.join(dir, 'tables'));
+  await fs.mkdir(path.join(dir, 'enums'));
+  await async.eachOf(formattedDescription.tables, async (value, key) => {
+    await fs.writeFile(path.join(dir, 'tables', `${key}.pg`), value);
+  });
+  await async.eachOf(formattedDescription.enums, async (value, key) => {
+    await fs.writeFile(path.join(dir, 'enums', `${key}.pg`), value);
+  });
+}

package/src/bin/pg-diff.ts

@@ -0,0 +1,63 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs';
+
+import {
+  diffDatabases,
+  diffDirectories,
+  diffDatabaseAndDirectory,
+  diffDirectoryAndDatabase,
+} from '../diff';
+
+const args = yargs
+  .usage('Usage: $0 [options]')
+  .option('db', {
+    description: 'reads a description from the named database',
+  })
+  .option('dir', {
+    description: "reads a description from a directory that's been generated by pg-describe",
+  })
+  .help('h')
+  .alias('h', 'help')
+  .example(
+    '$0 --db postgres --dir db_dump',
+    'Diffs the database "postgres" with the description in the directory "db_dump"'
+  )
+  .example(
+    '$0 --db postgres --db old_restore',
+    'Diffs the database "postgres" with the database "old_restore"'
+  )
+  .strict();
+
+const argv = args.parseSync();
+
+const options = {
+  outputFormat: 'string',
+  coloredOutput: process.stdout.isTTY,
+};
+
+if (argv.db && typeof argv.db === 'string' && argv.dir && typeof argv.dir === 'string') {
+  // Ensure correct ordering for the sake of diffs
+  if (process.argv.indexOf('--db') < process.argv.indexOf('--dir')) {
+    diffDatabaseAndDirectory(argv.db, argv.dir, options).then(handleResults, handleError);
+  } else {
+    diffDirectoryAndDatabase(argv.dir, argv.db, options).then(handleResults, handleError);
+  }
+} else if (argv.db && Array.isArray(argv.db) && argv.db.length === 2 && !argv.dir) {
+  diffDatabases(argv.db[0], argv.db[1], options).then(handleResults, handleError);
+} else if (argv.dir && Array.isArray(argv.dir) && argv.dir.length === 2 && !argv.db) {
+  diffDirectories(argv.dir[0], argv.dir[1], options).then(handleResults, handleError);
+} else {
+  args.showHelp();
+  process.exit(1);
+}
+
+function handleResults(results: string) {
+  process.stdout.write(results);
+  process.exit(0);
+}
+
+function handleError(err: any) {
+  console.error(err);
+  process.exit(1);
+}

package/src/describe.sql

@@ -0,0 +1,129 @@
+-- BLOCK get_tables
+SELECT
+  c.relname AS name,
+  c.oid AS oid
+FROM
+  pg_catalog.pg_class c
+  JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+WHERE
+  c.relkind = 'r'
+  AND n.nspname != 'pg_catalog'
+  AND n.nspname != 'information_schema'
+  AND n.nspname !~ '^pg_toast'
+  AND pg_catalog.pg_table_is_visible (c.oid)
+ORDER BY
+  c.relname;
+
+-- BLOCK get_columns_for_table
+SELECT
+  a.attname AS name,
+  pg_catalog.format_type (a.atttypid, a.atttypmod) AS
+type,
+a.attnotnull AS notnull,
+(
+  SELECT
+    substring(
+      pg_catalog.pg_get_expr (d.adbin, d.adrelid) for 128
+    )
+  FROM
+    pg_catalog.pg_attrdef d
+  WHERE
+    d.adrelid = a.attrelid
+    AND d.adnum = a.attnum
+    AND a.atthasdef
+) AS default
+FROM
+  pg_catalog.pg_attribute a
+  JOIN pg_catalog.pg_class c ON a.attrelid = c.oid
+WHERE
+  a.attrelid = $oid
+  AND NOT a.attisdropped
+  AND a.attnum > 0
+ORDER BY
+  a.attname;
+
+-- BLOCK get_indexes_for_table
+SELECT
+  c2.relname AS name,
+  i.indisprimary AS isprimary,
+  i.indisunique AS isunique,
+  pg_catalog.pg_get_indexdef (i.indexrelid, 0, true) AS indexdef,
+  pg_catalog.pg_get_constraintdef (con.oid, true) AS constraintdef,
+  contype
+FROM
+  pg_catalog.pg_class c,
+  pg_catalog.pg_class c2,
+  pg_catalog.pg_index i
+  LEFT JOIN pg_catalog.pg_constraint con ON (
+    conrelid = i.indrelid
+    AND conindid = i.indexrelid
+    AND contype IN ('p', 'u')
+  )
+WHERE
+  c.oid = $oid
+  AND c.oid = i.indrelid
+  AND i.indexrelid = c2.oid
+ORDER BY
+  i.indisprimary DESC,
+  i.indisunique DESC,
+  c2.relname;
+
+-- BLOCK get_references_for_table
+SELECT
+  conname AS name,
+  conrelid::pg_catalog.regclass AS table,
+  pg_catalog.pg_get_constraintdef (c.oid, true) as condef
+FROM
+  pg_catalog.pg_constraint c
+WHERE
+  c.confrelid = $oid
+  AND c.contype = 'f'
+ORDER BY
+  conname;
+
+-- BLOCK get_foreign_key_constraints_for_table
+SELECT
+  conname AS name,
+  pg_catalog.pg_get_constraintdef (r.oid, true) as def
+FROM
+  pg_catalog.pg_constraint r
+WHERE
+  r.conrelid = $oid
+  AND r.contype = 'f'
+ORDER BY
+  1;
+
+-- BLOCK get_check_constraints_for_table
+SELECT
+  conname AS name,
+  pg_catalog.pg_get_constraintdef (r.oid, true) as def
+FROM
+  pg_catalog.pg_constraint r
+WHERE
+  r.conrelid = $oid
+  AND r.contype = 'c'
+ORDER BY
+  1;
+
+-- BLOCK get_enums
+SELECT
+  t.typname AS name,
+  ARRAY (
+    SELECT
+      e.enumlabel
+    FROM
+      pg_catalog.pg_enum e
+    WHERE
+      e.enumtypid = t.oid
+    ORDER BY
+      e.enumsortorder
+  ) AS
+values
+FROM
+  pg_type t
+  JOIN pg_enum e ON t.oid = e.enumtypid
+  JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace
+GROUP BY
+  n.nspname,
+  t.typname,
+  t.oid;