@zajno/common 1.4.4 → 1.4.5

package/src/{observers.ts → observersMap.ts}

@@ -1,23 +1,33 @@
 import { createLogger, ILogger } from './logger';
 import { combineDisposers, IDisposable } from './disposer';
+import { NumberModel } from './viewModels/NumberModel';
 
 type Unsub = () => void;
 
-export class Observers implements IDisposable {
+export class ObserversMap implements IDisposable {
+    /** Unsusbcrobers map: key => unsub fn */
     private readonly _map = new Map<string, () => void>();
+    /** Timeouts map: key => timeout handle */
     private readonly _timeouts = new Map<string, any>();
 
     private readonly _logger: ILogger = null;
+    private readonly _count = new NumberModel();
 
-    constructor(readonly subscribe: (key: string) => Promise<Unsub[]>, readonly name?: string) {
+    constructor(readonly subscribe: null | ((key: string) => Promise<Unsub[]>), readonly name?: string) {
         this._logger = createLogger(`[Observers:${this.name || '?'}]`);
     }
 
+    public get count() { return this._count.value; }
+
     public getIsObserving(key: string) {
         return this._map.has(key);
     }
 
-    public async enable(key: string, enable: boolean, clearAfter: number = null) {
+    public getHasObserveTimeout(key: string) {
+        return this.getIsObserving(key) && this._timeouts.has(key);
+    }
+
+    public async enable(key: string, enable: boolean, clearAfter: number = null, existingUnsubs: Unsub[] = null) {
         if (enable === this.getIsObserving(key)) {
             this.refreshTimeout(key, enable, clearAfter, true);
             return;
@@ -32,13 +42,18 @@ export class Observers implements IDisposable {
 
             this._map.set(key, marker);
 
-            const unsubs = await this.subscribe(key);
+            if (!this.subscribe && !existingUnsubs) {
+                throw new Error('Neither subscribe function nor existingUnsubs has been configured');
+            }
+
+            const unsubs = existingUnsubs || await this.subscribe(key);
             const result = combineDisposers(...unsubs);
 
             if (disabed) { // unsubscribe was requested
                 result();
             } else {
                 this._map.set(key, result);
+                this._count.increment();
                 this.refreshTimeout(key, true, clearAfter);
             }
         } else {
@@ -47,6 +62,7 @@ export class Observers implements IDisposable {
             const unsub = this._map.get(key);
             this._map.delete(key);
             unsub();
+            this._count.decrement();
         }
     }
 
@@ -68,15 +84,22 @@ export class Observers implements IDisposable {
         }
     }
 
-    public dispose() {
+    public clear() {
+        // Clear timeouts
+        for (const t of this._timeouts.values()) {
+            clearTimeout(t);
+        }
+        this._timeouts.clear();
+
+        // Invoke unsubscribers
         for (const u of this._map.values()) {
             u();
         }
         this._map.clear();
+        this._count.setValue(0);
+    }
 
-        for (const t of this._timeouts.values()) {
-            clearTimeout(t);
-        }
-        this._timeouts.clear();
+    public dispose() {
+        this.clear();
     }
 }

package/src/observingCache.ts

@@ -0,0 +1,135 @@
+import { action } from 'mobx';
+import { Disposable } from './disposer';
+import { PromiseCache, DeferredGetter } from './cache';
+import { ObserversMap } from './observersMap';
+import { Fields } from './fields';
+
+export type Unsub = () => void;
+export type Fetcher<T> = (key: string, cb: (val: T) => Promise<void> | void) => Unsub | Promise<Unsub>;
+
+type ObserveStrategy = boolean | 'short' | number;
+
+export interface IObservingCache<T> {
+    get(key: string): DeferredGetter<T>;
+}
+
+export class ObservingCache<T> extends Disposable implements IObservingCache<T> {
+
+    private readonly _cache: PromiseCache<T>;
+    private readonly _observers: ObserversMap;
+
+    private _observeStrategy: ObserveStrategy = null;
+    private readonly _observeStrategyOverrides: Record<string, ObserveStrategy> = { };
+
+    private _updater: Fields.Updater<T> = null;
+
+    constructor(readonly fetcher: Fetcher<T>) {
+        super();
+
+        this._cache = new PromiseCache(this._fetch);
+        this._observers = new ObserversMap(this._subscribe);
+
+        this.disposer.add(this._observers);
+    }
+
+    public get loadingCount() { return this._cache.busyCount; }
+    public get observersCount() { return this._observers.count; }
+
+    useObservingStrategy(observe: ObserveStrategy) {
+        this._observeStrategy = observe;
+        if (!this._observeStrategy) {
+            this._observers.clear();
+        } else {
+            const currentKeys = this._cache.keys();
+            const timeout = getObserveTimeout(this._observeStrategy);
+            currentKeys.forEach(key => this._observers.enable(key, true, timeout));
+        }
+
+        return this;
+    }
+
+    useUpdater(updater: Fields.Updater<T>) {
+        this._updater = updater;
+        this._cache.useObserveItems(updater != null);
+        return this;
+    }
+
+    get(key: string, overrideStrategy?: ObserveStrategy): DeferredGetter<T> {
+        this._observeStrategyOverrides[key] = overrideStrategy;
+
+        const strategy = overrideStrategy || this._observeStrategy;
+        if (strategy && !this._observers.getIsObserving(key)) {
+            // ensure observe
+            if (this._cache.hasKey(key)) {
+                // the request has been initiated already
+                const timeout = getObserveTimeout(strategy);
+                this._observers.enable(key, true, timeout);
+            }
+        }
+
+        return this._cache.getDeferred(key);
+    }
+
+    populate = (key: string, item: T) => {
+        this._updateItem(key, item);
+    };
+
+    private _fetch = async (key: string): Promise<T> => {
+        let firstLoad = true;
+
+        return new Promise<T>((resolve) => {
+            Promise.resolve<Unsub>(
+                this.fetcher(key, item => {
+                    if (firstLoad) {
+                        resolve(item);
+                        firstLoad = false;
+                    } else {
+                        this._updateItem(key, item);
+                    }
+                })
+            ).then(unsub => {
+                const strategy = this._observeStrategyOverrides[key] || this._observeStrategy;
+                if (!strategy) {
+                    // immediate unsub in case no observing strategy has been set
+                    unsub();
+                } else {
+                    const timeout = getObserveTimeout(strategy);
+                    this._observers.enable(key, true, timeout, [unsub]);
+                }
+            });
+        });
+    };
+
+    private _subscribe = (key: string) => {
+        return Promise.all([
+            this.fetcher(key, item => this._updateItem(key, item)),
+        ]);
+    };
+
+    private _updateItem = action((key: string, item: T) => {
+        if (this._updater != null) {
+            const current = this._cache.getCurrent(key, false);
+            if (current != null) {
+                const result = this._updater(current, item);
+                // re-set existing item but with updated contents
+                this._cache.updateValueDirectly(key, result);
+                return;
+            }
+        }
+
+        this._cache.updateValueDirectly(key, item);
+    });
+}
+
+function getObserveTimeout(s: ObserveStrategy) {
+    if (!s) {
+        return undefined;
+    }
+
+    return typeof s === 'number'
+        ? s
+        : (s === 'short'
+            ? 5 * 60 * 1000
+            : null
+        );
+}

package/lib/observers.d.ts

@@ -1,16 +0,0 @@
-import { IDisposable } from './disposer';
-declare type Unsub = () => void;
-export declare class Observers implements IDisposable {
-    readonly subscribe: (key: string) => Promise<Unsub[]>;
-    readonly name?: string;
-    private readonly _map;
-    private readonly _timeouts;
-    private readonly _logger;
-    constructor(subscribe: (key: string) => Promise<Unsub[]>, name?: string);
-    getIsObserving(key: string): boolean;
-    enable(key: string, enable: boolean, clearAfter?: number): Promise<void>;
-    private refreshTimeout;
-    dispose(): void;
-}
-export {};
-//# sourceMappingURL=observers.d.ts.map

package/lib/observers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"observers.d.ts","sourceRoot":"","sources":["../src/observers.ts"],"names":[],"mappings":"AACA,OAAO,EAAoB,WAAW,EAAE,MAAM,YAAY,CAAC;AAE3D,aAAK,KAAK,GAAG,MAAM,IAAI,CAAC;AAExB,qBAAa,SAAU,YAAW,WAAW;IAM7B,QAAQ,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC;IAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM;IALzF,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiC;IACtD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IAEpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;gBAEpB,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,EAAW,IAAI,CAAC,EAAE,MAAM;IAIlF,cAAc,CAAC,GAAG,EAAE,MAAM;IAIpB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAE,MAAa;IAiC3E,OAAO,CAAC,cAAc;IAkBf,OAAO;CAWjB"}

package/lib/observers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"observers.js","sourceRoot":"","sources":["../src/observers.ts"],"names":[],"mappings":";;;AAAA,qCAAiD;AACjD,yCAA2D;AAI3D,MAAa,SAAS;IAMlB,YAAqB,SAA4C,EAAW,IAAa;QAApE,cAAS,GAAT,SAAS,CAAmC;QAAW,SAAI,GAAJ,IAAI,CAAS;QALxE,SAAI,GAAG,IAAI,GAAG,EAAsB,CAAC;QACrC,cAAS,GAAG,IAAI,GAAG,EAAe,CAAC;QAEnC,YAAO,GAAY,IAAI,CAAC;QAGrC,IAAI,CAAC,OAAO,GAAG,qBAAY,CAAC,cAAc,IAAI,CAAC,IAAI,IAAI,GAAG,GAAG,CAAC,CAAC;IACnE,CAAC;IAEM,cAAc,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,MAAe,EAAE,aAAqB,IAAI;QACvE,IAAI,MAAM,KAAK,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;YACrC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;YACnD,OAAO;SACV;QAED,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAErG,+GAA+G;YAC/G,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,MAAM,MAAM,GAAG,GAAG,EAAE,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAEzC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAE3B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACzC,MAAM,MAAM,GAAG,2BAAgB,CAAC,GAAG,MAAM,CAAC,CAAC;YAE3C,IAAI,OAAO,EAAE,EAAE,4BAA4B;gBACvC,MAAM,EAAE,CAAC;aACZ;iBAAM;gBACH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBAC3B,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;aAC9C;SACJ;aAAM;YACH,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;YACrD,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,KAAK,EAAE,CAAC;SACX;IACL,CAAC;IAEO,cAAc,CAAC,GAAW,EAAE,MAAe,EAAE,OAAgB,EAAE,OAAO,GAAG,KAAK;QAClF,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,OAAO,EAAE;YACT,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,IAAI,MAAM,IAAI,OAAO,IAAI,OAAO,IAAI,IAAI,EAAE;YACtC,sHAAsH;YACtH,OAAO;SACV;QAED,IAAI,MAAM,IAAI,OAAO,EAAE;YACnB,MAAM,CAAC,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;YAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SAC9B;IACL,CAAC;IAEM,OAAO;QACV,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE;YAChC,CAAC,EAAE,CAAC;SACP;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAElB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE;YACrC,YAAY,CAAC,CAAC,CAAC,CAAC;SACnB;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAC3B,CAAC;CACJ;AA5ED,8BA4EC"}