@openfeed/sdk-js 1.1.5 → 1.1.6

package/.releases/CHANGELOG-1.1.6.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [1.1.5](https://github.com/openfeed-org/sdk-js/compare/1.1.4...1.1.5) (2023-12-22)
+
+
+### Bug Fixes
+
+* new approach for listening to alias changes ([69f2d7d](https://github.com/openfeed-org/sdk-js/commit/69f2d7d6e5b64d7abeb6c6cda052c6e7f512aef3))

package/CHANGELOG.md

@@ -2,9 +2,9 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [1.1.5](https://github.com/openfeed-org/sdk-js/compare/1.1.4...1.1.5) (2023-12-22)
+### [1.1.6](https://github.com/openfeed-org/sdk-js/compare/1.1.5...1.1.6) (2024-02-27)
 
 
 ### Bug Fixes
 
-* new approach for listening to alias changes ([69f2d7d](https://github.com/openfeed-org/sdk-js/commit/69f2d7d6e5b64d7abeb6c6cda052c6e7f512aef3))
+* enhance unsubscription flow to prevent duplicate race condition ([863a4fe](https://github.com/openfeed-org/sdk-js/commit/863a4fe5e2ff27613b70a9f1638df211fd796acc))

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const version = "1.1.5";
+export declare const version = "1.1.6";

package/dist/index.js

@@ -8031,7 +8031,7 @@ class ResolutionSource {
     return this.onError;
   }
 }
-const version = "1.1.5";
+const version = "1.1.6";
 const send = (socket, message) => {
   socket.send(OpenfeedGatewayRequestEncode.encode(toT(message)).finish());
 };
@@ -8073,7 +8073,7 @@ class ConnectionDisposedError extends Error {
 }
 class OpenFeedConnection {
   constructor(connectionToken, socket, listeners, logger) {
-    __publicField(this, "subscriptions", /* @__PURE__ */ new Map());
+    __publicField(this, "subscriptionRequests", /* @__PURE__ */ new Map());
     __publicField(this, "exchangeRequests", /* @__PURE__ */ new Map());
     __publicField(this, "instrumentRequests", /* @__PURE__ */ new Map());
     __publicField(this, "definitionsInFlight", /* @__PURE__ */ new Map());
@@ -8157,6 +8157,16 @@ class OpenFeedConnection {
             request.resolve(message.exchangeResponse);
             continue;
           }
+          if (message.subscriptionResponse) {
+            const { correlationId, unsubscribe } = message.subscriptionResponse;
+            if (!unsubscribe) {
+              const request = this.subscriptionRequests.get(correlationId.toString());
+              if (!request)
+                throw new Error(`Subscription response ID ${correlationId} not found`);
+              const [, sub] = request;
+              sub.resolve();
+            }
+          }
           this.listeners.onMessage(message);
         }
       } catch (error) {
@@ -8229,7 +8239,8 @@ class OpenFeedConnection {
         requests: requests.map((r) => toT(r)),
         unsubscribe: false
       };
-      this.subscriptions.set(correlationId.toString(), subscriptionRequest);
+      const source = new ResolutionSource();
+      this.subscriptionRequests.set(correlationId.toString(), [subscriptionRequest, source]);
       send(this.socket, { subscriptionRequest });
       return correlationId;
     });
@@ -8237,13 +8248,12 @@ class OpenFeedConnection {
       if (this.whenDisconnectedSource.completed) {
         throw new ConnectionDisposedError("This connection was closed");
       }
-      const subscription = this.subscriptions.get(subscriptionId.toString());
+      const subscription = this.subscriptionRequests.get(subscriptionId.toString());
       if (!subscription) {
         throw new Error(`Subscription ID ${subscriptionId} does not exist.`);
       }
-      const subscriptionRequest = { ...subscription, unsubscribe: true };
-      send(this.socket, { subscriptionRequest });
-      this.subscriptions.delete(subscriptionId.toString());
+      const [originalRequest, sub] = subscription;
+      this.fireUnsubscribeWhenReady(originalRequest, sub);
     });
     __publicField(this, "getExchanges", async () => {
       var _a;
@@ -8342,6 +8352,18 @@ class OpenFeedConnection {
     this.socket.close(1e3, error.message);
     this.whenDisconnectedSource.reject(error);
   }
+  // We are keeping this fire and forget, because our problems
+  // would be caused by disconnection, and reconnect will clean up the rest
+  async fireUnsubscribeWhenReady(originalRequest, sub) {
+    try {
+      await sub.whenCompleted;
+      const subscriptionRequest = { ...originalRequest, unsubscribe: true };
+      send(this.socket, { subscriptionRequest });
+    } catch (e) {
+    } finally {
+      this.subscriptionRequests.delete(originalRequest.correlationId.toString());
+    }
+  }
 }
 class OpenFeedClient {
   constructor(url, username, password, listeners, logger, clientId) {
@@ -8607,14 +8629,22 @@ class OpenFeedListeners {
         return res ?? [void 0, void 0];
       };
       if (message.subscriptionResponse) {
-        if (message.subscriptionResponse != null && message.subscriptionResponse.marketId !== Long.ZERO) {
-          [def, symbols] = getInstrumentDefinition(message.subscriptionResponse.marketId);
-          if (!symbols) {
-            symbols = [message.subscriptionResponse.symbol];
-          } else if (!symbols.includes(message.subscriptionResponse.symbol)) {
-            symbols = [...symbols, message.subscriptionResponse.symbol];
-          }
-          this.instrumentByMarketId.set(message.subscriptionResponse.marketId.toString(), [def, symbols]);
+        const { marketId, symbol, unsubscribe } = message.subscriptionResponse;
+        if (marketId !== Long.ZERO) {
+          [def, symbols] = getInstrumentDefinition(marketId);
+          if (!unsubscribe) {
+            if (!symbols) {
+              symbols = [symbol];
+            } else if (!symbols.includes(symbol)) {
+              symbols = [...symbols, symbol];
+            }
+          } else {
+            if (symbols) {
+              symbols = symbols.filter((s) => s !== symbol);
+            }
+            this.instrumentBySymbol.delete(symbol);
+          }
+          this.instrumentByMarketId.set(marketId.toString(), [def, symbols]);
         }
       } else if (message.instrumentDefinition) {
         [def, symbols] = getInstrumentDefinition(message.instrumentDefinition.marketId);

package/dist/node.js

@@ -11655,7 +11655,7 @@ var ResolutionSource = class {
 };
 
 // generated/version.ts
-var version = "1.1.5";
+var version = "1.1.6";
 
 // src/connection/connection.ts
 var send = (socket, message) => {
@@ -11707,7 +11707,7 @@ var OpenFeedConnection = class {
     this.socket.onclose = this.onClose;
     this.runConnectionWatchLoop();
   }
-  subscriptions = /* @__PURE__ */ new Map();
+  subscriptionRequests = /* @__PURE__ */ new Map();
   exchangeRequests = /* @__PURE__ */ new Map();
   instrumentRequests = /* @__PURE__ */ new Map();
   definitionsInFlight = /* @__PURE__ */ new Map();
@@ -11791,6 +11791,16 @@ var OpenFeedConnection = class {
           request.resolve(message.exchangeResponse);
           continue;
         }
+        if (message.subscriptionResponse) {
+          const { correlationId, unsubscribe } = message.subscriptionResponse;
+          if (!unsubscribe) {
+            const request = this.subscriptionRequests.get(correlationId.toString());
+            if (!request)
+              throw new Error(`Subscription response ID ${correlationId} not found`);
+            const [, sub] = request;
+            sub.resolve();
+          }
+        }
         this.listeners.onMessage(message);
       }
     } catch (error) {
@@ -11881,7 +11891,8 @@ var OpenFeedConnection = class {
       requests: requests.map((r) => toT(r)),
       unsubscribe: false
     };
-    this.subscriptions.set(correlationId.toString(), subscriptionRequest);
+    const source = new ResolutionSource();
+    this.subscriptionRequests.set(correlationId.toString(), [subscriptionRequest, source]);
     send(this.socket, { subscriptionRequest });
     return correlationId;
   };
@@ -11889,14 +11900,25 @@ var OpenFeedConnection = class {
     if (this.whenDisconnectedSource.completed) {
       throw new ConnectionDisposedError("This connection was closed");
     }
-    const subscription = this.subscriptions.get(subscriptionId.toString());
+    const subscription = this.subscriptionRequests.get(subscriptionId.toString());
     if (!subscription) {
       throw new Error(`Subscription ID ${subscriptionId} does not exist.`);
     }
-    const subscriptionRequest = { ...subscription, unsubscribe: true };
-    send(this.socket, { subscriptionRequest });
-    this.subscriptions.delete(subscriptionId.toString());
+    const [originalRequest, sub] = subscription;
+    this.fireUnsubscribeWhenReady(originalRequest, sub);
   };
+  // We are keeping this fire and forget, because our problems
+  // would be caused by disconnection, and reconnect will clean up the rest
+  async fireUnsubscribeWhenReady(originalRequest, sub) {
+    try {
+      await sub.whenCompleted;
+      const subscriptionRequest = { ...originalRequest, unsubscribe: true };
+      send(this.socket, { subscriptionRequest });
+    } catch (e) {
+    } finally {
+      this.subscriptionRequests.delete(originalRequest.correlationId.toString());
+    }
+  }
   getExchanges = async () => {
     var _a;
     if (this.whenDisconnectedSource.completed) {
@@ -12236,14 +12258,22 @@ var OpenFeedListeners = class {
       return res ?? [void 0, void 0];
     };
     if (message.subscriptionResponse) {
-      if (message.subscriptionResponse != null && message.subscriptionResponse.marketId !== long_default.ZERO) {
-        [def, symbols] = getInstrumentDefinition(message.subscriptionResponse.marketId);
-        if (!symbols) {
-          symbols = [message.subscriptionResponse.symbol];
-        } else if (!symbols.includes(message.subscriptionResponse.symbol)) {
-          symbols = [...symbols, message.subscriptionResponse.symbol];
-        }
-        this.instrumentByMarketId.set(message.subscriptionResponse.marketId.toString(), [def, symbols]);
+      const { marketId, symbol, unsubscribe } = message.subscriptionResponse;
+      if (marketId !== long_default.ZERO) {
+        [def, symbols] = getInstrumentDefinition(marketId);
+        if (!unsubscribe) {
+          if (!symbols) {
+            symbols = [symbol];
+          } else if (!symbols.includes(symbol)) {
+            symbols = [...symbols, symbol];
+          }
+        } else {
+          if (symbols) {
+            symbols = symbols.filter((s) => s !== symbol);
+          }
+          this.instrumentBySymbol.delete(symbol);
+        }
+        this.instrumentByMarketId.set(marketId.toString(), [def, symbols]);
       }
     } else if (message.instrumentDefinition) {
       [def, symbols] = getInstrumentDefinition(message.instrumentDefinition.marketId);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfeed/sdk-js",
-    "version": "1.1.5",
+    "version": "1.1.6",
     "description": "JavaScript SDK for Barchart OpenFeed",
     "main": "dist/node.js",
     "browser": "dist/index.js",