@adobe/spacecat-shared-rum-api-client 2.5.4 → 2.6.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.6.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.5.4...@adobe/spacecat-shared-rum-api-client-v2.6.0) (2024-08-02)
+
+
+### Features
+
+* multi-query support for rum-client ([#311](https://github.com/adobe/spacecat-shared/issues/311)) ([c3ac6a2](https://github.com/adobe/spacecat-shared/commit/c3ac6a20396874d0abffdcdcd50406e9718a426b))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.5.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.5.3...@adobe/spacecat-shared-rum-api-client-v2.5.4) (2024-08-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.5.4",
+  "version": "2.6.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -21,26 +21,40 @@ export interface RUMAPIOptions {
 
 export default class RUMAPIClient {
   /**
-     * Static factory method to create an instance of RUMAPIClient.
-     * @param {UniversalContext} context - An object containing the AWS Lambda context information
-     * @returns An instance of RUMAPIClient.
-     * @remarks This method is designed to create a new instance from an AWS Lambda context.
-     *   The created instance is stored in the Lambda context, and subsequent calls to
-     *   this method will return the singleton instance if previously created.
-     */
+   * Static factory method to create an instance of RUMAPIClient.
+   * @param {UniversalContext} context - An object containing the AWS Lambda context information
+   * @returns An instance of RUMAPIClient.
+   * @remarks This method is designed to create a new instance from an AWS Lambda context.
+   *   The created instance is stored in the Lambda context, and subsequent calls to
+   *   this method will return the singleton instance if previously created.
+   */
   static createFrom(context: UniversalContext): RUMAPIClient;
 
   /**
-     * Constructor for creating an instance of RUMAPIClient.
-     */
+   * Constructor for creating an instance of RUMAPIClient.
+   */
   constructor();
 
   /**
-     * Asynchronous method to run queries against RUM Bundler API.
-     * @param {string} query - Name of the query to run.
-     * @param {RUMAPIOptions} opts - A object containing options for query to run.
-     * @returns A Promise resolving to an object with the query results.
-     * @remarks See the README.md for the available queries.
-     */
+   * Asynchronous method to run queries against RUM Bundler API.
+   * @param {string} query - Name of the query to run.
+   * @param {RUMAPIOptions} opts - A object containing options for query to run.
+   * @returns A Promise resolving to an object with the query results.
+   * @remarks See the README.md for the available queries.
+   */
   query(query: string, opts?: RUMAPIOptions): Promise<object>;
+
+  /**
+   * Asynchronous method to run multiple queries against the data fetched from RUM Bundler API.
+   *
+   * This method makes a single call to the RUM Bundler API to fetch the raw data, then applies
+   * all the requested queries to this raw data. The results are returned in an object where each
+   * key corresponds to a query name and each value contains the result of that query.
+   *
+   * @param {string[]} queries - An array of query names to execute.
+   * @param {RUMAPIOptions} [opts] - Optional object containing options for the queries.
+   * @returns {Promise<object>} A Promise that resolves to an object where each key is the name
+   * of a query, and each value is the result of that query.
+   */
+  queryMulti(queries: string[], opts?: RUMAPIOptions): Promise<object[]>;
 }

package/src/index.js

@@ -49,4 +49,41 @@ export default class RUMAPIClient {
       throw new Error(`Query '${query}' failed. Opts: ${JSON.stringify(opts)}. Reason: ${e.message}`);
     }
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  async queryMulti(queries, opts) {
+    const queryHandlers = [];
+    const allCheckpoints = new Set();
+
+    for (const query of queries) {
+      const { handler, checkpoints = [] } = HANDLERS[query] || {};
+
+      if (!handler) {
+        throw new Error(`Unknown query: ${query}`);
+      }
+
+      queryHandlers.push({ query, handler });
+      checkpoints.forEach((checkpoint) => allCheckpoints.add(checkpoint));
+    }
+
+    try {
+      // Fetch bundles with deduplicated checkpoints
+      const bundles = await fetchBundles({
+        ...opts,
+        checkpoints: [...allCheckpoints],
+      });
+
+      const results = {};
+
+      // Execute each query handler sequentially
+      for (const { query, handler } of queryHandlers) {
+        // eslint-disable-next-line no-await-in-loop
+        results[query] = await handler(bundles);
+      }
+
+      return results;
+    } catch (e) {
+      throw new Error(`Multi query failed. Queries: ${JSON.stringify(queries)}, Opts: ${JSON.stringify(opts)}. Reason: ${e.message}`);
+    }
+  }
 }