Merge pull request #86 from flutter-news-app-full-source-code/feat/app-review-required-data

Feat/app review required data

Author: fulleni

lib/src/enums/enums.dart

@@ -20,6 +20,7 @@ export 'feed_item_click_behavior.dart';
 export 'feed_item_density.dart';
 export 'feed_item_image_style.dart';
 export 'headline_report_reason.dart';
+export 'initial_app_review_feedback.dart';
 export 'push_notification_provider.dart';
 export 'push_notification_subscription_delivery_type.dart';
 export 'reaction_type.dart';

lib/src/enums/initial_app_review_feedback.dart

@@ -0,0 +1,16 @@
+import 'package:json_annotation/json_annotation.dart';
+
+/// {@template initial_app_review_feedback}
+/// Represents the user's response to the initial, private app review prompt
+/// (e.g., "Are you enjoying the app?").
+/// {@endtemplate}
+@JsonEnum()
+enum InitialAppReviewFeedback {
+  /// The user indicated a positive experience.
+  @JsonValue('positive')
+  positive,
+
+  /// The user indicated a negative experience.
+  @JsonValue('negative')
+  negative,
+}

lib/src/fixtures/app_reviews.dart

@@ -0,0 +1,127 @@
+import 'package:core/core.dart';
+
+/// Generates a list of predefined app reviews for fixture data.
+List<AppReview> getAppReviewsFixturesData({
+  String languageCode = 'en',
+  DateTime? now,
+}) {
+  final appReviews = <AppReview>[];
+  final users = usersFixturesData;
+  final referenceTime = now ?? DateTime.now();
+
+  final reasonsByLang = <String, List<String>>{
+    'en': [
+      'The app is a bit slow when loading the main feed.',
+      'I did not like the old layout.',
+      'Still experiencing some lag on the search page.',
+      'Crashes sometimes when I open a notification.',
+    ],
+    'ar': [
+      'التطبيق بطيء بعض الشيء عند تحميل الواجهة الرئيسية.',
+      'لم يعجبني التصميم القديم.',
+      'لا أزال أواجه بعض البطء في صفحة البحث.',
+      'يتوقف أحيانًا عند فتح إشعار.',
+    ],
+  };
+
+  final resolvedLanguageCode = ['en', 'ar'].contains(languageCode)
+      ? languageCode
+      : 'en';
+  final reasons = reasonsByLang[resolvedLanguageCode]!;
+
+  for (var i = 0; i < users.length; i++) {
+    final user = users[i];
+    final createdAt = referenceTime.subtract(Duration(days: 30 - i));
+
+    // Every 3rd user gives a positive review and is sent to the store.
+    if (i % 3 == 0) {
+      appReviews.add(
+        AppReview(
+          id: 'ar-pos-$i',
+          userId: user.id,
+          initialFeedback: InitialAppReviewFeedback.positive,
+          createdAt: createdAt,
+          updatedAt: createdAt.add(const Duration(minutes: 1)),
+          wasStoreReviewRequested: true,
+        ),
+      );
+    }
+    // Every 5th user gives a negative review with a reason.
+    else if (i % 5 == 0) {
+      appReviews.add(
+        AppReview(
+          id: 'ar-neg-reason-$i',
+          userId: user.id,
+          initialFeedback: InitialAppReviewFeedback.negative,
+          createdAt: createdAt,
+          updatedAt: createdAt,
+          negativeFeedbackHistory: [
+            NegativeFeedback(
+              providedAt: createdAt,
+              reason: reasons[i % reasons.length],
+            ),
+          ],
+        ),
+      );
+    }
+    // Other users give a negative review without a reason.
+    else {
+      appReviews.add(
+        AppReview(
+          id: 'ar-neg-$i',
+          userId: user.id,
+          initialFeedback: InitialAppReviewFeedback.negative,
+          createdAt: createdAt,
+          updatedAt: createdAt,
+        ),
+      );
+    }
+  }
+
+  // Add a case where a user gave negative feedback, then was prompted again
+  // later and gave positive feedback.
+  final multiStageUser = users[1];
+  final firstReviewTime = referenceTime.subtract(const Duration(days: 45));
+  final secondReviewTime = referenceTime.subtract(const Duration(days: 5));
+
+  // This would be an update to an existing record, but for fixtures we can
+  // just show the final state.
+  appReviews.add(
+    AppReview(
+      id: 'ar-multistage-final',
+      userId: multiStageUser.id,
+      initialFeedback: InitialAppReviewFeedback.positive,
+      // createdAt would be from the first interaction
+      createdAt: firstReviewTime,
+      // updatedAt is from the most recent interaction
+      updatedAt: secondReviewTime,
+      // The reason from the first negative review might be cleared or kept,
+      // depending on business logic. Here we assume it's cleared on positive.
+      wasStoreReviewRequested: true,
+      // The history might be kept for analytics, even after a positive review.
+      negativeFeedbackHistory: [
+        NegativeFeedback(providedAt: firstReviewTime, reason: reasons[1]),
+      ],
+    ),
+  );
+
+  // Add a case for a user who gave negative feedback multiple times.
+  final persistentNegativeUser = users[2];
+  final firstNegativeTime = referenceTime.subtract(const Duration(days: 60));
+  final secondNegativeTime = referenceTime.subtract(const Duration(days: 20));
+  appReviews.add(
+    AppReview(
+      id: 'ar-multi-neg',
+      userId: persistentNegativeUser.id,
+      initialFeedback: InitialAppReviewFeedback.negative,
+      createdAt: firstNegativeTime,
+      updatedAt: secondNegativeTime,
+      negativeFeedbackHistory: [
+        NegativeFeedback(providedAt: firstNegativeTime, reason: reasons[2]),
+        NegativeFeedback(providedAt: secondNegativeTime, reason: reasons[3]),
+      ],
+    ),
+  );
+
+  return appReviews;
+}

lib/src/fixtures/fixtures.dart

@@ -1,3 +1,4 @@
+export 'app_reviews.dart';
 export 'app_settings.dart';
 export 'countries.dart';
 export 'dashboard_summary.dart';

lib/src/fixtures/remote_configs.dart

@@ -215,20 +215,24 @@ final remoteConfigsFixturesData = <RemoteConfig>[
         },
       ),
       community: CommunityConfig(
+        enabled: true,
         engagement: EngagementConfig(
           enabled: true,
           engagementMode: EngagementMode.reactionsAndComments,
         ),
         reporting: ReportingConfig(
+          enabled: true,
           headlineReportingEnabled: true,
           sourceReportingEnabled: true,
           commentReportingEnabled: true,
         ),
         appReview: AppReviewConfig(
+          enabled: true,
           // User must perform 5 positive actions (e.g., save headline)
           // to become eligible for the review prompt.
           positiveInteractionThreshold: 5,
-          initialPromptCooldownDays: 14,
+          initialPromptCooldownDays: 3,
+          isNegativeFeedbackFollowUpEnabled: true,
         ),
       ),
     ),

lib/src/models/config/app_review_config.dart

@@ -7,69 +7,101 @@ part 'app_review_config.g.dart';
 /// {@template app_review_config}
 /// Defines the remote configuration for the two-layer App Review Funnel.
 ///
-/// This system strategically prompts engaged users for feedback to maximize
-/// positive public reviews while capturing constructive criticism privately.
+/// This system strategically prompts engaged users for feedback to maximize positive
+/// public reviews while capturing constructive criticism privately. It uses a
+/// combination of this configuration, the `UserFeedDecoratorStatus` model, and
+/// the `AppReview` model to manage the user's journey.
 ///
-/// ### How It Works
+/// ### Architectural Workflow
 ///
-/// 1.  **Trigger**: A user becomes eligible to see the prompt after reaching
-///     the [positiveInteractionThreshold] of positive actions (e.g., saves).
+/// 1.  **Eligibility**: A user becomes eligible to see the internal prompt after
+///     reaching the [positiveInteractionThreshold] of positive actions (e.g.,
+///     saving headlines).
 ///
-/// 2.  **Prompt**: The `FeedDecoratorType.rateApp` decorator asks the user
-///     "Are you enjoying the app?". The display logic is managed by the user's
-///     `UserFeedDecoratorStatus` for `rateApp`, which respects the
-///     [initialPromptCooldownDays].
+/// 2.  **Display Logic**: The `FeedDecoratorType.rateApp` decorator's visibility
+///     is controlled by the user's `UserFeedDecoratorStatus` for `rateApp`. The
+///     decorator is only shown if `isCompleted` is `false` and the cooldown
+///     period (defined here as [initialPromptCooldownDays]) has passed since
+///     `lastShownAt`.
 ///
-/// 3.  **Action**:
-///     - **On "Yes"**: The client sets `isCompleted` to `true` on the user's
-///       `UserFeedDecoratorStatus` for `rateApp` and immediately triggers the
-///       native OS in-app review dialog if applicable ie the app is hosted in
-///       google play or apple store. The prompt will not be shown again.
-///     - **On "No"**: The client only updates the `lastShownAt` timestamp on
-///       the status object. The prompt will not be shown again until the
-///       cooldown period has passed. No public review is requested.
+/// 3.  **User Interaction & State Change**:
+///     - **On "Yes" (Positive Feedback)**:
+///       - An `AppReview` record is created/updated with `initialFeedback: positive`
+///         and `wasStoreReviewRequested` is set to `true`.
+///       - The native OS in-app review dialog is immediately triggered. This is a
+///         "fire-and-forget" action; the OS controls if the dialog appears and
+///         provides no feedback to the app.
+///       - The `UserFeedDecoratorStatus` for `rateApp` has its `isCompleted` flag
+///         set to `true`, **permanently preventing the internal prompt from
+///         appearing again for this user.**
+///
+///     - **On "No" (Negative Feedback)**:
+///       - An `AppReview` record is created/updated with `initialFeedback: negative`.
+///         The app may optionally collect a reason, which is stored in the
+///         `negativeFeedbackHistory`.
+///       - The `UserFeedDecoratorStatus` for `rateApp` only has its `lastShownAt`
+///         timestamp updated. `isCompleted` remains `false`.
+///       - The prompt will not be shown again until the cooldown period has
+///         passed, at which point the user may be asked again.
 /// {@endtemplate}
 @immutable
 @JsonSerializable(explicitToJson: true, includeIfNull: true, checked: true)
 class AppReviewConfig extends Equatable {
   /// {@macro app_review_config}
   const AppReviewConfig({
+    required this.enabled,
     required this.positiveInteractionThreshold,
     required this.initialPromptCooldownDays,
+    required this.isNegativeFeedbackFollowUpEnabled,
   });
 
   /// Creates a [AppReviewConfig] from JSON data.
   factory AppReviewConfig.fromJson(Map<String, dynamic> json) =>
       _$AppReviewConfigFromJson(json);
 
+  /// A master switch to enable or disable the entire app review funnel.
+  final bool enabled;
+
   /// The number of positive interactions (e.g., saving a headline) required
   /// to trigger the initial review prompt.
   final int positiveInteractionThreshold;
 
   /// The number of days to wait before showing the initial prompt again if the
-  /// user dismisses it.
+  /// user provides negative feedback.
   final int initialPromptCooldownDays;
 
+  /// A switch to enable or disable the follow-up prompt that asks for a
+  /// text reason after a user provides negative feedback.
+  final bool isNegativeFeedbackFollowUpEnabled;
+
   /// Converts this [AppReviewConfig] instance to JSON data.
   Map<String, dynamic> toJson() => _$AppReviewConfigToJson(this);
 
   @override
   List<Object> get props => [
+    enabled,
     positiveInteractionThreshold,
     initialPromptCooldownDays,
+    isNegativeFeedbackFollowUpEnabled,
   ];
 
   /// Creates a copy of this [AppReviewConfig] but with the given fields
   /// replaced with the new values.
   AppReviewConfig copyWith({
+    bool? enabled,
     int? positiveInteractionThreshold,
     int? initialPromptCooldownDays,
+    bool? isNegativeFeedbackFollowUpEnabled,
   }) {
     return AppReviewConfig(
+      enabled: enabled ?? this.enabled,
       positiveInteractionThreshold:
           positiveInteractionThreshold ?? this.positiveInteractionThreshold,
       initialPromptCooldownDays:
           initialPromptCooldownDays ?? this.initialPromptCooldownDays,
+      isNegativeFeedbackFollowUpEnabled:
+          isNegativeFeedbackFollowUpEnabled ??
+          this.isNegativeFeedbackFollowUpEnabled,
     );
   }
 }

lib/src/models/config/app_review_config.g.dart

@@ -18,6 +18,7 @@ part 'community_config.g.dart';
 class CommunityConfig extends Equatable {
   /// {@macro community_config}
   const CommunityConfig({
+    required this.enabled,
     required this.engagement,
     required this.reporting,
     required this.appReview,
@@ -27,6 +28,9 @@ class CommunityConfig extends Equatable {
   factory CommunityConfig.fromJson(Map<String, dynamic> json) =>
       _$CommunityConfigFromJson(json);
 
+  /// A master switch to enable or disable all community features.
+  final bool enabled;
+
   /// Configuration for user engagement features (reactions, comments).
   final EngagementConfig engagement;
 
@@ -40,16 +44,18 @@ class CommunityConfig extends Equatable {
   Map<String, dynamic> toJson() => _$CommunityConfigToJson(this);
 
   @override
-  List<Object> get props => [engagement, reporting, appReview];
+  List<Object> get props => [enabled, engagement, reporting, appReview];
 
   /// Creates a copy of this [CommunityConfig] but with the given fields
   /// replaced with the new values.
   CommunityConfig copyWith({
+    bool? enabled,
     EngagementConfig? engagement,
     ReportingConfig? reporting,
     AppReviewConfig? appReview,
   }) {
     return CommunityConfig(
+      enabled: enabled ?? this.enabled,
       engagement: engagement ?? this.engagement,
       reporting: reporting ?? this.reporting,
       appReview: appReview ?? this.appReview,