ti2 1.0.85 → 1.0.87

package/cache.js

@@ -18,6 +18,7 @@ const save = async ({
     }
     return keyParam;
   })()}`;
+  // console.log('saving key', key);
   await cache.set(key, JSON.stringify(value));
   if (!skipTTL) {
     await cache.expire(key, ttl);
@@ -77,7 +78,7 @@ const drop = async ({
   fn,
   fnParams,
 }) => {
-  let key = `${pluginName}:${(() => {
+  const key = `${pluginName}:${(() => {
     if (!keyParam) {
       return hash({ fn, fnParams });
     }
@@ -86,14 +87,17 @@ const drop = async ({
     }
     return keyParam;
   })()}`;
-  key = `${pluginName}:${key}`;
+  // console.log('dropping key', key);
   await cache.del(key);
 };
 
+const keys = async () => cache.keys('*');
+
 module.exports = {
   cache,
   save,
   getOrExec,
   drop,
   get,
+  keys,
 };

package/controllers/__tests__/bookings.js

@@ -1,11 +1,13 @@
-/* globals beforeAll describe it expect */
+/* globals beforeAll describe it expect jest beforeEach */
 
 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: booking search', () => {
+describe('user: bookings controller', () => {
   const newApp = {
     name: 'travelgate',
     packageName: 'ti2-travelgate',
@@ -35,6 +37,16 @@ describe('user: booking search', () => {
     } = await testUtils({
       plugins: [newApp.name],
     }));
+
+    // drop all cache keys, clean slate
+    const cacheKeys = await cache.keys();
+    cacheKeys.forEach(key => cache.drop({
+      pluginName: key.split(':')[0],
+      key: key.split(':')[1],
+    }));
+  });
+  beforeEach(async () => {
+    jest.clearAllMocks();
   });
 
   let userToken;
@@ -77,7 +89,8 @@ describe('user: booking search', () => {
       url: `/user/${userId}/apps`,
       token: userToken,
     });
-    if (!userAppKeys.map(e => e.integrationId).includes(newApp.name)) {
+    if (!userAppKeys.find(e => e.hint === newIntegration.tokenHint
+        && e.integrationId === newApp.name)) {
       // relation does not exits
       const { value } = await doApiPost({
         url: `/${appKey}/${userId}`,
@@ -92,7 +105,7 @@ describe('user: booking search', () => {
       bookingId: '', supplierBookingId: '', name: '',
     };
     const { bookings } = await doApiPost({
-      url: `/bookings/${appKey}/${userId}/search`,
+      url: `/bookings/${appKey}/${userId}/testingToken/search`,
       token: userToken,
       payload,
     });
@@ -105,21 +118,127 @@ describe('user: booking search', () => {
     // expect(retVal.bookings.length > 0).toBeTruthy();
   });
 
-  it('should be able to search a for a booking product', async () => {
-    const payload = {};
-    const { products } = await doApiPost({
-      url: `/products/${appKey}/${userId}/search`,
-      token: userToken,
-      payload,
+  describe('searchProducts', () => {
+    it('should be able to get bookings products for most users without special setup: no cache', async () => {
+      const payload = {};
+      const { products } = await doApiPost({
+        url: `/products/${appKey}/${userId}/testingToken/search`,
+        token: userToken,
+        payload,
+      });
+      expect(plugins[0].searchProducts).toHaveBeenCalled();
+      expect(Array.isArray(products)).toBeTruthy();
+      expect(products.length).toBe(2);
+      expect(products[0].options.length).toBe(1);
+      expect(products[1].options.length).toBe(2);
+    });
+    it('should be able to get booking products: no cache, forceRefresh', async () => {
+      // NOTE: we need to remove the cache first
+      const cacheKey = hash({
+        appKey,
+        userId,
+        hint: 'testingToken',
+        operationId: 'bookingsProductSearch',
+      });
+      await cache.drop({
+        pluginName: appKey,
+        key: cacheKey,
+      });
+      const payload = {
+        forceRefresh: true,
+      };
+      const { products } = await doApiPost({
+        url: `/products/${appKey}/${userId}/testingToken/search`,
+        token: userToken,
+        payload,
+      });
+      expect(plugins[0].searchProducts).toHaveBeenCalled();
+      expect(Array.isArray(products)).toBeTruthy();
+      expect(products.length).toBe(2);
+      expect(products[0].options.length).toBe(1);
+      expect(products[1].options.length).toBe(2);
+      expect(plugins[0].searchProducts.mock.calls[0][0].token).toEqual(token);
+    });
+    it('should be able to get booking products: using cache', async () => {
+      const payload = {};
+      const { products } = await doApiPost({
+        url: `/products/${appKey}/${userId}/testingToken/search`,
+        token: userToken,
+        payload,
+      });
+      expect(plugins[0].searchProducts).not.toHaveBeenCalled();
+      expect(Array.isArray(products)).toBeTruthy();
+      expect(products.length).toBe(2);
+      expect(products[0].options.length).toBe(1);
+      expect(products[1].options.length).toBe(2);
+    });
+    it('should be able to get booking products with searchInput', async () => {
+      const payload = {
+        searchInput: 'Transfer from Sydney Harbor to Hilton Hotel',
+      };
+      const { products } = await doApiPost({
+        url: `/products/${appKey}/${userId}/testingToken/search`,
+        token: userToken,
+        payload,
+      });
+      expect(plugins[0].searchProducts).not.toHaveBeenCalled();
+      expect(Array.isArray(products)).toBeTruthy();
+      expect(products.length).toBe(1);
+      expect(products[0].productName).toBe('Davids');
+      expect(products[0].options.length).toBe(1);
+      expect(products[0].options[0].optionName).toBe('Transfer from Sydney Harbor Bridge to Hilton Hotel');
+    });
+    it('should be able to process doNotCallPluginForProducts in token', async () => {
+      const { userAppKeys } = await doApiGet({
+        url: `/user/${userId}/apps`,
+        token: userToken,
+      });
+      let newnewIntegration = userAppKeys.find(e => e.hint === 'hint_for_doNotCallPluginForProducts'
+        && e.integrationId === newApp.name);
+      if (!newnewIntegration) {
+        const newIntegrationContent = {
+          endpoint: 'https://api.travelgatex.com',
+          apiKey: chance.guid(),
+          client: 'tourconnect',
+          doNotCallPluginForProducts: true,
+        };
+        // create a new user token with the new content
+        newnewIntegration = await doApiPost({
+          url: `/travelgate/${userId}`,
+          token: adminKey,
+          payload: {
+            token: newIntegrationContent,
+            tokenHint: 'hint_for_doNotCallPluginForProducts',
+          },
+        });
+      }
+      expect(newnewIntegration).toBeTruthy();
+      // first time call, no cache expect no plugin call and empty products
+      let products;
+      await doApiPost({
+        url: `/products/${appKey}/${userId}/hint_for_doNotCallPluginForProducts/search`,
+        token: userToken,
+        payload: {},
+      }).then(({ products: p }) => {
+        products = p;
+      });
+      expect(plugins[0].searchProducts).not.toHaveBeenCalled();
+      expect(Array.isArray(products)).toBeTruthy();
+      expect(products.length).toBe(0);
+      // second time call, forceRefresh and still expect plugin call
+      await doApiPost({
+        url: `/products/${appKey}/${userId}/hint_for_doNotCallPluginForProducts/search`,
+        token: userToken,
+        payload: { forceRefresh: true },
+      }).then(({ products: p }) => {
+        products = p;
+      });
+      expect(plugins[0].searchProducts).toHaveBeenCalled();
+      expect(Array.isArray(products)).toBeTruthy();
+      expect(products.length).toBe(2);
     });
-    expect(plugins[0].searchProducts).toHaveBeenCalled();
-    expect(Array.isArray(products)).toBeTruthy();
-    expect(plugins[0].searchProducts.mock.calls[0][0].payload).toEqual(payload);
-    expect(plugins[0].searchProducts.mock.calls[0][0].token).toEqual(token);
-
-    // expect(Array.isArray(retVal.bookings)).toBeTruthy();
-    // expect(retVal.bookings.length > 0).toBeTruthy();
   });
+
   it('should be able to search for availabiility', async () => {
     const payload = {
       travelDateStart: '12/30/2025',
@@ -132,7 +251,7 @@ describe('user: booking search', () => {
       nationality: 'ES',
     };
     const { availability } = await doApiPost({
-      url: `/bookings/${appKey}/${userId}/availability`,
+      url: `/bookings/${appKey}/${userId}/testingToken/availability`,
       token: userToken,
       payload,
     });
@@ -154,7 +273,7 @@ describe('user: booking search', () => {
       nationality: 'ES',
     };
     const { quote } = await doApiPost({
-      url: `/bookings/${appKey}/${userId}/quote`,
+      url: `/bookings/${appKey}/${userId}/testingToken/quote`,
       token: userToken,
       payload,
     });
@@ -168,7 +287,7 @@ describe('user: booking search', () => {
       id: chance.guid(),
     };
     await doApiPost({
-      url: `/bookings/${appKey}/${userId}/booking`,
+      url: `/bookings/${appKey}/${userId}/testingToken/booking`,
       token: userToken,
       payload,
     });

package/controllers/bookings.js

@@ -1,5 +1,7 @@
 const assert = require('assert');
-
+const hash = require('object-hash');
+const cache = require('../cache');
+const R = require('ramda');
 const { UserAppKey } = require('../models/index');
 const { typeDefs: productTypeDefs, query: productQuery } = require('./graphql-schemas/product');
 const { typeDefs: availTypeDefs, query: availQuery } = require('./graphql-schemas/availability');
@@ -89,12 +91,48 @@ const bookingsCancel = plugins => async (req, res, next) => {
   }
 };
 
+const $searchProductList = (products, searchInput = '', optionId = '') => {
+  // NOTE: optionId could be a string or an array of strings
+  // NOTE: searchInput should not appear at the same time as optionId
+  if (!(searchInput && searchInput.trim()) && !(optionId && optionId.length)) {
+    return products;
+  }
+  const getFullSearchStr = (product, option) => `${
+    R.path(['productName'], product) || ''
+  } ${R.path(['optionName'], option) || ''
+  } ${R.path(['optionId'], option) || ''
+  } ${R.path(['supplierId'], product) || ''}`;
+  const inputValueLower = (searchInput || '').trim().toLowerCase();
+  const parts = inputValueLower.split(' ').filter(Boolean); // Filter out any empty strings just in case
+  const pwFilteredOptions = products.map(product => {
+    const filteredOptions = R.pathOr([], ['options'], product).filter(option => {
+      if (optionId && optionId.length) {
+        const optionIdArr = R.is(Array, optionId) ? optionId : [optionId];
+        return optionIdArr.includes(R.path(['optionId'], option));
+      }
+      const fullSearchStr = getFullSearchStr(product, option).toLowerCase();
+      return parts.every(part => fullSearchStr.includes(part));
+    });
+    return {
+      ...product,
+      options: filteredOptions,
+    };
+  });
+  const filteredProducts = pwFilteredOptions.filter(product => product.options.length > 0);
+  return filteredProducts;
+};
+
 const $bookingsProductSearch = plugins => async ({
   axios,
   appKey,
   userId,
   hint,
-  payload,
+  payload: {
+    searchInput,
+    optionId,
+    forceRefresh,
+    ...restPayload
+  },
   requestId,
 }) => {
   const app = plugins.find(({ name }) => name === appKey);
@@ -112,15 +150,68 @@ const $bookingsProductSearch = plugins => async ({
   assert(userAppKeys, 'could not find the app key');
   const token = await userAppKeys.token;
   const func = (app.searchProducts || app.searchProductsForItinerary).bind(app);
-  const results = await func({
+  // NOTE: this is intend to cache the entire product list
+  const cacheKey = hash({
+    appKey,
+    userId,
+    hint,
+    operationId: 'bookingsProductSearch',
+  });
+  if (forceRefresh) {
+    // remove the cache
+    await cache.drop({
+      pluginName: appKey,
+      key: cacheKey,
+    });
+  }
+  const cacheValue = await cache.get({
+    pluginName: appKey,
+    key: cacheKey,
+  });
+  if (cacheValue && cacheValue.products) {
+    const searchResults = $searchProductList(cacheValue.products, searchInput, optionId);
+    console.log(`${appKey}/${userId}/${hint}: found cache and returning cached products: ${searchResults.length}`);
+    return {
+      ...cacheValue,
+      products: searchResults,
+      // this is for sending the product filters specifically being used by pyfilematch
+      ...(token.configuration || {}),
+    };
+  }
+  const doNotCallPluginForProducts = token.doNotCallPluginForProducts
+    || R.path(['cacheSettings', 'bookingsProductSearch', 'doNotCall'], app);
+  if (doNotCallPluginForProducts && !forceRefresh) {
+    console.log(`${appKey}/${userId}/${hint}: no cache found but not calling the plugin because doNotCallPluginForProducts is true and forceRefresh is false`);
+    return { products: [] };
+  }
+  console.log(`${appKey}/${userId}/${hint}: no cache found(forceRefresh: ${forceRefresh}) and calling func`);
+  const funcResults = await func({
     axios,
     token,
-    payload,
+    payload: restPayload,
     typeDefsAndQueries,
     requestId,
     userId,
   });
-  return results;
+  // save cache if products are found
+  if (funcResults && funcResults.products && funcResults.products.length > 0) {
+    // 25 hours, just to have some buffer
+    const ttl = token.ttlForProducts || R.path(['cacheSettings', 'bookingsProductSearch', 'ttl'], app) || 60 * 60 * 25;
+    console.log(`${appKey}/${userId}/${hint}: saving cache of ${funcResults.products.length} products for (ttl:${ttl})`);
+    await cache.save({
+      pluginName: appKey,
+      key: cacheKey,
+      value: funcResults,
+      ttl,
+      skipTTL: Boolean(doNotCallPluginForProducts),
+    });
+  }
+  const searchResults = $searchProductList(R.pathOr([], ['products'], funcResults), searchInput, optionId);
+  return {
+    ...funcResults,
+    products: searchResults,
+    ...(token.configuration || {}),
+  };
 };
 
 const bookingsProductSearch = plugins => async (req, res, next) => {

package/controllers/graphql-schemas/itinerary-booking.js

@@ -35,6 +35,7 @@ const typeDefs = `
     bookingStatus: String!
     ref: String!
     agentRef: String
+    currency: String!
     totalPrice: String!
     currency: String!
     travelDate: String!
@@ -50,6 +51,7 @@ const query = `{
   bookingStatus
   ref
   agentRef
+  currency
   totalPrice
   currency
   travelDate

package/index.js

@@ -20,7 +20,7 @@ const cacheSettings = {
     'getAffiliateAgents',
     'getAffiliateDesks',
     'getPickupPoints',
-    'bookingsProductSearch',
+    // 'bookingsProductSearch',
     'getCreateBookingFields',
   ],
 };
@@ -263,10 +263,29 @@ module.exports = async ({
         const currentPlugin = req.pathParams
           ? plugins.find(p => p.name === req.pathParams.appKey)
           : null;
+        /*
+          currentPlugin = {
+            cacheSettings: {
+              getAffiliateDesks: {
+                ttl: 60 * 60 * 24, // one day
+              },
+              getPickupPoints: {
+                ttl: 60 * 60 * 24, // one day
+                // we will do middleware caching for getPickupPoints
+                cacheInMiddleware: true,
+              },
+            },
+          }
+        */
         const pluginCacheSettings = R.pathOr({}, ['cacheSettings'], currentPlugin);
+        // Filter plugin cache settings to only include those with cacheInMiddleware: true
+        const filteredPluginCacheSettings = R.pickBy(
+          value => R.pathOr(false, ['cacheInMiddleware'], value),
+          pluginCacheSettings,
+        );
         const cachingOperations = [
           ...cacheSettings['*'],
-          ...(currentPlugin ? R.keys(pluginCacheSettings) : []),
+          ...(currentPlugin ? R.keys(filteredPluginCacheSettings) : []),
         ];
         const body = req.customBody;
         if (cachingOperations.indexOf(body.operationId) > -1) {
@@ -288,7 +307,7 @@ module.exports = async ({
                 pluginName: req.pathParams.appKey,
                 key: cacheKey,
                 value: newData,
-                skipTTL: R.path([body.operationId, 'skipTTL'], pluginCacheSettings),
+                skipTTL: R.path([body.operationId, 'skipTTL'], filteredPluginCacheSettings),
                 ttl: 60 * 60 * 24, // one day
               });
             }

package/package.json

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

package/test/plugin.js

@@ -35,7 +35,28 @@ class Plugin {
     this.createLocation = jestPlugin.fn(() => ({ locationId: chance.guid() }));
     this.updateLocation = jestPlugin.fn(() => true);
     this.searchBooking = jestPlugin.fn(() => ({ bookings: [] }));
-    this.searchProducts = jestPlugin.fn(() => ({ bookings: [], products: [] }));
+    this.searchProducts = jestPlugin.fn(() => {
+      return {
+        products: [{
+          productId: '123',
+          productName: 'Bonza Bike Tours',
+          options: [{
+            optionId: '123',
+            optionName: 'Sydney Harbour Bridge Climb',
+          }],
+        }, {
+          productId: '234',
+          productName: 'Davids',
+          options: [{
+            optionId: '2346',
+            optionName: 'Transfer from Sydney Airport to Hilton Hotel',
+          }, {
+            optionId: '2345',
+            optionName: 'Transfer from Sydney Harbor Bridge to Hilton Hotel',
+          }],
+        }],
+      };
+    });
     this.searchAvailability = jestPlugin.fn(({
       token,
       payload: {