@mfxhub/sdk 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -4,6 +4,14 @@ Every release of `@mfxhub/sdk`, newest first. The format follows
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
 [Semantic Versioning](https://semver.org/).
 
+## 0.2.2
+
+### Fixed
+
+- `stream.close()` ends the stream for good. A `next()` or a `for await` loop waiting for a message
+  ends with nothing, and a reconnect under way is given up. Before, closing while a read waited
+  made the stream reconnect and keep delivering, so a script that closed its stream did not end.
+
 ## 0.2.1
 
 ### Added

package/dist/stream.d.ts

@@ -127,7 +127,10 @@ export declare class MfxStream implements AsyncIterable<StreamEvent> {
     resume(channel: string): Promise<void>;
     /** Stop watching a channel, and stop subscribing to it again after a reconnect. */
     unsubscribe(channel: string): Promise<void>;
-    /** Close the connection, if one is open. */
+    /**
+     * Close the stream for good. A read waiting on it ends with null, a reconnect under way is
+     * given up, and the stream is never opened again.
+     */
     close(): Promise<void>;
     [Symbol.asyncIterator](): AsyncGenerator<StreamEvent, void, undefined>;
     /**

package/dist/stream.js

@@ -208,6 +208,8 @@ export class MfxStream {
         refused: 0,
     };
     #connection = null;
+    /** The caller closed the stream: nothing reconnects it, and every read is null from here on. */
+    #closed = false;
     /** Use {@link MfxClient.stream}. */
     constructor(client, options = {}) {
         this.#client = client;
@@ -258,8 +260,12 @@ export class MfxStream {
         this.#channels.delete(channel);
         await this.#send({ op: "unsubscribe", ch: channel });
     }
-    /** Close the connection, if one is open. */
+    /**
+     * Close the stream for good. A read waiting on it ends with null, a reconnect under way is
+     * given up, and the stream is never opened again.
+     */
     async close() {
+        this.#closed = true;
         const connection = this.#connection;
         this.#connection = null;
         if (connection !== null)
@@ -287,6 +293,9 @@ export class MfxStream {
                 raw = await connection.recv();
             }
             catch (error) {
+                // The caller's own close ends the read; it is not a drop to come back from.
+                if (this.#closed)
+                    return null;
                 if (!(error instanceof StreamClosed))
                     throw error;
                 if (!(await this.#reopen(error)))
@@ -362,7 +371,14 @@ export class MfxStream {
         this.#bump("reconnects");
         // The client's own backoff, so the stream and the reads lean on this tenant's quota alike.
         await this.#client.pause(this.#client.backoffMs(this.#stats.reconnects));
+        if (this.#closedNow())
+            return false; // closed while waiting out the backoff
         await this.open();
+        if (this.#closedNow()) {
+            // closed while the connection was being opened: that one is closed too
+            await this.close();
+            return false;
+        }
         for (const [channel, last] of [...this.#channels]) {
             if (replayable(channel) && last !== null) {
                 await this.#send({ op: "resume", ch: channel, after_seq: last });
@@ -376,6 +392,10 @@ export class MfxStream {
         }
         return true;
     }
+    /** Read afresh after an await: close() may have run while this was waiting. */
+    #closedNow() {
+        return this.#closed;
+    }
     async #send(message) {
         const connection = this.#connection;
         if (connection === null)

package/dist/version.d.ts

@@ -1,4 +1,4 @@
 /** This package's version. */
-export declare const VERSION = "0.2.1";
+export declare const VERSION = "0.2.2";
 /** What every request says it is, as a product token: the SDK's language and its version. */
-export declare const USER_AGENT = "mfx-sdk-typescript/0.2.1";
+export declare const USER_AGENT = "mfx-sdk-typescript/0.2.2";

package/dist/version.js

@@ -1,5 +1,5 @@
 // This package's version, in one place: exported by the package, and named by every request.
 /** This package's version. */
-export const VERSION = "0.2.1";
+export const VERSION = "0.2.2";
 /** What every request says it is, as a product token: the SDK's language and its version. */
 export const USER_AGENT = `mfx-sdk-typescript/${VERSION}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mfxhub/sdk",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Typed TypeScript client for the MFX Hub API: hosted trading terminals, market data, execution and a live event stream",
   "license": "Apache-2.0",
   "type": "module",