microsoft · cwhitten · Mar 4, 2020 · Apr 19, 2019 · Apr 22, 2019 · Apr 24, 2019
diff --git a/STREAMING-EXTENSIONS.md b/STREAMING-EXTENSIONS.md
@@ -0,0 +1,99 @@
+# Direct Line Streaming Extensions
+
+This is CONTRIBUTING.md for Direct Line Streaming Extensions.
+
+## Run automated tests
+
+- Clone this repository branch
+- `npm ci`
+   - Please ignore `node-gyp` errors, it is a warning instead
+- `npm test`
+
+> You don't need to run `npm run build`. Jest will rebuild the source code on-the-fly for each test run.
+
+If you want to run tests in watch mode, run `npm test -- --watch`.
+
+## Build development bundle
+
+- Clone this repository
+- `npm ci`
+- `npm run build`
+
+After build succeeded, you can use the JavaScript bundle at `/dist/directline.js`. This is development build. It is not minified and contains instrumentation code for code coverage.
+
+To use the bundle:
+
+```js
+const { DirectLine } = window.DirectLine;
+
+const directLine = new DirectLineStreaming({
+  conversationId: '<required>',
+  domain: 'https://.../.bot/v3/directline',
+  token: '<required>',
+  webSocket: true
+});
+
+// Start the connection and console-logging every incoming activity
+directLine.activity$.subscribe({
+  next(activity) { console.log(activity); }
+});
+```
+
+## CI/CD pipeline
+
+### Build status
+
+For latest build status, navigate to https://travis-ci.org/microsoft/BotFramework-DirectLineJS/branches, and select `ckk/protocoljs` branch.
+
+### Test in Web Chat
+
+The last successful build can be tested with Web Chat and MockBot.
+
+- Navigate to https://compulim.github.io/webchat-loader/
+- Click `Dev` or select `<Latest development bit>` from the dropdown list
+- Click `[Public] MockBot with Streaming Extensions`
+- Click `Open Web Chat in a new window`
+
+Type `help` to MockBot for list of commands.
+
+### Build artifacts
+
+After successful build, artifacts are published to https://github.com/microsoft/BotFramework-DirectLineJS/releases/tag/dev-streamingextensions.
+
+For easier consumption, in the assets, [`directline.js`](https://github.com/microsoft/BotFramework-DirectLineJS/releases/download/dev-streamingextensions/directline.js) is the bundle from last successful build. You can use the HTML code below to use latest DirectLineJS with Web Chat 4.5.2:
+
+```html
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <title>Web Chat with Streaming Extensions</title>
+    <script src="https://cdn.botframework.com/botframework-webchat/latest/webchat-es5.js"></script>
+    <script src="https://github.com/microsoft/BotFramework-DirectLineJS/releases/download/dev-streamingextensions/directline.js"></script>
+    <style type="text/css">
+      html, body, body > div { height: 100%; }
+      body { margin: 0; }
+    </style>
+  </head>
+  <body>
+    <script>
+      const { DirectLine } = window.DirectLine;
+      const webChatElement = document.createElement('div');
+
+      window.WebChat.renderWebChat({
+        directLine: new DirectLine({
+          conversationId: '<required>',
+          domain: 'https://.../.bot/v3/directline',
+          token: '<required>',
+          webSocket: true
+        })
+      }, webChatElement);
+
+      document.body.append(webChatElement);
+    </script>
+  </body>
+</html>
+```
+
+### Source code
+
+Run `git checkout dev-streamingextensions` to checkout the source code of the last successful build.
diff --git a/__tests__/happy.conversationUpdate.js b/__tests__/happy.conversationUpdate.js
@@ -0,0 +1,49 @@
+import 'dotenv/config';
+
+import onErrorResumeNext from 'on-error-resume-next';
+
+import { timeouts } from './constants.json';
+import * as createDirectLine from './setup/createDirectLine';
+import waitForBotToRespond from './setup/waitForBotToRespond';
+import waitForConnected from './setup/waitForConnected';
+
+describe('Happy path', () => {
+  let unsubscribes;
+
+  beforeEach(() => unsubscribes = []);
+  afterEach(() => unsubscribes.forEach(fn => onErrorResumeNext(fn)));
+
+  describe('should receive the welcome message from bot', () => {
+    let directLine;
+
+    describe('using REST', () => {
+      beforeEach(() => jest.setTimeout(timeouts.rest));
+
+      test('with token', async () => {
+        directLine = await createDirectLine.forREST({ token: true });
+      });
+    });
+
+    test('using Streaming Extensions', async () => {
+      jest.setTimeout(timeouts.webSocket);
+      directLine = await createDirectLine.forStreamingExtensions();
+    });
+
+    describe('using Web Socket', () => {
+      beforeEach(() => jest.setTimeout(timeouts.webSocket));
+
+      test('with token', async () => {
+        directLine = await createDirectLine.forWebSocket({ token: true });
+      });
+    });
+
+    afterEach(async () => {
+      // If directLine object is undefined, that means the test is failing.
+      if (!directLine) { return; }
+
+      unsubscribes.push(directLine.end.bind(directLine));
+
+      await waitForBotToRespond(directLine, ({ text }) => text === 'Welcome')
+    });
+  });
+});
diff --git a/__tests__/happy.postActivity.js b/__tests__/happy.postActivity.js
@@ -29,10 +29,10 @@ describe('Happy path', () => {
       });
     });
 
-    // test('using Streaming Extensions', async () => {
-    //   jest.setTimeout(timeouts.webSocket);
-    //   directLine = await createDirectLine.forStreamingExtensions();
-    // });
+    test('using Streaming Extensions', async () => {
+      jest.setTimeout(timeouts.webSocket);
+      directLine = await createDirectLine.forStreamingExtensions();
+    });
 
     describe('using Web Socket', () => {
       beforeEach(() => jest.setTimeout(timeouts.webSocket));

diff --git a/__tests__/happy.receiveAttachmentStreams.js b/__tests__/happy.receiveAttachmentStreams.js
@@ -0,0 +1,61 @@
+import 'dotenv/config';
+
+import onErrorResumeNext from 'on-error-resume-next';
+
+import { timeouts } from './constants.json';
+import * as createDirectLine from './setup/createDirectLine';
+import fetchAsBase64 from './setup/fetchAsBase64';
+import postActivity from './setup/postActivity';
+import waitForBotToEcho from './setup/waitForBotToEcho';
+import waitForConnected from './setup/waitForConnected';
+import waitForBotToRespond from './setup/waitForBotToRespond.js';
+
+describe('Happy path', () => {
+  let unsubscribes;
+
+  beforeEach(() => unsubscribes = []);
+  afterEach(() => unsubscribes.forEach(fn => onErrorResumeNext(fn)));
+
+  describe('receive attachments', () => {
+    let directLine;
+
+    test('using Streaming Extensions', async () => {
+      jest.setTimeout(timeouts.webSocket);
+      directLine = await createDirectLine.forStreamingExtensions();
+    });
+
+    afterEach(async () => {
+      // If directLine object is undefined, that means the test is failing.
+      if (!directLine) { return; }
+
+      unsubscribes.push(directLine.end.bind(directLine));
+      unsubscribes.push(await waitForConnected(directLine));
+
+      let url1 = 'http://myasebot.azurewebsites.net/177KB.jpg';
+      let url2 = 'http://myasebot.azurewebsites.net/100KB.jpg';
+
+      const activityFromUser = {
+        text: 'attach ' + url1 + ' ' + url2,
+        type: 'message',
+        channelData: {
+          testType: "streaming"
+        }
+      };
+
+      await Promise.all([
+        postActivity(directLine, activityFromUser),
+        waitForBotToRespond(directLine, async (activity) => {
+          if (!activity.channelData){
+            return false;
+          }
+          let attachmentContents1 = await fetchAsBase64(url1);
+          let attachmentContents2 = await fetchAsBase64(url2);
+          const prefixLength = "data:text/plain;base64,".length;
+          return (activity.attachments.length == 2 &&
+             attachmentContents1 == activity.attachments[0].contentUrl.substr(prefixLength) &&
+             attachmentContents2 == activity.attachments[1].contentUrl.substr(prefixLength));
+        })
+      ]);
+    });
+  });
+});
diff --git a/__tests__/happy.uploadAttachmentStreams.js b/__tests__/happy.uploadAttachmentStreams.js
@@ -0,0 +1,77 @@
+import 'dotenv/config';
+
+import onErrorResumeNext from 'on-error-resume-next';
+
+import { timeouts } from './constants.json';
+import * as createDirectLine from './setup/createDirectLine';
+import fetchAsBase64 from './setup/fetchAsBase64';
+import postActivity from './setup/postActivity';
+import waitForBotToEcho from './setup/waitForBotToEcho';
+import waitForConnected from './setup/waitForConnected';
+
+describe('Happy path', () => {
+  let unsubscribes;
+
+  beforeEach(() => unsubscribes = []);
+  afterEach(() => unsubscribes.forEach(fn => onErrorResumeNext(fn)));
+
+  describe('upload 2 attachments with text messages', () => {
+    let directLine;
+
+    test('using Streaming Extensions', async () => {
+      jest.setTimeout(timeouts.webSocket);
+      directLine = await createDirectLine.forStreamingExtensions();
+    });
+
+    afterEach(async () => {
+      // If directLine object is undefined, that means the test is failing.
+      if (!directLine) { return; }
+
+      unsubscribes.push(directLine.end.bind(directLine));
+      unsubscribes.push(await waitForConnected(directLine));
+
+      const activityFromUser = {
+        // DirectLine.postActivityWithAttachments support "contentUrl" only but not "content"
+        attachments: [{
+          contentType: 'image/jpg',
+          contentUrl: 'http://myasebot.azurewebsites.net/177KB.jpg'
+        }, {
+          contentType: 'image/jpg',
+          contentUrl: 'http://myasebot.azurewebsites.net/100KB.jpg'
+        }],
+        text: 'Hello, World!',
+        type: 'message',
+        channelData: {
+          testType: "streaming"
+        }
+      };
+
+      await Promise.all([
+        postActivity(directLine, activityFromUser),
+        waitForBotToEcho(directLine, async ({ attachments, text }) => {
+          if (text === 'Hello, World!' && attachments) {
+            const [expectedContents, actualContents] = await Promise.all([
+              Promise.all([
+                fetchAsBase64(activityFromUser.attachments[0].contentUrl),
+                fetchAsBase64(activityFromUser.attachments[1].contentUrl)
+              ]),
+            ]);
+
+
+            let result = ( (expectedContents[0] === attachments[0].contentUrl &&
+                            expectedContents[1] === attachments[1].contentUrl) ||
+                          (expectedContents[1] === attachments[0].contentUrl &&
+                            expectedContents[0] === attachments[1].contentUrl) );
+
+            if (!result) {
+              console.warn(attachments[0].contentUrl);
+              console.warn(attachments[1].contentUrl);
+            }
+
+            return result;
+          }
+        })
+      ]);
+    });
+  });
+});
diff --git a/__tests__/happy.uploadAttachments.js b/__tests__/happy.uploadAttachments.js
@@ -30,11 +30,6 @@ describe('Happy path', () => {
       });
     });
 
-    // test('using Streaming Extensions', async () => {
-    //   jest.setTimeout(timeouts.webSocket);
-    //   directLine = await createDirectLine.forStreamingExtensions();
-    // });
-
     describe('using Web Socket', () => {
       beforeEach(() => jest.setTimeout(timeouts.webSocket));
 
@@ -57,13 +52,13 @@ describe('Happy path', () => {
       const activityFromUser = {
         // DirectLine.postActivityWithAttachments support "contentUrl" only but not "content"
         attachments: [{
-          contentType: 'image/png',
-          contentUrl: 'https://webchat-waterbottle.azurewebsites.net/public/surfacelogo.png',
-          thumbnailUrl: 'data:image/png;base64,===surfacelogo.png'
+          contentType: 'image/jpg',
+          contentUrl: 'http://myasebot.azurewebsites.net/177KB.jpg',
+          thumbnailUrl: 'data:image/png;base64,===177KB.jpg'
         }, {
           contentType: 'image/png',
-          contentUrl: 'https://webchat-waterbottle.azurewebsites.net/public/xboxlogo.png',
-          thumbnailUrl: 'data:image/png;base64,===xboxlogo.png'
+          contentUrl: 'http://myasebot.azurewebsites.net/100KB.jpg',
+          thumbnailUrl: 'data:image/png;base64,===100KB.jpb'
         }],
         text: 'Hello, World!',
         type: 'message'

diff --git a/__tests__/setup/createDirectLine.js b/__tests__/setup/createDirectLine.js
@@ -2,16 +2,17 @@ import fetch from 'node-fetch';
 
 import { DirectLine } from '../../src/directLine';
 import { userId as DEFAULT_USER_ID } from '../constants.json';
+import { DirectLineStreaming } from '../../src/directLineStreaming';
 
 const {
   DIRECT_LINE_SECRET,
-  STREAMING_EXTENSIONS_DOMAIN = 'https://webchat-waterbottle.azurewebsites.net/.bot/v3/directline'
+  STREAMING_EXTENSIONS_DOMAIN = 'https://myasebot.azurewebsites.net/.bot/v3/directline'
 } = process.env;
 
 const DEFAULT_DOMAIN = 'https://directline.botframework.com/v3/directline';
 
 async function fetchDirectLineToken() {
-  const res = await fetch('https://webchat-waterbottle.azurewebsites.net/token/directline');
+  const res = await fetch('https://myasebot.azurewebsites.net/token/directline');
 
   if (res.ok) {
     return await res.json();
@@ -21,7 +22,7 @@ async function fetchDirectLineToken() {
 }
 
 async function fetchDirectLineStreamingExtensionsToken() {
-  const res = await fetch(`${ STREAMING_EXTENSIONS_DOMAIN }/token/directline`);
+  const res = await fetch(`https://myasebot.azurewebsites.net/token/directlinease`);
 
   if (res.ok) {
     return await res.json();
@@ -79,10 +80,9 @@ export async function forStreamingExtensions(mergeOptions = {}) {
   :
     await fetchDirectLineStreamingExtensionsToken();
 
-  return new DirectLine({
+  return new DirectLineStreaming({
     conversationId,
     domain: STREAMING_EXTENSIONS_DOMAIN,
-    streamingWebSocket: true,
     token,
     webSocket: true,
     ...mergeOptions