@adobe/spacecat-shared-athena-client 1.2.1 → 1.2.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-athena-client-v1.2.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.2.2...@adobe/spacecat-shared-athena-client-v1.2.3) (2025-07-28)
+
+
+### Bug Fixes
+
+* introduce filter on traffic type ([#882](https://github.com/adobe/spacecat-shared/issues/882)) ([df08c60](https://github.com/adobe/spacecat-shared/commit/df08c6066206ba43582104b6be6a6622259cbafc))
+
+# [@adobe/spacecat-shared-athena-client-v1.2.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.2.1...@adobe/spacecat-shared-athena-client-v1.2.2) (2025-07-25)
+
+
+### Bug Fixes
+
+* switch to js template ([#876](https://github.com/adobe/spacecat-shared/issues/876)) ([4e843c6](https://github.com/adobe/spacecat-shared/commit/4e843c66a0d5b0d7d8652c03bb184e9f4253e4ea))
+
 # [@adobe/spacecat-shared-athena-client-v1.2.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.2.0...@adobe/spacecat-shared-athena-client-v1.2.1) (2025-07-24)
 
 

package/package.json

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

package/src/traffic-analysis/queries.js

@@ -9,33 +9,35 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { getStaticContent, getDateRanges } from '@adobe/spacecat-shared-utils';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const currentFile = fileURLToPath(import.meta.url);
-const currentDir = path.dirname(currentFile);
-
-const TRAFFIC_ANALYSIS_PATH = path.resolve(currentDir, '../../static/queries/traffic-analysis.sql.tpl');
+import { getDateRanges } from '@adobe/spacecat-shared-utils';
+import { getTrafficAnalysisTemplate } from './traffic-analysis-template.js';
 
 /**
  * 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.
+ * @returns {string} The templated SQL string.
  */
-export async function getTrafficAnalysisQuery(placeholders = {}) {
-  return getStaticContent(placeholders, TRAFFIC_ANALYSIS_PATH);
+export function getTrafficAnalysisQuery(placeholders = {}) {
+  return getTrafficAnalysisTemplate(placeholders);
 }
 
 /**
- * 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.
+ * Returns a sorted array of unique placeholder keys used in the template.
+ * @returns {string[]} Array of unique placeholder keys found in the template.
  */
-export async function getTrafficAnalysisQueryPlaceholders() {
-  const raw = await getStaticContent({}, TRAFFIC_ANALYSIS_PATH);
-  const matches = raw.match(/{{\s*([\w]+)\s*}}/g);
-  return [...new Set((matches).map((m) => m.replace(/{{\s*|\s*}}/g, '')))].sort();
+export function getTrafficAnalysisQueryPlaceholders() {
+  // Return the known placeholders used in the template
+  return [
+    'dimensionColumns',
+    'dimensionColumnsPrefixed',
+    'groupBy',
+    'pageTypeCase',
+    'siteId',
+    'tableName',
+    'temporalCondition',
+    'trfTypeCondition',
+  ];
 }
 
 /**
@@ -66,11 +68,12 @@ export function buildPageTypeCase(pageTypes, column) {
  * @param {number} params.week - The ISO week number (1–53).
  * @param {number} params.year - The year (e.g. 2025).
  * @param {string} params.siteId - UUID of the site.
- * @param {string[]} [params.dimensions- Dimensions to group by (e.g. ['utm_campaign', 'device']).
+ * @param {string[]} [params.dimensions] - Dimensions to group by (e.g. ['utm_campaign', 'device']).
  * @param {string} params.tableName - The name of the source table.
- *  @param {string} params.pageTypeMatchColumn - The pageTypeMatchColumn of the source table.
+ * @param {string} params.pageTypeMatchColumn - The pageTypeMatchColumn of the source table.
  * @param {Object|null} [params.pageTypes=null] - Optional pageType rules for CASE generation.
- *
+ * @param {string[]|null} [params.trfTypes] - Traffic type to filter by before
+ *  grouping (e.g ['paid']).
  * @returns {Object} Template values for SQL generation.
  */
 export function getTrafficAnalysisQueryPlaceholdersFilled({
@@ -81,6 +84,7 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
   tableName,
   pageTypes = null,
   pageTypeMatchColumn = 'path',
+  trfTypes = null,
 }) {
   if (!week || !year || !siteId || !tableName) {
     throw new Error('Missing required parameters: week, year, siteId, or tableName');
@@ -103,6 +107,12 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
     pageTypeCase = buildPageTypeCase(pageTypes, pageTypeMatchColumn);
   }
 
+  let trfTypeCondition = 'TRUE';
+  if (trfTypes && trfTypes.length > 0) {
+    const quotedTypes = trfTypes.map((type) => `'${type}'`).join(', ');
+    trfTypeCondition = `trf_type IN (${quotedTypes})`;
+  }
+
   return {
     siteId,
     groupBy: dimensionColumns,
@@ -111,5 +121,6 @@ export function getTrafficAnalysisQueryPlaceholdersFilled({
     tableName,
     temporalCondition,
     pageTypeCase,
+    trfTypeCondition,
   };
 }

package/src/traffic-analysis/traffic-analysis-template.js

@@ -0,0 +1,97 @@
+/*
+ * 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.
+ */
+
+/**
+ * Generates the traffic analysis SQL query using template literals.
+ * @param {Object} params - Template parameters
+ * @param {string} params.siteId - Site ID
+ * @param {string} params.tableName - Table name
+ * @param {string} params.temporalCondition - Temporal condition
+ * @param {string} params.dimensionColumns - Dimension columns
+ * @param {string} params.groupBy - Group by clause
+ * @param {string} params.dimensionColumnsPrefixed - Prefixed dimension columns
+ * @param {string} params.pageTypeCase - Page type case statement
+ * @returns {string} The SQL query string
+ */
+export function getTrafficAnalysisTemplate({
+  siteId,
+  tableName,
+  temporalCondition,
+  trfTypeCondition,
+  dimensionColumns,
+  groupBy,
+  dimensionColumnsPrefixed,
+  pageTypeCase,
+}) {
+  return `
+WITH raw AS (
+    SELECT
+        path,
+        ${pageTypeCase},   
+        trf_type,
+        trf_channel,
+        trf_platform,
+        device,
+        utm_source,
+        utm_medium,
+        utm_campaign,
+        referrer,
+        consent,
+        notfound,
+        pageviews,
+        clicked,
+        engaged,
+        latest_scroll,
+        CASE WHEN latest_scroll >= 10000 THEN 1 ELSE 0 END AS engaged_scroll,  
+        lcp,
+        cls,
+        inp
+    FROM ${tableName}
+    WHERE siteid = '${siteId}'
+    AND (${temporalCondition})
+    AND ${trfTypeCondition}
+),
+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,
+        CAST(SUM(engaged_scroll) AS BIGINT) AS engaged_scroll,
+        approx_percentile(latest_scroll, 0.70) AS p70_scroll,
+        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.engaged_scroll,
+    a.p70_scroll,
+    a.p70_lcp,
+    a.p70_cls,
+    a.p70_inp
+FROM agg a
+CROSS JOIN grand_total t
+ORDER BY a.pageviews DESC
+`.trim();
+}

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

@@ -1,59 +0,0 @@
-WITH raw AS (
-    SELECT
-        path,
-        {{pageTypeCase}},   
-        trf_type,
-        trf_channel,
-        trf_platform,
-        device,
-        utm_source,
-        utm_medium,
-        utm_campaign,
-        referrer,
-        consent,
-        notfound,
-        pageviews,
-        clicked,
-        engaged,
-        latest_scroll,
-        CASE WHEN latest_scroll >= 10000 THEN 1 ELSE 0 END AS engaged_scroll,  
-        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,
-        CAST(SUM(engaged_scroll) AS BIGINT) AS engaged_scroll,
-        approx_percentile(latest_scroll, 0.70) AS p70_scroll,
-        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.engaged_scroll,
-    a.p70_scroll,
-    a.p70_lcp,
-    a.p70_cls,
-    a.p70_inp
-FROM agg a
-CROSS JOIN grand_total t
-ORDER BY a.pageviews DESC