ti2 1.0.59 → 1.0.60

package/controllers/__tests__/allotments.js

@@ -1,6 +1,9 @@
 /* globals beforeAll describe it expect */
-
+const axios = require('axios');
+const MockAdapter = require('axios-mock-adapter');
 const chance = require('chance').Chance();
+
+
 const testUtils = require('../../test/utils');
 
 const { env: { adminKey } } = process;
@@ -26,6 +29,7 @@ describe('allotment', () => {
   let doApiGet;
   let doApiPost;
   let plugins;
+  let userToken;
   beforeAll(async () => {
     ({
       doApiDelete,
@@ -35,10 +39,8 @@ describe('allotment', () => {
     } = await testUtils({
       plugins: [appKey],
     }));
-  });
 
-  let userToken;
-  it('drop any existing user integration', async () => {
+    // drop any existing user integrations
     try {
       await doApiDelete({
         url: `/${appKey}/${userId}`,
@@ -48,16 +50,16 @@ describe('allotment', () => {
     } catch (err) {
       // console.debug(err);
     }
-  });
-  it('create the user', async () => {
+
+    // create the user
     ({ value: userToken } = await doApiPost({
       url: '/user',
       token: adminKey,
       payload: { userId },
     }));
     expect(userToken).toBeTruthy();
-  });
-  it('create the App+User setup', async () => {
+
+    // create the App+User setup
     const { userAppKeys } = await doApiGet({
       url: `/user/${userId}/apps`,
       token: userToken,
@@ -103,4 +105,32 @@ describe('allotment', () => {
     expect(call.payload).toEqual(payload);
     expect(call.token).toEqual(token);
   });
+  it('should be able to receive an axios error', async () => {
+    let urlParamsError = new URLSearchParams({
+      ...payload,
+      keyPath: 'errorAxios',
+    }).toString();
+    const returnValue = await doApiGet({
+      url: `/allotment/${appKey}/${newIntegration.tokenHint}/${userId}?${urlParamsError}`,
+      token: userToken,
+      expectStatusCode: 500,
+    });
+    expect(returnValue.allotments).toBeFalsy();
+    expect(returnValue.message).toBe('ECONNREFUSED');
+  });
+  it('should be able to receive an error from a regular response', async () => {
+    const mock = new MockAdapter(axios);
+    mock.onGet('http://www.example.com').reply(200, { error: 'something went wrong' });
+    let urlParamsError = new URLSearchParams({
+      ...payload,
+      keyPath: 'errorGeneral',
+    }).toString();
+    const returnValue = await doApiGet({
+      url: `/allotment/${appKey}/${newIntegration.tokenHint}/${userId}?${urlParamsError}`,
+      token: userToken,
+      expectStatusCode: 500,
+    });
+    expect(returnValue.allotments).toBeFalsy();
+    expect(returnValue.message).toBe('something went wrong');
+  });
 });

package/index.js

@@ -40,6 +40,7 @@ const bookingsController = require('./controllers/bookings');
 const allotmentController = require('./controllers/allotment');
 const { Integration } = require('./models');
 const cache = require('./cache');
+const getErrorMessage = require('./lib/get-error-message.js');
 
 // src : https://github.com/ramda/ramda/issues/3137#issuecomment-1016012904
 const rebuild = fn => obj =>
@@ -217,36 +218,20 @@ module.exports = async ({
       });
       axiosPlugin.interceptors.response.use(response => {
         ti2Events.emit(`${pluginName}.axios.response`, { ...axiosSafeResponse(response), userId });
-        if (errorPathsAxiosAny.length > 0) {
-          const pathMatch = errorPathsAxiosAny.find(errorPath => R.path(errorPath, response));
-          if (pathMatch) {
-            const errMsg = R.path(pathMatch, response);
-            if (process.env.debug) console.error(`error in ${pluginName}`, errMsg);
-            if (ti2Events.events) {
-              ti2Events.events.emit(`${pluginName}.axios.error`, {
-                response: axiosSafeResponse(response),
-                err: errMsg,
-              });
-            }
-            throw new Eror(errMsg);
+        const errMsg = getErrorMessage({ err: response, handlers: errorPathsAxiosAny, force: false });
+        if (errMsg) {
+          if (process.env.debug) console.error(`error in ${pluginName}`, errMsg);
+          if (ti2Events.events) {
+            ti2Events.events.emit(`${pluginName}.axios.error`, {
+              response: axiosSafeResponse(response),
+              err: errMsg,
+            });
           }
+          throw new Error(errMsg);
         }
         return response;
-      });
-      if (process.env.debug) {
-        curlirize(axiosPlugin);
-      }
-      req.axios = async (...args) => axiosPlugin(...args).catch(err => {
-        const errMsg = (() => {
-          const defaultErr = R.omit(['config'], err.toJSON()); // default error
-          if (errorPathsAxiosErrors.length > 0) {
-            const pathMatch = errorPathsAxiosErrors.find(errorPath => R.path(errorPath, err));
-            if (pathMatch) {
-              return R.path(pathMatch, err);
-            }
-          }
-          return defaultErr;
-        })();
+      }, err => {
+        const errMsg = getErrorMessage({ err, handlers: errorPathsAxiosErrors });
         if (process.env.debug) console.error(`error in ${pluginName}`, args[0], errMsg);
         if (ti2Events.events) {
           ti2Events.events.emit(`${pluginName}.axios.error`, {
@@ -254,9 +239,12 @@ module.exports = async ({
             err: errMsg,
           });
         }
-        throw new Error(errMsg);
+        return Promise.reject(errMsg);
       });
-
+      if (process.env.debug) {
+        curlirize(axiosPlugin);
+      }
+      req.axios = axiosPlugin;
       next();
     });
 
@@ -309,7 +297,7 @@ module.exports = async ({
         return next(err);
       }
       if (process.env.CONSOLE_ERRORS || process.env.JEST_WORKER_ID) {
-        console.error(R.path(['response', 'data'], err));
+        console.error(R.pathOr(err, ['response', 'data'], err));
       }
       return res.status((() => {
         if (!isNumber(err.status)) return 500;

package/lib/get-error-message.js

@@ -0,0 +1,21 @@
+const R = require('ramda');
+
+const getErrorMessage = ({ err, handlers = [], force = true }) => {
+  for (const handler of handlers) {
+    let errorMessage;
+    if (Array.isArray(handler)) {
+      errorMessage = R.path(handler, err);
+    } else if (typeof handler === 'function') {
+      errorMessage = handler(err);
+    }
+    if (errorMessage) {
+      return errorMessage;
+    }
+  }
+  if (force) return R.pathOr(
+    err,
+    ['message'],
+    err
+  );
+}
+module.exports = getErrorMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ti2",
-  "version": "1.0.59",
+  "version": "1.0.60",
   "description": "Tourist Industry Exchange (TI2)",
   "main": "index.js",
   "scripts": {
@@ -52,6 +52,7 @@
   },
   "devDependencies": {
     "@salvador/minami": "^1.2.3",
+    "axios-mock-adapter": "^1.21.4",
     "chance": "^1.1.8",
     "eslint": "^8.7.0",
     "eslint-config-airbnb-base": "^15.0.0",

package/test/plugin.js

@@ -1,5 +1,6 @@
 /* global jest, expect */
 /* eslint class-methods-use-this: "off", max-len: "off" */
+const R = require('ramda');
 
 const jestPlugin = (() => {
   if (typeof jest === 'undefined') {
@@ -53,7 +54,19 @@ class Plugin {
     });
     this.searchQuote = jestPlugin.fn(() => ({ quote: [{ id: chance.guid() }] }));
     this.createBooking = jestPlugin.fn(() => {});
-    this.queryAllotment = jestPlugin.fn(() => ({ allotments: [] }));
+    this.queryAllotment = jestPlugin.fn(async (args) => {
+      const {
+        axios,
+        payload,
+      } = args;
+      if (payload.keyPath === 'errorAxios') {
+        await axios.get('http://localhost:1235/');
+      }
+      if (payload.keyPath === 'errorGeneral') {
+        await axios.get('http://www.example.com');
+      }
+      return { allotments: [] }
+    });
     this.tokenTemplate = jestPlugin.fn(() => ({
       apiKey: {
         type: 'text',
@@ -61,6 +74,14 @@ class Plugin {
         description: 'Api Key',
       },
     }));
+    this.errorPathsAxiosErrors = jestPlugin.fn(() => ([
+      ['code'],
+    ]));
+    this.errorPathsAxiosAny = jestPlugin.fn(() => ([
+      err => {
+        return R.path(['data', 'error'], err);
+      }
+    ]));
 
     /**
      * Background and schedule Jos
@@ -458,6 +479,23 @@ class Plugin {
    */
   createBooking() {}
 
+  /**
+   * Allotment Object
+  /**
+   * @typedef {Object} Allotment
+   * @property {string} name - The name of the allotment.
+   * @property {string} description - A description of the allotment.
+   * @property {string} appliesTo - Specifies what the allotment applies to.
+   * @property {string} splitCode - The code used to split the allotment.
+   * @property {string} unitType - The type of unit used for the allotment.
+   * @property {Date} date - The date associated with the allotment using the input format.
+   * @property {string} release - The release period of the allotment as specified in the day inventory.
+   * @property {number} max - The maximum quantity allowed for the allotment as specified in the day inventory.
+   * @property {number} booked - The booked quantity of the allotment as specified in the day inventory.
+   * @property {boolean} request - Indicates whether requests are allowed for the allotment, based on the day inventory.
+   * @property {string[]} keyPaths - An array of key paths generated by combining supplier code and product codes.
+   */
+
   /**
    * Query Allotment
    * @async
@@ -473,7 +511,7 @@ class Plugin {
    * @param {string} args.payload.endDate - End date for the query of allotment objects
    * @param {string} args.payload.keyPath - End date for the query of allotment objects
    * @returns {object} retVal - the return object.
-   * @returns {Booking} retVal.booking - A Booking object.
+   * @returns {Allotment[]} retVal.allotment - An array of allotment spec objects.
    */
   queryAllotment() {}
 }