ti2 1.0.15 → 1.0.18

package/.eslintrc.js

@@ -42,4 +42,5 @@ module.exports = {
       },
     ],
   },
+  ignorePatterns: ['**/docs/*'],
 };

package/.github/workflows/tests.yml

@@ -1,15 +1,13 @@
 name: Tests Workflow
 
-on:
-  workflow_dispatch:
-  push:
+on: [workflow_dispatch, push, pull_request]
 
 jobs:
   test:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     container:
-      image: node:erbium
+      image: node:16.15.0
     services:
       mysql:
         image: mysql
@@ -19,9 +17,12 @@ jobs:
           MYSQL_ROOT_PASSWORD: root
         ports:
           - 3306:3306
+      redis:
+        image: redis
     env:
       CI: true
       DB_URL: 'mysql://root:root@mysql/ti2development'
+      REDIS_URL: 'redis://redis:6379'
       dbCryptoKey: 'YmYzYzE5OWMyNDcwY2I0NzdkOTA3YjFlMDkxN2MxN2I='
       jwtSecret: '9rifawckwztuKehocJOtGM6deTqICGWzIyc5CqgNyi'
       frontendKey: 'lYjEJHzb7lbQ1hk3ypjX'
@@ -32,10 +33,11 @@ jobs:
       with:
         node-version: 12
     - name: install dependencies
-      run: npm i
+      run: npm ci
     - name: create/migrate the database
       run: npx sequelize db:create && npx sequelize db:migrate
     - name: seed the database
       run: npx sequelize db:seed:all
+    - run: RUNNER_TRACKING_ID="" && (nohup node ./test/worker.js&)
     - name: run the tests
       run: npx jest -i --coverage --forceExit

package/.nvmrc

@@ -0,0 +1 @@
+v16.15.0

package/api.yml

@@ -29,6 +29,34 @@ components:
       properties:
         value:
           type: string
+    JobSpec:
+      type: object
+      properties:
+        payload:
+          type: object
+          description: The job app parameters
+          required: true
+          example: '{
+            "method": "dailyReport"
+          }'
+        jobParams:
+          type: object
+          description: Additional bull job params
+          example: '{
+            "delay": "5000"
+          }'
+    JobStatus:
+      type: object
+      properties:
+        jobId:
+          type: string
+        status:
+          type: string
+          example: 'active'
+        result:
+          type: object
+          description: The job return values
+          example: '{ "result": "value" }'
     App:
       type: object
       properties:
@@ -534,6 +562,128 @@ paths:
           content:
             application/json:
               schema: '#/components/schemas/Message'
+
+  /{app}/{userId}/jobRun:
+    security:
+      - bearerAuth: ['app', 'user', 'admin']
+    post:
+      tags:
+        - jobs
+      summary: Run a Job
+      security:
+        - bearerAuth: ['app', 'user', 'admin']
+      operationId: runAppJob
+      parameters:
+        - name: app
+          in: path
+          description: app that defines the job
+          example: 'ventrata'
+          required: true
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: user to run the schedule app against
+          example: '536830b6ed19afa44a000002'
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: The job parameters
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/JobSpec'
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema: '#/components/schemas/JobStatus'
+  /{app}/{userId}/{hint}/jobRun:
+    security:
+      - bearerAuth: ['app', 'user', 'admin']
+    post:
+      tags:
+        - jobs
+      summary: Run a schedule Job
+      security:
+        - bearerAuth: ['app', 'user', 'admin']
+      operationId: runAppJob
+      parameters:
+        - name: app
+          in: path
+          description: app that defines the job
+          example: 'ventrata'
+          required: true
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: user to run the schedule app against
+          example: '536830b6ed19afa44a000002'
+          required: true
+          schema:
+            type: string
+        - name: hint
+          in: path
+          description: a specific token hint to be used
+          required: true
+          example: 'travelgate-australia'
+          schema:
+            type: string
+      requestBody:
+        description: The job parameters
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/JobSpec'
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema: '#/components/schemas/JobStatus'
+  /{app}/{userId}/{jobId}/jobStatus:
+    security:
+      - bearerAuth: ['app', 'user', 'admin']
+    get:
+      tags:
+        - jobs
+      summary: Get the status and/or result from a job
+      security:
+        - bearerAuth: ['app', 'user', 'admin']
+      operationId: getJobStatus
+      parameters:
+        - name: app
+          in: path
+          description: app that defines the job
+          example: 'ventrata'
+          required: true
+          schema:
+            type: string
+        - name: userId
+          in: path
+          description: user that owns the job
+          example: '536830b6ed19afa44a000002'
+          required: true
+          schema:
+            type: string
+        - name: jobId
+          in: path
+          description: jobId to get the status for
+          example: '536830b6ed19afa44a000002'
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema: '#/components/schemas/JobStatus'
   /user/{userId}/apps:
     get:
       security:

package/auth/authHandler.js

@@ -68,10 +68,10 @@ const frontend = async (req, res, next) => {
 };
 
 const adminOrUser = levels => async (req, res, next) => {
-  result = await Promise.all(levels.map(
+  const result = await Promise.all(levels.map(
     level => level(req, res, err => err),
   ));
-  if (result.some(val => (!Boolean(val)))) {
+  if (result.some(val => (!val))) {
     return next();
   }
   return next(result[0]);

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/closeAll.js

@@ -0,0 +1,6 @@
+const { redisResults, queue } = require('./worker/queue');
+
+module.exports = async () => {
+  await queue.close();
+  await redisResults.quit();
+};

package/controllers/__tests__/admin.js

@@ -1,4 +1,4 @@
-/* globals describe it expect */
+/* globals beforeAll describe it expect */
 
 const chance = require('chance').Chance();
 const testUtils = require('../../test/utils');
@@ -15,11 +15,18 @@ describe('admin', () => {
     packageName: `ti2-${appName}`,
     adminEmail: chance.email(),
   };
-  const { doApiPost, doApiGet } = testUtils({
-    plugins: [appName],
-  });
   let appKey;
   const userId = '536830b6ed19afa44a000002';
+  let doApiPost; let
+    doApiGet;
+  beforeAll(async () => {
+    ({
+      doApiGet,
+      doApiPost,
+    } = await testUtils({
+      plugins: [appName],
+    }));
+  });
   it('should be able to create an app', async () => {
     ({ value: appKey } = await doApiPost({
       url: '/app',
@@ -33,11 +40,7 @@ describe('admin', () => {
       url: '/apps',
       token: adminKey,
     });
-    expect(integrations).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining(newApp),
-      ]),
-    );
+    expect(integrations.find(({ name }) => name === newApp.name)).toBeTruthy();
   });
   it('should be able to reset an app\'s key', async () => {
     const url = `/app/resetAppKey/${newApp.name}`;

package/controllers/__tests__/app.js

@@ -1,9 +1,11 @@
-/* globals describe it expect */
-
+/* globals beforeAll describe it expect */
 const chance = require('chance').Chance();
 const jwt = require('jwt-promise');
+const R = require('ramda');
+
 const testUtils = require('../../test/utils');
 const slugify = require('../../test/slugify');
+const appController = require('../app');
 
 const { env: { adminKey, jwtSecret } } = process;
 
@@ -16,9 +18,9 @@ describe('app', () => {
     packageName: `ti2-${appName}`,
     adminEmail: chance.email(),
   };
-  const { doApiPost, doApiGet, doApiPut } = testUtils({
-    plugins: [appName],
-  });
+  let doApiPost;
+  let doApiGet;
+  let doApiPut;
   let appKey;
   const userId = chance.guid();
   const apiKey = chance.guid();
@@ -31,6 +33,11 @@ describe('app', () => {
     payload: { lorem: chance.paragraph() },
   };
   let encodedKey;
+  beforeAll(async () => {
+    ({ doApiPost, doApiGet, doApiPut } = await testUtils({
+      plugins: [appName],
+    }));
+  });
   it('should create a new app', async () => {
     ({ value: appKey } = await doApiPost({
       url: '/app',
@@ -62,6 +69,51 @@ describe('app', () => {
     });
     expect(parseInt(value, 10)).toBeGreaterThan(0);
   });
+  describe('jobs', () => {
+    it('the scheduled job should have been created for the user', async () => {
+      const jobs = R.path(
+        ['jobs'],
+        await appController.getAppScheduledJobs({
+          integrationId: appName,
+          userId,
+        }),
+      );
+      expect(Array.isArray(jobs)).toBeTruthy();
+      expect(R.head(R.project(['pluginJobId', 'cron'], jobs)))
+        .toEqual({
+          pluginJobId: 'dailyReport',
+          cron: '0 9 * * *',
+        });
+    });
+    it.todo('if a new version of the plugin has a different set of scheduled tasks, they shoul dbe re-syncjed');
+    let jobId;
+    it('should be able to run a job', async () => {
+      let status;
+      ({ jobId, status } = await doApiPost({
+        url: `/${appName}/${userId}/jobRun`,
+        token: appKey,
+        payload: {
+          payload: {
+            method: 'dailyReport',
+          },
+        },
+      }));
+      expect(jobId).toBeTruthy();
+      expect(status).toBeTruthy();
+    });
+    it('should be able to get the status of a ran job', async () => {
+      await global.sleep(5e3);
+      const url = `/${appName}/${userId}/${jobId}/jobStatus`;
+      const jobStatus = await doApiGet({
+        url,
+        token: appKey,
+        payload: {},
+      });
+      expect(jobStatus.jobId).toBeTruthy();
+      expect(jobStatus.status).toBe('success');
+      expect(jobStatus.result).toEqual({ someVal: true });
+    }, 6e3);
+  });
   it('should be able to get a list of all tokens related to the app', async () => {
     const { userAppKeys } = await doApiGet({
       url: `/app/tokens/${appName}`,

package/controllers/__tests__/bookings.js

@@ -1,4 +1,4 @@
-/* globals describe it expect */
+/* globals beforeAll describe it expect */
 
 const chance = require('chance').Chance();
 const testUtils = require('../../test/utils');
@@ -22,13 +22,19 @@ describe('user: booking search', () => {
     tokenHint: 'testingToken',
     token,
   };
-  const {
-    doApiDelete,
-    doApiGet,
-    doApiPost,
-    plugins,
-  } = testUtils({
-    plugins: [newApp.name],
+  let doApiDelete;
+  let doApiGet;
+  let doApiPost;
+  let plugins;
+  beforeAll(async () => {
+    ({
+      doApiDelete,
+      doApiGet,
+      doApiPost,
+      plugins,
+    } = await testUtils({
+      plugins: [newApp.name],
+    }));
   });
 
   let userToken;
@@ -39,13 +45,17 @@ describe('user: booking search', () => {
         token: adminKey,
         payload: { tokenHint: 'testingToken' },
       });
-    } catch {}
+    } catch (err) {
+      console.debug(err);
+    }
     try {
       await doApiDelete({
         url: '/app/travelgate',
         token: adminKey,
       });
-    } catch {}
+    } catch (err) {
+      console.debug(err);
+    }
   });
   it('create the travelgate app', async () => {
     const { value: apiKey } = await doApiPost({

package/controllers/__tests__/ping.js

@@ -1,8 +1,13 @@
-/* global describe, it, expect */
-
-const { doApiGet } = require('../../test/utils')();
+/* global beforeAll, describe, it, expect */
+const testUtils = require('../../test/utils');
 
 describe('ping', () => {
+  let doApiGet;
+  beforeAll(async () => {
+    ({
+      doApiGet,
+    } = await testUtils());
+  });
   it('should get a server pong', async () => {
     const response = await doApiGet({
       url: '/ping',

package/controllers/__tests__/user.js

@@ -15,9 +15,8 @@ describe('user', () => {
     packageName: `ti2-${appName}`,
     adminEmail: chance.email(),
   };
-  const { doApiPost, doApiGet, doApiDelete } = testUtils({
-    plugins: [appName],
-  });
+  let doApiGet; let doApiPost; let
+    doApiDelete;
   let appKey;
   const userId = chance.guid();
   let apiKey = chance.guid();
@@ -27,6 +26,13 @@ describe('user', () => {
     apiKey,
   };
   beforeAll(async () => {
+    ({
+      doApiDelete,
+      doApiGet,
+      doApiPost,
+    } = await testUtils({
+      plugins: [appName],
+    }));
     // create an App
     ({ value: appKey } = await doApiPost({
       url: '/app',

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,
 };