Invoke geolocation callback by default

Author: markmur

README.md

@@ -351,7 +351,7 @@ val processor = object : DefaultCheckoutEventProcessor(activity) {
 ```
 
 > [!Note]
-> The `DefaultCheckoutEventProcessor` provides default implementations for current and future callback functions (such as `onLinkClicked()`), which can be overridden by clients wanting to change default behavior.
+> The `DefaultCheckoutEventProcessor` provides default implementations for current and future callback functions (such as `onCheckoutLinkClicked()`), which can be overridden by clients wanting to change default behavior.
 
 ### Error handling
 

lib/src/main/java/com/shopify/checkoutsheetkit/CheckoutEventProcessor.kt

@@ -22,9 +22,11 @@
  */
 package com.shopify.checkoutsheetkit
 
+import android.Manifest
 import android.annotation.SuppressLint
 import android.content.Context
 import android.content.Intent
+import android.content.pm.PackageManager
 import android.net.Uri
 import android.webkit.GeolocationPermissions
 import android.webkit.PermissionRequest
@@ -141,6 +143,11 @@ public abstract class DefaultCheckoutEventProcessor @JvmOverloads constructor(
     private val log: LogWrapper = LogWrapper(),
 ) : CheckoutEventProcessor {
 
+    private val LOCATION_PERMISSIONS: Array<String> = arrayOf(
+        Manifest.permission.ACCESS_FINE_LOCATION,
+        Manifest.permission.ACCESS_COARSE_LOCATION
+    )
+
     override fun onCheckoutLinkClicked(uri: Uri) {
         when (uri.scheme) {
             "tel" -> context.launchPhoneApp(uri.schemeSpecificPart)
@@ -166,14 +173,51 @@ public abstract class DefaultCheckoutEventProcessor @JvmOverloads constructor(
         return false
     }
 
-    override fun onGeolocationPermissionsShowPrompt(origin: String, callback: GeolocationPermissions.Callback) {
-        // no-op override to implement
+    /**
+     * Called when the webview requests location permissions. For example when using 'Use my location' to locate pickup points.
+     * The default implementation here will check for both manifest and runtime permissions. If both have been granted,
+     * permission will be granted to present the location prompt to the user.
+     *
+     * Runtime permissions must be requested by your host app. The Checkout Sheet kit cannot request them on your behalf.
+     */
+    override fun onGeolocationPermissionsShowPrompt(
+        origin: String,
+        callback: GeolocationPermissions.Callback
+    ) {
+        // Check manifest permissions
+        val manifestPermissions = try {
+            context.packageManager
+                .getPackageInfo(context.packageName, PackageManager.GET_PERMISSIONS)
+                .requestedPermissions
+                ?.toSet() ?: emptySet()
+        } catch (e: Exception) {
+            emptySet()
+        }
+
+        // Check if either permission is declared in manifest
+        val hasManifestPermission = LOCATION_PERMISSIONS.any { permission ->
+            manifestPermissions.contains(permission)
+        }
+
+        if (!hasManifestPermission) {
+            callback.invoke(origin, false, false)
+            return
+        }
+
+        // Check runtime permissions
+        val hasRuntimePermission = LOCATION_PERMISSIONS.any { permission ->
+            context.checkSelfPermission(permission) == PackageManager.PERMISSION_GRANTED
+        }
+
+        callback.invoke(origin, hasRuntimePermission, hasRuntimePermission)
     }
 
     override fun onGeolocationPermissionsHidePrompt() {
         // no-op override to implement
     }
 
+    // Private
+
     private fun Context.launchEmailApp(to: String) {
         val intent = Intent(Intent.ACTION_SEND)
         intent.type = "vnd.android.cursor.item/email"

lib/src/test/java/com/shopify/checkoutsheetkit/DefaultCheckoutEventProcessorTest.kt

@@ -1,18 +1,18 @@
 /*
  * MIT License
- * 
+ *
  * Copyright 2023-present, Shopify Inc.
- * 
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in all
  * copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -26,14 +26,17 @@ import android.content.Intent
 import android.content.pm.PackageManager
 import android.content.pm.ResolveInfo
 import android.net.Uri
+import android.webkit.GeolocationPermissions
 import androidx.activity.ComponentActivity
 import com.shopify.checkoutsheetkit.lifecycleevents.CheckoutCompletedEvent
 import com.shopify.checkoutsheetkit.pixelevents.PixelEvent
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.mockito.kotlin.any
 import org.mockito.kotlin.mock
+import org.mockito.kotlin.times
 import org.mockito.kotlin.verify
 import org.robolectric.Robolectric
 import org.robolectric.RobolectricTestRunner
@@ -46,6 +49,7 @@ class DefaultCheckoutEventProcessorTest {
 
     private lateinit var activity: ComponentActivity
     private lateinit var shadowActivity: ShadowActivity
+    private val mockCallback = mock<GeolocationPermissions.Callback>()
 
     @Before
     fun setUp() {
@@ -164,12 +168,36 @@ class DefaultCheckoutEventProcessorTest {
         assertThat(recoverable).isTrue()
     }
 
+    @Test
+    fun `onGeolocationPermissionsShowPrompt should invoke callback with correct args`() {
+        val origin = "http://shopify.com"
+        val processor = object: DefaultCheckoutEventProcessor(mock(), mock()) {
+            override fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent) {}
+            override fun onCheckoutFailed(error: CheckoutException) {}
+            override fun onCheckoutCanceled() {}
+        }
+        processor.onGeolocationPermissionsShowPrompt(origin, mockCallback)
+        verify(mockCallback).invoke(origin, true, true)
+    }
+
+    @Test
+    fun `onGeolocationPermissionsShowPrompt should not invoke callback if overridden with no-op`() {
+        val overriddenProcessor = object: DefaultCheckoutEventProcessor(mock(), mock()) {
+            override fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent) {}
+            override fun onCheckoutFailed(error: CheckoutException) {}
+            override fun onCheckoutCanceled() {}
+            override fun onGeolocationPermissionsShowPrompt(origin: String, callback: GeolocationPermissions.Callback) {}
+        }
+        overriddenProcessor.onGeolocationPermissionsShowPrompt("http://shopify.com", mockCallback)
+        verify(mockCallback, times(0)).invoke(any(), any(), any())
+    }
+
     private fun processor(activity: ComponentActivity): DefaultCheckoutEventProcessor {
         return object: DefaultCheckoutEventProcessor(activity) {
-            override fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent) {/* not implemented */}
-            override fun onCheckoutFailed(error: CheckoutException) {/* not implemented */}
-            override fun onCheckoutCanceled() {/* not implemented */}
-            override fun onWebPixelEvent(event: PixelEvent) {/* not implemented */}
+            override fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent) {}
+            override fun onCheckoutFailed(error: CheckoutException) {}
+            override fun onCheckoutCanceled() {}
+            override fun onWebPixelEvent(event: PixelEvent) {}
         }
     }
 }

samples/MobileBuyIntegration/app/src/main/java/com/shopify/checkout_sdk_mobile_buy_integration_sample/MainActivity.kt

@@ -25,6 +25,7 @@ package com.shopify.checkout_sdk_mobile_buy_integration_sample
 import android.Manifest
 import android.content.pm.PackageManager
 import android.net.Uri
+import android.os.Build
 import android.os.Bundle
 import android.webkit.GeolocationPermissions
 import android.webkit.ValueCallback
@@ -42,15 +43,14 @@ class MainActivity : ComponentActivity() {
     // Launchers
     private lateinit var requestPermissionLauncher: ActivityResultLauncher<String>
     private lateinit var showFileChooserLauncher: ActivityResultLauncher<FileChooserParams>
-    private lateinit var geolocationLauncher: ActivityResultLauncher<Array<String>>
 
     // State related to file chooser requests (e.g. for using a file chooser/camera for proving identity)
     private var filePathCallback: ValueCallback<Array<Uri>>? = null
     private var fileChooserParams: FileChooserParams? = null
 
-    // State related to geolocation requests (e.g. for pickup points - use my location)
-    private var geolocationPermissionCallback: GeolocationPermissions.Callback? = null
-    private var geolocationOrigin: String? = null
+    companion object {
+        private const val LOCATION_PERMISSION_REQUEST_CODE = 1001
+    }
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -84,15 +84,17 @@ class MainActivity : ComponentActivity() {
             filePathCallback = null
             fileChooserParams = null
         }
+    }
 
-        geolocationLauncher = registerForActivityResult(ActivityResultContracts.RequestMultiplePermissions()) { result ->
-            val isGranted = result.any { it.value }
-            // invoke the callback with the permission result
-            geolocationPermissionCallback?.invoke(geolocationOrigin, isGranted, false)
+    fun requestGeolocationPermission() {
+        val fineLocationGranted = checkSelfPermission(Manifest.permission.ACCESS_FINE_LOCATION) == PackageManager.PERMISSION_GRANTED
+        val coarseLocationGranted = checkSelfPermission(Manifest.permission.ACCESS_COARSE_LOCATION) == PackageManager.PERMISSION_GRANTED
 
-            // reset geolocation state
-            geolocationPermissionCallback = null
-            geolocationOrigin = null
+        if (!fineLocationGranted && !coarseLocationGranted) {
+            requestPermissions(
+                arrayOf(Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.ACCESS_COARSE_LOCATION),
+                    LOCATION_PERMISSION_REQUEST_CODE
+            )
         }
     }
 
@@ -111,19 +113,6 @@ class MainActivity : ComponentActivity() {
         return true
     }
 
-    // Deal with requests from Checkout to show the geolocation permissions prompt
-    fun onGeolocationPermissionsShowPrompt(origin: String, callback: GeolocationPermissions.Callback) {
-        if (permissionAlreadyGranted(Manifest.permission.ACCESS_FINE_LOCATION) && permissionAlreadyGranted(Manifest.permission.ACCESS_COARSE_LOCATION)) {
-            // Permissions already granted, invoke callback immediately
-            callback(origin, true, true)
-        } else {
-            // Permissions not yet granted, request permissions before invoking callback
-            geolocationPermissionCallback = callback
-            geolocationOrigin = origin
-            geolocationLauncher.launch(arrayOf(Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.ACCESS_COARSE_LOCATION))
-        }
-    }
-
     private fun permissionAlreadyGranted(permission: String): Boolean {
         return ContextCompat.checkSelfPermission(this, permission) == PackageManager.PERMISSION_GRANTED
     }

samples/MobileBuyIntegration/app/src/main/java/com/shopify/checkout_sdk_mobile_buy_integration_sample/common/MobileBuyEventProcessor.kt

@@ -85,7 +85,8 @@ class MobileBuyEventProcessor(
     }
 
     override fun onGeolocationPermissionsShowPrompt(origin: String, callback: GeolocationPermissions.Callback) {
-        return (context as MainActivity).onGeolocationPermissionsShowPrompt(origin, callback)
+        (context as MainActivity).requestGeolocationPermission()
+        super.onGeolocationPermissionsShowPrompt(origin, callback)
     }
 
     override fun onShowFileChooser(