Add setting for background service interval

vicolo-dev · Sep 16, 2024 · 70228bb · 70228bb
1 parent cd0fd9d
commit 70228bb
Show file tree

Hide file tree

Showing 3 changed files with 127 additions and 102 deletions.
diff --git a/lib/l10n/app_en.arb b/lib/l10n/app_en.arb
@@ -769,6 +769,7 @@
   "numeralTypeSetting": "Numeral type",
   "romanNumeral": "Roman",
   "arabicNumeral": "Arabic",
-  "showDigitalClock": "Show digital clock"
-
+  "showDigitalClock": "Show digital clock",
+  "backgroundServiceIntervalSetting": "Background service interval",
+  "backgroundServiceIntervalSettingDescription": "Lower interval will help keep the app alive, at the cost of some battery life"
 }
diff --git a/lib/settings/data/general_settings_schema.dart b/lib/settings/data/general_settings_schema.dart
@@ -18,6 +18,7 @@ import 'package:clock_app/settings/types/setting.dart';
 import 'package:clock_app/settings/types/setting_action.dart';
 import 'package:clock_app/settings/types/setting_group.dart';
 import 'package:clock_app/settings/types/setting_link.dart';
+import 'package:clock_app/system/logic/background_service.dart';
 import 'package:clock_app/system/logic/permissions.dart';
 import 'package:clock_app/widgets/logic/update_widgets.dart';
 import 'package:flutter/foundation.dart';
@@ -187,18 +188,17 @@ SettingGroup generalSettingsSchema = SettingGroup(
             (context) => AppLocalizations.of(context)!.pickerSpinner,
             DurationPickerType.spinner,
           ),
-           SelectSettingOption(
+          SelectSettingOption(
             (context) => AppLocalizations.of(context)!.pickerNumpad,
             DurationPickerType.numpad,
           ),
-
         ],
             searchTags: [
               "duration",
               "rings",
               "time",
               "numpad"
-              "picker",
+                  "picker",
               "dial",
               "input",
               "spinner",
@@ -229,15 +229,15 @@ SettingGroup generalSettingsSchema = SettingGroup(
         "Long Press Action",
         (context) => AppLocalizations.of(context)!.longPressActionSetting,
         [
-        SelectSettingOption(
+          SelectSettingOption(
             (context) => AppLocalizations.of(context)!.longPressSelectAction,
             LongPressAction.multiSelect,
           ),
           SelectSettingOption(
             (context) => AppLocalizations.of(context)!.longPressReorderAction,
             LongPressAction.reorder,
           ),
-                  ],
+        ],
       ),
     ]),
     SettingPageLink(
@@ -254,98 +254,120 @@ SettingGroup generalSettingsSchema = SettingGroup(
       searchTags: ["tags", "groups", "filter"],
       icon: Icons.label_outline_rounded,
     ),
-    SettingGroup("Reliability",
-        (context) => AppLocalizations.of(context)!.reliabilitySettingGroup, [
-      SwitchSetting(
-        "Show Foreground Notification",
-        (context) => AppLocalizations.of(context)!.showForegroundNotification,
-        false,
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.showForegroundNotificationDescription,
-      ),
-      SettingAction(
-        "Ignore Battery Optimizations",
-        (context) =>
-            AppLocalizations.of(context)!.ignoreBatteryOptimizationSetting,
-        (context) async {
-          requestBatteryOptimizationPermission(
-              onAlreadyGranted: () => {
-                    showSnackBar(
-                        context,
-                        AppLocalizations.of(context)!
-                            .ignoreBatteryOptimizationAlreadyGranted)
-                  });
-        },
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.batteryOptimizationSettingDescription,
-      ),
-      SettingAction(
-        "Notifications",
-        (context) =>
-            AppLocalizations.of(context)!.notificationPermissionSetting,
-        (context) async {
-          requestNotificationPermissions(
-              onAlreadyGranted: () => {
-                    showSnackBar(
-                        context,
-                        AppLocalizations.of(context)!
-                            .notificationPermissionAlreadyGranted)
-                  });
-        },
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.notificationPermissionDescription,
-      ),
-      SettingAction(
-        "Vendor Specific",
-        (context) => AppLocalizations.of(context)!.vendorSetting,
-        (context) => launchUrl(Uri.parse("https://dontkillmyapp.com")),
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.vendorSettingDescription,
-      ),
-      SettingAction(
-        "Disable Battery Optimization",
-        (context) => AppLocalizations.of(context)!.batteryOptimizationSetting,
-        (context) async {
-          AppSettings.openAppSettings(
-              type: AppSettingsType.batteryOptimization);
-        },
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.batteryOptimizationSettingDescription,
-      ),
-      SettingAction(
-        "Allow Notifications",
-        (context) => AppLocalizations.of(context)!.allowNotificationSetting,
-        (context) async {
-          AppSettings.openAppSettings(type: AppSettingsType.notification);
-        },
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.allowNotificationSettingDescription,
-      ),
-      SettingAction(
-        "Auto Start",
-        (context) => AppLocalizations.of(context)!.autoStartSetting,
-        (context) async {
-          try {
-            //check auto-start availability.
-            var test = (await isAutoStartAvailable) ?? false;
-            //if available then navigate to auto-start setting page.
-            if (test) {
-              await getAutoStartPermission();
-            } else {
-              // ignore: use_build_context_synchronously
-              if (context.mounted) {
-                showSnackBar(
-                    context, "Auto Start is not available for your device");
+    SettingGroup(
+      "Reliability",
+      (context) => AppLocalizations.of(context)!.reliabilitySettingGroup,
+      [
+        SwitchSetting(
+          "Show Foreground Notification",
+          (context) => AppLocalizations.of(context)!.showForegroundNotification,
+          false,
+          getDescription: (context) => AppLocalizations.of(context)!
+              .showForegroundNotificationDescription,
+          searchTags: ["foreground", "notification"],
+        ),
+        SliderSetting(
+          "backgroundServiceInterval",
+          (context) =>
+              AppLocalizations.of(context)!.backgroundServiceIntervalSetting,
+          15,
+          300,
+          60,
+          unit: "m",
+          snapLength: 15,
+          getDescription: (context) => AppLocalizations.of(context)!
+              .backgroundServiceIntervalSettingDescription,
+          searchTags: ["background", "service", "interval"],
+          onChange: (context, value) {
+            initBackgroundService(interval: value.toInt());
+          },
+        ),
+        SettingAction(
+          "Ignore Battery Optimizations",
+          (context) =>
+              AppLocalizations.of(context)!.ignoreBatteryOptimizationSetting,
+          (context) async {
+            requestBatteryOptimizationPermission(
+                onAlreadyGranted: () => {
+                      showSnackBar(
+                          context,
+                          AppLocalizations.of(context)!
+                              .ignoreBatteryOptimizationAlreadyGranted)
+                    });
+          },
+          getDescription: (context) => AppLocalizations.of(context)!
+              .batteryOptimizationSettingDescription,
+        ),
+        SettingAction(
+          "Notifications",
+          (context) =>
+              AppLocalizations.of(context)!.notificationPermissionSetting,
+          (context) async {
+            requestNotificationPermissions(
+                onAlreadyGranted: () => {
+                      showSnackBar(
+                          context,
+                          AppLocalizations.of(context)!
+                              .notificationPermissionAlreadyGranted)
+                    });
+          },
+          getDescription: (context) =>
+              AppLocalizations.of(context)!.notificationPermissionDescription,
+        ),
+        SettingAction(
+          "Vendor Specific",
+          (context) => AppLocalizations.of(context)!.vendorSetting,
+          (context) => launchUrl(Uri.parse("https://dontkillmyapp.com")),
+          getDescription: (context) =>
+              AppLocalizations.of(context)!.vendorSettingDescription,
+        ),
+        SettingAction(
+          "Disable Battery Optimization",
+          (context) => AppLocalizations.of(context)!.batteryOptimizationSetting,
+          (context) async {
+            AppSettings.openAppSettings(
+                type: AppSettingsType.batteryOptimization);
+          },
+          getDescription: (context) => AppLocalizations.of(context)!
+              .batteryOptimizationSettingDescription,
+
+        ),
+        SettingAction(
+          "Allow Notifications",
+          (context) => AppLocalizations.of(context)!.allowNotificationSetting,
+          (context) async {
+            AppSettings.openAppSettings(type: AppSettingsType.notification);
+          },
+          getDescription: (context) =>
+              AppLocalizations.of(context)!.allowNotificationSettingDescription,
+        ),
+        SettingAction(
+          "Auto Start",
+          (context) => AppLocalizations.of(context)!.autoStartSetting,
+          (context) async {
+            try {
+              //check auto-start availability.
+              var test = (await isAutoStartAvailable) ?? false;
+              //if available then navigate to auto-start setting page.
+              if (test) {
+                await getAutoStartPermission();
+              } else {
+                // ignore: use_build_context_synchronously
+                if (context.mounted) {
+                  showSnackBar(
+                      context, "Auto Start is not available for your device");
+                }
               }
+            } on PlatformException catch (e) {
+              if (kDebugMode) print(e.message);
             }
-          } on PlatformException catch (e) {
-            if (kDebugMode) print(e.message);
-          }
-        },
-        getDescription: (context) =>
-            AppLocalizations.of(context)!.autoStartSettingDescription,
-      ),
-    ]),
+          },
+          getDescription: (context) =>
+              AppLocalizations.of(context)!.autoStartSettingDescription,
+        ),
+      ],
+      searchTags: ["reliability", "battery", "optimization", "notifications"],
+    ),
     SelectSetting(
       "Default Tab",
       (context) => AppLocalizations.of(context)!.defaultPageSetting,
@@ -368,7 +390,6 @@ SettingGroup generalSettingsSchema = SettingGroup(
         ),
       ],
     ),
-
   ],
   icon: FluxIcons.settings,
   getDescription: (context) =>

diff --git a/lib/system/logic/background_service.dart b/lib/system/logic/background_service.dart
@@ -5,10 +5,12 @@ import 'package:clock_app/system/logic/initialize_isolate.dart';
 import 'package:clock_app/timer/logic/update_timers.dart';
 import 'package:flutter/material.dart';
 
-Future<void> initBackgroundService() async {
+Future<void> initBackgroundService({int interval = 60}) async {
+  assert(
+      interval >= 15, "Interval must be greater than or equal to 15 minutes.");
   await BackgroundFetch.configure(
       BackgroundFetchConfig(
-          minimumFetchInterval: 30,
+          minimumFetchInterval: interval,
           stopOnTerminate: false,
           enableHeadless: true,
           requiresBatteryNotLow: false,
@@ -40,8 +42,9 @@ Future<void> initBackgroundService() async {
 // [Android-only] This "Headless Task" is run when the Android app is terminated with `enableHeadless: true`
 @pragma('vm:entry-point')
 void handleBackgroundServiceTask(HeadlessTask task) async {
-    FlutterError.onError = (FlutterErrorDetails details) {
-    logger.f("Error in handleBackgroundServiceTask isolate: ${details.exception.toString()}");
+  FlutterError.onError = (FlutterErrorDetails details) {
+    logger.f(
+        "Error in handleBackgroundServiceTask isolate: ${details.exception.toString()}");
   };
   String taskId = task.taskId;
   bool isTimeout = task.timeout;