model: use statePromise

src/Model.discontinuity.test.ts

@@ -5,7 +5,8 @@ import { it, describe, expect, vi, beforeEach } from 'vitest';
 
 import Model from './Model.js';
 import { ModelOptions } from './types/model.js';
-import { getEventPromises, statePromise } from './utilities/test/promises.js';
+import { statePromise } from './utilities/promises.js';
+import { getEventPromises } from './utilities/test/promises.js';
 
 vi.mock('ably/promises');
 

src/Model.test.ts

@@ -7,8 +7,9 @@ import Model from './Model.js';
 import { StreamOptions, IStream, StreamState } from './stream/Stream.js';
 import { IStreamFactory } from './stream/StreamFactory.js';
 import type { ModelState, ModelStateChange, ModelOptions } from './types/model.d.ts';
+import { statePromise, timeout } from './utilities/promises.js';
 import { createMessage, customMessage } from './utilities/test/messages.js';
-import { getNthEventPromise, getEventPromises, statePromise, timeout } from './utilities/test/promises.js';
+import { getNthEventPromise, getEventPromises } from './utilities/test/promises.js';
 
 vi.mock('ably/promises');
 
@@ -128,8 +129,8 @@ describe('Model', () => {
     await statePromise(model, 'preparing');
     completeSync();
 
-    await statePromise(model, 'ready');
-    await expect(ready).resolves.toEqual({ current: 'ready', previous: 'preparing', reason: undefined });
+    const registerResult = await ready;
+    expect([undefined, { current: 'ready', previous: 'preparing', reason: undefined }]).toContain(registerResult);
 
     expect(sync).toHaveBeenCalledOnce();
     expect(model.data.optimistic).toEqual(simpleTestData);

src/Model.ts

@@ -22,6 +22,7 @@ import type {
 } from './types/model.js';
 import type { OptimisticInvocationParams } from './types/optimistic.js';
 import EventEmitter from './utilities/EventEmitter.js';
+import { statePromise } from './utilities/promises.js';
 
 /**
  * A Model encapsulates an observable, collaborative data model backed by a transactional database in your backend.
@@ -130,7 +131,7 @@ export default class Model<T> extends EventEmitter<Record<ModelState, ModelState
    */
   public async $sync() {
     await this.init();
-    return new Promise((resolve) => this.whenState('ready', this.state, resolve));
+    return statePromise(this, 'ready');
   }
 
   /**
@@ -172,7 +173,7 @@ export default class Model<T> extends EventEmitter<Record<ModelState, ModelState
     await this.pendingConfirmationRegistry.finalise(reason);
     this.subscriptionMap = new WeakMap();
     this.streamSubscriptionsMap = new WeakMap();
-    return new Promise((resolve) => this.whenState('disposed', this.state, resolve));
+    return statePromise(this, 'disposed');
   }
 
   /**
@@ -197,9 +198,8 @@ export default class Model<T> extends EventEmitter<Record<ModelState, ModelState
       this.merge = registration.$merge;
     }
 
-    const result = new Promise((resolve) => this.whenState('ready', this.state, resolve));
     await this.init();
-    return result;
+    return statePromise(this, 'ready');
   }
 
   /**

src/stream/Middleware.test.ts

@@ -3,8 +3,8 @@ import shuffle from 'lodash/shuffle.js';
 import { it, describe, expect, vi } from 'vitest';
 
 import { SlidingWindow, OrderedHistoryResumer, lexicographicOrderer } from './Middleware.js';
+import { timeout } from '../utilities/promises.js';
 import { createMessage } from '../utilities/test/messages.js';
-import { timeout } from '../utilities/test/promises.js';
 
 describe('SlidingWindow', () => {
   it('emits events immediately with no timeout', async () => {

src/stream/Stream.test.ts

@@ -4,8 +4,8 @@ import { Subject } from 'rxjs';
 import { it, describe, expect, beforeEach, afterEach, vi } from 'vitest';
 
 import Stream, { HISTORY_PAGE_SIZE, StreamOptions, StreamState } from './Stream.js';
+import { statePromise } from '../utilities/promises.js';
 import { createMessage } from '../utilities/test/messages.js';
-import { statePromise } from '../utilities/test/promises.js';
 
 vi.mock('ably/promises');
 

src/utilities/promises.ts

@@ -0,0 +1,11 @@
+import { EventListener } from './EventEmitter.js';
+
+interface StateListener<T, S> {
+  state: S;
+  whenState(targetState: S, currentState: S, listener: EventListener<T>, ...listenerArgs: unknown[]): void;
+}
+
+export const statePromise = <T, S>(object: StateListener<T, S>, state: S) =>
+  new Promise((resolve) => object.whenState(state, object.state, resolve));
+
+export const timeout = (ms: number = 0) => new Promise((resolve) => setTimeout(resolve, ms));

src/utilities/test/promises.ts

@@ -1,7 +1,5 @@
 import { Subject, lastValueFrom, take } from 'rxjs';
 
-import { EventListener } from '../EventEmitter.js';
-
 export const getNthEventPromise = <T>(subject: Subject<T>, n: number) => lastValueFrom(subject.pipe(take(n)));
 
 export const getEventPromises = <T>(subject: Subject<T>, n: number) => {
@@ -11,13 +9,3 @@ export const getEventPromises = <T>(subject: Subject<T>, n: number) => {
   }
   return promises;
 };
-
-interface StateListener<T, S> {
-  state: S;
-  whenState(targetState: S, currentState: S, listener: EventListener<T>, ...listenerArgs: unknown[]): void;
-}
-
-export const statePromise = <T, S>(object: StateListener<T, S>, state: S) =>
-  new Promise((resolve) => object.whenState(state, object.state, resolve));
-
-export const timeout = (ms: number = 0) => new Promise((resolve) => setTimeout(resolve, ms));