@uwdata/mosaic-core 0.17.0 → 0.19.0

package/dist/src/MosaicClient.js

@@ -0,0 +1,214 @@
+import { throttle } from './util/throttle.js';
+export function isMosaicClient(x) {
+    return x instanceof MosaicClient;
+}
+/**
+ * A Mosaic client is a data consumer that indicates its data needs to a
+ * Mosaic coordinator via the query method. The coordinator is responsible
+ * for issuing queries and returning results to the client.
+ *
+ * The client life-cycle consists of connection to a coordinator,
+ * initialization (potentially involving queries for data schema and summary
+ * statistic information), and then interactive queries that may be driven by
+ * an associated selection. When no longer needed, a client should be
+ * disconnected from the coordinator.
+ *
+ * When enabled, a client will initialize and respond to query update requests.
+ * If disabled, the client will delay initialization and not respond to queries
+ * until enabled again. Disabling a client can improve system performance when
+ * associated interface elements are offscreen or disabled.
+ */
+export class MosaicClient {
+    _filterBy;
+    _requestUpdate;
+    _coordinator;
+    _pending;
+    _enabled;
+    _initialized;
+    _request;
+    /**
+     * Create a new client instance.
+     * @param filterSelection An optional selection to
+     *  interactively filter this client's data. If provided, a coordinator
+     *  will re-query and update the client when the selection updates.
+     */
+    constructor(filterSelection) {
+        this._filterBy = filterSelection;
+        this._requestUpdate = throttle(() => this.requestQuery(), true);
+        this._coordinator = null;
+        this._pending = Promise.resolve();
+        this._enabled = true;
+        this._initialized = false;
+        this._request = null;
+    }
+    /**
+     * @returns this client's connected coordinator.
+     */
+    get coordinator() {
+        return this._coordinator;
+    }
+    /**
+     * Set this client's connected coordinator.
+     */
+    set coordinator(coordinator) {
+        this._coordinator = coordinator;
+    }
+    /**
+     * Return this client's enabled state.
+     */
+    get enabled() {
+        return this._enabled;
+    }
+    /**
+     * Set this client's enabled state;
+     */
+    set enabled(state) {
+        state = !!state; // ensure boolean
+        if (this._enabled !== state) {
+            this._enabled = state;
+            if (state) {
+                if (!this._initialized) {
+                    // initialization includes a query request
+                    this.initialize();
+                }
+                else if (this._request) {
+                    // request query now if requested while disabled
+                    this.requestQuery(this._request === true ? undefined : this._request);
+                }
+                this._request = null;
+            }
+        }
+    }
+    /**
+     * Return a Promise that resolves once the client has updated.
+     */
+    get pending() {
+        return this._pending;
+    }
+    /**
+     * @returns this client's filter selection.
+     */
+    get filterBy() {
+        return this._filterBy;
+    }
+    /**
+     * Return a boolean indicating if the client query can be sped up with
+     * materialized views of pre-aggregated data. Should return true if changes
+     * to the filterBy selection do not change the groupby domain of the client
+     * query.
+     */
+    get filterStable() {
+        return true;
+    }
+    /**
+     * Prepare the client before the `query()` method is called. Subclasses
+     * should override this method as needed, potentially issuing one or more
+     * queries to gather data or metadata needed prior to `query` calls.
+     */
+    async prepare() {
+    }
+    /**
+     * Return a query specifying the data needed by this client.
+     * @param filter The filtering criteria to apply in the query.
+     * @returns The client query
+     */
+    query(filter) {
+        return null;
+    }
+    /**
+     * Called by the coordinator to inform the client that a query is pending.
+     * @returns this
+     */
+    queryPending() {
+        return this;
+    }
+    /**
+     * Called by the coordinator to return a query result.
+     * @param data The query result.
+     * @returns this
+     */
+    queryResult(data) {
+        return this;
+    }
+    /**
+     * Called by the coordinator to report a query execution error.
+     * @param error
+     * @returns this
+     */
+    queryError(error) {
+        // do nothing, the coordinator logs the error
+        return this;
+    }
+    /**
+     * Request the coordinator to execute a query for this client.
+     * If an explicit query is not provided, the client `query` method will
+     * be called, filtered by the current `filterBy` selection. This method has
+     * no effect if the client is not connected to a coordinator. If the client
+     * is connected by currently disabled, the request will be serviced if the
+     * client is later enabled.
+     * @param query The query to request. If unspecified, the query
+     *  will be determined by the client's `query` method and the current
+     *  `filterBy` selection state.
+     */
+    requestQuery(query) {
+        if (this._enabled) {
+            const q = query || this.query(this.filterBy?.predicate(this));
+            return this._coordinator.requestQuery(this, q);
+        }
+        else {
+            this._request = query ?? true;
+            return null;
+        }
+    }
+    /**
+     * Request that the coordinator perform a throttled update of this client
+     * using the default query. Unlike requestQuery, for which every call results
+     * in an executed query, multiple calls to requestUpdate may be consolidated
+     * into a single update. This method has no effect if the client is not
+     * connected to a coordinator. If the client is connected but currently
+     * disabled, the request will be serviced if the client is later enabled.
+     */
+    requestUpdate() {
+        if (this._enabled) {
+            this._requestUpdate();
+        }
+        else {
+            this.requestQuery();
+        }
+    }
+    /**
+     * Reset this client, calling the prepare method and query requests. This
+     * method has no effect if the client is not registered with a coordinator.
+     */
+    initialize() {
+        if (!this._enabled) {
+            // clear flag so we initialize when enabled again
+            this._initialized = false;
+        }
+        else if (this._coordinator) {
+            // if connected, let's initialize
+            this._initialized = true;
+            this._pending = this.prepare().then(() => this.requestQuery());
+        }
+    }
+    /**
+     * Remove this client: disconnect from the coordinator and free up any
+     * resource use. This method has no effect if the client is not connected
+     * to a coordinator.
+     *
+     * If overriding this method in a client subclass, be sure to also
+     * disconnect from the coordinator.
+     */
+    destroy() {
+        this._enabled = false;
+        this.coordinator?.disconnect(this);
+    }
+    /**
+     * Requests a client update, for example to (re-)render an interface
+     * component.
+     */
+    update() {
+        return this;
+    }
+}
+//# sourceMappingURL=MosaicClient.js.map

package/dist/src/MosaicClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MosaicClient.js","sourceRoot":"","sources":["../../src/MosaicClient.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAI9C,MAAM,UAAU,cAAc,CAAC,CAAU;IACvC,OAAO,CAAC,YAAY,YAAY,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,YAAY;IACvB,SAAS,CAAwB;IACjC,cAAc,CAAa;IAC3B,YAAY,CAAqB;IACjC,QAAQ,CAAmB;IAC3B,QAAQ,CAAU;IAClB,YAAY,CAAU;IACtB,QAAQ,CAAyB;IAEjC;;;;;OAKG;IACH,YAAY,eAA2B;QACrC,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,CAAC,CAAC;QAChE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,WAAW,CAAC,WAA+B;QAC7C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO,CAAC,KAAc;QACxB,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,iBAAiB;QAClC,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YACtB,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;oBACvB,0CAA0C;oBAC1C,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,CAAC;qBAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACzB,gDAAgD;oBAChD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACxE,CAAC;gBACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;IACb,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAA0B;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAa;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAY;QACrB,6CAA6C;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CAAC,KAAa;QACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,YAAa,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,KAAK,IAAI,IAAI,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,aAAa;QACX,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,iDAAiD;YACjD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,CAAC;aAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC7B,iCAAiC;YACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/src/Param.d.ts

@@ -0,0 +1,56 @@
+import { AsyncDispatch } from './util/AsyncDispatch.js';
+/**
+ * Test if a value is a Param instance.
+ * @param x The value to test.
+ * @returns True if the input is a Param, false otherwise.
+ */
+export declare function isParam<T>(x: unknown): x is Param<T>;
+/**
+ * Represents a dynamic parameter that dispatches updates
+ * upon parameter changes.
+ */
+export declare class Param<T> extends AsyncDispatch<T> {
+    protected _value?: T;
+    /**
+     * Create a new Param instance.
+     * @param value The initial value of the Param.
+     */
+    constructor(value?: T);
+    /**
+     * Create a new Param instance with the given initial value.
+     * @param value The initial value of the Param.
+     * @returns The new Param instance.
+     */
+    static value<T>(value: T): Param<T>;
+    /**
+     * Create a new Param instance over an array of initial values,
+     * which may contain nested Params.
+     * @param values The initial values of the Param.
+     * @returns The new Param instance.
+     */
+    static array<T>(values: (T | Param<T>)[]): Param<T[]>;
+    /**
+     * The current value of the Param.
+     */
+    get value(): T | undefined;
+    /**
+     * Update the Param value
+     * @param value The new value of the Param.
+     * @param options The update options.
+     * @param options.force A boolean flag indicating if the Param
+     *  should emit a 'value' event even if the internal value is unchanged.
+     * @returns This Param instance.
+     */
+    update(value: T, { force }?: {
+        force?: boolean;
+    }): this;
+    /**
+     * Upon value-typed updates, sets the current value to the input value
+     * immediately prior to the event value being emitted to listeners.
+     * @param type The event type.
+     * @param value The input event value.
+     * @returns The input event value.
+     */
+    willEmit(type: string, value: T): T;
+}
+//# sourceMappingURL=Param.d.ts.map

package/dist/src/Param.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Param.d.ts","sourceRoot":"","sources":["../../src/Param.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAGxD;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAEpD;AAED;;;GAGG;AACH,qBAAa,KAAK,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IAC5C,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAErB;;;OAGG;gBACS,KAAK,CAAC,EAAE,CAAC;IAKrB;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAInC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,GAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;IAanD;;OAEG;IACH,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAEzB;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,IAAI;IAU3D;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC;CAMpC"}

package/dist/src/Param.js

@@ -0,0 +1,89 @@
+import { AsyncDispatch } from './util/AsyncDispatch.js';
+import { distinct } from './util/distinct.js';
+/**
+ * Test if a value is a Param instance.
+ * @param x The value to test.
+ * @returns True if the input is a Param, false otherwise.
+ */
+export function isParam(x) {
+    return x instanceof Param;
+}
+/**
+ * Represents a dynamic parameter that dispatches updates
+ * upon parameter changes.
+ */
+export class Param extends AsyncDispatch {
+    _value;
+    /**
+     * Create a new Param instance.
+     * @param value The initial value of the Param.
+     */
+    constructor(value) {
+        super();
+        this._value = value;
+    }
+    /**
+     * Create a new Param instance with the given initial value.
+     * @param value The initial value of the Param.
+     * @returns The new Param instance.
+     */
+    static value(value) {
+        return new Param(value);
+    }
+    /**
+     * Create a new Param instance over an array of initial values,
+     * which may contain nested Params.
+     * @param values The initial values of the Param.
+     * @returns The new Param instance.
+     */
+    static array(values) {
+        if (values.some(v => isParam(v))) {
+            const p = new Param();
+            const update = () => {
+                p.update(values.map(v => isParam(v) ? v.value : v));
+            };
+            update();
+            values.forEach(v => isParam(v) ? v.addEventListener('value', update) : 0);
+            return p;
+        }
+        return new Param(values);
+    }
+    /**
+     * The current value of the Param.
+     */
+    get value() {
+        return this._value;
+    }
+    /**
+     * Update the Param value
+     * @param value The new value of the Param.
+     * @param options The update options.
+     * @param options.force A boolean flag indicating if the Param
+     *  should emit a 'value' event even if the internal value is unchanged.
+     * @returns This Param instance.
+     */
+    update(value, { force } = {}) {
+        const shouldEmit = distinct(this._value, value) || force;
+        if (shouldEmit) {
+            this.emit('value', value);
+        }
+        else {
+            this.cancel('value');
+        }
+        return this;
+    }
+    /**
+     * Upon value-typed updates, sets the current value to the input value
+     * immediately prior to the event value being emitted to listeners.
+     * @param type The event type.
+     * @param value The input event value.
+     * @returns The input event value.
+     */
+    willEmit(type, value) {
+        if (type === 'value') {
+            this._value = value;
+        }
+        return value;
+    }
+}
+//# sourceMappingURL=Param.js.map

package/dist/src/Param.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Param.js","sourceRoot":"","sources":["../../src/Param.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAI,CAAU;IACnC,OAAO,CAAC,YAAY,KAAK,CAAC;AAC5B,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,KAAS,SAAQ,aAAgB;IAClC,MAAM,CAAK;IAErB;;;OAGG;IACH,YAAY,KAAS;QACnB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAI,KAAQ;QACtB,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAI,MAAsB;QACpC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,IAAI,KAAK,EAAO,CAAC;YAC3B,MAAM,MAAM,GAAG,GAAS,EAAE;gBACxB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,CAAC,CAAC;YACF,MAAM,EAAE,CAAC;YACT,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1E,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,IAAI,KAAK,CAAC,MAAM,CAAe,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAQ,EAAE,EAAE,KAAK,KAA0B,EAAE;QAClD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC;QACzD,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAY,EAAE,KAAQ;QAC7B,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,GAAG,KAAU,CAAC;QAC3B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/src/QueryConsolidator.d.ts

@@ -0,0 +1,11 @@
+import type { Cache, QueryEntry } from './types.js';
+/**
+ * Create a consolidator to combine structurally compatible queries.
+ * @param enqueue Query manager enqueue method
+ * @param cache Client-side query cache (sql -> data)
+ * @returns A consolidator object
+ */
+export declare function consolidator(enqueue: (entry: QueryEntry, priority?: number) => void, cache: Cache): {
+    add(entry: QueryEntry, priority: number): void;
+};
+//# sourceMappingURL=QueryConsolidator.d.ts.map

package/dist/src/QueryConsolidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryConsolidator.d.ts","sourceRoot":"","sources":["../../src/QueryConsolidator.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAa,MAAM,YAAY,CAAC;AAwB/D;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,EACvD,KAAK,EAAE,KAAK;eAmBC,UAAU,YAAY,MAAM,GAAG,IAAI;EAWjD"}

package/dist/src/QueryConsolidator.js

@@ -0,0 +1,249 @@
+import { isAggregateExpression, isColumnRef, isDescribeQuery, isSelectQuery } from '@uwdata/mosaic-sql';
+import { QueryResult } from './util/query-result.js';
+function wait(callback) {
+    if (typeof requestAnimationFrame !== 'undefined') {
+        return requestAnimationFrame(callback);
+    }
+    else if (typeof setImmediate !== 'undefined') {
+        return setImmediate(callback);
+    }
+    else {
+        return setTimeout(callback);
+    }
+}
+/**
+ * Create a consolidator to combine structurally compatible queries.
+ * @param enqueue Query manager enqueue method
+ * @param cache Client-side query cache (sql -> data)
+ * @returns A consolidator object
+ */
+export function consolidator(enqueue, cache) {
+    let pending = [];
+    let id = 0;
+    function run() {
+        // group queries into bundles that can be consolidated
+        const groups = entryGroups(pending, cache);
+        pending = [];
+        id = 0;
+        // build and issue consolidated queries
+        for (const group of groups) {
+            consolidate(group, enqueue);
+            processResults(group, cache);
+        }
+    }
+    return {
+        add(entry, priority) {
+            if (entry.request.type === 'arrow') {
+                // wait one frame, gather an ordered list of queries
+                // only Apache Arrow is supported, so we can project efficiently
+                id ||= wait(() => run());
+                pending.push({ entry, priority, index: pending.length });
+            }
+            else {
+                enqueue(entry, priority);
+            }
+        }
+    };
+}
+/**
+ * Segment query requests into consolidation-compatible groups.
+ * @param entries Query request entries ({ request, result } objects)
+ * @param cache Client-side query cache
+ * @returns An array of grouped entry arrays
+ */
+function entryGroups(entries, cache) {
+    const groups = [];
+    const groupMap = new Map();
+    for (const query of entries) {
+        const { entry: { request } } = query;
+        const key = consolidationKey(request.query, cache);
+        if (!groupMap.has(key)) {
+            const list = [];
+            groups.push(list);
+            groupMap.set(key, list);
+        }
+        groupMap.get(key).push(query);
+    }
+    return groups;
+}
+/**
+ * Generate a key string for query consolidation.
+ * Queries with matching keys are conosolidation-compatible.
+ * If a query is found in the cache, it is exempted from consolidation,
+ * which is indicated by returning the precise query SQL as the key.
+ * @param query The input query.
+ * @param cache The query cache (sql -> data).
+ * @returns a key string
+ */
+function consolidationKey(query, cache) {
+    const sql = `${query}`;
+    if (isSelectQuery(query) && !cache.get(sql)) {
+        if (query._where.length || query._qualify.length || query._having.length ||
+            query._orderby.length || query._distinct) {
+            // bail if query includes clauses that may refer to *derived* columns
+            // that we can't resolve. also do not consolidate distinct queries
+            return sql;
+        }
+        // create a derived query stripped of selections
+        const q = query.clone().setSelect('*');
+        // check group by criteria for compatibility
+        // queries may refer to *derived* columns as group by criteria
+        // we resolve these against the true grouping expressions
+        const groupby = query._groupby;
+        if (groupby.length) {
+            const map = {}; // expression map (alias -> expr)
+            query._select.forEach(({ alias, expr }) => map[alias] = expr);
+            q.setGroupby(groupby.map(e => (isColumnRef(e) && map[e.column]) || e));
+        }
+        else if (query._select.some(e => isAggregateExpression(e.expr))) {
+            // if query is an ungrouped aggregate, add an explicit groupby to
+            // prevent improper consolidation with non-aggregate queries
+            q.setGroupby('ALL');
+        }
+        // key is just the transformed query as SQL
+        return `${q}`;
+    }
+    else {
+        // can not analyze query, simply return as string
+        return sql;
+    }
+}
+/**
+ * Issue queries, consolidating where possible.
+ * @param group Array of bundled query entries
+ * @param enqueue Add entry to query queue
+ */
+function consolidate(group, enqueue) {
+    if (shouldConsolidate(group)) {
+        // issue a single consolidated query
+        enqueue({
+            request: {
+                type: 'arrow',
+                cache: false,
+                query: (group.query = consolidatedQuery(group))
+            },
+            result: (group.result = new QueryResult())
+        });
+    }
+    else {
+        // issue queries directly
+        for (const { entry, priority } of group) {
+            enqueue(entry, priority);
+        }
+    }
+}
+/**
+ * Check if a group contains multiple distinct queries.
+ * @param group Array of bundled query entries
+ * @returns false if group contains a single (possibly repeated) query,
+ *  otherwise true
+ */
+function shouldConsolidate(group) {
+    if (group.length > 1) {
+        const sql = `${group[0].entry.request.query}`;
+        for (let i = 1; i < group.length; ++i) {
+            if (sql !== `${group[i].entry.request.query}`) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+/**
+ * Create a consolidated query for a group.
+ * @param group Array of bundled query entries
+ * @returns A consolidated Query instance
+ */
+function consolidatedQuery(group) {
+    const maps = group.maps = [];
+    const fields = new Map();
+    // gather select fields
+    for (const item of group) {
+        const query = item.entry.request.query;
+        const fieldMap = [];
+        maps.push(fieldMap);
+        for (const { alias, expr } of query._select) {
+            const e = `${expr}`;
+            if (!fields.has(e)) {
+                fields.set(e, [`col${fields.size}`, expr]);
+            }
+            const [name] = fields.get(e);
+            fieldMap.push([name, alias]);
+        }
+    }
+    // use a cloned query as a starting point
+    const query = group[0].entry.request.query.clone();
+    // update group by statement as needed
+    const groupby = query._groupby;
+    if (groupby.length) {
+        const map = {};
+        group.maps[0].forEach(([name, as]) => map[as] = name);
+        query.setGroupby(groupby.map((e) => (isColumnRef(e) && map[e.column]) || e));
+    }
+    // update select statement and return
+    return query.setSelect(Array.from(fields.values()));
+}
+/**
+ * Process query results, dispatch results to original requests
+ * @param group Array of query requests
+ * @param cache Client-side query cache (sql -> data)
+ */
+async function processResults(group, cache) {
+    const { maps, query, result } = group;
+    // exit early if no consolidation performed
+    // in this case results are passed directly
+    if (!maps)
+        return;
+    // await consolidated query result, pass errors if needed
+    let data;
+    try {
+        data = await result;
+    }
+    catch (err) {
+        // pass error to consolidated queries
+        for (const { entry } of group) {
+            entry.result.reject(err);
+        }
+        return;
+    }
+    // extract result for each query in the consolidation group
+    // update cache and pass extract to original issuer
+    const describe = isDescribeQuery(query);
+    group.forEach(({ entry }, index) => {
+        const { request, result } = entry;
+        const map = maps[index];
+        const extract = describe && map ? filterResult(data, map)
+            : map ? projectResult(data, map)
+                : data;
+        if (request.cache) {
+            cache.set(String(request.query), extract);
+        }
+        result.fulfill(extract);
+    });
+}
+/**
+ * Project a consolidated result to a client result
+ * @param data Consolidated query result, as an Arrow Table
+ * @param map Column name map as [source, target] pairs
+ * @returns the projected Apache Arrow table
+ */
+function projectResult(data, map) {
+    return data.select(map.map(x => x[0]), map.map(x => x[1]));
+}
+/**
+ * Filter a consolidated describe query result to a client result
+ * @param data Consolidated query result, as an Arrow Table
+ * @param map Column name map as [source, target] pairs
+ * @returns the filtered table data
+ */
+function filterResult(data, map) {
+    const lookup = new Map(map);
+    const result = [];
+    for (const d of data) {
+        if (lookup.has(d.column_name)) {
+            result.push({ ...d, column_name: lookup.get(d.column_name) });
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=QueryConsolidator.js.map

package/dist/src/QueryConsolidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryConsolidator.js","sourceRoot":"","sources":["../../src/QueryConsolidator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAerD,SAAS,IAAI,CAAC,QAAoB;IAChC,IAAI,OAAO,qBAAqB,KAAK,WAAW,EAAE,CAAC;QACjD,OAAO,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;SAAM,IAAI,OAAO,YAAY,KAAK,WAAW,EAAE,CAAC;QAC/C,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAuD,EACvD,KAAY;IAEZ,IAAI,OAAO,GAAiB,EAAE,CAAC;IAC/B,IAAI,EAAE,GAAY,CAAC,CAAC;IAEpB,SAAS,GAAG;QACV,sDAAsD;QACtD,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3C,OAAO,GAAG,EAAE,CAAC;QACb,EAAE,GAAG,CAAC,CAAC;QAEP,uCAAuC;QACvC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAC5B,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,OAAO;QACL,GAAG,CAAC,KAAiB,EAAE,QAAgB;YACrC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBACnC,oDAAoD;gBACpD,gEAAgE;gBAChE,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,WAAW,CAAC,OAAqB,EAAE,KAAY;IACtD,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAsB,CAAC;IAE/C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC;QACrC,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,GAAe,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClB,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,gBAAgB,CAAC,KAAgB,EAAE,KAAY;IACtD,MAAM,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC;IACvB,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5C,IACE,KAAK,CAAC,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM;YACpE,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,EACxC,CAAC;YACD,qEAAqE;YACrE,kEAAkE;YAClE,OAAO,GAAG,CAAC;QACb,CAAC;QAED,gDAAgD;QAChD,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEvC,4CAA4C;QAC5C,8DAA8D;QAC9D,yDAAyD;QACzD,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC;QAC/B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,GAAG,GAA6B,EAAE,CAAC,CAAC,iCAAiC;YAC3E,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAC9D,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzE,CAAC;aACI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAK,CAAC,CAAC,EAAE,CAAC;YACjE,iEAAiE;YACjE,4DAA4D;YAC5D,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QAED,2CAA2C;QAC3C,OAAO,GAAG,CAAC,EAAE,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,iDAAiD;QACjD,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAClB,KAAiB,EACjB,OAAuD;IAEvD,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,oCAAoC;QACpC,OAAO,CAAC;YACN,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,KAAK;gBACZ,KAAK,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;aAChD;YACD,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;SAC3C,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,yBAAyB;QACzB,KAAK,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,KAAK,EAAE,CAAC;YACxC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,KAAiB;IAC1C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACtC,IAAI,GAAG,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;gBAC9C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,KAAiB;IAC1C,MAAM,IAAI,GAAmC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,GAAG,EAA8B,CAAC;IAErD,uBAAuB;IACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAoB,CAAC;QACtD,MAAM,QAAQ,GAA4B,EAAE,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpB,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAC5C,MAAM,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;YAC7C,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,yCAAyC;IACzC,MAAM,KAAK,GAAI,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAqB,CAAC,KAAK,EAAE,CAAC;IAEpE,sCAAsC;IACtC,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC/B,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QACtD,KAAK,CAAC,UAAU,CACd,OAAO,CAAC,GAAG,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CACrE,CAAC;IACJ,CAAC;IAED,qCAAqC;IACrC,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACtD,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc,CAAC,KAAiB,EAAE,KAAY;IAC3D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAEtC,2CAA2C;IAC3C,2CAA2C;IAC3C,IAAI,CAAC,IAAI;QAAE,OAAO;IAElB,yDAAyD;IACzD,IAAI,IAAW,CAAC;IAChB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,MAAe,CAAC;IAC/B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,qCAAqC;QACrC,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,KAAK,EAAE,CAAC;YAC9B,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QACD,OAAO;IACT,CAAC;IAED,2DAA2D;IAC3D,mDAAmD;IACnD,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAM,CAAC,CAAC;IACzC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE;QACjC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC;YACvD,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC;gBAChC,CAAC,CAAC,IAAI,CAAC;QACT,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,IAAW,EAAE,GAA4B;IAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CAAC,IAAW,EAAE,GAA4B;IAC7D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;QAC/D,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}