Merge pull request #388 from kenime/master

Added Timeout and Optout learning for Conversation node

Author: chughts

services/conversation/v1.html

@@ -49,6 +49,10 @@
         <label for="node-input-workspaceid"><i class="fa fa-tag"></i> Workspace ID</label>
         <input type="text" id="node-input-workspaceid" placeholder="WorkspaceID">
     </div>
+    <div class="form-row">
+        <label for="node-input-timeout"><i class="fa fa-tag"></i> Timeout Period</label>
+        <input type="text" id="node-input-timeout" placeholder="Leave empty to disable">
+    </div>
     <div class="form-row">
         <label>&nbsp;</label>
         <input type="checkbox" id="node-input-context" style="display: inline-block; width: auto; vertical-align: top;">
@@ -62,7 +66,12 @@
     <div class="form-row">
         <label>&nbsp;</label>
         <input type="checkbox" id="node-input-empty-payload" style="display: inline-block; width: auto; vertical-align: top;">
-        <label for="node-input-empty-payload" style="width: 70%;"> Permit empty payload</label>
+        <label for="node-input-empty-payload" style="width: 70%;"> Permit Empty Payload</label>
+    </div>
+    <div class="form-row">
+        <label>&nbsp;</label>
+        <input type="checkbox" id="node-input-optout-learning" style="display: inline-block; width: auto; vertical-align: top;">
+        <label for="node-input-optout-learning" style="width: 70%;"> Opt Out Request Logging</label>
     </div>
 
     <div class="form-tips" id="conversation-form-tips">
@@ -81,6 +90,7 @@
     <li><code>msg.payload</code> : the message of the conversation to analyse. Format: String </li>
     <li><code>msg.user</code> (optional): unique identifier of the user. This will be used to maintain the context of the conversation for each user when using with multiple users. Format: String </li>
     <li><code>msg.params.workspace_id</code> : unique identifier of the workspace to be used. Could be also configured in the node. Format: String </li>
+    <li><code>msg.params.timeout</code> (optional): The timeout period (in millisecond) for Watson request. Leave empty or set to 0 to disable. </li>
     <li><code>msg.params.context</code> (optional): A context object that includes state information for the conversation. When you send multiple requests for the same conversation, include the context object from the response. (<a href="http://www.ibm.com/watson/developercloud/conversation/api/v1/#send_input" target="_blank">documentation</a>). This will overwrite any context saved in the node. Format: JSON </li>
     <li><code>msg.params.alternate_intents</code> (optional) : whether to return more than one intent. Default is false. Set to true to return all matching intents. For example, return all intents when the confidence is not high to allow users to choose their intent.</li>
     <li><code>msg.params.output</code> (optional) : see API documentation </li>
@@ -91,6 +101,7 @@
     <li><code>msg.params.username</code> : If provided will be used as the username credential for the Conversation service.</li>
     <li><code>msg.params.password</code> : If provided will be used as the password credential for the Conversation service.</li>
     <li><code>msg.params.endpoint</code> : If provided will be used as the url for the Conversation service.</li>
+    <li><code>msg.params.optout_learning</code> : Set to true to opt out of request logging. Check the <a href="https://console.bluemix.net/docs/services/watson/getting-started-logging.html#controlling-request-logging-for-watson-services" target="_blank">documentation</a> for details.</li>
     </ul>
     <p>See <a href="http://www.ibm.com/watson/developercloud/conversation/api/v1/#send_input" target="_blank">Conversation API documentation</a> for details.</p>
     <p>All Results will made available at <code>msg.payload</code> in JSON format. Check the  <a href="http://www.ibm.com/watson/developercloud/conversation/api/v1/#send_input" target="_blank">documentation</a> for details.</p>
@@ -108,7 +119,7 @@
 <script type="text/javascript">
     var oneditprepare = function() {
         $('input#node-input-context').change(function () {
-            var checked = $('input#node-input-context').prop('checked')
+            var checked = $('input#node-input-context').prop('checked');
             if (checked) {
                 $('input#node-input-multiuser').parent().show();
                 $('#conversation-form-tips').show();
@@ -118,7 +129,7 @@
             }
         });
         $('input#node-input-default-endpoint').change(function () {
-            var checked = $('input#node-input-default-endpoint').prop('checked')
+            var checked = $('input#node-input-default-endpoint').prop('checked');
             if (checked) {
                 $('#node-input-service-endpoint').parent().hide();
             } else {
@@ -147,8 +158,10 @@
               multiuser: {value: false},
               context: {value: true},
               'empty-payload': {value: false},
-              'default-endpoint' :{value: true},
-              'service-endpoint' :{value: 'https://gateway.watsonplatform.net/conversation/api'}
+              'default-endpoint' : {value: true},
+              'service-endpoint' : {value: 'https://gateway.watsonplatform.net/conversation/api'},
+              timeout: {value: '', validate: RED.validators.number(true)},
+              'optout-learning': {value: false}
             },
             credentials: {
               username: {type:'text'},

services/conversation/v1.js

@@ -124,6 +124,7 @@ module.exports = function(RED) {
     if (msg.params && msg.params.alternate_intents) {
       params.alternate_intents = msg.params.alternate_intents;
     }
+
     verifyOptionalInputs(node, msg, config, params);
     return true;
   }
@@ -143,7 +144,8 @@ module.exports = function(RED) {
 
     var userName = sUsername || node.credentials.username,
       passWord = sPassword || node.credentials.password,
-      endpoint = '';
+      endpoint = '',
+      optoutLearning = false;
 
     if (!(userName || msg.params.username) ||
       !(passWord || msg.params.password)) {
@@ -165,6 +167,9 @@ module.exports = function(RED) {
       }
     }
 
+    serviceSettings.username = userName;
+    serviceSettings.password = passWord;
+
     if (service) {
       endpoint = service.url;
     }
@@ -179,15 +184,31 @@ module.exports = function(RED) {
       serviceSettings.url = endpoint;
     }
 
-    serviceSettings.username = userName;
-    serviceSettings.password = passWord;
+    if ((msg.params && msg.params['optout_learning'])){
+      optoutLearning = true;
+    } else if (config['optout-learning']){
+      optoutLearning = true;
+    }
+
+    if (optoutLearning){
+      serviceSettings.headers = serviceSettings.headers || {};
+      serviceSettings.headers['X-Watson-Learning-Opt-Out'] = '1';
+    }
+
+    if (config['timeout'] && config['timeout'] !== '0' && isFinite(config['timeout'])){
+      serviceSettings.timeout = parseInt(config['timeout']);
+    }
+
+    if (msg.params && msg.params.timeout !== '0' && isFinite(msg.params.timeout)){
+      serviceSettings.timeout = parseInt(msg.params.timeout);
+    }
 
     node.service = new ConversationV1(serviceSettings);
     return true;
   }
 
   function processResponse(err, body, node, msg, config) {
-    if (err !== null && body === null) {
+    if (err !== null && (body === null || typeof (body) === 'undefined')) {
       node.error(err, msg);
       node.status({
         fill: 'red',