Merge branch 'master' into feat/openfoodfacts#517

monsieurtanuki · Aug 3, 2022 · 9bcd6c6 · 9bcd6c6
2 parents fcfbfdd + 2961310
commit 9bcd6c6
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 19 deletions.
diff --git a/.github/workflows/auto-assign-pr.yml b/.github/workflows/auto-assign-pr.yml
@@ -12,4 +12,4 @@ jobs:
   assign-author:
     runs-on: ubuntu-latest
     steps:
-      - uses: toshimaru/auto-author-assign@v1.5.1
+      - uses: toshimaru/auto-author-assign@v1.6.1
diff --git a/lib/openfoodfacts.dart b/lib/openfoodfacts.dart
@@ -45,7 +45,6 @@ import 'utils/HttpHelper.dart';
 import 'utils/LanguageHelper.dart';
 import 'utils/ProductHelper.dart';
 import 'utils/ProductQueryConfigurations.dart';
-import 'utils/ProductSearchQueryConfiguration.dart';
 
 export 'events.dart';
 export 'folksonomy.dart';
@@ -293,14 +292,6 @@ class OpenFoodAPIClient {
   /// Returns the list of products as SearchResult.
   /// Query the language specific host from OpenFoodFacts.
   static Future<SearchResult> searchProducts(
-    final User? user,
-    final ProductSearchQueryConfiguration configuration, {
-    final QueryType? queryType,
-  }) async =>
-      getProducts(user, configuration, queryType: queryType);
-
-  /// Returns products searched according to a [configuration].
-  static Future<SearchResult> getProducts(
     final User? user,
     final AbstractQueryConfiguration configuration, {
     final QueryType? queryType,
@@ -312,7 +303,20 @@ class OpenFoodAPIClient {
     return result;
   }
 
+  /// Returns products searched according to a [configuration].
+  // TODO: deprecated from 2022-07-26; remove when old enough
+  @Deprecated('Use searchProducts instead')
+  static Future<SearchResult> getProducts(
+    final User? user,
+    final AbstractQueryConfiguration configuration, {
+    final QueryType? queryType,
+  }) async =>
+      searchProducts(user, configuration, queryType: queryType);
+
   /// Search the OpenFoodFacts product database: multiple barcodes in input.
+  // TODO: deprecated from 2022-07-26; remove when old enough
+  @Deprecated(
+      'Use method searchProducts with ProductListQueryConfiguration instead')
   static Future<SearchResult> getProductList(
     final User? user,
     final ProductListQueryConfiguration configuration, {
@@ -328,7 +332,7 @@ class OpenFoodAPIClient {
     final OpenFoodFactsCountry? country,
     final QueryType? queryType,
   }) async {
-    final SearchResult searchResult = await getProductList(
+    final SearchResult searchResult = await searchProducts(
       user,
       ProductListQueryConfiguration(
         barcodes,

diff --git a/lib/utils/ProductListQueryConfiguration.dart b/lib/utils/ProductListQueryConfiguration.dart
@@ -48,7 +48,7 @@ class ProductListQueryConfiguration extends AbstractQueryConfiguration {
   Map<String, String> getParametersMap() {
     final Map<String, String> result = super.getParametersMap();
 
-    result['code'] = '${barcodes.join(',')}.json';
+    result['code'] = barcodes.join(',');
 
     return result;
   }

diff --git a/test/api_getToBeCompletedProducts_test.dart b/test/api_getToBeCompletedProducts_test.dart
@@ -30,7 +30,7 @@ void main() {
 
       final SearchResult result;
       try {
-        result = await OpenFoodAPIClient.getProducts(
+        result = await OpenFoodAPIClient.searchProducts(
           OpenFoodAPIConfiguration.globalUser,
           configuration,
           queryType: OpenFoodAPIConfiguration.globalQueryType,

diff --git a/test/api_getUserProducts_test.dart b/test/api_getUserProducts_test.dart
@@ -34,7 +34,7 @@ void main() {
 
       final SearchResult result;
       try {
-        result = await OpenFoodAPIClient.getProducts(
+        result = await OpenFoodAPIClient.searchProducts(
           OpenFoodAPIConfiguration.globalUser,
           configuration,
           queryType: OpenFoodAPIConfiguration.globalQueryType,

diff --git a/test/api_matchedProductV2_test.dart b/test/api_matchedProductV2_test.dart
@@ -126,7 +126,7 @@ void main() {
         BARCODE_CHORIZO,
       ];
 
-      final SearchResult result = await OpenFoodAPIClient.getProductList(
+      final SearchResult result = await OpenFoodAPIClient.searchProducts(
         OpenFoodAPIConfiguration.globalUser,
         ProductListQueryConfiguration(
           inputBarcodes,

diff --git a/test/api_saveProduct_test.dart b/test/api_saveProduct_test.dart
@@ -86,7 +86,7 @@ void main() {
       );
 
       testProductResult1(result2);
-    });
+    }, skip: 'Random results');
 
     /// Returns a timestamp up to the minute level.
     String _getMinuteTimestamp() =>

diff --git a/test/api_searchProducts_test.dart b/test/api_searchProducts_test.dart
@@ -523,7 +523,7 @@ void main() {
         language: OpenFoodFactsLanguage.FRENCH,
       );
 
-      final SearchResult result = await OpenFoodAPIClient.getProductList(
+      final SearchResult result = await OpenFoodAPIClient.searchProducts(
         TestConstants.PROD_USER,
         configuration,
         queryType: QueryType.PROD,
@@ -573,7 +573,7 @@ void main() {
           sortOption: SortOption.PRODUCT_NAME,
         );
 
-        final result = await OpenFoodAPIClient.getProductList(
+        final result = await OpenFoodAPIClient.searchProducts(
             TestConstants.PROD_USER, configuration);
         if (result.products == null || result.products!.isEmpty) {
           break;
@@ -629,7 +629,7 @@ void main() {
         language: OpenFoodFactsLanguage.FRENCH,
       );
 
-      final SearchResult result = await OpenFoodAPIClient.getProductList(
+      final SearchResult result = await OpenFoodAPIClient.searchProducts(
         TestConstants.PROD_USER,
         configuration,
         queryType: QueryType.PROD,