Added jsonataResponseValidator configuration to rebound/delay a reque…

…st and requeue it to the component after that delay period has passed.

README.md

@@ -48,6 +48,7 @@ _Numbers show: (1) The URL and method of the REST API resource, (2) the HTTP cal
    The `Call Count` value by default is 1. If you want to use another value, please set the `Call Count` field.
    Notice: See [Known Limitations](#known-limitations) about `Delay` value.
 - `Call Count` - the field should be used only in pair with `Delay`, default to 1.
+- `jsonataResponseValidator` - This works in coordination with the `enableRebound` configuration to throw a status code 429. When this JSONata configuration is present and `enableRebound` set to `true`, it is assumed the JSONata will resolve to a boolean.  If the boolean is false the incoming component message will be requeued and tried again. Otherwise the response will be processed as it normally would.
 - `Request timeout` - Timeout period in milliseconds (1-1140000) while component waiting for server response, also can be configured with REQUEST_TIMEOUT environment variable if configuration field is not provided. Defaults to 100000 (100 sec).
 
    Notice: Specified for component REQUEST_TIMEOUT enviroment variable would be overwritten by specified value of Request timeout, default value would be also overwritten

lib/utils.js

@@ -71,6 +71,7 @@ module.exports.processMethod = async function (msg, cfg, snapshot) {
     msg.data.oihsnapshot = snapshot;
   }
 
+  const { jsonataResponseValidator } = cfg;
   const config = cfg.reader;
 
   if (!config.url) {
@@ -128,13 +129,13 @@ module.exports.processMethod = async function (msg, cfg, snapshot) {
     headers: {
       Authorization: `Bearer ${token}`,
     },
-    data: {
-      name: msg.data.name,
-      first_name: msg.data.first_name,
-      last_name: msg.data.name,
-      phone: msg.data.phone,
-      email: msg.data.email,
-    },
+    // data: {
+    //   name: msg.data.name,
+    //   first_name: msg.data.first_name,
+    //   last_name: msg.data.name,
+    //   phone: msg.data.phone,
+    //   email: msg.data.email,
+    // },
   };
 
   const returnObject = {
@@ -429,40 +430,48 @@ module.exports.processMethod = async function (msg, cfg, snapshot) {
     const contType = response.headers['content-type'];
 
     emitter.logger.debug('Response content type: %o', contType);
-    if (contType) {
-      if (contType.includes('json') && !contType.includes('jsonl')) {
-        const data = await Promise.resolve(response.data);
-        emitter.logger.info('HTTP Response body1: %o', data);
-        return data;
+    if (!contType || (contType && contType.includes('json') && !contType.includes('jsonl'))) {
+      const data = await Promise.resolve(response.data);
+      emitter.logger.info('HTTP Response body1: %o', data);
+      if (jsonataResponseValidator) {
+        const valid = transform(data, { customMapping: jsonataResponseValidator });
+        emitter.logger.debug(`jsonataResponseValidator config is ${jsonataResponseValidator} and evaluates to ${valid}`);
+        if (!valid) {
+          // Throw error to, if enabled, force a rebound of this component
+          const err = new Error('JSONata validation against response failed and request should be retried in rebound queue');
+          err.response = { status: 429 };
+          return Promise.reject(err);
+        }
       }
-      // TODO: implement later and add unit tests for XML file
-      // if (contType.includes('xml')) {
-      //   emitter.logger.info('Trying to parse response as XML');
-      //   const parseOptions = {
-      //     trim: false,
-      //     normalize: false,
-      //     explicitArray: false,
-      //     normalizeTags: false,
-      //     attrkey: '_attr',
-      //     tagNameProcessors: [
-      //       (name) => name.replace(':', '-'),
-      //     ],
-      //   };
-      //   return xml2js(response.body, parseOptions)
-      //     .then((result) => {
-      //       emitter.logger.info('Response successfully parsed');
-      //       return result;
-      //     });
-      // }
-      if (contType.includes('image') || contType.includes('msword')
+      return data;
+    }
+    // TODO: implement later and add unit tests for XML file
+    // if (contType.includes('xml')) {
+    //   emitter.logger.info('Trying to parse response as XML');
+    //   const parseOptions = {
+    //     trim: false,
+    //     normalize: false,
+    //     explicitArray: false,
+    //     normalizeTags: false,
+    //     attrkey: '_attr',
+    //     tagNameProcessors: [
+    //       (name) => name.replace(':', '-'),
+    //     ],
+    //   };
+    //   return xml2js(response.body, parseOptions)
+    //     .then((result) => {
+    //       emitter.logger.info('Response successfully parsed');
+    //       return result;
+    //     });
+    // }
+    if (contType.includes('image') || contType.includes('msword')
           || contType.includes('msexcel') || contType.includes('pdf')
           || contType.includes('csv') || contType.includes('octet-stream')
           || contType.includes('binary') || contType.includes('jsonl')) {
-        const attachmentProcessor = new AttachmentProcessor(emitter, null, cfg.attachmentServiceUrl);
-        const attachment = await attachmentProcessor.uploadAttachment(response.data, contType);
-        emitter.logger.info('Binary data successfully saved to attachments');
-        return attachment;
-      }
+      const attachmentProcessor = new AttachmentProcessor(emitter, null, cfg.attachmentServiceUrl);
+      const attachment = await attachmentProcessor.uploadAttachment(response.data, contType);
+      emitter.logger.info('Binary data successfully saved to attachments');
+      return attachment;
     }
     emitter.logger.info('Unknown content-type. Trying to parse as JSON');
     return Promise.resolve(response.data);

package.json

@@ -4,7 +4,8 @@
   "description": "This is the rest api component for the OIH",
   "main": "node_modules/@openintegrationhub/ferryman/runGlobal.js",
   "scripts": {
-    "test": "LOG_LEVEL=fatal mocha test --recursive --timeout 50000"
+    "test": "LOG_LEVEL=fatal mocha test --recursive --timeout 50000",
+    "test:debug": "LOG_LEVEL=trace DEBUG=nock.* mocha test --recursive --timeout 50000"
   },
   "repository": {
     "type": "git",

test/httpRequestAction.spec.js

@@ -697,6 +697,41 @@ describe('httpRequest action', () => {
         'Request failed with status code 408',
       );
     });
+
+    it('jsonata response validator false && enableRebound true', async () => {
+      const method = 'POST';
+      const msg = {
+        data: {
+          url: 'http://example.com',
+        },
+      };
+
+      const cfg = {
+        enableRebound: true,
+        jsonataResponseValidator: 'data.result',
+        reader: {
+          url: '$$.data.url',
+          method,
+        },
+        auth: {},
+      };
+
+      const responseMessage = {
+        data: { result: false },
+      };
+
+      nock(transform(msg, { customMapping: cfg.reader.url }))
+        .intercept('/', method)
+        .delay(20 + Math.random() * 200)
+        .reply((uri, requestBody) => [200, responseMessage]);
+
+
+      await processAction.call(emitter, msg, cfg);
+      expect(emitter.emit.withArgs('rebound').callCount).to.be.equal(1);
+      expect(emitter.emit.withArgs('rebound').args[0][1]).to.be.equal(
+        'JSONata validation against response failed and request should be retried in rebound queue',
+      );
+    });
   });
 
   describe('when some args are wrong', () => {