Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

3.9 KB
Raw Blame
export type BookWsEvent = { type: string; [key: string]: unknown };

export interface BookSocketLike {
  onopen: ((event: Event) => void) | null;
  onmessage: ((event: MessageEvent<string>) => void) | null;
  onerror: ((event: Event) => void) | null;
  onclose: ((event: CloseEvent) => void) | null;
  send(data: string): void;
  close(): void;
}

export interface BookSocketOperationOptions {
  message: BookWsEvent;
  resultType: string;
  onEvent?: (event: BookWsEvent) => void;
  /** Maximum silence before a one-shot operation is considered stalled. */
  idleTimeoutMs?: number;
}

const DEFAULT_IDLE_TIMEOUT_MS = 5 * 60_000;

export class BookSocketOperationError extends Error {
  constructor(
    message: string,
    public readonly status?: number,
    public readonly code?: string,
    public readonly currentRevision?: number,
  ) {
    super(message);
    this.name = "BookSocketOperationError";
  }
}

function errorMessage(event: BookWsEvent): string {
  const detail = event.content ?? event.message ?? event.detail;
  return typeof detail === "string" && detail.trim()
    ? detail
    : "Book WebSocket operation failed";
}

export function runBookSocketOperation<T extends BookWsEvent = BookWsEvent>(
  createSocket: () => BookSocketLike,
  options: BookSocketOperationOptions,
): Promise<T> {
  return new Promise<T>((resolve, reject) => {
    const socket = createSocket();
    let settled = false;
    let idleTimer: ReturnType<typeof setTimeout> | undefined;

    const armIdleTimeout = (): void => {
      if (idleTimer) clearTimeout(idleTimer);
      const timeoutMs = options.idleTimeoutMs ?? DEFAULT_IDLE_TIMEOUT_MS;
      if (timeoutMs <= 0) return;
      idleTimer = setTimeout(() => {
        finish(
          () =>
            reject(
              new Error(
                `Book WebSocket operation timed out waiting for ${options.resultType}`,
              ),
            ),
          true,
        );
      }, timeoutMs);
    };

    const finish = (callback: () => void, closeSocket: boolean): void => {
      if (settled) return;
      settled = true;
      if (idleTimer) clearTimeout(idleTimer);
      if (closeSocket) {
        try {
          socket.close();
        } catch {
          // The operation result is authoritative even if cleanup fails.
        }
      }
      callback();
    };

    socket.onopen = () => {
      armIdleTimeout();
      try {
        socket.send(JSON.stringify(options.message));
      } catch (error) {
        finish(
          () =>
            reject(
              error instanceof Error
                ? error
                : new Error("Failed to send Book WebSocket operation"),
            ),
          true,
        );
      }
    };

    socket.onmessage = (message) => {
      let event: BookWsEvent;
      try {
        event = JSON.parse(message.data) as BookWsEvent;
      } catch {
        return;
      }

      armIdleTimeout();

      options.onEvent?.(event);

      if (event.type === "error") {
        finish(
          () =>
            reject(
              new BookSocketOperationError(
                errorMessage(event),
                typeof event.status === "number" ? event.status : undefined,
                typeof event.code === "string" ? event.code : undefined,
                typeof event.current_revision === "number"
                  ? event.current_revision
                  : undefined,
              ),
            ),
          true,
        );
        return;
      }

      if (event.type === options.resultType) {
        finish(() => resolve(event as T), true);
      }
    };

    socket.onerror = () => {
      finish(() => reject(new Error("Book WebSocket connection failed")), true);
    };

    socket.onclose = () => {
      finish(
        () =>
          reject(
            new Error(
              `Book WebSocket closed before ${options.resultType} was received`,
            ),
          ),
        false,
      );
    };

    armIdleTimeout();
  });
}