@truenas/api-client 9.0.4 → 9.0.6

package/README.md

@@ -258,6 +258,21 @@ version stays the same, so a different version needs a new client:
 client.connection.setEndpoint({ hostnames: ['10.0.0.5'], protocol: 'http:' });
 ```
 
+Middleware holds 20 calls per connection on current releases and refuses the
+next one, so a client that can put more than that in flight at once (an app
+loading a dashboard, say) should cap itself with `maxConcurrentCalls`. Calls
+beyond the cap wait, in order, for an answer to make room. Every frame counts,
+the client's own `core.ping` included:
+
+```typescript
+const client = await createTrueNasClient({ uuid, hostnames, enabled: true, maxConcurrentCalls: 20 });
+```
+
+Calls still waiting when a socket is lost are held until the session is
+authenticated again, since a new socket starts signed out. If the next person to
+sign in may not be the one who made those calls, end them first:
+`client.connection.refuseHeldCalls()` answers each with `ENOTAUTHENTICATED`.
+
 An `interceptor` sees the connection's traffic, for a debug panel or for
 mocking calls in a running app. `outgoing` gets every frame before it is
 written, including the client's own `core.set_options` and `core.ping`, and

package/dist/{chunk-PEOXWWBS.js → chunk-R4VP3HBB.js}

@@ -3175,6 +3175,157 @@ function getWebSocketError(code) {
       return "Network connection failed - Check IP address and connectivity";
   }
 }
+var CallLimiter = class {
+  constructor(limit, write) {
+    this.limit = limit;
+    this.write = write;
+    /**
+     * Each request awaiting an answer, with the handle `write` gave for it. That
+     * handle closes once the frame is on a socket: until then the connection is
+     * still holding it for one, and giving up on it takes it back.
+     */
+    this.inFlight = /* @__PURE__ */ new Map();
+    this.waiting = [];
+    /**
+     * Calls that were waiting when a socket was lost, kept apart from `waiting`
+     * until `release()`. A call sent after the loss, the sign-in among them, then
+     * never waits behind one: nothing would write it, and `release()` waits on it.
+     */
+    this.heldCalls = [];
+  }
+  /** Requests written or being written, and not answered yet. */
+  get inFlightCount() {
+    return this.inFlight.size;
+  }
+  /** Requests waiting for a place, held ones included. */
+  get waitingCount() {
+    return this.waiting.length + this.heldCalls.length;
+  }
+  /** Whether calls are being kept from a lost socket until `release()`. */
+  get held() {
+    return this.heldCalls.length > 0;
+  }
+  /**
+   * Sends `message` now if there is room, or queues it. Frames that are not
+   * requests pass straight through. Unsubscribing the returned handle takes
+   * the call back if it has not been written yet.
+   *
+   * New calls are not held back by a lost socket, only by the limit: the frames
+   * that sign a new socket in come through here, and the held calls are
+   * waiting on exactly those.
+   */
+  send(message) {
+    if (!isRequest(message)) {
+      return this.write(message);
+    }
+    const call = { id: message.id, message, handle: new Subscription() };
+    if (this.inFlight.size < this.limit) {
+      this.start(call);
+      return call.handle;
+    }
+    this.waiting.push(call);
+    call.handle.add(() => {
+      remove(this.waiting, call);
+      remove(this.heldCalls, call);
+    });
+    return call.handle;
+  }
+  /**
+   * Counts a request the connection wrote to a socket itself, such as its
+   * keepalive `core.ping`, or returns `false` without counting it when there is
+   * no room. A request written that way is not the limiter's to queue: the
+   * caller decides what not sending it means.
+   */
+  tryTrack(id) {
+    if (this.inFlight.size >= this.limit) {
+      return false;
+    }
+    this.inFlight.set(id, Subscription.EMPTY);
+    return true;
+  }
+  /** Frees the place of the request this frame answers, if it is one. */
+  received(message) {
+    if (message.id === void 0 || message.id === null || message.method) {
+      return;
+    }
+    this.finish(String(message.id));
+  }
+  /**
+   * What was written on the lost socket is lost with it, answers included, so
+   * those places are freed. A frame the connection has not written yet is still
+   * its to send on the next socket, so it stays counted. Calls still waiting are
+   * held until `release()`: the new socket starts signed out, and a call sent on
+   * it before the session is back is refused.
+   */
+  socketLost() {
+    this.inFlight.forEach((sending, id) => {
+      if (sending.closed) {
+        this.inFlight.delete(id);
+      }
+    });
+    this.heldCalls.push(...this.waiting.splice(0));
+  }
+  /**
+   * Lets held calls go out again, once the session they were made in is back.
+   * They were sent before anything still waiting, so they go first.
+   */
+  release() {
+    this.waiting.unshift(...this.heldCalls.splice(0));
+    this.startWaiting();
+  }
+  /**
+   * Takes back every call held from a lost socket, unsent, and returns their
+   * ids so the caller can answer them. Does nothing while nothing is held.
+   */
+  takeHeld() {
+    return this.heldCalls.splice(0).map(({ id }) => id);
+  }
+  // The three below call each other in a ring.
+  start({ id, message, handle }) {
+    this.inFlight.set(id, Subscription.EMPTY);
+    let sending;
+    try {
+      sending = this.write(message);
+    } catch (error) {
+      this.finish(id);
+      throw error;
+    }
+    if (!this.inFlight.has(id)) {
+      return;
+    }
+    this.inFlight.set(id, sending);
+    handle.add(() => {
+      const isWritten = sending.closed;
+      sending.unsubscribe();
+      if (!isWritten && this.inFlight.get(id) === sending) {
+        this.finish(id);
+      }
+    });
+  }
+  startWaiting() {
+    while (this.inFlight.size < this.limit) {
+      const next = this.waiting.shift();
+      if (!next) {
+        return;
+      }
+      this.start(next);
+    }
+  }
+  finish(id) {
+    if (this.inFlight.delete(id)) {
+      this.startWaiting();
+    }
+  }
+};
+function remove(calls, call) {
+  const index = calls.indexOf(call);
+  if (index >= 0) {
+    calls.splice(index, 1);
+  }
+}
+function isRequest(message) {
+  return message.id !== void 0 && message.id !== null && Boolean(message.method);
+}
 var TrueNasSocket = class {
   constructor(config) {
     this.config = config;
@@ -3203,7 +3354,7 @@ function socketScheme(protocol) {
 var tenSeconds = 10 * 1e3;
 var twentySeconds = 20 * 1e3;
 var TrueNasConnection = class {
-  constructor(initialEnabled, hostnames, systemUuid, websocketPath, systemName, retryDelay = tenSeconds, maxRetry = 3, logger = noopLogger, protocol = "https:", interceptor) {
+  constructor(initialEnabled, hostnames, systemUuid, websocketPath, systemName, retryDelay = tenSeconds, maxRetry = 3, logger = noopLogger, protocol = "https:", interceptor, maxConcurrentCalls) {
     this.systemUuid = systemUuid;
     this.websocketPath = websocketPath;
     this.systemName = systemName;
@@ -3211,6 +3362,7 @@ var TrueNasConnection = class {
     this.maxRetry = maxRetry;
     this.logger = logger;
     this.interceptor = interceptor;
+    this.maxConcurrentCalls = maxConcurrentCalls;
     // compatibility properties
     this.opened = new BehaviorSubject(false);
     this.closed = new Subject();
@@ -3374,16 +3526,39 @@ var TrueNasConnection = class {
         catchError(() => EMPTY)
       ))
     );
-    this.messages$ = interceptor?.injected$ ? merge(this.socketMessages$, interceptor.injected$.pipe(observeOn(asapScheduler), share())) : this.socketMessages$;
+    /** Answers given here, to calls ended without being sent. See `refuseHeldCalls()`. */
+    this.refusals$ = new Subject();
+    if (maxConcurrentCalls !== void 0 && !(Number.isInteger(maxConcurrentCalls) && maxConcurrentCalls > 0)) {
+      throw new Error(`maxConcurrentCalls must be a positive integer, got ${String(maxConcurrentCalls)}`);
+    }
+    this.limiter = maxConcurrentCalls === void 0 ? null : new CallLimiter(maxConcurrentCalls, (message) => this.writeToNextSocket(message));
+    this.messages$ = interceptor?.injected$ ? merge(this.socketMessages$, this.refusals$, interceptor.injected$.pipe(observeOn(asapScheduler), share())) : merge(this.socketMessages$, this.refusals$);
     this.endpoint$.next(resolveEndpoint(hostnames, protocol));
     this.ws$.pipe(
       switchMap((ws) => ws ? interval(twentySeconds).pipe(map(() => ws)) : EMPTY),
       takeUntil(this.closeConnection)
     ).subscribe((ws) => {
       const ping = createJsonRpcMessage("core.ping");
+      if (this.limiter && !this.limiter.tryTrack(ping.id ?? "")) {
+        this.logger.debug("Skipping core.ping: every concurrent call place is taken");
+        return;
+      }
       this.interceptor?.outgoing?.(ping);
       ws.next(ping);
     });
+    if (this.limiter) {
+      const limiter = this.limiter;
+      this.socketMessages$.pipe(takeUntil(this.closeConnection)).subscribe((message) => {
+        limiter.received(message);
+      });
+      let wasOpen = false;
+      this.opened$.pipe(takeUntil(this.closeConnection)).subscribe((isOpen) => {
+        if (wasOpen && !isOpen) {
+          limiter.socketLost();
+        }
+        wasOpen = isOpen;
+      });
+    }
     if (interceptor?.incoming) {
       const incoming = interceptor.incoming.bind(interceptor);
       this.messages$.pipe(takeUntil(this.closeConnection)).subscribe((message) => incoming(message));
@@ -3454,11 +3629,46 @@ var TrueNasConnection = class {
    * sends a message over the current websocket OR queues it to send once
    * the next websocket is opened. messages sent via `send` will not be lost until after
    * the next `closed$` emission.
+   *
+   * With `maxConcurrentCalls` set, a request beyond the limit waits for an
+   * answer to make room. Unsubscribing the returned handle takes back a frame
+   * not written yet, waiting or queued.
    */
   send(message) {
     if (this.interceptor?.outgoing?.(message) === false) {
       return Subscription.EMPTY;
     }
+    return this.limiter ? this.limiter.send(message) : this.writeToNextSocket(message);
+  }
+  /**
+   * Lets calls held from a lost socket go out again. The client calls this
+   * whenever the session is authenticated, so a consumer does not need to;
+   * a no-op without `maxConcurrentCalls`, or with nothing held.
+   *
+   * Calls waiting for a place when a socket is lost are held, not sent on the
+   * next one: a new socket starts signed out, so middleware would refuse them
+   * with `ENOTAUTHENTICATED`.
+   */
+  releaseHeldCalls() {
+    this.limiter?.release();
+  }
+  /**
+   * Ends every call held from a lost socket without sending it, answering each
+   * on `messages()` with the refusal middleware would have given it on a socket
+   * that is not signed in: `ENOTAUTHENTICATED`. Returns how many it ended.
+   *
+   * For an app whose next sign-in may be a different user than the one who made
+   * those calls, e.g. a password prompt after the session was lost. Call it
+   * before that sign-in; otherwise the calls go out once it succeeds. A no-op
+   * while nothing is held, so a healthy session's waiting calls are not touched.
+   */
+  refuseHeldCalls() {
+    const ids = this.limiter?.takeHeld() ?? [];
+    ids.forEach((id) => this.refusals$.next(notAuthenticatedRefusal(id)));
+    return ids.length;
+  }
+  /** Writes to the current socket, or to the next one once it opens. */
+  writeToNextSocket(message) {
     return this.ws$.pipe(
       filter((ws) => ws !== null),
       take(1)
@@ -3602,6 +3812,22 @@ var makeConnectionError = (message, hostname, closeCode, closeReason) => ({
 var isTerminalClose = (err) => err?.closeCode === policyViolationCloseCode;
 var resolveEndpoint = (hostnames, protocol) => Object.freeze({ hostnames: Object.freeze([...hostnames]), protocol });
 var sameEndpoint = (a, b) => a.protocol === b.protocol && a.hostnames.length === b.hostnames.length && a.hostnames.every((hostname, i) => hostname === b.hostnames[i]);
+var notAuthenticatedRefusal = (id) => ({
+  jsonrpc: "2.0",
+  id,
+  error: {
+    code: -32001,
+    message: "Method call error",
+    data: {
+      // `ErrnoMixin.ENOTAUTHENTICATED` in truenas_api_client.
+      error: 207,
+      errname: "ENOTAUTHENTICATED",
+      reason: "The session this call was made in ended before it could be sent.",
+      extra: null,
+      trace: null
+    }
+  }
+});
 var closedConnection = { state: "closed" };
 
 // src/client/truenas-api-client.ts
@@ -3619,6 +3845,11 @@ var TrueNasApiClient = class {
     this.authenticator = this.createAuthenticator();
     this.api = this.createApi();
     this.ops = this.createOperations();
+    this.authenticator.authenticated$.pipe(
+      distinctUntilChanged(),
+      filter(Boolean),
+      takeUntil(this.connection.closeConnection)
+    ).subscribe(() => this.connection.releaseHeldCalls());
   }
   /**
    * Get current connection status.
@@ -3657,7 +3888,8 @@ var TrueNasApiClient = class {
       this.reconnect.maxRetry,
       this.logger,
       this.protocol,
-      this.reconnect.interceptor
+      this.reconnect.interceptor,
+      this.reconnect.maxConcurrentCalls
     );
   }
   /**
@@ -4522,7 +4754,12 @@ function instantiateClientForVersion(version, opts, logger) {
     systemName,
     logger,
     opts.protocol,
-    { retryDelay: opts.retryDelay, maxRetry: opts.maxRetry, interceptor: opts.interceptor }
+    {
+      retryDelay: opts.retryDelay,
+      maxRetry: opts.maxRetry,
+      interceptor: opts.interceptor,
+      maxConcurrentCalls: opts.maxConcurrentCalls
+    }
   );
 }
 function errorMessageOrDefault(error, fallback) {
@@ -4542,5 +4779,5 @@ var UserRole = /* @__PURE__ */ ((UserRole2) => {
 })(UserRole || {});
 
 export { AppState, AuthError, AuthErrorCode, AuthResponseType, InvalidVersionResponseError, JobState, NoCompatibleVersionsError, SUPPORTED_API_VERSIONS, TrueNasApiClient, TrueNasApiClientV2510, TrueNasApiClientV27, TrueNasApiClientV28, TrueNasApiError, TrueNasAuthMechanism, TrueNasAuthenticator, TrueNasConnection, UserRole, VersionCompatibility, VersionDiscovery, VersionDiscoveryError, VersionDiscoveryNetworkError, VersionDiscoveryTimeoutError, VersionEndpointNotFoundError, VersionTooNewError, VersionTooOldError, clientClassFor, consoleLogger, createTrueNasClient, getApiErrorMessage, getCloseMessage, isJobFinished, noopLogger, parseApiVersion, policyViolationCloseCode, subscriptionName, v25_10_0_exports, v25_10_1_exports, v25_10_2_exports, v25_10_3_exports, v25_10_4_exports, v25_10_5_exports, v27_0_0_exports, v28_0_0_exports };
-//# sourceMappingURL=chunk-PEOXWWBS.js.map
-//# sourceMappingURL=chunk-PEOXWWBS.js.map
+//# sourceMappingURL=chunk-R4VP3HBB.js.map
+//# sourceMappingURL=chunk-R4VP3HBB.js.map