mythix 2.11.3 → 2.12.0

package/README.md

@@ -416,7 +416,7 @@ class Application extends Mythix.Application {
 
 Tasks are cron-like tasks that run at a given frequency, delay, or scheduled time. They can be defined using the `Mythix.defineTask` method, and should be placed inside `./app/tasks`, in files with names that have a `-task.js` suffix.
 
-Like most `mythix` classes, you can call `this.getApplication()` to get the application instance, `this.getLogger()` to get the tasks logger, `this.getModel(name)` or `this.getModels()` to get application models, and `this.getDBConnection()` to get the database connection for the running application.
+Like most `mythix` classes, you can call `this.getApplication()` to get the application instance, `this.getLogger()` to get the tasks logger, `this.getModel(name)` or `this.getModels()` to get application models, and `this.getConnection()` to get the database connection for the running application.
 
 Example task:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mythix",
-  "version": "2.11.3",
+  "version": "2.12.0",
   "description": "Mythix is a NodeJS web-app framework",
   "main": "src/index",
   "scripts": {
@@ -20,7 +20,7 @@
   "homepage": "https://github.com/th317erd/mythix#readme",
   "devDependencies": {
     "@spothero/eslint-plugin-spothero": "github:spothero/eslint-plugin-spothero",
-    "@types/node": "^18.11.9",
+    "@types/node": "^18.11.10",
     "colors": "^1.4.0",
     "diff": "^5.1.0",
     "eslint": "^8.28.0",
@@ -33,9 +33,9 @@
     "express": "^4.18.2",
     "express-busboy": "github:th317erd/express-busboy#0754a570d7979097b31e48655b80d3fcd628d4e4",
     "form-data": "^4.0.0",
-    "luxon": "^3.1.0",
+    "luxon": "^3.1.1",
     "micromatch": "^4.0.5",
-    "mythix-orm": "^1.11.4",
+    "mythix-orm": "^1.12.0",
     "nife": "^1.12.1",
     "prompts": "^2.4.2"
   }

package/src/application.d.ts

@@ -66,7 +66,10 @@ export declare class Application {
   // From DatabaseModule
   public getDBConfig(): GenericObject;
   public getDBTablePrefix(): string | null;
-  public getDBConnection(): ConnectionBase;
+  public getConnection(connection?: ConnectionBase): ConnectionBase;
+
+  // Deprecated
+  public getDBConnection(connection?: ConnectionBase): ConnectionBase;
 
   // From FileWatcherModule
   public autoReload(enable?: boolean, shuttingDown?: boolean): Promise<void>;

package/src/cli/cli-utils.d.ts

@@ -7,7 +7,7 @@ import { Logger } from '../logger';
 
 export declare type CommandClass = typeof CommandBase;
 
-export declare type CommandClasses = { [ key: string ]: CommandClass };
+export declare type CommandClasses = { [key: string]: CommandClass };
 
 export declare type FileFilterCallback = (fullFileName: string, fileName: string, stats?: Stats) => boolean;
 
@@ -16,7 +16,7 @@ export declare class CommandBase {
   declare public static commandName: string;
   declare public static applicationConfig?: GenericObject | (() => GenericObject);
   declare public static commandArguments?: () => { help: HelpInterface, runner: Runner };
-  declare public static runtimeArguments?: { [ key: string ]: Array<string> };
+  declare public static runtimeArguments?: { [key: string]: Array<string> };
   public static execute(): Promise<void>;
 
   declare public application: Application;
@@ -26,7 +26,10 @@ export declare class CommandBase {
   getOptions(): GenericObject;
   getApplication(): Application;
   getLogger(): Logger;
-  getDBConnection(): ConnectionBase;
+  getConnection(connection?: ConnectionBase): ConnectionBase;
+
+  // Deprecated
+  getDBConnection(connection?: ConnectionBase): ConnectionBase;
 
   spawnCommand(
     command: string,

package/src/cli/cli-utils.js

@@ -48,9 +48,14 @@ class CommandBase {
     return app.getLogger();
   }
 
-  getDBConnection() {
+  getConnection(connection) {
     let application = this.getApplication();
-    return application.getDBConnection();
+    return application.getConnection(connection);
+  }
+
+  // Deprecated
+  getDBConnection(connection) {
+    return this.getConnection(connection);
   }
 
   spawnCommand(command, args, options) {
@@ -290,7 +295,7 @@ function defineCommand(_commandName, definer, _parent) {
         return await commandInstance.execute.call(commandInstance, commandOptions, commandContext);
       };
 
-      let dbConnection = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : undefined;
+      let dbConnection = (typeof application.getConnection === 'function') ? application.getConnection() : undefined;
       let result;
 
       if (dbConnection && typeof dbConnection.createContext === 'function')

package/src/cli/generators/migration-generator.js

@@ -17,11 +17,11 @@ const MIGRATION_ID = '${migrationID}';
 
 module.exports = {
   MIGRATION_ID,
-  up: async function(connection) {
-${upCode}
+  up: async function(connection, application) {
+${upCode || ''}
   },
-  down: async function(connection) {
-${downCode}
+  down: async function(connection, application) {
+${downCode || ''}
   },
 };
 `;
@@ -36,12 +36,13 @@ class GenerateMigrationCommand extends CommandBase {
         '@usage': 'mythix-cli generate migration {operation} {operation args} [options]',
         '@title': 'Generate a migration file',
         '@examples':  [
+          'mythix-cli generate migration add blank --name "my migration"',
           'mythix-cli generate migration add model User',
           'mythix-cli generate migration rename model User AdminUser',
-          'mythix-cli generate migration remove model User',
+          'mythix-cli generate migration drop model User',
           'mythix-cli generate migration add field User:age',
           'mythix-cli generate migration rename field User:age yearsLived',
-          'mythix-cli generate migration remove field User:age',
+          'mythix-cli generate migration drop field User:age',
         ],
         '-n={name} | -n {name} | --name={name} | --name {name}': 'Specify the name of the generated migration file',
         '-o={path} | -o {path} | --output={path} | --output {path}': 'Specify the name of the generated migration file',
@@ -60,9 +61,9 @@ class GenerateMigrationCommand extends CommandBase {
           || store('outputPath', Path.resolve(applicationOptions.migrationsPath));
 
         let result = $(
-          /[\w-]+/,
+          /^(add|rename|drop)$/i,
           ({ store }, parsedResult) => {
-            store({ operation: parsedResult.value });
+            store({ operation: parsedResult.value.toLowerCase() });
             return true;
           },
           { formatParsedResult: (result) => ({ value: result[0] }) },
@@ -72,18 +73,25 @@ class GenerateMigrationCommand extends CommandBase {
           return false;
 
         result = $(
-          /[\w-]+/,
+          /^(models?|fields?|blank)$/i,
           ({ store }, parsedResult) => {
-            store({ entity: parsedResult.value });
+            let entity = parsedResult.value.toLowerCase();
+            if (entity === 'models')
+              entity = 'model';
+
+            if (entity === 'fields')
+              entity = 'field';
+
+            store({ entity });
             return true;
           },
           { formatParsedResult: (result) => ({ value: result[0] }) },
         );
 
-        if (!result && fetch('operation') !== 'blank')
+        if (!result)
           return false;
 
-        if (fetch('operation') === 'blank' && Nife.isEmpty(fetch('name'))) {
+        if (fetch('entity') === 'blank' && Nife.isEmpty(fetch('name'))) {
           console.log('Error: Blank templates require a name. Use the "--name {name}" argument to specify a name.\n');
           return false;
         }
@@ -113,13 +121,17 @@ class GenerateMigrationCommand extends CommandBase {
 
     let name = [
       args.operation,
-      args.entity,
+      (args.remaining.length > 1) ? `${args.entity}s` : args.entity,
       ...args.remaining,
     ];
 
     return `${args.version}-${this.formatMigrationName(name.join('-'))}.js`;
   }
 
+  generateMigration(migrationID, upCode, downCode) {
+    return generateMigration(migrationID, upCode, downCode);
+  }
+
   async execute(args, fullArgs) {
     args.version = this.getRevisionNumber();
     args.remaining = fullArgs._remaining;
@@ -172,12 +184,18 @@ class GenerateMigrationCommand extends CommandBase {
     return str.trim().replace(/^/gm, ws);
   }
 
-  operationAddModels(args) {
+  operationAddBlank(args) {
+    return this.generateMigration(
+      args.version,
+    );
+  }
+
+  addOrDropModels(args, reverseOperation) {
     if (Nife.isEmpty(args.remaining))
       throw new ValidationError('No model name(s) provided. Try this instead: \n\nmythix-cli generate migration add models \'{model name}\' ...');
 
     let application       = this.getApplication();
-    let connection        = application.getDBConnection();
+    let connection        = application.getConnection();
     let queryGenerator    = connection.getQueryGenerator();
     let statements        = [];
     let reverseStatements = [];
@@ -187,22 +205,97 @@ class GenerateMigrationCommand extends CommandBase {
       let modelName = modelNames[i];
       let Model     = connection.getModel(modelName);
 
-      let createTable = queryGenerator.generateCreateTableStatement(Model);
-      statements.push(`    // Create ${modelName} table\n    await connection.query(\`\n${this.tabIn(createTable, 3)}\`,\n      { logger: console },\n    );`);
+      // Create table
+      let createTable = queryGenerator.generateCreateTableStatement(Model, { ifNotExists: true });
+      statements.push(`    // Create "${Model.getTableName()}" table\n    await connection.query(\`\n${this.tabIn(createTable, 3)}\`,\n      { logger: console },\n    );`);
+
+      // Create indexes and constraints
+      let trailingStatements = Nife.toArray(queryGenerator.generateCreateTableStatementOuterTail(Model)).filter(Boolean);
+      if (Nife.isNotEmpty(trailingStatements)) {
+        for (let i = 0, il = trailingStatements.length; i < il; i++) {
+          let trailingStatement = trailingStatements[i];
+          statements.push(`    await connection.query(\n      \`${trailingStatement}\`,\n      { logger: console },\n    );`);
+        }
+      }
 
       let dropTable = queryGenerator.generateDropTableStatement(Model, { cascade: true });
-      reverseStatements.push(`    // Drop ${modelName} table\n    await connection.query(\n      \`${dropTable.trim()}\`,\n      { logger: console },\n    );`);
+      reverseStatements.push(`    // Drop "${Model.getTableName()}" table\n    await connection.query(\n      \`${dropTable.trim()}\`,\n      { logger: console },\n    );`);
     }
 
-    return generateMigration(
-      args.version,
-      statements.join('\n\n'),
-      reverseStatements.reverse().join('\n\n'),
-    );
+    if (reverseOperation) {
+      return this.generateMigration(
+        args.version,
+        reverseStatements.reverse().join('\n\n'),
+        statements.join('\n\n'),
+      );
+    } else {
+      return this.generateMigration(
+        args.version,
+        statements.join('\n\n'),
+        reverseStatements.reverse().join('\n\n'),
+      );
+    }
+  }
+
+  addOrDropFields(args, reverseOperation) {
+    if (Nife.isEmpty(args.remaining))
+      throw new ValidationError('No field name(s) provided. Try this instead: \n\nmythix-cli generate migration add fields \'{model name}:{field name}\' ...');
+
+    let application       = this.getApplication();
+    let connection        = application.getConnection();
+    let queryGenerator    = connection.getQueryGenerator();
+    let statements        = [];
+    let reverseStatements = [];
+
+    let fields = args.remaining.map((fieldName) => {
+      let field = connection.getField(fieldName);
+      if (!field)
+        throw new ValidationError(`Unable to find requested field: "${fieldName}"`);
+
+      return field;
+    });
+
+    for (let i = 0, il = fields.length; i < il; i++) {
+      let field = fields[i];
+      let Model = field.Model;
+
+      // Create table
+      let createColumn = queryGenerator.generateAddColumnStatement(field, { ifNotExists: true });
+      statements.push(`    // Add "${Model.getTableName()}"."${field.columnName}" column\n    await connection.query(\n      \`${createColumn}\`,\n      { logger: console },\n    );`);
+
+      let dropColumn = queryGenerator.generateDropColumnStatement(field, { cascade: true, ifExists: true });
+      reverseStatements.push(`    // Drop "${Model.getTableName()}"."${field.columnName}" column\n    await connection.query(\n      \`${dropColumn.trim()}\`,\n      { logger: console },\n    );`);
+    }
+
+    if (reverseOperation) {
+      return this.generateMigration(
+        args.version,
+        reverseStatements.reverse().join('\n\n'),
+        statements.join('\n\n'),
+      );
+    } else {
+      return this.generateMigration(
+        args.version,
+        statements.join('\n\n'),
+        reverseStatements.reverse().join('\n\n'),
+      );
+    }
   }
 
   operationAddModel(args) {
-    return this.operationAddModels(args);
+    return this.addOrDropModels(args, false);
+  }
+
+  operationDropModel(args) {
+    return this.addOrDropModels(args, true);
+  }
+
+  operationAddField(args) {
+    return this.addOrDropFields(args, false);
+  }
+
+  operationDropField(args) {
+    return this.addOrDropFields(args, true);
   }
 }
 

package/src/cli/migrate-command.js

@@ -62,16 +62,16 @@ module.exports = defineCommand('migrate', ({ Parent }) => {
         let fileName        = Path.basename(fullFileName);
         let migrationFileTS = fileName.substring(0, TIMESTAMP_LENGTH);
 
-        if (BigInt(migrationFileTS) >= revision)
+        if (BigInt(migrationFileTS) > revision)
           return true;
 
         return false;
       });
 
       if (index < 0)
-        return migrationFiles.slice();
+        return [];
 
-      return migrationFiles.slice((isRollback) ? index : index + 1);
+      return migrationFiles.slice((isRollback) ? index - 1 : index);
     }
 
     async executeMigration(application, dbConnection, migrationFileName, useTransaction, rollback) {
@@ -147,7 +147,7 @@ module.exports = defineCommand('migrate', ({ Parent }) => {
 
       let application         = this.getApplication();
       let applicationOptions  = application.getOptions();
-      let dbConnection        = application.getDBConnection();
+      let dbConnection        = application.getConnection();
       let migrationsPath      = applicationOptions.migrationsPath;
       let migrationFiles      = this.getMigrationFiles(migrationsPath);
       let useTransaction      = args.transaction;

package/src/cli/shell-command.js

@@ -63,7 +63,7 @@ module.exports = defineCommand('shell', ({ Parent }) => {
         interactiveShell.setupHistory(Path.join(OS.homedir(), `.${appName}-${environment}-history`), () => {});
 
         interactiveShell.context.UUIDV4 = UUIDV4;
-        interactiveShell.context.connection = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : null;
+        interactiveShell.context.connection = (typeof application.getConnection === 'function') ? application.getConnection() : null;
         interactiveShell.context.application = application;
         interactiveShell.context.Nife = Nife;
 

package/src/controllers/controller-base.d.ts

@@ -7,7 +7,7 @@ import { HTTPBaseError } from '../http-server/http-errors';
 
 export declare type ControllerClass = typeof ControllerBase;
 
-export declare type ControllerClasses = { [ key: string ]: ControllerClass };
+export declare type ControllerClasses = { [key: string]: ControllerClass };
 
 export declare interface ControllerContext {
   params: GenericObject;
@@ -37,7 +37,11 @@ export declare class ControllerBase {
   public getLogger(): Logger;
   public getModel(name?: string): ModelClass | undefined;
   public getModels(): Models;
-  public getDBConnection(): ConnectionBase;
+  public getConnection(connection?: ConnectionBase): ConnectionBase;
+
+  // Deprecated
+  public getDBConnection(connection?: ConnectionBase): ConnectionBase;
+
   public prepareToThrowError(ErrorClass: Function, args: Array<any>): HTTPBaseError;
   public throwNotFoundError(...args: Array<any>): void;
   public throwBadRequestError(...args: Array<any>): void;

package/src/controllers/controller-base.js

@@ -97,9 +97,14 @@ class ControllerBase {
     return application.getModels();
   }
 
-  getDBConnection() {
+  getConnection(connection) {
     let application = this.getApplication();
-    return application.getDBConnection();
+    return application.getConnection(connection);
+  }
+
+  // Deprecated
+  getDBConnection(connection) {
+    return this.getConnection(connection);
   }
 
   prepareToThrowError(ErrorClass, args) {

package/src/http-server/http-server.js

@@ -308,7 +308,7 @@ class HTTPServer {
     };
 
     let application   = this.getApplication();
-    let dbConnection  = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : undefined;
+    let dbConnection  = (typeof application.getConnection === 'function') ? application.getConnection() : undefined;
 
     if (dbConnection && typeof dbConnection.createContext === 'function')
       return await dbConnection.createContext(executeRequest, dbConnection, dbConnection);
@@ -386,7 +386,7 @@ class HTTPServer {
           return await controllerInstance.handleOutgoingResponse(controllerResult, request, response, context);
         };
 
-        let dbConnection = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : undefined;
+        let dbConnection = (typeof application.getConnection === 'function') ? application.getConnection() : undefined;
         if (dbConnection && typeof dbConnection.createContext === 'function')
           await dbConnection.createContext(handleOutgoing, dbConnection, dbConnection);
         else

package/src/models/model-module.js

@@ -75,7 +75,7 @@ class ModelModule extends BaseModule {
 
   loadModels(modelsPath) {
     let application = this.getApplication();
-    let connection  = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : null;
+    let connection  = (typeof application.getConnection === 'function') ? application.getConnection() : null;
     let dbConfig    = (typeof application.getDBConfig === 'function') ? application.getDBConfig() : null;
     let modelFiles  = this.getModelFilePaths(modelsPath);
     let models      = {};
@@ -103,7 +103,7 @@ class ModelModule extends BaseModule {
 
   getModel(modelName) {
     let application = this.getApplication();
-    let connection  = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : null;
+    let connection  = (typeof application.getConnection === 'function') ? application.getConnection() : null;
     if (!connection)
       return;
 
@@ -112,7 +112,7 @@ class ModelModule extends BaseModule {
 
   getModels() {
     let application = this.getApplication();
-    let connection  = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : null;
+    let connection  = (typeof application.getConnection === 'function') ? application.getConnection() : null;
     if (!connection)
       return {};
 

package/src/models/model.d.ts

@@ -13,5 +13,8 @@ export declare class Model extends _Model {
 
   public getApplication(): Application;
   public getLogger(): Logger;
-  public getDBConnection(connection): ConnectionBase;
+  public getConnection(connection?: ConnectionBase): ConnectionBase;
+
+  // Deprecated
+  public getDBConnection(connection?: ConnectionBase): ConnectionBase;
 }

package/src/models/model.js

@@ -34,7 +34,7 @@ class Model extends _Model {
     return application.getLogger();
   }
 
-  getDBConnection(connection) {
+  getConnection(connection) {
     if (connection)
       return connection;
 
@@ -42,18 +42,23 @@ class Model extends _Model {
     if (!application)
       return null;
 
-    if (typeof application.getDBConnection === 'function')
-      return application.getDBConnection();
+    if (typeof application.getConnection === 'function')
+      return application.getConnection();
 
     return null;
   }
 
+  // Deprecated
+  getDBConnection(connection) {
+    return this.getConnection(connection);
+  }
+
   static _getConnection(_connection) {
     let connection = super._getConnection(_connection);
     if (connection)
       return connection;
 
-    return this.getApplication().getDBConnection();
+    return this.getApplication().getConnection();
   }
 }
 

package/src/modules/database-module.js

@@ -42,7 +42,7 @@ class DatabaseModule extends BaseModule {
         configurable: true,
         value:        this.getTablePrefix.bind(this),
       },
-      'getDBConnection': {
+      'getConnection': {
         writable:     true,
         enumerable:   false,
         configurable: true,

package/src/tasks/task-base.d.ts

@@ -3,7 +3,7 @@ import { Application } from '../application';
 import { Logger } from '../logger';
 import { ConnectionBase, ModelClass, Models } from 'mythix-orm';
 
-export declare type Tasks = { [ key: string ]: TaskBase };
+export declare type Tasks = { [key: string]: TaskBase };
 
 export declare type TaskClass = typeof TaskBase;
 
@@ -37,7 +37,11 @@ export declare class TaskBase {
   public getNumberOfWorkers(): number;
   public getModel(name: string): ModelClass;
   public getModels(): Models;
-  public getDBConnection(): ConnectionBase;
+  public getConnection(connection?: ConnectionBase): ConnectionBase;
+
+  // Deprecated
+  public getDBConnection(connection?: ConnectionBase): ConnectionBase;
+
   public getFrequency(taskIndex?: number): number;
   public getStartDelay(taskIndex?: number): number;
 }

package/src/tasks/task-base.js

@@ -100,9 +100,14 @@ class TaskBase {
     return application.getModels();
   }
 
-  getDBConnection() {
+  getConnection(connection) {
     let application = this.getApplication();
-    return application.getDBConnection();
+    return application.getConnection(connection);
+  }
+
+  // Deprecated
+  getDBConnection(connection) {
+    return this.getConnection(connection);
   }
 
   getFrequency(taskIndex) {

package/src/tasks/task-module.js

@@ -81,7 +81,7 @@ class TaskModule extends BaseModule {
   loadTasks(tasksPath) {
     let application = this.getApplication();
     let taskFiles   = this.getTaskFilePaths(tasksPath);
-    let connection  = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : null;
+    let connection  = (typeof application.getConnection === 'function') ? application.getConnection() : null;
     let dbConfig    = (typeof application.getDBConfig === 'function') ? application.getDBConfig() : null;
     let tasks       = {};
     let args        = { application, connection, dbConfig };
@@ -126,22 +126,18 @@ class TaskModule extends BaseModule {
         promise.reject(error);
       };
 
-      const _runTask = () => {
-        let result = taskInstance.execute(lastTime, currentTime, diff);
-
-        if (Nife.instanceOf(result, 'promise')) {
-          result.then(
-            successResult,
-            errorResult,
-          );
-        } else {
-          promise.resolve(result);
+      const _runTask = async () => {
+        try {
+          let result = await taskInstance.execute(lastTime, currentTime, diff);
+          successResult(result);
+        } catch (error) {
+          errorResult(error);
         }
       };
 
       const runTask = async () => {
         let application   = this.getApplication();
-        let dbConnection  = (typeof application.getDBConnection === 'function') ? application.getDBConnection() : undefined;
+        let dbConnection  = (typeof application.getConnection === 'function') ? application.getConnection() : undefined;
 
         if (dbConnection && typeof dbConnection.createContext === 'function')
           await dbConnection.createContext(_runTask, dbConnection, dbConnection);

package/src/utils/test-utils.js

@@ -115,8 +115,8 @@ function createTestApplication(ApplicationClass) {
     async start(...args) {
       let result = await super.start(...args);
 
-      if (typeof this.getDBConnection === 'function') {
-        let connection = this.getDBConnection();
+      if (typeof this.getConnection === 'function') {
+        let connection = this.getConnection();
         await this.createAllTables(connection);
       }
 
@@ -142,7 +142,7 @@ function createTestApplication(ApplicationClass) {
     }
 
     async truncateAllTables(exclude) {
-      let connection  = this.getDBConnection();
+      let connection  = this.getConnection();
       let models      = this.getModels();
       let modelNames  = Object.keys(models);
 
@@ -173,7 +173,7 @@ function createTestApplication(ApplicationClass) {
       try {
         let Klass = callback.call(this, OriginalModel);
 
-        let connection = this.getDBConnection();
+        let connection = this.getConnection();
         connection.registerModel(Klass);
 
         return await runner.call(this, Klass);