Minor Release - Merge pull request #404 from helloextend/CategoryFix

Minor Release - account for url breaking characters
helloextend · Feb 22, 2024 · 6967edb · 6967edb
2 parents 8b52b2b + f0260b9
commit 6967edb
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 6 deletions.
diff --git a/Model/Api/Request/ProductDataBuilder.php b/Model/Api/Request/ProductDataBuilder.php
@@ -266,7 +266,7 @@ private function getCategories(ProductInterface $product): string
                 $names = [];
                 foreach ($pathIds as $id) {
                     if (isset($parentCategories[$id]) && $parentCategories[$id]->getName()) {
-                        $names[] = $parentCategories[$id]->getName();
+                        $names[] = $this->sanitizeCategoryName($parentCategories[$id]->getName());
                     }
                 }
                 $categories[] = implode(self::DELIMITER_CATEGORY, $names);
@@ -276,6 +276,34 @@ private function getCategories(ProductInterface $product): string
         return implode(',', $categories);
     }
 
+    /**
+     * Returns sanitized value for payload
+     *
+     * @param string|null $theString
+     * @return string|null
+     */
+    private function sanitizeCategoryName(?string $theString): ?string
+    {
+        if (!$theString)
+            return null;
+
+        // Use a regular expression to find HTML-encoded sections (e.g., %25)
+        $encodedSectionRegex = '/%[0-9A-Fa-f]{2}/';
+
+        // Decode HTML-encoded values using a callback function
+        $decodedString = preg_replace_callback($encodedSectionRegex, function($match) {
+            return urldecode($match[0]);
+        }, $theString);
+
+        // Replace remaining breaking characters
+        $resultString = str_replace('%', 'pct ', $decodedString);
+        $resultString = str_replace('?', '.', $resultString);
+        $resultString = str_replace('#', '.', $resultString);
+        $resultString = str_replace('&', 'and ', $resultString);
+
+        return $resultString;
+    }
+
     /**
      * Get product image url
      *

diff --git a/etc/config.xml b/etc/config.xml
@@ -2,7 +2,7 @@
     <default>
         <warranty>
             <version>
-               <tag>2.2.8</tag>
+               <tag>2.2.9</tag>
             </version>
             <enableExtend>
                 <enable>0</enable>

diff --git a/view/frontend/web/js/warranty-offers-base.js b/view/frontend/web/js/warranty-offers-base.js
@@ -31,7 +31,7 @@ define([
 
             Extend.buttons.render(this.element.get(0), {
                 referenceId: this.options.productSku,
-                category: this.options.productInfo.category,
+                category: this.sanitizeValue(this.options.productInfo.category),
                 price:this.options.productInfo.price
             });
         },
@@ -47,7 +47,7 @@ define([
 
             Extend.buttons.renderSimpleOffer(this.element.get(0), {
                 referenceId: this.options.productSku,
-                category: this.options.productInfo.category,
+                category: this.sanitizeValue(this.options.productInfo.category),
                 price:this.options.productInfo.price,
                 onAddToCart: function (data) {
                     var warranty = data.plan;
@@ -61,7 +61,30 @@ define([
                 }
             });
         },
+
+        /**
+         * Returns sanitized value for payload
+         * @param {String} theString
+         * @return {string|null}
+         */
+        sanitizeValue: function (theString ) {
+            if (!theString)
+                return;
+
+            // Use a regular expression to find HTML-encoded sections (e.g., %25)
+            var encodedSectionRegex = /%[0-9A-Fa-f]{2}/g;
 
+            // Replace each HTML-encoded section with its decoded equivalent
+            var decodedString = theString.replace(encodedSectionRegex, function(match) {
+                return decodeURIComponent(match);
+            });
+
+            // replace breaking characters
+            var theSanitizedString = decodedString.replace(/%/g, "pct ").replace(/\?/g, ".").replace(/#/g, ".").replace(/&/g, "and");
+
+            return theSanitizedString;
+        },
+
         /**
          * Returns current warranty offers block instance
          *
@@ -86,7 +109,7 @@ define([
                 let activeProduct = {
                     referenceId:productSku,
                     price: product.price,
-                    category: product.category
+                    category: this.sanitizeValue(product.category)
                 };
                 component.setActiveProduct(activeProduct);
             }
@@ -108,7 +131,7 @@ define([
             Extend.modal.open({
                 referenceId: productSku,
                 price:productInfo.price,
-                category:productInfo.category,
+                category: this.sanitizeValue(productInfo.category),
                 onClose: closeCallback.bind(this)
             });
         },