feat: 719 - Suggestion Manager with suggestions for the latest input (#…

…720) * feat: 719 - Suggestion Manager with suggestions for the latest input New files: * `api_suggestion_manager_test.dart`: Unit tests for `SuggestionManager` * `suggestion_manager.dart`: Manager that returns the suggestions for the latest input. Impacted files: * `open_food_api_client.dart`: added a comment mentioning `SuggestionManager`. * `openfoodfacts.dart`: exported new file `suggestion_manager.dart` * feat: 719 - fixed tests and added a verbose jsonDecode method Deleted file: * `api_get_autocompleted_suggestions_test.dart`: based on a deprecated method Impacted files: * `api_get_suggestions_test.dart`: fixed test * `available_attribute_groups.dart`: now uses `HttpHelper().jsonDecode` * `available_preference_importances.dart`: now uses `HttpHelper().jsonDecode` * `events.dart`: now uses `HttpHelper().jsonDecode` * `folksonomy.dart`: now uses `HttpHelper().jsonDecode` * `http_helper.dart`: new `jsonDecode` method that deals with typical OFF server html error pages * `invalid_barcodes.dart`: now uses `HttpHelper().jsonDecode` * `open_food_api_client.dart`: now uses `HttpHelper().jsonDecode` * `ordered_nutrient_test.dart`: now uses `HttpHelper().jsonDecode` * `product_from_json_test.dart`: now uses `HttpHelper().jsonDecode` * `status.dart`: now uses `HttpHelper().jsonDecode` * feat: 719 - added the "software error" case Impacted file: * `http_helper.dart`: added the "software error" case to `jsonDecode` method
openfoodfacts · Apr 1, 2023 · 5a31a09 · 5a31a09
1 parent 4953709
commit 5a31a09
Show file tree

Hide file tree

Showing 15 changed files with 310 additions and 432 deletions.
diff --git a/lib/openfoodfacts.dart b/lib/openfoodfacts.dart
@@ -102,6 +102,7 @@ export 'src/utils/product_helper.dart';
 export 'src/utils/product_query_configurations.dart';
 export 'src/utils/product_search_query_configuration.dart';
 export 'src/utils/query_type.dart';
+export 'src/utils/suggestion_manager.dart';
 export 'src/utils/tag_type.dart';
 export 'src/utils/unit_helper.dart';
 export 'src/utils/uri_helper.dart';

diff --git a/lib/src/events.dart b/lib/src/events.dart
@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'dart:convert';
 
 import 'package:http/http.dart';
 import 'model/badge_base.dart';
@@ -47,7 +46,8 @@ class EventsAPIClient {
     );
     _checkResponse(response);
     final List<EventsBase> result = <EventsBase>[];
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       result.add(EventsBase.fromJson(element));
     }
@@ -78,7 +78,7 @@ class EventsAPIClient {
     _checkResponse(response);
     final Map<String, int> result = <String, int>{};
     final Map<String, dynamic> json =
-        jsonDecode(response.body) as Map<String, dynamic>;
+        HttpHelper().jsonDecode(response.body) as Map<String, dynamic>;
     for (final String key in json.keys) {
       result[key] = json[key] as int;
     }
@@ -112,7 +112,7 @@ class EventsAPIClient {
     );
     _checkResponse(response);
     final Map<String, dynamic> json =
-        jsonDecode(response.body) as Map<String, dynamic>;
+        HttpHelper().jsonDecode(response.body) as Map<String, dynamic>;
     return json['score'] as int;
   }
 
@@ -139,7 +139,8 @@ class EventsAPIClient {
     );
     _checkResponse(response);
     final List<BadgeBase> result = <BadgeBase>[];
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       result.add(BadgeBase.fromJson(element));
     }
@@ -165,7 +166,8 @@ class EventsAPIClient {
     );
     _checkResponse(response);
     final List<LeaderboardEntry> result = <LeaderboardEntry>[];
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       result.add(LeaderboardEntry.fromJson(element));
     }
@@ -179,7 +181,7 @@ class EventsAPIClient {
       String? exception;
       try {
         final Map<String, dynamic> json =
-            jsonDecode(response.body) as Map<String, dynamic>;
+            HttpHelper().jsonDecode(response.body) as Map<String, dynamic>;
         exception = json['detail'];
       } catch (e) {
         //

diff --git a/lib/src/folksonomy.dart b/lib/src/folksonomy.dart
@@ -1,5 +1,4 @@
 import 'dart:async';
-import 'dart:convert';
 
 import 'package:http/http.dart';
 
@@ -69,7 +68,8 @@ class FolksonomyAPIClient {
       // not found
       return result;
     }
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       result.add(ProductStats.fromJson(element));
     }
@@ -104,7 +104,8 @@ class FolksonomyAPIClient {
     );
     _checkResponse(response);
     final Map<String, String> result = <String, String>{};
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       final ProductList productList = ProductList.fromJson(element);
       if (productList.key != key) {
@@ -142,7 +143,8 @@ class FolksonomyAPIClient {
       // not found
       return result;
     }
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       final ProductTag productTag = ProductTag.fromJson(element);
       result[productTag.key] = productTag;
@@ -178,7 +180,7 @@ class FolksonomyAPIClient {
       return null;
     }
     final Map<String, dynamic> json =
-        jsonDecode(response.body) as Map<String, dynamic>;
+        HttpHelper().jsonDecode(response.body) as Map<String, dynamic>;
     return ProductTag.fromJson(json);
   }
 
@@ -210,7 +212,8 @@ class FolksonomyAPIClient {
       // not found
       return result;
     }
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       final ProductTag productTag = ProductTag.fromJson(element);
       result[productTag.key] = productTag;
@@ -269,7 +272,8 @@ Future<void> deleteProductTag({
       // not found
       return result;
     }
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       result.add(ProductTag.fromJson(element));
     }
@@ -349,7 +353,8 @@ Future<void> deleteProductTag({
     );
     _checkResponse(response);
     final Map<String, KeyStats> result = <String, KeyStats>{};
-    final List<dynamic> json = jsonDecode(response.body) as List<dynamic>;
+    final List<dynamic> json =
+        HttpHelper().jsonDecode(response.body) as List<dynamic>;
     for (var element in json) {
       final KeyStats item = KeyStats.fromJson(element);
       result[item.key] = item;

diff --git a/lib/src/model/status.dart b/lib/src/model/status.dart
@@ -1,8 +1,7 @@
-import 'dart:convert';
-
 import 'package:json_annotation/json_annotation.dart';
 
 import '../interface/json_object.dart';
+import '../utils/http_helper.dart';
 
 part 'status.g.dart';
 
@@ -66,7 +65,7 @@ class Status extends JsonObject {
   /// Constructs a [Status] from an API response
   factory Status.fromApiResponse(String responseBody) {
     try {
-      return Status.fromJson(json.decode(responseBody));
+      return Status.fromJson(HttpHelper().jsonDecode(responseBody));
     } catch (e) {
       return Status(
         body: responseBody,

diff --git a/lib/src/open_food_api_client.dart b/lib/src/open_food_api_client.dart
@@ -174,7 +174,7 @@ class OpenFoodAPIClient {
       user,
       queryType: queryType,
     );
-    return ProductResultV3.fromJson(jsonDecode(response.body));
+    return ProductResultV3.fromJson(HttpHelper().jsonDecode(response.body));
   }
 
   /// Send one image to the server.
@@ -253,7 +253,7 @@ class OpenFoodAPIClient {
       user: user,
       queryType: queryType,
     );
-    return ProductResult.fromJson(json.decode(productString));
+    return ProductResult.fromJson(HttpHelper().jsonDecode(productString));
   }
 
   /// Returns the product for the given barcode.
@@ -278,7 +278,9 @@ class OpenFoodAPIClient {
       queryType: queryType,
     );
     final String jsonStr = _replaceQuotes(productString);
-    final ProductResult result = ProductResult.fromJson(jsonDecode(jsonStr));
+    final ProductResult result = ProductResult.fromJson(
+      HttpHelper().jsonDecode(jsonStr),
+    );
     if (result.product != null) {
       ProductHelper.removeImages(result.product!, configuration.language);
       ProductHelper.createImageUrls(result.product!, queryType: queryType);
@@ -331,8 +333,9 @@ class OpenFoodAPIClient {
       queryType: queryType,
     );
     final String jsonStr = _replaceQuotes(productString);
-    final ProductResultV3 result =
-        ProductResultV3.fromJson(jsonDecode(jsonStr));
+    final ProductResultV3 result = ProductResultV3.fromJson(
+      HttpHelper().jsonDecode(jsonStr),
+    );
     if (result.product != null) {
       ProductHelper.removeImages(result.product!, configuration.language);
       ProductHelper.createImageUrls(result.product!, queryType: queryType);
@@ -360,7 +363,7 @@ class OpenFoodAPIClient {
       queryType: queryType,
     );
     final String jsonStr = _replaceQuotes(productString);
-    final json = jsonDecode(jsonStr);
+    final json = HttpHelper().jsonDecode(jsonStr);
     if (json['status'] != 'success') {
       throw Exception('Error: ${json['status']}');
     }
@@ -549,7 +552,9 @@ class OpenFoodAPIClient {
   }) async {
     final Response response = await configuration.getResponse(user, queryType);
     final String jsonStr = _replaceQuotes(response.body);
-    final SearchResult result = SearchResult.fromJson(json.decode(jsonStr));
+    final SearchResult result = SearchResult.fromJson(
+      HttpHelper().jsonDecode(jsonStr),
+    );
     _removeImages(result, configuration);
     return result;
   }
@@ -609,7 +614,7 @@ class OpenFoodAPIClient {
     );
 
     Map<String, dynamic> decodedJson =
-        json.decode(_replaceQuotes(response.body))
+        HttpHelper().jsonDecode(_replaceQuotes(response.body))
           ..removeWhere((String key, dynamic value) {
             if (value is Map) {
               return value.isEmpty;
@@ -819,8 +824,9 @@ class OpenFoodAPIClient {
       user: user,
       queryType: queryType,
     );
-    var result =
-        InsightsResult.fromJson(json.decode(utf8.decode(response.bodyBytes)));
+    var result = InsightsResult.fromJson(
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes)),
+    );
 
     return result;
   }
@@ -842,7 +848,8 @@ class OpenFoodAPIClient {
     );
 
     return InsightsResult.fromJson(
-        json.decode(utf8.decode(response.bodyBytes)));
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes)),
+    );
   }
 
   static Future<RobotoffQuestionResult> getRobotoffQuestionsForProduct(
@@ -873,7 +880,8 @@ class OpenFoodAPIClient {
       queryType: queryType,
     );
     var result = RobotoffQuestionResult.fromJson(
-        json.decode(utf8.decode(response.bodyBytes)));
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes)),
+    );
 
     return result;
   }
@@ -917,7 +925,8 @@ class OpenFoodAPIClient {
       queryType: queryType,
     );
     var result = RobotoffQuestionResult.fromJson(
-        json.decode(utf8.decode(response.bodyBytes)));
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes)),
+    );
 
     return result;
   }
@@ -994,7 +1003,8 @@ class OpenFoodAPIClient {
       addCredentialsToHeader: true,
     );
     SpellingCorrection result = SpellingCorrection.fromJson(
-        json.decode(utf8.decode(response.bodyBytes)));
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes)),
+    );
 
     return result;
   }
@@ -1043,7 +1053,8 @@ class OpenFoodAPIClient {
       addCredentialsToBody: false,
     );
     return OcrIngredientsResult.fromJson(
-      json.decode(utf8.decode(response.bodyBytes)) as Map<String, dynamic>,
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes))
+          as Map<String, dynamic>,
     );
   }
 
@@ -1088,7 +1099,8 @@ class OpenFoodAPIClient {
       addCredentialsToBody: false,
     );
     return OcrPackagingResult.fromJson(
-      json.decode(utf8.decode(response.bodyBytes)) as Map<String, dynamic>,
+      HttpHelper().jsonDecode(utf8.decode(response.bodyBytes))
+          as Map<String, dynamic>,
     );
   }
 
@@ -1131,10 +1143,12 @@ class OpenFoodAPIClient {
       queryType: queryType,
       addCredentialsToBody: false,
     );
-    return json.decode(response.body);
+    return HttpHelper().jsonDecode(response.body);
   }
 
   /// cf. https://openfoodfacts.github.io/openfoodfacts-server/reference/api-v3/#get-/api/v3/taxonomy_suggestions
+  ///
+  /// Consider using [SuggestionManager].
   static Future<List<String>> getSuggestions(
     final TagType taxonomyType, {
     final String input = '',
@@ -1165,7 +1179,7 @@ class OpenFoodAPIClient {
       user: user,
       queryType: queryType,
     );
-    final Map<String, dynamic> map = json.decode(response.body);
+    final Map<String, dynamic> map = HttpHelper().jsonDecode(response.body);
     final List<String> result = <String>[];
     if (map['suggestions'] != null) {
       for (dynamic value in map['suggestions']) {
@@ -1227,7 +1241,7 @@ class OpenFoodAPIClient {
       addCredentialsToBody: true,
     );
     if (response.statusCode == 200 || response.statusCode == 403) {
-      return LoginStatus.fromJson(jsonDecode(response.body));
+      return LoginStatus.fromJson(HttpHelper().jsonDecode(response.body));
     }
 
     return null;
@@ -1371,7 +1385,7 @@ class OpenFoodAPIClient {
     final QueryType? queryType,
   }) async =>
       OrderedNutrients.fromJson(
-        jsonDecode(
+        HttpHelper().jsonDecode(
           await getOrderedNutrientsJsonString(
             country: CountryHelper.fromJson(cc)!,
             language: language,
@@ -1512,7 +1526,7 @@ class OpenFoodAPIClient {
           'Bad response (${response.statusCode}): ${response.body}');
     }
     final Map<String, dynamic> json =
-        jsonDecode(response.body) as Map<String, dynamic>;
+        HttpHelper().jsonDecode(response.body) as Map<String, dynamic>;
     final String status = json['status'];
     if (status != 'status ok') {
       throw Exception('Status not ok ($status)');
@@ -1565,7 +1579,7 @@ class OpenFoodAPIClient {
           'Bad response (${response.statusCode}): ${response.body}');
     }
     final Map<String, dynamic> json =
-        jsonDecode(response.body) as Map<String, dynamic>;
+        HttpHelper().jsonDecode(response.body) as Map<String, dynamic>;
     final String status = json['status'];
     if (status != 'status ok') {
       throw Exception('Status not ok ($status)');

diff --git a/lib/src/personalized_search/available_attribute_groups.dart b/lib/src/personalized_search/available_attribute_groups.dart
@@ -1,13 +1,13 @@
-import 'dart:convert';
 import '../model/attribute_group.dart';
+import '../utils/http_helper.dart';
 
 /// Referential of attribute groups, with loader.
 class AvailableAttributeGroups {
   /// Load constructor; may throw an exception.
   AvailableAttributeGroups.loadFromJSONString(
     final String attributeGroupsString,
   ) {
-    final dynamic inputJson = json.decode(attributeGroupsString);
+    final dynamic inputJson = HttpHelper().jsonDecode(attributeGroupsString);
     final List<AttributeGroup> attributeGroups = <AttributeGroup>[];
     for (final dynamic item in inputJson as List<dynamic>) {
       attributeGroups.add(AttributeGroup.fromJson(item));

diff --git a/lib/src/personalized_search/available_preference_importances.dart b/lib/src/personalized_search/available_preference_importances.dart
@@ -1,5 +1,5 @@
-import 'dart:convert';
 import 'preference_importance.dart';
+import '../utils/http_helper.dart';
 
 /// Referential of preference importance, with loader.
 class AvailablePreferenceImportances {
@@ -11,7 +11,8 @@ class AvailablePreferenceImportances {
     final Map<String, PreferenceImportance> preferenceImportances =
         <String, PreferenceImportance>{};
     final Map<String, int> importancesReverseIds = <String, int>{};
-    final dynamic inputJson = json.decode(preferenceImportancesString);
+    final dynamic inputJson =
+        HttpHelper().jsonDecode(preferenceImportancesString);
     for (final dynamic item in inputJson as List<dynamic>) {
       final PreferenceImportance preferenceImportance =
           PreferenceImportance.fromJson(item);