migrates geolocator_web to package:web (#1475)

* migrates geolocator_web to package:web

* fix: depends on geolocator web 4.0

* Apply suggestions from code review

Co-authored-by: Maurits van Beusekom <[email protected]>

* fix: returns a known exception from getCurrentPosition

* style: formatting

* fix: uses PositionUpdateException rather than PlatformException

* fix: remove unused import, fix deprecation warning when using background color

---------

Co-authored-by: Maurits van Beusekom <[email protected]>

Author: josh-burton

geolocator/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 12.0.0
+
+- **BREAKING CHANGE:** Updates dependency on geolocator_web to version [4.0.0](https://pub.dev/packages/geolocator_web/changelog).
+
 ## 11.1.0
 
 - Expose `AndroidPosition` from geolocator.

geolocator/example/lib/main.dart

@@ -118,7 +118,7 @@ class _GeolocatorWidgetState extends State<GeolocatorWidget> {
           ExamplePage(
             Icons.location_on,
             (context) => Scaffold(
-              backgroundColor: Theme.of(context).colorScheme.background,
+              backgroundColor: Theme.of(context).colorScheme.surface,
               body: ListView.builder(
                 itemCount: _positionItems.length,
                 itemBuilder: (context, index) {

geolocator/pubspec.yaml

@@ -2,7 +2,7 @@ name: geolocator
 description: Geolocation plugin for Flutter. This plugin provides a cross-platform (iOS, Android) API for generic location (GPS etc.) functions.
 repository: https://github.com/baseflow/flutter-geolocator/tree/main/geolocator
 issue_tracker: https://github.com/baseflow/flutter-geolocator/issues?q=is%3Aissue+is%3Aopen
-version: 11.1.0
+version: 12.0.0
 
 environment:
   sdk: ">=2.15.0 <4.0.0"
@@ -29,7 +29,7 @@ dependencies:
   geolocator_platform_interface: ^4.1.0
   geolocator_android: ^4.3.0
   geolocator_apple: ^2.3.0
-  geolocator_web: ^3.0.0
+  geolocator_web: ^4.0.0
   geolocator_windows: ^0.2.2
 
 dev_dependencies:

geolocator_web/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.0.0
+
+**BREAKING CHANGE:**
+  - Migrates from dart:html to package:web and dart:js_interop
+  - Migrates to Dart SDK 3.3.0 and Flutter 3.16.0.
+
 ## 3.0.0
 
 **BREAKING CHANGE:**

geolocator_web/lib/src/html_geolocation_manager.dart

@@ -1,46 +1,78 @@
-import 'dart:html' as html;
+import 'dart:async';
+import 'dart:js_interop';
 
 import 'package:geolocator_platform_interface/geolocator_platform_interface.dart';
+import 'package:web/web.dart' as web;
 
 import 'geolocation_manager.dart';
 import 'utils.dart';
 
 /// Implementation of the [GeolocationManager] interface based on the
 /// [html.Geolocation] class.
 class HtmlGeolocationManager implements GeolocationManager {
-  final html.Geolocation _geolocation;
+  final web.Geolocation _geolocation;
 
   /// Creates a new instance of the [HtmlGeolocationManager] class.
-  HtmlGeolocationManager() : _geolocation = html.window.navigator.geolocation;
+  HtmlGeolocationManager() : _geolocation = web.window.navigator.geolocation;
 
   @override
   Future<Position> getCurrentPosition({
     bool? enableHighAccuracy,
     Duration? timeout,
   }) async {
+    Completer<Position> completer = Completer();
     try {
-      final geoPosition = await _geolocation.getCurrentPosition(
-        enableHighAccuracy: enableHighAccuracy,
-        timeout: timeout,
+      _geolocation.getCurrentPosition(
+        (web.GeolocationPosition position) {
+          completer.complete(toPosition(position));
+        }.toJS,
+        (web.GeolocationPositionError error) {
+          completer.completeError(convertPositionError(error));
+        }.toJS,
+        web.PositionOptions(
+          enableHighAccuracy: enableHighAccuracy ?? false,
+          timeout:
+              timeout?.inMicroseconds ?? const Duration(days: 1).inMilliseconds,
+        ),
       );
-
-      return toPosition(geoPosition);
-    } on html.PositionError catch (e) {
-      throw convertPositionError(e);
+    } catch (e) {
+      completer.completeError(const PositionUpdateException(
+          "Something went wrong while getting current position"));
     }
+
+    return completer.future;
   }
 
   @override
   Stream<Position> watchPosition({
     bool? enableHighAccuracy,
     Duration? timeout,
   }) {
-    return _geolocation
-        .watchPosition(
-          enableHighAccuracy: enableHighAccuracy,
-          timeout: timeout,
-        )
-        .handleError((error) => throw convertPositionError(error))
-        .map((geoPosition) => toPosition(geoPosition));
+    int? watchId;
+    StreamController<Position> controller = StreamController<Position>(
+        sync: true,
+        onCancel: () {
+          assert(watchId != null);
+          _geolocation.clearWatch(watchId!);
+        });
+
+    controller.onListen = () {
+      assert(watchId == null);
+      watchId = _geolocation.watchPosition(
+        (web.GeolocationPosition position) {
+          controller.add(toPosition(position));
+        }.toJS,
+        (web.GeolocationPositionError error) {
+          controller.addError(convertPositionError(error));
+        }.toJS,
+        web.PositionOptions(
+          enableHighAccuracy: enableHighAccuracy ?? false,
+          timeout:
+              timeout?.inMicroseconds ?? const Duration(days: 1).inMilliseconds,
+        ),
+      );
+    };
+
+    return controller.stream;
   }
 }

geolocator_web/lib/src/html_permissions_manager.dart

@@ -1,18 +1,17 @@
-import 'dart:html' as html;
-
 import 'package:geolocator_platform_interface/geolocator_platform_interface.dart';
-
+import 'package:web/web.dart' as web;
+import 'dart:js_interop';
 import 'permissions_manager.dart';
 import 'utils.dart';
 
 /// Implementation of the [GeolocationManager] interface based on the
 /// [html.Permissions] class.
 class HtmlPermissionsManager implements PermissionsManager {
   static const _permissionQuery = {'name': 'geolocation'};
-  final html.Permissions? _permissions;
+  final web.Permissions? _permissions;
 
   /// Creates a new instance of the HtmlPermissionsManager class.
-  HtmlPermissionsManager() : _permissions = html.window.navigator.permissions;
+  HtmlPermissionsManager() : _permissions = web.window.navigator.permissions;
 
   @override
   bool get permissionsSupported => _permissions != null;
@@ -23,11 +22,11 @@ class HtmlPermissionsManager implements PermissionsManager {
       return LocationPermission.unableToDetermine;
     }
 
-    final html.PermissionStatus status = await _permissions!.query(
-      _permissionQuery,
-    );
+    // navigator.permissions.query({ name: "geolocation" })
+    final web.PermissionStatus? status =
+        await _permissions?.query(_permissionQuery.jsify() as JSObject).toDart;
 
-    return status.state != null
+    return status != null
         ? toLocationPermission(status.state)
         : LocationPermission.denied;
   }

geolocator_web/lib/src/utils.dart

@@ -1,22 +1,16 @@
 import 'dart:async';
-import 'dart:html' as html;
+import 'package:web/web.dart' as web;
 import 'package:flutter/services.dart';
 import 'package:geolocator_platform_interface/geolocator_platform_interface.dart';
 
 /// Converts the Geoposition object into a [Position] object.
-Position toPosition(html.Geoposition webPosition) {
+Position toPosition(web.GeolocationPosition webPosition) {
   final coords = webPosition.coords;
 
-  if (coords == null) {
-    throw const PositionUpdateException('Received invalid position result.');
-  }
-
   return Position(
     latitude: coords.latitude as double,
     longitude: coords.longitude as double,
-    timestamp: webPosition.timestamp != null
-        ? DateTime.fromMillisecondsSinceEpoch(webPosition.timestamp!)
-        : DateTime.now(),
+    timestamp: DateTime.fromMillisecondsSinceEpoch(webPosition.timestamp),
     altitude: coords.altitude as double? ?? 0.0,
     altitudeAccuracy: coords.altitudeAccuracy as double? ?? 0.0,
     accuracy: coords.accuracy as double? ?? 0.0,
@@ -47,7 +41,7 @@ LocationPermission toLocationPermission(String? webPermission) {
 
 /// Converts an error received from the browser into a custom Geolocator
 /// exception.
-Exception convertPositionError(html.PositionError error) {
+Exception convertPositionError(web.GeolocationPositionError error) {
   switch (error.code) {
     case 1:
       return PermissionDeniedException(error.message);

geolocator_web/pubspec.yaml

@@ -2,7 +2,7 @@ name: geolocator_web
 description: Official web implementation of the geolocator plugin.
 repository: https://github.com/baseflow/flutter-geolocator/tree/main/geolocator_web
 issue_tracker: https://github.com/baseflow/flutter-geolocator/issues?q=is%3Aissue+is%3Aopen
-version: 3.0.0
+version: 4.0.0
 
 flutter:
   plugin:
@@ -17,7 +17,8 @@ dependencies:
     sdk: flutter
   flutter_web_plugins:
     sdk: flutter
-  geolocator_platform_interface: ^4.1.0
+  geolocator_platform_interface: ^4.2.2
+  web: ^0.5.1
 
 dev_dependencies:
   build_runner: ^2.4.8
@@ -28,5 +29,5 @@ dev_dependencies:
 
 
 environment:
-  sdk: '>=2.15.0 <4.0.0'
-  flutter: ">=2.8.0"
+  sdk: '>=3.3.0 <4.0.0'
+  flutter: ">=3.16.0"

geolocator_web/test/geolocator_utils_test.dart

@@ -1,28 +1,26 @@
+@TestOn('browser')
+library;
+
 import 'dart:async';
-import 'dart:html';
+import 'dart:js_interop';
 
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'package:mockito/annotations.dart';
-import 'package:mockito/mockito.dart';
 import 'package:geolocator_platform_interface/geolocator_platform_interface.dart';
 import 'package:geolocator_web/src/utils.dart';
+import 'package:web/web.dart' as web;
 
-import 'geolocator_utils_test.mocks.dart';
+@JSExport()
+class MockGeolocationPositionError {
+  final int code;
+  final String message;
 
-@GenerateNiceMocks([
-  MockSpec<Geoposition>(),
-  MockSpec<PositionError>(),
-])
-void main() {
-  test('toPosition should throw a exception if coords is null', () {
-    final geoposition = MockGeoposition();
-    when(geoposition.coords).thenReturn(null);
+  MockGeolocationPositionError({required this.code, required this.message});
+}
 
-    expect(
-        () => toPosition(geoposition), throwsA(isA<PositionUpdateException>()));
-  });
+typedef GeolocationPosition = web.GeolocationPosition;
 
+void main() {
   test('toLocationPermission returns the correct LocationPermission', () {
     expect(toLocationPermission('granted'), LocationPermission.whileInUse);
     expect(toLocationPermission('prompt'), LocationPermission.denied);
@@ -31,19 +29,20 @@ void main() {
   });
 
   test('convertPositionError returns the correct exception', () {
-    final positionError = MockPositionError();
+    web.GeolocationPositionError createError(int code) {
+      return createJSInteropWrapper<MockGeolocationPositionError>(
+              MockGeolocationPositionError(code: code, message: 'message'))
+          as web.GeolocationPositionError;
+    }
 
-    when(positionError.code).thenReturn(1);
     expect(
-        convertPositionError(positionError), isA<PermissionDeniedException>());
+        convertPositionError(createError(1)), isA<PermissionDeniedException>());
 
-    when(positionError.code).thenReturn(2);
-    expect(convertPositionError(positionError), isA<PositionUpdateException>());
+    expect(
+        convertPositionError(createError(2)), isA<PositionUpdateException>());
 
-    when(positionError.code).thenReturn(3);
-    expect(convertPositionError(positionError), isA<TimeoutException>());
+    expect(convertPositionError(createError(3)), isA<TimeoutException>());
 
-    when(positionError.code).thenReturn(4);
-    expect(convertPositionError(positionError), isA<PlatformException>());
+    expect(convertPositionError(createError(4)), isA<PlatformException>());
   });
 }