Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Geolocation] Provide default implementation for geolocation callback #177

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[Geolocation] Provide default implementation for geolocation callback #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a64343d
Invoke geolocation callback by default
markmur Dec 17, 2024
8dd95b0
Update tests
markmur Dec 17, 2024
c5bc2cc
permissionGranted helper
markmur Dec 17, 2024
94bdbda
Update tests
markmur Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
154 changes: 109 additions & 45 deletions lib/src/main/java/com/shopify/checkoutsheetkit/CheckoutEventProcessor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -35,99 +37,111 @@ import com.shopify.checkoutsheetkit.lifecycleevents.CheckoutCompletedEvent
import com.shopify.checkoutsheetkit.pixelevents.PixelEvent

/**
* Interface to implement to allow responding to lifecycle events in checkout.
* We'd strongly recommend extending DefaultCheckoutEventProcessor where possible
* Interface to implement to allow responding to lifecycle events in checkout. We'd strongly
* recommend extending DefaultCheckoutEventProcessor where possible
*/
public interface CheckoutEventProcessor {
/**
* Event representing the successful completion of a checkout.
*/
/** Event representing the successful completion of a checkout. */
public fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent)

/**
* Event representing an error that occurred during checkout. This can be used to display
* error messages for example.
* Event representing an error that occurred during checkout. This can be used to display error
* messages for example.
*
* @param error - the CheckoutErrorException that occurred
* @param error
* - the CheckoutErrorException that occurred
* @see Exception
*/
public fun onCheckoutFailed(error: CheckoutException)

/**
* Event representing the cancellation/closing of checkout by the buyer
*/
/** Event representing the cancellation/closing of checkout by the buyer */
public fun onCheckoutCanceled()

/**
* Event indicating that a link has been clicked within checkout that should be opened outside
* of the WebView, e.g. in a system browser or email client. Protocols can be http/https/mailto/tel
* of the WebView, e.g. in a system browser or email client. Protocols can be
* http/https/mailto/tel
*/
public fun onCheckoutLinkClicked(uri: Uri)

/**
* A permission has been requested by the web chrome client, e.g. to access the camera
*/
/** A permission has been requested by the web chrome client, e.g. to access the camera */
public fun onPermissionRequest(permissionRequest: PermissionRequest)

/**
* Web Pixel event emitted from checkout, that can be optionally transformed, enhanced (e.g. with user and session identifiers),
* and processed
* Web Pixel event emitted from checkout, that can be optionally transformed, enhanced (e.g.
* with user and session identifiers), and processed
*/
public fun onWebPixelEvent(event: PixelEvent)

/**
* Called when the client should show a file chooser. This is called to handle HTML forms with 'file' input type, in response to the
* user pressing the "Select File" button. To cancel the request, call filePathCallback.onReceiveValue(null) and return true.
* Called when the client should show a file chooser. This is called to handle HTML forms with
* 'file' input type, in response to the user pressing the "Select File" button. To cancel the
* request, call filePathCallback.onReceiveValue(null) and return true.
*/
public fun onShowFileChooser(
webView: WebView,
filePathCallback: ValueCallback<Array<Uri>>,
fileChooserParams: WebChromeClient.FileChooserParams,
webView: WebView,
filePathCallback: ValueCallback<Array<Uri>>,
fileChooserParams: WebChromeClient.FileChooserParams,
): Boolean

/**
* Called when the client should show a location permissions prompt. For example when using 'Use my location' for
* pickup points in checkout
* Called when the client should show a location permissions prompt. For example when using 'Use
* my location' for pickup points in checkout
*/
public fun onGeolocationPermissionsShowPrompt(origin: String, callback: GeolocationPermissions.Callback)
public fun onGeolocationPermissionsShowPrompt(
origin: String,
callback: GeolocationPermissions.Callback
)

/**
* Called when the client should hide the location permissions prompt, e.g. if th request is cancelled
* Called when the client should hide the location permissions prompt, e.g. if th request is
* cancelled
*/
public fun onGeolocationPermissionsHidePrompt()
}

internal class NoopEventProcessor : CheckoutEventProcessor {
override fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent) {/* noop */
override fun onCheckoutCompleted(checkoutCompletedEvent: CheckoutCompletedEvent) {
/* noop */
}

override fun onCheckoutFailed(error: CheckoutException) {/* noop */
override fun onCheckoutFailed(error: CheckoutException) {
/* noop */
}

override fun onCheckoutCanceled() {/* noop */
override fun onCheckoutCanceled() {
/* noop */
}

override fun onCheckoutLinkClicked(uri: Uri) {/* noop */
override fun onCheckoutLinkClicked(uri: Uri) {
/* noop */
}

override fun onWebPixelEvent(event: PixelEvent) {/* noop */
override fun onWebPixelEvent(event: PixelEvent) {
/* noop */
}

override fun onShowFileChooser(
webView: WebView,
filePathCallback: ValueCallback<Array<Uri>>,
fileChooserParams: WebChromeClient.FileChooserParams,
webView: WebView,
filePathCallback: ValueCallback<Array<Uri>>,
fileChooserParams: WebChromeClient.FileChooserParams,
): Boolean {
return false
}

override fun onPermissionRequest(permissionRequest: PermissionRequest) {/* noop */
override fun onPermissionRequest(permissionRequest: PermissionRequest) {
/* noop */
}

override fun onGeolocationPermissionsShowPrompt(origin: String, callback: GeolocationPermissions.Callback) {/* noop */
override fun onGeolocationPermissionsShowPrompt(
origin: String,
callback: GeolocationPermissions.Callback
) {
/* noop */
}

override fun onGeolocationPermissionsHidePrompt() {/* noop */
override fun onGeolocationPermissionsHidePrompt() {
/* noop */
}
}

Expand All @@ -136,11 +150,19 @@ internal class NoopEventProcessor : CheckoutEventProcessor {
* for handling checkout events and interacting with the Android operating system.
* @param context from which we will launch intents.
*/
public abstract class DefaultCheckoutEventProcessor @JvmOverloads constructor(
private val context: Context,
private val log: LogWrapper = LogWrapper(),
public abstract class DefaultCheckoutEventProcessor
@JvmOverloads
constructor(
private val context: Context,
private val log: LogWrapper = LogWrapper(),
) : CheckoutEventProcessor {

private val locationPermissions: 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)
Expand All @@ -159,21 +181,63 @@ public abstract class DefaultCheckoutEventProcessor @JvmOverloads constructor(
}

override fun onShowFileChooser(
webView: WebView,
filePathCallback: ValueCallback<Array<Uri>>,
fileChooserParams: WebChromeClient.FileChooserParams,
webView: WebView,
filePathCallback: ValueCallback<Array<Uri>>,
fileChooserParams: WebChromeClient.FileChooserParams,
): Boolean {
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) {
log.e(TAG, "Failed to get package permissions", e)
emptySet()
}

// Check if either permission is declared in manifest
val hasManifestPermission =
locationPermissions.any { permission -> manifestPermissions.contains(permission) }

if (!hasManifestPermission) {
callback.invoke(origin, false, false)
return
}

// Check runtime permissions
val hasRuntimePermission =
locationPermissions.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"
Expand Down
Loading
Loading