fix: remove non-JS list of products (#10743)

As discussed on the product opener meeting on Monday, this removes the HTML list of products that that is displayed when browsers have turned off Javascript. This is done for performance reasons, to avoid having browsers download the data twice. It also makes the responses smaller and easier to cache.
openfoodfacts · Aug 28, 2024 · 6805b9f · 6805b9f
1 parent e1a485e
commit 6805b9f
Show file tree

Hide file tree

Showing 39 changed files with 21,859 additions and 864 deletions.
diff --git a/lib/ProductOpener/Display.pm b/lib/ProductOpener/Display.pm
@@ -227,6 +227,7 @@ my $uri_finder = URI::Find->new(
 # Sort keys of JSON output
 # $json has utf8 disabled: it encodes to Perl Unicode strings
 my $json = JSON::MaybeXS->new->utf8(0)->allow_nonref->canonical;
+my $json_indent = JSON::MaybeXS->new->indent(1)->utf8(0)->allow_nonref->canonical;
 # $json_utf8 has utf8 enabled: it encodes to UTF-8 bytes
 my $json_utf8 = JSON::MaybeXS->new->utf8(1)->allow_nonref->canonical;
 
@@ -5645,7 +5646,8 @@ sub search_and_display_products ($request_ref, $query_ref, $sort_by, $limit, $pa
 	my $products_json = '[]';
 
 	if (defined $request_ref->{structured_response}{products}) {
-		$products_json = $json->encode($request_ref->{structured_response}{products});
+		# We indent the JSON in the generated HTML so that we can easily see diffs in integration tests outputs
+		$products_json = $json_indent->encode($request_ref->{structured_response}{products});
 	}
 
 	my $contributor_prefs_json = $json->encode(

diff --git a/templates/web/common/includes/list_of_products.tt.html b/templates/web/common/includes/list_of_products.tt.html
@@ -113,20 +113,9 @@
             [% product.product_name %]
           </a>
         </li>
-      [% ELSE %]
-        <li>
-        [% IF product.product_name == '' %]
-          <a href="[% product.url %]" title="[% product.code %]">
-          [% ELSE %]
-          <a href="[% product.url %]" title="[% product.product_name %]">
-          [% END %]
-            <div>[% product.img %]</div>
-            <span>[% product.product_name %]</span>
-          </a>
-        </li>
-        [% END %]
       [% END %]
-      [% IF (jqm.defined) && !(jqm_loadmore.defined) %]
+    [% END %]
+    [% IF (jqm.defined) && !(jqm_loadmore.defined) %]
     </ul>
     [% ELSE %]
 		</ul>

diff --git a/tests/integration/expected_test_results/page_crawler/crawler-access-category-facet-page.html b/tests/integration/expected_test_results/page_crawler/crawler-access-category-facet-page.html
diff --git a/...ation/expected_test_results/page_crawler/crawler-does-not-get-facet-knowledge-panels.html b/...ation/expected_test_results/page_crawler/crawler-does-not-get-facet-knowledge-panels.html
diff --git a/...ntegration/expected_test_results/page_crawler/normal-user-access-category-facet-page.html b/...ntegration/expected_test_results/page_crawler/normal-user-access-category-facet-page.html
diff --git a/.../integration/expected_test_results/page_crawler/normal-user-access-nested-facet-page.html b/.../integration/expected_test_results/page_crawler/normal-user-access-nested-facet-page.html
diff --git a/...ntegration/expected_test_results/page_crawler/normal-user-get-facet-knowledge-panels.html b/...ntegration/expected_test_results/page_crawler/normal-user-get-facet-knowledge-panels.html
diff --git a/tests/integration/expected_test_results/page_crawler/normal-user-get-non-official-cc-lc.html b/tests/integration/expected_test_results/page_crawler/normal-user-get-non-official-cc-lc.html
@@ -566,7 +566,8 @@ <h3 class="title-5 text-medium">Descubre el proyecto</h3>
 var page_type = "products";
 var preferences_text = "Clasifica los productos 0 de acuerdo a tus preferencias";
 var contributor_prefs = {"display_barcode":null,"edit_link":null};
-var products = [];
+var products = []
+;
 </script>
 <script src="//static.openfoodfacts.localhost/js/product-preferences.js"></script>
 <script src="//static.openfoodfacts.localhost/js/product-search.js"></script>

diff --git a/tests/integration/expected_test_results/unknown_tags/country-cambodia-exists-but-empty.html b/tests/integration/expected_test_results/unknown_tags/country-cambodia-exists-but-empty.html
@@ -646,7 +646,8 @@ <h3 class="title-5 text-medium">Discover the project</h3>
 var page_type = "products";
 var preferences_text = "Classify the 0 products below according to your preferences";
 var contributor_prefs = {"display_barcode":null,"edit_link":null};
-var products = [];
+var products = []
+;
 </script>
 <script src="//static.openfoodfacts.localhost/js/product-preferences.js"></script>
 <script src="//static.openfoodfacts.localhost/js/product-search.js"></script>

diff --git a/...ntegration/expected_test_results/unknown_tags/country-doesnotexist-ingredients-apple.html b/...ntegration/expected_test_results/unknown_tags/country-doesnotexist-ingredients-apple.html
@@ -510,7 +510,8 @@ <h3 class="title-5 text-medium">Discover the project</h3>
 var page_type = "products";
 var preferences_text = "Classify the 0 products below according to your preferences";
 var contributor_prefs = {"display_barcode":null,"edit_link":null};
-var products = [];
+var products = []
+;
 </script>
 <script src="//static.openfoodfacts.localhost/js/product-preferences.js"></script>
 <script src="//static.openfoodfacts.localhost/js/product-search.js"></script>

diff --git a/tests/integration/expected_test_results/unknown_tags/country-doesnotexist.html b/tests/integration/expected_test_results/unknown_tags/country-doesnotexist.html
@@ -510,7 +510,8 @@ <h3 class="title-5 text-medium">Discover the project</h3>
 var page_type = "products";
 var preferences_text = "Classify the 0 products below according to your preferences";
 var contributor_prefs = {"display_barcode":null,"edit_link":null};
-var products = [];
+var products = []
+;
 </script>
 <script src="//static.openfoodfacts.localhost/js/product-preferences.js"></script>
 <script src="//static.openfoodfacts.localhost/js/product-search.js"></script>

diff --git a/tests/integration/expected_test_results/unknown_tags/country-france-exists.html b/tests/integration/expected_test_results/unknown_tags/country-france-exists.html
diff --git a/tests/integration/expected_test_results/unknown_tags/ingredient-apple-exists.html b/tests/integration/expected_test_results/unknown_tags/ingredient-apple-exists.html
diff --git a/...sults/unknown_tags/ingredient-someunknownandemptyingredient-does-not-exist-and-empty.html b/...sults/unknown_tags/ingredient-someunknownandemptyingredient-does-not-exist-and-empty.html
@@ -510,7 +510,8 @@ <h3 class="title-5 text-medium">Discover the project</h3>
 var page_type = "products";
 var preferences_text = "Classify the 0 products below according to your preferences";
 var contributor_prefs = {"display_barcode":null,"edit_link":null};
-var products = [];
+var products = []
+;
 </script>
 <script src="//static.openfoodfacts.localhost/js/product-preferences.js"></script>
 <script src="//static.openfoodfacts.localhost/js/product-search.js"></script>

diff --git a/...t_results/unknown_tags/ingredient-someunknowningredient-does-not-exist-but-not-empty.html b/...t_results/unknown_tags/ingredient-someunknowningredient-does-not-exist-but-not-empty.html
diff --git a/tests/integration/expected_test_results/web_html/fr-categories.html b/tests/integration/expected_test_results/web_html/fr-categories.html
diff --git a/tests/integration/expected_test_results/web_html/fr-index.html b/tests/integration/expected_test_results/web_html/fr-index.html
diff --git a/tests/integration/expected_test_results/web_html/fr-search-results-cached.html b/tests/integration/expected_test_results/web_html/fr-search-results-cached.html
diff --git a/tests/integration/expected_test_results/web_html/fr-search-results-no-cache.html b/tests/integration/expected_test_results/web_html/fr-search-results-no-cache.html
diff --git a/tests/integration/expected_test_results/web_html/fr-search-results.html b/tests/integration/expected_test_results/web_html/fr-search-results.html
diff --git a/tests/integration/expected_test_results/web_html/world-categories.html b/tests/integration/expected_test_results/web_html/world-categories.html
diff --git a/tests/integration/expected_test_results/web_html/world-index-signedin.html b/tests/integration/expected_test_results/web_html/world-index-signedin.html
diff --git a/tests/integration/expected_test_results/web_html/world-index.html b/tests/integration/expected_test_results/web_html/world-index.html
diff --git a/tests/integration/expected_test_results/web_html/world-label-organic.html b/tests/integration/expected_test_results/web_html/world-label-organic.html
diff --git a/tests/integration/expected_test_results/web_html/world-search-results.html b/tests/integration/expected_test_results/web_html/world-search-results.html
diff --git a/tests/unit/expected_test_results/routing/api-v0-attribute-groups.json b/tests/unit/expected_test_results/routing/api-v0-attribute-groups.json
@@ -15,8 +15,8 @@
    "original_query_string" : "api/v0/attribute_groups",
    "page" : 1,
    "query_string" : "api/v0/attribute_groups",
-   "rate_limiter_bucket" : null,
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : null,
    "rate_limiter_limit" : null,
    "rate_limiter_user_requests" : null
 }
diff --git a/tests/unit/expected_test_results/routing/api-v3-product-code.json b/tests/unit/expected_test_results/routing/api-v3-product-code.json
@@ -17,8 +17,8 @@
    "original_query_string" : "api/v3/product/03564703999971",
    "page" : 1,
    "query_string" : "api/v3/product/03564703999971",
-   "rate_limiter_bucket" : "product",
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "product",
    "rate_limiter_limit" : 100,
    "rate_limiter_user_requests" : null
 }
diff --git a/tests/unit/expected_test_results/routing/api-v3-product-gs1-data-uri.json b/tests/unit/expected_test_results/routing/api-v3-product-gs1-data-uri.json
@@ -17,8 +17,8 @@
    "original_query_string" : "api/v3/product/https%3A%2F%2Fid.gs1.org%2F01%2F03564703999971%2F10%2FABC%2F21%2F123456%3F17%3D211200",
    "page" : 1,
    "query_string" : "api/v3/product/https%3A%2F%2Fid.gs1.org%2F01%2F03564703999971%2F10%2FABC%2F21%2F123456%3F17%3D211200",
-   "rate_limiter_bucket" : "product",
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "product",
    "rate_limiter_limit" : 100,
    "rate_limiter_user_requests" : null
 }
diff --git a/tests/unit/expected_test_results/routing/facet-url-group-by-in-english.json b/tests/unit/expected_test_results/routing/facet-url-group-by-in-english.json
@@ -11,6 +11,10 @@
    "page" : 1,
    "param" : {},
    "query_string" : "category/breads/ingredients",
+   "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "facet_tags",
+   "rate_limiter_limit" : null,
+   "rate_limiter_user_requests" : null,
    "tag" : "es:breads",
    "tag_prefix" : "",
    "tagid" : "es:breads",
@@ -22,9 +26,5 @@
          "tagtype" : "categories"
       }
    ],
-   "tagtype" : "categories",
-   "rate_limiter_bucket": "facet_tags",
-   "rate_limiter_blocking" : 0,
-   "rate_limiter_limit" : null,
-   "rate_limiter_user_requests" : null
+   "tagtype" : "categories"
 }
diff --git a/tests/unit/expected_test_results/routing/facet-url-group-by.json b/tests/unit/expected_test_results/routing/facet-url-group-by.json
@@ -11,6 +11,10 @@
    "page" : 1,
    "param" : {},
    "query_string" : "category/breads/ingredients",
+   "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "facet_tags",
+   "rate_limiter_limit" : null,
+   "rate_limiter_user_requests" : null,
    "tag" : "en:breads",
    "tag_prefix" : "",
    "tagid" : "en:breads",
@@ -22,9 +26,5 @@
          "tagtype" : "categories"
       }
    ],
-   "tagtype" : "categories",
-   "rate_limiter_bucket": "facet_tags",
-   "rate_limiter_blocking" : 0,
-   "rate_limiter_limit" : null,
-   "rate_limiter_user_requests" : null
+   "tagtype" : "categories"
 }
diff --git a/tests/unit/expected_test_results/routing/facet-url-with-page-number.json b/tests/unit/expected_test_results/routing/facet-url-with-page-number.json
@@ -10,6 +10,10 @@
    "page" : "4",
    "param" : {},
    "query_string" : "category/breads/4",
+   "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "facet_products",
+   "rate_limiter_limit" : null,
+   "rate_limiter_user_requests" : null,
    "tag" : "en:breads",
    "tag_prefix" : "",
    "tagid" : "en:breads",
@@ -21,9 +25,5 @@
          "tagtype" : "categories"
       }
    ],
-   "tagtype" : "categories",
-   "rate_limiter_bucket" : "facet_products",
-   "rate_limiter_blocking" : 0,
-   "rate_limiter_limit" : null,
-   "rate_limiter_user_requests" : null
+   "tagtype" : "categories"
 }
diff --git a/tests/unit/expected_test_results/routing/facet-url-with-synonym-and-page-number.json b/tests/unit/expected_test_results/routing/facet-url-with-synonym-and-page-number.json
@@ -10,8 +10,8 @@
    "page" : "4",
    "param" : {},
    "query_string" : "category/bread/4",
-   "rate_limiter_bucket" : "facet_products",
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "facet_products",
    "rate_limiter_limit" : 5,
    "rate_limiter_user_requests" : null,
    "tag" : "en:bread",

diff --git a/tests/unit/expected_test_results/routing/facet-url.json b/tests/unit/expected_test_results/routing/facet-url.json
@@ -10,8 +10,8 @@
    "page" : 1,
    "param" : {},
    "query_string" : "category/breads",
-   "rate_limiter_bucket" : "facet_products",
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "facet_products",
    "rate_limiter_limit" : 10,
    "rate_limiter_user_requests" : null,
    "tag" : "en:breads",

diff --git a/tests/unit/expected_test_results/routing/geoip-get-country-from-ipv4-us.json b/tests/unit/expected_test_results/routing/geoip-get-country-from-ipv4-us.json
@@ -16,8 +16,8 @@
    "original_query_string" : "api/v3/geopip/12.45.23.45",
    "page" : 1,
    "query_string" : "api/v3/geopip/12.45.23.45",
-   "rate_limiter_bucket" : null,
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : null,
    "rate_limiter_limit" : null,
    "rate_limiter_user_requests" : null
 }
diff --git a/tests/unit/expected_test_results/routing/geoip-get-country-from-ipv6-fr.json b/tests/unit/expected_test_results/routing/geoip-get-country-from-ipv6-fr.json
@@ -16,8 +16,8 @@
    "original_query_string" : "api/v3/geopip/2001:ac8:25:3b::e01d",
    "page" : 1,
    "query_string" : "api/v3/geopip/2001:ac8:25:3b::e01d",
-   "rate_limiter_bucket" : null,
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : null,
    "rate_limiter_limit" : null,
    "rate_limiter_user_requests" : null
 }
diff --git a/tests/unit/expected_test_results/routing/invalid-last-url-component.json b/tests/unit/expected_test_results/routing/invalid-last-url-component.json
@@ -13,8 +13,8 @@
    "page" : 1,
    "param" : {},
    "query_string" : "category/breads/no-nutrition-data",
-   "rate_limiter_bucket" : null,
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : null,
    "rate_limiter_limit" : null,
    "rate_limiter_user_requests" : null,
    "status_code" : 404,

diff --git a/tests/unit/expected_test_results/routing/products-code.json b/tests/unit/expected_test_results/routing/products-code.json
@@ -11,8 +11,8 @@
    "original_query_string" : "products/3564703999971",
    "page" : 1,
    "query_string" : "products/3564703999971",
-   "rate_limiter_bucket" : null,
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : null,
    "rate_limiter_limit" : null,
    "rate_limiter_user_requests" : null,
    "search" : 1

diff --git a/tests/unit/expected_test_results/routing/products-codes.json b/tests/unit/expected_test_results/routing/products-codes.json
@@ -11,8 +11,8 @@
    "original_query_string" : "products/3564703999971,3564703999972",
    "page" : 1,
    "query_string" : "products/3564703999971,3564703999972",
-   "rate_limiter_bucket" : null,
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : null,
    "rate_limiter_limit" : null,
    "rate_limiter_user_requests" : null,
    "search" : 1

diff --git a/tests/unit/expected_test_results/routing/rate-limit-on-facet-registered-user.json b/tests/unit/expected_test_results/routing/rate-limit-on-facet-registered-user.json
@@ -10,14 +10,13 @@
    "page" : 1,
    "param" : {},
    "query_string" : "category/breads",
-   "rate_limiter_bucket" : "facet_products",
    "rate_limiter_blocking" : 0,
+   "rate_limiter_bucket" : "facet_products",
    "rate_limiter_limit" : 10,
    "rate_limiter_user_requests" : null,
    "tag" : "en:breads",
    "tag_prefix" : "",
    "tagid" : "en:breads",
-   "user_id": "userid",
    "tags" : [
       {
          "tag" : "en:breads",
@@ -26,5 +25,6 @@
          "tagtype" : "categories"
       }
    ],
-   "tagtype" : "categories"
+   "tagtype" : "categories",
+   "user_id" : "userid"
 }