feat(feedback): Add screenshot attachment button to user feedback widget #5828
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| package io.sentry.android.core; | ||
|
|
||
| import android.app.Activity; | ||
| import android.net.Uri; | ||
| import androidx.activity.ComponentActivity; | ||
| import androidx.activity.result.ActivityResultLauncher; | ||
| import androidx.activity.result.PickVisualMediaRequest; | ||
| import androidx.activity.result.contract.ActivityResultContracts; | ||
| import io.sentry.SentryOptions; | ||
| import io.sentry.util.LoadClass; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| /** | ||
| * Launches the androidx photo picker to attach an screenshot to user feedback. All | ||
| * androidx.activity references are isolated in this class, so it must only be loaded after {@link | ||
| * #isAvailable} has returned true. | ||
| */ | ||
| final class SentryFeedbackScreenshotPicker { | ||
|
|
||
| interface OnScreenshotPicked { | ||
| void onScreenshotPicked(@NotNull Uri uri); | ||
| } | ||
|
|
||
| private final @NotNull ActivityResultLauncher<PickVisualMediaRequest> launcher; | ||
|
|
||
| private SentryFeedbackScreenshotPicker( | ||
| final @NotNull ActivityResultLauncher<PickVisualMediaRequest> launcher) { | ||
| this.launcher = launcher; | ||
| } | ||
|
|
||
| static boolean isAvailable( | ||
| final @NotNull LoadClass loadClass, final @NotNull SentryOptions options) { | ||
| return loadClass.isClassAvailable("androidx.activity.ComponentActivity", options) | ||
| && loadClass.isClassAvailable( | ||
| "androidx.activity.result.contract.ActivityResultContracts$PickVisualMedia", options); | ||
| } | ||
|
|
||
| static @Nullable SentryFeedbackScreenshotPicker register( | ||
| final @NotNull Activity activity, | ||
| final @NotNull SentryFeedbackScreenshotPicker.OnScreenshotPicked callback) { | ||
| if (!(activity instanceof ComponentActivity)) { | ||
| return null; | ||
| } | ||
| final @NotNull ActivityResultLauncher<PickVisualMediaRequest> launcher = | ||
| ((ComponentActivity) activity) | ||
| .getActivityResultRegistry() | ||
| .register( | ||
| "sentry_user_feedback_screenshot_picker", | ||
| new ActivityResultContracts.PickVisualMedia(), | ||
| (@Nullable Uri uri) -> { | ||
| if (uri != null) { | ||
| callback.onScreenshotPicked(uri); | ||
| } | ||
| }); | ||
| return new SentryFeedbackScreenshotPicker(launcher); | ||
| } | ||
|
|
||
| void launch() { | ||
| launcher.launch( | ||
| new PickVisualMediaRequest.Builder() | ||
| .setMediaType(ActivityResultContracts.PickVisualMedia.ImageOnly.INSTANCE) | ||
| .build()); | ||
| } | ||
|
|
||
| void unregister() { | ||
| launcher.unregister(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,17 +3,24 @@ | |
| import android.app.Activity; | ||
| import android.app.AlertDialog; | ||
| import android.app.Application; | ||
| import android.content.ContentResolver; | ||
| import android.content.Context; | ||
| import android.content.ContextWrapper; | ||
| import android.database.Cursor; | ||
| import android.net.Uri; | ||
| import android.os.Bundle; | ||
| import android.provider.OpenableColumns; | ||
| import android.view.View; | ||
| import android.view.Window; | ||
| import android.view.WindowManager; | ||
| import android.webkit.MimeTypeMap; | ||
| import android.widget.Button; | ||
| import android.widget.EditText; | ||
| import android.widget.ImageView; | ||
| import android.widget.TextView; | ||
| import android.widget.Toast; | ||
| import io.sentry.Attachment; | ||
| import io.sentry.Hint; | ||
| import io.sentry.IScopes; | ||
| import io.sentry.Sentry; | ||
| import io.sentry.SentryFeedbackOptions; | ||
|
|
@@ -23,6 +30,9 @@ | |
| import io.sentry.protocol.Feedback; | ||
| import io.sentry.protocol.SentryId; | ||
| import io.sentry.protocol.User; | ||
| import io.sentry.util.FileUtils; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.lang.ref.WeakReference; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
@@ -39,6 +49,9 @@ public class SentryUserFeedbackForm extends AlertDialog { | |
| private @Nullable SentryShakeDetector shakeDetector; | ||
| private @Nullable Application.ActivityLifecycleCallbacks shakeLifecycleCallbacks; | ||
|
|
||
| private @Nullable SentryFeedbackScreenshotPicker screenshotPicker; | ||
| private @Nullable Uri selectedImageUri; | ||
|
|
||
| SentryUserFeedbackForm( | ||
| final @NotNull Context context, | ||
| final int themeResId, | ||
|
|
@@ -191,6 +204,29 @@ protected void onCreate(Bundle savedInstanceState) { | |
| findViewById(R.id.sentry_dialog_user_feedback_edt_description); | ||
| final @NotNull Button btnSend = findViewById(R.id.sentry_dialog_user_feedback_btn_send); | ||
| final @NotNull Button btnCancel = findViewById(R.id.sentry_dialog_user_feedback_btn_cancel); | ||
| final @NotNull Button btnAddScreenshot = | ||
| findViewById(R.id.sentry_dialog_user_feedback_btn_add_screenshot); | ||
|
|
||
| // The button is made visible in onStart, once the screenshot picker is registered successfully | ||
| btnAddScreenshot.setVisibility(View.GONE); | ||
| btnAddScreenshot.setOnClickListener( | ||
| v -> { | ||
| if (selectedImageUri == null) { | ||
| if (screenshotPicker != null) { | ||
| try { | ||
| screenshotPicker.launch(); | ||
| } catch (Throwable t) { | ||
|
Contributor
There was a problem hiding this comment. gonna make the same comment that I did for the other usages of |
||
| Sentry.getCurrentScopes() | ||
| .getOptions() | ||
| .getLogger() | ||
| .log(SentryLevel.ERROR, "Failed to launch the screenshot picker.", t); | ||
| } | ||
| } | ||
| } else { | ||
| selectedImageUri = null; | ||
| btnAddScreenshot.setText(feedbackOptions.getAddScreenshotButtonLabel()); | ||
| } | ||
| }); | ||
|
|
||
| if (feedbackOptions.isShowBranding()) { | ||
| imgLogo.setVisibility(View.VISIBLE); | ||
|
|
@@ -276,7 +312,9 @@ protected void onCreate(Bundle savedInstanceState) { | |
| } | ||
|
|
||
| // Capture the feedback. If the ID is empty, it means that the feedback was not sent | ||
| final @NotNull Hint hint = new Hint(); | ||
| maybeAddImageAttachment(hint); | ||
| final @NotNull SentryId id = Sentry.feedback().capture(feedback, hint); | ||
| if (!id.equals(SentryId.EMPTY_ID)) { | ||
| Toast.makeText( | ||
| getContext(), feedbackOptions.getSuccessMessageText(), Toast.LENGTH_SHORT) | ||
|
|
@@ -331,6 +369,7 @@ protected void onStart() { | |
| edtMessage.setError(null); | ||
|
|
||
| final @NotNull SentryOptions options = Sentry.getCurrentScopes().getOptions(); | ||
| maybeRegisterScreenshotPicker(options); | ||
| final @NotNull SentryFeedbackOptions feedbackOptions = options.getFeedbackOptions(); | ||
| final @Nullable Runnable onFormOpen = feedbackOptions.getOnFormOpen(); | ||
| if (onFormOpen != null) { | ||
|
|
@@ -340,6 +379,125 @@ protected void onStart() { | |
| currentReplayId = options.getReplayController().getReplayId(); | ||
| } | ||
|
|
||
| @Override | ||
| protected void onStop() { | ||
| super.onStop(); | ||
| if (screenshotPicker != null) { | ||
| screenshotPicker.unregister(); | ||
| screenshotPicker = null; | ||
| } | ||
| } | ||
|
|
||
| private void maybeRegisterScreenshotPicker(final @NotNull SentryOptions options) { | ||
| // Clear any previously selected image so subsequent show() calls start with a fresh form | ||
| final @NotNull Button btnAddScreenshot = | ||
| findViewById(R.id.sentry_dialog_user_feedback_btn_add_screenshot); | ||
| selectedImageUri = null; | ||
| btnAddScreenshot.setText(resolvedFeedbackOptions.getAddScreenshotButtonLabel()); | ||
|
|
||
| if (!resolvedFeedbackOptions.isEnableAttachScreenshot()) { | ||
| return; | ||
| } | ||
| final @Nullable Activity activity = getActivity(getContext()); | ||
| if (activity != null | ||
| && SentryFeedbackScreenshotPicker.isAvailable( | ||
| resolvedFeedbackOptions.getLoadClass(), options)) { | ||
| screenshotPicker = | ||
| SentryFeedbackScreenshotPicker.register( | ||
| activity, uri -> onScreenshotPicked(options, btnAddScreenshot, uri)); | ||
| } | ||
| if (screenshotPicker != null) { | ||
| btnAddScreenshot.setVisibility(View.VISIBLE); | ||
| } else { | ||
| btnAddScreenshot.setVisibility(View.GONE); | ||
| options | ||
| .getLogger() | ||
| .log( | ||
| SentryLevel.WARNING, | ||
| "Feedback screenshot button won't be shown. It requires the androidx.activity " | ||
| + "dependency and the feedback form being shown from a ComponentActivity."); | ||
|
Comment on lines
+415
to
+418
There was a problem hiding this comment. Bug: The Suggested FixIn Prompt for AI Agent |
||
| } | ||
| } | ||
|
|
||
| private void onScreenshotPicked( | ||
| final @NotNull SentryOptions options, | ||
| final @NotNull Button btnAddScreenshot, | ||
| final @NotNull Uri uri) { | ||
| final long size = getUriSize(getContext().getContentResolver(), uri); | ||
| if (size > options.getMaxAttachmentSize()) { | ||
|
sentry[bot] marked this conversation as resolved.
|
||
| options | ||
| .getLogger() | ||
| .log( | ||
| SentryLevel.WARNING, | ||
| "Selected screenshot is larger than the maxAttachmentSize of %d bytes, dropping it.", | ||
| options.getMaxAttachmentSize()); | ||
| Toast.makeText( | ||
| getContext(), | ||
| resolvedFeedbackOptions.getScreenshotTooLargeMessageText(), | ||
| Toast.LENGTH_SHORT) | ||
| .show(); | ||
| return; | ||
| } | ||
| selectedImageUri = uri; | ||
| btnAddScreenshot.setText(resolvedFeedbackOptions.getRemoveScreenshotButtonLabel()); | ||
| } | ||
|
|
||
| private void maybeAddImageAttachment(final @NotNull Hint hint) { | ||
| final @Nullable Uri imageUri = selectedImageUri; | ||
| if (imageUri == null) { | ||
| return; | ||
| } | ||
| try { | ||
| final @NotNull ContentResolver resolver = getContext().getContentResolver(); | ||
| final @Nullable String resolvedMime = resolver.getType(imageUri); | ||
| final @NotNull String mime = resolvedMime != null ? resolvedMime : "image/png"; | ||
| final @Nullable String resolvedExt = | ||
| MimeTypeMap.getSingleton().getExtensionFromMimeType(mime); | ||
| final @NotNull String ext = resolvedExt != null ? resolvedExt : "png"; | ||
| hint.addAttachment( | ||
| new Attachment( | ||
| () -> | ||
| readUriBytes( | ||
| resolver, | ||
| imageUri, | ||
| Sentry.getCurrentScopes().getOptions().getMaxAttachmentSize()), | ||
| "screenshot." + ext, | ||
| mime, | ||
| "event.attachment", | ||
| false)); | ||
|
There was a problem hiding this comment. Lazy URI read may drop attachmentMedium Severity The screenshot Additional Locations (1)  Reviewed by Cursor Bugbot for commit c8c08c1. Configure here. |
||
| } catch (Throwable t) { | ||
|
Contributor
There was a problem hiding this comment. I decided I'm always going to comment whenever we add new usages of this. Sorry to bring it up again.
|
||
| Sentry.getCurrentScopes() | ||
| .getOptions() | ||
| .getLogger() | ||
| .log(SentryLevel.ERROR, "Failed to attach image to feedback.", t); | ||
| } | ||
| } | ||
|
|
||
| private static long getUriSize(final @NotNull ContentResolver resolver, final @NotNull Uri uri) { | ||
| try (final @Nullable Cursor cursor = resolver.query(uri, null, null, null, null)) { | ||
| if (cursor != null && cursor.moveToFirst()) { | ||
| final int sizeIndex = cursor.getColumnIndex(OpenableColumns.SIZE); | ||
| if (sizeIndex != -1 && !cursor.isNull(sizeIndex)) { | ||
| return cursor.getLong(sizeIndex); | ||
| } | ||
| } | ||
| } catch (Throwable ignored) { | ||
|
Contributor
There was a problem hiding this comment. same comment here as above. |
||
| // if the size cannot be determined, let the attachment size limit handle it at capture time | ||
| } | ||
| return -1; | ||
| } | ||
|
|
||
| private static byte[] readUriBytes( | ||
| final @NotNull ContentResolver resolver, final @NotNull Uri uri, final long maxSize) | ||
| throws IOException { | ||
| try (final @Nullable InputStream inputStream = resolver.openInputStream(uri)) { | ||
| if (inputStream == null) { | ||
| throw new IOException("Unable to open image attachment: " + uri); | ||
| } | ||
| return FileUtils.inputStreamToByteArray(inputStream, maxSize); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void show() { | ||
| // If Sentry is disabled, don't show the dialog, but log a warning | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.