ti2 1.0.15 → 1.0.16

package/.github/workflows/tests.yml

@@ -1,8 +1,6 @@
 name: Tests Workflow
 
-on:
-  workflow_dispatch:
-  push:
+on: [workflow_dispatch, push, pull_request]
 
 jobs:
   test:

package/cli.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const { Command, Argument } = require('commander');
+
+const { migrateApp } = require('./controllers/app');
+const { migrate } = require('./controllers/admin');
+
+const program = new Command();
+
+program
+  .name('ti2-cli')
+  .description('TI2 Command line interface utilities')
+  .version((require('./package.json')).version);
+
+program.command('dbapp')
+  .description('Handle database migrations for apps')
+  .argument('<string>', 'integration to operate on')
+  .addArgument(
+    new Argument('<action>', 'action to take', 'migrate')
+      .choices(['migrate', 'revert']),
+  )
+  .action(async (integration, action) => {
+    await migrateApp({ integrationId: integration, action });
+  });
+
+program.command('db')
+  .description('Handle database migrations for integrations')
+  .addArgument(
+    new Argument('<action>', 'action to take', 'migrate')
+      .choices(['migrate', 'revert']),
+  )
+  .action(async action => {
+    await migrate({ action });
+  });
+
+program.parse();

package/controllers/admin.js

@@ -1,6 +1,11 @@
 const jwt = require('jsonwebtoken');
 const assert = require('assert');
 const { omit } = require('ramda');
+const { Umzug, SequelizeStorage } = require('umzug');
+const Sequelize = require('sequelize');
+const fs = require('fs').promises;
+const path = require('path');
+
 const sqldb = require('../models');
 
 const { env: { jwtSecret } } = process;
@@ -91,10 +96,50 @@ const resetIntegrationToken = async (req, res, next) => {
   }
 };
 
+const migrate = async ({ action }) => {
+  const { sequelize } = sqldb;
+  const migrationsPath = path.join(
+    __dirname,
+    '../',
+    'migrations',
+  );
+  try {
+    await fs.access(migrationsPath);
+  } catch (err) {
+    throw Error(`Could not find any migrations on ${migrationsPath}`);
+  }
+  const umzug = new Umzug({
+    migrations: {
+      glob: `${migrationsPath}/*.js`,
+      resolve: ({ name, path: migPath, context }) => {
+        const migration = require(migPath);
+        return {
+          name,
+          up: async () => migration.up(context, Sequelize),
+          down: async () => migration.down(context, Sequelize),
+        };
+      },
+    },
+    context: sequelize.getQueryInterface(),
+    storage: new SequelizeStorage({
+      sequelize,
+    }),
+    logger: console,
+  });
+  if (action === 'migrate') {
+    return umzug.up();
+  }
+  if (action === 'revert') {
+    return umzug.down({ to: 0 });
+  }
+  throw Error('No recognized action');
+};
+
 module.exports = {
   createApp,
-  deleteApp,
   createUserToken,
+  deleteApp,
   listApps,
+  migrate,
   resetIntegrationToken,
 };

package/controllers/app.js

@@ -1,5 +1,11 @@
 const jwt = require('jwt-promise');
 const { omit } = require('ramda');
+const assert = require('assert');
+const { Umzug, SequelizeStorage } = require('umzug');
+const path = require('path');
+const Sequelize = require('sequelize');
+const fs = require('fs').promises;
+
 const sqldb = require('../models');
 
 const { env: { jwtSecret } } = process;
@@ -83,9 +89,54 @@ const listAppTokens = async (req, res, next) => {
   }
 };
 
+const migrateApp = async ({ integrationId, action }) => {
+  const { sequelize } = sqldb;
+  assert(integrationId);
+  assert(action);
+  const migrationsPath = path.join(
+    __dirname,
+    '../',
+    '../',
+    `ti2-${integrationId}`,
+    'migrations',
+  );
+  try {
+    await fs.access(migrationsPath);
+  } catch (err) {
+    throw Error(`Could not find any migrations for ${integrationId} on ${migrationsPath}`);
+  }
+  const umzug = new Umzug({
+    migrations: {
+      glob: `${migrationsPath}/*.js`,
+      resolve: ({ name, path: migPath, context }) => {
+        const migration = require(migPath);
+        return {
+          name,
+          up: async () => migration.up(context, Sequelize),
+          down: async () => migration.down(context, Sequelize),
+        };
+      },
+    },
+    context: sequelize.getQueryInterface(),
+    storage: new SequelizeStorage({
+      sequelize,
+      tableName: `SequelizeMeta-${integrationId}`,
+    }),
+    logger: console,
+  });
+  if (action === 'migrate') {
+    return umzug.up();
+  }
+  if (action === 'revert') {
+    return umzug.down({ to: 0 });
+  }
+  throw Error('No recognized action');
+};
+
 module.exports = {
-  jwtEncode,
   createAppToken,
   deleteAppToken,
+  jwtEncode,
   listAppTokens,
+  migrateApp,
 };

package/models/db.js

@@ -7,7 +7,6 @@ const {
 } = process;
 
 const options = {
-  operatorsAliases: false,
   logging: false,
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git+https://github.com/ti2travel/ti2.git"
   },
+  "bin": "./cli.js",
   "author": "",
   "license": "GPL-3",
   "bugs": {
@@ -20,6 +21,7 @@
   "homepage": "https://github.com/ti2travel/ti2#readme",
   "dependencies": {
     "bluebird": "^3.7.2",
+    "commander": "^9.2.0",
     "express": "^4.17.2",
     "js-yaml": "^4.1.0",
     "jsonwebtoken": "^8.5.1",
@@ -32,6 +34,7 @@
     "swagger-express-middleware": "3.0.0-alpha.5",
     "swagger-routes-express": "3.3.1",
     "swagger-ui-express": "4.3.0",
+    "umzug": "^3.1.1",
     "uninstall": "^0.0.0"
   },
   "devDependencies": {

package/tutorials/plugin-development.md

@@ -216,14 +216,17 @@ Ti2 uses [Sequelize v6.13](https://sequelize.org/v6) which is the database ORM w
 
 Migrations should be run after the fact, from the root of ti2 instance like so:
 
-
 ```
-$  npm explore ti2<pluginName> -- npx sequelize db:migrate"
+$ ti2 dbapp [plugin name] migrate
 ```
 
 We strongly encourage all the plugin's table names are prefixed with the plugin name (i.e. ti2-pluginName-cacheTable).
 
-This should be executed after the ti2 project migrations have been executed.
+This should be executed after all ti2 host migrations had been executed.
+
+```
+$ ti2 db migrate
+```
 
 ## Scheduled Task (to be released on v2)
 

package/tutorials/setup-your-instance.md

@@ -52,7 +52,7 @@ $ npm i ti2 ti2-tourconnect
 After installing the ti2 package you need to run the database migrations for ti2:
 
 ```
-$  npm explore ti2<pluginName> -- npx sequelize db:migrate"
+$  ti2 db migrate
 ```
 
 ### Entry File