@adobe/spacecat-shared-athena-client 1.0.3 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-athena-client-v1.1.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.0.4...@adobe/spacecat-shared-athena-client-v1.1.0) (2025-07-18)
+
+
+### Features
+
+* add traffic queries for traffic analysis to shared location ([#847](https://github.com/adobe/spacecat-shared/issues/847)) ([4eecc72](https://github.com/adobe/spacecat-shared/commit/4eecc7289ba630e37fea923262b13e70528ce250))
+
+# [@adobe/spacecat-shared-athena-client-v1.0.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.0.3...@adobe/spacecat-shared-athena-client-v1.0.4) (2025-07-15)
+
+
+### Bug Fixes
+
+* add pagination for athena ([#848](https://github.com/adobe/spacecat-shared/issues/848)) ([2007cfa](https://github.com/adobe/spacecat-shared/commit/2007cfad79f1921ad015c9c0301cf790f9b9405d))
+
 # [@adobe/spacecat-shared-athena-client-v1.0.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.0.2...@adobe/spacecat-shared-athena-client-v1.0.3) (2025-07-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-athena-client",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Shared modules of the Spacecat Services - AWS Athena Client",
   "type": "module",
   "engines": {

package/src/index.js

@@ -14,8 +14,8 @@ import {
   AthenaClient,
   StartQueryExecutionCommand,
   GetQueryExecutionCommand,
-  GetQueryResultsCommand,
   QueryExecutionState,
+  paginateGetQueryResults,
 } from '@aws-sdk/client-athena';
 import { instrumentAWSClient, hasText } from '@adobe/spacecat-shared-utils';
 
@@ -220,29 +220,40 @@ export class AWSAthenaClient {
    * @returns {Promise<Array>} – Parsed query results
    */
   async query(sql, database, description = 'Athena query', opts = {}) {
-    const {
-      backoffMs = this.backoffMs,
-      maxRetries = this.maxRetries,
-      pollIntervalMs = this.pollIntervalMs,
-      maxPollAttempts = this.maxPollAttempts,
-    } = opts;
+    const queryExecutionId = await this.execute(sql, database, description, opts);
 
-    this.log.info(`[Athena Client] Executing: ${description}`);
+    this.log.debug(`[Athena Client] Fetching paginated results for QueryExecutionId=${queryExecutionId}`);
 
-    const queryExecutionId = await this.#startQueryWithRetry(
-      sql,
-      database,
-      description,
-      backoffMs,
-      maxRetries,
-    );
+    const paginationConfig = {
+      client: this.client,
+    };
 
-    await this.#pollToCompletion(queryExecutionId, description, pollIntervalMs, maxPollAttempts);
+    const input = {
+      QueryExecutionId: queryExecutionId,
+    };
 
-    const results = await this.client.send(
-      new GetQueryResultsCommand({ QueryExecutionId: queryExecutionId }),
-    );
+    const paginator = paginateGetQueryResults(paginationConfig, input);
+
+    const allResults = [];
+    let pageCount = 0;
+    let totalRows = 0;
 
-    return AWSAthenaClient.#parseAthenaResults(results);
+    /* c8 ignore start */
+    for await (const page of paginator) {
+      pageCount += 1;
+      const pageRows = page.ResultSet?.Rows?.length || 0;
+      totalRows += pageRows;
+
+      this.log.debug(`[Athena Client] Processing page ${pageCount} with ${pageRows} rows`);
+
+      const pageResults = AWSAthenaClient.#parseAthenaResults(page);
+      allResults.push(...pageResults);
+    }
+    /* c8 ignore stop */
+
+    this.log.info(`[Athena Client] Fetched ${totalRows} total rows across ${pageCount} pages`);
+    return allResults;
   }
 }
+
+export { getTrafficAnalysisQuery, getTrafficAnalysisQueryPlaceholders } from './queries.js';

package/src/queries.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import { getStaticContent } from '@adobe/spacecat-shared-utils';
+
+const TRAFIC_ANALYSIS_PATH = 'static/queries/traffic-analysis.sql.tpl';
+
+/**
+ * Loads the traffic analysis query template and applies placeholders.
+ * @param {Object} placeholders - Key-value pairs to replace in the query template.
+ * @param {Object} log - Logger (optional)
+ * @returns {Promise<string|null>} The templated SQL string or null on error.
+ */
+export async function getTrafficAnalysisQuery(placeholders = {}) {
+  return getStaticContent(placeholders, TRAFIC_ANALYSIS_PATH);
+}
+
+/**
+ * Scans the query template and returns a sorted array of unique placeholder (strings).
+ * @returns {Promise<string[]>} Array of unique placeholder keys found in the template.
+ */
+export async function getTrafficAnalysisQueryPlaceholders() {
+  const raw = await getStaticContent({}, TRAFIC_ANALYSIS_PATH);
+  const matches = raw.match(/{{\s*([\w]+)\s*}}/g);
+  return [...new Set((matches).map((m) => m.replace(/{{\s*|\s*}}/g, '')))].sort();
+}

package/static/queries/traffic-analysis.sql.tpl

@@ -0,0 +1,55 @@
+WITH raw AS (
+    SELECT
+        trf_type,
+        path,
+        {{pageTypeCase}},
+        trf_channel,
+        utm_campaign,
+        trf_platform,
+        device,
+        pageviews,
+        clicked,
+        engaged,
+        lcp,
+        cls,
+        inp
+    FROM {{tableName}}
+    WHERE siteid = '{{siteId}}'
+        AND ({{temporalCondition}})
+),
+  
+agg AS (
+    SELECT
+        {{dimensionColumns}},
+        COUNT(*)                          AS row_count,
+        CAST(SUM(pageviews) AS BIGINT)    AS pageviews,
+        CAST(SUM(clicked) AS BIGINT)      AS clicks,
+        CAST(SUM(engaged) AS BIGINT)      AS engagements,
+        approx_percentile(lcp, 0.70)      AS p70_lcp,
+        approx_percentile(cls, 0.70)      AS p70_cls,
+        approx_percentile(inp, 0.70)      AS p70_inp
+    FROM raw
+    GROUP BY
+        {{groupBy}}
+),
+  
+grand_total AS (
+    SELECT CAST(SUM(pageviews) AS BIGINT) AS total_pv FROM agg
+)
+  
+SELECT
+    {{dimensionColumnsPrefixed}},
+    a.pageviews,
+  
+    CAST(a.pageviews AS double) / NULLIF(t.total_pv, 0)            AS pct_pageviews,
+    CAST(a.clicks AS double)      / NULLIF(a.row_count, 0)         AS click_rate,
+    CAST(a.engagements AS double) / NULLIF(a.row_count, 0)         AS engagement_rate,
+    1 - CAST(a.engagements AS double) / NULLIF(a.row_count, 0)     AS bounce_rate,
+  
+    a.p70_lcp,
+    a.p70_cls,
+    a.p70_inp
+  
+FROM agg a
+CROSS JOIN grand_total t
+ORDER BY a.pageviews DESC