synstate 6.2.1 → 7.0.1

package/src/core/operators/inner-ownership.test.mts

@@ -1,5 +1,7 @@
-import { source } from '../create/index.mjs';
-import { createScope } from '../scope/index.mjs';
+import { panic } from 'ts-std-forge';
+import { toNode } from '../class/index.mjs';
+import { just, source } from '../create/index.mjs';
+import { createScope, onScopeDispose } from '../scope/index.mjs';
 import { map } from './map.mjs';
 import { mergeMap } from './merge-map.mjs';
 import { switchMap } from './switch-map.mjs';
@@ -278,3 +280,144 @@ describe('mergeMap releases only the inner observables its projection created (#
     assert.isFalse(shared$.isCompleted);
   });
 });
+
+describe('mergeMap releases an inner observable as soon as it completes (#2769)', () => {
+  test('disposes what the projection made once its inner observable completes', () => {
+    const click$ = source<number>();
+
+    const mut_inners: ReturnType<typeof source<string>>[] = [];
+
+    const mut_disposed: number[] = [];
+
+    const merged$ = click$.pipe(
+      mergeMap((n) => {
+        onScopeDispose(() => {
+          mut_disposed.push(n);
+        });
+
+        const inner$ = source<string>();
+
+        mut_inners.push(inner$);
+
+        return inner$;
+      }),
+    );
+
+    const mut_values: string[] = [];
+
+    merged$.subscribe((v) => {
+      mut_values.push(v);
+    });
+
+    click$.next(1);
+
+    click$.next(2);
+
+    mut_inners[0]?.next('a');
+
+    mut_inners[0]?.complete();
+
+    assert.deepStrictEqual(mut_disposed, [1]);
+
+    mut_inners[1]?.next('b');
+
+    assert.deepStrictEqual(mut_values, ['a', 'b']);
+
+    merged$.complete();
+
+    // Each projection's scope is disposed once.
+    assert.deepStrictEqual(mut_disposed, [1, 2]);
+  });
+
+  test('disposes at once what the projection made when its inner observable completes while subscribed', () => {
+    const click$ = source<number>();
+
+    const mut_disposed: number[] = [];
+
+    const merged$ = click$.pipe(
+      mergeMap((n) => {
+        onScopeDispose(() => {
+          mut_disposed.push(n);
+        });
+
+        return just(n);
+      }),
+    );
+
+    const mut_values: number[] = [];
+
+    merged$.subscribe((v) => {
+      mut_values.push(v);
+    });
+
+    click$.next(1);
+
+    click$.next(2);
+
+    assert.deepStrictEqual(mut_values, [1, 2]);
+
+    assert.deepStrictEqual(mut_disposed, [1, 2]);
+
+    merged$.complete();
+
+    assert.deepStrictEqual(mut_disposed, [1, 2]);
+  });
+
+  test('disposes what a projection that threw made when mergeMap completes', () => {
+    const click$ = source<number>();
+
+    const mut_disposed: number[] = [];
+
+    const merged$ = click$.pipe(
+      mergeMap((n) => {
+        onScopeDispose(() => {
+          mut_disposed.push(n);
+        });
+
+        return panic('projection failed');
+      }),
+    );
+
+    merged$.subscribe(() => {});
+
+    expect(() => {
+      click$.next(1);
+    }).toThrow('projection failed');
+
+    merged$.complete();
+
+    assert.deepStrictEqual(mut_disposed, [1]);
+  });
+
+  test('releases an inner observable when mergeMap completes while subscribing to it', () => {
+    const click$ = source<number>();
+
+    const inner$ = source<string>('first');
+
+    const mut_disposed: number[] = [];
+
+    const merged$ = click$.pipe(
+      mergeMap((n) => {
+        onScopeDispose(() => {
+          mut_disposed.push(n);
+        });
+
+        return inner$;
+      }),
+    );
+
+    merged$.subscribe((v) => {
+      if (v === 'first') {
+        merged$.complete();
+      }
+    });
+
+    click$.next(1);
+
+    assert.isTrue(merged$.isCompleted);
+
+    assert.deepStrictEqual(mut_disposed, [1]);
+
+    assert.isFalse(toNode(inner$).hasSubscriber);
+  });
+});

package/src/core/operators/merge-map.mts

@@ -5,7 +5,8 @@
 // @sumi-expect-error-file banned-syntax/no-this
 // @sumi-expect-error-file functions/prefer-arrow-function
 // @sumi-expect-error-file mutation/no-mutation-without-mut-prefix
-import { Arr, Optional } from 'ts-data-forge';
+import { Optional } from 'ts-data-forge';
+import type { MutableMap } from 'ts-type-forge';
 import { AsyncChildObservableClass } from '../class/index.mjs';
 import { createScope, getCurrentScope } from '../scope/index.mjs';
 import type {
@@ -21,9 +22,13 @@ import type {
  * Projects each source value to an observable and merges all inner observables.
  * Unlike `switchMap`, does not cancel previous inner observables.
  *
+ * A value the source already holds when `mergeMap` is created is projected at
+ * once, as with `switchMap`. A completed source is not projected.
+ *
  * Each projection runs in a scope of its own (see `createScope`): what it
- * creates is disposed when `mergeMap` completes. An observable it only returns
- * — one created outside the projection and shared with others — is unsubscribed
+ * creates is disposed when the observable it returned completes, or when
+ * `mergeMap` completes, whichever comes first. An observable it only returns —
+ * one created outside the projection and shared with others — is unsubscribed
  * and left running.
  *
  * @template A - The type of values from the source
@@ -136,8 +141,12 @@ class MergeMapObservableClass<A, B>
   /** See `SwitchMapObservableClass`. */
   readonly #ownerScope: Scope | undefined;
 
-  #mut_innerScopes: readonly Scope[];
-  #mut_subscriptions: readonly Subscription[];
+  /**
+   * The inner observables still live, by the scope their projection ran in.
+   * One that completes is released at once, so a long-lived `mergeMap` holds
+   * only those (#2769).
+   */
+  readonly #mut_liveInners: MutableMap<Scope, Subscription | undefined>;
 
   constructor(
     parentObservable: Observable<A>,
@@ -152,11 +161,47 @@ class MergeMapObservableClass<A, B>
 
     this.#ownerScope = getCurrentScope();
 
-    this.#mut_innerScopes = [];
+    this.#mut_liveInners = new Map<Scope, Subscription | undefined>();
+
+    this.attachProjectingHeldValue(parentObservable, (value, updateToken) => {
+      this.#project(value, updateToken);
+    });
+  }
+
+  /**
+   * Unsubscribes from an inner observable and disposes what its projection
+   * made.
+   */
+  #releaseInner(innerScope: Scope): void {
+    this.#mut_liveInners.get(innerScope)?.unsubscribe();
 
-    this.#mut_subscriptions = [];
+    this.#mut_liveInners.delete(innerScope);
 
-    this.attach();
+    innerScope.dispose();
+  }
+
+  /** Adds the inner observable of `value` to those merged. */
+  #project(value: A, updateToken: UpdateToken): void {
+    const innerScope = createScope(this.#ownerScope);
+
+    // Held before the projection runs, so that `teardown` disposes what it made
+    // even if it throws, or if `mergeMap` completes while the inner observable
+    // is being subscribed.
+    this.#mut_liveInners.set(innerScope, undefined);
+
+    const observable = innerScope.run(() => this.#mapToObservable(value));
+
+    const subscription = this.subscribeInner(observable, updateToken, () => {
+      this.#releaseInner(innerScope);
+    });
+
+    if (this.#mut_liveInners.has(innerScope)) {
+      this.#mut_liveInners.set(innerScope, subscription);
+    } else {
+      // Released while it was subscribed: the inner observable completed
+      // (`just(x)`), or `mergeMap` did.
+      subscription.unsubscribe();
+    }
   }
 
   override tryUpdate(updateToken: UpdateToken): void {
@@ -168,28 +213,13 @@ class MergeMapObservableClass<A, B>
       return; // skip update
     }
 
-    const innerScope = createScope(this.#ownerScope);
-
-    this.#mut_innerScopes = Arr.toPushed(this.#mut_innerScopes, innerScope);
-
-    const observable = innerScope.run(() => this.#mapToObservable(sn.value));
-
-    const subscription = this.subscribeInner(observable, updateToken);
-
-    this.#mut_subscriptions = Arr.toPushed(
-      this.#mut_subscriptions,
-      subscription,
-    );
+    this.#project(sn.value, updateToken);
   }
 
   /** Releases the inner observables, and only those this operator made. */
   protected override teardown(): void {
-    for (const s of this.#mut_subscriptions) {
-      s.unsubscribe();
-    }
-
-    for (const scope of this.#mut_innerScopes) {
-      scope.dispose();
+    for (const innerScope of this.#mut_liveInners.keys()) {
+      this.#releaseInner(innerScope);
     }
   }
 }

package/src/core/operators/skip-while.mts

@@ -5,7 +5,7 @@
 // @sumi-expect-error-file banned-syntax/no-this
 // @sumi-expect-error-file functions/prefer-arrow-function
 // @sumi-expect-error-file mutation/no-mutation-without-mut-prefix
-import { Optional, SafeUint, asSafeUint, pipe } from 'ts-data-forge';
+import { Optional, asSafeUint, pipe, type SafeUint } from 'ts-data-forge';
 import { SyncChildObservableClass } from '../class/index.mjs';
 import type {
   DropInitialValueOperator,
@@ -93,16 +93,20 @@ class SkipWhileObservableClass<A>
     parentObservable: Observable<A>,
     predicate: (value: A, index: SafeUint | -1) => boolean,
   ) {
+    const initialValue = pipe(parentObservable.getSnapshot()).map((sn) =>
+      Optional.isNone(sn) || predicate(sn.value, -1) ? Optional.none : sn,
+    ).value;
+
     super({
       parents: [parentObservable],
-      initialValue: pipe(parentObservable.getSnapshot()).map((sn) =>
-        Optional.isNone(sn) || predicate(sn.value, -1) ? Optional.none : sn,
-      ).value,
+      initialValue,
     });
 
     this.#mut_index = -1;
 
-    this.#mut_isSkipping = true;
+    // A parent value the predicate let through has ended the skipping, as any
+    // later one would.
+    this.#mut_isSkipping = Optional.isNone(initialValue);
 
     this.#predicate = predicate;
 
@@ -118,10 +122,10 @@ class SkipWhileObservableClass<A>
       return; // skip update
     }
 
-    this.#mut_index =
-      this.#mut_index === -1 ? asSafeUint(0) : SafeUint.add(1, this.#mut_index);
+    this.#mut_index = asSafeUint(this.#mut_index + 1);
 
-    if (!this.#predicate(sn.value, this.#mut_index)) {
+    // Once skipping has ended, the predicate is not asked again.
+    if (this.#mut_isSkipping && !this.#predicate(sn.value, this.#mut_index)) {
       this.#mut_isSkipping = false;
     }
 

package/src/core/operators/skip-while.test.mts

@@ -1,4 +1,5 @@
 import { Optional } from 'ts-data-forge';
+import { createState } from '../../utils/index.mjs';
 import { just } from '../create/index.mjs';
 import { skipWhile } from './skip-while.mjs';
 
@@ -17,4 +18,62 @@ describe(skipWhile, () => {
 
     assert.isTrue(Optional.isNone(dropped$.getSnapshot()));
   });
+
+  test('passes every later value once the initial value has ended the skipping', () => {
+    const [s$, setS] = createState(5);
+
+    const passed$ = s$.pipe(skipWhile((x) => x < 3));
+
+    const mut_history: number[] = [];
+
+    passed$.subscribe((x) => {
+      mut_history.push(x);
+    });
+
+    setS(1);
+
+    setS(2);
+
+    assert.deepStrictEqual(mut_history, [5, 1, 2]);
+  });
+
+  test('keeps skipping after an initial value the predicate skips', () => {
+    const [s$, setS] = createState(1);
+
+    const passed$ = s$.pipe(skipWhile((x) => x < 3));
+
+    const mut_history: number[] = [];
+
+    passed$.subscribe((x) => {
+      mut_history.push(x);
+    });
+
+    setS(2);
+
+    setS(5);
+
+    setS(1);
+
+    assert.deepStrictEqual(mut_history, [5, 1]);
+  });
+
+  test('asks the predicate no more once the initial value has ended the skipping', () => {
+    const [s$, setS] = createState(5);
+
+    let mut_calls = 0;
+
+    s$.pipe(
+      skipWhile((x) => {
+        mut_calls += 1;
+
+        return x < 3;
+      }),
+    ).subscribe(() => {});
+
+    setS(1);
+
+    setS(2);
+
+    assert.strictEqual(mut_calls, 1);
+  });
 });

package/src/core/operators/switch-map.mts

@@ -21,6 +21,10 @@ import type {
  * Projects each source value to an observable, subscribes to it, and emits its values.
  * When a new value arrives from the source, the previous inner observable is unsubscribed.
  *
+ * A value the source already holds when `switchMap` is created (a state, an
+ * observable with an initial value) is projected at once, as `map` and `filter`
+ * start from it. A completed source is not projected.
+ *
  * The projection runs in a scope of its own (see `createScope`): what it
  * creates is disposed when the next value switches away from it and when
  * `switchMap` completes. An observable it only returns — one created outside
@@ -152,7 +156,9 @@ class SwitchMapObservableClass<A, B>
 
     this.#mut_subscription = undefined;
 
-    this.attach();
+    this.attachProjectingHeldValue(parentObservable, (value, updateToken) => {
+      this.#project(value, updateToken);
+    });
   }
 
   /** Releases the inner observable, and only the one this operator made. */
@@ -162,6 +168,19 @@ class SwitchMapObservableClass<A, B>
     this.#mut_innerScope?.dispose();
   }
 
+  /** Switches to the inner observable of `value`. */
+  #project(value: A, updateToken: UpdateToken): void {
+    this.#releaseInner();
+
+    const innerScope = createScope(this.#ownerScope);
+
+    this.#mut_innerScope = innerScope;
+
+    const observable = innerScope.run(() => this.#mapToObservable(value));
+
+    this.#mut_subscription = this.subscribeInner(observable, updateToken);
+  }
+
   override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
@@ -171,15 +190,7 @@ class SwitchMapObservableClass<A, B>
       return; // skip update
     }
 
-    this.#releaseInner();
-
-    const innerScope = createScope(this.#ownerScope);
-
-    this.#mut_innerScope = innerScope;
-
-    const observable = innerScope.run(() => this.#mapToObservable(sn.value));
-
-    this.#mut_subscription = this.subscribeInner(observable, updateToken);
+    this.#project(sn.value, updateToken);
   }
 
   protected override teardown(): void {

package/src/core/operators/take-while.mts

@@ -5,13 +5,7 @@
 // @sumi-expect-error-file banned-syntax/no-this
 // @sumi-expect-error-file functions/prefer-arrow-function
 // @sumi-expect-error-file mutation/no-mutation-without-mut-prefix
-import {
-  Optional,
-  SafeUint,
-  asSafeUint,
-  expectType,
-  pipe,
-} from 'ts-data-forge';
+import { Optional, asSafeUint, expectType, type SafeUint } from 'ts-data-forge';
 import { SyncChildObservableClass } from '../class/index.mjs';
 import { source } from '../create/index.mjs';
 import type {
@@ -73,7 +67,7 @@ import { withInitialValue } from './with-initial-value.mjs';
  *
  * assert.deepStrictEqual(valueHistory, [1, 2, 3, 4]);
  *
- * num$.next(1); // logs: 1
+ * num$.next(1); // nothing logged (already completed)
  *
  * assert.deepStrictEqual(valueHistory, [1, 2, 3, 4]);
  * ```
@@ -98,21 +92,26 @@ class TakeWhileObservableClass<A>
     parentObservable: Observable<A>,
     predicate: (value: A, index: SafeUint | -1) => boolean,
   ) {
+    const parentSnapshot = parentObservable.getSnapshot();
+
+    const isTaking =
+      Optional.isNone(parentSnapshot) || predicate(parentSnapshot.value, -1);
+
     super({
       parents: [parentObservable],
-      initialValue: pipe(parentObservable.getSnapshot()).map((par) =>
-        Optional.isNone(par)
-          ? Optional.none
-          : predicate(par.value, -1)
-            ? par
-            : Optional.none,
-      ).value,
+      initialValue: isTaking ? parentSnapshot : Optional.none,
     });
 
     this.#mut_index = -1;
 
     this.#predicate = predicate;
 
+    // A parent value the predicate rejects ends it, as any later one would;
+    // `attach` then leaves it out of the graph.
+    if (!isTaking) {
+      this.complete();
+    }
+
     this.attach();
   }
 
@@ -125,8 +124,7 @@ class TakeWhileObservableClass<A>
       return; // skip update
     }
 
-    this.#mut_index =
-      this.#mut_index === -1 ? asSafeUint(0) : SafeUint.add(1, this.#mut_index);
+    this.#mut_index = asSafeUint(this.#mut_index + 1);
 
     if (this.#predicate(sn.value, this.#mut_index)) {
       this.setNext(sn.value, updateToken);

package/src/core/operators/take-while.test.mts

@@ -0,0 +1,51 @@
+import { createState } from '../../utils/index.mjs';
+import { takeWhile } from './take-while.mjs';
+
+describe(takeWhile, () => {
+  test('completes at once when the initial value fails the predicate', () => {
+    const [s$, setS] = createState(5);
+
+    const taken$ = s$.pipe(takeWhile((x) => x < 3));
+
+    const mut_events: string[] = [];
+
+    taken$.subscribe(
+      (x) => {
+        mut_events.push(`next ${x}`);
+      },
+      () => {
+        mut_events.push('complete');
+      },
+    );
+
+    assert.isTrue(taken$.isCompleted);
+
+    setS(1);
+
+    assert.deepStrictEqual(mut_events, ['complete']);
+  });
+
+  test('keeps taking after an initial value that passes the predicate', () => {
+    const [s$, setS] = createState(1);
+
+    const taken$ = s$.pipe(takeWhile((x) => x < 3));
+
+    const mut_history: number[] = [];
+
+    taken$.subscribe((x) => {
+      mut_history.push(x);
+    });
+
+    setS(2);
+
+    assert.isFalse(taken$.isCompleted);
+
+    setS(5);
+
+    assert.isTrue(taken$.isCompleted);
+
+    setS(1);
+
+    assert.deepStrictEqual(mut_history, [1, 2]);
+  });
+});

package/src/core/operators/throttle.mts

@@ -139,14 +139,15 @@ class ThrottleObservableClass<A>
       return; // skip update
     }
 
-    this.setNext(sn.value, updateToken);
-
+    // The window opens before `setNext`, which can lead back here: a value a
+    // subscriber writes to the parent falls inside it.
     this.#mut_isSkipping = true;
 
-    // set timer
     this.#mut_timerId = setTimeout(() => {
       this.#mut_isSkipping = false;
     }, this.#milliSeconds);
+
+    this.setNext(sn.value, updateToken);
   }
 
   protected override teardown(): void {

package/src/core/operators/with-buffered-from.mts

@@ -5,7 +5,8 @@
 // @sumi-expect-error-file banned-syntax/no-this
 // @sumi-expect-error-file functions/prefer-arrow-function
 // @sumi-expect-error-file mutation/no-mutation-without-mut-prefix
-import { Arr, Optional, pipe } from 'ts-data-forge';
+import { Optional, pipe } from 'ts-data-forge';
+import * as Arr from 'ts-data-forge/array';
 import { SyncChildObservableClass } from '../class/index.mjs';
 import type {
   KeepInitialValueOperator,
@@ -93,11 +94,13 @@ class WithBufferedFromObservableClass<A, B>
   #mut_bufferedValues: readonly B[];
 
   constructor(parentObservable: Observable<A>, observable: Observable<B>) {
+    const parentSnapshot = parentObservable.getSnapshot();
+
     super({
       parents: [parentObservable],
       depth: 1 + maxDepth([parentObservable, observable]),
       initialValue: pipe({
-        par: parentObservable.getSnapshot(),
+        par: parentSnapshot,
         me: observable.getSnapshot(),
       }).map(({ par, me }) =>
         Optional.isNone(par)
@@ -115,6 +118,12 @@ class WithBufferedFromObservableClass<A, B>
       this.#mut_bufferedValues = Arr.toPushed(this.#mut_bufferedValues, value);
     });
 
+    // `subscribe` has just pushed the buffered observable's current value,
+    // which the initial tuple already carries.
+    if (Optional.isSome(parentSnapshot)) {
+      this.#mut_bufferedValues = [];
+    }
+
     this.attach();
   }
 
@@ -127,9 +136,13 @@ class WithBufferedFromObservableClass<A, B>
       return; // skip update
     }
 
-    this.setNext([sn.value, this.#mut_bufferedValues], updateToken);
+    const buffered = this.#mut_bufferedValues;
 
+    // Emptied before `setNext`, which can lead back here: a value a subscriber
+    // writes to the buffered observable belongs to the next batch.
     this.#mut_bufferedValues = [];
+
+    this.setNext([sn.value, buffered], updateToken);
   }
 
   protected override teardown(): void {

package/src/core/operators/with-buffered-from.test.mts

@@ -1,3 +1,4 @@
+import { createState } from '../../utils/index.mjs';
 import { toNode } from '../class/index.mjs';
 import { source } from '../create/index.mjs';
 import { withBufferedFrom } from './with-buffered-from.mjs';
@@ -55,3 +56,29 @@ describe('withBufferedFrom teardown', () => {
     assert.deepStrictEqual(mut_history, [[1, ['A', 'B']]]);
   });
 });
+
+describe('withBufferedFrom initial value', () => {
+  test('reports the current value of the buffered observable once when both hold one (#2767)', () => {
+    const [data$] = createState('x');
+
+    const [trigger$, setTrigger] = createState(0);
+
+    const result$ = trigger$.pipe(withBufferedFrom(data$));
+
+    const mut_history: (readonly [number, readonly string[]])[] = [];
+
+    result$.subscribe((v) => {
+      mut_history.push(v);
+    });
+
+    setTrigger(1);
+
+    setTrigger(2);
+
+    assert.deepStrictEqual(mut_history, [
+      [0, ['x']],
+      [1, []],
+      [2, []],
+    ]);
+  });
+});

package/src/core/predefined/operators/attach-index.mts

@@ -5,7 +5,7 @@
 // @sumi-expect-error-file banned-syntax/no-this
 // @sumi-expect-error-file functions/prefer-arrow-function
 // @sumi-expect-error-file mutation/no-mutation-without-mut-prefix
-import { Optional, SafeUint, asSafeUint } from 'ts-data-forge';
+import { Optional, asSafeUint, type SafeUint } from 'ts-data-forge';
 import { SyncChildObservableClass } from '../../class/index.mjs';
 import type {
   KeepInitialValueOperator,
@@ -112,8 +112,7 @@ class WithIndexObservableClass<A> extends SyncChildObservableClass<
       return; // skip update
     }
 
-    this.#mut_index =
-      this.#mut_index === -1 ? asSafeUint(0) : SafeUint.add(1, this.#mut_index);
+    this.#mut_index = asSafeUint(this.#mut_index + 1);
 
     this.setNext([this.#mut_index, sn.value], updateToken);
   }