Refactor common code

Author: chughts

README.md

@@ -15,7 +15,7 @@ and migrated off watson-developer-cloud to ibm-watson as a npm dependancy.
 Migrated nodes will not be compatible with pre 1.0.0 versions of node-red.
 During the migration there will be a dependancy on both modules.
 - Bump dependancy on node to >=10.0.0
-- Bump dependancy on cfenv, request
+- Bump dependancy on cfenv, request, file-type
 - Remove dependancy on ibm-cloud-sdk-core.
 - Node-RED & IBM-Watson & Use of promises on API invokation & IAM URL construct migration & Removal of default endpoint of
     - Tone Analyzer node.

package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "async": "^1.5.2",
     "cfenv": "~1.2.2",
-    "file-type": "^10.9.0",
+    "file-type": "^12.4.2",
     "request": "~2.88.0",
     "temp": "^0.9.0",
     "qs": "6.x",

services/visual_recognition/v3.js

@@ -39,7 +39,6 @@ module.exports = function(RED) {
     fileType = require('file-type'),
     fs = require('fs'),
     async = require('async'),
-    toArray = require('stream-to-array'),
     sAPIKey = null,
     apikey = '',
     service = null,
@@ -123,31 +122,6 @@ module.exports = function(RED) {
   }
 
 
-  // Even though Visual Reconition SDK can accept a filestream as input
-  // it can't handle the one on msg.payload, so read it into a buffer
-  function checkForStream(msg) {
-    var p = new Promise(function resolver(resolve, reject) {
-      if (payloadutils.isReadableStream(msg.payload)) {
-        //msg.payload.resume();
-        toArray(msg.payload)
-          .then(function(parts) {
-            var buffers = [], part = null;
-
-            for (var i = 0; i < parts.length; ++i) {
-              part = parts[i];
-              buffers.push((part instanceof Buffer) ? part : new Buffer(part));
-            }
-            msg.payload = Buffer.concat(buffers);
-            resolve();
-          });
-      } else {
-        resolve();
-      }
-    });
-    return p;
-
-  }
-
   function verifyServiceCredentials(node, msg) {
     // If it is present the newly provided user entered key
     // takes precedence over the existing one.
@@ -530,7 +504,7 @@ module.exports = function(RED) {
         })
         .then(function(f) {
           feature = f;
-          return checkForStream(msg);
+          return payloadutils.checkForStream(msg);
         })
         .then(function() {
           return verifyInputs(feature, msg);

services/visual_recognition/v4-collection-utils.html

@@ -43,6 +43,8 @@
             <option value="updateCollection">Update name or description of a collection</option>
             <option value="deleteCollection">Delete a collection</option>
             <option value="deleteAllCollections">Delete all collections</option>
+            <option disabled>______________</option>
+            <option value="addImages">Add image to collection</option>
         </select>
     </div>
 </script>
@@ -115,6 +117,7 @@
         <li><b>Update collection</b></li>
         <li><b>Delete collection</b></li>
         <li><b>Delete all collections</b></li>
+        <li><b>Add images to collection</b></li>
     </ul>
 
     <p>All Results will made available at <code>msg.payload</code></p>
@@ -166,6 +169,17 @@
 
     <p><b>Delete all collections</b></p>
     <p>No input parameters are required : </p>
-        
+
+    <p><b>Add images to collection</b></p>
+    <p>this feature should be provided in input : </p>
+    <ul>
+        <li><code>msg.payload</code> : Either a zip of image files or an array of URLs of image files (Required)</li>
+        <li><code>msg.params["collectionId"]</code> : The identifier of the collection (Required)</li>
+        <li><code>msg.params["trainingData"]</code> : Training data if a single image is provided locating objects in image as a JSON object (Optional)</li>
+    </ul>
+    <p>More information on this
+      <a href="https://cloud.ibm.com/apidocs/visual-recognition/visual-recognition-v4?code=node#add-images">
+        API documentation</a>.</p>
+      
 
 </script>

services/visual_recognition/v4-collection-utils.js

@@ -23,13 +23,17 @@ module.exports = function(RED) {
       'createCollection': ['name', 'description'],
       'getCollection': ['collectionId'],
       'updateCollection': ['collectionId'],
-      'deleteCollection': ['collectionId']
+      'deleteCollection': ['collectionId'],
+      'addImages': ['collectionId']
     };
 
   var pkg = require('../../package.json'),
     serviceutils = require('../../utilities/service-utils'),
     payloadutils = require('../../utilities/payload-utils'),
     temp = require('temp'),
+    fileType = require('file-type'),
+    fs = require('fs'),
+    fsp = require('fs').promises,
     sAPIKey = null,
     apikey = '',
     service = null,
@@ -238,6 +242,7 @@ module.exports = function(RED) {
       case 'getCollection':
       case 'updateCollection':
       case 'deleteCollection':
+      case 'addImages':
         theMissing = paramCheckFor(REQUIRED_PARAMS[feature], msg);
         if (theMissing.length === 0) {
           return Promise.resolve();
@@ -257,6 +262,72 @@ module.exports = function(RED) {
     }
   }
 
+  function bufferCheck(data) {
+    return data instanceof Buffer;
+  }
+
+  function zipCheck(msg) {
+    return new Promise(function resolver(resolve, reject) {
+      if (!bufferCheck(msg.payload)) {
+        reject('msg.payload is neither an array or urls or a zip');
+      } else {
+        let ft = fileType(msg.payload);
+        if (!ft || !ft.ext || 'zip' != ft.ext) {
+          reject('msg.payload is not a zip');
+        } else {
+          resolve();
+        }
+      }
+    });
+  }
+
+  function setImagesFileParam(msg) {
+    return new Promise(function resolver(resolve, reject) {
+      temp.open({
+        suffix: '.' + 'zip'
+      }, function(err, info) {
+        if (err) {
+          reject('Node has been unable to open the zip stream');
+        }
+        fsp.writeFile(info.path, msg.payload)
+          .then(() => {
+            msg.params['imagesFile'] = fs.createReadStream(info.path);
+            resolve();
+          })
+          .catch((err) => {
+            reject(err);
+          })
+      });
+    });
+  }
+
+  function processPayload(node, msg) {
+    return new Promise(function resolver(resolve, reject) {
+      if ('addImages' !== node.config[FEATURE]) {
+        resolve();
+      } else if (Array.isArray(msg.payload)) {
+        // Payload can be either an array of urls for images
+        msg.params['imageUrl'] = msg.payload;
+        resolve();
+      } else {
+        // or a zip of images
+        payloadutils.checkForStream(msg)
+          .then(() => {
+            return zipCheck(msg);
+          })
+          .then(() => {
+            return setImagesFileParam(msg);
+          })
+          .then(() => {
+            resolve();
+          })
+          .catch((err) => {
+            reject(err);
+          });
+      }
+    });
+  }
+
   function verifyPayload(node, msg) {
     switch (node.config[FEATURE]) {
       case 'createCollection':
@@ -266,8 +337,13 @@ module.exports = function(RED) {
       case 'deleteCollection':
       case 'deleteAllCollections':
         return Promise.resolve();
+      case 'addImages':
+        if (!msg.payload) {
+          return Promise.reject('Missing property: msg.payload');
+        }
+        return Promise.resolve();
       default:
-        return Promise.reject('Missing property: msg.payload');
+        return Promise.reject('Unknown mode has been specified');
     }
   }
 
@@ -294,6 +370,9 @@ module.exports = function(RED) {
         .then(() => {
           return verifyParams(node, msg);
         })
+        .then(() => {
+          return processPayload(node, msg);
+        })
         .then(() => {
           return determineEndpoint(node.config);
         })

utilities/payload-utils.js

@@ -18,6 +18,7 @@ var url = require('url'),
   fileType = require('file-type'),
   request = require('request'),
   path = require('path'),
+  toArray = require('stream-to-array'),
   stream = require('stream');
 
 function PayloadUtils() {}
@@ -99,6 +100,31 @@ PayloadUtils.prototype = {
     request(url).pipe(wstream);
   },
 
+  // Convert filestream in msg.payload to a buffer
+  checkForStream: function (msg) {
+    let me = this;
+    return new Promise(function resolver(resolve, reject) {
+      if (me.isReadableStream(msg.payload)) {
+        //msg.payload.resume();
+        toArray(msg.payload)
+          .then(function(parts) {
+            var buffers = [], part = null;
+
+            for (var i = 0; i < parts.length; ++i) {
+              part = parts[i];
+              buffers.push((part instanceof Buffer) ? part : new Buffer(part));
+            }
+
+            msg.payload = Buffer.concat(buffers);
+            resolve();
+          });
+      } else {
+        resolve();
+      }
+    });
+  },
+
+
   reportError: function (node, msg, err) {
     var messageTxt = err;
 
@@ -162,7 +188,7 @@ PayloadUtils.prototype = {
         // default
         return cb(txt.split(' ').length);
       };
-      
+
     if (ct === 'ja') {
       fn = function(txt, cb) {
         cb(200);