@tokamakdev/plugin-location 0.1.0-beta.83 → 0.1.0-beta.84

package/README.md

@@ -25,6 +25,18 @@ milliseconds, 0 by default, or takes a new one, and rejects with
 `TimeoutError` when none arrives within `timeout` milliseconds, unlimited by
 default. The timeout starts once the user allows location.
 
+## Off screen
+
+The plugin asks for location while the app is in use only. While the app is
+off screen on iOS or Android, as when Worker code runs in the background, a
+call that would ask the user for permission rejects with `NeedsUIError`. With
+permission granted, the platforms stop locating an app that is off screen
+without background location permission, which the plugin does not request, so
+`getCurrentPosition` rejects with `NotAllowedError` there. iOS still locates
+the app for a few seconds after it leaves the screen.
+
+## Platforms
+
 The web implementation uses `navigator.geolocation`. Native Tokamak builds use
 Core Location on Apple platforms, `LocationManager` on Android, and WebView2's
 location implementation on Windows. Calling the API on a platform without

package/android/LocationPlugin.kt

@@ -59,7 +59,10 @@ class TokamakLocationPlugin(
         }
     }
 
-    /** Passes [action] whether the app may read fine or coarse location, asking when it may not. */
+    /**
+     * Passes [action] whether the app may read fine or coarse location, asking when it may not.
+     * Throws `NeedsUIError` when asking would show UI while the app is in the background.
+     */
     private fun withPermission(action: (Boolean) -> Unit) {
         if (PERMISSIONS.any { context.checkSelfPermission(it) == PackageManager.PERMISSION_GRANTED }) {
             action(true)
@@ -93,8 +96,7 @@ class TokamakLocationPlugin(
                 context.mainExecutor,
             ) { location ->
                 handler.removeCallbacks(timeout)
-                if (location == null) reply(unavailable("Location is unavailable"))
-                else reply(Result.success(position(location)))
+                reply(if (location == null) missingFix() else Result.success(position(location)))
             }
         }.onFailure {
             handler.removeCallbacks(timeout)
@@ -165,6 +167,14 @@ class TokamakLocationPlugin(
     private fun permissionDenied(): Result<Any?> =
         Result.failure(TokamakPluginError("NotAllowedError", "Location permission was denied"))
 
+    /** Why no fix came: Android gives none in the background without background location permission. */
+    private fun missingFix(): Result<Any?> =
+        if (host.isInForeground || context.checkSelfPermission(BACKGROUND) == PackageManager.PERMISSION_GRANTED) {
+            unavailable("Location is unavailable")
+        } else {
+            Result.failure(TokamakPluginError("NotAllowedError", "Location permission does not cover the background"))
+        }
+
     private fun unavailable(message: String): Result<Any?> =
         Result.failure(TokamakPluginError("NotReadableError", message))
 
@@ -176,5 +186,6 @@ class TokamakLocationPlugin(
         /** The `timeout` that never expires, as the page sends it. */
         const val UNLIMITED = 0xffffffffL
         val PERMISSIONS = setOf(Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.ACCESS_COARSE_LOCATION)
+        const val BACKGROUND = Manifest.permission.ACCESS_BACKGROUND_LOCATION
     }
 }

package/apple/LocationPlugin.swift

@@ -23,6 +23,7 @@ final class TokamakLocationPlugin: NSObject, TokamakPlugin,
     var timer: DispatchWorkItem?
   }
 
+  private let host: TokamakHost
   /// Updates watchers.
   private let updates = CLLocationManager()
   /// Takes single fixes for current position requests, apart from watching.
@@ -31,6 +32,7 @@ final class TokamakLocationPlugin: NSObject, TokamakPlugin,
   private var watchers: [UUID: TokamakPluginReply] = [:]
 
   init(host: TokamakHost) {
+    self.host = host
     super.init()
     for manager in [updates, fixes] {
       manager.delegate = self
@@ -60,10 +62,9 @@ final class TokamakLocationPlugin: NSObject, TokamakPlugin,
     method: String,
     arguments: Any,
     reply: @escaping TokamakPluginReply
-  ) -> (() -> Void) {
+  ) throws(TokamakPluginError) -> (() -> Void) {
     guard method == "watchPosition" else {
-      reply(.failure(.notSupported("\(id).\(method) is not supported")))
-      return {}
+      throw .notSupported("\(id).\(method) is not supported")
     }
     let subscription = UUID()
     watchers[subscription] = reply
@@ -121,10 +122,15 @@ final class TokamakLocationPlugin: NSObject, TokamakPlugin,
       return
     }
     let status = updates.authorizationStatus
-    if status == .notDetermined {
-      updates.requestWhenInUseAuthorization()
-    } else {
+    guard status == .notDetermined else {
       serve(status)
+      return
+    }
+    do throws(TokamakPluginError) {
+      try host.requireUI()
+      updates.requestWhenInUseAuthorization()
+    } catch {
+      fail(error)
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tokamakdev/plugin-location",
-  "version": "0.1.0-beta.83",
+  "version": "0.1.0-beta.84",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mantty/tokamak.git",
@@ -11,7 +11,7 @@
     ".": "./src/index.ts"
   },
   "peerDependencies": {
-    "@tokamakdev/plugin": "0.1.0-beta.83"
+    "@tokamakdev/plugin": "0.1.0-beta.84"
   },
   "files": [
     "android",

package/src/index.ts

@@ -1,4 +1,4 @@
-import { FrontendPlugin } from "@tokamakdev/plugin";
+import { Plugin } from "@tokamakdev/plugin";
 import * as web from "../web/index.js";
 
 export interface Coordinates {
@@ -27,7 +27,7 @@ export interface PositionOptions {
 export type PositionCallback = (position: Position) => void;
 export type PositionErrorCallback = (error: DOMException) => void;
 
-class Location extends FrontendPlugin {
+class Location extends Plugin {
   constructor() {
     super("location");
   }