@dxos/async 0.6.12-main.f9d0246 → 0.6.12-staging.0b4bb48

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/async",
-  "version": "0.6.12-main.f9d0246",
+  "version": "0.6.12-staging.0b4bb48",
   "description": "Async utilities.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -10,8 +10,7 @@
     ".": {
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
-        "require": "./dist/lib/node/index.cjs",
-        "default": "./dist/lib/node-esm/index.mjs"
+        "default": "./dist/lib/node/index.cjs"
       },
       "types": "./dist/types/src/index.d.ts"
     }
@@ -27,12 +26,12 @@
   "dependencies": {
     "zen-observable": "^0.10.0",
     "zen-push": "^0.3.1",
-    "@dxos/debug": "0.6.12-main.f9d0246",
-    "@dxos/log": "0.6.12-main.f9d0246",
-    "@dxos/invariant": "0.6.12-main.f9d0246",
-    "@dxos/node-std": "0.6.12-main.f9d0246",
-    "@dxos/util": "0.6.12-main.f9d0246",
-    "@dxos/context": "0.6.12-main.f9d0246"
+    "@dxos/debug": "0.6.12-staging.0b4bb48",
+    "@dxos/invariant": "0.6.12-staging.0b4bb48",
+    "@dxos/node-std": "0.6.12-staging.0b4bb48",
+    "@dxos/util": "0.6.12-staging.0b4bb48",
+    "@dxos/log": "0.6.12-staging.0b4bb48",
+    "@dxos/context": "0.6.12-staging.0b4bb48"
   },
   "devDependencies": {
     "@types/zen-observable": "^0.8.3"

package/src/event-emitter.test.ts

@@ -2,8 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
+import { expect } from 'chai';
 import { EventEmitter } from 'node:events';
-import { describe, expect, test } from 'vitest';
+
+import { describe, test } from '@dxos/test';
 
 import { onEvent, waitForEvent } from './event-emitter';
 import { latch } from './latch';

package/src/events.test.ts

@@ -2,11 +2,12 @@
 // Copyright 2020 DXOS.org
 //
 
-// import { setFlagsFromString } from 'node:v8';
-// import { runInNewContext } from 'node:vm';
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
+import { setFlagsFromString } from 'node:v8';
+import { runInNewContext } from 'node:vm';
 
 import { Context } from '@dxos/context';
+import { describe, test } from '@dxos/test';
 
 import { Event } from './events';
 import { sleep } from './timeout';
@@ -89,28 +90,28 @@ describe('Event', () => {
     expect(error.message).to.equal('test');
   });
 
-  // test.skip('weak', async () => {
-  //   setFlagsFromString('--expose_gc');
-  //   const gc = runInNewContext('gc'); // nocommit
+  test.skip('weak', async () => {
+    setFlagsFromString('--expose_gc');
+    const gc = runInNewContext('gc'); // nocommit
 
-  //   let called = 0;
-  //   let callback: (() => void) | null = () => {
-  //     called++;
-  //   };
+    let called = 0;
+    let callback: (() => void) | null = () => {
+      called++;
+    };
 
-  //   const event = new Event();
-  //   event.on(new Context(), callback, { weak: true });
+    const event = new Event();
+    event.on(new Context(), callback, { weak: true });
 
-  //   event.emit();
-  //   expect(called).to.equal(1);
+    event.emit();
+    expect(called).to.equal(1);
 
-  //   callback = null;
-  //   while (event.listenerCount() > 0) {
-  //     gc();
-  //     await sleep(5);
-  //   }
+    callback = null;
+    while (event.listenerCount() > 0) {
+      gc();
+      await sleep(5);
+    }
 
-  //   event.emit();
-  //   expect(called).to.equal(1);
-  // });
+    event.emit();
+    expect(called).to.equal(1);
+  });
 });

package/src/events.ts

@@ -65,7 +65,7 @@ export type ListenerOptions = {
  * ## Advantages over traditional EventEmitter:
  * 1. User describes explicitly what events a class has as they are defined as class fields.
  * 2. User can explicitly define event visibility (public, protected, private).
- * 3. Having events as class fields allows the compiler to check for correct event usage.
+ * 3. Havings events as class fields allows the compiler to check for correct event usage.
  * 4. User can type the data that event will be emitting.
  * 5. Uses composition instead of inheritance.
  * 6. Removes the cases where event names intersect when used in cases with inheritance.
@@ -73,9 +73,6 @@ export type ListenerOptions = {
  */
 // TODO(burdon): Rename EventSink? (Event is a built-in type).
 export class Event<T = void> implements ReadOnlyEvent<T> {
-  /**
-   * Wrap objects that have on/off style event emitters.
-   */
   static wrap<T>(emitter: EventEmitterLike, eventName: string): Event<T> {
     const event = new Event<T>();
 
@@ -262,7 +259,7 @@ export class Event<T = void> implements ReadOnlyEvent<T> {
    * If event is emitted for the first time or event wasn't fired for `timeout` milliseconds,
    * the event is emitted after `timeout / 8` ms.
    */
-  // TODO(burdon): Factor out generic function.
+  // TODO(burdon): Provide function.
   debounce(timeout = 0) {
     let firing: NodeJS.Timeout | undefined;
     let lastFired: number | undefined;
@@ -346,15 +343,13 @@ export class Event<T = void> implements ReadOnlyEvent<T> {
  */
 export interface ReadOnlyEvent<T = void> {
   /**
-   * Register an event listener.
+   * Registers an event listener.
    * If provided callback was already registered as once-listener, it is made permanent.
    *
    * @param callback
-   * @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;
 
   /**
    * Unsubscribes this callback from new events. Includes persistent and once-listeners.
@@ -397,14 +392,6 @@ export interface ReadOnlyEvent<T = void> {
    * Turn any variant of `Event<T>` into an `Event<void>` discarding the callback parameter.
    */
   discardParameter(): Event<void>;
-
-  /**
-   * Triggers an event with at least `timeout` milliseconds between each event.
-   * If the event is triggered more often, the event is delayed until the timeout is reached.
-   * If event is emitted for the first time or event wasn't fired for `timeout` milliseconds,
-   * the event is emitted after `timeout / 8` ms.
-   */
-  debounce(timeout?: number): Event<void>;
 }
 
 class EventListener<T> {

package/src/mutex.test.ts

@@ -2,9 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
 
 import { expectToThrow } from '@dxos/debug';
+import { describe, test } from '@dxos/test';
 
 import { Mutex, synchronized } from './mutex';
 import { sleep } from './timeout';
@@ -138,7 +139,7 @@ describe('Mutex', () => {
 
     expect(error!.stack!.includes('throwsError')).to.be.true;
     expect(error!.stack!.includes('callmutex')).to.be.true;
-  }); // .skipEnvironments('webkit');
+  }).skipEnvironments('webkit');
 
   test('works with explicit resource management syntax', async () => {
     const mutex = new Mutex();

package/src/observable-value.test.ts

@@ -2,7 +2,9 @@
 // Copyright 2022 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
+
+import { describe, test } from '@dxos/test';
 
 import { type AsyncEvents, TimeoutError } from './errors';
 import { latch } from './latch';

package/src/observable.test.ts

@@ -2,7 +2,9 @@
 // Copyright 2023 DXOS.org
 //
 
-import { describe, expect, onTestFinished, test } from 'vitest';
+import { expect } from 'chai';
+
+import { afterTest, describe, test } from '@dxos/test';
 
 import { Event } from './events';
 import { MulticastObservable, Observable, PushStream } from './observable';
@@ -21,7 +23,7 @@ describe('multicast observable', () => {
       expect(value).to.equal(1);
       trigger.wake();
     });
-    onTestFinished(() => subscription.unsubscribe());
+    afterTest(() => subscription.unsubscribe());
     await trigger.wait();
   });
 
@@ -44,8 +46,8 @@ describe('multicast observable', () => {
       }
     });
 
-    onTestFinished(() => subscription1.unsubscribe());
-    onTestFinished(() => subscription2.unsubscribe());
+    afterTest(() => subscription1.unsubscribe());
+    afterTest(() => subscription2.unsubscribe());
 
     const next = { new: 'value' };
     event.emit(next);
@@ -98,7 +100,7 @@ describe('multicast observable', () => {
     const subscription = mapped.subscribe((value) => {
       result.wake(value);
     });
-    onTestFinished(() => subscription.unsubscribe());
+    afterTest(() => subscription.unsubscribe());
     expect(await result.wait()).to.deep.equal(6);
   });
 
@@ -119,7 +121,7 @@ describe('multicast observable', () => {
     const subscription = reduced.subscribe((value) => {
       result.wake(value);
     });
-    onTestFinished(() => subscription.unsubscribe());
+    afterTest(() => subscription.unsubscribe());
     expect(await result.wait()).to.deep.equal(6);
   });
 

package/src/task-scheduling.test.ts

@@ -2,9 +2,11 @@
 // Copyright 2022 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
+import waitForExpect from 'wait-for-expect';
 
 import { Context } from '@dxos/context';
+import { describe, test } from '@dxos/test';
 
 import { DeferredTask, scheduleTask } from './task-scheduling';
 import { sleep } from './timeout';
@@ -23,7 +25,9 @@ describe('task-scheduling', () => {
         throw new Error('test');
       });
 
-      await expect.poll(() => error.message).toBe('test');
+      await waitForExpect(() => {
+        expect(error.message).to.eq('test');
+      });
     });
 
     test('cancelation', async () => {

package/src/test-stream.test.ts

@@ -2,7 +2,7 @@
 // Copyright 2022 DXOS.org
 //
 
-import { test } from 'vitest';
+import { test } from '@dxos/test';
 
 import { TestStream } from './test-stream';
 

package/src/testing.test.ts

@@ -2,9 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
 
 import { expectToThrow } from '@dxos/debug';
+import { describe, test } from '@dxos/test';
 
 import { waitForCondition } from './testing';
 

package/src/timeout.test.ts

@@ -2,7 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
+
+import { expectToThrow } from '@dxos/debug';
+import { describe, test } from '@dxos/test';
 
 import { asyncTimeout, sleep } from './timeout';
 
@@ -15,7 +18,7 @@ describe('timeout', () => {
 
   test('fails', async () => {
     const promise = sleep(200).then(() => 'test');
-    await expect(() => asyncTimeout(promise, 100, new Error('timeout'))).rejects.toThrowError();
+    await expectToThrow(() => asyncTimeout(promise, 100, new Error('timeout')));
   });
 
   test('sleep', async () => {

package/src/trigger.test.ts

@@ -2,11 +2,16 @@
 // Copyright 2020 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+import { describe, test } from '@dxos/test';
 
 import { sleep } from './timeout';
 import { Trigger, TriggerState, trigger } from './trigger';
 
+chai.use(chaiAsPromised);
+
 describe('trigger', () => {
   test('trigger', async () => {
     const [value, setValue] = trigger<any>();
@@ -47,7 +52,7 @@ describe('trigger', () => {
       const error = new Error('Test error');
       const promise = trigger.wait();
       trigger.throw(error);
-      await expect(promise).rejects.toThrowError(error);
+      await expect(promise).to.be.rejectedWith(error);
       expect(trigger.state).to.equal(TriggerState.REJECTED);
       trigger.reset();
       expect(trigger.state).to.equal(TriggerState.WAITING);

package/src/until.test.ts

@@ -2,7 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
+
+import { expectToThrow } from '@dxos/debug';
+import { describe, test } from '@dxos/test';
 
 import { sleep } from './timeout';
 import { until } from './until';
@@ -19,29 +22,29 @@ describe('until', () => {
   });
 
   test('error', async () => {
-    await expect(async () => {
+    await expectToThrow(async () => {
       await until(async (resolve, reject) => {
         await sleep(100);
         reject(new Error());
       });
-    }).rejects.toThrowError();
+    });
   });
 
   test('catch', async () => {
-    await expect(async () => {
+    await expectToThrow(async () => {
       await until(async () => {
         await sleep(100);
         throw new Error();
       });
-    }).rejects.toThrowError();
+    });
   });
 
   test('timeout', async () => {
-    await expect(async () => {
+    await expectToThrow(async () => {
       await until(async (resolve) => {
         await sleep(500);
         resolve();
       }, 100); // Timeout before complete.
-    }).rejects.toThrowError();
+    });
   });
 });

package/src/update-scheduler.test.ts

@@ -2,9 +2,10 @@
 // Copyright 2023 DXOS.org
 //
 
-import { describe, expect, test } from 'vitest';
+import { expect } from 'chai';
 
 import { Context } from '@dxos/context';
+import { describe, test } from '@dxos/test';
 
 import { sleep } from './timeout';
 import { UpdateScheduler } from './update-scheduler';