ti2 1.0.123 → 1.0.124

package/README.md

@@ -73,11 +73,12 @@ calling the integration; `cacheFound` distinguishes a cache miss from a cached
 empty catalog.
 
 A forced request is a full-catalog refresh by default. `fullSyncTrigger` may be
-`scheduled`, `manual`, or `organic`; scheduled and manual refreshes reject
-`searchInput`, `optionId`, `productId`, `productName`, or `lastUpdatedFrom`
-selectors. An empty `searchInput` or `searchInput: "*"` represents the full
-catalog. Scheduler-owned requests may also carry `fullSyncStartedAt`,
-`fullSyncAdmissionToken`, and an `admissionOverrideReason`.
+`scheduled`, `manual`, or `organic`; an omitted trigger on a forced request is
+treated as manual. Manual refreshes require a non-blank `admissionOverrideReason`.
+Scheduled and manual refreshes reject `searchInput`, `optionId`, `productId`,
+`productName`, or `lastUpdatedFrom` selectors. An empty `searchInput` or
+`searchInput: "*"` represents the full catalog. Scheduler-owned requests may
+also carry `fullSyncStartedAt` and `fullSyncAdmissionToken`.
 
 Unscoped forced responses include `catalogRefreshOutcome`, `cacheUpdated`,
 `cachePreserved`, and `cachedProductCount`. Consumers that update a downstream

package/api.yml

@@ -455,7 +455,7 @@ components:
         forceRefresh:
           type: boolean
           default: false
-          description: Call the plugin directly. Full-catalog refreshes require the app's weeklyProductCatalogSync capability and default to a scheduled trigger when fullSyncTrigger is omitted.
+          description: Call the plugin directly. Full-catalog refreshes require the app's weeklyProductCatalogSync capability and default to a manual trigger when fullSyncTrigger is omitted. Manual refreshes require admissionOverrideReason.
         cacheOnly:
           type: boolean
           default: false
@@ -466,14 +466,14 @@ components:
           description: Execute the request through the Ti2 worker.
         fullSyncTrigger:
           type: string
-          description: Catalog refresh owner. Scheduled and manual triggers reject selector fields.
+          description: Catalog refresh owner. Forced requests default to manual when omitted. Scheduled and manual triggers reject selector fields.
           enum:
             - organic
             - scheduled
             - manual
         admissionOverrideReason:
           type: string
-          description: Audit reason for an admitted manual refresh override.
+          description: Required non-blank audit reason for a manual refresh override.
         fullSyncStartedAt:
           type: number
           description: Start time supplied by the full-sync admission owner.

package/controllers/README.md

@@ -29,6 +29,7 @@ The `$bookingsProductSearch` function in `controllers/bookings.js` implements a
     *   **Condition 3: `forceRefresh` is true**:
         *   This is the catalog refresh owner. The system fetches fresh data from the plugin.
         *   Ti2 rejects the request unless the host declared `weeklyProductCatalogSync: true` for the plugin. Manual audit reasons may override timing admission, but not catalog-completeness eligibility.
+        *   An omitted `fullSyncTrigger` is treated as `manual`, and manual refreshes require a non-blank `admissionOverrideReason`. Weekly scheduler requests must explicitly send `fullSyncTrigger: scheduled`.
         *   Unless `fullSyncTrigger: organic` is explicit, a force refresh is a scheduled or manual full-catalog request and rejects `searchInput`, `optionId`, `productId`, `productName`, and `lastUpdatedFrom` selectors. `searchInput: "*"` is unscoped.
         *   The `fetchFromPluginAndCache` helper function is invoked. This function:
             *   Sets the `pluginExecutionLockKey` before calling the plugin to prevent other concurrent direct calls.

package/controllers/__tests__/bookings-searchProducts.js

@@ -134,7 +134,7 @@ describe('user: bookings controller - searchProducts', () => {
       const response = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${testHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true },
+        payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
         expectStatusCode: 500,
       });
 
@@ -146,6 +146,7 @@ describe('user: bookings controller - searchProducts', () => {
       // NOTE: we SHOULD NOT need to remove the cache first, since we are forceRefreshing, we are testing the endpoint get's called while having a cache created
       const payload = {
         forceRefresh: true,
+        fullSyncTrigger: 'scheduled',
       };
       const { products } = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${testHint}/search`,
@@ -253,7 +254,10 @@ describe('user: bookings controller - searchProducts', () => {
         await doApiPost({
           url: `/products/${testAppName}/${testUserId}/${testHint}/search`,
           token: userToken,
-          payload: { forceRefresh: true },
+          payload: {
+            forceRefresh: true,
+            admissionOverrideReason: 'legacy manual refresh',
+          },
         });
         const cacheSavePayload = emitSpy.mock.calls
           .filter(call => call[0] === 'bookingsProductSearch:cache:save')
@@ -265,6 +269,8 @@ describe('user: bookings controller - searchProducts', () => {
         expect(cacheSavePayload.hint).toBe(testHint);
         expect(cacheSavePayload.userIdHash).toBeTruthy();
         expect(cacheSavePayload.hintHash).toBeTruthy();
+        expect(cacheSavePayload.fullSyncTrigger).toBe('manual');
+        expect(cacheSavePayload.admissionOverrideReason).toBe('legacy manual refresh');
         emitSpy.mockRestore();
       });
 
@@ -355,7 +361,7 @@ describe('user: bookings controller - searchProducts', () => {
         await doApiPost({
           url: `/products/${testAppName}/${testUserId}/${doNotCallHint}/search`,
           token: userToken,
-          payload: { forceRefresh: true },
+          payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
         }).then(({ products: p }) => {
           products = p; // Assign to the outer scoped 'products'
         });
@@ -415,7 +421,11 @@ describe('user: bookings controller - searchProducts', () => {
         await doApiPost({
           url: `/products/${testAppName}/${testUserId}/${configuredOmitHint}/search`,
           token: userToken,
-          payload: { forceRefresh: true, omitServiceCodes: [] },
+          payload: {
+            forceRefresh: true,
+            fullSyncTrigger: 'scheduled',
+            omitServiceCodes: [],
+          },
         });
 
         expect(travelgatePlugin.searchProducts).toHaveBeenCalledTimes(1);
@@ -642,7 +652,7 @@ describe('user: bookings controller - searchProducts', () => {
       const result = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${staleCacheTestHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true },
+        payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
       });
 
       const cached = await cache.get({ pluginName: testAppName, key: cacheKeyForTest });
@@ -687,7 +697,7 @@ describe('user: bookings controller - searchProducts', () => {
       await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${staleCacheTestHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true },
+        payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
       });
 
       const cached = await cache.get({ pluginName: testAppName, key: cacheKeyForTest });
@@ -725,7 +735,7 @@ describe('user: bookings controller - searchProducts', () => {
       const result = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${staleCacheTestHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true },
+        payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
       });
 
       const cached = await cache.get({ pluginName: testAppName, key: cacheKeyForTest });
@@ -764,15 +774,22 @@ describe('user: bookings controller - searchProducts', () => {
       },
     );
 
-    it('rejects a forced selector when fullSyncTrigger is omitted', async () => {
+    it.each([
+      ['an omitted trigger', { forceRefresh: true }],
+      ['a blank reason', {
+        forceRefresh: true,
+        fullSyncTrigger: 'manual',
+        admissionOverrideReason: '  ',
+      }],
+    ])('rejects a manual catalog refresh with %s', async (_description, payload) => {
       const response = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${staleCacheTestHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true, optionId: 'option-1' },
+        payload,
         expectStatusCode: 400,
       });
 
-      expect(response.message).toContain('must not include product selectors');
+      expect(response.message).toContain('requires a non-blank admissionOverrideReason');
       expect(travelgatePlugin.searchProducts).not.toHaveBeenCalled();
     });
 
@@ -847,7 +864,7 @@ describe('user: bookings controller - searchProducts', () => {
       const result = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${configuredHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true },
+        payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
       });
 
       expect(result).toEqual(expect.objectContaining({
@@ -1130,7 +1147,7 @@ describe('Bookings Product Search Lock Mechanism (Job Queuing on Stale Cache)',
     const makeForceRequest = () => doApiPost({
       url: `/products/${testAppName}/${testUserId}/${ttrTestHint}/search`,
       token: userToken,
-      payload: { forceRefresh: true },
+      payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
     });
 
     const requestPromises = [makeForceRequest(), makeForceRequest(), makeForceRequest()];
@@ -1185,7 +1202,7 @@ describe('Bookings Product Search Lock Mechanism (Job Queuing on Stale Cache)',
     const makeForceRequest = () => doApiPost({
       url: `/products/${testAppName}/${testUserId}/${ttrTestHint}/search`,
       token: userToken,
-      payload: { forceRefresh: true },
+      payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
     });
 
     const requestPromises = [makeForceRequest(), makeForceRequest(), makeForceRequest()];
@@ -1236,7 +1253,7 @@ describe('Bookings Product Search Lock Mechanism (Job Queuing on Stale Cache)',
       const result = await doApiPost({
         url: `/products/${testAppName}/${testUserId}/${ttrTestHint}/search`,
         token: userToken,
-        payload: { forceRefresh: true },
+        payload: { forceRefresh: true, fullSyncTrigger: 'scheduled' },
       });
 
       expect(result).toEqual(expect.objectContaining({

package/controllers/bookings.js

@@ -193,6 +193,14 @@ const createScopedCatalogRefreshError = () => {
   return err;
 };
 
+const createManualCatalogRefreshReasonError = () => {
+  const err = new Error(
+    'A manual catalog refresh requires a non-blank admissionOverrideReason',
+  );
+  err.status = 400;
+  return err;
+};
+
 const createUnsupportedCatalogRefreshError = appKey => {
   const err = new Error(
     `${appKey} does not support complete product catalog refreshes`,
@@ -402,7 +410,7 @@ const $bookingsProductSearch = plugins => async ({
     requestedFullSyncTrigger,
   ) >= 0
     ? requestedFullSyncTrigger
-    : (forceRefresh ? 'scheduled' : 'organic');
+    : (forceRefresh ? 'manual' : 'organic');
   const admissionOverrideReason = typeof requestedOverrideReason === 'string'
     ? requestedOverrideReason.trim() || undefined
     : undefined;
@@ -431,6 +439,14 @@ const $bookingsProductSearch = plugins => async ({
   const isScopedSearch = hasProductSearchSelector(normalizedRequestBody);
   const isDeclaredFullCatalogRefresh = forceRefresh
     && ['scheduled', 'manual'].indexOf(fullSyncTrigger) >= 0;
+  if (
+    forceRefresh
+    && !cacheOnly
+    && fullSyncTrigger === 'manual'
+    && !admissionOverrideReason
+  ) {
+    throw createManualCatalogRefreshReasonError();
+  }
   if (isDeclaredFullCatalogRefresh && isScopedSearch) {
     throw createScopedCatalogRefreshError();
   }

package/package.json

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