Merge pull request #738 from Baseflow/callback_locationservice_platform_interface

Callback locationservice platform interface

Author: mvanbeusekom

geolocator_platform_interface/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.0
+
+- Added the possibility to start a stream which will return an event when Location Services are manually enabled/disabled
+
 ## 2.0.2
 
 - Added definition of the `ActivityMissingException`.

geolocator_platform_interface/lib/src/enums/enums.dart

@@ -1,2 +1,3 @@
 export 'location_accuracy.dart';
 export 'location_permission.dart';
+export 'location_service.dart';

geolocator_platform_interface/lib/src/enums/location_service.dart

@@ -0,0 +1,8 @@
+/// Describes the current state of the location service on the native platform.
+enum ServiceStatus {
+  /// Indicates that the location service on the native platform is enabled.
+  disabled,
+
+  /// Indicates that the location service on the native platform is enabled.
+  enabled,
+}

geolocator_platform_interface/lib/src/geolocator_platform_interface.dart

@@ -107,6 +107,14 @@ abstract class GeolocatorPlatform extends PlatformInterface {
     throw UnimplementedError('getCurrentPosition() has not been implemented.');
   }
 
+  /// Fires when the Location Service is manually disabled or enabled f.e.
+  /// when Location Service in Settings is disabled, a event will be fired which
+  /// returns a [LocationServiceStatus].
+  Stream<ServiceStatus> getServiceStatusStream() {
+    throw UnimplementedError(
+        'getServiceStatusStream() has not been implemented.');
+  }
+
   /// Fires whenever the location changes inside the bounds of the
   /// [desiredAccuracy].
   ///

geolocator_platform_interface/lib/src/implementations/method_channel_geolocator.dart

@@ -21,13 +21,19 @@ class MethodChannelGeolocator extends GeolocatorPlatform {
   static const _eventChannel =
       EventChannel('flutter.baseflow.com/geolocator_updates');
 
+  /// The event channel used to receive [LocationServiceStatus] updates from the
+  /// native platform.
+  static const _serviceStatusEventChannel =
+      EventChannel('flutter.baseflow.com/geolocator_service_updates');
+
   /// On Android devices you can set [forceAndroidLocationManager]
   /// to true to force the plugin to use the [LocationManager] to determine the
   /// position instead of the [FusedLocationProviderClient]. On iOS this is
   /// ignored.
   bool forceAndroidLocationManager = false;
 
   Stream<Position>? _positionStream;
+  Stream<ServiceStatus>? _serviceStatusStream;
 
   @override
   Future<LocationPermission> checkPermission() async {
@@ -121,6 +127,27 @@ class MethodChannelGeolocator extends GeolocatorPlatform {
     }
   }
 
+  @override
+  Stream<ServiceStatus> getServiceStatusStream() {
+    if (_serviceStatusStream != null) {
+      return _serviceStatusStream!;
+    }
+    var serviceStatusStream =
+        _serviceStatusEventChannel.receiveBroadcastStream();
+
+    _serviceStatusStream = serviceStatusStream
+        .map((dynamic element) => ServiceStatus.values[element as int])
+        .handleError((error) {
+      _serviceStatusStream = null;
+      if (error is PlatformException) {
+        _handlePlatformException(error);
+      }
+      throw error;
+    });
+
+    return _serviceStatusStream!;
+  }
+
   @override
   Stream<Position> getPositionStream({
     LocationAccuracy desiredAccuracy = LocationAccuracy.best,

geolocator_platform_interface/pubspec.yaml

@@ -3,7 +3,7 @@ description: A common platform interface for the geolocator plugin.
 homepage: https://github.com/baseflow/flutter-geolocator
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 2.0.2
+version: 2.1.0
 
 dependencies:
   flutter:

geolocator_platform_interface/test/geolocator_platform_interface_test.dart

@@ -101,6 +101,20 @@ void main() {
       );
     });
 
+    test(
+        // ignore: lines_longer_than_80_chars
+        'Default implementation of getServiceStatusStream should throw unimplemented error',
+        () {
+      // Arrange
+      final geolocatorPlatform = ExtendsGeolocatorPlatform();
+
+      // Act & Assert
+      expect(
+        geolocatorPlatform.getServiceStatusStream,
+        throwsUnimplementedError,
+      );
+    });
+
     test(
         // ignore: lines_longer_than_80_chars
         'Default implementation of getPositionStream should throw unimplemented error',

geolocator_platform_interface/test/src/implementations/method_channel_geolocator_test.dart

@@ -5,7 +5,7 @@ import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:geolocator_platform_interface/geolocator_platform_interface.dart';
 import 'package:geolocator_platform_interface/src/implementations/method_channel_geolocator.dart';
-
+import 'package:geolocator_platform_interface/src/enums/location_service.dart';
 import 'event_channel_mock.dart';
 import 'method_channel_mock.dart';
 
@@ -556,6 +556,95 @@ void main() {
         });
       });
 
+      group(
+          // ignore: lines_longer_than_80_chars
+          'getServiceStream: When requesting a stream of location service status updates',
+          () {
+        group(
+            'And requesting for location service status updates multiple times',
+            () {
+          test('Should return the same stream', () {
+            final methodChannelGeolocator = MethodChannelGeolocator();
+            final firstStream =
+                methodChannelGeolocator.getServiceStatusStream();
+            final secondstream =
+                methodChannelGeolocator.getServiceStatusStream();
+
+            expect(
+              identical(firstStream, secondstream),
+              true,
+            );
+          });
+        });
+      });
+
+      test(
+          // ignore: lines_longer_than_80_chars
+          'Should receive a stream with location service updates if permissions are granted',
+          () async {
+        // Arrange
+        final streamController = StreamController<int>.broadcast();
+        EventChannelMock(
+            channelName: 'flutter.baseflow.com/geolocator_service_updates',
+            stream: streamController.stream);
+
+        // Act
+        final locationServiceStream =
+            MethodChannelGeolocator().getServiceStatusStream();
+        final streamQueue = StreamQueue(locationServiceStream);
+
+        // Emit test events
+        streamController.add(0); // disabled value in native enum
+        streamController.add(1); // enabled value in native enum
+
+        //Assert
+        expect(await streamQueue.next, ServiceStatus.disabled);
+        expect(await streamQueue.next, ServiceStatus.enabled);
+
+        // Clean up
+        await streamQueue.cancel();
+        await streamController.close();
+      });
+
+      test(
+          // ignore: lines_longer_than_80_chars
+          'Should receive an exception if android activity is missing',
+          () async {
+        // Arrange
+        final streamController =
+            StreamController<PlatformException>.broadcast();
+        EventChannelMock(
+          channelName: 'flutter.baseflow.com/geolocator_service_updates',
+          stream: streamController.stream,
+        );
+
+        // Act
+        final positionStream =
+            MethodChannelGeolocator().getServiceStatusStream();
+        final streamQueue = StreamQueue(positionStream);
+
+        // Emit test error
+        streamController.addError(PlatformException(
+            code: 'ACTIVITY_MISSING',
+            message: 'Activity missing',
+            details: null));
+
+        // Assert
+        expect(
+            streamQueue.next,
+            throwsA(
+              isA<ActivityMissingException>().having(
+                (e) => e.message,
+                'message',
+                'Activity missing',
+              ),
+            ));
+
+        // Clean up
+        streamQueue.cancel();
+        streamController.close();
+      });
+
       test(
           // ignore: lines_longer_than_80_chars
           'Should receive a stream with position updates if permissions are granted',