gloomberb 0.13.3 → 0.14.0

package/src/api-client/request.test.ts

@@ -20,19 +20,34 @@ describe("CloudApiRequestTransport connection reporting", () => {
     const dispose = registerGloomCloudConnectionSources(health);
     const transport = new CloudApiRequestTransport({
       connectionHealth: health,
-      fetchTransport: async () => responseWithBody(async () => JSON.stringify({ observations: [], info: null })),
+      fetchTransport: async () =>
+        responseWithBody(async () =>
+          JSON.stringify({ observations: [], info: null }),
+        ),
     });
 
-    await transport.request("/cloud/econ/series/VIXCLS?limit=120&sortOrder=desc");
+    await transport.request(
+      "/cloud/econ/series/VIXCLS?limit=120&sortOrder=desc",
+    );
 
-    expect(health.getSnapshot().sources.map((source) => ({
-      id: source.id,
-      status: source.status,
-      operation: source.lastOperation,
-    }))).toEqual([
-      { id: "gloom-cloud-http", status: "connected", operation: "GET /cloud/econ/series/VIXCLS" },
+    expect(
+      health.getSnapshot().sources.map((source) => ({
+        id: source.id,
+        status: source.status,
+        operation: source.lastOperation,
+      })),
+    ).toEqual([
+      {
+        id: "gloom-cloud-http",
+        status: "connected",
+        operation: "GET /cloud/econ/series/VIXCLS",
+      },
       { id: "gloom-cloud-socket", status: "idle", operation: null },
-      { id: "gloom-cloud-fred", status: "connected", operation: "GET /cloud/econ/series/VIXCLS" },
+      {
+        id: "gloom-cloud-fred",
+        status: "connected",
+        operation: "GET /cloud/econ/series/VIXCLS",
+      },
     ]);
 
     dispose();
@@ -51,9 +66,9 @@ describe("CloudApiRequestTransport market deadlines", () => {
       },
     });
 
-    await expect(transport.request("/market/quote?symbol=AAPL")).rejects.toThrow(
-      "Cloud market request timed out after 10ms",
-    );
+    await expect(
+      transport.request("/market/quote?symbol=AAPL"),
+    ).rejects.toThrow("Cloud market request timed out after 10ms");
     expect(signal?.aborted).toBe(true);
   });
 
@@ -67,9 +82,9 @@ describe("CloudApiRequestTransport market deadlines", () => {
       },
     });
 
-    await expect(transport.request("/market/history?symbol=AAPL")).rejects.toThrow(
-      "Cloud market request timed out after 10ms",
-    );
+    await expect(
+      transport.request("/market/history?symbol=AAPL"),
+    ).rejects.toThrow("Cloud market request timed out after 10ms");
     expect(signal?.aborted).toBe(true);
   });
 
@@ -85,9 +100,11 @@ describe("CloudApiRequestTransport market deadlines", () => {
       },
     });
 
-    await expect(transport.request("/market/quote?symbol=AAPL", {
-      signal: controller.signal,
-    })).rejects.toThrow("cancelled by caller");
+    await expect(
+      transport.request("/market/quote?symbol=AAPL", {
+        signal: controller.signal,
+      }),
+    ).rejects.toThrow("cancelled by caller");
     expect(fetchCalls).toBe(0);
   });
 });

package/src/api-client/request.ts

@@ -1,6 +1,10 @@
-import { httpFetch } from "../utils/http-transport";
+import { httpFetch, isHttpFetchStreaming } from "../utils/http-transport";
 import { withDeadline } from "../utils/async-deadline";
-import { ApiRequestError, parseApiErrorMessage } from "./errors";
+import {
+  ApiRequestError,
+  parseApiErrorMessage,
+  parseRetryAfterMs,
+} from "./errors";
 import {
   connectionHealth,
   GLOOM_CLOUD_FRED_CONNECTION_ID,
@@ -10,23 +14,67 @@ import {
 
 const DEFAULT_API_URL = "https://api.gloom.sh";
 const DEFAULT_MARKET_REQUEST_TIMEOUT_MS = 10_000;
-const SESSION_COOKIE_NAMES = ["__Secure-gloomberb.session_token", "gloomberb.session_token"] as const;
+/** Local status for "this runtime cannot stream", never returned by the server. */
+export const STREAMING_UNSUPPORTED_STATUS = 0;
+const SESSION_COOKIE_NAMES = [
+  "__Secure-gloomberb.session_token",
+  "gloomberb.session_token",
+] as const;
 
 type CloudApiResponse = Pick<Response, "ok" | "status" | "headers" | "text">;
-type CloudApiFetchTransport = (url: string, init?: RequestInit) => Promise<CloudApiResponse>;
+type CloudApiFetchTransport = (
+  url: string,
+  init?: RequestInit,
+) => Promise<CloudApiResponse>;
+type CloudApiStreamFetch = (
+  url: string,
+  init?: RequestInit,
+) => Promise<Response>;
 type SessionCookieName = (typeof SESSION_COOKIE_NAMES)[number];
 
+export interface CloudApiFetchTransportOptions {
+  /**
+   * Whether the transport resolves once headers arrive and exposes a live
+   * `response.body`. The desktop transport proxies over RPC and returns the
+   * whole payload as a string, so it must stay false: a caller that waits for
+   * server-sent events on it would never see a first token.
+   */
+  streaming?: boolean;
+}
+
 let cloudApiFetchTransport: CloudApiFetchTransport = httpFetch;
+let cloudApiTransportInstalled = false;
+let cloudApiFetchStreaming = true;
 
-export function setCloudApiFetchTransport(transport: CloudApiFetchTransport | null): void {
+export function setCloudApiFetchTransport(
+  transport: CloudApiFetchTransport | null,
+  options: CloudApiFetchTransportOptions = {},
+): void {
   cloudApiFetchTransport = transport ?? httpFetch;
+  cloudApiTransportInstalled = !!transport;
+  cloudApiFetchStreaming = transport ? (options.streaming ?? false) : true;
+}
+
+/**
+ * The fetch to use for a response that must be read while it arrives, or null
+ * when the installed transport buffers whole responses.
+ */
+export function getCloudApiStreamFetch(): CloudApiStreamFetch | null {
+  if (cloudApiTransportInstalled) {
+    // A transport that declares streaming returns a real Response.
+    return cloudApiFetchStreaming
+      ? (cloudApiFetchTransport as CloudApiStreamFetch)
+      : null;
+  }
+  return isHttpFetchStreaming() ? httpFetch : null;
 }
 
 declare const __GLOOMBERB_API_URL__: string | undefined;
 
 export function getCloudApiBaseUrl(): string {
   // Browser bundles have no `process`; the build replaces this with a literal.
-  const bundled = typeof __GLOOMBERB_API_URL__ === "string" ? __GLOOMBERB_API_URL__ : "";
+  const bundled =
+    typeof __GLOOMBERB_API_URL__ === "string" ? __GLOOMBERB_API_URL__ : "";
   if (bundled) {
     return typeof location !== "undefined" && bundled === location.origin
       ? `${bundled}/api`
@@ -40,7 +88,10 @@ export function getCloudApiBaseUrl(): string {
 
 function throwIfRequestAborted(signal: AbortSignal | null | undefined): void {
   if (!signal?.aborted) return;
-  throw signal.reason ?? new DOMException("The operation was aborted.", "AbortError");
+  throw (
+    signal.reason ??
+    new DOMException("The operation was aborted.", "AbortError")
+  );
 }
 
 export class CloudApiRequestTransport {
@@ -54,13 +105,16 @@ export class CloudApiRequestTransport {
 
   readonly baseUrl = getCloudApiBaseUrl();
 
-  constructor(options: {
-    fetchTransport?: CloudApiFetchTransport;
-    marketRequestTimeoutMs?: number;
-    connectionHealth?: ConnectionHealthRegistry;
-  } = {}) {
+  constructor(
+    options: {
+      fetchTransport?: CloudApiFetchTransport;
+      marketRequestTimeoutMs?: number;
+      connectionHealth?: ConnectionHealthRegistry;
+    } = {},
+  ) {
     this.fetchTransport = options.fetchTransport ?? null;
-    this.marketRequestTimeoutMs = options.marketRequestTimeoutMs ?? DEFAULT_MARKET_REQUEST_TIMEOUT_MS;
+    this.marketRequestTimeoutMs =
+      options.marketRequestTimeoutMs ?? DEFAULT_MARKET_REQUEST_TIMEOUT_MS;
     this.connectionHealth = options.connectionHealth ?? connectionHealth;
   }
 
@@ -104,9 +158,63 @@ export class CloudApiRequestTransport {
     return true;
   }
 
-  async request<T>(path: string, options?: RequestInit): Promise<T> {
+  /** False when this transport buffers whole responses, e.g. the desktop view. */
+  isStreamingSupported(): boolean {
+    return !this.fetchTransport && !!getCloudApiStreamFetch();
+  }
+
+  /**
+   * Opens a response that the caller reads incrementally. Unlike `request`,
+   * nothing is buffered or JSON-parsed here, so the body stays a live stream.
+   */
+  async openStream(path: string, options: RequestInit = {}): Promise<Response> {
+    throwIfRequestAborted(options.signal);
+    const streamFetch = this.fetchTransport ? null : getCloudApiStreamFetch();
+    if (!streamFetch) {
+      throw new ApiRequestError(
+        "This client cannot read streaming responses.",
+        STREAMING_UNSUPPORTED_STATUS,
+      );
+    }
+    const headers = new Headers(options.headers);
+    if (
+      !headers.has("Content-Type") &&
+      options.method &&
+      options.method !== "GET"
+    ) {
+      headers.set("Content-Type", "application/json");
+    }
+    if (!headers.has("Accept")) headers.set("Accept", "text/event-stream");
+    this.setSessionCookieHeader(headers);
+    headers.set("Origin", this.baseUrl);
+
+    const operation = `${options.method ?? "GET"} ${path.split("?")[0]}`;
+    return this.connectionHealth.track(
+      GLOOM_CLOUD_HTTP_CONNECTION_ID,
+      operation,
+      async () => {
+        const response = await streamFetch(`${this.baseUrl}${path}`, {
+          ...options,
+          headers,
+          credentials: "include",
+        });
+        throwIfRequestAborted(options.signal);
+        if (!response.ok) {
+          const text = await response.text().catch(() => "");
+          throw new ApiRequestError(
+            parseApiErrorMessage(text),
+            response.status,
+            parseRetryAfterMs(response.headers.get("Retry-After")),
+          );
+        }
+        return response;
+      },
+    );
+  }
+
+  async request<T>(path: string, options?: RequestInit, canApplySession: () => boolean = () => true): Promise<T> {
     if (!path.startsWith("/market/")) {
-      return this.performRequest<T>(path, options);
+      return this.performRequest<T>(path, options, canApplySession);
     }
 
     const controller = new AbortController();
@@ -122,7 +230,7 @@ export class CloudApiRequestTransport {
       const request = this.performRequest<T>(path, {
         ...options,
         signal: controller.signal,
-      });
+      }, canApplySession);
       return await withDeadline(
         request,
         this.marketRequestTimeoutMs,
@@ -134,10 +242,18 @@ export class CloudApiRequestTransport {
     }
   }
 
-  private async performRequest<T>(path: string, options?: RequestInit): Promise<T> {
+  private async performRequest<T>(
+    path: string,
+    options: RequestInit | undefined,
+    canApplySession: () => boolean,
+  ): Promise<T> {
     throwIfRequestAborted(options?.signal);
     const headers = new Headers(options?.headers);
-    if (!headers.has("Content-Type") && options?.method && options.method !== "GET") {
+    if (
+      !headers.has("Content-Type") &&
+      options?.method &&
+      options.method !== "GET"
+    ) {
       headers.set("Content-Type", "application/json");
     }
     this.setSessionCookieHeader(headers);
@@ -146,26 +262,34 @@ export class CloudApiRequestTransport {
 
     const operation = `${options?.method ?? "GET"} ${path.split("?")[0]}`;
     const request = async () => {
-      const res = await (this.fetchTransport ?? cloudApiFetchTransport)(`${this.baseUrl}${path}`, {
-        ...options,
-        headers,
-        credentials: "include",
-      });
+      const res = await (this.fetchTransport ?? cloudApiFetchTransport)(
+        `${this.baseUrl}${path}`,
+        {
+          ...options,
+          headers,
+          credentials: "include",
+        },
+      );
       throwIfRequestAborted(options?.signal);
-      if (this.sessionToken === sessionTokenAtRequestStart) {
-        this.extractSessionCookie(res);
-      }
+      const ownsCredential = canApplySession() && this.sessionToken === sessionTokenAtRequestStart;
+      if (ownsCredential) this.extractSessionCookie(res);
+      const sessionTokenAfterHeaders = this.sessionToken;
       const text = await res.text();
       throwIfRequestAborted(options?.signal);
 
       if (!res.ok) {
         const msg = parseApiErrorMessage(text);
-        throw new ApiRequestError(msg, res.status);
+        throw new ApiRequestError(
+          msg,
+          res.status,
+          parseRetryAfterMs(res.headers.get("Retry-After")),
+        );
       }
 
       if (!text) return undefined as T;
       const parsed = JSON.parse(text) as T & { token?: string };
-      if (typeof parsed?.token === "string" && parsed.token.length > 0) {
+      if (ownsCredential && canApplySession() && this.sessionToken === sessionTokenAfterHeaders
+        && typeof parsed?.token === "string" && parsed.token.length > 0) {
         this.websocketToken = parsed.token;
       }
       return parsed as T;
@@ -173,9 +297,14 @@ export class CloudApiRequestTransport {
     return this.connectionHealth.track(
       GLOOM_CLOUD_HTTP_CONNECTION_ID,
       operation,
-      () => path.startsWith("/cloud/econ/series/")
-        ? this.connectionHealth.track(GLOOM_CLOUD_FRED_CONNECTION_ID, operation, request)
-        : request(),
+      () =>
+        path.startsWith("/cloud/econ/series/")
+          ? this.connectionHealth.track(
+              GLOOM_CLOUD_FRED_CONNECTION_ID,
+              operation,
+              request,
+            )
+          : request(),
     );
   }
 
@@ -187,7 +316,10 @@ export class CloudApiRequestTransport {
     }
     for (const cookie of setCookie) {
       for (const cookieName of SESSION_COOKIE_NAMES) {
-        const escapedCookieName = cookieName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+        const escapedCookieName = cookieName.replace(
+          /[.*+?^${}()|[\]\\]/g,
+          "\\$&",
+        );
         const match = cookie.match(new RegExp(`${escapedCookieName}=([^;]+)`));
         if (!match) continue;
         this.sessionToken = match[1] ?? null;
@@ -199,8 +331,12 @@ export class CloudApiRequestTransport {
 
   private buildSessionCookieHeader(): string | null {
     if (!this.sessionToken) return null;
-    const cookieNames = this.sessionCookieName ? [this.sessionCookieName] : SESSION_COOKIE_NAMES;
-    return cookieNames.map((cookieName) => `${cookieName}=${this.sessionToken}`).join("; ");
+    const cookieNames = this.sessionCookieName
+      ? [this.sessionCookieName]
+      : SESSION_COOKIE_NAMES;
+    return cookieNames
+      .map((cookieName) => `${cookieName}=${this.sessionToken}`)
+      .join("; ");
   }
 
   private setSessionCookieHeader(headers: Headers): void {