async-reactivity 2.0.1 → 2.0.3

package/lib/computed.js

@@ -10,11 +10,14 @@ var ComputedState;
 class CircularDependencyError extends Error {
 }
 export default class Computed extends Tracker {
+    getter;
+    state = ComputedState.Invalid;
+    dependencies = new Map();
+    computePromise;
+    computePromiseActions;
+    lastComputeAttemptPromise;
     constructor(getter) {
         super();
-        this.state = ComputedState.Invalid;
-        this.dependencies = new Map();
-        this.trackDependency = this.innerTrackDependency.bind(this);
         this.getter = getter;
         this.prepareComputePromise();
     }
@@ -91,6 +94,7 @@ export default class Computed extends Tracker {
         dependency.addDependent(this);
         return dependency.value;
     }
+    trackDependency = this.innerTrackDependency.bind(this);
     finalizeComputing() {
         this.state = ComputedState.Valid;
         this.lastComputeAttemptPromise = undefined;

package/lib/computed.test.js

@@ -0,0 +1,216 @@
+import 'mocha';
+import assert from 'assert';
+import { Computed, Ref } from './index.js';
+describe('computed', function () {
+    it('lazy compute', function () {
+        let gate = false;
+        const a = new Computed(() => {
+            gate = true;
+            return 5;
+        });
+        assert.strictEqual(gate, false);
+        assert.strictEqual(a.value, 5);
+        assert.strictEqual(gate, true);
+    });
+    it('cache', function () {
+        let gate = false;
+        const a = new Computed(() => {
+            gate = true;
+            return 5;
+        });
+        assert.strictEqual(a.value, 5);
+        gate = false;
+        assert.strictEqual(a.value, 5);
+        assert.strictEqual(gate, false);
+    });
+    it('invalidate dependents', function () {
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            return value(a) + 4;
+        });
+        assert.strictEqual(b.value, 9);
+        a.value = 6;
+        assert.strictEqual(b.value, 10);
+    });
+    it('dependents up-to-date', function () {
+        const a = new Ref(5);
+        const b = new Ref(10);
+        let gate;
+        const c = new Computed((value) => {
+            gate = true;
+            return value(a) < 10 ? value(b) : 0;
+        });
+        assert.strictEqual(c.value, 10);
+        a.value = 15;
+        assert.strictEqual(c.value, 0);
+        b.value = 15;
+        gate = false;
+        assert.strictEqual(c.value, 0);
+        assert.strictEqual(gate, false);
+    });
+    it('detect circular dependency', function () {
+        // @ts-expect-error
+        const a = new Computed((value) => {
+            return value(b);
+        });
+        // @ts-expect-error
+        const b = new Computed((value) => {
+            return value(a);
+        });
+        assert.throws(() => a.value);
+    });
+    xit('detect circular deeper dependency', function () {
+        // do not support for better performance
+        assert.fail('not implemented');
+    });
+    it('throw error', function () {
+        const a = new Computed(() => {
+            throw new Error();
+        });
+        assert.throws(() => a.value);
+    });
+    it('ignore same ref value', function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            gate++;
+            return value(a);
+        });
+        assert.strictEqual(b.value, 5);
+        a.value = 5;
+        assert.strictEqual(b.value, 5);
+        assert.strictEqual(gate, 1);
+    });
+    it('ignore same computed value', function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            return value(a) % 2;
+        });
+        const c = new Computed((value) => {
+            gate++;
+            return value(b) + 5;
+        });
+        assert.strictEqual(c.value, 6);
+        a.value = 7;
+        assert.strictEqual(c.value, 6);
+        assert.strictEqual(gate, 1);
+    });
+});
+describe('async computed', function () {
+    it('getter', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            return 5;
+        });
+        assert.strictEqual(await a.value, 5);
+    });
+    it('tracks async dependencies', async function () {
+        const a = new Ref(5);
+        const b = new Computed(async (value) => {
+            await new Promise(resolve => setTimeout(resolve));
+            return value(a) + 5;
+        });
+        assert.strictEqual(await b.value, 10);
+        a.value = 6;
+        assert.strictEqual(await b.value, 11);
+    });
+    it('get value while computing', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            return 5;
+        });
+        a.value;
+        assert.strictEqual(await a.value, 5);
+    });
+    it('detect circular dependency', async function () {
+        // @ts-expect-error
+        const a = new Computed(async (value) => {
+            await new Promise(resolve => setTimeout(resolve));
+            return value(b);
+        });
+        // @ts-expect-error
+        const b = new Computed(async (value) => {
+            await new Promise(resolve => setTimeout(resolve));
+            return value(a);
+        });
+        assert.rejects(async () => await a.value);
+    });
+    it('dependency changed while computing', async function () {
+        const a = new Ref(5);
+        const b = new Computed(async (value) => value(a) + 5);
+        b.value; // trigger compute
+        a.value = 8;
+        assert.strictEqual(await b.value, 13);
+    });
+    it('old dependency changed while computing', async function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Computed(async (value) => {
+            gate++;
+            await new Promise(resolve => setTimeout(resolve));
+            return value(a) + 2;
+        });
+        assert.strictEqual(await b.value, 7);
+        b.invalidate();
+        const promise = b.value;
+        a.value = 6;
+        assert.strictEqual(await promise, 8);
+        assert.strictEqual(gate, 2);
+    });
+    it('new dependency changed while computing', async function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Ref(10);
+        const c = new Computed(async (value) => {
+            gate++;
+            await new Promise(resolve => setTimeout(resolve, 50));
+            let sum = value(a);
+            await new Promise(resolve => setTimeout(resolve, 50));
+            sum += value(b);
+            return sum;
+        });
+        assert.strictEqual(await c.value, 15);
+        c.invalidate();
+        const promise = c.value;
+        await new Promise(resolve => setTimeout(resolve, 60));
+        a.value = 10;
+        assert.strictEqual(await promise, 20);
+        assert.strictEqual(gate, 3);
+    });
+    it('fallback to primitive while computing', async function () {
+        const a = new Ref(5);
+        const b = new Ref(10);
+        const c = new Computed(async (value) => {
+            if (value(a) < 10) {
+                await new Promise(resolve => setTimeout(resolve, 50));
+                return value(b) + 5;
+            }
+            return 2;
+        });
+        const promise = c.value;
+        await new Promise(resolve => setTimeout(resolve, 20));
+        a.value = 10;
+        assert.strictEqual(await promise, 2);
+    });
+    it('throw error', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            throw new Error();
+        });
+        assert.rejects(() => a.value);
+    });
+    it('dispose computed', async function () {
+        const a = new Ref(5);
+        let gate = 0;
+        const b = new Computed(value => {
+            gate++;
+            return value(a) + 2;
+        });
+        b.value;
+        assert.strictEqual(gate, 1);
+        b.dispose();
+        b.value;
+        assert.strictEqual(gate, 2);
+    });
+});

package/lib/ref.js

@@ -1,13 +1,16 @@
 import Tracker from "./tracker.js";
+const defaultIsEqual = (v1, v2) => v1 === v2;
 export default class Ref extends Tracker {
-    constructor(_value) {
+    isEqual;
+    constructor(_value, isEqual = (defaultIsEqual)) {
         super();
         this._value = _value;
+        this.isEqual = isEqual;
     }
     set value(_value) {
         const lastValue = this._value;
         this._value = _value;
-        if (lastValue !== _value) {
+        if (!this.isEqual(lastValue, _value)) {
             this.invalidate();
         }
     }

package/lib/ref.test.js

@@ -0,0 +1,21 @@
+import 'mocha';
+import assert from 'assert';
+import { Ref, Watcher } from './index.js';
+describe('ref', function () {
+    it('getter', function () {
+        const a = new Ref(5);
+        assert.strictEqual(a.value, 5);
+    });
+    it('setter', function () {
+        const a = new Ref(5);
+        a.value = 4;
+        assert.strictEqual(a.value, 4);
+    });
+    it('setter isEqual', function () {
+        const a = new Ref(5, () => true);
+        new Watcher(a, () => {
+            assert.fail();
+        }, false);
+        a.value = 4;
+    });
+});

package/lib/tracker.js

@@ -1,7 +1,6 @@
 export default class Tracker {
-    constructor() {
-        this.dependents = new Set();
-    }
+    dependents = new Set();
+    _value;
     addDependent(dependent) {
         this.dependents.add(dependent);
     }

package/lib/watcher.js

@@ -6,9 +6,11 @@ var WatchState;
 })(WatchState || (WatchState = {}));
 ;
 export default class Watcher extends Tracker {
+    onChange;
+    dependency;
+    state = WatchState.Valid;
     constructor(dependency, onChange, immediate = true) {
         super();
-        this.state = WatchState.Valid;
         this.onChange = onChange;
         this.dependency = dependency;
         dependency.addDependent(this);
@@ -18,13 +20,18 @@ export default class Watcher extends Tracker {
         }
     }
     invalidate() {
-        this.state = WatchState.Uncertain;
-        const oldValue = this._value;
-        this._value = this.dependency.value;
         if (this.state === WatchState.Uncertain) {
-            this.onChange(this._value, oldValue);
-            this.state = WatchState.Valid;
+            return;
         }
+        this.state = WatchState.Uncertain;
+        Promise.resolve().then(() => {
+            const oldValue = this._value;
+            this._value = this.dependency.value;
+            if (this.state === WatchState.Uncertain) {
+                this.onChange(this._value, oldValue);
+                this.state = WatchState.Valid;
+            }
+        });
     }
     validate() {
         this.state = WatchState.Valid;

package/lib/watcher.test.js

@@ -0,0 +1,62 @@
+import 'mocha';
+import assert from 'assert';
+import { Computed, Ref, Watcher } from './index.js';
+describe('watcher', function () {
+    it('sync', function () {
+        const a = new Ref(5);
+        new Watcher(a, (newValue, oldValue) => {
+            assert.strictEqual(oldValue, 5);
+            assert.strictEqual(newValue, 6);
+        }, false);
+        a.value = 6;
+    });
+    it('async', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            return 10;
+        });
+        const result = await new Promise(resolve => new Watcher(a, resolve));
+        assert.strictEqual(result, 10);
+    });
+    it('sync cancel', async function () {
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            return value(a) % 2;
+        });
+        let gate = 0;
+        new Watcher(b, () => {
+            gate++;
+        }, false);
+        a.value = 6;
+        await new Promise(resolve => setTimeout(resolve));
+        assert.strictEqual(gate, 1);
+        a.value = 7;
+        a.value = 9;
+        a.value = 11;
+        await new Promise(resolve => setTimeout(resolve));
+        assert.strictEqual(gate, 2);
+    });
+    it('async sync cancel', async function () {
+        const a = new Ref(5);
+        let computedGate = 0;
+        const b = new Computed(async (value) => {
+            computedGate++;
+            new Promise(resolve => setTimeout(resolve));
+            return value(a) % 2;
+        });
+        let watcherGate = 0;
+        new Watcher(b, () => {
+            watcherGate++;
+        }, false);
+        await new Promise(resolve => setTimeout(resolve, 10));
+        a.value = 6;
+        await new Promise(resolve => setTimeout(resolve, 10));
+        assert.strictEqual(computedGate, 2);
+        assert.strictEqual(watcherGate, 1);
+        a.value = 7;
+        a.value = 9;
+        await new Promise(resolve => setTimeout(resolve, 10));
+        assert.strictEqual(computedGate, 3);
+        assert.strictEqual(watcherGate, 2);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "async-reactivity",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
@@ -22,9 +22,9 @@
   "author": "Donatas Lučiūnas",
   "license": "ISC",
   "devDependencies": {
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.10.5",
-    "mocha": "^10.2.0",
-    "typescript": "^5.3.3"
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^20.14.10",
+    "mocha": "^10.6.0",
+    "typescript": "^5.5.3"
   }
 }

package/src/computed.test.ts

@@ -0,0 +1,244 @@
+import 'mocha';
+import assert from 'assert';
+import { Computed, Ref } from './index.js';
+
+describe('computed', function () {
+    it('lazy compute', function () {
+        let gate = false;
+        const a = new Computed(() => {
+            gate = true;
+            return 5;
+        });
+
+        assert.strictEqual(gate, false);
+        assert.strictEqual(a.value, 5);
+        assert.strictEqual(gate, true);
+    });
+
+    it('cache', function () {
+        let gate = false;
+        const a = new Computed(() => {
+            gate = true;
+            return 5;
+        });
+
+        assert.strictEqual(a.value, 5);
+
+        gate = false;
+        assert.strictEqual(a.value, 5);
+        assert.strictEqual(gate, false);
+    });
+
+    it('invalidate dependents', function () {
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            return value(a) + 4;
+        });
+        assert.strictEqual(b.value, 9);
+        a.value = 6;
+        assert.strictEqual(b.value, 10);
+    });
+
+    it('dependents up-to-date', function () {
+        const a = new Ref(5);
+        const b = new Ref(10);
+        let gate;
+        const c = new Computed((value) => {
+            gate = true;
+            return value(a) < 10 ? value(b) : 0;
+        });
+        assert.strictEqual(c.value, 10);
+        a.value = 15;
+        assert.strictEqual(c.value, 0);
+        b.value = 15;
+        gate = false;
+        assert.strictEqual(c.value, 0);
+        assert.strictEqual(gate, false);
+    });
+
+    it('detect circular dependency', function () {
+        // @ts-expect-error
+        const a = new Computed((value) => {
+            return value(b);
+        });
+        // @ts-expect-error
+        const b = new Computed((value) => {
+            return value(a);
+        });
+        assert.throws(() => a.value);
+    });
+
+    xit('detect circular deeper dependency', function () {
+        // do not support for better performance
+        assert.fail('not implemented');
+    });
+
+    it('throw error', function () {
+        const a = new Computed(() => {
+            throw new Error();
+        });
+        assert.throws(() => a.value);
+    });
+
+    it('ignore same ref value', function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            gate++;
+            return value(a);
+        });
+
+        assert.strictEqual(b.value, 5);
+
+        a.value = 5;
+        assert.strictEqual(b.value, 5);
+        assert.strictEqual(gate, 1);
+    });
+
+    it('ignore same computed value', function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Computed((value) => {
+            return value(a) % 2;
+        });
+        const c = new Computed((value) => {
+            gate++;
+            return value(b) + 5;
+        });
+
+        assert.strictEqual(c.value, 6);
+
+        a.value = 7;
+        assert.strictEqual(c.value, 6);
+        assert.strictEqual(gate, 1);
+    });
+});
+
+describe('async computed', function () {
+    it('getter', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            return 5;
+        });
+        assert.strictEqual(await a.value, 5);
+    });
+
+    it('tracks async dependencies', async function () {
+        const a = new Ref(5);
+        const b = new Computed(async (value) => {
+            await new Promise(resolve => setTimeout(resolve));
+            return value(a) + 5;
+        });
+        assert.strictEqual(await b.value, 10);
+        a.value = 6;
+        assert.strictEqual(await b.value, 11);
+    });
+
+    it('get value while computing', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            return 5;
+        });
+
+        a.value;
+        assert.strictEqual(await a.value, 5);
+    });
+
+    it('detect circular dependency', async function () {
+        // @ts-expect-error
+        const a = new Computed(async (value) => {
+            await new Promise(resolve => setTimeout(resolve));
+            return value(b);
+        });
+        // @ts-expect-error
+        const b = new Computed(async (value) => {
+            await new Promise(resolve => setTimeout(resolve));
+            return value(a);
+        });
+
+        assert.rejects(async () => await a.value);
+    });
+
+    it('dependency changed while computing', async function () {
+        const a = new Ref(5);
+        const b = new Computed(async (value) => value(a) + 5);
+        b.value;            // trigger compute
+        a.value = 8;
+        assert.strictEqual(await b.value, 13);
+    });
+
+    it('old dependency changed while computing', async function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Computed(async (value) => {
+            gate++;
+            await new Promise(resolve => setTimeout(resolve));
+            return value(a) + 2;
+        });
+        assert.strictEqual(await b.value, 7);
+        b.invalidate();
+        const promise = b.value;
+        a.value = 6;
+        assert.strictEqual(await promise, 8);
+        assert.strictEqual(gate, 2);
+    });
+
+    it('new dependency changed while computing', async function () {
+        let gate = 0;
+        const a = new Ref(5);
+        const b = new Ref(10);
+        const c = new Computed(async (value) => {
+            gate++;
+            await new Promise(resolve => setTimeout(resolve, 50));
+            let sum = value(a);
+            await new Promise(resolve => setTimeout(resolve, 50));
+            sum += value(b);
+            return sum;
+        });
+        assert.strictEqual(await c.value, 15);
+        c.invalidate();
+        const promise = c.value;
+        await new Promise(resolve => setTimeout(resolve, 60));
+        a.value = 10;
+        assert.strictEqual(await promise, 20);
+        assert.strictEqual(gate, 3);
+    });
+
+    it('fallback to primitive while computing', async function () {
+        const a = new Ref(5);
+        const b = new Ref(10);
+        const c = new Computed(async (value) => {
+            if (value(a) < 10) {
+                await new Promise(resolve => setTimeout(resolve, 50));
+                return value(b) + 5;
+            }
+            return 2;
+        });
+        const promise = c.value;
+        await new Promise(resolve => setTimeout(resolve, 20));
+        a.value = 10;
+        assert.strictEqual(await promise, 2);
+    });
+
+    it('throw error', async function () {
+        const a = new Computed(async () => {
+            await new Promise(resolve => setTimeout(resolve));
+            throw new Error();
+        });
+        assert.rejects(() => a.value);
+    });
+
+    it('dispose computed', async function () {
+        const a = new Ref(5);
+        let gate = 0;
+        const b = new Computed(value => {
+            gate++;
+            return value(a) + 2;
+        });
+        b.value;
+        assert.strictEqual(gate, 1);
+        b.dispose();
+        b.value;
+        assert.strictEqual(gate, 2);
+    });
+});

package/src/ref.test.ts

@@ -0,0 +1,24 @@
+import 'mocha';
+import assert from 'assert';
+import { Ref, Watcher } from './index.js';
+
+describe('ref', function () {
+    it('getter', function () {
+        const a = new Ref(5);
+        assert.strictEqual(a.value, 5);
+    });
+
+    it('setter', function () {
+        const a = new Ref(5);
+        a.value = 4;
+        assert.strictEqual(a.value, 4);
+    });
+
+    it('setter isEqual', function () {
+        const a = new Ref(5, () => true);
+        new Watcher(a, () => {
+            assert.fail();
+        }, false);
+        a.value = 4;
+    });
+});