Merge pull request #75 from holzgeist/fix-support-non-root-base-href

fix: add support for non-root base-href

Author: diegotori

.github/workflows/checks.yml

@@ -455,6 +455,35 @@ jobs:
           flutter pub get
           flutter build web --debug --target=./lib/main.dart
 
+  web_plugin_unit_test:
+    needs: setup_matrix
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        flutter_version: ${{ fromJson(needs.setup_matrix.outputs.flutter_versions_json) }}
+    name: Web Plugin Unit Test (${{ matrix.flutter_version }})
+    steps:
+      - uses: actions/checkout@v6
+      - uses: subosito/flutter-action@v2
+        with:
+          flutter-version: ${{ (contains(matrix.flutter_version, '.') || contains(matrix.flutter_version, 'x')) && matrix.flutter_version || '' }}
+          channel: ${{ (!contains(matrix.flutter_version, '.') && !contains(matrix.flutter_version, 'x')) && matrix.flutter_version || '' }}
+          cache: true
+          cache-key: flutter-:os:-:channel:-:version:-:arch:-:hash:-${{ hashFiles('**/pubspec.lock') }}
+
+      - name: Install dependencies
+        run: flutter pub get
+        working-directory: wakelock_plus
+
+      - name: Run Web Plugin Tests
+        run: |
+          flutter test \
+            --platform chrome \
+            --dart-define=WEB_PLUGIN_TESTS=true \
+            test/wakelock_plus_web_plugin_test.dart
+        working-directory: wakelock_plus
+
   web_integration_test:
     needs: setup_matrix
     runs-on: ubuntu-latest

wakelock_plus/example/.gitignore

@@ -31,12 +31,9 @@
 .pub/
 /build/
 
-# Web related
-lib/generated_plugin_registrant.dart
-
 # Symbolication related
 app.*.symbols
 
 # Obfuscation related
 app.*.map.json
-!/ios/Podfile
+!/ios/Podfile

wakelock_plus/assets/no_sleep.js wakelock_plus/lib/assets/no_sleep.jswakelock_plus/assets/no_sleep.js renamed to wakelock_plus/lib/assets/no_sleep.js

@@ -1,3 +1,32 @@
+/*! Based On NoSleep.js v0.12.0 - git.io/vfn01 - Rich Tibbett - MIT license */
+
+class PromiseCompleter {
+  _promise;
+  _resolve;
+  _reject;
+  constructor() {
+    this._promise = new Promise((resolve, reject) => {
+      this._resolve = resolve;
+      this._reject = reject;
+    });
+  }
+
+  isCompleted = false;
+
+  get future() {
+    return this._promise;
+  }
+
+  complete(value) {
+    this.isCompleted = true;
+    this._resolve(value);
+  }
+
+  completeError(error) {
+    this._reject(error);
+  }
+}
+
 var webm =
   'data:video/webm;base64,GkXfo0AgQoaBAUL3gQFC8oEEQvOBCEKCQAR3ZWJtQoeBAkKFgQIYU4BnQI0VSalmQCgq17FAAw9CQE2AQAZ3aGFtbXlXQUAGd2hhbW15RIlACECPQAAAAAAAFlSua0AxrkAu14EBY8WBAZyBACK1nEADdW5khkAFVl9WUDglhohAA1ZQOIOBAeBABrCBCLqBCB9DtnVAIueBAKNAHIEAAIAwAQCdASoIAAgAAUAmJaQAA3AA/vz0AAA='
 var mp4 =
@@ -26,48 +55,28 @@ function _classCallCheck(instance, Constructor) {
   }
 }
 
-// Detect iOS browsers < version 10
-var oldIOS =
-  typeof navigator !== 'undefined' &&
-  parseFloat(
-    (
-      '' +
-      (/CPU.*OS ([0-9_]{3,4})[0-9_]{0,1}|(CPU like).*AppleWebKit.*Mobile/i.exec(
-        navigator.userAgent
-      ) || [0, ''])[1]
-    )
-      .replace('undefined', '3_2')
-      .replace('_', '.')
-      .replace('_', '')
-  ) < 10 &&
-  !window.MSStream
-
 // Detect native Wake Lock API support
 var nativeWakeLock = 'wakeLock' in navigator
 
 var NoSleep = (function () {
-  var _releasedNative = true
-  var _nativeRequestInProgress = false
+  var _nativeEnabledCompleter;
+  var _playVideoCompleter;
 
   function NoSleep() {
     var _this = this
 
     _classCallCheck(this, NoSleep)
 
+    this.nativeEnabled = false
     if (nativeWakeLock) {
       this._wakeLock = null
       var handleVisibilityChange = function handleVisibilityChange() {
-        if (
-          _this._wakeLock !== null &&
-          document.visibilityState === 'visible'
-        ) {
+        if (_this._wakeLock !== null && document.visibilityState === 'visible') {
           _this.enable()
         }
       }
       document.addEventListener('visibilitychange', handleVisibilityChange)
       document.addEventListener('fullscreenchange', handleVisibilityChange)
-    } else if (oldIOS) {
-      this.noSleepTimer = null
     } else {
       // Set up no sleep video element
       this.noSleepVideo = document.createElement('video')
@@ -106,90 +115,92 @@ var NoSleep = (function () {
     },
     {
       key: 'enable',
-      value: function enable() {
+      value: async function enable() {
         var _this2 = this
 
         if (nativeWakeLock) {
-          _nativeRequestInProgress = true
+          // Disable any previously held wakelocks.
+          await this.disable()
+          if (_nativeEnabledCompleter == null) {
+            _nativeEnabledCompleter = new PromiseCompleter()
+          }
           navigator.wakeLock
             .request('screen')
             .then(function (wakeLock) {
-              _releasedNative = false
-              _nativeRequestInProgress = false
-
               _this2._wakeLock = wakeLock
+              _this2.nativeEnabled = true
+
+              // We now have a wakelock. Notify all of the existing callers.
               _this2._wakeLock.addEventListener('release', function () {
-                _releasedNative = true
+                _this2.nativeEnabled = false
                 _this2._wakeLock = null
               })
+
+              _nativeEnabledCompleter.complete()
+              _nativeEnabledCompleter = null
             })
             .catch(function (err) {
-              _nativeRequestInProgress = false
-              console.error(err.name + ', ' + err.message)
+              _this2.nativeEnabled = false
+              var errorMessage = err.name + ', ' + err.message
+              _nativeEnabledCompleter.completeError(errorMessage)
+              _nativeEnabledCompleter = null
             })
-        } else if (oldIOS) {
-          this.disable()
-          console.warn(
-            '\n        NoSleep enabled for older iOS devices. This can interrupt\n        active or long-running network requests from completing successfully.\n        See https://github.com/richtr/NoSleep.js/issues/15 for more details.\n      '
-          )
-          this.noSleepTimer = window.setInterval(function () {
-            if (!document.hidden) {
-              window.location.href = window.location.href.split('#')[0]
-              window.setTimeout(window.stop, 0)
-            }
-          }, 15000)
+          // We then wait for screen to be made available.
+          return _nativeEnabledCompleter.future
         } else {
-          this.noSleepVideo.play()
+          if (_playVideoCompleter == null) {
+            _playVideoCompleter = new PromiseCompleter()
+          }
+          var playPromise = this.noSleepVideo.play()
+          playPromise.then(function (res) {
+            _playVideoCompleter.complete()
+            _playVideoCompleter = null
+          }).catch(function (err) {
+            var errorMessage = err.name + ', ' + err.message
+            _playVideoCompleter.completeError(errorMessage)
+            _playVideoCompleter = null
+          });
+          return _playVideoCompleter.future
         }
       },
     },
     {
       key: 'disable',
-      value: function disable() {
+      value: async function disable() {
         if (nativeWakeLock) {
+          // If we're still trying to enable the wakelock, wait for it to be enabled
+          if (_nativeEnabledCompleter != null) {
+            await _nativeEnabledCompleter.future
+          }
           if (this._wakeLock != null) {
-            _releasedNative = true
+            this.nativeEnabled = false
             this._wakeLock.release()
           }
 
           this._wakeLock = null
-        } else if (oldIOS) {
-          if (this.noSleepTimer) {
-            console.warn(
-              '\n          NoSleep now disabled for older iOS devices.\n        '
-            )
-            window.clearInterval(this.noSleepTimer)
-            this.noSleepTimer = null
-          }
         } else {
+          if (_playVideoCompleter != null) {
+            await _playVideoCompleter.future
+          }
           this.noSleepVideo.pause()
         }
+        return Promise.resolve();
       },
     },
     {
-      key: 'enabled',
-      value: async function enabled() {
+      key: 'isEnabled',
+      value: async function isEnabled() {
         if (nativeWakeLock) {
-          if (_nativeRequestInProgress == true) {
-            // Wait until the request is done.
-            while (true) {
-              // Wait for 42 milliseconds.
-              await new Promise((resolve, reject) => setTimeout(resolve, 42))
-              if (_nativeRequestInProgress == false) {
-                break
-              }
-            }
-          }
-
-          // todo: use WakeLockSentinel.released when that is available (https://developer.mozilla.org/en-US/docs/Web/API/WakeLockSentinel/released)
-          if (_releasedNative != false) {
-            return false
+          // If we're still trying to enable the wakelock, wait for it to be enabled
+          if (_nativeEnabledCompleter != null) {
+            await _nativeEnabledCompleter.future
           }
 
-          return true
-        } else if (oldIOS) {
-          return this.noSleepTimer != null
+          return this.nativeEnabled
         } else {
+          if (_playVideoCompleter != null) {
+            await _playVideoCompleter.future
+          }
           if (this.noSleepVideo == undefined) {
             return false
           }
@@ -208,17 +219,22 @@ var noSleep = new NoSleep()
 var Wakelock = {
   enabled: async function () {
     try {
-      return noSleep.enabled()
+      return noSleep.isEnabled()
     } catch (e) {
       return false
     }
   },
   toggle: async function (enable) {
-    if (enable) {
-      noSleep.enable()
-    } else {
-      noSleep.disable()
+    try {
+      if (enable) {
+        await noSleep.enable()
+      } else {
+        await noSleep.disable()
+      }
+    } catch (e) {
+      return Promise.reject(e);
     }
+    return Promise.resolve()
   },
 }
 

wakelock_plus/lib/src/wakelock_plus_web_plugin.dart

@@ -1,11 +1,10 @@
 import 'dart:async';
-import 'dart:js_interop';
 
 import 'package:flutter_web_plugins/flutter_web_plugins.dart';
-import 'package:wakelock_plus_platform_interface/wakelock_plus_platform_interface.dart';
 import 'package:wakelock_plus/src/web_impl/import_js_library.dart';
 import 'package:wakelock_plus/src/web_impl/js_wakelock.dart'
     as wakelock_plus_web;
+import 'package:wakelock_plus_platform_interface/wakelock_plus_platform_interface.dart';
 
 /// The web implementation of the [WakelockPlatformInterface].
 ///
@@ -14,45 +13,37 @@ class WakelockPlusWebPlugin extends WakelockPlusPlatformInterface {
   /// Registers [WakelockPlusWebPlugin] as the default instance of the
   /// [WakelockPlatformInterface].
   static void registerWith(Registrar registrar) {
-    // Import a version of `NoSleep.js` that was adjusted for the wakelock
-    // plugin.
-    _jsLoaded = importJsLibrary(
+    WakelockPlusPlatformInterface.instance = WakelockPlusWebPlugin();
+  }
+
+  // The future that signals when the JS is loaded.
+  // This needs to be `await`ed before accessing any methods of the
+  // JS-interop layer.
+  Future<void>? _jsLoaded;
+
+  //
+  // Lazily imports the JS library once, then awaits to ensure that
+  // it's loaded into the DOM.
+  //
+  Future<void> _ensureJsLoaded() async {
+    _jsLoaded ??= importJsLibrary(
       url: 'assets/no_sleep.js',
       flutterPluginName: 'wakelock_plus',
     );
-
-    WakelockPlusPlatformInterface.instance = WakelockPlusWebPlugin();
+    return _jsLoaded;
   }
 
-  // The future that resolves when the JS library is loaded.
-  static late Future<void> _jsLoaded;
-
   @override
   Future<void> toggle({required bool enable}) async {
     // Make sure the JS library is loaded before calling it.
-    await _jsLoaded;
-
-    wakelock_plus_web.toggle(enable);
+    await _ensureJsLoaded();
+    await wakelock_plus_web.toggle(enable);
   }
 
   @override
   Future<bool> get enabled async {
     // Make sure the JS library is loaded before calling it.
-    await _jsLoaded;
-
-    final completer = Completer<bool>();
-
-    wakelock_plus_web.enabled().toDart.then(
-      // onResolve
-      (value) {
-        completer.complete(value.toDart);
-      },
-      // onReject
-      onError: (error) {
-        completer.completeError(error);
-      },
-    );
-
-    return completer.future;
+    await _ensureJsLoaded();
+    return wakelock_plus_web.enabled();
   }
 }