@rvoh/dream 0.30.0 → 0.30.2

package/dist/cjs/src/bin/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../cli/index.js");
 const ConnectionConfRetriever_js_1 = require("../db/ConnectionConfRetriever.js");
-const index_js_1 = require("../dream-application/index.js");
+const index_js_2 = require("../dream-application/index.js");
 const SchemaBuilder_js_1 = require("../helpers/cli/SchemaBuilder.js");
 const generateDream_js_1 = require("../helpers/cli/generateDream.js");
 const generateMigration_js_1 = require("../helpers/cli/generateMigration.js");
@@ -19,14 +20,14 @@ class DreamBin {
         await onSync();
     }
     static async buildDreamSchema() {
-        console.log('writing dream schema...');
+        const spinner = index_js_1.default.logger.log('writing dream schema...', { spinner: true });
         await new SchemaBuilder_js_1.default().build();
-        console.log('Done!');
+        spinner.stop();
     }
     static async dbCreate() {
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        console.log(`creating ${primaryDbConf.name}`);
+        const spinner = index_js_1.default.logger.log(`creating ${primaryDbConf.name}...`, { spinner: true });
         await (0, createDb_js_1.default)('primary');
         // TODO: add support for creating replicas. Began doing it below, but it is very tricky,
         // and we don't need it at the moment, so kicking off for future development when we have more time
@@ -36,12 +37,12 @@ class DreamBin {
         //   console.log(`creating ${process.env[replicaDbConf.name]}`)
         //   await createDb('replica')
         // }
-        console.log('complete!');
+        spinner.stop();
     }
     static async dbDrop() {
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        console.log(`dropping ${primaryDbConf.name}`);
+        const spinner = index_js_1.default.logger.log(`dropping ${primaryDbConf.name}...`, { spinner: true });
         await (0, dropDb_js_1.default)('primary');
         // TODO: add support for dropping replicas. Began doing it below, but it is very tricky,
         // and we don't need it at the moment, so kicking off for future development when we have more time
@@ -51,19 +52,27 @@ class DreamBin {
         //   console.log(`dropping ${process.env[replicaDbConf.name]}`)
         //   await _dropDb('replica')
         // }
-        console.log('complete!');
+        spinner.stop();
     }
     static async dbMigrate() {
+        const connectionRetriever = new ConnectionConfRetriever_js_1.default();
+        const primaryDbConf = connectionRetriever.getConnectionConf('primary');
+        const spinner = index_js_1.default.logger.log(`migrating ${primaryDbConf.name}...`, { spinner: true });
         await (0, runMigration_js_1.default)({ mode: 'migrate' });
         await this.duplicateDatabase();
+        spinner.stop();
     }
     static async dbRollback(opts) {
+        const connectionRetriever = new ConnectionConfRetriever_js_1.default();
+        const primaryDbConf = connectionRetriever.getConnectionConf('primary');
+        const spinner = index_js_1.default.logger.log(`rolling back ${primaryDbConf.name}...`, { spinner: true });
         let step = opts.steps;
         while (step > 0) {
             await (0, runMigration_js_1.default)({ mode: 'rollback' });
             step -= 1;
         }
         await this.duplicateDatabase();
+        spinner.stop();
     }
     static async generateDream(fullyQualifiedModelName, columnsWithTypes, options) {
         await (0, generateDream_js_1.default)({ fullyQualifiedModelName, columnsWithTypes, options });
@@ -78,12 +87,11 @@ class DreamBin {
     // It is only made private so that people don't mistakenly try
     // to use it to generate docs for their apps.
     static async buildDocs() {
-        console.log('generating docs...');
+        index_js_1.default.logger.log('generating docs...');
         await (0, sspawn_js_1.default)('yarn typedoc src/index.ts --tsconfig ./tsconfig.esm.build.json --out docs');
-        console.log('done!');
     }
     static async duplicateDatabase() {
-        const parallelTests = index_js_1.default.getOrFail().parallelTests;
+        const parallelTests = index_js_2.default.getOrFail().parallelTests;
         if (!parallelTests)
             return;
         const connectionRetriever = new ConnectionConfRetriever_js_1.default();
@@ -91,15 +99,22 @@ class DreamBin {
         const client = await (0, loadPgClient_js_1.default)({ useSystemDb: true });
         if (process.env.DREAM_CORE_DEVELOPMENT === '1') {
             const replicaTestWorkerDatabaseName = `replica_test_${dbConf.name}`;
-            console.log(`creating fake replica test database ${replicaTestWorkerDatabaseName}`);
+            const spinner = index_js_1.default.logger.log(`creating fake replica test database ${replicaTestWorkerDatabaseName}...`, {
+                spinner: true,
+            });
             await client.query(`DROP DATABASE IF EXISTS ${replicaTestWorkerDatabaseName};`);
             await client.query(`CREATE DATABASE ${replicaTestWorkerDatabaseName} TEMPLATE ${dbConf.name};`);
+            spinner.stop();
         }
         for (let i = 2; i <= parallelTests; i++) {
             const workerDatabaseName = `${dbConf.name}_${i}`;
             console.log(`creating duplicate test database ${workerDatabaseName} for concurrent tests`);
+            const spinner = index_js_1.default.logger.log(`creating duplicate test database ${workerDatabaseName} for concurrent tests...`, {
+                spinner: true,
+            });
             await client.query(`DROP DATABASE IF EXISTS ${workerDatabaseName};`);
             await client.query(`CREATE DATABASE ${workerDatabaseName} TEMPLATE ${dbConf.name};`);
+            spinner.stop();
         }
         await client.end();
     }

package/dist/cjs/src/cli/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
 const commander_1 = require("commander");
 const index_js_1 = require("../bin/index.js");
 const EnvInternal_js_1 = require("../helpers/EnvInternal.js");
+const DreamCliLogger_js_1 = require("./logger/DreamCliLogger.js");
 class DreamCLI {
     /**
      * use this method for initializing a standalone dream application. If using Psychic and Dream together,
@@ -144,6 +146,32 @@ class DreamCLI {
             process.exit();
         });
     }
+    /*
+     * the default spawn provided by node:child_process is incompatible
+     * with promises. this will automatically wrap the spawn method,
+     * and will by default connect STDOUT to the current STDOUT,
+     * so that whatever the command is outputting is output to the
+     * primary STDOUT context.
+     */
+    static async spawn(command, opts) {
+        return new Promise((accept, reject) => {
+            const spawnInstance = (0, child_process_1.spawn)(command, {
+                stdio: 'inherit',
+                shell: true,
+                ...(opts || {}),
+            });
+            spawnInstance.on('close', code => {
+                if (code !== 0)
+                    reject(new Error(code?.toString()));
+                accept({});
+            });
+        });
+    }
+    static get logger() {
+        this._logger ||= new DreamCliLogger_js_1.default();
+        return this._logger;
+    }
+    static _logger = undefined;
 }
 exports.default = DreamCLI;
 function myParseInt(value) {

package/dist/cjs/src/cli/logger/DreamCliLogger.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const DreamCliLoggableSpinner_js_1 = require("./loggable/DreamCliLoggableSpinner.js");
+const DreamCliLoggableText_js_1 = require("./loggable/DreamCliLoggableText.js");
+class DreamCliLogger {
+    logs = [];
+    log(text, { permanent = false, spinner = false, logPrefix, logPrefixColor, logPrefixBgColor, spinnerPrefixColor = 'greenBright', spinnerPrefixBgColor, } = {}) {
+        const loggable = spinner
+            ? new DreamCliLoggableSpinner_js_1.default({
+                text,
+                permanent: false,
+                spinner: 'noise',
+                color: spinnerPrefixColor,
+                bgColor: spinnerPrefixBgColor,
+            })
+            : new DreamCliLoggableText_js_1.default(text, {
+                permanent,
+                logPrefix,
+                logPrefixColor: logPrefixColor || (permanent ? 'green' : 'yellow'),
+                logPrefixBgColor,
+            });
+        this.logs.push(loggable);
+        // re-render everything
+        this.render();
+        return loggable;
+    }
+    render() {
+        this.clear();
+        let skipNext = false;
+        this.logs.forEach(loggable => {
+            if (skipNext) {
+                skipNext = false;
+                return;
+            }
+            loggable.render();
+        });
+    }
+    get spinners() {
+        return this.logs.filter(log => log instanceof DreamCliLoggableSpinner_js_1.default);
+    }
+    /*
+     * remove all logs that are not marked permanent,
+     * then clear STDOUT and re-render with only
+     * the permanent logs remaining.
+     */
+    purge() {
+        this.logs = this.logs.filter(log => log.permanent);
+        this.render();
+    }
+    clear() {
+        console.clear();
+        // @ts-expect-error this works fine with no args provided
+        process.stdout.clearLine?.();
+        process.stdout.cursorTo?.(0);
+    }
+}
+exports.default = DreamCliLogger;

package/dist/cjs/src/cli/logger/helpers/createSpinner.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createSpinner;
+const yocto_spinner_1 = require("yocto-spinner");
+const spinners_js_1 = require("../loggable/spinners.js");
+function createSpinner(text, spinnerKey = 'noise') {
+    return (0, yocto_spinner_1.default)({
+        text,
+        spinner: {
+            interval: spinners_js_1.default[spinnerKey].interval,
+            frames: [...spinners_js_1.default[spinnerKey].frames],
+        },
+    }).start();
+}

package/dist/cjs/src/cli/logger/loggable/DreamCliLoggable.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const colorize_js_1 = require("./colorize.js");
+class DreamCliLoggable {
+    permanent;
+    logPrefix;
+    logPrefixColor;
+    logPrefixBgColor;
+    constructor({ permanent, logPrefix = '✺', logPrefixColor, logPrefixBgColor, }) {
+        this.permanent = permanent;
+        this.logPrefix = logPrefix;
+        this.logPrefixColor = logPrefixColor;
+        this.logPrefixBgColor = logPrefixBgColor;
+    }
+    render() {
+        throw new Error('define in base class');
+    }
+    get colorizedLogPrefix() {
+        return (0, colorize_js_1.default)(this.logPrefix, { color: this.logPrefixColor, bgColor: this.logPrefixBgColor });
+    }
+}
+exports.default = DreamCliLoggable;

package/dist/cjs/src/cli/logger/loggable/DreamCliLoggableSpinner.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const createSpinner_js_1 = require("../helpers/createSpinner.js");
+const DreamCliLoggable_js_1 = require("./DreamCliLoggable.js");
+const index_js_1 = require("../../index.js");
+class DreamCliLoggableSpinner extends DreamCliLoggable_js_1.default {
+    text;
+    spinner;
+    currentIndex = 0;
+    color;
+    bgColor;
+    lastRender;
+    _spinner;
+    constructor({ text, permanent, spinner, color, bgColor, }) {
+        super({ permanent });
+        this.text = text;
+        this.spinner = spinner;
+        this.color = color;
+        this.bgColor = bgColor;
+    }
+    render() {
+        this._spinner?.stop();
+        this._spinner = (0, createSpinner_js_1.default)(this.text, this.spinner);
+    }
+    stop(message = this.text + ' done!') {
+        this._spinner.stop();
+        index_js_1.default.logger.purge();
+        index_js_1.default.logger.log(message, { permanent: true });
+    }
+}
+exports.default = DreamCliLoggableSpinner;

package/dist/cjs/src/cli/logger/loggable/DreamCliLoggableText.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const colorize_js_1 = require("./colorize.js");
+const DreamCliLoggable_js_1 = require("./DreamCliLoggable.js");
+class DreamCliLoggableText extends DreamCliLoggable_js_1.default {
+    text;
+    color;
+    bgColor;
+    constructor(text, { permanent, logPrefix, color, bgColor, logPrefixColor, logPrefixBgColor, }) {
+        super({ permanent, logPrefix });
+        this.text = text;
+        this.color = color;
+        this.bgColor = bgColor;
+        this.logPrefixColor = logPrefixColor;
+        this.logPrefixBgColor = logPrefixBgColor;
+    }
+    render() {
+        console.log(`${this.colorizedLogPrefix} ${(0, colorize_js_1.default)(this.text, { color: this.color, bgColor: this.bgColor })}`);
+    }
+}
+exports.default = DreamCliLoggableText;

package/dist/cjs/src/cli/logger/loggable/colorize.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = colorize;
+const yoctocolors_1 = require("yoctocolors");
+function colorize(text, { color, bgColor }) {
+    const foregroundApplied = color ? yoctocolors_1.default[color](text) : text;
+    return bgColor ? yoctocolors_1.default[bgColor](foregroundApplied) : foregroundApplied;
+}