Merge pull request #119 from amazon-connect/add-typing-throttle

throttle typing event

package.json

@@ -58,7 +58,8 @@
       "json",
       "html",
       "cobertura",
-      "lcov"
+      "lcov",
+      "text"
     ]
   },
   "author": "Amazon Web Services",

src/client/client.js

@@ -6,6 +6,8 @@ import {
 import { LogManager } from "../log";
 //Note: this imports AWS instead from aws-sdk npm package - details in ReadMe
 import { ConnectParticipant } from "./aws-sdk-connectparticipant";
+import throttle from "lodash/throttle";
+import { CONTENT_TYPE, TYPING_VALIDITY_TIME } from '../constants';
 
 const DEFAULT_PREFIX = "Amazon-Connect-ChatJS-ChatClient";
 
@@ -227,21 +229,35 @@ class AWSChatClient extends ChatClient {
       .catch(err => { return Promise.reject(err); });
   }
 
+
   sendEvent(connectionToken, contentType, content) {
     let self = this;
-      var params = {
-        ConnectionToken: connectionToken,
-        ContentType: contentType,
-        Content: content
-      };
-      var sendEventRequest = self.chatClient.sendEvent(params);
-      const logContent = {contentType};
-      return self._sendRequest(sendEventRequest).then((res) => {
-        this.logger.debug("Successfully send event", {...logContent, id: res.data?.Id, });
-        return res;
-      }).catch((err) => {
-        return Promise.reject(err);
-      });
+    if(contentType === CONTENT_TYPE.typing) {
+      return self.throttleEvent(connectionToken, contentType, content)
+    }
+    return self._submitEvent(connectionToken, contentType, content);
+  }
+
+  throttleEvent = throttle((connectionToken, contentType, content) => {
+    return this._submitEvent(connectionToken, contentType, content);
+  }, TYPING_VALIDITY_TIME, { trailing: false, leading: true })
+
+  async _submitEvent(connectionToken, contentType, content) {
+    let self = this;
+    var params = {
+      ConnectionToken: connectionToken,
+      ContentType: contentType,
+      Content: content
+    };
+    var sendEventRequest = self.chatClient.sendEvent(params);
+    const logContent = {contentType};
+    try {
+      const res = await self._sendRequest(sendEventRequest);
+      this.logger.debug("Successfully send event", { ...logContent, id: res.data?.Id, });
+      return res;
+    } catch (err) {
+      return await Promise.reject(err);
+    }
   }
 
   _sendRequest(request) {

src/client/client.spec.js

@@ -0,0 +1,54 @@
+import { ChatClientFactory } from "./client";
+import { CONTENT_TYPE } from "../constants";
+import { jest } from "@jest/globals";
+
+describe("client test cases", () => {
+  describe("event throttling test cases", () => {
+    const options = {};
+    const logMetaData = {};
+    const connectionToken = "connectionToken";
+    const content = "content";
+
+    var chatClient = ChatClientFactory.getCachedClient(options, logMetaData);
+
+    beforeEach(() => {
+      jest.spyOn(chatClient, "_submitEvent").mockImplementation(() => {});
+      jest.useFakeTimers();
+      jest.clearAllTimers();
+      jest.clearAllMocks();
+    });
+
+    test("typing event should be throttled if content type is typing", () => {
+      let count = 0;
+      let typingInterval = setInterval(() => {
+        if (count > 8) {
+          clearInterval(typingInterval);
+        }
+        count++;
+        chatClient.sendEvent(connectionToken, CONTENT_TYPE.typing, content);
+      }, 100);
+      jest.advanceTimersByTime(900);
+      expect(chatClient._submitEvent).toHaveBeenCalledTimes(1);
+    });
+
+    test("Other events should not be throttled", () => {
+      for (let key in CONTENT_TYPE) {
+        jest.clearAllTimers();
+        jest.clearAllMocks();
+        if (key === "typing") {
+          continue;
+        }
+        let count = 0;
+        let typingInterval = setInterval(() => {
+          if (count > 8) {
+            clearInterval(typingInterval);
+          }
+          count++;
+          chatClient.sendEvent(connectionToken, CONTENT_TYPE[key], content);
+        }, 100);
+        jest.advanceTimersByTime(900);
+        expect(chatClient._submitEvent).toHaveBeenCalledTimes(9);
+      }
+    });
+  });
+});

src/constants.js

@@ -160,4 +160,6 @@ export const MOCK_USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
 export const SEND_EVENT_CONACK_THROTTLED = "SEND_EVENT_CONACK_THROTTLED";
 export const CREATE_PARTICIPANT_CONACK_FAILURE = "CREATE_PARTICIPANT_CONACK_FAILURE";
 export const SEND_EVENT_CONACK_FAILURE = "SEND_EVENT_CONACK_FAILURE";
-export const CREATE_PARTICIPANT_CONACK_API_CALL_COUNT = "CREATE_PARTICIPANT_CONACK_CALL_COUNT";
+export const CREATE_PARTICIPANT_CONACK_API_CALL_COUNT = "CREATE_PARTICIPANT_CONACK_CALL_COUNT";
+
+export const TYPING_VALIDITY_TIME = 10000;