refactor: Remove duplicate code

Author: Dev-hwang

android/src/main/kotlin/com/pravera/flutter_foreground_task/service/ForegroundService.kt

@@ -22,6 +22,9 @@ import com.pravera.flutter_foreground_task.models.*
 import com.pravera.flutter_foreground_task.utils.ForegroundServiceUtils
 import com.pravera.flutter_foreground_task.utils.PluginUtils
 import kotlinx.coroutines.*
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.update
 import java.util.*
 
 /**
@@ -40,15 +43,14 @@ class ForegroundService : Service() {
         private const val ACTION_NOTIFICATION_DISMISSED = "onNotificationDismissed"
         private const val INTENT_DATA_FIELD_NAME = "data"
 
-        /** Returns whether the foreground service is running. */
-        var isRunningService = false
-            private set
+        private val _isRunningServiceState = MutableStateFlow(false)
+        val isRunningServiceState = _isRunningServiceState.asStateFlow()
 
         private var foregroundTask: ForegroundTask? = null
         private var taskLifecycleListeners = ForegroundTaskLifecycleListeners()
 
         fun sendData(data: Any?) {
-            if (isRunningService) {
+            if (isRunningServiceState.value) {
                 foregroundTask?.invokeMethod(ACTION_RECEIVE_DATA, data)
             }
         }
@@ -247,14 +249,15 @@ class ForegroundService : Service() {
         releaseLockMode()
         acquireLockMode()
 
-        isRunningService = true
+        _isRunningServiceState.update { true }
     }
 
     private fun stopForegroundService() {
         releaseLockMode()
         stopForeground(true)
         stopSelf()
-        isRunningService = false
+
+        _isRunningServiceState.update { false }
     }
 
     @RequiresApi(Build.VERSION_CODES.O)

android/src/main/kotlin/com/pravera/flutter_foreground_task/service/ForegroundServiceManager.kt

@@ -21,7 +21,7 @@ import com.pravera.flutter_foreground_task.models.NotificationOptions
 class ForegroundServiceManager {
 	/** Start the foreground service. */
 	fun start(context: Context, arguments: Any?) {
-		if (ForegroundService.isRunningService) {
+		if (isRunningService()) {
 			throw ServiceAlreadyStartedException()
 		}
 
@@ -37,7 +37,7 @@ class ForegroundServiceManager {
 
 	/** Restart the foreground service. */
 	fun restart(context: Context) {
-		if (!ForegroundService.isRunningService) {
+		if (!isRunningService()) {
 			throw ServiceNotStartedException()
 		}
 
@@ -48,7 +48,7 @@ class ForegroundServiceManager {
 
 	/** Update the foreground service. */
 	fun update(context: Context, arguments: Any?) {
-		if (!ForegroundService.isRunningService) {
+		if (!isRunningService()) {
 			throw ServiceNotStartedException()
 		}
 
@@ -63,7 +63,7 @@ class ForegroundServiceManager {
 
 	/** Stop the foreground service. */
 	fun stop(context: Context) {
-		if (!ForegroundService.isRunningService) {
+		if (!isRunningService()) {
 			throw ServiceNotStartedException()
 		}
 
@@ -84,5 +84,5 @@ class ForegroundServiceManager {
 	}
 
 	/** Returns whether the foreground service is running. */
-	fun isRunningService(): Boolean = ForegroundService.isRunningService
+	fun isRunningService(): Boolean = ForegroundService.isRunningServiceState.value
 }

lib/flutter_foreground_task.dart

@@ -17,6 +17,7 @@ import 'models/notification_options.dart';
 import 'models/notification_permission.dart';
 import 'models/service_request_result.dart';
 import 'task_handler.dart';
+import 'utils/utility.dart';
 
 export 'errors/service_already_started_exception.dart';
 export 'errors/service_not_initialized_exception.dart';
@@ -101,11 +102,11 @@ class FlutterForegroundTask {
     List<NotificationButton>? notificationButtons,
     Function? callback,
   }) async {
-    if (!isInitialized) {
-      return ServiceRequestResult.error(ServiceNotInitializedException());
-    }
-
     try {
+      if (!isInitialized) {
+        throw ServiceNotInitializedException();
+      }
+
       if (await isRunningService) {
         throw ServiceAlreadyStartedException();
       }
@@ -123,25 +124,7 @@ class FlutterForegroundTask {
       );
 
       if (!skipServiceResponseCheck) {
-        final Stopwatch stopwatch = Stopwatch()..start();
-        bool isStarted = false;
-        await Future.doWhile(() async {
-          isStarted = await isRunningService;
-
-          // official doc: Once the service has been created, the service must call its startForeground() method within five seconds.
-          // ref: https://developer.android.com/guide/components/services#StartingAService
-          if (isStarted || stopwatch.elapsedMilliseconds > 5 * 1000) {
-            return false;
-          } else {
-            await Future.delayed(const Duration(milliseconds: 100));
-            return true;
-          }
-        });
-
-        // no response :(
-        if (!isStarted) {
-          throw ServiceTimeoutException();
-        }
+        await checkServiceStateChange(target: true);
       }
 
       return ServiceRequestResult.success();
@@ -204,25 +187,7 @@ class FlutterForegroundTask {
       await _platform.stopService();
 
       if (!skipServiceResponseCheck) {
-        final Stopwatch stopwatch = Stopwatch()..start();
-        bool isStopped = false;
-        await Future.doWhile(() async {
-          isStopped = !(await isRunningService);
-
-          // official doc: Once the service has been created, the service must call its startForeground() method within five seconds.
-          // ref: https://developer.android.com/guide/components/services#StartingAService
-          if (isStopped || stopwatch.elapsedMilliseconds > 5 * 1000) {
-            return false;
-          } else {
-            await Future.delayed(const Duration(milliseconds: 100));
-            return true;
-          }
-        });
-
-        // no response :(
-        if (!isStopped) {
-          throw ServiceTimeoutException();
-        }
+        await checkServiceStateChange(target: false);
       }
 
       return ServiceRequestResult.success();
@@ -231,6 +196,22 @@ class FlutterForegroundTask {
     }
   }
 
+  @visibleForTesting
+  static Future<void> checkServiceStateChange({required bool target}) async {
+    // official doc: Once the service has been created, the service must call its startForeground() method within 5 seconds.
+    // ref: https://developer.android.com/guide/components/services#StartingAService
+    final bool isCompleted = await Utility.instance.completedWithinDeadline(
+      deadline: const Duration(seconds: 5),
+      future: () async {
+        return target == await isRunningService;
+      },
+    );
+
+    if (!isCompleted) {
+      throw ServiceTimeoutException();
+    }
+  }
+
   /// Returns whether the foreground service is running.
   static Future<bool> get isRunningService => _platform.isRunningService;
 

lib/models/notification_button.dart

@@ -1,5 +1,7 @@
 import 'dart:ui';
 
+import 'package:flutter_foreground_task/utils/color_extension.dart';
+
 /// The button to display in the notification.
 class NotificationButton {
   /// Constructs an instance of [NotificationButton].
@@ -21,10 +23,7 @@ class NotificationButton {
 
   /// Returns the data fields of [NotificationButton] in JSON format.
   Map<String, dynamic> toJson() {
-    String? textColorRgb;
-    if (textColor != null) {
-      textColorRgb = '${textColor!.red},${textColor!.green},${textColor!.blue}';
-    }
+    final String? textColorRgb = textColor?.toRgbString;
 
     return {
       'id': id,

lib/models/notification_icon_data.dart

@@ -1,5 +1,7 @@
 import 'dart:ui';
 
+import 'package:flutter_foreground_task/utils/color_extension.dart';
+
 /// The resource type of the notification icon.
 enum ResourceType {
   /// A resources in the drawable folder.
@@ -48,11 +50,7 @@ class NotificationIconData {
 
   /// Returns the data fields of [NotificationIconData] in JSON format.
   Map<String, dynamic> toJson() {
-    String? backgroundColorRgb;
-    if (backgroundColor != null) {
-      backgroundColorRgb =
-          '${backgroundColor!.red},${backgroundColor!.green},${backgroundColor!.blue}';
-    }
+    final String? backgroundColorRgb = backgroundColor?.toRgbString;
 
     return {
       'resType': resType.toString().split('.').last,

lib/ui/with_foreground_task.dart

@@ -9,10 +9,7 @@ class WithForegroundTask extends StatefulWidget {
   /// A child widget that contains the [Scaffold] widget.
   final Widget child;
 
-  const WithForegroundTask({
-    Key? key,
-    required this.child,
-  }) : super(key: key);
+  const WithForegroundTask({super.key, required this.child});
 
   @override
   State<StatefulWidget> createState() => _WithForegroundTaskState();

lib/utils/color_extension.dart

@@ -0,0 +1,5 @@
+import 'dart:ui';
+
+extension ColorExtension on Color {
+  String get toRgbString => '$red,$green,$blue';
+}

lib/utils/utility.dart

@@ -0,0 +1,26 @@
+final class Utility {
+  Utility._();
+
+  static Utility instance = Utility._();
+
+  Future<bool> completedWithinDeadline({
+    required Duration deadline,
+    required Future<bool> Function() future,
+    Duration tick = const Duration(milliseconds: 100),
+  }) async {
+    final Stopwatch stopwatch = Stopwatch()..start();
+    bool completed = false;
+    await Future.doWhile(() async {
+      completed = await future();
+      if (completed ||
+          stopwatch.elapsedMilliseconds > deadline.inMilliseconds) {
+        return false;
+      } else {
+        await Future.delayed(tick);
+        return true;
+      }
+    });
+
+    return completed;
+  }
+}