ti2 1.0.120 → 1.0.121

package/api.yml

@@ -101,6 +101,17 @@ components:
       properties:
         value:
           type: string
+    CreateAppTokenResponse:
+      type: object
+      required:
+        - value
+        - isFirstIntegration
+      properties:
+        value:
+          type: string
+        isFirstIntegration:
+          type: boolean
+          description: True only when this transaction created the user's first integration credential.
     Status:
       type: object
       properties:
@@ -862,7 +873,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Message'
+                $ref: '#/components/schemas/CreateAppTokenResponse'
     delete:
       tags:
         - app

package/controllers/__tests__/user.js

@@ -20,7 +20,7 @@ describe('user', () => {
   let doApiGet; let doApiPost; let
     doApiDelete;
   let app;
-  let sqldb;
+  let db;
   let appKey;
   const userId = chance.guid();
   let apiKey = chance.guid();
@@ -33,7 +33,7 @@ describe('user', () => {
   beforeAll(async () => {
     ({
       app,
-      sqldb,
+      sqldb: db,
       doApiDelete,
       doApiGet,
       doApiPost,
@@ -41,6 +41,7 @@ describe('user', () => {
     } = await testUtils({
       plugins: [appName],
     }));
+    await db.models.UserAppKey.destroy({ where: { userId } });
     // create an App
     ({ value: appKey } = await doApiPost({
       url: '/app',
@@ -117,7 +118,7 @@ describe('user', () => {
     // set up new token
     apiKey = chance.guid();
     token.apiKey = apiKey;
-    await doApiPost({
+    const createResult = await doApiPost({
       url: `/${appName}/${userId}`,
       token: userKey,
       payload: {
@@ -125,6 +126,7 @@ describe('user', () => {
         token,
       },
     });
+    expect(createResult.isFirstIntegration).toBe(true);
     // make sure the app token is there
     const { userAppKeys } = await doApiGet({
       url: `/user/${userId}/apps`,
@@ -140,11 +142,117 @@ describe('user', () => {
       ]),
     );
   });
+  it('reports post-save cron setup failure while preserving the committed credential', async () => {
+    const postCommitUserId = chance.guid();
+    const postCommitUserKey = (await doApiPost({
+      url: '/user',
+      token: adminKey,
+      payload: { userId: postCommitUserId },
+    })).value;
+    const cronLookup = jest.spyOn(db.models.CronJobs, 'findOne')
+      .mockRejectedValueOnce(new Error('cron unavailable'));
+    const consoleError = jest.spyOn(console, 'error').mockImplementation(() => {});
+    try {
+      const result = await doApiPost({
+        url: `/${appName}/${postCommitUserId}`,
+        token: postCommitUserKey,
+        payload: { tokenHint: 'post-commit', token },
+        expectStatusCode: 500,
+      });
+
+      expect(result.message).toContain('cron unavailable');
+      expect(await db.models.UserAppKey.count({ where: { userId: postCommitUserId } })).toBe(1);
+    } finally {
+      cronLookup.mockRestore();
+      consoleError.mockRestore();
+    }
+  });
+
+  it('serializes competing first integrations and marks exactly one as first', async () => {
+    const concurrentUserId = chance.guid();
+    const concurrentUserKey = (await doApiPost({
+      url: '/user',
+      token: adminKey,
+      payload: { userId: concurrentUserId },
+    })).value;
+    const lockTransaction = await db.transaction();
+    await db.models.User.findOne({
+      where: { userId: concurrentUserId },
+      transaction: lockTransaction,
+      lock: lockTransaction.LOCK.UPDATE,
+    });
+    const originalFindOne = db.models.User.findOne.bind(db.models.User);
+    const lockAttempts = [];
+    let releaseLockAttempts;
+    const bothLockAttempts = new Promise(resolveLockAttempts => {
+      releaseLockAttempts = resolveLockAttempts;
+    });
+    const findOne = jest.spyOn(db.models.User, 'findOne').mockImplementation(options => {
+      if (options.transaction !== lockTransaction && options.lock) {
+        lockAttempts.push(options);
+        if (lockAttempts.length === 2) releaseLockAttempts();
+      }
+      return originalFindOne(options);
+    });
+    let settled = 0;
+    let requests;
+    try {
+      requests = [
+        doApiPost({
+          url: `/${appName}/${concurrentUserId}`,
+          token: concurrentUserKey,
+          payload: { tokenHint: 'first-a', token },
+        }),
+        doApiPost({
+          url: `/${appName}/${concurrentUserId}`,
+          token: concurrentUserKey,
+          payload: { tokenHint: 'first-b', token },
+        }),
+      ].map(postRequest => postRequest.finally(() => { settled += 1; }));
+      await bothLockAttempts;
+      expect(lockAttempts).toHaveLength(2);
+      expect(settled).toBe(0);
+    } finally {
+      findOne.mockRestore();
+      await lockTransaction.commit();
+    }
+    const results = await Promise.all(requests);
+
+    expect(results.map(result => result.isFirstIntegration).sort())
+      .toEqual([false, true]);
+    expect(await db.models.UserAppKey.count({ where: { userId: concurrentUserId } })).toBe(2);
+  });
   const apiKey2 = chance.guid();
   const token2 = { ...token };
+  it('replaces a sole existing integration without marking the update as first', async () => {
+    const replaceUserId = chance.guid();
+    const replaceUserKey = (await doApiPost({
+      url: '/user',
+      token: adminKey,
+      payload: { userId: replaceUserId },
+    })).value;
+    const replaceHint = 'replace-existing';
+    const first = await doApiPost({
+      url: `/${appName}/${replaceUserId}`,
+      token: replaceUserKey,
+      payload: { tokenHint: replaceHint, token },
+    });
+    const replacement = await doApiPost({
+      url: `/${appName}/${replaceUserId}`,
+      token: replaceUserKey,
+      payload: { tokenHint: replaceHint, token: { ...token, apiKey: chance.guid() } },
+    });
+
+    expect(first.isFirstIntegration).toBe(true);
+    expect(replacement.isFirstIntegration).toBe(false);
+    expect(await db.models.UserAppKey.count({
+      where: { userId: replaceUserId, integrationId: appName, hint: replaceHint },
+    })).toBe(1);
+  });
+
   it('create a second token', async () => {
     // set up new token
-    await doApiPost({
+    const createResult = await doApiPost({
       url: `/${appName}/${userId}`,
       token: userKey,
       payload: {
@@ -152,6 +260,7 @@ describe('user', () => {
         token: token2,
       },
     });
+    expect(createResult.isFirstIntegration).toBe(false);
   });
   it('should be able to read a user/app token', async () => {
     const returnValue = await doApiGet({
@@ -257,7 +366,7 @@ describe('user', () => {
   it('should return 422 when stored app token is corrupted', async () => {
     const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
     const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-    const [originalRows] = await sqldb.query(
+    const [originalRows] = await db.query(
       'SELECT id, appKey FROM UserAppKeys WHERE integrationId = :integrationId AND userId = :userId',
       {
         replacements: {
@@ -266,7 +375,7 @@ describe('user', () => {
         },
       },
     );
-    await sqldb.query(
+    await db.query(
       'UPDATE UserAppKeys SET appKey = :appKey WHERE integrationId = :integrationId AND userId = :userId',
       {
         replacements: {
@@ -284,7 +393,7 @@ describe('user', () => {
       });
       expect(returnValue.message).toBe('Stored integration token is invalid. Please re-save credentials.');
     } finally {
-      await Promise.all(originalRows.map(currentRow => sqldb.query(
+      await Promise.all(originalRows.map(currentRow => db.query(
         'UPDATE UserAppKeys SET appKey = :appKey WHERE id = :id',
         {
           replacements: {
@@ -300,7 +409,7 @@ describe('user', () => {
   it('should return 422 when stored app token is corrupted for hinted endpoint', async () => {
     const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
     const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-    const [originalRows] = await sqldb.query(
+    const [originalRows] = await db.query(
       'SELECT id, appKey FROM UserAppKeys WHERE integrationId = :integrationId AND userId = :userId AND hint = :hint',
       {
         replacements: {
@@ -310,7 +419,7 @@ describe('user', () => {
         },
       },
     );
-    await sqldb.query(
+    await db.query(
       'UPDATE UserAppKeys SET appKey = :appKey WHERE integrationId = :integrationId AND userId = :userId AND hint = :hint',
       {
         replacements: {
@@ -329,7 +438,7 @@ describe('user', () => {
       });
       expect(returnValue.message).toBe('Stored integration token is invalid. Please re-save credentials.');
     } finally {
-      await Promise.all(originalRows.map(currentRow => sqldb.query(
+      await Promise.all(originalRows.map(currentRow => db.query(
         'UPDATE UserAppKeys SET appKey = :appKey WHERE id = :id',
         {
           replacements: {

package/controllers/app.js

@@ -98,6 +98,7 @@ const createAppToken = async (req, res, next) => {
       userId,
     },
   } = req;
+  let transaction;
   try {
     const payload = {
       integrationId,
@@ -105,20 +106,45 @@ const createAppToken = async (req, res, next) => {
       hint,
       appKey,
     };
-    // check if the user exists
-    const userRecord = await sqldb.User.findOne({ where: { userId } });
-    if (!userRecord) { // create the user record
-      await sqldb.User.create({ userId });
-    }
-    // check if the user already has the same app with the same hint
+    await sqldb.User.findOrCreate({ where: { userId }, defaults: { userId } });
+
+    transaction = await sqldb.sequelize.transaction();
+    await sqldb.User.findOne({
+      where: { userId },
+      transaction,
+      lock: transaction.LOCK.UPDATE,
+    });
+    const integrationCount = await sqldb.UserAppKey.count({
+      where: { userId },
+      transaction,
+    });
+    const isFirstIntegration = integrationCount === 0;
+    // Replacing an existing app/hint is an update, never a first integration.
     const userAppKeyDup = await sqldb.UserAppKey.findOne({
       where: { userId, integrationId, hint },
+      transaction,
     });
-    if (userAppKeyDup) await userAppKeyDup.destroy();
-    const newAppKey = await sqldb.UserAppKey.create(payload);
-    // create any cronjobs related to the app
-        await bb.each(req.app.plugins, async plugin => {
-      if (Array.isArray(plugin.jobs)) {
+    if (userAppKeyDup) await userAppKeyDup.destroy({ transaction });
+    const newAppKey = await sqldb.UserAppKey.create(payload, { transaction });
+    try {
+      await transaction.commit();
+    } catch (commitErr) {
+      // Sequelize marks failed commits as finished, so a rollback would mask the original error.
+      transaction = null;
+      throw commitErr;
+    }
+    transaction = null;
+
+    const responsePayload = {
+      value: newAppKey.get('id').toString(),
+      isFirstIntegration,
+    };
+
+    // Credential persistence is already committed, but cron provisioning must
+    // remain caller-visible so missing scheduled functionality is not silent.
+    try {
+      await bb.each(req.app.plugins, async plugin => {
+        if (!Array.isArray(plugin.jobs)) return;
         const validJobs = plugin.jobs.filter(job => Boolean(job.cron) && Boolean(job.method));
         await bb.each(validJobs, async job => {
           const where = {
@@ -144,40 +170,48 @@ const createAppToken = async (req, res, next) => {
             ...(job.params || {}),
             removeOnComplete: false,
           };
-          let bullJobId;
           if (existing) {
             const bullJob = await queue.getJob(job.bullJobId);
             if (!bullJob) {
-              let rawBullJobId = await addJob(jobPayload, jobParams);
-              existing.bullJobId = (rawBullJobId && typeof rawBullJobId === 'object' && rawBullJobId.id) ? rawBullJobId.id : rawBullJobId;
+              const rawBullJobId = await addJob(jobPayload, jobParams);
+              existing.bullJobId = (rawBullJobId && typeof rawBullJobId === 'object'
+                && rawBullJobId.id) ? rawBullJobId.id : rawBullJobId;
               await existing.save();
             } else {
-              // make sure the cron is the same
-              // bullJobId here is from existing.bullJobId, which should be a string.
-              // The queue.getJob expects a string ID.
               const bullCron = R.path(
                 ['opts', 'repeat', 'cron'],
-                await queue.getJob(existing.bullJobId), // Use existing.bullJobId
+                await queue.getJob(existing.bullJobId),
               );
               if (bullCron !== job.cron) {
-                await queue.removeJobs(existing.bullJobId); // Use existing.bullJobId
-                let rawBullJobId = await addJob(jobPayload, jobParams);
-                existing.bullJobId = (rawBullJobId && typeof rawBullJobId === 'object' && rawBullJobId.id) ? rawBullJobId.id : rawBullJobId;
+                await queue.removeJobs(existing.bullJobId);
+                const rawBullJobId = await addJob(jobPayload, jobParams);
+                existing.bullJobId = (rawBullJobId && typeof rawBullJobId === 'object'
+                  && rawBullJobId.id) ? rawBullJobId.id : rawBullJobId;
                 await existing.save();
               }
             }
           } else {
-            let rawBullJobId = await addJob(jobPayload, jobParams);
-            const actualBullJobId = (rawBullJobId && typeof rawBullJobId === 'object' && rawBullJobId.id) ? rawBullJobId.id : rawBullJobId;
+            const rawBullJobId = await addJob(jobPayload, jobParams);
+            const actualBullJobId = (rawBullJobId && typeof rawBullJobId === 'object'
+              && rawBullJobId.id) ? rawBullJobId.id : rawBullJobId;
             await sqldb.CronJobs.create({ ...where, bullJobId: actualBullJobId });
           }
         });
-      }
-    });
-
+      });
+    } catch (cronErr) {
+      console.error('Unable to configure integration cron jobs after save', cronErr);
+      throw cronErr;
+    }
 
-    return res.json({ value: newAppKey.get('id').toString() });
+    return res.json(responsePayload);
   } catch (err) {
+    if (transaction && !transaction.finished) {
+      try {
+        await transaction.rollback();
+      } catch (rollbackErr) {
+        console.error('Unable to roll back integration credential transaction', rollbackErr);
+      }
+    }
     return next(err);
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.120",
+  "version": "1.0.121",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {

package/.windsurfrules

@@ -1,9 +0,0 @@
-This is a Node.js project using Sequelize for database operations and Express.js for the web server.
-The API is defined in api.yml using OpenAPI 3.0.2
-The database is defined in models/index.js
-The models are defined in models/
-to run tests you have to run them on the ti2 named docker container, and consider this codebase is part of node_modules/ti2 path for example : 
-`` $ docker exec ti2 bash -c "cd /ti2 && npx jest lib/__tests__/callback.js --forceExit"``
-When writing / editing tests, make use of test/utils.js and review their implementation to understand how to mock the environment.
-Do not make any changes until you 95% confident of the changes you want to make, ask follow up questions until you have that confidence.
-when sending jobs to the background worker using the queue, asssume a worker is always runing to execute it but is on a different instance thread, so to review / wait for jobs we have to use the wokrer/queue.js listJobs fn to check for it

package/CLAUDE.md

@@ -1,166 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-Ti2 (Tourism Information Interchange) is an open-source integration framework for the tourism industry. It provides standardized functions for bookings, content, and rates management through a plugin-based architecture.
-
-## Critical Development Rules
-
-1. **Docker Container Execution**: ALL commands must be run inside the `ti2` Docker container
-   - The codebase is located at `/ti2` path inside the container
-   - This project is part of `node_modules/ti2` in the container environment
-   - **NEVER run npm, node, or npx commands on the host machine**
-   - Always use: `docker exec ti2 bash -c "cd /ti2 && <command>"`
-   - Example for npm install: `docker exec ti2 bash -c "cd /ti2 && npm install <package>"`
-
-2. **Testing Rules**:
-   - Tests MUST be run inside the Docker container
-   - Example: `docker exec ti2 bash -c "cd /ti2 && npx jest lib/__tests__/callback.js --forceExit"`
-   - Use `test/utils.js` for mocking the environment
-   - Review test utility implementations before writing/editing tests
-
-3. **Background Jobs**:
-   - Jobs sent to the queue run on a separate worker thread/instance
-   - Use `worker/queue.js` `listJobs` function to check job status
-   - Workers are always assumed to be running
-
-4. **Code Confidence**: Do not make changes until 95% confident. Ask follow-up questions if uncertain.
-
-## Public Repo Privacy
-
-- `ti2` is open source. Before opening or updating public PRs, review summaries, inline comments, release notes, or commit messages, scrub internal TourConnect service names and private implementation details.
-- Do not mention internal services such as `pyfilematch`, `filematch`, `tcoutlook`, private frontend names, private trace URLs, private customer identifiers, or internal deployment architecture in public GitHub text.
-- Use generic wording such as `upstream caller`, `internal catalog caller`, `private frontend`, `caller-side timeout`, or `internal workflow` when context is needed.
-- After editing public GitHub text, search the PR body, issue comments, review comments, and review summaries for internal service names before handoff.
-
-## Common Development Commands
-
-```bash
-# Run tests (inside Docker container)
-docker exec ti2 bash -c "cd /ti2 && npm test"
-docker exec ti2 bash -c "cd /ti2 && npx jest [test-file] --forceExit"
-
-# Run specific test file
-docker exec ti2 bash -c "cd /ti2 && npx jest controllers/__tests__/bookings.js --forceExit"
-
-# Database migrations
-docker exec ti2 bash -c "cd /ti2 && npm run sequelize db:migrate"
-
-# Generate documentation
-docker exec ti2 bash -c "cd /ti2 && npm run doc"
-```
-
-## Architecture
-
-### Core Components
-
-1. **Main Entry Point** (`index.js`):
-   - Initializes Express server on port 10010 (default)
-   - Sets up Swagger documentation at `/api-docs`
-   - Handles plugin instantiation and middleware
-   - Implements caching mechanism
-   - Manages background job processing via `worker/queue.js`
-
-2. **API Definition** (`api.yml`):
-   - OpenAPI 3.0.0 specification
-   - Defines all endpoints and schemas
-   - JWT Bearer authentication
-
-3. **Plugin System**:
-   - Two types: Integration Plugins (connect systems) and App Plugins (value-added tools)
-   - Plugins are instantiated with cache, axios, events, and configuration
-   - Plugin schemas are merged with main API schema
-   - Each plugin gets its own routes under `/apps/{pluginName}`
-
-4. **Controllers** (`controllers/`):
-   - `app.js`: Core application controller
-   - `bookings.js`: Booking operations (searchProducts, createBooking, etc.)
-   - `admin.js`: Administrative functions
-   - `user.js`: User management
-   - `ping.js`: Health check endpoints
-   - `allotment.js`: Allotment management
-
-5. **Database Models** (`models/`):
-   - Sequelize ORM with MySQL
-   - Key models: Integration, User, UserAppKey, CronJobs, ApiCronJobs
-   - Migrations in `migrations/` directory
-
-6. **Worker System** (`worker/`):
-   - Bull queue for background job processing
-   - Redis-backed job queue
-   - Supports plugin jobs, API jobs, and callback jobs
-   - Multi-worker support with throng
-
-7. **Authentication** (`auth/authHandler.js`):
-   - JWT-based authentication
-   - Bearer token scheme
-
-### Key Features
-
-- **Caching**: Redis-based caching with configurable TTL
-- **Event System**: EventEmitter2 for plugin communication
-- **Background Jobs**: Async job processing with Bull/Redis
-- **Cron Jobs**: Scheduled task execution
-- **Multi-tenancy**: Support for multiple integrations/plugins
-
-### Plugin Development
-
-Plugins must implement standard methods:
-- `validateToken`: Token validation
-- `tokenTemplate`: Token configuration template
-- Booking methods: `searchProducts`, `searchAvailability`, `createBooking`, `cancelBooking`
-- Content methods: `getProducts`, `getProduct`, `createProduct`, `updateProduct`
-
-### Testing Strategy
-
-- Jest testing framework
-- Test fixtures in `__fixtures__/`
-- Mock plugins in `__mocks__/`
-- Use `test/utils.js` for creating test environments
-- Tests organized by controller in `controllers/__tests__/`
-
-## Database
-
-- Sequelize ORM with MySQL/MariaDB
-- Connection managed through `models/db.js`
-- Migrations handled via sequelize-cli
-- Models auto-loaded from `models/` directory
-
-## Environment Variables
-
-Key variables:
-- `PORT`: Server port (default: 10010)
-- `REDIS_URL`: Redis connection (default: redis://redis:6379)
-- `jwtSecret`: JWT signing secret
-- `adminKey`: Admin authentication key
-- `WEB_CONCURRENCY`: Number of workers
-- `MAX_JOBS_PER_WORKER`: Job concurrency per worker
-- `SSL_INSECURE_ALLOWED_DOMAINS`: Pipe-separated list of domains where SSL certificate verification is skipped (e.g., `localhost|staging.example.com|192.168.1.100`)
-
-Plugin-specific variables follow pattern: `ti2_{pluginName}_{setting}`
-
-### SSL Configuration
-
-The `SSL_INSECURE_ALLOWED_DOMAINS` environment variable allows you to specify domains where SSL certificate verification should be skipped. This is useful for:
-- Development environments with self-signed certificates
-- Testing against staging servers with invalid certificates
-- Local development with HTTPS
-
-Example usage:
-```bash
-# Skip SSL verification for specific domains
-export SSL_INSECURE_ALLOWED_DOMAINS="localhost|staging.api.com|192.168.1.100"
-
-# Multiple domains separated by pipe
-export SSL_INSECURE_ALLOWED_DOMAINS="dev.example.com|test.example.com"
-```
-
-**Important Implementation Notes**:
-- SSL configuration is ONLY applied to plugin axios instances (for external API calls) and worker axios instances
-- Internal communication (callbacks, per-request axios) do NOT use SSL configuration  
-- SSL configuration uses a per-request interceptor approach for better isolation
-- The configuration checks domains dynamically on each request
-
-**Warning**: Only use this in development/testing environments. Never skip SSL verification in production for security reasons.