[MIG] website_sale_product_brand: Migration to 19.0

Author: Alexgars73

website_sale_product_brand/README.rst

@@ -21,13 +21,13 @@ Product Brand Filtering in Website
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fe--commerce-lightgray.png?logo=github
-    :target: https://github.com/OCA/e-commerce/tree/18.0/website_sale_product_brand
+    :target: https://github.com/OCA/e-commerce/tree/19.0/website_sale_product_brand
     :alt: OCA/e-commerce
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/e-commerce-18-0/e-commerce-18-0-website_sale_product_brand
+    :target: https://translation.odoo-community.org/projects/e-commerce-19-0/e-commerce-19-0-website_sale_product_brand
     :alt: Translate me on Weblate
 .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
-    :target: https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&target_branch=18.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&target_branch=19.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
@@ -84,7 +84,7 @@ Bug Tracker
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/e-commerce/issues>`_.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/OCA/e-commerce/issues/new?body=module:%20website_sale_product_brand%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/e-commerce/issues/new?body=module:%20website_sale_product_brand%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
 
 Do not contact contributors directly about support or help with technical issues.
 
@@ -113,6 +113,10 @@ Contributors
      - Carlos López
      - Pilar Vargas
 
+- `Studio73 <https://www.studio73.es>`__:
+
+     - Alex Garcia <[alex@studio73.es]>
+
 Maintainers
 -----------
 
@@ -126,6 +130,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.
 
-This module is part of the `OCA/e-commerce <https://github.com/OCA/e-commerce/tree/18.0/website_sale_product_brand>`_ project on GitHub.
+This module is part of the `OCA/e-commerce <https://github.com/OCA/e-commerce/tree/19.0/website_sale_product_brand>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

website_sale_product_brand/__manifest__.py

@@ -8,7 +8,7 @@
     "Tecnativa, "
     "Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/e-commerce",
-    "version": "18.0.1.0.0",
+    "version": "19.0.1.0.0",
     "license": "AGPL-3",
     "depends": ["product_brand", "website_sale"],
     "data": [
@@ -18,13 +18,14 @@
         "views/product_brand_views.xml",
         "views/templates.xml",
     ],
-    "demo": [
-        "demo/product_brand_demo.xml",
-        "demo/product_product_demo.xml",
-    ],
     "assets": {
         "web.assets_frontend": [
-            "/website_sale_product_brand/static/src/scss/website_sale_product_brand.scss"
+            "/website_sale_product_brand/static/src/scss/website_sale_product_brand.scss",
+            (
+                "after",
+                "website_sale/static/src/interactions/website_sale.js",
+                "/website_sale_product_brand/static/src/interactions/website_sale_brand_filter.esm.js",
+            ),
         ],
         "web.assets_tests": [
             "/website_sale_product_brand/static/src/js/tour.esm.js",

website_sale_product_brand/controllers/main.py

@@ -2,26 +2,13 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 from odoo import http
+from odoo.fields import Domain
 from odoo.http import request
-from odoo.osv import expression
 
 from odoo.addons.website_sale.controllers.main import QueryURL, WebsiteSale
 
 
 class WebsiteSale(WebsiteSale):
-    def _get_shop_domain(
-        self, search, category, attrib_values, search_in_description=True
-    ):
-        domain = super()._get_shop_domain(
-            search=search,
-            category=category,
-            attrib_values=attrib_values,
-            search_in_description=search_in_description,
-        )
-        # add selected brands to product search domain
-        brands_list = self._get_brand_ids(request.httprequest.args)
-        return self._update_domain(brands_list, domain)
-
     def _update_domain(self, brands_list, domain):
         selected_brand_ids = [int(brand) for brand in brands_list]
         if brands_list:
@@ -49,20 +36,20 @@ def _build_brands_list(
             domain = [("product_ids", "in", search_products.ids)]
         return (
             request.env["product.brand"]
+            .sudo()
             .search(domain)
             .filtered(lambda x: x.products_count > 0)
         )
 
     def _get_shop_domain_no_brands(
-        self, search, category, attrib_values, search_in_description
+        self, search, category, attribute_value_dict, search_in_description
     ):
-        domain = super()._get_shop_domain(
-            search=search,
-            category=category,
-            attrib_values=attrib_values,
+        return super()._get_shop_domain(
+            search,
+            category,
+            attribute_value_dict,
             search_in_description=search_in_description,
         )
-        return domain
 
     def _remove_extra_brands(self, brands, search_products, attrib_values):
         if attrib_values:
@@ -74,35 +61,44 @@ def _remove_extra_brands(self, brands, search_products, attrib_values):
     def _get_search_options(
         self,
         category=None,
-        attrib_values=None,
-        pricelist=None,
+        attribute_value_dict=None,
+        tags=None,
         min_price=0.0,
         max_price=0.0,
         conversion_rate=1,
         **post,
     ):
         res = super()._get_search_options(
             category=category,
-            attrib_values=attrib_values,
-            pricelist=pricelist,
+            attribute_value_dict=attribute_value_dict,
+            tags=tags,
             min_price=min_price,
             max_price=max_price,
             conversion_rate=conversion_rate,
             **post,
         )
-        res["brand"] = request.context.get("brand_id")
+        res["brand_ids"] = request.env.context.get("brand_ids")
         return res
 
     def _get_shop_domain(
-        self, search, category, attrib_values, search_in_description=True
+        self, search, category, attribute_value_dict, search_in_description=True
     ):
         domain = super()._get_shop_domain(
-            search, category, attrib_values, search_in_description=search_in_description
+            search,
+            category,
+            attribute_value_dict,
+            search_in_description=search_in_description,
         )
-        if "brand_id" in request.context:
-            domain = expression.AND(
-                [domain, [("product_brand_id", "=", request.context["brand_id"])]]
+        brand_ids = request.env.context.get("brand_ids") or [
+            int(b)
+            for b in (
+                request.httprequest.args.getlist("brand")
+                or request.httprequest.args.getlist("brand_ids")
             )
+            if b and str(b).isdigit()
+        ]
+        if brand_ids:
+            domain = Domain.AND([domain, [("product_brand_id", "in", brand_ids)]])
         return domain
 
     @http.route(
@@ -129,9 +125,12 @@ def shop(
         brand=None,
         **post,
     ):
-        if brand:
-            context = dict(request.context)
-            context.setdefault("brand_id", int(brand))
+        brands_list = self._get_brand_ids(request.httprequest.args)
+        if brands_list:
+            request.update_context(brand_ids=[int(b) for b in brands_list])
+        elif brand:
+            context = dict(request.env.context)
+            context.setdefault("brand_ids", [int(brand)])
             request.update_context(**context)
         res = super().shop(
             page=page,
@@ -143,19 +142,19 @@ def shop(
             brand=brand,
             **post,
         )
-        # parse selected attributes
-        attrib_list = request.httprequest.args.getlist("attribute_value")
-        attrib_values = res.qcontext["attrib_values"]
-        if attrib_list:
-            post["attribute_value"] = attrib_list
-        # get filtered products
-        products = res.qcontext["products"]
+        qcontext = getattr(res, "qcontext", None) or {}
+        attrib_values = qcontext.get("attrib_values")
+        products = qcontext.get("products")
+        if attrib_values is None or products is None:
+            return res
+        attribute_values = request.httprequest.args.getlist("attribute_values")
+        if attribute_values:
+            post["attribute_values"] = attribute_values
         domain = self._get_shop_domain_no_brands(
             search, category, attrib_values, search_in_description=False
         )
         search_products = request.env["product.template"].search(domain)
         # build brands list
-        brands_list = self._get_brand_ids(request.httprequest.args)
         selected_brand_ids = [int(brand) for brand in brands_list]
         brands = self._build_brands_list(
             selected_brand_ids, search, products, search_products, category
@@ -178,22 +177,16 @@ def shop(
             )
             .ids
         )
-        # keep selected brands in URL
-        keep = QueryURL(
-            "/shop",
-            **self._shop_get_query_url_kwargs(
-                category and int(category), search, min_price, max_price, **post
-            ),
-            brand=brands_list,
-            brand_ids=selected_brand_ids,
-        )
+        keep = qcontext.get("keep")
+        if keep and hasattr(keep, "args"):
+            keep.args["brand"] = brands_list
+            keep.args["brand_ids"] = selected_brand_ids
         # assign values for usage in qweb
-        res.qcontext.update(
+        qcontext.update(
             {
                 "brands": brands,
                 "selected_brand_ids": selected_brand_ids,
                 "attr_valid": attrib_valid_ids,
-                "keep": keep,
             }
         )
         return res

website_sale_product_brand/demo/product_brand_demo.xml

@@ -10,8 +10,8 @@ class ProductTemplate(models.Model):
     def _search_get_detail(self, website, order, options):
         res = super()._search_get_detail(website, order, options)
         domain = res["base_domain"]
-        brand_id = options.get("brand")
-        if brand_id:
-            domain.append([("product_brand_id", "=", brand_id)])
+        brand_ids = options.get("brand_ids")
+        if brand_ids:
+            domain.append([("product_brand_id", "in", brand_ids)])
         res["base_domain"] = domain
         return res

website_sale_product_brand/demo/product_product_demo.xml

@@ -11,3 +11,6 @@
   > - Carlos López
   > - Pilar Vargas
 
+- [Studio73](https://www.studio73.es):
+  > - Alex Garcia <[alex@studio73.es]>
+

website_sale_product_brand/models/product_template.py

@@ -374,7 +374,7 @@ <h1>Product Brand Filtering in Website</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:2866648306719d101a1a7e53c7797ebb0c3f171e68905bf0f627ed69f5f020f4
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/e-commerce/tree/18.0/website_sale_product_brand"><img alt="OCA/e-commerce" src="https://img.shields.io/badge/github-OCA%2Fe--commerce-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/e-commerce-18-0/e-commerce-18-0-website_sale_product_brand"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&amp;target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/e-commerce/tree/19.0/website_sale_product_brand"><img alt="OCA/e-commerce" src="https://img.shields.io/badge/github-OCA%2Fe--commerce-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/e-commerce-19-0/e-commerce-19-0-website_sale_product_brand"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/e-commerce&amp;target_branch=19.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module was written to extend the functionality of product filtering
 on website. It will allow you to filter product based on its brand.</p>
 <p>While shopping online, we have seen various eShops having a feature to
@@ -431,7 +431,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h2>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/e-commerce/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/e-commerce/issues/new?body=module:%20website_sale_product_brand%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/e-commerce/issues/new?body=module:%20website_sale_product_brand%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
@@ -462,6 +462,13 @@ <h3><a class="toc-backref" href="#toc-entry-6">Contributors</a></h3>
 </ul>
 </blockquote>
 </li>
+<li><p class="first"><a class="reference external" href="https://www.studio73.es">Studio73</a>:</p>
+<blockquote>
+<ul class="simple">
+<li>Alex Garcia &lt;[<a class="reference external" href="mailto:alex&#64;studio73.es]">alex&#64;studio73.es]</a>&gt;</li>
+</ul>
+</blockquote>
+</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
@@ -473,7 +480,7 @@ <h3><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h3>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
 mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/e-commerce/tree/18.0/website_sale_product_brand">OCA/e-commerce</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/e-commerce/tree/19.0/website_sale_product_brand">OCA/e-commerce</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>

website_sale_product_brand/readme/CONTRIBUTORS.md

@@ -0,0 +1,54 @@
+import {WebsiteSale} from "@website_sale/interactions/website_sale";
+import {patch} from "@web/core/utils/patch";
+
+patch(WebsiteSale.prototype, {
+    onChangeAttribute(ev) {
+        const container =
+            ev.currentTarget.closest(".o_wsale_products_grid_before_rail") ||
+            ev.currentTarget.closest(".oe_website_sale") ||
+            document;
+        const filters = container.querySelectorAll(
+            "form.js_attributes input:checked, form.js_attributes select"
+        );
+        const attributeValues = new Map();
+        const tags = new Set();
+        const brands = new Set();
+        for (const filter of filters) {
+            if (!filter.value) {
+                continue;
+            }
+            if (filter.name === "attribute_value") {
+                const [attributeId, attributeValueId] = filter.value.split("-");
+                const valueIds = attributeValues.get(attributeId) ?? new Set();
+                valueIds.add(attributeValueId);
+                attributeValues.set(attributeId, valueIds);
+            } else if (filter.name === "tags") {
+                tags.add(filter.value);
+            } else if (filter.name === "brand") {
+                brands.add(filter.value);
+            }
+        }
+        const url = new URL(window.location.href);
+        const searchParams = url.searchParams;
+        searchParams.delete("attribute_values");
+        searchParams.delete("tags");
+        searchParams.delete("brand");
+        searchParams.delete("brand_ids");
+        searchParams.delete("page");
+
+        for (const entry of attributeValues.entries()) {
+            searchParams.append(
+                "attribute_values",
+                `${entry[0]}-${[...entry[1]].join(",")}`
+            );
+        }
+        if (tags.size) {
+            searchParams.set("tags", [...tags].join(","));
+        }
+        for (const brandId of brands) {
+            searchParams.append("brand", brandId);
+        }
+
+        window.location.assign(`${url.pathname}?${searchParams.toString()}`);
+    },
+});

website_sale_product_brand/static/description/index.html

@@ -8,6 +8,11 @@ registry.category("web_tour.tours").add("website_sale_filter_product_brand", {
             content: "Check brand",
             trigger: 'input[name="brand"]',
             run: "click",
+            expectUnloadPage: true,
+        },
+        {
+            content: "Brand should be checked after reload",
+            trigger: 'input[name="brand"]:checked',
         },
     ],
 });