async-reactivity 2.0.21 → 2.0.23

package/lib/computed.js

@@ -9,7 +9,6 @@ var ComputedState;
     ComputedState[ComputedState["Uncertain"] = 2] = "Uncertain";
     ComputedState[ComputedState["Computing"] = 3] = "Computing";
 })(ComputedState || (ComputedState = {}));
-;
 class CircularDependencyError extends Error {
 }
 export default class Computed extends Tracker {
@@ -21,6 +20,7 @@ export default class Computed extends Tracker {
     computePromiseActions;
     lastComputeAttemptPromise;
     deferrer;
+    abortController;
     constructor(getter, isEqual = (defaultIsEqual), timeToLive) {
         super();
         this.getter = getter;
@@ -70,9 +70,13 @@ export default class Computed extends Tracker {
                 return this._value;
             }
         }
+        else if (this.state === ComputedState.Computing) {
+            this.abortController?.abort();
+        }
         this.state = ComputedState.Computing;
         this.clearDependencies(true);
-        const newValue = this.getter(this.trackDependency, this._value);
+        this.abortController = new AbortController();
+        const newValue = this.getter(this.trackDependency, this._value, this.abortController.signal);
         if (this.isEqual(newValue, this._value)) {
             this.handlePromiseThen(this.lastComputeAttemptPromise, this._value);
             this.validateDependents();
@@ -120,6 +124,7 @@ export default class Computed extends Tracker {
     finalizeComputing() {
         this.state = ComputedState.Valid;
         this.lastComputeAttemptPromise = undefined;
+        this.abortController = undefined;
         this.prepareComputePromise();
     }
     invalidate() {
@@ -134,7 +139,9 @@ export default class Computed extends Tracker {
     }
     forceInvalidate() {
         this.invalidate();
-        this.state = ComputedState.Invalid;
+        if (this.state !== ComputedState.Computing) {
+            this.state = ComputedState.Invalid;
+        }
     }
     validate(dependency) {
         this.dependencies.set(dependency, false);

package/lib/computed.test.js

@@ -130,6 +130,22 @@ describe('computed', function () {
         assert.strictEqual(c.value, 6);
         assert.strictEqual(gate, 2);
     });
+    it('compute and abort when forced', async function () {
+        let gate = 0;
+        const b = new Computed(async (_value, _previousValue, abortSignal) => {
+            await new Promise(resolve => setTimeout(resolve, 10));
+            if (abortSignal.aborted) {
+                gate++;
+                throw new Error();
+            }
+            return 5;
+        });
+        const v = b.value;
+        await new Promise(resolve => setTimeout(resolve, 5));
+        b.forceInvalidate();
+        assert.strictEqual(await v, 5);
+        assert.strictEqual(gate, 1);
+    });
     it('isEqual', function () {
         const a = new Ref(1);
         const b = new Computed((value) => {
@@ -186,6 +202,23 @@ describe('async computed', function () {
         a.value = 8;
         assert.strictEqual(await b.value, 13);
     });
+    it('dependency changed while computing - abortSignal', async function () {
+        const a = new Ref(5);
+        let gate = 0;
+        const b = new Computed(async (value, _previousValue, abortSignal) => {
+            const dep = value(a);
+            await new Promise(resolve => setTimeout(resolve, 10));
+            if (abortSignal.aborted) {
+                throw new Error();
+            }
+            gate++;
+            return dep + 5;
+        });
+        b.value; // trigger compute
+        a.value = 8;
+        await b.value;
+        assert.strictEqual(gate, 1);
+    });
     it('old dependency changed while computing', async function () {
         let gate = 0;
         const a = new Ref(5);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "async-reactivity",
-  "version": "2.0.21",
+  "version": "2.0.23",
   "description": "",
   "main": "lib/index.js",
   "types": "types/index.d.ts",

package/src/computed.test.ts

@@ -153,6 +153,24 @@ describe('computed', function () {
         assert.strictEqual(gate, 2);
     });
 
+    it('compute and abort when forced', async function () {
+        let gate = 0;
+        const b = new Computed(async (_value, _previousValue, abortSignal) => {
+            await new Promise(resolve => setTimeout(resolve, 10));
+            if (abortSignal.aborted) {
+                gate++;
+                throw new Error();
+            }
+            return 5;
+        });
+
+        const v = b.value;
+        await new Promise(resolve => setTimeout(resolve, 5));
+        b.forceInvalidate();
+        assert.strictEqual(await v, 5);
+        assert.strictEqual(gate, 1);
+    });
+
     it('isEqual', function() {
         const a = new Ref(1);
         const b = new Computed((value) => {
@@ -219,6 +237,24 @@ describe('async computed', function () {
         assert.strictEqual(await b.value, 13);
     });
 
+    it('dependency changed while computing - abortSignal', async function () {
+        const a = new Ref(5);
+        let gate = 0;
+        const b = new Computed(async (value, _previousValue, abortSignal) => {
+            const dep = value(a);
+            await new Promise(resolve => setTimeout(resolve, 10));
+            if (abortSignal.aborted) {
+                throw new Error();
+            }
+            gate++;
+            return dep + 5;
+        });
+        b.value;            // trigger compute
+        a.value = 8;
+        await b.value;
+        assert.strictEqual(gate, 1);
+    });
+
     it('old dependency changed while computing', async function () {
         let gate = 0;
         const a = new Ref(5);

package/src/computed.ts

@@ -6,15 +6,15 @@ import { Deferrer } from "./deferrer.js";
 import { debounce } from 'lodash-es';
 
 export declare type TrackValue = <T>(dependency: Dependency<T>) => T;
-export declare type ComputeFunc<T> = (value: TrackValue, previousValue?: T) => T;
-export declare type ComputeFuncScoped<T1, T2> = (value: TrackValue, scope: T1, previousValue?: T2) => T2;
+export declare type ComputeFunc<T> = (value: TrackValue, previousValue: T | undefined, abortSignal: AbortSignal) => T;
+export declare type ComputeFuncScoped<T1, T2> = (value: TrackValue, scope: T1, previousValue: T2 | undefined, abortSignal: AbortSignal) => T2;
 
 enum ComputedState {
     Invalid,
     Valid,
     Uncertain,
     Computing
-};
+}
 
 class CircularDependencyError extends Error { }
 
@@ -27,6 +27,7 @@ export default class Computed<T> extends Tracker<T> implements Dependent, Depend
     private computePromiseActions?: { resolve: Function, reject: Function };
     private lastComputeAttemptPromise?: Promise<void>;
     private deferrer?: Deferrer;
+    private abortController?: AbortController;
 
     constructor(getter: ComputeFunc<T>, isEqual = defaultIsEqual<T>, timeToLive?: number) {
         super();
@@ -80,12 +81,15 @@ export default class Computed<T> extends Tracker<T> implements Dependent, Depend
                 this.validateDependents();
                 return this._value!;
             }
+        } else if (this.state === ComputedState.Computing) {
+            this.abortController?.abort();
         }
 
         this.state = ComputedState.Computing;
         this.clearDependencies(true);
+        this.abortController = new AbortController();
 
-        const newValue: T = this.getter(this.trackDependency, this._value);
+        const newValue: T = this.getter(this.trackDependency, this._value, this.abortController.signal);
         if (this.isEqual(newValue, this._value!)) {
             this.handlePromiseThen(this.lastComputeAttemptPromise!, this._value);
             this.validateDependents();
@@ -137,6 +141,7 @@ export default class Computed<T> extends Tracker<T> implements Dependent, Depend
     private finalizeComputing() {
         this.state = ComputedState.Valid;
         this.lastComputeAttemptPromise = undefined;
+        this.abortController = undefined;
         this.prepareComputePromise();
     }
 
@@ -152,7 +157,9 @@ export default class Computed<T> extends Tracker<T> implements Dependent, Depend
 
     public forceInvalidate() {
         this.invalidate();
-        this.state = ComputedState.Invalid;
+        if (this.state !== ComputedState.Computing) {
+            this.state = ComputedState.Invalid;
+        }
     }
 
     public validate(dependency: Dependency<any>) {

package/types/computed.d.ts

@@ -3,8 +3,8 @@ import Dependent from "./dependent.js";
 import Tracker from "./tracker.js";
 import defaultIsEqual from "./defaultIsEqual.js";
 export declare type TrackValue = <T>(dependency: Dependency<T>) => T;
-export declare type ComputeFunc<T> = (value: TrackValue, previousValue?: T) => T;
-export declare type ComputeFuncScoped<T1, T2> = (value: TrackValue, scope: T1, previousValue?: T2) => T2;
+export declare type ComputeFunc<T> = (value: TrackValue, previousValue: T | undefined, abortSignal: AbortSignal) => T;
+export declare type ComputeFuncScoped<T1, T2> = (value: TrackValue, scope: T1, previousValue: T2 | undefined, abortSignal: AbortSignal) => T2;
 export default class Computed<T> extends Tracker<T> implements Dependent, Dependency<T> {
     getter: ComputeFunc<T>;
     isEqual: typeof defaultIsEqual<T>;
@@ -14,6 +14,7 @@ export default class Computed<T> extends Tracker<T> implements Dependent, Depend
     private computePromiseActions?;
     private lastComputeAttemptPromise?;
     private deferrer?;
+    private abortController?;
     constructor(getter: ComputeFunc<T>, isEqual?: (v1: T, v2: T) => boolean, timeToLive?: number);
     private prepareComputePromise;
     get value(): T;

package/types/computed.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"computed.d.ts","sourceRoot":"","sources":["../src/computed.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAIjD,MAAM,CAAC,OAAO,MAAM,UAAU,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACrE,MAAM,CAAC,OAAO,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AACjF,MAAM,CAAC,OAAO,MAAM,iBAAiB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;AAWzG,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAE,YAAW,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IACnF,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,OAAO,EAAE,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;IAClC,OAAO,CAAC,KAAK,CAAyB;IACtC,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,cAAc,CAAC,CAAe;IACtC,OAAO,CAAC,qBAAqB,CAAC,CAA0C;IACxE,OAAO,CAAC,yBAAyB,CAAC,CAAgB;IAClD,OAAO,CAAC,QAAQ,CAAC,CAAW;gBAEhB,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,OAAO,4BAAoB,EAAE,UAAU,CAAC,EAAE,MAAM;IAepF,OAAO,CAAC,qBAAqB;IAS7B,IAAW,KAAK,IAAI,CAAC,CAMpB;IAED,OAAO,CAAC,OAAO;IA0Cf,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,eAAe,CAAwC;IAE/D,OAAO,CAAC,iBAAiB;IAMlB,UAAU;IAUV,eAAe;IAKf,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC;IAI3C,OAAO,CAAC,kBAAkB;IAMnB,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,gBAAoB,GAAG,IAAI;IAKxE,KAAK;IAQL,OAAO;CAGjB"}
+{"version":3,"file":"computed.d.ts","sourceRoot":"","sources":["../src/computed.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAIjD,MAAM,CAAC,OAAO,MAAM,UAAU,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACrE,MAAM,CAAC,OAAO,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,CAAC,GAAG,SAAS,EAAE,WAAW,EAAE,WAAW,KAAK,CAAC,CAAC;AACtH,MAAM,CAAC,OAAO,MAAM,iBAAiB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,GAAG,SAAS,EAAE,WAAW,EAAE,WAAW,KAAK,EAAE,CAAC;AAW9I,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAE,YAAW,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IACnF,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IACvB,OAAO,EAAE,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;IAClC,OAAO,CAAC,KAAK,CAAyB;IACtC,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,cAAc,CAAC,CAAe;IACtC,OAAO,CAAC,qBAAqB,CAAC,CAA0C;IACxE,OAAO,CAAC,yBAAyB,CAAC,CAAgB;IAClD,OAAO,CAAC,QAAQ,CAAC,CAAW;IAC5B,OAAO,CAAC,eAAe,CAAC,CAAkB;gBAE9B,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,OAAO,4BAAoB,EAAE,UAAU,CAAC,EAAE,MAAM;IAepF,OAAO,CAAC,qBAAqB;IAS7B,IAAW,KAAK,IAAI,CAAC,CAMpB;IAED,OAAO,CAAC,OAAO;IA6Cf,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,eAAe,CAAwC;IAE/D,OAAO,CAAC,iBAAiB;IAOlB,UAAU;IAUV,eAAe;IAOf,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC;IAI3C,OAAO,CAAC,kBAAkB;IAMnB,eAAe,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,gBAAoB,GAAG,IAAI;IAKxE,KAAK;IAQL,OAAO;CAGjB"}