cmd-control-client-lib 3.0.5 → 3.0.11

package/dist/protocol/channel.d.ts

@@ -335,6 +335,8 @@ export declare class CMDP_CHANNELSSUMMARY_RESPONSE extends CMDP_CHANNELSSUMMARY
         pinned: string;
         /** number of muted channels */
         muted: string;
+        /** number of banned channels */
+        banned: string;
         /** number of vip channels */
         vip: string;
     };

package/dist/protocol/live/live-commands.d.ts

@@ -66,9 +66,7 @@ export declare class CMDP_TRACERT_REPLY_RESPONSE extends CMDP_TRACERT_REPLY impl
 }
 export declare class CMDP_KICK implements ICOMMAND {
     action: ACTION;
-    params: baseParamsType & chatIdType & {
-        time?: string;
-    };
+    params: baseParamsType & chatIdType;
 }
 export declare class CMDP_KICK_RESPONSE extends CMDP_KICK implements IRESPONSE {
     result: RESULT;

package/dist/v-control-error-event.d.ts

@@ -0,0 +1,4 @@
+export declare class VControlErrorEvent extends Event {
+    reConnectTimeout?: number;
+    isFatal?: boolean;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cmd-control-client-lib",
   "description": "Cmd-Client-Library",
-  "version": "3.0.5",
+  "version": "3.0.11",
   "directories": {
     "lib": "./dist"
   },
@@ -64,7 +64,7 @@
     "build": "webpack --config webpack.prod.js",
     "build:dev": "webpack --config webpack.dev.js",
     "watch": "webpack --config webpack.dev.js --watch",
-    "lint": "eslint src test --ext .ts",
+    "lint": "eslint src --ext .ts",
     "lint:teamcity": "yarn lint --format ./node_modules/eslint-teamcity/index.js",
     "style": "prettier --write \"{src,test}/**/*.ts\"",
     "test": "jest",

package/test/open-web-socket.spec.ts

@@ -0,0 +1,163 @@
+import { CmdConnection, ConnectionConfig } from "../src/cmd-connection";
+import { logger } from "../src/logger";
+import { VControlErrorEvent } from "../src/v-control-error-event";
+
+describe("WebSocket connection", () => {
+  it("Should open webSocket successfully", () => {
+    // @ts-ignore
+    global.WebSocket = jest.fn().mockImplementation(() => ({ send: jest.fn() }));
+    const connectionConfig = new ConnectionConfig();
+    connectionConfig.https = true;
+    connectionConfig.host = "hostMock";
+    connectionConfig.wssport = "wssPortMock";
+    connectionConfig.useWS = true;
+
+    const CMDConnection = new CmdConnection(connectionConfig);
+    CMDConnection.connect();
+    expect(global.WebSocket).toHaveBeenCalledWith("wss://hostMock:wssPortMock");
+    //Socket was successfully opened and is able from the service
+    expect(CMDConnection["_socket"]).not.toBeUndefined();
+  });
+
+  it("Should make 5 attempts if webSocket open failed", () => {
+    logger.warn = jest.fn();
+    jest.useFakeTimers();
+    const error = "Connection failed Mock";
+    // @ts-ignore
+    global.WebSocket = jest.fn().mockImplementation(() => {
+      throw new Error(error);
+
+      return {};
+    });
+
+    const connectionConfig = new ConnectionConfig();
+    connectionConfig.https = true;
+    connectionConfig.host = "hostMock";
+    connectionConfig.wssport = "wssPortMock";
+    connectionConfig.useWS = true;
+    connectionConfig.jsonp = false;
+    connectionConfig.connectionRetryInterval = 15000;
+    connectionConfig.onError = jest.fn();
+
+    const CMDConnection = new CmdConnection(connectionConfig);
+    CMDConnection.connect();
+    expect(global.WebSocket).toHaveBeenCalledWith("wss://hostMock:wssPortMock");
+    expect(CMDConnection["_socket"]).toBeUndefined();
+    //First attempt
+    expect(setTimeout).toHaveBeenCalledTimes(1);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 15000);
+
+    jest.runOnlyPendingTimers();
+    //Second attempt
+    const secondError = new VControlErrorEvent("error");
+    secondError.reConnectTimeout = 15000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(secondError);
+    expect(setTimeout).toHaveBeenCalledTimes(2);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 30000);
+
+    jest.runOnlyPendingTimers();
+    //Third attempt
+    const thirdError = new VControlErrorEvent("error");
+    thirdError.reConnectTimeout = 30000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(thirdError);
+    expect(setTimeout).toHaveBeenCalledTimes(3);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 45000);
+
+    jest.runOnlyPendingTimers();
+    //Fourth attempt
+    const fourthError = new VControlErrorEvent("error");
+    fourthError.reConnectTimeout = 45000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(fourthError);
+    expect(setTimeout).toHaveBeenCalledTimes(4);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 60000);
+
+    jest.runOnlyPendingTimers();
+    //Final attempt
+    const finalError = new VControlErrorEvent("error");
+    finalError.reConnectTimeout = 60000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(finalError);
+    expect(setTimeout).toHaveBeenCalledTimes(5);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 75000);
+
+    jest.runOnlyPendingTimers();
+    const lastTimeout = new VControlErrorEvent("error");
+    lastTimeout.reConnectTimeout = 75000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(lastTimeout);
+    //No more setTimeout was called
+    expect(setTimeout).toHaveBeenCalledTimes(5);
+    expect(logger.warn).toHaveBeenCalledWith(
+      "CMDP._openSocket SECURITY_ERR, maximum reconnect attempts count reached",
+      new Error(error),
+    );
+    //Calling error function that was provided through settings with fatal:true flag
+    const fatalError = new VControlErrorEvent("error");
+    fatalError.isFatal = true;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(fatalError);
+  });
+
+  it("Should make up to 5 attempts if opened websocket failed", () => {
+    logger.log = jest.fn();
+    logger.warn = jest.fn();
+    jest.useFakeTimers();
+    // @ts-ignore
+    global.WebSocket = jest.fn().mockImplementationOnce(() => ({ send: jest.fn() }));
+    const connectionConfig = new ConnectionConfig();
+    connectionConfig.https = true;
+    connectionConfig.host = "hostMock";
+    connectionConfig.wssport = "wssPortMock";
+    connectionConfig.useWS = true;
+    connectionConfig.connectionRetryInterval = 15000;
+    connectionConfig.onError = jest.fn();
+
+    const CMDConnection = new CmdConnection(connectionConfig);
+    CMDConnection.connect();
+    expect(global.WebSocket).toHaveBeenCalledWith("wss://hostMock:wssPortMock");
+    //Socket is opened
+    expect(CMDConnection["_socket"]).not.toBeUndefined();
+
+    const closeEvent = { reason: "Mocked WebSocket close imitation" } as CloseEvent;
+    CMDConnection["_closing"] = false;
+    // @ts-ignore
+    CMDConnection._onclose(closeEvent);
+    expect(logger.log).toHaveBeenCalledWith("CMDP.socket.onclose", closeEvent);
+    expect(logger.log).toHaveBeenCalledWith("CMDP.retry connect in 15000 ms");
+
+    const error = "Connection failed Mock";
+    // @ts-ignore
+    global.WebSocket = jest.fn().mockImplementation(() => {
+      throw new Error(error);
+
+      return {};
+    });
+    jest.runOnlyPendingTimers();
+    //Socket was killed
+    expect(CMDConnection["_socket"]).toBeUndefined();
+    expect(global.WebSocket).toHaveBeenCalledWith("wss://hostMock:wssPortMock");
+    expect(setTimeout).toHaveBeenCalledTimes(2);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 30000);
+    jest.runOnlyPendingTimers();
+
+    const firstError = new VControlErrorEvent("error");
+    firstError.reConnectTimeout = 30000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(firstError);
+    expect(setTimeout).toHaveBeenCalledTimes(3);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 45000);
+    jest.runOnlyPendingTimers();
+
+    const secondError = new VControlErrorEvent("error");
+    secondError.reConnectTimeout = 45000;
+    expect(connectionConfig.onError).toHaveBeenCalledWith(secondError);
+    expect(setTimeout).toHaveBeenCalledTimes(4);
+    expect(setTimeout).toHaveBeenLastCalledWith(expect.any(Function), 60000);
+
+    //Imitating reconnect success on fourth attempt
+    //Socket can be opened successfully
+    // @ts-ignore
+    global.WebSocket = jest.fn().mockImplementationOnce(() => ({ send: jest.fn() }));
+    jest.runOnlyPendingTimers();
+    expect(setTimeout).toHaveBeenCalledTimes(4);
+    //Socket was successfully reconnected
+    expect(global.WebSocket).toHaveBeenCalledWith("wss://hostMock:wssPortMock");
+    expect(CMDConnection["_socket"]).not.toBeUndefined();
+  });
+});

package/test/result.spec.ts

@@ -1,17 +1,17 @@
 import { RESULT } from "../src/protocol/command/icommand";
-import { CODE } from "../src/protocol/command/resultcode";
+import { ResultCode } from "../src/protocol/command/resultcode";
 
 describe("RESULT", () => {
   it("Should accept ENUM OK value as result codes", () => {
     const result: RESULT = {
-      code: CODE.OK,
+      code: ResultCode.OK,
       reason: "All good",
     };
   });
 
   it("Should accept ENUM ERROR value as result codes", () => {
     const result: RESULT = {
-      code: CODE.SESSION_ERROR,
+      code: ResultCode.SESSION_ERROR,
       reason: "Unknown session",
     };
   });