@onecx/accelerator 6.26.0 → 6.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onecx/accelerator",
-  "version": "6.26.0",
+  "version": "6.27.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -10,7 +10,7 @@
     "tslib": "^2.6.3",
     "rxjs": "^7.8.1",
     "@nx/devkit": "^20.3.0",
-    "@onecx/nx-migration-utils": "^6.26.0"
+    "@onecx/nx-migration-utils": "^6.27.0"
   },
   "peerDependenciesMeta": {
     "@nx/devkit": {

package/src/index.d.ts

@@ -8,5 +8,6 @@ export * from './lib/utils/date.utils';
 export * from './lib/utils/is-test.utils';
 export * from './lib/utils/normalize-locales.utils';
 export * from './lib/utils/get-normalized-browser-locales.utils';
+export * from './lib/utils/gatherer';
 export * from './lib/utils/ensure-property.utils';
 export * from './lib/utils/get-onecx-shared-recommendations';

package/src/index.js

@@ -11,6 +11,7 @@ tslib_1.__exportStar(require("./lib/utils/date.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/is-test.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/normalize-locales.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/get-normalized-browser-locales.utils"), exports);
+tslib_1.__exportStar(require("./lib/utils/gatherer"), exports);
 tslib_1.__exportStar(require("./lib/utils/ensure-property.utils"), exports);
 tslib_1.__exportStar(require("./lib/utils/get-onecx-shared-recommendations"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/accelerator/src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC;AACjC,uEAA4C;AAC5C,mFAAwD;AACxD,qEAA0C;AAC1C,sEAA2C;AAC3C,iEAAsC;AACtC,iEAAsC;AACtC,oEAAyC;AACzC,8EAAmD;AACnD,2FAAgE;AAChE,4EAAiD;AACjD,uFAA4D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/accelerator/src/index.ts"],"names":[],"mappings":";;;AAAA,4DAAiC;AACjC,uEAA4C;AAC5C,mFAAwD;AACxD,qEAA0C;AAC1C,sEAA2C;AAC3C,iEAAsC;AACtC,iEAAsC;AACtC,oEAAyC;AACzC,8EAAmD;AACnD,2FAAgE;AAChE,+DAAoC;AACpC,4EAAiD;AACjD,uFAA4D"}

package/src/lib/declarations.d.ts

@@ -1,11 +1,35 @@
 declare const topicTabId: object & {
     "@onecx/accelerator": {
+        gatherer: object & {
+            promises: Record<number, Promise<any>[]>;
+        };
+    };
+} & {
+    "@onecx/accelerator": {
+        gatherer: object & {
+            promises: Record<number, Promise<any>[]>;
+        } & {
+            debug: string[];
+        };
+    };
+} & {
+    "@onecx/accelerator": {
+        gatherer: object & {
+            promises: Record<number, Promise<any>[]>;
+        } & {
+            debug: string[];
+        };
         topic: object & {
             useBroadcastChannel: boolean | "V2";
         };
     };
 } & {
     "@onecx/accelerator": {
+        gatherer: object & {
+            promises: Record<number, Promise<any>[]>;
+        } & {
+            debug: string[];
+        };
         topic: object & {
             useBroadcastChannel: boolean | "V2";
         } & {
@@ -14,6 +38,11 @@ declare const topicTabId: object & {
     };
 } & {
     "@onecx/accelerator": {
+        gatherer: object & {
+            promises: Record<number, Promise<any>[]>;
+        } & {
+            debug: string[];
+        };
         topic: object & {
             useBroadcastChannel: boolean | "V2";
         } & {

package/src/lib/declarations.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.acceleratorState = void 0;
 const ensure_property_utils_1 = require("./utils/ensure-property.utils");
-const topicUseBroadcastChannel = (0, ensure_property_utils_1.ensureProperty)(globalThis, ['@onecx/accelerator', 'topic', 'useBroadcastChannel'], 'V2');
+const gatherPromises = (0, ensure_property_utils_1.ensureProperty)(globalThis, ['@onecx/accelerator', 'gatherer', 'promises'], {});
+const gatherDebug = (0, ensure_property_utils_1.ensureProperty)(gatherPromises, ['@onecx/accelerator', 'gatherer', 'debug'], []);
+const topicUseBroadcastChannel = (0, ensure_property_utils_1.ensureProperty)(gatherDebug, ['@onecx/accelerator', 'topic', 'useBroadcastChannel'], 'V2');
 const topicInitDate = (0, ensure_property_utils_1.ensureProperty)(topicUseBroadcastChannel, ['@onecx/accelerator', 'topic', 'initDate'], Date.now());
 const topicTabId = (0, ensure_property_utils_1.ensureProperty)(topicInitDate, ['@onecx/accelerator', 'topic', 'tabId'], Math.ceil(globalThis.performance?.now?.() ?? 0));
 exports.acceleratorState = topicTabId;

package/src/lib/declarations.js.map

@@ -1 +1 @@
-{"version":3,"file":"declarations.js","sourceRoot":"","sources":["../../../../../libs/accelerator/src/lib/declarations.ts"],"names":[],"mappings":";;;AAAA,yEAA8D;AAE9D,MAAM,wBAAwB,GAAG,IAAA,sCAAc,EAAC,UAAoB,EAAE,CAAC,oBAAoB,EAAE,OAAO,EAAE,qBAAqB,CAAC,EAAE,IAAsB,CAAC,CAAA;AACrJ,MAAM,aAAa,GAAG,IAAA,sCAAc,EAAC,wBAAwB,EAAE,CAAC,oBAAoB,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;AACvH,MAAM,UAAU,GAAG,IAAA,sCAAc,EAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;AAEpH,sCAAgB"}
+{"version":3,"file":"declarations.js","sourceRoot":"","sources":["../../../../../libs/accelerator/src/lib/declarations.ts"],"names":[],"mappings":";;;AAAA,yEAA8D;AAE9D,MAAM,cAAc,GAAG,IAAA,sCAAc,EAAC,UAAoB,EAAE,CAAC,oBAAoB,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAyC,CAAC,CAAA;AACtJ,MAAM,WAAW,GAAG,IAAA,sCAAc,EAAC,cAAc,EAAE,CAAC,oBAAoB,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,EAAc,CAAC,CAAA;AAC/G,MAAM,wBAAwB,GAAG,IAAA,sCAAc,EAAC,WAAW,EAAE,CAAC,oBAAoB,EAAE,OAAO,EAAE,qBAAqB,CAAC,EAAE,IAAsB,CAAC,CAAA;AAC5I,MAAM,aAAa,GAAG,IAAA,sCAAc,EAAC,wBAAwB,EAAE,CAAC,oBAAoB,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;AACvH,MAAM,UAAU,GAAG,IAAA,sCAAc,EAAC,aAAa,EAAE,CAAC,oBAAoB,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;AAEpH,sCAAgB"}

package/src/lib/utils/gatherer.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Implementation of the Scatter-Gather pattern.
+ */
+export declare class Gatherer<Request, Response> {
+    private static id;
+    private readonly topic;
+    private readonly ownIds;
+    private readonly topicSub;
+    private readonly topicName;
+    constructor(name: string, version: number, callback: (request: Request) => Promise<Response>);
+    destroy(): void;
+    gather(request: Request): Promise<Response[]>;
+    private logReceivedIfDebug;
+    private logAnsweredIfDebug;
+    private logIfDebug;
+    private isOwnerOfRequest;
+}

package/src/lib/utils/gatherer.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gatherer = void 0;
+const topic_1 = require("../topic/topic");
+const declarations_1 = require("../declarations");
+/**
+ * Implementation of the Scatter-Gather pattern.
+ */
+class Gatherer {
+    static id = 0;
+    topic;
+    ownIds = new Set();
+    topicSub = null;
+    topicName;
+    constructor(name, version, callback) {
+        this.topicName = name;
+        this.logIfDebug(name, `Gatherer ${name}: ${version} created`);
+        this.topic = new topic_1.Topic(name, version, false);
+        // Perform a callback every time a request is received in the topic.
+        this.topicSub = this.topic.subscribe((m) => {
+            if (!this.isOwnerOfRequest(m) && declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises) {
+                this.logReceivedIfDebug(name, version, m);
+                if (!declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises[m.id]) {
+                    console.warn('Expected an array of promises to gather for id ', m.id, ' but the id was not present');
+                    return;
+                }
+                let resolve;
+                declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises[m.id].push(new Promise((r) => {
+                    resolve = r;
+                }));
+                callback(m.request).then((response) => {
+                    resolve(response);
+                    this.logAnsweredIfDebug(name, version, m, response);
+                });
+            }
+        });
+    }
+    destroy() {
+        this.logIfDebug(this.topic.name, `Gatherer ${this.topic.name}: ${this.topic.version} destroyed`);
+        this.topicSub?.unsubscribe();
+        this.topic.destroy();
+        for (const id of this.ownIds) {
+            if (declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises?.[id]) {
+                delete declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises[id];
+            }
+        }
+    }
+    async gather(request) {
+        if (!declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises) {
+            throw new Error('Gatherer is not initialized');
+        }
+        const id = Gatherer.id++;
+        // Save the id to ownIds to prevent processing own requests.
+        this.ownIds.add(id);
+        declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises[id] = [];
+        // Publish the request to the topic.
+        // This will trigger the callback for all instances of gatherer.
+        // Await is crucial here to ensure that promises are created before awaiting them.
+        // See Why Awaiting the Promise Works in dev-docs/topics/scheduling.adoc.
+        const message = { id, request };
+        await this.topic.publish(message);
+        const promises = declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises[id];
+        delete declarations_1.acceleratorState['@onecx/accelerator'].gatherer.promises[id];
+        this.ownIds.delete(id);
+        return Promise.all(promises).then((v) => {
+            this.logIfDebug(this.topicName, 'Finished gathering responses', v);
+            return v;
+        });
+    }
+    logReceivedIfDebug(name, version, m) {
+        this.logIfDebug(name, 'Gatherer ' + name + ': ' + version + ' received request ' + m.request);
+    }
+    logAnsweredIfDebug(name, version, m, response) {
+        this.logIfDebug(name, 'Gatherer ' + name + ': ' + version + ' answered request ' + m.request + ' with response', response);
+    }
+    logIfDebug(name, ...args) {
+        if (declarations_1.acceleratorState['@onecx/accelerator'].gatherer.debug.includes(name)) {
+            console.log(...args);
+        }
+    }
+    isOwnerOfRequest(m) {
+        return this.ownIds.has(m.id);
+    }
+}
+exports.Gatherer = Gatherer;
+//# sourceMappingURL=gatherer.js.map

package/src/lib/utils/gatherer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gatherer.js","sourceRoot":"","sources":["../../../../../../libs/accelerator/src/lib/utils/gatherer.ts"],"names":[],"mappings":";;;AACA,0CAAsC;AAEtC,kDAAkD;AAElD;;GAEG;AACH,MAAa,QAAQ;IACX,MAAM,CAAC,EAAE,GAAG,CAAC,CAAA;IACJ,KAAK,CAAyC;IAC9C,MAAM,GAAG,IAAI,GAAG,EAAU,CAAA;IAC1B,QAAQ,GAAwB,IAAI,CAAA;IACpC,SAAS,CAAQ;IAElC,YAAY,IAAY,EAAE,OAAe,EAAE,QAAiD;QAC1F,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,IAAI,KAAK,OAAO,UAAU,CAAC,CAAA;QAE7D,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAmC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9E,oEAAoE;QACpE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YAEzC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBAC1F,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;gBACzC,IAAI,CAAC,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;oBACpE,OAAO,CAAC,IAAI,CAAC,iDAAiD,EAAE,CAAC,CAAC,EAAE,EAAE,6BAA6B,CAAC,CAAA;oBACpG,OAAM;gBACR,CAAC;gBACD,IAAI,OAAkC,CAAA;gBACtC,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CACjE,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBAChB,OAAO,GAAG,CAAC,CAAA;gBACb,CAAC,CAAC,CACH,CAAA;gBACD,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACpC,OAAO,CAAC,QAAQ,CAAC,CAAA;oBACjB,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAA;gBACrD,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO;QACL,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;QAEhG,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,CAAA;QAC5B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAA;QACpB,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC7B,IAAI,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;gBACnE,OAAO,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;YACrE,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAgB;QAC3B,IAAI,CAAC,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAChD,CAAC;QAED,MAAM,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,CAAA;QACxB,4DAA4D;QAC5D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACnB,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,CAAA;QACjE,oCAAoC;QACpC,gEAAgE;QAChE,kFAAkF;QAClF,yEAAyE;QACzE,MAAM,OAAO,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,CAAA;QAC/B,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACjC,MAAM,QAAQ,GAAG,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAwB,CAAA;QACpG,OAAO,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QACnE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACtB,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACtC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,8BAA8B,EAAE,CAAC,CAAC,CAAA;YAClE,OAAO,CAAC,CAAA;QACV,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,kBAAkB,CAAC,IAAY,EAAE,OAAe,EAAE,CAAmC;QAC3F,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,oBAAoB,GAAG,CAAC,CAAC,OAAO,CAAC,CAAA;IAC/F,CAAC;IAEO,kBAAkB,CAAC,IAAY,EAAE,OAAe,EAAE,CAAmC,EAAE,QAAkB;QAC/G,IAAI,CAAC,UAAU,CACb,IAAI,EACJ,WAAW,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,oBAAoB,GAAG,CAAC,CAAC,OAAO,GAAG,gBAAgB,EACzF,QAAQ,CACT,CAAA;IACH,CAAC;IAEO,UAAU,CAAC,IAAY,EAAE,GAAG,IAAW;QAC7C,IAAI,+BAAgB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACzE,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAA;QACtB,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,CAAmC;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAC9B,CAAC;;AA3FH,4BA4FC"}