obsidian-dev-utils/dist/lib/esm/obsidian/Queue.mjs

This is the collection of useful functions that you can use for your Obsidian plugin development

/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin
*/

(function initEsm() {
  if (globalThis.process) {
    return;
  }

  const browserProcess = {
    browser: true,
    cwd() {
      return '/';
    },
    env: {},
    platform: 'android'
  };
  globalThis.process = browserProcess;
})();

import {
  abortSignalAny,
  abortSignalNever
} from "../AbortController.mjs";
import {
  addErrorHandler,
  invokeAsyncSafely
} from "../Async.mjs";
import { getStackTrace } from "../Error.mjs";
import { noop } from "../Function.mjs";
import { getObsidianDevUtilsState } from "./App.mjs";
import { runWithTimeoutNotice } from "./AsyncWithNotice.mjs";
import { t } from "./i18n/i18n.mjs";
import { invokeAsyncAndLog } from "./Logger.mjs";
function addToQueue(options) {
  const stackTrace = options.stackTrace ?? getStackTrace(1);
  invokeAsyncSafely(() => addToQueueAndWait(options), stackTrace);
}
async function addToQueueAndWait(options) {
  const abortSignal = options.abortSignal ?? abortSignalNever();
  abortSignal.throwIfAborted();
  const DEFAULT_TIMEOUT_IN_MILLISECONDS = 6e4;
  const timeoutInMilliseconds = options.timeoutInMilliseconds ?? DEFAULT_TIMEOUT_IN_MILLISECONDS;
  const stackTrace = options.stackTrace ?? getStackTrace(1);
  const operationName = options.operationName ?? "";
  const queue = getQueue(options.app).value;
  queue.items.push({
    abortSignal,
    operationFn: options.operationFn,
    operationName,
    shouldShowTimeoutNotice: options.shouldShowTimeoutNotice ?? true,
    stackTrace,
    timeoutInMilliseconds
  });
  queue.promise = queue.promise.then(() => processNextQueueItem(options.app));
  await queue.promise;
}
async function flushQueue(app) {
  await addToQueueAndWait({
    app,
    operationFn: noop,
    operationName: t(($) => $.obsidianDevUtils.queue.flushQueue)
  });
}
function getQueue(app) {
  return getObsidianDevUtilsState(app, "queue", { items: [], promise: Promise.resolve() });
}
async function processNextQueueItem(app) {
  const queue = getQueue(app).value;
  const item = queue.items[0];
  if (!item) {
    return;
  }
  await addErrorHandler(
    () => runWithTimeoutNotice({
      context: { queuedFn: item.operationFn },
      async operationFn(abortSignal) {
        await invokeAsyncAndLog(
          item.operationName || processNextQueueItem.name,
          item.operationFn,
          abortSignalAny(abortSignal, item.abortSignal),
          item.stackTrace
        );
      },
      operationName: item.operationName,
      shouldShowTimeoutNotice: item.shouldShowTimeoutNotice,
      stackTrace: item.stackTrace,
      timeoutInMilliseconds: item.timeoutInMilliseconds
    })
  );
  queue.items.shift();
}
export {
  addToQueue,
  addToQueueAndWait,
  flushQueue
};
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/obsidian/Queue.ts"],
  "sourcesContent": ["/**\n * @packageDocumentation\n *\n * Contains utility functions for enqueuing and processing functions in Obsidian.\n */\n\nimport type { App } from 'obsidian';\nimport type { Promisable } from 'type-fest';\n\nimport type { ValueWrapper } from './App.ts';\n\nimport {\n  abortSignalAny,\n  abortSignalNever\n} from '../AbortController.ts';\nimport {\n  addErrorHandler,\n  invokeAsyncSafely\n} from '../Async.ts';\nimport { getStackTrace } from '../Error.ts';\nimport { noop } from '../Function.ts';\nimport { getObsidianDevUtilsState } from './App.ts';\nimport { runWithTimeoutNotice } from './AsyncWithNotice.ts';\nimport { t } from './i18n/i18n.ts';\nimport { invokeAsyncAndLog } from './Logger.ts';\n\n/**\n * Options for the {@link addToQueueAndWait} function.\n */\nexport interface AddToQueueAndWaitOptions {\n  /**\n   * Optional abort signal.\n   */\n  abortSignal?: AbortSignal;\n\n  /**\n   * The Obsidian application instance.\n   */\n  app: App;\n\n  /**\n   * The function to add.\n   */\n  operationFn: (abortSignal: AbortSignal) => Promisable<void>;\n\n  /**\n   * Optional name of the operation.\n   */\n  operationName?: string;\n\n  /**\n   * Whether to show a timeout notice. Default is `true`.\n   */\n  shouldShowTimeoutNotice?: boolean;\n\n  /**\n   * Optional stack trace.\n   */\n  stackTrace?: string;\n\n  /**\n   * The timeout in milliseconds.\n   */\n  timeoutInMilliseconds?: number;\n}\n\n/**\n * Options for the {@link addToQueue} function.\n */\nexport interface AddToQueueOptions {\n  /**\n   * Optional abort signal.\n   */\n  abortSignal?: AbortSignal;\n\n  /**\n   * The Obsidian application instance.\n   */\n  app: App;\n\n  /**\n   * The function to add.\n   */\n  operationFn: (abortSignal: AbortSignal) => Promisable<void>;\n\n  /**\n   * Optional name of the operation.\n   */\n  operationName?: string;\n\n  /**\n   * Whether to show a timeout notice. Default is `true`.\n   */\n  shouldShowTimeoutNotice?: boolean;\n\n  /**\n   * Optional stack trace.\n   */\n  stackTrace?: string;\n\n  /**\n   * The timeout in milliseconds.\n   */\n  timeoutInMilliseconds?: number;\n}\n\ninterface Queue {\n  items: QueueItem[];\n  promise: Promise<void>;\n}\n\ninterface QueueItem {\n  abortSignal: AbortSignal;\n  operationFn(this: void, abortSignal: AbortSignal): Promisable<void>;\n  operationName: string;\n  shouldShowTimeoutNotice: boolean;\n  stackTrace: string;\n  timeoutInMilliseconds: number;\n}\n\n/**\n * Adds an asynchronous function to be executed after the previous function completes.\n *\n * @param options - The options for the function.\n */\nexport function addToQueue(options: AddToQueueOptions): void {\n  const stackTrace = options.stackTrace ?? getStackTrace(1);\n  invokeAsyncSafely(() => addToQueueAndWait(options), stackTrace);\n}\n\n/**\n * Adds an asynchronous function to be executed after the previous function completes and returns a {@link Promise} that resolves when the function completes.\n *\n * @param options - The options for the function.\n */\nexport async function addToQueueAndWait(options: AddToQueueAndWaitOptions): Promise<void> {\n  const abortSignal = options.abortSignal ?? abortSignalNever();\n  abortSignal.throwIfAborted();\n\n  const DEFAULT_TIMEOUT_IN_MILLISECONDS = 60000;\n  const timeoutInMilliseconds = options.timeoutInMilliseconds ?? DEFAULT_TIMEOUT_IN_MILLISECONDS;\n  const stackTrace = options.stackTrace ?? getStackTrace(1);\n  const operationName = options.operationName ?? '';\n  const queue = getQueue(options.app).value;\n  queue.items.push({\n    abortSignal,\n    operationFn: options.operationFn,\n    operationName,\n    shouldShowTimeoutNotice: options.shouldShowTimeoutNotice ?? true,\n    stackTrace,\n    timeoutInMilliseconds\n  });\n  queue.promise = queue.promise.then(() => processNextQueueItem(options.app));\n  await queue.promise;\n}\n\n/**\n * Flushes the queue;\n *\n * @param app - The Obsidian application instance.\n */\nexport async function flushQueue(app: App): Promise<void> {\n  await addToQueueAndWait({\n    app,\n    operationFn: noop,\n    operationName: t(($) => $.obsidianDevUtils.queue.flushQueue)\n  });\n}\n\nfunction getQueue(app: App): ValueWrapper<Queue> {\n  return getObsidianDevUtilsState(app, 'queue', { items: [], promise: Promise.resolve() });\n}\n\nasync function processNextQueueItem(app: App): Promise<void> {\n  const queue = getQueue(app).value;\n  const item = queue.items[0];\n  if (!item) {\n    return;\n  }\n\n  await addErrorHandler(() =>\n    runWithTimeoutNotice({\n      context: { queuedFn: item.operationFn },\n      async operationFn(abortSignal: AbortSignal): Promise<void> {\n        await invokeAsyncAndLog(\n          item.operationName || processNextQueueItem.name,\n          item.operationFn,\n          abortSignalAny(abortSignal, item.abortSignal),\n          item.stackTrace\n        );\n      },\n      operationName: item.operationName,\n      shouldShowTimeoutNotice: item.shouldShowTimeoutNotice,\n      stackTrace: item.stackTrace,\n      timeoutInMilliseconds: item.timeoutInMilliseconds\n    })\n  );\n  queue.items.shift();\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAWA;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP,SAAS,qBAAqB;AAC9B,SAAS,YAAY;AACrB,SAAS,gCAAgC;AACzC,SAAS,4BAA4B;AACrC,SAAS,SAAS;AAClB,SAAS,yBAAyB;AAqG3B,SAAS,WAAW,SAAkC;AAC3D,QAAM,aAAa,QAAQ,cAAc,cAAc,CAAC;AACxD,oBAAkB,MAAM,kBAAkB,OAAO,GAAG,UAAU;AAChE;AAOA,eAAsB,kBAAkB,SAAkD;AACxF,QAAM,cAAc,QAAQ,eAAe,iBAAiB;AAC5D,cAAY,eAAe;AAE3B,QAAM,kCAAkC;AACxC,QAAM,wBAAwB,QAAQ,yBAAyB;AAC/D,QAAM,aAAa,QAAQ,cAAc,cAAc,CAAC;AACxD,QAAM,gBAAgB,QAAQ,iBAAiB;AAC/C,QAAM,QAAQ,SAAS,QAAQ,GAAG,EAAE;AACpC,QAAM,MAAM,KAAK;AAAA,IACf;AAAA,IACA,aAAa,QAAQ;AAAA,IACrB;AAAA,IACA,yBAAyB,QAAQ,2BAA2B;AAAA,IAC5D;AAAA,IACA;AAAA,EACF,CAAC;AACD,QAAM,UAAU,MAAM,QAAQ,KAAK,MAAM,qBAAqB,QAAQ,GAAG,CAAC;AAC1E,QAAM,MAAM;AACd;AAOA,eAAsB,WAAW,KAAyB;AACxD,QAAM,kBAAkB;AAAA,IACtB;AAAA,IACA,aAAa;AAAA,IACb,eAAe,EAAE,CAAC,MAAM,EAAE,iBAAiB,MAAM,UAAU;AAAA,EAC7D,CAAC;AACH;AAEA,SAAS,SAAS,KAA+B;AAC/C,SAAO,yBAAyB,KAAK,SAAS,EAAE,OAAO,CAAC,GAAG,SAAS,QAAQ,QAAQ,EAAE,CAAC;AACzF;AAEA,eAAe,qBAAqB,KAAyB;AAC3D,QAAM,QAAQ,SAAS,GAAG,EAAE;AAC5B,QAAM,OAAO,MAAM,MAAM,CAAC;AAC1B,MAAI,CAAC,MAAM;AACT;AAAA,EACF;AAEA,QAAM;AAAA,IAAgB,MACpB,qBAAqB;AAAA,MACnB,SAAS,EAAE,UAAU,KAAK,YAAY;AAAA,MACtC,MAAM,YAAY,aAAyC;AACzD,cAAM;AAAA,UACJ,KAAK,iBAAiB,qBAAqB;AAAA,UAC3C,KAAK;AAAA,UACL,eAAe,aAAa,KAAK,WAAW;AAAA,UAC5C,KAAK;AAAA,QACP;AAAA,MACF;AAAA,MACA,eAAe,KAAK;AAAA,MACpB,yBAAyB,KAAK;AAAA,MAC9B,YAAY,KAAK;AAAA,MACjB,uBAAuB,KAAK;AAAA,IAC9B,CAAC;AAAA,EACH;AACA,QAAM,MAAM,MAAM;AACpB;",
  "names": []
}
