ti2 1.0.94 → 1.0.95

package/.github/workflows/tests.yml

@@ -7,7 +7,7 @@ jobs:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     container:
-      image: node:16.15.0
+      image: node:16.20.0
     services:
       mysql:
         image: mysql
@@ -31,13 +31,17 @@ jobs:
     - uses: actions/checkout@v2
     - uses: actions/setup-node@v1
       with:
-        node-version: 12
+        node-version: 16
     - name: install dependencies
       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: start worker process
+      run: RUNNER_TRACKING_ID="" node ./test/worker.js > worker.log 2>&1 &
     - name: run the tests
       run: npx jest -i --coverage --forceExit
+    - name: display worker logs
+      if: ${{ failure() }}
+      run: cat worker.log

package/api.yml

@@ -13,6 +13,78 @@ components:
       scheme: bearer
       bearerFormat: JWT
   schemas:
+    CronJob:
+      type: object
+      properties:
+        id:
+          type: string
+          description: uuid of the crojob to remove
+          example: '550e8400-e29b-41d4-a716-446655440000'
+        method:
+          type: string
+          description: HTTP method for the API call
+          example: 'POST'
+          enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH']
+        url:
+          type: string
+          description: URL path for the API call
+          example: '/products/travelgate-hotelx/123/search'
+        cron:
+          type: string
+          description: Cron expression for job scheduling
+          example: '0 0 * * *'
+        userId:
+          type: string
+          description: User ID associated with the job
+        body:
+          type: object
+          description: body for the scheduled rquest
+        removeOnComplete:
+          type: boolean
+          description: Whether the job should be removed from the queue after successful completion (for one-off executions).
+          default: false
+    CronJobList:
+      type: object
+      properties:
+        jobs:
+          type: array
+          items:
+            $ref: '#/components/schemas/CronJob'
+    CronJobCreate:
+      type: object
+      required:
+        - method
+        - url
+        - cron
+      properties:
+        method:
+          type: string
+          description: HTTP method for the API call
+          example: 'POST'
+          enum: ['GET', 'POST', 'PUT', 'DELETE', 'PATCH']
+        url:
+          type: string
+          description: URL path for the API call
+          example: '/products/travelgate-hotelx/123/search'
+        cron:
+          type: string
+          description: Cron expression for job scheduling
+          example: '0 0 * * *'
+        callbackUrl:
+          type: string
+          description: Optional URL to call after job completion
+          example: 'https://example.com/callback'
+        payload:
+          type: object
+          description: Optional payload for the API call
+          example:
+            startDate: '01/01/2023'
+            endDate: '03/04/2023'
+            keyPath: 'MAGLUX|7CQLDACMAGLUXDELSUI'
+        removeOnComplete:
+          type: boolean
+          description: Whether the job should be removed from the queue after successful completion (for one-off executions).
+          default: false
     ServerInfo:
       type: object
       properties:
@@ -404,6 +476,93 @@ components:
         type: boolean
         default: false
 paths:
+  /cronjobs/{userId}:
+    get:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - cronjobs
+      summary: List cronjobs for a user
+      operationId: listCronjobs
+      parameters:
+        - name: userId
+          in: path
+          description: User ID to list cronjobs for
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: List of cronjobs
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CronJobList'
+    post:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - cronjobs
+      summary: Create a new cronjob
+      operationId: createCronjob
+      parameters:
+        - name: userId
+          in: path
+          description: User ID to create cronjob for
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CronJobCreate'
+      responses:
+        '200':
+          description: Created cronjob
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CronJob'
+  /cronjobs/{userId}/{id}:
+    delete:
+      security:
+        - bearerAuth: ['admin', 'user']
+      tags:
+        - cronjobs
+      summary: Delete a cronjob
+      operationId: deleteCronjob
+      parameters:
+        - name: userId
+          in: path
+          description: User ID the cronjob belongs to
+          required: true
+          schema:
+            type: string
+        - name: id
+          in: path
+          description: Cron job ID (UUID) to delete
+          required: true
+          schema:
+            type: string
+      responses:
+        '404':
+          description: Cronjob not found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: 'Cronjob not found'
+        '200':
+          description: Success status
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Status'
   /ping:
     get:
       tags:

package/cli.js

@@ -5,6 +5,7 @@ const { Command, Argument } = require('commander');
 const { migrateApp } = require('./controllers/app')();
 const { migrate } = require('./controllers/admin');
 const { decrypt, encrypt } = require('./lib/security');
+const { queue, redisResults } = require('./worker/queue');
 
 const program = new Command();
 
@@ -55,4 +56,109 @@ program.command('encrypt')
     process.exit(0);
   });
 
+program.command('queue:list [pattern]')
+  .description('List jobs in the queue, optionally filtering by ID pattern (e.g., "jobId*", "*suffix", "prefix*suffix")')
+  .action(async (pattern) => {
+    try {
+      await queue.isReady(); // Ensure queue is ready
+      const jobTypes = ['waiting', 'active', 'completed', 'failed', 'delayed', 'paused'];
+      let message = `Fetching jobs of types: ${jobTypes.join(', ')}...`;
+      if (pattern) {
+        message += ` matching pattern "${pattern}"`;
+      }
+      console.log(message);
+      let jobs = await queue.getJobs(jobTypes);
+
+      if (pattern) {
+        const regexPatternText = '^' + pattern.replace(/\./g, '\\.').replace(/\*/g, '.*') + '$';
+        const regexPattern = new RegExp(regexPatternText);
+        console.log(`Using filter regex: ${regexPattern}`);
+        jobs = jobs.filter(job => regexPattern.test(job.id.toString()));
+      }
+
+      if (jobs.length === 0) {
+        if (pattern) {
+          console.log(`No jobs found matching pattern "${pattern}".`);
+        } else {
+          console.log('No jobs found in the queue.');
+        }
+      } else {
+        console.log(`Found ${jobs.length} jobs:`);
+        for (const job of jobs) {
+          const state = await job.getState();
+          const progress = job.progress();
+          const timestamp = new Date(job.timestamp).toISOString();
+          console.log(`\n- ID: ${job.id}`);
+          console.log(`  State: ${state}`);
+          console.log(`  Progress: ${progress}`);
+          console.log(`  Added: ${timestamp}`);
+          console.log(`  Name (Queue): ${job.name}`);
+          console.log(`  Data: ${JSON.stringify(job.data, null, 2)}`);
+          if (job.opts.repeat) {
+            console.log(`  Repeat Options: ${JSON.stringify(job.opts.repeat)}`);
+          }
+          if (state === 'failed' && job.failedReason) {
+            console.log(`  Failed Reason: ${job.failedReason}`);
+          }
+        }
+      }
+    } catch (error) {
+      console.error('Error listing queue jobs:', error);
+      process.exit(1);
+    }
+    process.exit(0);
+  });
+
+program.command('queue:remove')
+  .description('Remove job instances from the queue by ID or pattern (e.g., "jobId*", "*suffix", "prefix*suffix")')
+  .argument('<pattern>', 'Job ID or glob-like pattern for job IDs to remove')
+  .action(async (pattern) => {
+    try {
+      await queue.isReady(); // Ensure queue is ready
+      console.log(`Attempting to remove job instances matching pattern: "${pattern}"`);
+
+      const jobTypes = ['waiting', 'active', 'completed', 'failed', 'delayed', 'paused'];
+      const jobs = await queue.getJobs(jobTypes);
+      let removedCount = 0;
+      const removedJobIds = [];
+
+      const regexPatternText = '^' + pattern.replace(/\./g, '\\.').replace(/\*/g, '.*') + '$';
+      const regexPattern = new RegExp(regexPatternText);
+
+      console.log(`Using regex: ${regexPattern}`);
+
+      for (const job of jobs) {
+        if (regexPattern.test(job.id.toString())) {
+          try {
+            await job.remove();
+            removedJobIds.push(job.id.toString());
+            removedCount++;
+            console.log(`Removed job ${job.id} from Bull queue.`);
+          } catch (e) {
+            console.error(`Failed to remove job ${job.id} from Bull queue:`, e.message);
+          }
+        }
+      }
+
+      if (removedCount > 0) {
+        console.log(`Successfully removed ${removedCount} job instance(s) from Bull queue.`);
+        if (removedJobIds.length > 0) {
+          console.log(`Attempting to remove ${removedJobIds.length} result(s) from Redis for the removed jobs...`);
+          try {
+            const delCount = await redisResults.del(removedJobIds);
+            console.log(`Removed ${delCount} result(s) from Redis.`);
+          } catch (e) {
+            console.error('Failed to remove results from Redis:', e.message);
+          }
+        }
+      } else {
+        console.log(`No job instances found matching pattern "${pattern}".`);
+      }
+    } catch (error) {
+      console.error('Error removing queue jobs:', error);
+      process.exit(1);
+    }
+    process.exit(0);
+  });
+
 program.parse();

package/controllers/__tests__/admin.js

@@ -1,12 +1,12 @@
 /* globals beforeAll describe it expect */
 
 const chance = require('chance').Chance();
-const testUtils = require('../../test/utils');
 const slugify = require('../../test/slugify');
 
 const { env: { adminKey } } = process;
 
 describe('admin', () => {
+  const testUtils = require('../../test/utils');
   const appName = slugify(
     chance.company(),
   );

package/controllers/__tests__/allotments.js

@@ -3,11 +3,10 @@ const axios = require('axios');
 const MockAdapter = require('axios-mock-adapter');
 const chance = require('chance').Chance();
 
-const testUtils = require('../../test/utils');
-
 const { env: { adminKey } } = process;
 
 describe('allotment', () => {
+  const testUtils = require('../../test/utils');
   const newApp = {
     name: 'tourplantest',
     packageName: 'ti2-tourplanTest',

package/controllers/__tests__/app.js

@@ -3,13 +3,13 @@ const chance = require('chance').Chance();
 const jwt = require('jwt-promise');
 const R = require('ramda');
 
-const testUtils = require('../../test/utils');
 const slugify = require('../../test/slugify');
 let appController = require('../app');
 
 const { env: { adminKey, jwtSecret } } = process;
 
 describe('app', () => {
+  const testUtils = require('../../test/utils');
   const appName = slugify(
     chance.company(),
   );

package/controllers/__tests__/bookings.js

@@ -2,12 +2,12 @@
 
 const chance = require('chance').Chance();
 const hash = require('object-hash');
-const testUtils = require('../../test/utils');
 const cache = require('../../cache');
 
 const { env: { adminKey } } = process;
 
 describe('user: bookings controller', () => {
+  const testUtils = require('../../test/utils');
   const newApp = {
     name: 'travelgate',
     packageName: 'ti2-travelgate',
@@ -344,8 +344,18 @@ describe('user: bookings controller', () => {
           expect(products.length).toBe(2); // Based on existing test expectations
         });
 
-        // Plugin should only be called once due to lock mechanism
-        expect(plugins[0].searchProducts).toHaveBeenCalledTimes(1);
+        // Plugin should only be called once due to lock mechanism, and with correct context
+        expect(plugins[0].searchProducts).toHaveBeenCalledWith(
+          expect.objectContaining({
+            token: expect.objectContaining({
+              client: 'tourconnect',
+              endpoint: expect.stringContaining('https://api.travelgatex.com'),
+            }),
+            userId: expect.stringContaining(userId),
+            payload: {},
+            typeDefsAndQueries: expect.any(Object)
+          })
+        );
       });
     });
   });