@rvoh/dream 0.30.0 → 0.30.1

package/dist/cjs/src/helpers/db/runMigration.js

@@ -7,6 +7,8 @@ const path = require("path");
 const DreamDbConnection_js_1 = require("../../db/DreamDbConnection.js");
 const index_js_1 = require("../../db/index.js");
 const index_js_2 = require("../../dream-application/index.js");
+const index_js_3 = require("../../cli/index.js");
+const colorize_js_1 = require("../../cli/logger/loggable/colorize.js");
 async function runMigration({ mode = 'migrate' } = {}) {
     const dreamApp = index_js_2.default.getOrFail();
     const migrationFolder = path.join(dreamApp.projectRoot, dreamApp.paths.db, 'migrations');
@@ -87,11 +89,14 @@ function migratedActionPastTense(mode) {
 function logResults(results, mode) {
     results?.forEach(it => {
         if (it.status === 'Success') {
-            console.log(`migration "${it.migrationName}" was ${migratedActionPastTense(mode)} successfully`);
+            index_js_3.default.logger.log((0, colorize_js_1.default)(`[db]`, { color: 'cyan' }) +
+                ` migration "${it.migrationName}" was ${migratedActionPastTense(mode)} successfully`, { permanent: true, logPrefix: '├', logPrefixColor: 'cyan' });
         }
         else if (it.status === 'Error') {
-            console.log(it);
-            console.error(`failed to ${migratedActionCurrentTense(mode)} migration "${it.migrationName}"`);
+            index_js_3.default.logger.log(JSON.stringify(it, null, 2), { permanent: true });
+            index_js_3.default.logger.log((0, colorize_js_1.default)(`failed to ${migratedActionCurrentTense(mode)} migration "${it.migrationName}"`, {
+                color: 'redBright',
+            }), { permanent: true });
         }
     });
 }

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

@@ -1,3 +1,4 @@
+import DreamCLI from '../cli/index.js';
 import ConnectionConfRetriever from '../db/ConnectionConfRetriever.js';
 import DreamApplication from '../dream-application/index.js';
 import SchemaBuilder from '../helpers/cli/SchemaBuilder.js';
@@ -17,14 +18,14 @@ export default class DreamBin {
         await onSync();
     }
     static async buildDreamSchema() {
-        console.log('writing dream schema...');
+        const spinner = DreamCLI.logger.log('writing dream schema...', { spinner: true });
         await new SchemaBuilder().build();
-        console.log('Done!');
+        spinner.stop();
     }
     static async dbCreate() {
         const connectionRetriever = new ConnectionConfRetriever();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        console.log(`creating ${primaryDbConf.name}`);
+        const spinner = DreamCLI.logger.log(`creating ${primaryDbConf.name}...`, { spinner: true });
         await createDb('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
@@ -34,12 +35,12 @@ export default class DreamBin {
         //   console.log(`creating ${process.env[replicaDbConf.name]}`)
         //   await createDb('replica')
         // }
-        console.log('complete!');
+        spinner.stop();
     }
     static async dbDrop() {
         const connectionRetriever = new ConnectionConfRetriever();
         const primaryDbConf = connectionRetriever.getConnectionConf('primary');
-        console.log(`dropping ${primaryDbConf.name}`);
+        const spinner = DreamCLI.logger.log(`dropping ${primaryDbConf.name}...`, { spinner: true });
         await _dropDb('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
@@ -49,19 +50,27 @@ export default class DreamBin {
         //   console.log(`dropping ${process.env[replicaDbConf.name]}`)
         //   await _dropDb('replica')
         // }
-        console.log('complete!');
+        spinner.stop();
     }
     static async dbMigrate() {
+        const connectionRetriever = new ConnectionConfRetriever();
+        const primaryDbConf = connectionRetriever.getConnectionConf('primary');
+        const spinner = DreamCLI.logger.log(`migrating ${primaryDbConf.name}...`, { spinner: true });
         await runMigration({ mode: 'migrate' });
         await this.duplicateDatabase();
+        spinner.stop();
     }
     static async dbRollback(opts) {
+        const connectionRetriever = new ConnectionConfRetriever();
+        const primaryDbConf = connectionRetriever.getConnectionConf('primary');
+        const spinner = DreamCLI.logger.log(`rolling back ${primaryDbConf.name}...`, { spinner: true });
         let step = opts.steps;
         while (step > 0) {
             await runMigration({ mode: 'rollback' });
             step -= 1;
         }
         await this.duplicateDatabase();
+        spinner.stop();
     }
     static async generateDream(fullyQualifiedModelName, columnsWithTypes, options) {
         await generateDream({ fullyQualifiedModelName, columnsWithTypes, options });
@@ -76,9 +85,8 @@ export default 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...');
+        DreamCLI.logger.log('generating docs...');
         await sspawn('yarn typedoc src/index.ts --tsconfig ./tsconfig.esm.build.json --out docs');
-        console.log('done!');
     }
     static async duplicateDatabase() {
         const parallelTests = DreamApplication.getOrFail().parallelTests;
@@ -89,15 +97,22 @@ export default class DreamBin {
         const client = await loadPgClient({ 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 = DreamCLI.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 = DreamCLI.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/esm/src/cli/index.js

@@ -1,6 +1,8 @@
+import { spawn } from 'child_process';
 import { InvalidArgumentError } from 'commander';
 import DreamBin from '../bin/index.js';
 import EnvInternal from '../helpers/EnvInternal.js';
+import DreamCliLogger from './logger/DreamCliLogger.js';
 export default class DreamCLI {
     /**
      * use this method for initializing a standalone dream application. If using Psychic and Dream together,
@@ -142,6 +144,32 @@ export default 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 = 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();
+        return this._logger;
+    }
+    static _logger = undefined;
 }
 function myParseInt(value) {
     const parsedValue = parseInt(value, 10);

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

@@ -0,0 +1,54 @@
+import DreamCliLoggableSpinner from './loggable/DreamCliLoggableSpinner.js';
+import DreamCliLoggableText from './loggable/DreamCliLoggableText.js';
+export default class DreamCliLogger {
+    logs = [];
+    log(text, { permanent = false, spinner = false, logPrefix, logPrefixColor, logPrefixBgColor, spinnerPrefixColor = 'greenBright', spinnerPrefixBgColor, } = {}) {
+        const loggable = spinner
+            ? new DreamCliLoggableSpinner({
+                text,
+                permanent: false,
+                spinner: 'noise',
+                color: spinnerPrefixColor,
+                bgColor: spinnerPrefixBgColor,
+            })
+            : new DreamCliLoggableText(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);
+    }
+    /*
+     * 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);
+    }
+}

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

@@ -0,0 +1,11 @@
+import yoctoSpinner from 'yocto-spinner';
+import spinners from '../loggable/spinners.js';
+export default function createSpinner(text, spinnerKey = 'noise') {
+    return yoctoSpinner({
+        text,
+        spinner: {
+            interval: spinners[spinnerKey].interval,
+            frames: [...spinners[spinnerKey].frames],
+        },
+    }).start();
+}

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

@@ -0,0 +1,19 @@
+import colorize from './colorize.js';
+export default 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 colorize(this.logPrefix, { color: this.logPrefixColor, bgColor: this.logPrefixBgColor });
+    }
+}

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

@@ -0,0 +1,28 @@
+import createSpinner from '../helpers/createSpinner.js';
+import DreamCliLoggable from './DreamCliLoggable.js';
+import DreamCLI from '../../index.js';
+export default class DreamCliLoggableSpinner extends DreamCliLoggable {
+    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 = createSpinner(this.text, this.spinner);
+    }
+    stop(message = this.text + ' done!') {
+        this._spinner.stop();
+        DreamCLI.logger.purge();
+        DreamCLI.logger.log(message, { permanent: true });
+    }
+}

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

@@ -0,0 +1,18 @@
+import colorize from './colorize.js';
+import DreamCliLoggable from './DreamCliLoggable.js';
+export default class DreamCliLoggableText extends DreamCliLoggable {
+    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} ${colorize(this.text, { color: this.color, bgColor: this.bgColor })}`);
+    }
+}

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

@@ -0,0 +1,5 @@
+import c from 'yoctocolors';
+export default function colorize(text, { color, bgColor }) {
+    const foregroundApplied = color ? c[color](text) : text;
+    return bgColor ? c[bgColor](foregroundApplied) : foregroundApplied;
+}