ti2 1.0.124 → 1.0.126

package/services/integrationLifecycle.js

@@ -0,0 +1,496 @@
+const axios = require('axios');
+const crypto = require('crypto');
+const { Op } = require('sequelize');
+
+const sqldb = require('../models');
+const { removeJob } = require('../worker/queue');
+
+const DEFAULT_PROVISIONING_TIMEOUT_MS = 5 * 60e3;
+
+const identityWhere = ({ userId, integrationId, hint }) => ({
+  userId,
+  integrationId,
+  hint,
+});
+
+const lifecycleError = (status, message) => {
+  const error = new Error(message);
+  error.status = status;
+  return error;
+};
+
+const newRequestId = () => crypto.randomBytes(16).toString('hex');
+
+const provisioningTimeoutMs = () => {
+  const configured = Number(process.env.INTEGRATION_PROVISIONING_TIMEOUT_MS);
+  return Number.isFinite(configured) && configured > 0
+    ? configured
+    : DEFAULT_PROVISIONING_TIMEOUT_MS;
+};
+
+const provisioningIsStale = lifecycle => {
+  const lastUpdatedAt = lifecycle.updatedAt || lifecycle.requestedAt;
+  const lastUpdatedMs = new Date(lastUpdatedAt).getTime();
+  return Number.isFinite(lastUpdatedMs)
+    && Date.now() - lastUpdatedMs >= provisioningTimeoutMs();
+};
+
+const catalogLifecycleEndpoint = () => {
+  const eventsUrl = process.env.ti2_events2url_eventsURL;
+  if (!eventsUrl) return null;
+  const endpoint = new URL(eventsUrl);
+  endpoint.pathname = '/productSync/integration-lifecycle';
+  endpoint.search = '';
+  endpoint.hash = '';
+  return endpoint.toString();
+};
+
+const callCatalogLifecycle = async ({
+  action,
+  userId,
+  integrationId,
+  hint,
+  generation,
+}) => {
+  const endpoint = catalogLifecycleEndpoint();
+  if (!endpoint) {
+    return {
+      status: action === 'activate' ? 'active' : 'deleted',
+      generation,
+      skipped: true,
+      reason: 'catalog_lifecycle_not_configured',
+    };
+  }
+  try {
+    const response = await axios.post(
+      endpoint,
+      {
+        action,
+        companyId: userId,
+        integrationId,
+        hint,
+        generation,
+      },
+      {
+        headers: {
+          Authorization: process.env.ti2_events2url_authorization,
+        },
+        timeout: Number(process.env.INTEGRATION_LIFECYCLE_TIMEOUT_MS) || 30e3,
+      },
+    );
+    return response.data;
+  } catch (error) {
+    const responseData = error.response && error.response.data;
+    if (responseData && ['retry', 'superseded'].includes(responseData.status)) {
+      return responseData;
+    }
+    throw error;
+  }
+};
+
+const prepareActivation = async ({
+  userId,
+  integrationId,
+  hint,
+  transaction,
+}) => {
+  const where = identityWhere({ userId, integrationId, hint });
+  let lifecycle = await sqldb.IntegrationLifecycle.findOne({
+    where,
+    transaction,
+    lock: transaction.LOCK.UPDATE,
+  });
+  if (lifecycle && ['deleting', 'external_cleanup', 'failed'].includes(lifecycle.status)) {
+    throw lifecycleError(409, 'Integration removal must finish before this integration can be saved again.');
+  }
+  if (!lifecycle) {
+    lifecycle = await sqldb.IntegrationLifecycle.create({
+      ...where,
+      generation: 1,
+      status: 'provisioning',
+      requestId: newRequestId(),
+      retryCount: 0,
+      requestedAt: new Date(),
+      artifacts: { requiresCatalogActivation: false },
+    }, { transaction });
+  } else if (lifecycle.status === 'complete') {
+    lifecycle.generation += 1;
+    lifecycle.status = 'provisioning';
+    lifecycle.requestId = newRequestId();
+    lifecycle.retryCount = 0;
+    lifecycle.requestedAt = new Date();
+    lifecycle.lastError = null;
+    lifecycle.artifacts = { requiresCatalogActivation: true };
+    await lifecycle.save({ transaction });
+  } else {
+    lifecycle.status = 'provisioning';
+    lifecycle.lastError = null;
+    if (!lifecycle.artifacts || typeof lifecycle.artifacts !== 'object') {
+      lifecycle.artifacts = { requiresCatalogActivation: false };
+    }
+    await lifecycle.save({ transaction });
+  }
+  return lifecycle;
+};
+
+const activateCatalog = async lifecycle => {
+  const result = await callCatalogLifecycle({
+    action: 'activate',
+    userId: lifecycle.userId,
+    integrationId: lifecycle.integrationId,
+    hint: lifecycle.hint,
+    generation: lifecycle.generation,
+  });
+  if (result && result.status === 'active') return result;
+  if (result && result.status === 'superseded') {
+    throw lifecycleError(409, 'A newer integration lifecycle already exists.');
+  }
+  if (result && result.status === 'retry') {
+    throw lifecycleError(503, 'Product catalog activation is not ready and can be retried.');
+  }
+  throw lifecycleError(502, 'Product catalog activation returned an unexpected response.');
+};
+
+const activationWhere = lifecycle => ({
+  ...identityWhere(lifecycle),
+  generation: lifecycle.generation,
+  status: 'provisioning',
+});
+
+const assertActivationOwnership = updatedRows => {
+  if (updatedRows !== 1) {
+    throw lifecycleError(409, 'Integration save was superseded by a newer lifecycle.');
+  }
+};
+
+const touchActivation = async lifecycle => {
+  const [updatedRows] = await sqldb.IntegrationLifecycle.update({
+    updatedAt: new Date(),
+  }, {
+    where: activationWhere(lifecycle),
+  });
+  if (updatedRows === 1) return;
+  // MySQL reports zero changed rows when a sub-second heartbeat rounds to the
+  // same stored timestamp, so confirm the fenced row before treating it as lost.
+  const current = await sqldb.IntegrationLifecycle.findOne({
+    where: activationWhere(lifecycle),
+  });
+  if (!current) assertActivationOwnership(updatedRows);
+};
+
+const completeActivation = async lifecycle => {
+  const [updatedRows] = await sqldb.IntegrationLifecycle.update({
+    status: 'active',
+    artifacts: null,
+    lastError: null,
+  }, {
+    where: activationWhere(lifecycle),
+  });
+  assertActivationOwnership(updatedRows);
+};
+
+const failActivation = (lifecycle, error) => sqldb.IntegrationLifecycle.update({
+  status: 'failed_activation',
+  lastError: error.message,
+}, {
+  where: {
+    ...identityWhere(lifecycle),
+    generation: lifecycle.generation,
+    status: 'provisioning',
+  },
+});
+
+const beginDeletion = async ({
+  userId,
+  integrationId,
+  hint,
+  requestedBy,
+}) => {
+  const where = identityWhere({ userId, integrationId, hint });
+  return sqldb.sequelize.transaction(async transaction => {
+    await sqldb.User.findOne({
+      where: { userId },
+      transaction,
+      lock: transaction.LOCK.UPDATE,
+    });
+    let lifecycle = await sqldb.IntegrationLifecycle.findOne({
+      where,
+      transaction,
+      lock: transaction.LOCK.UPDATE,
+    });
+    if (lifecycle && ['complete', 'external_cleanup'].includes(lifecycle.status)) {
+      return lifecycle;
+    }
+    if (
+      lifecycle
+      && lifecycle.status === 'provisioning'
+      && !provisioningIsStale(lifecycle)
+    ) {
+      throw lifecycleError(409, 'Integration save is still finishing. Retry removal shortly.');
+    }
+    if (!lifecycle) {
+      const credential = await sqldb.UserAppKey.findOne({
+        where,
+        transaction,
+        lock: transaction.LOCK.UPDATE,
+      });
+      if (!credential) throw lifecycleError(404, 'Integration credential not found.');
+      lifecycle = await sqldb.IntegrationLifecycle.create({
+        ...where,
+        generation: 1,
+        status: 'deleting',
+        requestId: newRequestId(),
+        retryCount: 0,
+        requestedBy,
+        requestedAt: new Date(),
+      }, { transaction });
+      return lifecycle;
+    }
+    if (
+      ['active', 'failed_activation'].includes(lifecycle.status)
+      || (lifecycle.status === 'provisioning' && provisioningIsStale(lifecycle))
+    ) {
+      // Deletion intentionally advances beyond a failed/stale activation. The catalog
+      // contract accepts a higher generation so an activation that committed remotely
+      // before TI2 crashed cannot resurrect the integration.
+      lifecycle.generation += 1;
+      lifecycle.requestId = newRequestId();
+      lifecycle.retryCount = 0;
+      lifecycle.requestedAt = new Date();
+    } else {
+      lifecycle.retryCount += 1;
+    }
+    lifecycle.status = 'deleting';
+    lifecycle.requestedBy = requestedBy;
+    lifecycle.lastError = null;
+    await lifecycle.save({ transaction });
+    return lifecycle;
+  });
+};
+
+const cleanupSchedules = async ({
+  userId,
+  integrationId,
+  hint,
+}) => {
+  const where = {
+    userId,
+    hint,
+    pluginName: integrationId,
+  };
+  return sqldb.sequelize.transaction(async transaction => {
+    const schedules = await sqldb.CronJobs.findAll({
+      where,
+      transaction,
+      lock: transaction.LOCK.UPDATE,
+    });
+    /* eslint-disable no-await-in-loop */
+    // Sequential removal keeps each Bull deletion paired with its locked database row.
+    for (const schedule of schedules) { // eslint-disable-line no-restricted-syntax
+      const references = await sqldb.CronJobs.findAll({
+        where: { bullJobId: schedule.bullJobId },
+        transaction,
+        lock: transaction.LOCK.UPDATE,
+      });
+      if (references.length === 1) await removeJob(schedule.bullJobId);
+      await schedule.destroy({ transaction });
+    }
+    /* eslint-enable no-await-in-loop */
+    return schedules.length;
+  });
+};
+
+const cleanupCredentialAndSettings = ({ userId, integrationId, hint }) => (
+  sqldb.sequelize.transaction(async transaction => {
+    await sqldb.User.findOne({
+      where: { userId },
+      transaction,
+      lock: transaction.LOCK.UPDATE,
+    });
+    const credentials = await sqldb.UserAppKey.destroy({
+      where: identityWhere({ userId, integrationId, hint }),
+      transaction,
+    });
+    const remainingHints = await sqldb.UserAppKey.count({
+      where: { userId, integrationId },
+      transaction,
+    });
+    const settings = remainingHints === 0
+      ? await sqldb.UserIntegrationSettings.destroy({
+        where: { userId, integrationId },
+        transaction,
+      })
+      : 0;
+    return { credentials, settings };
+  })
+);
+
+const deleteIntegration = async ({
+  userId,
+  integrationId,
+  hint,
+  requestedBy,
+  deferCompletion = false,
+}) => {
+  const lifecycle = await beginDeletion({
+    userId,
+    integrationId,
+    hint,
+    requestedBy,
+  });
+  if (['complete', 'external_cleanup'].includes(lifecycle.status)) {
+    return lifecycle.get({ plain: true });
+  }
+
+  const where = identityWhere({ userId, integrationId, hint });
+  let failureStage = 'schedule cleanup';
+  let observedArtifacts = lifecycle.artifacts || {};
+  try {
+    const cronJobs = await cleanupSchedules({ userId, integrationId, hint });
+    const previousArtifacts = { ...observedArtifacts };
+    delete previousArtifacts.failureStage;
+    observedArtifacts = {
+      ...previousArtifacts,
+      cronJobs: Math.max(previousArtifacts.cronJobs || 0, cronJobs),
+    };
+    await sqldb.IntegrationLifecycle.update({ artifacts: observedArtifacts }, {
+      where: {
+        ...where,
+        generation: lifecycle.generation,
+        status: { [Op.in]: ['deleting', 'failed'] },
+      },
+    });
+    failureStage = 'credential and settings cleanup';
+    const { credentials, settings } = await cleanupCredentialAndSettings({
+      userId,
+      integrationId,
+      hint,
+    });
+    observedArtifacts = {
+      ...observedArtifacts,
+      credentials: Math.max(observedArtifacts.credentials || 0, credentials),
+      settings: Math.max(observedArtifacts.settings || 0, settings),
+    };
+    await sqldb.IntegrationLifecycle.update({ artifacts: observedArtifacts }, {
+      where: {
+        ...where,
+        generation: lifecycle.generation,
+        status: { [Op.in]: ['deleting', 'failed'] },
+      },
+    });
+    failureStage = 'product catalog cleanup';
+    const catalog = await callCatalogLifecycle({
+      action: 'delete',
+      userId,
+      integrationId,
+      hint,
+      generation: lifecycle.generation,
+    });
+    if (catalog && catalog.status === 'superseded') {
+      throw lifecycleError(409, 'A newer product catalog lifecycle already exists.');
+    }
+    if (catalog && catalog.status === 'retry') {
+      throw lifecycleError(503, 'Product catalog cleanup is not ready and can be retried.');
+    }
+    if (!catalog || catalog.status !== 'deleted') {
+      throw lifecycleError(502, 'Product catalog cleanup returned an unexpected response.');
+    }
+    const artifacts = {
+      ...observedArtifacts,
+      catalog,
+    };
+    const status = deferCompletion ? 'external_cleanup' : 'complete';
+    const [updatedRows] = await sqldb.IntegrationLifecycle.update({
+      status,
+      artifacts,
+      lastError: null,
+    }, {
+      where: {
+        ...where,
+        generation: lifecycle.generation,
+        status: { [Op.in]: ['deleting', 'failed'] },
+      },
+    });
+    if (updatedRows === 0) {
+      const persisted = await sqldb.IntegrationLifecycle.findOne({ where });
+      if (
+        persisted
+        && persisted.generation === lifecycle.generation
+        && ['complete', 'external_cleanup'].includes(persisted.status)
+      ) {
+        return persisted.get({ plain: true });
+      }
+      throw lifecycleError(409, 'Integration cleanup state changed before completion.');
+    }
+    return {
+      ...where,
+      generation: lifecycle.generation,
+      requestId: lifecycle.requestId,
+      requestedAt: lifecycle.requestedAt,
+      retryCount: lifecycle.retryCount,
+      status,
+      artifacts,
+    };
+  } catch (error) {
+    await sqldb.IntegrationLifecycle.update({
+      status: 'failed',
+      artifacts: { ...observedArtifacts, failureStage },
+      lastError: error.message,
+    }, {
+      where: {
+        ...where,
+        generation: lifecycle.generation,
+        status: 'deleting',
+      },
+    });
+    if (error.status) throw error;
+    throw lifecycleError(
+      503,
+      `Integration cleanup stopped at ${failureStage} and can be retried: ${error.message}`,
+    );
+  }
+};
+
+const completeDeletion = async ({
+  userId,
+  integrationId,
+  hint,
+  generation,
+  requestId,
+  externalArtifacts,
+}) => sqldb.sequelize.transaction(async transaction => {
+  const where = identityWhere({ userId, integrationId, hint });
+  const lifecycle = await sqldb.IntegrationLifecycle.findOne({
+    where,
+    transaction,
+    lock: transaction.LOCK.UPDATE,
+  });
+  if (!lifecycle || lifecycle.generation !== generation) {
+    throw lifecycleError(409, 'Integration cleanup generation no longer matches.');
+  }
+  if (lifecycle.requestId !== requestId) {
+    throw lifecycleError(409, 'Integration cleanup request no longer owns this generation.');
+  }
+  if (lifecycle.status === 'complete') return lifecycle.get({ plain: true });
+  if (lifecycle.status !== 'external_cleanup') {
+    throw lifecycleError(409, 'Integration cleanup is not ready to finalize.');
+  }
+  lifecycle.status = 'complete';
+  lifecycle.artifacts = {
+    ...(lifecycle.artifacts || {}),
+    external: externalArtifacts || {},
+  };
+  lifecycle.lastError = null;
+  await lifecycle.save({ transaction });
+  return lifecycle.get({ plain: true });
+});
+
+module.exports = {
+  activateCatalog,
+  completeActivation,
+  completeDeletion,
+  deleteIntegration,
+  failActivation,
+  prepareActivation,
+  touchActivation,
+};

package/worker/__tests__/queue-remove.js

@@ -0,0 +1,89 @@
+/* globals beforeEach describe expect it jest */
+
+const crypto = require('crypto');
+
+const mockQueue = {
+  getJob: jest.fn(),
+  getRepeatableJobs: jest.fn(),
+  on: jest.fn(),
+  removeRepeatableByKey: jest.fn(),
+};
+const mockRedis = { del: jest.fn() };
+
+jest.mock('bull', () => jest.fn(() => mockQueue));
+jest.mock('ioredis', () => jest.fn(() => mockRedis));
+
+jest.resetModules();
+const Queue = require('bull');
+const { removeJob } = require('../queue');
+
+const occurrenceId = ({
+  name, id, key, timestamp = 1700000000000,
+}) => {
+  const namespace = crypto.createHash('md5').update(key).digest('hex');
+  const repeatHash = crypto.createHash('md5')
+    .update(`${name}${id ? `${id}:` : ':'}${namespace}`)
+    .digest('hex');
+  return `repeat:${repeatHash}:${timestamp}`;
+};
+
+describe('queue settings', () => {
+  it('keeps long-running jobs locked while the worker is active', () => {
+    expect(Queue).toHaveBeenCalledWith('work', expect.any(String), {
+      settings: {
+        lockDuration: 120e3,
+        lockRenewTime: 15e3,
+      },
+    });
+  });
+});
+
+describe('removeJob', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+    mockQueue.getJob.mockResolvedValue(null);
+  });
+
+  it('removes only the repeat definition that owns the stored occurrence id', async () => {
+    const target = {
+      name: '__default__',
+      id: 'company-a-tourplan-desk-a',
+      key: '__default__:company-a-tourplan-desk-a:::0 9 * * *',
+    };
+    const sameCronOtherIntegration = {
+      name: '__default__',
+      id: 'company-a-tourplan-desk-b',
+      key: '__default__:company-a-tourplan-desk-b:::0 9 * * *',
+    };
+    mockQueue.getRepeatableJobs.mockResolvedValue([sameCronOtherIntegration, target]);
+    const jobId = occurrenceId(target);
+
+    await removeJob(jobId);
+
+    expect(mockQueue.removeRepeatableByKey).toHaveBeenCalledTimes(1);
+    expect(mockQueue.removeRepeatableByKey).toHaveBeenCalledWith(target.key);
+    expect(mockRedis.del).toHaveBeenCalledWith(jobId);
+  });
+
+  it('treats an already-removed repeat definition as an idempotent success', async () => {
+    mockQueue.getRepeatableJobs.mockResolvedValue([]);
+
+    await expect(removeJob('repeat:missing:1700000000000')).resolves.toBeUndefined();
+
+    expect(mockQueue.removeRepeatableByKey).not.toHaveBeenCalled();
+    expect(mockRedis.del).toHaveBeenCalledWith('repeat:missing:1700000000000');
+  });
+
+  it('removes a repeat definition referenced by a legacy custom job id', async () => {
+    const target = {
+      id: 'company-a-tourplan-desk-a',
+      key: '__default__:company-a-tourplan-desk-a:::0 9 * * *',
+    };
+    mockQueue.getRepeatableJobs.mockResolvedValue([target]);
+
+    await removeJob(target.id);
+
+    expect(mockQueue.removeRepeatableByKey).toHaveBeenCalledWith(target.key);
+    expect(mockRedis.del).toHaveBeenCalledWith(target.id);
+  });
+});