Add a customizable card in the dashboard

lib/core/constants/preferences_flags.dart

@@ -34,6 +34,7 @@ enum PreferencesFlag {
   discoveryMore,
 
   // Dashboard flags
+  broadcastCard,
   aboutUsCard,
   scheduleCard,
   progressBarCard,

lib/core/managers/settings_manager.dart

@@ -97,6 +97,13 @@ class SettingsManager with ChangeNotifier {
   Future<Map<PreferencesFlag, int>> getDashboard() async {
     final Map<PreferencesFlag, int> dashboard = {};
 
+    final broadcastCardIndex =
+        await _preferencesService.getInt(PreferencesFlag.broadcastCard) ??
+            getDefaultCardIndex(PreferencesFlag.broadcastCard);
+
+    dashboard.putIfAbsent(
+        PreferencesFlag.broadcastCard, () => broadcastCardIndex);
+
     final aboutUsIndex =
         await _preferencesService.getInt(PreferencesFlag.aboutUsCard) ??
             getDefaultCardIndex(PreferencesFlag.aboutUsCard);
@@ -268,8 +275,9 @@ class SettingsManager with ChangeNotifier {
   }
 
   /// Get the default index of each card
-  int getDefaultCardIndex(PreferencesFlag flag) =>
-      flag.index - PreferencesFlag.aboutUsCard.index;
+  int getDefaultCardIndex(PreferencesFlag flag) {
+    return flag.index - PreferencesFlag.broadcastCard.index;
+  }
 
   bool get calendarViewSetting => _remoteConfigService.scheduleListViewDefault;
 }

lib/core/services/remote_config_service.dart

@@ -8,14 +8,32 @@ import 'package:notredame/locator.dart';
 
 /// Manage the analytics of the application
 class RemoteConfigService {
+  static const String tag = "RemoteConfigService";
   static const _serviceIsDown = "service_is_down";
+
+  // dashboard message remote config keys
+  static const _dashboardMsgToggle = "dashboard_message_toggle";
+  static const _dashboardMsgFr = "dashboard_message_fr";
+  static const _dashboardMsgEn = "dashboard_message_en";
+  static const _dashboardMsgTitleFr = "dashboard_message_title_fr";
+  static const _dashboardMsgTitleEn = "dashboard_message_title_en";
+  static const _dashboardMsgColor = "dashboard_message_color";
+  static const _dashboardMsgUrl = "dashboard_message_url";
+  static const _dashboardMsgType = "dashboard_message_type";
+
   static const _scheduleListViewDefault = "schedule_list_view_default";
   final FirebaseRemoteConfig _remoteConfig = FirebaseRemoteConfig.instance;
   final defaults = <String, dynamic>{
     _serviceIsDown: false,
+    _dashboardMsgFr: "",
+    _dashboardMsgEn: "",
+    _dashboardMsgTitleFr: "",
+    _dashboardMsgTitleEn: "",
+    _dashboardMsgColor: "",
+    _dashboardMsgUrl: "",
+    _dashboardMsgType: "",
     _scheduleListViewDefault: true
   };
-  static const String tag = "RemoteConfigService";
 
   Future initialize() async {
     await _remoteConfig.setDefaults(defaults);
@@ -27,11 +45,51 @@ class RemoteConfigService {
     return _remoteConfig.getBool(_serviceIsDown);
   }
 
+  bool get dashboardMessageActive {
+    fetch();
+    return _remoteConfig.getBool(_dashboardMsgToggle);
+  }
+
   bool get scheduleListViewDefault {
     fetch();
     return _remoteConfig.getBool(_scheduleListViewDefault);
   }
 
+  String get dashboardMessageFr {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgFr);
+  }
+
+  String get dashboardMessageEn {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgEn);
+  }
+
+  String get dashboardMessageTitleFr {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgTitleFr);
+  }
+
+  String get dashboardMessageTitleEn {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgTitleEn);
+  }
+
+  String get dashboardMsgColor {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgColor);
+  }
+
+  String get dashboardMsgUrl {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgUrl);
+  }
+
+  String get dashboardMsgType {
+    fetch();
+    return _remoteConfig.getString(_dashboardMsgType);
+  }
+
   Future<void> fetch() async {
     final AnalyticsService analyticsService = locator<AnalyticsService>();
     try {

lib/core/viewmodels/dashboard_viewmodel.dart

@@ -21,6 +21,7 @@ import 'package:notredame/core/services/siren_flutter_service.dart';
 import 'package:notredame/core/services/preferences_service.dart';
 import 'package:notredame/core/services/analytics_service.dart';
 import 'package:notredame/core/services/app_widget_service.dart';
+import 'package:notredame/core/services/remote_config_service.dart';
 
 // MODEL
 import 'package:notredame/core/models/widget_models.dart';
@@ -39,6 +40,8 @@ class DashboardViewModel extends FutureViewModel<Map<PreferencesFlag, int>> {
   final CourseRepository _courseRepository = locator<CourseRepository>();
   final AnalyticsService _analyticsService = locator<AnalyticsService>();
   final AppWidgetService _appWidgetService = locator<AppWidgetService>();
+  final RemoteConfigService remoteConfigService =
+      locator<RemoteConfigService>();
 
   /// All dashboard displayable cards
   Map<PreferencesFlag, int> _cards;
@@ -58,6 +61,14 @@ class DashboardViewModel extends FutureViewModel<Map<PreferencesFlag, int>> {
   /// Numbers of days elapsed and total number of days of the current session
   List<int> _sessionDays = [0, 0];
 
+  /// Message to display in case of urgent/important broadcast need (Firebase
+  /// remote config), and the associated card title
+  String broadcastMessage = "";
+  String broadcastTitle = "";
+  String broadcastColor = "";
+  String broadcastUrl = "";
+  String broadcastType = "";
+
   /// Get progress of the session
   double get progress => _progress;
 
@@ -189,6 +200,7 @@ class DashboardViewModel extends FutureViewModel<Map<PreferencesFlag, int>> {
 
   Future loadDataAndUpdateWidget() async {
     return Future.wait([
+      futureToRunBroadcast(),
       futureToRunGrades(),
       futureToRunSessionProgressBar(),
       futureToRunSchedule()
@@ -282,13 +294,13 @@ class DashboardViewModel extends FutureViewModel<Map<PreferencesFlag, int>> {
   void setAllCardsVisible() {
     _cards.updateAll((key, value) {
       _settingsManager
-          .setInt(key, key.index - PreferencesFlag.aboutUsCard.index)
+          .setInt(key, key.index - PreferencesFlag.broadcastCard.index)
           .then((value) {
         if (!value) {
           Fluttertoast.showToast(msg: _appIntl.error);
         }
       });
-      return key.index - PreferencesFlag.aboutUsCard.index;
+      return key.index - PreferencesFlag.broadcastCard.index;
     });
 
     getCardsToDisplay();
@@ -535,4 +547,29 @@ class DashboardViewModel extends FutureViewModel<Map<PreferencesFlag, int>> {
           PreferencesFlag.updateAskedVersion, storeVersion.toString());
     }
   }
+
+  Future<void> futureToRunBroadcast() async {
+    setBusyForObject(broadcastMessage, true);
+    setBusyForObject(broadcastTitle, true);
+    setBusyForObject(broadcastColor, true);
+    setBusyForObject(broadcastUrl, true);
+    setBusyForObject(broadcastType, true);
+
+    if (_appIntl.localeName == "fr") {
+      broadcastMessage = remoteConfigService.dashboardMessageFr;
+      broadcastTitle = remoteConfigService.dashboardMessageTitleFr;
+    } else {
+      broadcastMessage = remoteConfigService.dashboardMessageEn;
+      broadcastTitle = remoteConfigService.dashboardMessageTitleEn;
+    }
+    broadcastColor = remoteConfigService.dashboardMsgColor;
+    broadcastUrl = remoteConfigService.dashboardMsgUrl;
+    broadcastType = remoteConfigService.dashboardMsgType;
+
+    setBusyForObject(broadcastMessage, false);
+    setBusyForObject(broadcastTitle, false);
+    setBusyForObject(broadcastColor, false);
+    setBusyForObject(broadcastUrl, false);
+    setBusyForObject(broadcastType, false);
+  }
 }

lib/ui/views/dashboard_view.dart

@@ -1,4 +1,5 @@
 // FLUTTER / DART / THIRD-PARTIES
+import 'package:auto_size_text/auto_size_text.dart';
 import 'package:feature_discovery/feature_discovery.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/scheduler.dart';
@@ -100,8 +101,16 @@ class _DashboardViewState extends State<DashboardView>
   List<Widget> _buildCards(DashboardViewModel model) {
     final List<Widget> cards = List.empty(growable: true);
 
+    // always try to build broadcast cart so the user doesn't miss out on
+    // important info if they dismissed it previously
+
     for (final PreferencesFlag element in model.cardsToDisplay) {
       switch (element) {
+        case PreferencesFlag.broadcastCard:
+          if (model.remoteConfigService.dashboardMessageActive) {
+            cards.add(_buildMessageBroadcastCard(model, element));
+          }
+          break;
         case PreferencesFlag.aboutUsCard:
           cards.add(_buildAboutUsCard(model, element));
           break;
@@ -394,6 +403,79 @@ class _DashboardViewState extends State<DashboardView>
             ]),
       );
 
+  Widget _buildMessageBroadcastCard(
+      DashboardViewModel model, PreferencesFlag flag) {
+    final broadcastMsgColor = Color(int.parse(model.broadcastColor));
+    final broadcastMsgType = model.broadcastType;
+    final broadcastMsgUrl = model.broadcastUrl;
+    return DismissibleCard(
+        key: UniqueKey(),
+        onDismissed: (DismissDirection direction) {
+          dismissCard(model, flag);
+        },
+        isBusy: model.busy(model.broadcastMessage),
+        cardColor: broadcastMsgColor,
+        child: Padding(
+          padding: const EdgeInsets.fromLTRB(17, 10, 15, 20),
+          child: Column(mainAxisSize: MainAxisSize.min, children: [
+            // title row
+            Row(
+              children: [
+                Expanded(
+                  child: Align(
+                    alignment: Alignment.centerLeft,
+                    child: Text(model.broadcastTitle,
+                        style: Theme.of(context).primaryTextTheme.headline6),
+                  ),
+                ),
+                Align(
+                  alignment: Alignment.centerRight,
+                  child: InkWell(
+                    child: getBroadcastIcon(broadcastMsgType, broadcastMsgUrl),
+                  ),
+                ),
+              ],
+            ),
+            // main text
+            AutoSizeText(model.broadcastMessage ?? "",
+                style: Theme.of(context).primaryTextTheme.bodyText2)
+          ]),
+        ));
+  }
+
+  Widget getBroadcastIcon(String type, String url) {
+    switch (type) {
+      case "warning":
+        return const Icon(
+          Icons.warning_rounded,
+          color: AppTheme.lightThemeBackground,
+          size: 36.0,
+        );
+      case "alert":
+        return const Icon(
+          Icons.error,
+          color: AppTheme.lightThemeBackground,
+          size: 36.0,
+        );
+      case "link":
+        return IconButton(
+          onPressed: () {
+            Utils.launchURL(url, AppIntl.of(context));
+          },
+          icon: const Icon(
+            Icons.open_in_new,
+            color: AppTheme.lightThemeBackground,
+            size: 30.0,
+          ),
+        );
+    }
+    return const Icon(
+      Icons.campaign,
+      color: AppTheme.lightThemeBackground,
+      size: 36.0,
+    );
+  }
+
   void dismissCard(DashboardViewModel model, PreferencesFlag flag) {
     model.hideCard(flag);
   }

pubspec.yaml

@@ -5,7 +5,7 @@ description: The 4th generation of ÉTSMobile, the main gateway between the Éco
 # pub.dev using `pub publish`. This is preferred for private packages.
 publish_to: 'none' # Remove this line if you wish to publish to pub.dev
 
-version: 4.25.3+1
+version: 4.26.0+1
 
 environment:
   sdk: ">=2.10.0 <3.0.0"

test/managers/settings_manager_test.dart

@@ -440,17 +440,20 @@ void main() {
 
         // Cards
         final Map<PreferencesFlag, int> expected = {
-          PreferencesFlag.aboutUsCard: 0,
-          PreferencesFlag.scheduleCard: 1,
-          PreferencesFlag.progressBarCard: 2,
-          PreferencesFlag.gradesCard: 3
+          PreferencesFlag.broadcastCard: 0,
+          PreferencesFlag.aboutUsCard: 1,
+          PreferencesFlag.scheduleCard: 2,
+          PreferencesFlag.progressBarCard: 3,
+          PreferencesFlag.gradesCard: 4
         };
 
         expect(
           await manager.getDashboard(),
           expected,
         );
 
+        verify(preferencesService.getInt(PreferencesFlag.broadcastCard))
+            .called(1);
         verify(preferencesService.getInt(PreferencesFlag.aboutUsCard))
             .called(1);
         verify(preferencesService.getInt(PreferencesFlag.scheduleCard))
@@ -464,37 +467,44 @@ void main() {
       });
 
       test("validate the loading of the cards", () async {
+        PreferencesServiceMock.stubGetInt(
+            preferencesService as PreferencesServiceMock,
+            PreferencesFlag.broadcastCard,
+            toReturn: 0);
         PreferencesServiceMock.stubGetInt(
             preferencesService as PreferencesServiceMock,
             PreferencesFlag.aboutUsCard,
-            // ignore: avoid_redundant_argument_values
-            toReturn: 1);
+            toReturn: 2);
         PreferencesServiceMock.stubGetInt(
             preferencesService as PreferencesServiceMock,
             PreferencesFlag.scheduleCard,
-            toReturn: 2);
+            toReturn: 3);
         PreferencesServiceMock.stubGetInt(
             preferencesService as PreferencesServiceMock,
             PreferencesFlag.progressBarCard,
-            toReturn: 0);
+            // ignore: avoid_redundant_argument_values
+            toReturn: 1);
         PreferencesServiceMock.stubGetInt(
             preferencesService as PreferencesServiceMock,
             PreferencesFlag.gradesCard,
-            toReturn: 3);
+            toReturn: 4);
 
         // Cards
         final Map<PreferencesFlag, int> expected = {
-          PreferencesFlag.aboutUsCard: 1,
-          PreferencesFlag.scheduleCard: 2,
-          PreferencesFlag.progressBarCard: 0,
-          PreferencesFlag.gradesCard: 3
+          PreferencesFlag.broadcastCard: 0,
+          PreferencesFlag.aboutUsCard: 2,
+          PreferencesFlag.scheduleCard: 3,
+          PreferencesFlag.progressBarCard: 1,
+          PreferencesFlag.gradesCard: 4
         };
 
         expect(
           await manager.getDashboard(),
           expected,
         );
 
+        verify(preferencesService.getInt(PreferencesFlag.broadcastCard))
+            .called(1);
         verify(preferencesService.getInt(PreferencesFlag.aboutUsCard))
             .called(1);
         verify(preferencesService.getInt(PreferencesFlag.scheduleCard))