@dxos/async 0.8.3 → 0.8.4-main.1068cf700f

package/package.json

@@ -1,21 +1,25 @@
 {
   "name": "@dxos/async",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1068cf700f",
   "description": "Async utilities.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": true,
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
         "require": "./dist/lib/node/index.cjs",
         "default": "./dist/lib/node-esm/index.mjs"
-      },
-      "types": "./dist/types/src/index.d.ts"
+      }
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -29,12 +33,12 @@
   "dependencies": {
     "zen-observable": "^0.10.0",
     "zen-push": "^0.3.1",
-    "@dxos/debug": "0.8.3",
-    "@dxos/context": "0.8.3",
-    "@dxos/invariant": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/util": "0.8.3",
-    "@dxos/node-std": "0.8.3"
+    "@dxos/context": "0.8.4-main.1068cf700f",
+    "@dxos/invariant": "0.8.4-main.1068cf700f",
+    "@dxos/log": "0.8.4-main.1068cf700f",
+    "@dxos/util": "0.8.4-main.1068cf700f",
+    "@dxos/node-std": "0.8.4-main.1068cf700f",
+    "@dxos/debug": "0.8.4-main.1068cf700f"
   },
   "devDependencies": {
     "@types/zen-observable": "^0.8.3"

package/src/callback.ts

@@ -2,12 +2,12 @@
 // Copyright 2020 DXOS.org
 //
 
+export type Awaited<T> = T extends Promise<infer U> ? U : T;
+
 /**
  * Helper to convert a callback based API into a promise based API.
  */
-export const createPromiseFromCallback = <T = void>(
-  run: (cb: (error?: Error, value?: T) => void) => void,
-): Promise<T> =>
+export const promiseFromCallback = <T = void>(run: (cb: (error?: Error, value?: T) => void) => void): Promise<T> =>
   new Promise((resolve, reject) => {
     run((error, value) => {
       if (error) {

package/src/chain.ts

@@ -7,7 +7,7 @@ type Transform = (...args: any) => Promise<any>;
 /**
  * Async reducer iteratively applies functions to the given array of elements.
  */
-export const asyncChain =
+export const chain =
   <T>(chain: Transform[]) =>
   async (elements: Promise<T[]>) => {
     let result = await elements;

package/src/cleanup.ts

@@ -37,22 +37,23 @@ type EventMap<T> = T extends Window
 /**
  * Add the event listener and return a cleanup function.
  * Can be used in effect hooks in conjunction with `combine`.
+ * @deprecated use bind-event-listener
  */
-export function addEventListener<T extends EventTarget, K extends keyof EventMap<T>>(
+export const addEventListener = <T extends EventTarget, K extends keyof EventMap<T>>(
   target: T,
   type: K,
   listener: (this: T, ev: EventMap<T>[K]) => any,
   options?: boolean | AddEventListenerOptions,
-): CleanupFn {
+): CleanupFn => {
   target.addEventListener(type as string, listener as EventListener, options);
   return () => target.removeEventListener(type as string, listener as EventListener, options);
-}
+};
 
 export class SubscriptionList {
   private readonly _cleanups: CleanupFn[] = [];
 
-  add(cb: CleanupFn): this {
-    this._cleanups.push(cb);
+  add(...cb: CleanupFn[]): this {
+    this._cleanups.push(...cb);
     return this;
   }
 

package/src/debounce.test.ts

@@ -0,0 +1,115 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+import { describe, expect, test } from 'vitest';
+
+import { debounce, throttle } from './debounce';
+import { sleep } from './timeout';
+
+describe('throttle', () => {
+  test('throttles function calls', async () => {
+    let count = 0;
+    const fn = throttle(() => count++, 100);
+
+    // First call should execute immediately.
+    fn();
+    expect(count).toBe(1);
+
+    // Second call within throttle window should not execute.
+    fn();
+    expect(count).toBe(1);
+
+    // Wait for throttle window to pass.
+    await sleep(150);
+
+    // Next call should execute.
+    fn();
+    expect(count).toBe(2);
+  });
+
+  test('passes arguments to throttled function', async () => {
+    let lastArgs: any[] = [];
+    const fn = throttle((...args: any[]) => {
+      lastArgs = args;
+    }, 100);
+
+    fn('test', 123);
+    expect(lastArgs).toEqual(['test', 123]);
+
+    // Call with different args within throttle window.
+    fn('different', 456);
+    expect(lastArgs).toEqual(['test', 123]); // Should not update.
+
+    await sleep(150);
+    fn('new', 789);
+    expect(lastArgs).toEqual(['new', 789]);
+  });
+
+  test('handles multiple rapid calls', async () => {
+    let count = 0;
+    const fn = throttle(() => count++, 100);
+
+    // Make multiple rapid calls.
+    for (let i = 0; i < 5; i++) {
+      fn();
+    }
+    expect(count).toBe(1); // Only first call should execute.
+
+    await sleep(150);
+    expect(count).toBe(1); // Still only one execution.
+
+    fn();
+    expect(count).toBe(2); // Next call after wait should execute.
+  });
+});
+
+describe('debounce', () => {
+  test('debounces function calls', async () => {
+    let count = 0;
+    const fn = debounce(() => count++, 100);
+
+    // First call should not execute immediately.
+    fn();
+    expect(count).toBe(0);
+
+    // Second call should reset the timer.
+    fn();
+    expect(count).toBe(0);
+
+    // Wait for debounce window to pass.
+    await sleep(150);
+    expect(count).toBe(1); // Only the last call should execute.
+  });
+
+  test('passes arguments to debounced function', async () => {
+    let lastArgs: any[] = [];
+    const fn = debounce((...args: any[]) => {
+      lastArgs = args;
+    }, 100);
+
+    fn('test', 123);
+    expect(lastArgs).toEqual([]); // Should not execute immediately.
+
+    // Call with different args.
+    fn('different', 456);
+    expect(lastArgs).toEqual([]); // Should not execute immediately.
+
+    await sleep(150);
+    expect(lastArgs).toEqual(['different', 456]); // Should execute with last args.
+  });
+
+  test('handles multiple rapid calls', async () => {
+    let count = 0;
+    const fn = debounce(() => count++, 100);
+
+    // Make multiple rapid calls.
+    for (let i = 0; i < 5; i++) {
+      fn();
+    }
+    expect(count).toBe(0); // Should not execute immediately.
+
+    await sleep(150);
+    expect(count).toBe(1); // Should execute only once after wait.
+  });
+});

package/src/debounce.ts

@@ -2,13 +2,97 @@
 // Copyright 2023 DXOS.org
 //
 
+type Callback = (...args: any[]) => void;
+
+/**
+ * Delay callback execution by a specified time.
+ * Unlike debounce, subsequent calls during the delay period are ignored.
+ *
+ * @param cb Callback to invoke.
+ * @param delay Time to wait before invoking the callback.
+ * @returns A new function that schedules the callback once and ignores subsequent calls until executed.
+ */
+export const delay = <CB extends Callback>(cb: CB, delay = 100): CB => {
+  let pending = false;
+  return ((...args: any[]) => {
+    if (pending) {
+      return;
+    }
+
+    pending = true;
+    setTimeout(() => {
+      try {
+        cb(...args);
+      } finally {
+        pending = false;
+      }
+    }, delay);
+  }) as CB;
+};
+
 /**
  * Debounce callback.
+ *
+ * @param cb Callback to invoke.
+ * @param delay Time window to wait before allowing calls.
+ * @returns A new function that wraps the callback and ensures that the callback is only invoked after the time window has passed and no new calls have been made.
  */
-export const debounce = (cb: (...args: any[]) => void, wait = 100): ((...args: any[]) => void) => {
+export const debounce = <CB extends Callback>(cb: CB, delay = 100): CB => {
   let t: ReturnType<typeof setTimeout>;
-  return (...args: any[]) => {
+  return ((...args: any[]) => {
     clearTimeout(t);
-    t = setTimeout(() => cb(...args), wait);
-  };
+    t = setTimeout(() => cb(...args), delay);
+  }) as CB;
+};
+
+/**
+ * Throttle callback.
+ *
+ * @param cb Callback to invoke.
+ * @param delay Time window to allow calls in.
+ * @returns A new function that wraps the callback and prevents multiple invocations within the time window.
+ */
+export const throttle = <CB extends Callback>(cb: CB, delay = 100): CB => {
+  let lastCall = 0;
+  return ((...args: any[]) => {
+    const now = Date.now();
+    if (now - lastCall >= delay) {
+      cb(...args);
+      lastCall = now;
+    }
+  }) as CB;
+};
+
+/**
+ * Debounce and throttle callback.
+ * Executes immediately on the first call (throttle), prevents calls during the throttle window,
+ * and ensures a final call happens after activity stops (debounce).
+ *
+ * @param cb Callback to invoke.
+ * @param delay Time window for both throttle and debounce.
+ * @returns A new function that combines throttle and debounce behavior.
+ */
+export const debounceAndThrottle = <CB extends Callback>(cb: CB, delay = 100): CB => {
+  let timeout: ReturnType<typeof setTimeout>;
+  let lastCall = 0;
+
+  return ((...args: any[]) => {
+    const now = Date.now();
+    const delta = now - lastCall;
+
+    // Clear any pending debounced call.
+    clearTimeout(timeout);
+
+    // Throttle: execute immediately if enough time has passed.
+    if (delta >= delay) {
+      cb(...args);
+      lastCall = now;
+    } else {
+      // Debounce: schedule to execute after the remaining time.
+      timeout = setTimeout(() => {
+        cb(...args);
+        lastCall = Date.now();
+      }, delay - delta);
+    }
+  }) as CB;
 };

package/src/event-emitter.test.ts

@@ -3,11 +3,12 @@
 //
 
 import { EventEmitter } from 'node:events';
+
 import { describe, expect, test } from 'vitest';
 
 import { onEvent, waitForEvent } from './event-emitter';
-import { latch } from './latch';
 import { asyncTimeout } from './timeout';
+import { latch } from './trigger';
 
 describe('event-emitter', () => {
   test('onEvent', async () => {

package/src/events.test.ts

@@ -22,7 +22,7 @@ describe('Event', () => {
       pureCount++;
     });
 
-    const debounced = event.debounce(80);
+    const debounced = event.debounce(200);
     debounced.on(() => {
       debounceCount++;
     });

package/src/index.ts

@@ -9,13 +9,11 @@ export * from './debounce';
 export * from './errors';
 export * from './event-emitter';
 export * from './events';
-export * from './latch';
 export * from './mutex';
 export * from './observable';
 export * from './observable-value';
 export * from './persistent-lifecycle';
 export * from './push-iterable';
-export * from './sink';
 export * from './stream-to-array';
 export * from './task-scheduling';
 export * from './test-stream';
@@ -24,6 +22,4 @@ export * from './timeout';
 export * from './timer';
 export * from './track-leaks';
 export * from './trigger';
-export * from './types';
-export * from './until';
 export * from './update-scheduler';

package/src/observable-value.test.ts

@@ -5,12 +5,12 @@
 import { describe, expect, test } from 'vitest';
 
 import { type AsyncEvents, TimeoutError } from './errors';
-import { latch } from './latch';
 import {
   type CancellableObservable,
   type CancellableObservableEvents,
   CancellableObservableProvider,
 } from './observable-value';
+import { latch } from './trigger';
 
 interface ConnectionEvents extends AsyncEvents, CancellableObservableEvents {
   onConnected(connectionId: string): void;

package/src/persistent-lifecycle.test.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import { describe, expect, test, onTestFinished } from 'vitest';
+import { describe, expect, onTestFinished, test } from 'vitest';
 
 import { log } from '@dxos/log';
 

package/src/persistent-lifecycle.ts

@@ -13,7 +13,7 @@ import { sleep } from './timeout';
 const INIT_RESTART_DELAY = 100;
 const DEFAULT_MAX_RESTART_DELAY = 5000;
 
-export type PersistentLifecycleParams<T> = {
+export type PersistentLifecycleProps<T> = {
   /**
    * Create connection.
    * If promise resolves successfully, connection is considered established.
@@ -51,7 +51,7 @@ export class PersistentLifecycle<T> extends Resource {
   private _restartTask?: DeferredTask = undefined;
   private _restartAfter = 0;
 
-  constructor({ start, stop, onRestart, maxRestartDelay = DEFAULT_MAX_RESTART_DELAY }: PersistentLifecycleParams<T>) {
+  constructor({ start, stop, onRestart, maxRestartDelay = DEFAULT_MAX_RESTART_DELAY }: PersistentLifecycleProps<T>) {
     super();
     this._start = start;
     this._stop = stop;

package/src/task-scheduling.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { ContextDisposedError, type Context } from '@dxos/context';
+import { Context, ContextDisposedError } from '@dxos/context';
 import { StackTrace } from '@dxos/debug';
 import { type MaybePromise } from '@dxos/util';
 
@@ -77,6 +77,100 @@ export class DeferredTask {
   }
 }
 
+// TODO(dmaretskyi): Protyping this an alternative API to DeferredTask.
+export class AsyncTask {
+  #callback: () => Promise<void>;
+  #ctx?: Context = undefined;
+
+  #scheduled = false;
+  #currentTask: Promise<void> | null = null; // Can't be rejected.
+  #nextTask = new Trigger();
+
+  constructor(callback: () => Promise<void>) {
+    this.#callback = callback;
+  }
+
+  get scheduled() {
+    return this.#scheduled;
+  }
+
+  /**
+   * Context of the resource that owns the task.
+   * When the context is disposed, the task is cancelled and cannot be scheduled again.
+   */
+  open(): void {
+    this.#ctx = new Context();
+  }
+
+  /**
+   * Closes the task and waits for it to finish if it is running.
+   */
+  async close(): Promise<void> {
+    await this.#ctx?.dispose();
+    await this.join();
+    this.#ctx = undefined;
+  }
+
+  [Symbol.asyncDispose](): Promise<void> {
+    return this.close();
+  }
+
+  /**
+   * Schedule the task to run asynchronously.
+   */
+  // TODO(dmaretskyi): Add scheduleAt. Where the earlier time will override the later one.
+  schedule(): void {
+    if (!this.#ctx || this.#ctx.disposed) {
+      throw new Error('AsyncTask not open');
+    }
+
+    if (this.#scheduled) {
+      return; // Already scheduled.
+    }
+
+    scheduleTask(this.#ctx, async () => {
+      // The previous task might still be running, so we need to wait for it to finish.
+      await this.#currentTask; // Can't be rejected.
+
+      if (!this.#ctx || this.#ctx.disposed) {
+        return;
+      }
+
+      // Reset the flag. New tasks can now be scheduled. They would wait for the callback to finish.
+      this.#scheduled = false;
+      const completionTrigger = this.#nextTask;
+      this.#nextTask = new Trigger(); // Re-create the trigger as opposed to resetting it since there might be listeners waiting for it.
+
+      // Store the promise so that new tasks could wait for this one to finish.
+      this.#currentTask = runInContextAsync(this.#ctx, () => this.#callback()).then(() => {
+        completionTrigger.wake();
+      });
+    });
+
+    this.#scheduled = true;
+  }
+
+  /**
+   * Schedule the task to run and wait for it to finish.
+   */
+  async runBlocking(): Promise<void> {
+    if (this.#ctx?.disposed) {
+      throw new ContextDisposedError();
+    }
+
+    this.schedule();
+    await this.#nextTask.wait();
+  }
+
+  /**
+   * Waits for the current task to finish if it is running.
+   * Does not schedule a new task.
+   */
+  async join(): Promise<void> {
+    await this.#currentTask;
+  }
+}
+
 export const runInContext = (ctx: Context, fn: () => void) => {
   try {
     fn();

package/src/testing.test.ts

@@ -6,7 +6,8 @@ import { describe, expect, test } from 'vitest';
 
 import { expectToThrow, raise } from '@dxos/debug';
 
-import { waitForCondition } from './testing';
+import { until, waitForCondition } from './testing';
+import { sleep } from './timeout';
 
 describe('waitForCondition', () => {
   test('succeeds', async () => {
@@ -27,3 +28,42 @@ describe('waitForCondition', () => {
     ).rejects.toThrow('test');
   });
 });
+
+describe('until', () => {
+  test('success', async () => {
+    const value = await until<number>(async (resolve) => {
+      await sleep(100);
+      resolve(100);
+      return 1;
+    });
+
+    expect(value).to.equal(100);
+  });
+
+  test('error', async () => {
+    await expect(async () => {
+      await until(async (resolve, reject) => {
+        await sleep(100);
+        reject(new Error());
+      });
+    }).rejects.toThrowError();
+  });
+
+  test('catch', async () => {
+    await expect(async () => {
+      await until(async () => {
+        await sleep(100);
+        throw new Error();
+      });
+    }).rejects.toThrowError();
+  });
+
+  test('timeout', async () => {
+    await expect(async () => {
+      await until(async (resolve) => {
+        await sleep(500);
+        resolve();
+      }, 100); // Timeout before complete.
+    }).rejects.toThrowError();
+  });
+});

package/src/testing.ts

@@ -54,3 +54,56 @@ export const waitForCondition = <FunctionType extends (...args: any) => any>({
 
   return trigger.wait({ timeout });
 };
+
+export type UntilCallback<T> = (resolve: (value: T) => void, reject: (error: Error) => void) => Promise<T> | void;
+
+/**
+ * Awaits promise.
+ */
+export const until = <T = void>(cb: UntilCallback<T>, timeout?: number): Promise<T> => {
+  return new Promise((resolve, reject) => {
+    const t =
+      timeout &&
+      setTimeout(() => {
+        reject(new Error(`Timeout after ${t}ms`));
+      }, timeout);
+
+    setTimeout(async () => {
+      try {
+        await cb(
+          (value: T) => {
+            t && clearTimeout(t);
+            resolve(value);
+          },
+          (error: Error) => {
+            t && clearTimeout(t);
+            reject(error);
+          },
+        );
+      } catch (err) {
+        reject(err);
+      }
+    });
+  });
+};
+
+/**
+ * Wait until promise resolves.
+ */
+export const untilPromise = <T = void>(cb: () => Promise<T>) => cb();
+
+/**
+ * Wait until error is thrown.
+ */
+export const untilError = (cb: () => Promise<any>) => {
+  return new Promise((resolve, reject) => {
+    setTimeout(async () => {
+      try {
+        await cb();
+        reject(new Error('No error was thrown.'));
+      } catch (err) {
+        resolve(err);
+      }
+    });
+  });
+};