@adobe/spacecat-shared-tokowaka-client 1.1.0 → 1.2.0

package/src/mappers/base-mapper.js

@@ -108,7 +108,7 @@ export default class BaseOpportunityMapper {
    */
   // eslint-disable-next-line no-unused-vars
   rollbackPatches(config, suggestionIds, opportunityId) {
-    if (!config || !config.tokowakaOptimizations) {
+    if (!config || !config.patches) {
       return config;
     }
 

package/src/mappers/faq-mapper.js

@@ -205,41 +205,36 @@ export default class FaqMapper extends BaseOpportunityMapper {
 
   /**
    * Removes patches from configuration for FAQ suggestions
-   * FAQ-specific logic: Also removes the heading patch when no FAQ suggestions remain for a URL
+   * FAQ-specific logic: Also removes the heading patch when no FAQ suggestions remain
    * @param {Object} config - Current Tokowaka configuration
    * @param {Array<string>} suggestionIds - Suggestion IDs to remove
    * @param {string} opportunityId - Opportunity ID
    * @returns {Object} - Updated configuration with patches removed
    */
   rollbackPatches(config, suggestionIds, opportunityId) {
-    if (!config || !config.tokowakaOptimizations) {
+    if (!config || !config.patches) {
       return config;
     }
 
     const suggestionIdsSet = new Set(suggestionIds);
     const additionalPatchKeys = [];
 
-    // Analyze each URL to determine if FAQ heading patch should be removed
-    Object.entries(config.tokowakaOptimizations).forEach(([urlPath, optimization]) => {
-      const { patches = [] } = optimization;
-
-      // Find FAQ patches for this opportunity
-      const opportunityPatches = patches.filter((p) => p.opportunityId === opportunityId);
-
-      // Get FAQ suggestion IDs that will remain after rollback (for this URL)
-      const remainingSuggestionIds = opportunityPatches
-        .filter((p) => p.suggestionId && !suggestionIdsSet.has(p.suggestionId))
-        .map((p) => p.suggestionId);
-
-      // If no FAQ suggestions remain for this URL, remove the heading patch too
-      if (remainingSuggestionIds.length === 0) {
-        this.log.debug(`No remaining FAQ suggestions for ${urlPath}, marking heading patch for removal`);
-        // Add heading patch key (opportunityId only, no suggestionId)
-        additionalPatchKeys.push(`${urlPath}:${opportunityId}`);
-      } else {
-        this.log.debug(`${remainingSuggestionIds.length} FAQ suggestions remain for ${urlPath}, keeping heading patch`);
-      }
-    });
+    // Find FAQ patches for this opportunity
+    const opportunityPatches = config.patches.filter((p) => p.opportunityId === opportunityId);
+
+    // Get FAQ suggestion IDs that will remain after rollback
+    const remainingSuggestionIds = opportunityPatches
+      .filter((p) => p.suggestionId && !suggestionIdsSet.has(p.suggestionId))
+      .map((p) => p.suggestionId);
+
+    // If no FAQ suggestions remain, remove the heading patch too
+    if (remainingSuggestionIds.length === 0) {
+      this.log.debug('No remaining FAQ suggestions, marking heading patch for removal');
+      // Add heading patch key (opportunityId only, no suggestionId)
+      additionalPatchKeys.push(opportunityId);
+    } else {
+      this.log.debug(`${remainingSuggestionIds.length} FAQ suggestions remain, keeping heading patch`);
+    }
 
     // Remove FAQ suggestion patches and any orphaned heading patches
     this.log.debug(

package/src/utils/custom-html-utils.js

@@ -81,6 +81,7 @@ async function fetchWithRetry(url, options, maxRetries, retryDelayMs, log, fetch
       await sleep(retryDelayMs);
     }
   }
+  /* c8 ignore next */
   throw new Error(`Failed to fetch ${fetchType} HTML after ${maxRetries} retries`);
 }
 

package/src/utils/patch-utils.js

@@ -67,50 +67,37 @@ export function mergePatches(existingPatches, newPatches) {
 
 /**
  * Removes patches matching the given suggestion IDs from a config
+ * Works with flat config structure
  * @param {Object} config - Tokowaka configuration object
  * @param {Array<string>} suggestionIds - Array of suggestion IDs to remove
  * @param {Array<string>} additionalPatchKeys - Optional array of additional patch keys to remove
  * @returns {Object} - Updated configuration with patches removed
  */
 export function removePatchesBySuggestionIds(config, suggestionIds, additionalPatchKeys = []) {
-  if (!config || !config.tokowakaOptimizations) {
+  if (!config || !config.patches) {
     return config;
   }
 
   const suggestionIdSet = new Set(suggestionIds);
   const patchKeysToRemove = new Set(additionalPatchKeys);
-  const updatedOptimizations = {};
   let removedCount = 0;
 
-  // Iterate through each URL path and filter out patches matching suggestionIds or patch keys
-  Object.entries(config.tokowakaOptimizations).forEach(([urlPath, optimization]) => {
-    const { patches = [] } = optimization;
+  // Filter out patches with matching suggestionIds or additional patch keys
+  const filteredPatches = config.patches.filter((patch) => {
+    const shouldRemoveBySuggestionId = suggestionIdSet.has(patch.suggestionId);
+    const patchKey = getPatchKey(patch);
+    const shouldRemoveByPatchKey = patchKeysToRemove.has(patchKey);
 
-    // Filter out patches with matching suggestionIds or patch keys
-    const filteredPatches = patches.filter((patch) => {
-      const shouldRemoveBySuggestionId = suggestionIdSet.has(patch.suggestionId);
-      const patchKey = `${urlPath}:${getPatchKey(patch)}`;
-      const shouldRemoveByPatchKey = patchKeysToRemove.has(patchKey);
-
-      if (shouldRemoveBySuggestionId || shouldRemoveByPatchKey) {
-        removedCount += 1;
-        return false;
-      }
-      return true;
-    });
-
-    // Only keep URL paths that still have patches
-    if (filteredPatches.length > 0) {
-      updatedOptimizations[urlPath] = {
-        ...optimization,
-        patches: filteredPatches,
-      };
+    if (shouldRemoveBySuggestionId || shouldRemoveByPatchKey) {
+      removedCount += 1;
+      return false;
     }
+    return true;
   });
 
   return {
     ...config,
-    tokowakaOptimizations: updatedOptimizations,
+    patches: filteredPatches,
     removedCount,
   };
 }

package/src/utils/s3-utils.js

@@ -11,14 +11,107 @@
  */
 
 /**
- * Generates S3 path for Tokowaka configuration
- * @param {string} apiKey - Tokowaka API key
+ * Normalizes a URL pathname for S3 storage
+ * - Removes trailing slash (except for root '/')
+ * - Ensures starts with '/'
+ * @param {string} pathname - URL pathname
+ * @returns {string} - Normalized pathname
+ */
+export function normalizePath(pathname) {
+  let normalized = pathname.endsWith('/') && pathname !== '/' ? pathname.slice(0, -1) : pathname;
+
+  if (!normalized.startsWith('/')) {
+    normalized = `/${normalized}`;
+  }
+
+  return normalized;
+}
+
+/**
+ * Extracts and normalizes hostname from URL
+ * - Strips 'www.' prefix
+ * @param {URL} url - URL object
+ * @param {Object} logger - Logger instance
+ * @returns {string} - Normalized hostname
+ * @throws {Error} - If hostname extraction fails
+ */
+export function getHostName(url, logger) {
+  try {
+    const finalHostname = url.hostname.replace(/^www\./, '');
+    return finalHostname;
+  } catch (error) {
+    logger.error(`Error extracting host name: ${error.message}`);
+    throw new Error(`Error extracting host name: ${url.toString()}`);
+  }
+}
+
+/**
+ * Base64 URL encodes a string (RFC 4648)
+ * - Uses URL-safe characters (- instead of +, _ instead of /)
+ * - Removes padding (=)
+ * @param {string} input - String to encode
+ * @returns {string} - Base64 URL encoded string
+ */
+export function base64UrlEncode(input) {
+  // Encode to UTF-8 bytes
+  const bytes = new TextEncoder().encode(input);
+  // Convert bytes → binary string
+  let binary = '';
+  for (let i = 0; i < bytes.length; i += 1) {
+    binary += String.fromCharCode(bytes[i]);
+  }
+  // Standard base64
+  const base64 = btoa(binary);
+  // Convert to base64url (RFC 4648)
+  return base64
+    .replace(/\+/g, '-') // + → -
+    .replace(/\//g, '_') // / → _
+    .replace(/=+$/, ''); // remove padding
+}
+
+/**
+ * Generates S3 path for Tokowaka configuration based on URL
+ * @param {string} url - Full URL (e.g., 'https://www.example.com/products/item')
+ * @param {Object} logger - Logger instance
  * @param {boolean} isPreview - Whether this is a preview path
- * @returns {string} - S3 path
+ * @returns {string} - S3 path (e.g., 'opportunities/example.com/L3Byb2R1Y3RzL2l0ZW0')
+ * @throws {Error} - If URL parsing fails
  */
-export function getTokowakaConfigS3Path(apiKey, isPreview = false) {
-  if (isPreview) {
-    return `preview/opportunities/${apiKey}`;
+export function getTokowakaConfigS3Path(url, logger, isPreview = false) {
+  try {
+    const urlObj = new URL(url);
+    let path = urlObj.pathname;
+
+    path = normalizePath(path);
+    path = base64UrlEncode(path);
+
+    const normalizedHostName = getHostName(urlObj, logger);
+    const prefix = isPreview ? 'preview/opportunities' : 'opportunities';
+
+    return `${prefix}/${normalizedHostName}/${path}`;
+  } catch (error) {
+    logger.error(`Error generating S3 path for URL ${url}: ${error.message}`);
+    throw new Error(`Failed to generate S3 path: ${error.message}`);
+  }
+}
+
+/**
+ * Generates S3 path for domain-level metaconfig
+ * @param {string} url - Full URL (used to extract domain)
+ * @param {Object} logger - Logger instance
+ * @param {boolean} isPreview - Whether this is a preview path
+ * @returns {string} - S3 path for metaconfig (e.g., 'opportunities/example.com/config')
+ * @throws {Error} - If URL parsing fails
+ */
+export function getTokowakaMetaconfigS3Path(url, logger, isPreview = false) {
+  try {
+    const urlObj = new URL(url);
+    const normalizedHostName = getHostName(urlObj, logger);
+    const prefix = isPreview ? 'preview/opportunities' : 'opportunities';
+
+    return `${prefix}/${normalizedHostName}/config`;
+  } catch (error) {
+    logger.error(`Error generating metaconfig S3 path for URL ${url}: ${error.message}`);
+    throw new Error(`Failed to generate metaconfig S3 path: ${error.message}`);
   }
-  return `opportunities/${apiKey}`;
 }