@dxos/async 0.7.4 → 0.7.5-labs.071a3e2

package/dist/types/src/task-scheduling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"task-scheduling.d.ts","sourceRoot":"","sources":["../../../src/task-scheduling.ts"],"names":[],"mappings":"AAIA,OAAO,EAAwB,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAEnE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAK/C,MAAM,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC;AAEvC;;;;GAIG;AAGH,qBAAa,YAAY;IAMrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAN5B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,SAAS,CAAiB;gBAGf,IAAI,EAAE,OAAO,EACb,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC;IAGjD;;OAEG;IACH,QAAQ;IAuBR;;OAEG;IACG,WAAW;IASjB;;;OAGG;IACG,IAAI;CAGX;AAED,eAAO,MAAM,YAAY,QAAS,OAAO,MAAM,MAAM,IAAI,SAMxD,CAAC;AAEF,eAAO,MAAM,iBAAiB,QAAe,OAAO,MAAM,MAAM,YAAY,CAAC,IAAI,CAAC,kBAMjF,CAAC;AAEF,eAAO,MAAM,iBAAiB,QAAS,OAAO,MAAM,MAAM,YAAY,CAAC,IAAI,CAAC,SAO3E,CAAC;AAEF,eAAO,MAAM,YAAY,QAAS,OAAO,MAAM,MAAM,YAAY,CAAC,IAAI,CAAC,YAAY,MAAM,SAgBxF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAS,OAAO,QAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,YAAY,MAAM,SAqB7F,CAAC;AAEF,eAAO,MAAM,sCAAsC,QAC5C,OAAO,QACN,MAAM,OAAO,CAAC,IAAI,CAAC,mBACR,MAAM,SAwBxB,CAAC"}
+{"version":3,"file":"task-scheduling.d.ts","sourceRoot":"","sources":["../../../src/task-scheduling.ts"],"names":[],"mappings":"AAIA,OAAO,EAAwB,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAEnE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAK/C,MAAM,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC;AAEvC;;;;GAIG;AAGH,qBAAa,YAAY;IAMrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAN5B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,SAAS,CAAiB;gBAGf,IAAI,EAAE,OAAO,EACb,SAAS,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC;IAGjD,IAAI,SAAS,YAEZ;IAED;;OAEG;IACH,QAAQ;IAuBR;;OAEG;IACG,WAAW;IASjB;;;OAGG;IACG,IAAI;CAGX;AAED,eAAO,MAAM,YAAY,QAAS,OAAO,MAAM,MAAM,IAAI,SAMxD,CAAC;AAEF,eAAO,MAAM,iBAAiB,QAAe,OAAO,MAAM,MAAM,YAAY,CAAC,IAAI,CAAC,kBAMjF,CAAC;AAEF,eAAO,MAAM,iBAAiB,QAAS,OAAO,MAAM,MAAM,YAAY,CAAC,IAAI,CAAC,SAO3E,CAAC;AAEF,eAAO,MAAM,YAAY,QAAS,OAAO,MAAM,MAAM,YAAY,CAAC,IAAI,CAAC,YAAY,MAAM,SAgBxF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAS,OAAO,QAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,YAAY,MAAM,SAqB7F,CAAC;AAEF,eAAO,MAAM,sCAAsC,QAC5C,OAAO,QACN,MAAM,OAAO,CAAC,IAAI,CAAC,mBACR,MAAM,SAwBxB,CAAC"}

package/dist/types/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"5.7.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/async",
-  "version": "0.7.4",
+  "version": "0.7.5-labs.071a3e2",
   "description": "Async utilities.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -28,12 +28,12 @@
   "dependencies": {
     "zen-observable": "^0.10.0",
     "zen-push": "^0.3.1",
-    "@dxos/context": "0.7.4",
-    "@dxos/debug": "0.7.4",
-    "@dxos/invariant": "0.7.4",
-    "@dxos/log": "0.7.4",
-    "@dxos/util": "0.7.4",
-    "@dxos/node-std": "0.7.4"
+    "@dxos/context": "0.7.5-labs.071a3e2",
+    "@dxos/invariant": "0.7.5-labs.071a3e2",
+    "@dxos/debug": "0.7.5-labs.071a3e2",
+    "@dxos/log": "0.7.5-labs.071a3e2",
+    "@dxos/util": "0.7.5-labs.071a3e2",
+    "@dxos/node-std": "0.7.5-labs.071a3e2"
   },
   "devDependencies": {
     "@types/zen-observable": "^0.8.3"

package/src/events.test.ts

@@ -89,6 +89,21 @@ describe('Event', () => {
     expect(error.message).to.equal('test');
   });
 
+  test('emitAsync', async () => {
+    const event = new Event<number>();
+    let called = 0;
+    event.on(async (num) => {
+      await sleep(10);
+      called++;
+    });
+
+    await event.emitAsync(1);
+    expect(called).to.equal(1);
+
+    // TODO(dmaretskyi): Disabled for now.
+    // expect(() => event.emit(1)).to.throw(TypeError);
+  });
+
   // test.skip('weak', async () => {
   //   setFlagsFromString('--expose_gc');
   //   const gc = runInNewContext('gc'); // nocommit

package/src/events.ts

@@ -3,6 +3,7 @@
 //
 
 import { Context } from '@dxos/context';
+import type { MaybePromise } from '@dxos/util';
 
 export type UnsubscribeCallback = () => void;
 
@@ -42,6 +43,11 @@ export type ListenerOptions = {
   once?: boolean;
 };
 
+type EventCallback<T> = (data: T) => MaybePromise<void>;
+
+// TODO(dmaretskyi): Remove this once the code is cleaned up.
+const DO_NOT_ERROR_ON_ASYNC_CALLBACK = true;
+
 /**
  * An EventEmitter variant that does not do event multiplexing and represents a single event.
  *
@@ -102,7 +108,25 @@ export class Event<T = void> implements ReadOnlyEvent<T> {
    */
   emit(data: T) {
     for (const listener of this._listeners) {
-      void listener.trigger(data);
+      listener.trigger(data);
+
+      if (listener.once) {
+        this._listeners.delete(listener);
+      }
+    }
+  }
+
+  /**
+   * Emit an event and wait for async listeners to complete.
+   * In most cases should only be called by the class or entity containing the event.
+   * All listeners are called in order of subscription with persistent ones first.
+   * Listeners are called sequentially.
+   *
+   * @param data param that will be passed to all listeners.
+   */
+  async emitAsync(data: T) {
+    for (const listener of this._listeners) {
+      await listener.triggerAsync(data);
 
       if (listener.once) {
         this._listeners.delete(listener);
@@ -118,9 +142,9 @@ export class Event<T = void> implements ReadOnlyEvent<T> {
    * @param options.weak If true, the callback will be weakly referenced and will be garbage collected if no other references to it exist.
    * @returns function that unsubscribes this event listener
    */
-  on(callback: (data: T) => void): UnsubscribeCallback;
-  on(ctx: Context, callback: (data: T) => void, options?: ListenerOptions): UnsubscribeCallback;
-  on(_ctx: any, _callback?: (data: T) => void, options?: ListenerOptions): UnsubscribeCallback {
+  on(callback: EventCallback<T>): UnsubscribeCallback;
+  on(ctx: Context, callback: EventCallback<T>, options?: ListenerOptions): UnsubscribeCallback;
+  on(_ctx: any, _callback?: EventCallback<T>, options?: ListenerOptions): UnsubscribeCallback {
     const [ctx, callback] = _ctx instanceof Context ? [_ctx, _callback] : [new Context(), _ctx];
     const weak = !!options?.weak;
     const once = !!options?.once;
@@ -408,13 +432,13 @@ export interface ReadOnlyEvent<T = void> {
 }
 
 class EventListener<T> {
-  public readonly callback: ((data: T) => void) | WeakRef<(data: T) => void>;
+  public readonly callback: EventCallback<T> | WeakRef<EventCallback<T>>;
 
   private readonly _clearDispose?: () => void = undefined;
 
   constructor(
     event: Event<T>,
-    listener: (data: T) => void,
+    listener: EventCallback<T>,
     public readonly ctx: Context,
     public readonly once: boolean,
     public readonly weak: boolean,
@@ -438,11 +462,27 @@ class EventListener<T> {
     }
   }
 
-  derefCallback(): ((data: T) => void) | undefined {
-    return this.weak ? (this.callback as WeakRef<(data: T) => void>).deref() : (this.callback as (data: T) => void);
+  derefCallback(): EventCallback<T> | undefined {
+    return this.weak ? (this.callback as WeakRef<EventCallback<T>>).deref() : (this.callback as EventCallback<T>);
+  }
+
+  trigger(data: T) {
+    let result!: MaybePromise<void>;
+    try {
+      const callback = this.derefCallback();
+      result = callback?.(data);
+    } catch (err: any) {
+      this.ctx.raise(err);
+    }
+
+    if (!DO_NOT_ERROR_ON_ASYNC_CALLBACK) {
+      if (result instanceof Promise) {
+        throw new TypeError('Event has async callbacks, use emitAsync instead');
+      }
+    }
   }
 
-  async trigger(data: T) {
+  async triggerAsync(data: T) {
     try {
       const callback = this.derefCallback();
       await callback?.(data);

package/src/task-scheduling.ts

@@ -28,6 +28,10 @@ export class DeferredTask {
     private readonly _callback: () => Promise<void>,
   ) {}
 
+  get scheduled() {
+    return this._scheduled;
+  }
+
   /**
    * Schedule the task to run asynchronously.
    */