feat(yargs): add table-name and attribute-name cli options

The options will overwrite the default DynamoDB tableName and primaryKey attribute options

Author: floydspace

src/commands/migrate-undo-all.ts

@@ -1,7 +1,6 @@
 import { CommandModule } from 'yargs';
 
-import { defaultMigrator } from '../core/migrator';
-import { BaseCliOptions, baseOptions } from '../core/yargs';
+import { BaseCliOptions, baseHandler, baseOptions } from '../core/yargs';
 import logger from '../helpers/logger';
 
 interface CliOptions extends BaseCliOptions {
@@ -16,21 +15,21 @@ export default {
       type: 'string'
     }),
 
-  handler: async (args) => {
+  handler: baseHandler(async (args, migrator) => {
     try {
-      const migrations = await defaultMigrator.executed();
+      const migrations = await migrator.executed();
 
       if (migrations.length === 0) {
         logger.log('No executed migrations found.');
 
         process.exit(0);
       }
 
-      await defaultMigrator.down({ to: args.to || 0 });
+      await migrator.down({ to: args.to || 0 });
     } catch (e) {
       logger.error(e);
     }
 
     process.exit(0);
-  }
+  })
 } as CommandModule<CliOptions, CliOptions>;

src/commands/migrate-undo.ts

@@ -1,7 +1,6 @@
 import { CommandModule } from 'yargs';
 
-import { defaultMigrator } from '../core/migrator';
-import { BaseCliOptions, baseOptions } from '../core/yargs';
+import { BaseCliOptions, baseHandler, baseOptions } from '../core/yargs';
 import logger from '../helpers/logger';
 
 interface CliOptions extends BaseCliOptions {
@@ -15,9 +14,9 @@ export default {
       type: 'string'
     }),
 
-  handler: async (args) => {
+  handler: baseHandler(async (args, migrator) => {
     try {
-      const migrations = await defaultMigrator.executed();
+      const migrations = await migrator.executed();
 
       if (migrations.length === 0) {
         logger.log('No executed migrations found.');
@@ -26,14 +25,14 @@ export default {
       }
 
       if (args.name) {
-        await defaultMigrator.down(args.name);
+        await migrator.down(args.name);
       } else {
-        await defaultMigrator.down();
+        await migrator.down();
       }
     } catch (e) {
       logger.error(e);
     }
 
     process.exit(0);
-  }
+  })
 } as CommandModule<CliOptions, CliOptions>;

src/commands/migrate.ts

@@ -1,7 +1,7 @@
 import { CommandModule } from 'yargs';
 
-import { defaultMigrator } from '../core/migrator';
-import { BaseCliOptions, baseOptions } from '../core/yargs';
+import { Migrator } from '../core/migrator';
+import { BaseCliOptions, baseHandler, baseOptions } from '../core/yargs';
 import logger from '../helpers/logger';
 
 interface CliOptions extends BaseCliOptions {
@@ -20,26 +20,26 @@ export default {
       type: 'string'
     }),
 
-  handler: async function (args) {
+  handler: baseHandler(async (args, migrator) => {
     const command = args._[0];
 
     switch (command) {
       case 'migrate':
-        await migrate(args);
+        await migrate(args, migrator);
         break;
       case 'migrate:status':
-        await migrationStatus();
+        await migrationStatus(migrator);
         break;
     }
 
     process.exit(0);
-  }
+  })
 } as CommandModule<CliOptions, CliOptions>;
 
-async function migrate(args: CliOptions) {
+async function migrate(args: CliOptions, migrator: Migrator) {
   try {
-    const migrations = await defaultMigrator.pending();
-    const options: Partial<CliOptions> = {};
+    const migrations = await migrator.pending();
+    const options = {} as CliOptions;
 
     if (migrations.length === 0) {
       logger.log('No migrations were executed, database schema was already up to date.');
@@ -60,21 +60,21 @@ async function migrate(args: CliOptions) {
       options.from = args.from;
     }
 
-    await defaultMigrator.up(options);
+    await migrator.up(options);
   } catch (e) {
     logger.error(e);
   }
 }
 
-async function migrationStatus() {
+async function migrationStatus(migrator: Migrator) {
   try {
-    const executedMigrations = await defaultMigrator.executed();
+    const executedMigrations = await migrator.executed();
 
     executedMigrations.forEach(migration => {
       logger.log('up', migration.file);
     });
 
-    const pendingMigrations = await defaultMigrator.pending();
+    const pendingMigrations = await migrator.pending();
 
     pendingMigrations.forEach(migration => {
       logger.log('down', migration.file);

src/commands/migration-generate.ts

@@ -2,8 +2,7 @@ import clc from 'cli-color';
 import path from 'path';
 import { CommandModule } from 'yargs';
 
-import { defaultMigrator } from '../core/migrator';
-import { BaseCliOptions, baseOptions } from '../core/yargs';
+import { BaseCliOptions, baseHandler, baseOptions } from '../core/yargs';
 import logger from '../helpers/logger';
 
 interface CliOptions extends BaseCliOptions {
@@ -18,8 +17,8 @@ export default {
       demandOption: true
     }),
 
-  handler: async (args) => {
-    await defaultMigrator.generate(args.name);
+  handler: baseHandler(async (args, migrator) => {
+    await migrator.generate(args.name);
 
     logger.log(
       'New migration was created at',
@@ -28,5 +27,5 @@ export default {
     );
 
     process.exit(0);
-  }
+  })
 } as CommandModule<CliOptions, CliOptions>;

src/core/migrator.ts

@@ -11,6 +11,7 @@ export {DynamoDBStorage};
 export interface MigratorOptions {
   dynamodb?: DocumentClient;
   tableName?: string;
+  attributeName?: string;
 }
 
 export class Migrator {
@@ -22,13 +23,15 @@ export class Migrator {
    * @param options
    * @param options.dynamodb - a DynamoDB document client instance
    * @param options.tableName - a name of migration table in DynamoDB
+   * @param options.attributeName - name of the table primaryKey attribute in DynamoDB
    */
-  constructor({ dynamodb, tableName }: MigratorOptions = {}) {
+  constructor({ dynamodb, tableName, attributeName }: MigratorOptions = {}) {
     dynamodb = dynamodb || new DocumentClient();
     tableName = tableName || 'migrations';
+    attributeName = attributeName || 'name';
 
     this.umzug = new Umzug({
-      storage: new DynamoDBStorage({ dynamodb, tableName }),
+      storage: new DynamoDBStorage({ dynamodb, tableName, attributeName }),
       migrations: {
         params: [dynamodb],
       },

src/core/yargs.ts

@@ -1,4 +1,6 @@
-import { Argv } from 'yargs';
+import { Arguments, Argv } from 'yargs';
+
+import { Migrator } from './migrator';
 
 export interface BaseCliOptions {
   'options-path': string;
@@ -7,6 +9,8 @@ export interface BaseCliOptions {
   'secret-access-key': string;
   'region': string;
   'endpoint-url': string;
+  'table-name': string;
+  'attribute-name': string;
 }
 
 export function baseOptions(yargs: Argv<BaseCliOptions>) {
@@ -33,7 +37,26 @@ export function baseOptions(yargs: Argv<BaseCliOptions>) {
       type: 'string'
     })
     .option('endpoint-url', {
-      describe: 'The DynamoDB endpoint url to use',
+      describe: 'The DynamoDB endpoint url to use. The DynamoDB local instance url could be specified here.',
+      type: 'string'
+    })
+    .option('table-name', {
+      describe: 'The DynamoDB table name. `migrations` is default.',
+      type: 'string'
+    })
+    .option('attribute-name', {
+      describe: 'The DynamoDB primaryKey attribute name. `name` is default.',
       type: 'string'
     });
 }
+
+export function baseHandler<T extends BaseCliOptions>(callback: (args: Arguments<T>, migrator: Migrator) => void) {
+  return (args: Arguments<T>): void => {
+    const migrator = new Migrator({
+      tableName: args['table-name'],
+      attributeName: args['attribute-name'],
+    });
+
+    callback(args, migrator);
+  };
+}