feat: Replace socket.io-client (#99)

Author: gismya

.eslintignore

@@ -1,5 +1,4 @@
 lib/
-socket.io-websocket-only.js
 doc/resource
 coverage/
 build/

.gitignore

@@ -59,3 +59,4 @@ package.tgz
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+.DS_Store

package.json

@@ -23,20 +23,20 @@
     "dist"
   ],
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.0",
-    "@types/uuid": "^9.0.0",
-    "cross-fetch": "^3.1.5",
+    "@types/uuid": "^9.0.1",
+    "cross-fetch": "^3.1.6",
     "dayjs": "^1.11.7",
-    "eslint": "^8.33.0",
+    "eslint": "^8.41.0",
     "eslint-config-react-app": "^7.0.1",
-    "jsdom": "^21.1.0",
-    "lint-staged": "^13.1.0",
-    "msw": "^1.0.0",
-    "prettier": "^2.8.3",
+    "jsdom": "^22.0.0",
+    "lint-staged": "^13.2.2",
+    "msw": "^1.2.1",
+    "prettier": "^2.8.8",
     "typescript": "^5.0.4",
     "vite": "^4.3.8",
     "vite-plugin-dts": "^2.3.0",
-    "vitest": "^0.31.1"
+    "vitest": "^0.31.1",
+    "ws": "^8.13.0"
   },
   "repository": {
     "type": "git",
@@ -54,10 +54,19 @@
   },
   "homepage": "http://ftrack.com",
   "dependencies": {
+    "isomorphic-ws": "^5.0.0",
     "loglevel": "^1.8.1",
     "moment": "^2.29.4",
     "uuid": "^9.0.0"
   },
+  "peerDependencies": {
+    "ws": "^8.13.0"
+  },
+  "peerDependenciesMeta": {
+    "ws": {
+      "optional": true
+    }
+  },
   "lint-staged": {
     "*.js": "eslint --cache --fix",
     "*.{js,css,md,json,jsx,scss,yml}": "prettier --write"

source/event.ts

@@ -1,6 +1,6 @@
 // :copyright: Copyright (c) 2016 ftrack
 import { v4 as uuidV4 } from "uuid";
-
+import { EventSource } from "./event_hub.js";
 /**
  * ftrack API Event class.
  */
@@ -11,7 +11,7 @@ export class Event {
     target: string;
     inReplyToEvent: string | null;
     id: string;
-    source?: any;
+    source?: EventSource;
   };
 
   /**
@@ -37,12 +37,12 @@ export class Event {
   }
 
   /** Return event data. */
-  getData(): { [key: string]: any } {
+  getData() {
     return this._data;
   }
 
   /** Add source to event data. */
-  addSource(source: any): void {
+  addSource(source: EventSource): void {
     this._data.source = source;
   }
 }

source/event_hub.ts

@@ -1,7 +1,7 @@
 // :copyright: Copyright (c) 2016 ftrack
 import { v4 as uuidV4 } from "uuid";
 import loglevel from "loglevel";
-import * as io from "./socket.io-websocket-only.js";
+import io from "./simple_socketio.js";
 import { Event } from "./event.js";
 import {
   EventServerConnectionTimeoutError,
@@ -72,11 +72,11 @@ export type EventPayload =
   | UpdateEventPayload;
 
 export interface EventSource {
-  clientToken: string;
+  clientToken?: string;
   applicationId: string;
   user: {
     username: string;
-    id: string;
+    id?: string;
   };
   id: string;
 }
@@ -132,7 +132,7 @@ export class EventHub {
   };
   private _unsentEvents: ConnectionCallback[];
   private _subscribers: Subscriber[];
-  private _socketIo: io.SocketIO | null;
+  private _socketIo: io | null;
 
   /**
    * Construct EventHub instance with API credentials.
@@ -177,17 +177,7 @@ export class EventHub {
 
   /** Connect to the event server. */
   connect(): void {
-    this._socketIo = io.connect(this._serverUrl, {
-      "max reconnection attempts": Infinity,
-      "reconnection limit": 10000,
-      "reconnection delay": 5000,
-      transports: ["websocket"],
-      query: new URLSearchParams({
-        api_user: this._apiUser,
-        api_key: this._apiKey,
-      }).toString(),
-    });
-
+    this._socketIo = io.connect(this._serverUrl, this._apiUser, this._apiKey);
     this._socketIo.on("connect", this._onSocketConnected);
     this._socketIo.on("ftrack.event", this._handle);
   }
@@ -197,7 +187,7 @@ export class EventHub {
    * @return {Boolean}
    */
   isConnected(): boolean {
-    return (this._socketIo && this._socketIo.socket.connected) || false;
+    return this._socketIo?.isConnected() || false;
   }
 
   /**
@@ -247,7 +237,7 @@ export class EventHub {
    *
    * If timeout is non-zero, the promise will be rejected if the event is not
    * sent before the timeout is reached. Should be specified as seconds and
-   * will default to 10.
+   * will default to 30.
    *
    * @param  {Event}  event               Event instance to publish
    * @param  {Function} [options.onReply] Function to be invoked when a reply
@@ -368,7 +358,7 @@ export class EventHub {
         // Force reconnect socket if not automatically reconnected. This
         // happens for example in Adobe After Effects when rendering a
         // sequence takes longer than ~30s and the JS thread is blocked.
-        this._socketIo.socket.reconnect();
+        this._socketIo.reconnect();
       }
     } else {
       callback();