fix: 6249 - refresh of the prices of a product after a related price addition (#6361)

monsieurtanuki · web-flow · commit 75fc7b5d354d · 2025-02-10T10:39:19.000+01:00
New file:
* `product_price_refresher.dart`: Async refresh of the prices of a product, with several loading phases.

Impacted files:
* `background_task_add_other_price.dart`: minor refactoring
* `background_task_add_price.dart`: minor refactoring
* `background_task_price.dart`: now aftrer we add a price, we signal that the related product price counts needs to be refreshed
* `prices_card.dart`: used the new `ProductPriceRefresher` class for async data loading
* `product_prices_list.dart`: used the new `ProductPriceRefresher` class for async data loading; refactored the display of the list in a separate class
diff --git a/packages/smooth_app/lib/background/background_task_add_other_price.dart b/packages/smooth_app/lib/background/background_task_add_other_price.dart
@@ -121,6 +121,7 @@ class BackgroundTaskAddOtherPrice extends BackgroundTaskPrice {
     await addPrices(
       bearerToken: bearerToken,
       proofId: proofId,
+      localDatabase: localDatabase,
     );
 
     await closeSession(bearerToken: bearerToken);
diff --git a/packages/smooth_app/lib/background/background_task_add_price.dart b/packages/smooth_app/lib/background/background_task_add_price.dart
@@ -256,6 +256,7 @@ class BackgroundTaskAddPrice extends BackgroundTaskPrice {
     await addPrices(
       bearerToken: bearerToken,
       proofId: uploadProof.value.id,
+      localDatabase: localDatabase,
     );
 
     await closeSession(bearerToken: bearerToken);
diff --git a/packages/smooth_app/lib/background/background_task_price.dart b/packages/smooth_app/lib/background/background_task_price.dart
@@ -5,6 +5,7 @@ import 'package:flutter_gen/gen_l10n/app_localizations.dart';
 import 'package:openfoodfacts/openfoodfacts.dart';
 import 'package:smooth_app/background/background_task.dart';
 import 'package:smooth_app/database/local_database.dart';
+import 'package:smooth_app/pages/prices/product_price_refresher.dart';
 import 'package:smooth_app/query/product_query.dart';
 
 /// Abstract background task about adding prices.
@@ -174,8 +175,10 @@ abstract class BackgroundTaskPrice extends BackgroundTask {
   Future<void> addPrices({
     required final String bearerToken,
     required final int proofId,
+    required final LocalDatabase localDatabase,
   }) async {
     for (int i = 0; i < barcodes.length; i++) {
+      final String barcode = barcodes[i];
       final Price newPrice = Price()
         ..date = date
         ..currency = currency
@@ -185,7 +188,7 @@ abstract class BackgroundTaskPrice extends BackgroundTask {
         ..priceIsDiscounted = pricesAreDiscounted[i]
         ..price = prices[i]
         ..priceWithoutDiscount = pricesWithoutDiscount[i]
-        ..productCode = barcodes[i];
+        ..productCode = barcode;
 
       // create price
       final MaybeError<Price?> addedPrice =
@@ -197,7 +200,9 @@ abstract class BackgroundTaskPrice extends BackgroundTask {
       if (addedPrice.isError) {
         throw Exception('Could not add price: ${addedPrice.error}');
       }
+      ProductPriceRefresher.setLatestUpdate(barcode);
     }
+    localDatabase.notifyListeners();
   }
 
   @protected
diff --git a/packages/smooth_app/lib/pages/prices/prices_card.dart b/packages/smooth_app/lib/pages/prices/prices_card.dart
@@ -1,17 +1,21 @@
+import 'dart:async';
 import 'dart:math';
 
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_gen/gen_l10n/app_localizations.dart';
 import 'package:openfoodfacts/openfoodfacts.dart';
+import 'package:provider/provider.dart';
+import 'package:smooth_app/data_models/preferences/user_preferences.dart';
+import 'package:smooth_app/database/local_database.dart';
 import 'package:smooth_app/generic_lib/buttons/smooth_large_button_with_icon.dart';
 import 'package:smooth_app/generic_lib/design_constants.dart';
 import 'package:smooth_app/helpers/product_cards_helper.dart';
 import 'package:smooth_app/pages/prices/get_prices_model.dart';
 import 'package:smooth_app/pages/prices/price_meta_product.dart';
 import 'package:smooth_app/pages/prices/prices_page.dart';
 import 'package:smooth_app/pages/prices/product_price_add_page.dart';
-import 'package:smooth_app/query/product_query.dart';
+import 'package:smooth_app/pages/prices/product_price_refresher.dart';
 import 'package:smooth_app/resources/app_icons.dart' as icons;
 import 'package:smooth_app/themes/smooth_theme.dart';
 import 'package:smooth_app/themes/smooth_theme_colors.dart';
@@ -130,67 +134,64 @@ class _PricesCardViewButton extends StatefulWidget {
 }
 
 class _PricesCardViewButtonState extends State<_PricesCardViewButton> {
-  late final GetPricesModel _model;
-  late final Future<MaybeError<GetPricesResult>> _prices = _showProductPrices();
+  GetPricesModel? _model;
+  ProductPriceRefresher? _productPriceRefresher;
 
   @override
-  Widget build(BuildContext context) =>
-      FutureBuilder<MaybeError<GetPricesResult>>(
-        future: _prices,
-        builder: (
-          final BuildContext context,
-          final AsyncSnapshot<MaybeError<GetPricesResult>> snapshot,
-        ) {
-          final AppLocalizations appLocalizations =
-              AppLocalizations.of(context);
-          GetPricesResult? pricesResult;
-          if (snapshot.hasData && !snapshot.data!.isError) {
-            pricesResult = snapshot.data!.value;
-          }
-          return Badge(
-            offset: Offset.zero,
-            isLabelVisible: pricesResult?.total != null,
-            backgroundColor:
-                context.extension<SmoothColorsThemeExtension>().secondaryNormal,
-            label: Padding(
-              padding: const EdgeInsetsDirectional.only(
-                start: VERY_SMALL_SPACE,
-                end: VERY_SMALL_SPACE,
-                top: VERY_SMALL_SPACE,
-                bottom: 6.0,
-              ),
-              child: Text(
-                '${pricesResult?.total}',
-                style: const TextStyle(
-                  color: Colors.white,
-                  fontWeight: FontWeight.bold,
-                ),
-              ),
-            ),
-            child: SmoothLargeButtonWithIcon(
-              text: appLocalizations.prices_view_prices,
-              leadingIcon: const Icon(CupertinoIcons.tag_fill),
-              onPressed: () async => Navigator.of(context).push(
-                MaterialPageRoute<void>(
-                  builder: (BuildContext context) => PricesPage(
-                    _model,
-                    pricesResult: pricesResult,
-                  ),
-                ),
-              ),
-            ),
-          );
-        },
-      );
+  Widget build(BuildContext context) {
+    final AppLocalizations appLocalizations = AppLocalizations.of(context);
 
-  Future<MaybeError<GetPricesResult>> _showProductPrices() async {
-    _model = GetPricesModel.product(
+    _model ??= GetPricesModel.product(
       product: PriceMetaProduct.product(widget.product),
       context: context,
     );
-    return OpenPricesAPIClient.getPrices(
-      _model.parameters,
-      uriHelper: ProductQuery.uriPricesHelper,
+    _productPriceRefresher ??= ProductPriceRefresher(
+      model: _model!,
+      userPreferences: context.read<UserPreferences>(),
+      pricesResult: null,
+      refreshDisplay: () {
+        if (mounted) {
+          setState(() {});
+        }
+      },
+    );
+
+    context.watch<LocalDatabase>();
+    unawaited(_productPriceRefresher!.runIfNeeded());
+
+    final int? total = _productPriceRefresher!.pricesResult?.total;
+    return Badge(
+      offset: Offset.zero,
+      isLabelVisible: total != null,
+      backgroundColor:
+          context.extension<SmoothColorsThemeExtension>().secondaryNormal,
+      label: Padding(
+        padding: const EdgeInsetsDirectional.only(
+          start: VERY_SMALL_SPACE,
+          end: VERY_SMALL_SPACE,
+          top: VERY_SMALL_SPACE,
+          bottom: 6.0,
+        ),
+        child: Text(
+          '$total',
+          style: const TextStyle(
+            color: Colors.white,
+            fontWeight: FontWeight.bold,
+          ),
+        ),
+      ),
+      child: SmoothLargeButtonWithIcon(
+        text: appLocalizations.prices_view_prices,
+        leadingIcon: const Icon(CupertinoIcons.tag_fill),
+        onPressed: () async => Navigator.of(context).push(
+          MaterialPageRoute<void>(
+            builder: (BuildContext context) => PricesPage(
+              _model!,
+              pricesResult: _productPriceRefresher!.pricesResult,
+            ),
+          ),
+        ),
+      ),
     );
   }
 }
diff --git a/packages/smooth_app/lib/pages/prices/product_price_refresher.dart b/packages/smooth_app/lib/pages/prices/product_price_refresher.dart
@@ -0,0 +1,100 @@
+import 'dart:async';
+import 'dart:ui';
+
+import 'package:openfoodfacts/openfoodfacts.dart';
+import 'package:smooth_app/data_models/preferences/user_preferences.dart';
+import 'package:smooth_app/database/local_database.dart';
+import 'package:smooth_app/pages/prices/get_prices_model.dart';
+import 'package:smooth_app/pages/product/common/loading_status.dart';
+import 'package:smooth_app/query/product_query.dart';
+
+/// Async refresh of the prices of a product, with several loading phases.
+class ProductPriceRefresher {
+  ProductPriceRefresher({
+    required this.pricesResult,
+    required this.model,
+    required this.userPreferences,
+    required this.refreshDisplay,
+  });
+
+  final GetPricesModel model;
+  final UserPreferences userPreferences;
+  final VoidCallback refreshDisplay;
+
+  GetPricesResult? pricesResult;
+
+  LoadingStatus? _loadingStatus;
+
+  LoadingStatus? get loadingStatus => _loadingStatus;
+
+  String? _loadingError;
+
+  String? get loadingError => _loadingError;
+
+  String? get _barcode => model.parameters.productCode;
+
+  Future<void> runIfNeeded() async {
+    _resetIfNeedsUpdate();
+    if (loadingStatus == null) {
+      return _asyncLoad();
+    }
+  }
+
+  void _resetIfNeedsUpdate() {
+    if (_barcode == null) {
+      return;
+    }
+    final int? latestUpdate = _latestUpdates[_barcode!];
+    final int? latestRefresh = _latestRefreshes[_barcode!];
+    if (latestRefresh != null &&
+        latestUpdate != null &&
+        latestUpdate > latestRefresh &&
+        _loadingStatus != LoadingStatus.LOADING) {
+      _loadingStatus = null;
+      pricesResult = null;
+    }
+  }
+
+  Future<void> _asyncLoad() async {
+    _loadingStatus = LoadingStatus.LOADING;
+    refreshDisplay();
+    final MaybeError<GetPricesResult> result;
+    if (pricesResult != null) {
+      result = MaybeError<GetPricesResult>.value(pricesResult!);
+    } else {
+      result = await OpenPricesAPIClient.getPrices(
+        model.parameters,
+        uriHelper: ProductQuery.uriPricesHelper,
+      );
+    }
+    if (result.isError) {
+      _loadingError = result.detailError;
+      _loadingStatus = LoadingStatus.ERROR;
+    } else {
+      pricesResult = result.value;
+      _loadingStatus = LoadingStatus.LOADED;
+      if (model.lazyCounterPrices != null && pricesResult!.total != null) {
+        model.lazyCounterPrices!.setLocalCount(
+          pricesResult!.total!,
+          userPreferences,
+          notify: true,
+        );
+      }
+      if (_barcode != null) {
+        _setLatestRefresh(_barcode!);
+      }
+    }
+    refreshDisplay();
+  }
+
+  static final Map<String, int> _latestUpdates = <String, int>{};
+  static final Map<String, int> _latestRefreshes = <String, int>{};
+
+  static void setLatestUpdate(final String barcode) =>
+      _latestUpdates[barcode] = _getTimestamp();
+
+  static void _setLatestRefresh(final String barcode) =>
+      _latestRefreshes[barcode] = _getTimestamp();
+
+  static int _getTimestamp() => LocalDatabase.nowInMillis();
+}
diff --git a/packages/smooth_app/lib/pages/prices/product_prices_list.dart b/packages/smooth_app/lib/pages/prices/product_prices_list.dart
