fix(ios): resolving requestPermissions (#16)

Author: OS-pedrogustavobilro

packages/capacitor-plugin/ios/Sources/GeolocationPlugin/GeolocationCallbackManager.swift

@@ -2,6 +2,7 @@ import Capacitor
 import IONGeolocationLib
 
 private enum GeolocationCallbackType {
+    case requestPermissions
     case location
     case watch
 
@@ -10,7 +11,7 @@ private enum GeolocationCallbackType {
     }
 
     var shouldClearAfterSending: Bool {
-        self == .location
+        self == .location || self == .requestPermissions
     }
 }
 
@@ -20,23 +21,34 @@ private struct GeolocationCallbackGroup {
 }
 
 final class GeolocationCallbackManager {
+    private(set) var requestPermissionsCallbacks: [CAPPluginCall]
     private(set) var locationCallbacks: [CAPPluginCall]
     private(set) var watchCallbacks: [String: CAPPluginCall]
     private let capacitorBridge: CAPBridgeProtocol?
 
     private var allCallbackGroups: [GeolocationCallbackGroup] {
         [
+            .init(ids: requestPermissionsCallbacks, type: .requestPermissions),
             .init(ids: locationCallbacks, type: .location),
             .init(ids: Array(watchCallbacks.values), type: .watch)
         ]
     }
+    private var requestPermissionsCallbackGroup: GeolocationCallbackGroup? {
+        allCallbackGroups.first { $0.type == .requestPermissions }
+    }
 
     init(capacitorBridge: CAPBridgeProtocol?) {
         self.capacitorBridge = capacitorBridge
+        self.requestPermissionsCallbacks = []
         self.locationCallbacks = []
         self.watchCallbacks = [:]
     }
 
+    func addRequestPermissionsCallback(capacitorCall call: CAPPluginCall) {
+        capacitorBridge?.saveCall(call)
+        requestPermissionsCallbacks.append(call)
+    }
+
     func addLocationCallback(capacitorCall call: CAPPluginCall) {
         capacitorBridge?.saveCall(call)
         locationCallbacks.append(call)
@@ -47,6 +59,13 @@ final class GeolocationCallbackManager {
         watchCallbacks[watchId] = call
     }
 
+    func clearRequestPermissionsCallbacks() {
+        requestPermissionsCallbacks.forEach {
+            capacitorBridge?.releaseCall($0)
+        }
+        requestPermissionsCallbacks.removeAll()
+    }
+
     func clearWatchCallbackIfExists(_ watchId: String) {
         if let callbackToRemove = watchCallbacks[watchId] {
             capacitorBridge?.releaseCall(callbackToRemove)
@@ -69,10 +88,25 @@ final class GeolocationCallbackManager {
         call.resolve(data)
     }
 
+    func sendRequestPermissionsSuccess(_ permissionsResult: String) {
+        if let group = requestPermissionsCallbackGroup {
+            let data = [
+                Constants.AuthorisationStatus.ResultKey.location: permissionsResult,
+                Constants.AuthorisationStatus.ResultKey.coarseLocation: permissionsResult
+            ]
+            send(.success(data), to: group)
+        }
+    }
+
     func sendSuccess(with position: IONGLOCPositionModel) {
         createPluginResult(status: .success(position.toJSObject()))
     }
 
+    func sendError(_ call: CAPPluginCall, error: GeolocationError) {
+        let errorModel = error.toCodeMessagePair()
+        call.reject(errorModel.1, errorModel.0)
+    }
+
     func sendError(_ error: GeolocationError) {
         createPluginResult(status: .error(error.toCodeMessagePair()))
     }
@@ -87,6 +121,7 @@ private enum CallResultStatus {
 }
 
 private extension GeolocationCallbackManager {
+
     func createPluginResult(status: CallResultStatus) {
         allCallbackGroups.forEach {
             send(status, to: $0)
@@ -112,6 +147,8 @@ private extension GeolocationCallbackManager {
     func clearCallbacks(for type: GeolocationCallbackType) {
         if case .location = type {
             clearLocationCallbacks()
+        } else if case .requestPermissions = type {
+            clearRequestPermissionsCallbacks()
         }
     }
 }

packages/capacitor-plugin/ios/Sources/GeolocationPlugin/GeolocationPlugin.swift

@@ -53,8 +53,8 @@ public class GeolocationPlugin: CAPPlugin, CAPBridgedPlugin {
         callbackManager?.sendSuccess(call)
     }
 
-    override public func checkPermissions(_ call: CAPPluginCall) {
-        checkIfLocationServicesAreEnabled()
+    @objc override public func checkPermissions(_ call: CAPPluginCall) {
+        guard checkIfLocationServicesAreEnabled(call) else { return }
 
         let status = switch locationService?.authorisationStatus {
         case .restricted, .denied: Constants.AuthorisationStatus.Status.denied
@@ -69,11 +69,12 @@ public class GeolocationPlugin: CAPPlugin, CAPBridgedPlugin {
         callbackManager?.sendSuccess(call, with: callResultData)
     }
 
-    override public func requestPermissions(_ call: CAPPluginCall) {
-        checkIfLocationServicesAreEnabled()
+    @objc override public func requestPermissions(_ call: CAPPluginCall) {
+        guard checkIfLocationServicesAreEnabled(call) else { return }
 
         if locationService?.authorisationStatus == .notDetermined {
             shouldSetupBindings()
+            callbackManager?.addRequestPermissionsCallback(capacitorCall: call)
         } else {
             checkPermissions(call)
         }
@@ -94,13 +95,13 @@ private extension GeolocationPlugin {
 
                 switch status {
                 case .denied:
-                    self.callbackManager?.sendError(.permissionDenied)
+                    self.onLocationPermissionNotGranted(error: .permissionDenied)
                 case .notDetermined:
                     self.requestLocationAuthorisation(type: .whenInUse)
                 case .restricted:
-                    self.callbackManager?.sendError(.permissionRestricted)
+                    self.onLocationPermissionNotGranted(error: .permissionRestricted)
                 case .authorisedAlways, .authorisedWhenInUse:
-                    self.requestLocation()
+                    self.onLocationPermissionGranted()
                 @unknown default: break
                 }
             })
@@ -120,23 +121,41 @@ private extension GeolocationPlugin {
 
     func requestLocationAuthorisation(type requestType: IONGLOCAuthorisationRequestType) {
         DispatchQueue.global(qos: .background).async {
-            self.checkIfLocationServicesAreEnabled()
+            guard self.checkIfLocationServicesAreEnabled() else { return }
             self.locationService?.requestAuthorisation(withType: requestType)
         }
     }
 
-    func checkIfLocationServicesAreEnabled() {
-        guard locationService?.areLocationServicesEnabled() ?? false else {
-            callbackManager?.sendError(.locationServicesDisabled)
-            return
+    func checkIfLocationServicesAreEnabled(_ call: CAPPluginCall? = nil) -> Bool {
+        guard locationService?.areLocationServicesEnabled() == true else {
+                call.map { callbackManager?.sendError($0, error: .locationServicesDisabled) }
+                    ?? callbackManager?.sendError(.locationServicesDisabled)
+                return false
+            }
+        return true
+    }
+
+    func onLocationPermissionNotGranted(error: GeolocationError) {
+        let shouldNotifyRequestPermissionsResult = callbackManager?.requestPermissionsCallbacks.isEmpty == false
+        let shouldNotifyPermissionError = callbackManager?.locationCallbacks.isEmpty == false ||  callbackManager?.watchCallbacks.isEmpty == false
+
+        if shouldNotifyRequestPermissionsResult {
+            self.callbackManager?.sendRequestPermissionsSuccess(Constants.AuthorisationStatus.Status.denied)
+        }
+        if shouldNotifyPermissionError {
+            self.callbackManager?.sendError(error)
         }
     }
 
-    func requestLocation() {
-        // should request if callbacks exist and are not empty
+    func onLocationPermissionGranted() {
+        let shouldNotifyPermissionGranted = callbackManager?.requestPermissionsCallbacks.isEmpty == false
+        // should request location if callbacks below exist and are not empty
         let shouldRequestCurrentPosition = callbackManager?.locationCallbacks.isEmpty == false
         let shouldRequestLocationMonitoring = callbackManager?.watchCallbacks.isEmpty == false
 
+        if shouldNotifyPermissionGranted {
+            callbackManager?.sendRequestPermissionsSuccess(Constants.AuthorisationStatus.Status.granted)
+        }
         if shouldRequestCurrentPosition {
             locationService?.requestSingleLocation()
         }
@@ -156,7 +175,7 @@ private extension GeolocationPlugin {
         }
 
         switch locationService?.authorisationStatus {
-        case .authorisedAlways, .authorisedWhenInUse: requestLocation()
+        case .authorisedAlways, .authorisedWhenInUse: onLocationPermissionGranted()
         case .denied: callbackManager?.sendError(.permissionDenied)
         case .restricted: callbackManager?.sendError(.permissionRestricted)
         default: break

packages/example-app-capacitor/ios/App/Podfile.lock

@@ -1,13 +1,13 @@
 PODS:
-  - Capacitor (7.0.0-rc.0):
+  - Capacitor (7.0.1):
     - CapacitorCordova
-  - CapacitorCamera (7.0.0-alpha.2):
+  - CapacitorCamera (7.0.0):
     - Capacitor
-  - CapacitorCordova (7.0.0-rc.0)
-  - CapacitorGeolocation (7.0.0-alpha.2):
+  - CapacitorCordova (7.0.1)
+  - CapacitorGeolocation (7.1.0):
     - Capacitor
     - IONGeolocationLib (~> 1.0)
-  - CapacitorSplashScreen (7.0.0-alpha.2):
+  - CapacitorSplashScreen (7.0.0):
     - Capacitor
   - IONGeolocationLib (1.0.0)
 
@@ -35,11 +35,11 @@ EXTERNAL SOURCES:
     :path: "../../node_modules/@capacitor/splash-screen"
 
 SPEC CHECKSUMS:
-  Capacitor: e79eb426d47f13ee0e2fdaff9ef0e9990db34a48
-  CapacitorCamera: ad97105da555e693f9885aaab084d205f8d82366
-  CapacitorCordova: 8f4f6826f0b40f7b506eb13b832039b7140a88b4
-  CapacitorGeolocation: dde03dcfdc26a83c0c837eb56bf5852dac3bc04e
-  CapacitorSplashScreen: f612f95daee8566768daf86646b97d4dcac01240
+  Capacitor: 23fff43571a4d1e3ee7d67b5a3588c6e757c2913
+  CapacitorCamera: 777ddf61d727754fcda0b92303ae09ea3765d7b7
+  CapacitorCordova: 63d476958d5022d76f197031e8b7ea3519988c64
+  CapacitorGeolocation: c24f77edcc58510fb87418754407e448fc48b9b5
+  CapacitorSplashScreen: f4e58cc02aafd91c7cbaf32a3d1b44d02a115125
   IONGeolocationLib: 81f33f88d025846946de2cf63b0c7628e7c6bc9d
 
 PODFILE CHECKSUM: 6e3f0881e9bf33b13c7f481b07ee65b5c9321cb0