Merge pull request #68 from leapfrogtechnology/make-migration

Introduce make command to generate migration files

Author: kabirbaidhya

assets/templates/migration/create_down.sql

@@ -0,0 +1 @@
+DROP TABLE {{table}};

assets/templates/migration/create_up.sql

@@ -0,0 +1,6 @@
+--
+-- Create {{table}} table.
+--
+CREATE TABLE {{table}} (
+  id INT PRIMARY KEY
+);

package.json

@@ -8,7 +8,8 @@
   "files": [
     "/bin/run",
     "/bin/run.cmd",
-    "/lib"
+    "/lib",
+    "/assets"
   ],
   "bin": {
     "sync-db": "./bin/run"

src/commands/make.ts

@@ -0,0 +1,55 @@
+import { loadConfig } from '../config';
+import { printLine } from '../util/io';
+import { Command, flags } from '@oclif/command';
+import Configuration from '../domain/Configuration';
+import * as fileMakerService from '../service/fileMaker';
+
+class Make extends Command {
+  static description = 'Make migration files from the template.';
+
+  static args = [{ name: 'name', description: 'Object or filename to generate.', required: true }];
+  static flags = {
+    type: flags.string({
+      char: 't',
+      helpValue: 'TYPE',
+      description: 'Type of file to generate.',
+      default: 'migration',
+      options: ['migration', 'view', 'procedure', 'function']
+    })
+  };
+
+  /**
+   * CLI command execution handler.
+   *
+   * @returns {Promise<void>}
+   */
+  async run(): Promise<void> {
+    const { args, flags: parsedFlags } = this.parse(Make);
+    const config = await loadConfig();
+    const list = await this.makeFiles(config, args.name, parsedFlags.type);
+
+    for (const filename of list) {
+      await printLine(`Created ${filename}`);
+    }
+  }
+
+  /**
+   * Make files based on the given name and type.
+   *
+   * @param {Configuration} config
+   * @param {string} name
+   * @param {string} [type]
+   * @returns {Promise<string[]>}
+   */
+  async makeFiles(config: Configuration, name: string, type?: string): Promise<string[]> {
+    switch (type) {
+      case 'migration':
+        return fileMakerService.makeMigration(config, name);
+
+      default:
+        throw new Error(`Unsupported file type ${type}.`);
+    }
+  }
+}
+
+export default Make;

src/migration/service/knexMigrator.ts

@@ -80,12 +80,7 @@ export async function resolveMigrationContext(
 
   log(`Initialize migration context [sourceType=${config.migration.sourceType}]`);
 
-  const { basePath, migration } = config;
-
-  // Migration directory could be absolute OR could be relative to the basePath.
-  const migrationPath = path.isAbsolute(migration.directory)
-    ? migration.directory
-    : path.join(basePath, migration.directory);
+  const migrationPath = getMigrationPath(config);
 
   switch (config.migration.sourceType) {
     case 'sql':
@@ -101,3 +96,19 @@ export async function resolveMigrationContext(
       throw new Error(`Unsupported migration.sourceType value "${config.migration.sourceType}".`);
   }
 }
+
+/**
+ * Get Migration directory path.
+ *
+ * @param {Configuration} config
+ * @returns {string}
+ */
+export function getMigrationPath(config: Configuration): string {
+  const { basePath, migration } = config;
+  // Migration directory could be absolute OR could be relative to the basePath.
+  const migrationPath = path.isAbsolute(migration.directory)
+    ? migration.directory
+    : path.join(basePath, migration.directory);
+
+  return migrationPath;
+}

src/service/fileMaker.ts

@@ -0,0 +1,62 @@
+import * as path from 'path';
+
+import * as fs from '../util/fs';
+import { log } from '../util/logger';
+import { interpolate } from '../util/string';
+import { getTimestampString } from '../util/ts';
+import Configuration from '../domain/Configuration';
+import { getMigrationPath } from '../migration/service/knexMigrator';
+
+const MIGRATION_TEMPLATE_PATH = path.resolve(__dirname, '../../assets/templates/migration');
+const CREATE_TABLE_CONVENTION = /create_(\w+)_table/;
+
+/**
+ * Generate migration file(s).
+ *
+ * @param {string} filename
+ * @returns {Promise<string[]>}
+ */
+export async function makeMigration(config: Configuration, filename: string): Promise<string[]> {
+  if (config.migration.sourceType !== 'sql') {
+    // TODO: We'll need to support different types of migrations eg both sql & js
+    // For instance migrations in JS would have different context like JavaScriptMigrationContext.
+    throw new Error(`Unsupported migration.sourceType value "${config.migration.sourceType}".`);
+  }
+
+  let createUpTemplate = '';
+  let createDownTemplate = '';
+
+  const migrationPath = getMigrationPath(config);
+  const migrationPathExists = await fs.exists(migrationPath);
+
+  if (!migrationPathExists) {
+    log(`Migration path does not exist, creating ${migrationPath}`);
+
+    await fs.mkdir(migrationPath, { recursive: true });
+  }
+
+  const timestamp = getTimestampString();
+  const upFilename = path.join(migrationPath, `${timestamp}_${filename}.up.sql`);
+  const downFilename = path.join(migrationPath, `${timestamp}_${filename}.down.sql`);
+
+  // Use the create migration template if the filename follows the pattern: create_<table>_table.sql
+  const createTableMatched = filename.match(CREATE_TABLE_CONVENTION);
+
+  if (createTableMatched) {
+    const table = createTableMatched[1];
+
+    log(`Create migration for table: ${table}`);
+
+    createUpTemplate = await fs
+      .read(path.join(MIGRATION_TEMPLATE_PATH, 'create_up.sql'))
+      .then(template => interpolate(template, { table }));
+    createDownTemplate = await fs
+      .read(path.join(MIGRATION_TEMPLATE_PATH, 'create_down.sql'))
+      .then(template => interpolate(template, { table }));
+  }
+
+  await fs.write(upFilename, createUpTemplate);
+  await fs.write(downFilename, createDownTemplate);
+
+  return [upFilename, downFilename];
+}

src/util/fs.ts

@@ -3,6 +3,8 @@ import * as os from 'os';
 import * as path from 'path';
 import { promisify } from 'util';
 
+export const mkdir = promisify(fs.mkdir);
+
 /**
  * Create a temporary directory and return it's path.
  *

src/util/string.ts

@@ -0,0 +1,31 @@
+/**
+ * Interpolate a given template string by filling the placeholders with the params.
+ *
+ * Placeholder syntax:
+ *  {{name}}
+ *
+ * @example
+ * interpolate('<div>{{text}}</div>', {text: 'Hello World!'})
+ *  => '<div>Hello World!</div>'
+ *
+ * @param {string} template
+ * @param {*} [params={}]
+ * @returns {string}
+ */
+export function interpolate(template: string, params: any = {}): string {
+  if (!params || !Object.keys(params)) {
+    return template;
+  }
+
+  let result = template;
+
+  for (const [key, value] of Object.entries(params)) {
+    if (value === null || value === undefined) {
+      continue;
+    }
+
+    result = result.replace(new RegExp('{{' + key + '}}', 'g'), `${value}`);
+  }
+
+  return result;
+}

src/util/ts.ts

@@ -17,3 +17,36 @@ export function getElapsedTime(timeStart: [number, number], fixed: false | numbe
 
   return Number(timeElapsed.toFixed(fixed));
 }
+
+/**
+ * Gets a timestamp string for the given date.
+ *
+ * @param {Date} [date=new Date()]
+ * @returns {string}
+ */
+export function getTimestampString(date: Date = new Date()): string {
+  const dtf = new Intl.DateTimeFormat('en', {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit',
+    hour: '2-digit',
+    minute: '2-digit',
+    second: '2-digit'
+  });
+
+  const [
+    { value: month },
+    ,
+    { value: day },
+    ,
+    { value: year },
+    ,
+    { value: hour },
+    ,
+    { value: minute },
+    ,
+    { value: second }
+  ] = dtf.formatToParts(date);
+
+  return `${year}${month}${day}${hour}${minute}${second}`;
+}

test/cli/commands/common.test.ts

@@ -11,7 +11,7 @@ const packageJson = fs.readFileSync(path.join(__dirname, '../../../package.json'
 const { version } = JSON.parse(packageJson.toString());
 
 describe('CLI:', () => {
-  describe('default run', () => {
+  describe('with no args', () => {
     it('should display the usage information.', async () => {
       const { stdout } = await runCli([], { cwd });