@mfxhub/sdk 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -4,6 +4,22 @@ 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
+
+- Every request the SDK sends, and the stream's upgrade, carries
+  `User-Agent: mfx-sdk-typescript/<version>`, built from the package's own version, so MFX Hub can
+  tell which SDK and which version made each call.
+
 ## 0.2.0
 
 ### Added

package/dist/client.js

@@ -12,6 +12,7 @@ import { Catalog } from "./catalog.js";
 import { Execution } from "./execution.js";
 import { MfxStream } from "./stream.js";
 import { Terminals } from "./terminals.js";
+import { USER_AGENT } from "./version.js";
 /** Default time a single request may take. */
 export const DEFAULT_TIMEOUT_MS = 30_000;
 /** How many times a rate-limited read is tried again. */
@@ -138,6 +139,7 @@ export class MfxClient {
         const body = spec.body === undefined ? new Uint8Array() : Buffer.from(JSON.stringify(spec.body));
         const headers = {
             Accept: "application/json",
+            "User-Agent": USER_AGENT,
             ...this.#signer.headersFor(spec.method, url.pathname + url.search, body),
         };
         if (spec.body !== undefined)

package/dist/index.d.ts

@@ -25,5 +25,4 @@ export type { CreateTerminal, JournalLine, JournalOptions, PageOptions, Redundan
 export { RequestSigner, SigningKey, signingMessage } from "./signing.js";
 export { KEY_HEADER, NONCE_HEADER, SIGNATURE_HEADER, TIMESTAMP_HEADER } from "./signing.js";
 export type { components, operations, paths } from "./generated/api.js";
-/** This package's version. */
-export declare const VERSION = "0.2.0";
+export { VERSION } from "./version.js";

package/dist/index.js

@@ -16,5 +16,4 @@ export { CLOSE_LIFETIME, CLOSE_REAUTHENTICATE, CLOSE_SLOW_CONSUMER, Channel, Cha
 export { Terminals, isUsable } from "./terminals.js";
 export { RequestSigner, SigningKey, signingMessage } from "./signing.js";
 export { KEY_HEADER, NONCE_HEADER, SIGNATURE_HEADER, TIMESTAMP_HEADER } from "./signing.js";
-/** This package's version. */
-export const VERSION = "0.2.0";
+export { VERSION } from "./version.js";

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

@@ -23,6 +23,7 @@
 // The upgrade is signed exactly as a REST request is, over `GET /v1/stream`.
 import WebSocket from "ws";
 import { AuthError, MfxError, MfxTransportError, errorFor } from "./errors.js";
+import { USER_AGENT } from "./version.js";
 /** The server says why it hung up. 4001 is the one reconnecting cannot fix. */
 export const CLOSE_REAUTHENTICATE = 4001;
 export const CLOSE_SLOW_CONSUMER = 4008;
@@ -207,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;
@@ -225,7 +228,10 @@ export class MfxStream {
     /** Opens the connection. {@link MfxClient.stream} does this for you. */
     async open() {
         const path = new URL(this.#url).pathname;
-        this.#connection = await this.#connect(this.#url, this.#client.signer.headersFor("GET", path));
+        this.#connection = await this.#connect(this.#url, {
+            ...this.#client.signer.headersFor("GET", path),
+            "User-Agent": USER_AGENT,
+        });
         return this;
     }
     /** Subscribe to one channel. Subscribing twice is not an error. */
@@ -254,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)
@@ -283,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)))
@@ -358,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 });
@@ -372,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

@@ -0,0 +1,4 @@
+/** This package's version. */
+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.2";

package/dist/version.js

@@ -0,0 +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.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.0",
+  "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",