Merge pull request #123 from Naktibalda/feature/dynamic-workspace-id

Set workspace_id dynamically

Author: germanattanasio

README.md

@@ -362,6 +362,30 @@ middleware.before = function(message, conversationPayload, callback) {
   }
 ```
 
+#### Dynamic workspace
+
+If you need to make use of multiple workspaces in a single bot, workspace_id can be changed dynamically by setting workspace_id property in context.
+
+Example of setting workspace_id to id provided as a property of hello message:
+```js
+function handleHelloEvent(bot, message) {
+    message.type = 'welcome';
+    var contextDelta = {};
+
+    if (message.workspaceId) {
+        contextDelta.workspace_id = message.workspaceId;
+    }
+
+    watsonMiddleware.sendToWatsonAsync(bot, message, contextDelta).catch(function (error) {
+        message.watsonError = error;
+    }).then(function () {
+        bot.reply(message, message.watsonData.output.text.join('\n'));
+    });
+}
+
+controller.on('hello', handleHelloEvent);
+```
+
 ## License
 
 This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).

lib/middleware/index.js

@@ -108,6 +108,9 @@ module.exports = function(config) {
             payload.context = deepMerge(payload.context, contextDelta);
           }
         }
+        if (payload.context && payload.context.workspace_id && payload.context.workspace_id.length === 36) {
+          payload.workspace_id = payload.context.workspace_id;
+        }
         return payload;
       }).then(function(payload) {
         return before(message, payload);

test/test.middleware_send_to_watson.js

@@ -218,4 +218,66 @@ describe('sendToWatson()', function() {
       });
     });
   });
+
+  it('should make request to different workspace, if workspace_id is set in context', function (done) {
+    var newWorkspaceId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
+
+    var expectedPath = '/v1/workspaces/' + newWorkspaceId + '/message';
+
+    var storedContext = {
+      workspace_id: newWorkspaceId
+    };
+
+    var expectedContextInResponse = clone(storedContext);
+    expectedContextInResponse.conversation_id = "8a79f4db-382c-4d56-bb88-1b320edf9eae",
+      expectedContextInResponse.system = {
+        dialog_stack: [
+          "root"
+        ],
+        dialog_turn_counter: 1,
+        dialog_request_counter: 1
+      };
+
+    var expectedRequest = {
+      input: {
+        text: message.text
+      },
+      context: storedContext
+    };
+
+    var mockedWatsonResponse = {
+      "intents": [],
+      "entities": [],
+      "input": {
+        "text": "hi"
+      },
+      "output": {
+        "log_messages": [],
+        "text": [
+          "Hello from Watson Conversation!"
+        ],
+        "nodes_visited": [
+          "node_1_1467221909631"
+        ]
+      },
+      "context": expectedContextInResponse
+    };
+
+    //verify request and return mocked response
+    var mockedRequest = nock(service.url)
+      .post(expectedPath + '?version=' + service.version_date, expectedRequest)
+      .reply(200, mockedWatsonResponse);
+
+    utils.updateContext(message.user, bot.botkit.storage, {context: storedContext}, function(err) {
+      assert.ifError(err);
+
+      middleware.sendToWatson(bot, message, function(err, response) {
+        assert.ifError(err);
+        assert.ifError(message.watsonError);
+
+        mockedRequest.done();
+        done();
+      });
+    });
+  })
 });