All files / src/collections reactiveSet.ts

100% Statements 130/130
100% Branches 39/39
100% Functions 11/11
100% Lines 130/130

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 2092x 2x 2x   2x                       2x       31x 32x 32x               31x 18x 18x 18x 18x 18x 13x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 13x 2x 2x 13x 18x 18x 18x 18x                           31x   31x 31x   31x 1x 3x 3x 1x 31x   31x 7x 7x 3x 7x 2x 2x 7x 2x 2x 4x 4x 2x 2x 2x 2x 2x 2x 5x 7x   31x 44x 40x 40x 40x 12x 12x 12x 12x 40x 40x 40x 40x 44x 44x   31x 13x 10x 10x 7x 7x 7x 10x 3x 3x 3x 3x 10x 10x 10x 13x 13x   31x 3x 2x 2x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 2x 2x 2x 2x 3x     31x     31x     31x     31x     31x 52x 3x 3x 2x 2x 3x 52x 52x 31x                                                       2x  
import { batchFlush, batchStart, type BatchTask, tasks } from "../batch";
import { type EventObject, on, type RemoveListener, send, size } from "../event";
import { writable } from "../readable";
import { type ReadableProvider, type OwnedWritable, type Readable } from "../typings";
import { onDisposeValue, type OnDisposeValue } from "./utils";
 
export interface ReactiveSetChanged<V> {
  readonly upsert: readonly V[];
  readonly delete: readonly V[];
}
 
interface OnChanged<V> extends BatchTask<EventObject<ReactiveSetChanged<V>>> {
  readonly upsert_: Set<V>;
  readonly delete_: Set<V>;
}
 
export class OwnedReactiveSet<V> extends Set<V> implements ReadableProvider<ReadonlyReactiveSet<V>> {
  /**
   * A Readable that emits the set itself whenever it changes.
   */
  public get $(): Readable<ReadonlyReactiveSet<V>> {
    return (this._$ ??= writable(this, { equal: false }));
  }
 
  /**
   * Subscribe to changes in the set.
   *
   * @param fn - The function to call when the set is changed.
   * @returns A disposer function to unsubscribe from the event.
   */
  public onChanged(fn: (changed: ReactiveSetChanged<V>) => void): RemoveListener {
    return on(
      (this._onChanged_ ??= {
        delete_: new Set<V>(),
        upsert_: new Set<V>(),
        task_: () => {
          if (this._onChanged_ && size(this._onChanged_)) {
            const { upsert_, delete_ } = this._onChanged_;
            if (upsert_.size > 0 || delete_.size > 0) {
              const changedData = {
                upsert: [...upsert_],
                delete: [...delete_],
              };
              upsert_.clear();
              delete_.clear();
              send(this._onChanged_, changedData);
            }
          } else {
            this._onChanged_ = null;
          }
        },
      }),
      fn,
    );
  }
 
  /**
   * Subscribe to events when a value is needed to be disposed.
   *
   * A value is considered for disposal when:
   * - it is deleted from the set.
   * - it is replaced by another value (the old value is removed).
   * - it is cleared from the set.
   * - the set is disposed.
   *
   * @param fn - The function to call when a value is needed to be disposed.
   * @returns A disposer function to unsubscribe from the event.
   */
  public readonly onDisposeValue = onDisposeValue;
 
  public constructor(values?: Iterable<V> | null) {
    super();
 
    if (values) {
      for (const value of values) {
        super.add(value);
      }
    }
  }
 
  public dispose(): void {
    if (this._disposed_) return;
    if (process.env.NODE_ENV !== "production") {
      this._disposed_ = new Error("[embra] ReactiveSet disposed at:");
    } else {
      this._disposed_ = true;
    }
    if (this.onDisposeValue_) {
      const { delete_ } = this.onDisposeValue_;
      for (const value of this.values()) {
        delete_.add(value);
      }
      if (delete_.size) {
        const isBatchTop = batchStart();
        tasks.add(this.onDisposeValue_);
        isBatchTop && batchFlush();
      }
    }
    this._$ = this._onChanged_ = this.onDisposeValue_ = null;
  }
 
  public override add(value: V): this {
    if (!this.has(value)) {
      const isBatchTop = batchStart();
      this.onDisposeValue_?.delete_.delete(value);
      if (this._onChanged_) {
        this._onChanged_.upsert_.add(value);
        this._onChanged_.delete_.delete(value);
        tasks.add(this._onChanged_);
      }
      super.add(value);
      this._notify_();
      isBatchTop && batchFlush();
    }
    return this;
  }
 
  public override delete(value: V): boolean {
    if (this.has(value)) {
      const isBatchTop = batchStart();
      if (this.onDisposeValue_) {
        this.onDisposeValue_.delete_.add(value);
        tasks.add(this.onDisposeValue_);
      }
      if (this._onChanged_) {
        this._onChanged_.delete_.add(value);
        this._onChanged_.upsert_.delete(value);
        tasks.add(this._onChanged_);
      }
      this._notify_();
      isBatchTop && batchFlush();
    }
    return super.delete(value);
  }
 
  public override clear(): void {
    if (this.size) {
      const isBatchTop = batchStart();
      if (this.onDisposeValue_ || this._onChanged_) {
        for (const value of this) {
          if (this.onDisposeValue_) {
            this.onDisposeValue_.delete_.add(value);
            tasks.add(this.onDisposeValue_);
          }
          if (this._onChanged_) {
            this._onChanged_.delete_.add(value);
            this._onChanged_.upsert_.delete(value);
            tasks.add(this._onChanged_);
          }
        }
      }
      super.clear();
      this._notify_();
      isBatchTop && batchFlush();
    }
  }
 
  /** @internal */
  private _disposed_?: Error | true;
 
  /** @internal */
  private _$?: OwnedWritable<this> | null;
 
  /** @internal */
  private _onChanged_?: null | OnChanged<V>;
 
  /** @internal */
  public onDisposeValue_?: null | OnDisposeValue<V>;
 
  /** @internal */
  private _notify_() {
    if (this._disposed_) {
      console.error(new Error("disposed"));
      if (process.env.NODE_ENV !== "production") {
        console.error(this._disposed_);
      }
    }
    this._$?.set(this);
  }
}
 
export type ReactiveSet<V> = Omit<OwnedReactiveSet<V>, "dispose">;
 
export interface ReadonlyReactiveSet<V> extends ReadonlySet<V> {
  readonly $: Readable<ReadonlySet<V>>;
  /**
   * Subscribe to changes in the set.
   *
   * @param fn - The function to call when the set is changed.
   * @returns A disposer function to unsubscribe from the event.
   */
  onChanged(fn: (changed: ReactiveSetChanged<V>) => void): RemoveListener;
  /**
   * Subscribe to events when a value is needed to be disposed.
   *
   * A value is considered for disposal when:
   * - it is deleted from the set.
   * - it is replaced by another value (the old value is removed).
   * - it is cleared from the set.
   * - the set is disposed.
   *
   * @param fn - The function to call when a value is needed to be disposed.
   * @returns A disposer function to unsubscribe from the event.
   */
  onDisposeValue(fn: (value: V) => void): RemoveListener;
}
 
export const reactiveSet = <V>(values?: Iterable<V> | null): OwnedReactiveSet<V> => new OwnedReactiveSet(values);