hyperframes/packages/studio/src/utils/domEditSaveQueue.ts

import { getStudioSaveErrorMessage, getStudioSaveStatusCode } from "./studioSaveDiagnostics";

interface DomEditSaveQueueOpenEvent {
  consecutiveFailures: number;
  errorMessage: string;
  statusCode: number | null;
}

interface DomEditSaveQueueOptions {
  failureThreshold?: number;
  onOpen?: (event: DomEditSaveQueueOpenEvent) => void;
  onReset?: () => void;
}

export interface DomEditSaveQueue {
  enqueue: (save: () => Promise<void>) => Promise<void>;
  waitForIdle: () => Promise<void>;
  reset: () => void;
  destroy: () => void;
}

const DEFAULT_FAILURE_THRESHOLD = 5;

export class DomEditSaveQueueOpenError extends Error {
  constructor() {
    super("Auto-save is paused. Dismiss the warning to retry DOM edits.");
    this.name = "DomEditSaveQueueOpenError";
  }
}

export function createDomEditSaveQueue(options: DomEditSaveQueueOptions = {}): DomEditSaveQueue {
  const failureThreshold = options.failureThreshold ?? DEFAULT_FAILURE_THRESHOLD;

  let tail = Promise.resolve();
  let consecutiveFailures = 0;
  let breakerOpen = false;

  const reset = (notify = true) => {
    const wasOpen = breakerOpen;
    consecutiveFailures = 0;
    breakerOpen = false;
    if (notify && wasOpen) options.onReset?.();
  };

  const open = (error: unknown) => {
    if (breakerOpen) return;
    breakerOpen = true;
    options.onOpen?.({
      consecutiveFailures,
      errorMessage: getStudioSaveErrorMessage(error),
      statusCode: getStudioSaveStatusCode(error) ?? null,
    });
  };

  const run = async (save: () => Promise<void>) => {
    try {
      await save();
      if (!breakerOpen) consecutiveFailures = 0;
    } catch (error) {
      consecutiveFailures += 1;
      if (consecutiveFailures >= failureThreshold) open(error);
      throw error;
    }
  };

  return {
    enqueue(save) {
      if (breakerOpen) return Promise.reject(new DomEditSaveQueueOpenError());
      const queued = tail.catch(() => undefined).then(() => run(save));
      tail = queued.then(
        () => undefined,
        () => undefined,
      );
      return queued;
    },

    async waitForIdle() {
      await tail.catch(() => undefined);
    },

    reset,

    destroy() {
      reset(false);
    },
  };
}