migrate to package:web (#1303)

raldhafiri · web-flow · commit c4a2034baed7 · 2024-07-26T11:53:54.000+02:00
diff --git a/permission_handler_html/CHANGELOG.md b/permission_handler_html/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.1.2
+
+* Migrate to package:web and adding wasm support.
+
 ## 0.1.1
 
 * Updates the dependency on `permission_handler_platform_interface` to version 4.1.0 (SiriKit support is only available for iOS and macOS).
diff --git a/permission_handler_html/example/analysis_options.yaml b/permission_handler_html/example/analysis_options.yaml
@@ -0,0 +1,28 @@
+# This file configures the analyzer, which statically analyzes Dart code to
+# check for errors, warnings, and lints.
+#
+# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
+# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
+# invoked from the command line by running `flutter analyze`.
+
+# The following line activates a set of recommended lints for Flutter apps,
+# packages, and plugins designed to encourage good coding practices.
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  # The lint rules applied to this project can be customized in the
+  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
+  # included above or to enable additional rules. A list of all available lints
+  # and their documentation is published at https://dart.dev/lints.
+  #
+  # Instead of disabling a lint rule for the entire project in the
+  # section below, it can also be suppressed for a single line of code
+  # or a specific dart file by using the `// ignore: name_of_lint` and
+  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
+  # producing the lint.
+  rules:
+    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
+    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
+
+# Additional information about this file can be found at
+# https://dart.dev/guides/language/analysis-options
diff --git a/permission_handler_html/example/web/index.html b/permission_handler_html/example/web/index.html
@@ -1,5 +1,6 @@
 <!DOCTYPE html>
 <html>
+
 <head>
   <!--
     If you are serving your web app in a path other than the root, change the
@@ -27,33 +28,23 @@
   <link rel="apple-touch-icon" href="icons/Icon-192.png">
 
   <!-- Favicon -->
-  <link rel="icon" type="image/png" href="favicon.png"/>
+  <link rel="icon" type="image/png" href="favicon.png" />
 
   <title>example</title>
   <link rel="manifest" href="manifest.json">
 
   <script>
-    // The value below is injected by flutter build, do not touch.
-    var serviceWorkerVersion = null;
+    {{flutter_service_worker_version}}
   </script>
   <!-- This script adds the flutter initialization JS code -->
-  <script src="flutter.js" defer></script>
+  <script src="flutter.js"></script>
 </head>
+
 <body>
   <script>
-    window.addEventListener('load', function(ev) {
-      // Download main.dart.js
-      _flutter.loader.loadEntrypoint({
-        serviceWorker: {
-          serviceWorkerVersion: serviceWorkerVersion,
-        },
-        onEntrypointLoaded: function(engineInitializer) {
-          engineInitializer.initializeEngine().then(function(appRunner) {
-            appRunner.runApp();
-          });
-        }
-      });
-    });
+    {{flutter_build_config}}
+    _flutter.loader.load();
   </script>
 </body>
-</html>
+
+</html>
diff --git a/permission_handler_html/lib/permission_handler_html.dart b/permission_handler_html/lib/permission_handler_html.dart
@@ -1,6 +1,7 @@
-import 'dart:html' as html;
 import 'dart:async';
 
+import 'package:web/web.dart' as web;
+
 import 'package:flutter/foundation.dart';
 import 'package:flutter_web_plugins/flutter_web_plugins.dart';
 import 'package:permission_handler_platform_interface/permission_handler_platform_interface.dart';
@@ -9,11 +10,10 @@ import 'web_delegate.dart';
 
 /// Platform implementation of the permission_handler Flutter plugin.
 class WebPermissionHandler extends PermissionHandlerPlatform {
-  static final html.MediaDevices? _devices = html.window.navigator.mediaDevices;
-  static final html.Geolocation _geolocation =
-      html.window.navigator.geolocation;
-  static final html.Permissions? _htmlPermissions =
-      html.window.navigator.permissions;
+  static final web.MediaDevices? _devices = web.window.navigator.mediaDevices;
+  static final web.Geolocation _geolocation = web.window.navigator.geolocation;
+  static final web.Permissions? _htmlPermissions =
+      web.window.navigator.permissions;
 
   final WebDelegate _webDelegate;
 
diff --git a/permission_handler_html/lib/web_delegate.dart b/permission_handler_html/lib/web_delegate.dart
@@ -1,5 +1,7 @@
-import 'dart:html' as html;
 import 'dart:async';
+import 'dart:js_interop';
+
+import 'package:web/web.dart' as web;
 
 import 'package:permission_handler_platform_interface/permission_handler_platform_interface.dart';
 
@@ -8,21 +10,21 @@ import 'package:permission_handler_platform_interface/permission_handler_platfor
 class WebDelegate {
   /// Constructs a WebDelegate.
   WebDelegate(
-    html.MediaDevices? devices,
-    html.Geolocation? geolocation,
-    html.Permissions? permissions,
+    web.MediaDevices? devices,
+    web.Geolocation? geolocation,
+    web.Permissions? permissions,
   )   : _devices = devices,
         _geolocation = geolocation,
         _htmlPermissions = permissions;
 
   /// The html media devices object used to request camera and microphone permissions.
-  final html.MediaDevices? _devices;
+  final web.MediaDevices? _devices;
 
   /// The html geolocation object used to request location permission.
-  final html.Geolocation? _geolocation;
+  final web.Geolocation? _geolocation;
 
   /// The html permissions object used to check permission status.
-  final html.Permissions? _htmlPermissions;
+  final web.Permissions? _htmlPermissions;
 
   /// The permission name to request access to the camera.
   static const _microphonePermissionName = 'microphone';
@@ -58,8 +60,10 @@ class WebDelegate {
     }
   }
 
-  Future<PermissionStatus> _permissionStatusState(String webPermissionName, html.Permissions? permissions) async {
-    final webPermissionStatus = await permissions?.query({'name': webPermissionName});
+  Future<PermissionStatus> _permissionStatusState(
+      String webPermissionName, web.Permissions? permissions) async {
+    final webPermissionStatus =
+        await permissions?.query({'name': webPermissionName}.toJSBox).toDart;
     return _toPermissionStatus(webPermissionStatus?.state);
   }
 
@@ -69,7 +73,9 @@ class WebDelegate {
     }
 
     try {
-      html.MediaStream mediaStream = await _devices!.getUserMedia({'audio': true});
+      web.MediaStream? mediaStream = await _devices
+          ?.getUserMedia(web.MediaStreamConstraints(audio: true.toJS))
+          .toDart;
 
       // In browsers, calling [getUserMedia] will start the recording
       // automatically right after. This is undesired behavior as
@@ -78,13 +84,13 @@ class WebDelegate {
       // The manual stop action is then needed here for to stop the automatic
       // recording.
 
-      if (mediaStream.active ?? false) {
-        final audioTracks = mediaStream.getAudioTracks();
+      if (mediaStream?.active ?? false) {
+        final audioTracks = mediaStream?.getAudioTracks().toDart ?? [];
         if (audioTracks.isNotEmpty) {
           audioTracks[0].stop();
         }
       }
-    } on html.DomException {
+    } on web.DOMException {
       return false;
     }
 
@@ -97,7 +103,9 @@ class WebDelegate {
     }
 
     try {
-      html.MediaStream mediaStream = await _devices!.getUserMedia({'video': true});
+      web.MediaStream? mediaStream = await _devices
+          ?.getUserMedia(web.MediaStreamConstraints(video: true.toJS))
+          .toDart;
 
       // In browsers, calling [getUserMedia] will start the recording
       // automatically right after. This is undesired behavior as
@@ -106,38 +114,51 @@ class WebDelegate {
       // The manual stop action is then needed here for to stop the automatic
       // recording.
 
-      if (mediaStream.active ?? false) {
-        final videoTracks = mediaStream.getVideoTracks();
+      if (mediaStream?.active ?? false) {
+        final videoTracks = mediaStream?.getVideoTracks().toDart ?? [];
         if (videoTracks.isNotEmpty) {
           videoTracks[0].stop();
         }
       }
-    } on html.DomException {
+    } on web.DOMException {
       return false;
     }
 
     return true;
   }
 
   Future<bool> _requestNotificationPermission() async {
-    return html.Notification.requestPermission().then((permission) => permission == "granted");
+    return web.Notification.requestPermission()
+        .toDart
+        .then((permission) => (permission == "granted".toJS));
   }
 
   Future<bool> _requestLocationPermission() async {
+    Completer<bool> completer = Completer<bool>();
     try {
-      return await _geolocation?.getCurrentPosition().then((value) => true) ?? false;
-    } on html.PositionError {
-      return false;
+      _geolocation?.getCurrentPosition(
+        (JSAny _) {
+          completer.complete(true);
+        }.toJS,
+        (JSAny _) {
+          completer.complete(false);
+        }.toJS,
+      );
+    } catch (_) {
+      completer.complete(false);
     }
+    return completer.future;
   }
 
-  Future<PermissionStatus> _requestSingularPermission(Permission permission) async {
+  Future<PermissionStatus> _requestSingularPermission(
+      Permission permission) async {
     bool permissionGranted = switch (permission) {
       Permission.microphone => await _requestMicrophonePermission(),
       Permission.camera => await _requestCameraPermission(),
       Permission.notification => await _requestNotificationPermission(),
       Permission.location => await _requestLocationPermission(),
-      _ => throw UnsupportedError('The ${permission.toString()} permission is currently not supported on web.')
+      _ => throw UnsupportedError(
+          'The ${permission.toString()} permission is currently not supported on web.')
     };
 
     if (!permissionGranted) {
@@ -150,12 +171,14 @@ class WebDelegate {
   /// they have not already been granted before.
   ///
   /// Returns a [Map] containing the status per requested [Permission].
-  Future<Map<Permission, PermissionStatus>> requestPermissions(List<Permission> permissions) async {
+  Future<Map<Permission, PermissionStatus>> requestPermissions(
+      List<Permission> permissions) async {
     final Map<Permission, PermissionStatus> permissionStatusMap = {};
 
     for (final permission in permissions) {
       try {
-        permissionStatusMap[permission] = await _requestSingularPermission(permission);
+        permissionStatusMap[permission] =
+            await _requestSingularPermission(permission);
       } on UnimplementedError {
         rethrow;
       }
diff --git a/permission_handler_html/pubspec.yaml b/permission_handler_html/pubspec.yaml
@@ -1,6 +1,6 @@
 name: permission_handler_html
 description: Permission plugin for Flutter. This plugin provides the web API to request and check permissions.
-version: 0.1.1
+version: 0.1.2
 homepage: https://github.com/baseflow/flutter-permission-handler
 
 environment:
@@ -13,6 +13,7 @@ dependencies:
   flutter_web_plugins:
     sdk: flutter
   permission_handler_platform_interface: ^4.1.0
+  web: ^0.5.1
 
 dev_dependencies:
   flutter_test:
diff --git a/permission_handler_html/test/permission_handler_web_test.dart b/permission_handler_html/test/permission_handler_web_test.dart
diff --git a/permission_handler_html/test/permission_handler_web_test.mocks.dart b/permission_handler_html/test/permission_handler_web_test.mocks.dart
diff --git a/permission_handler_html/test/tests_exist_elsewhere_test.dart b/permission_handler_html/test/tests_exist_elsewhere_test.dart
