-
-
Notifications
You must be signed in to change notification settings - Fork 435
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Sentry Github Bot <[email protected]>
- Loading branch information
1 parent
1e2a01e
commit 4414ba0
Showing
18 changed files
with
586 additions
and
30 deletions.
There are no files selected for viewing
This file contains 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 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 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 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
194 changes: 194 additions & 0 deletions
194
sentry-android-core/src/main/java/io/sentry/android/core/ScreenshotEventProcessor.java
This file contains 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,194 @@ | ||
| package io.sentry.android.core; | ||
|
|
||
| import static io.sentry.TypeCheckHint.ANDROID_ACTIVITY; | ||
| import static io.sentry.TypeCheckHint.SENTRY_SCREENSHOT; | ||
|
|
||
| import android.annotation.SuppressLint; | ||
| import android.app.Activity; | ||
| import android.app.Application; | ||
| import android.graphics.Bitmap; | ||
| import android.graphics.Canvas; | ||
| import android.os.Build; | ||
| import android.os.Bundle; | ||
| import android.view.View; | ||
| import androidx.annotation.NonNull; | ||
| import androidx.annotation.Nullable; | ||
| import io.sentry.Attachment; | ||
| import io.sentry.EventProcessor; | ||
| import io.sentry.SentryEvent; | ||
| import io.sentry.SentryLevel; | ||
| import io.sentry.util.Objects; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.Closeable; | ||
| import java.io.IOException; | ||
| import java.lang.ref.WeakReference; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import org.jetbrains.annotations.ApiStatus; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| /** | ||
| * ScreenshotEventProcessor responsible for taking a screenshot of the screen when an error is | ||
| * captured. | ||
| */ | ||
| @ApiStatus.Internal | ||
| public final class ScreenshotEventProcessor | ||
| implements EventProcessor, Application.ActivityLifecycleCallbacks, Closeable { | ||
|
|
||
| private final @NotNull Application application; | ||
| private final @NotNull SentryAndroidOptions options; | ||
| private @Nullable WeakReference<Activity> currentActivity; | ||
| final @NotNull BuildInfoProvider buildInfoProvider; | ||
|
|
||
| public ScreenshotEventProcessor( | ||
| final @NotNull Application application, | ||
| final @NotNull SentryAndroidOptions options, | ||
| final @NotNull BuildInfoProvider buildInfoProvider) { | ||
| this.application = Objects.requireNonNull(application, "Application is required"); | ||
| this.options = Objects.requireNonNull(options, "SentryAndroidOptions is required"); | ||
| this.buildInfoProvider = | ||
| Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required"); | ||
|
|
||
| if (this.options.isAttachScreenshot()) { | ||
| application.registerActivityLifecycleCallbacks(this); | ||
|
|
||
| this.options | ||
| .getLogger() | ||
| .log( | ||
| SentryLevel.DEBUG, | ||
| "attachScreenshot is enabled, ScreenshotEventProcessor is installed."); | ||
| } else { | ||
| this.options | ||
| .getLogger() | ||
| .log( | ||
| SentryLevel.DEBUG, | ||
| "attachScreenshot is disabled, ScreenshotEventProcessor isn't installed."); | ||
| } | ||
| } | ||
|
|
||
| @SuppressWarnings("NullAway") | ||
| @Override | ||
| public @NotNull SentryEvent process( | ||
| final @NotNull SentryEvent event, @Nullable Map<String, Object> hint) { | ||
| if (options.isAttachScreenshot() && event.isErrored() && currentActivity != null) { | ||
| final Activity activity = currentActivity.get(); | ||
| if (isActivityValid(activity) | ||
| && activity.getWindow() != null | ||
| && activity.getWindow().getDecorView() != null | ||
| && activity.getWindow().getDecorView().getRootView() != null) { | ||
| final View view = activity.getWindow().getDecorView().getRootView(); | ||
|
|
||
| if (view.getWidth() > 0 && view.getHeight() > 0) { | ||
| try { | ||
| // ARGB_8888 -> This configuration is very flexible and offers the best quality | ||
| final Bitmap bitmap = | ||
| Bitmap.createBitmap(view.getWidth(), view.getHeight(), Bitmap.Config.ARGB_8888); | ||
|
|
||
| final Canvas canvas = new Canvas(bitmap); | ||
| view.draw(canvas); | ||
|
|
||
| final ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(); | ||
|
|
||
| // 0 meaning compress for small size, 100 meaning compress for max quality. | ||
| // Some formats, like PNG which is lossless, will ignore the quality setting. | ||
| bitmap.compress(Bitmap.CompressFormat.PNG, 0, byteArrayOutputStream); | ||
|
|
||
| if (hint == null) { | ||
| hint = new HashMap<>(); | ||
| } | ||
|
|
||
| if (byteArrayOutputStream.size() > 0) { | ||
| // screenshot png is around ~100-150 kb | ||
| hint.put( | ||
| SENTRY_SCREENSHOT, | ||
| Attachment.fromScreenshot(byteArrayOutputStream.toByteArray())); | ||
| hint.put(ANDROID_ACTIVITY, activity); | ||
| } else { | ||
| this.options | ||
| .getLogger() | ||
| .log(SentryLevel.DEBUG, "Screenshot is 0 bytes, not attaching the image."); | ||
| } | ||
| } catch (Throwable e) { | ||
| this.options.getLogger().log(SentryLevel.ERROR, "Taking screenshot failed.", e); | ||
| } | ||
| } else { | ||
| this.options | ||
| .getLogger() | ||
| .log(SentryLevel.DEBUG, "View's width and height is zeroed, not taking screenshot."); | ||
| } | ||
| } else { | ||
| this.options | ||
| .getLogger() | ||
| .log(SentryLevel.DEBUG, "Activity isn't valid, not taking screenshot."); | ||
| } | ||
| } | ||
|
|
||
| return event; | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityCreated(@NonNull Activity activity, @Nullable Bundle savedInstanceState) { | ||
| setCurrentActivity(activity); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityStarted(@NonNull Activity activity) { | ||
| setCurrentActivity(activity); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityResumed(@NonNull Activity activity) { | ||
| setCurrentActivity(activity); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityPaused(@NonNull Activity activity) { | ||
| cleanCurrentActivity(activity); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivityStopped(@NonNull Activity activity) { | ||
| cleanCurrentActivity(activity); | ||
| } | ||
|
|
||
| @Override | ||
| public void onActivitySaveInstanceState(@NonNull Activity activity, @NonNull Bundle outState) {} | ||
|
|
||
| @Override | ||
| public void onActivityDestroyed(@NonNull Activity activity) { | ||
| cleanCurrentActivity(activity); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws IOException { | ||
| if (options.isAttachScreenshot()) { | ||
| application.unregisterActivityLifecycleCallbacks(this); | ||
| currentActivity = null; | ||
| } | ||
| } | ||
|
|
||
| private void cleanCurrentActivity(@NonNull Activity activity) { | ||
| if (currentActivity != null && currentActivity.get() == activity) { | ||
| currentActivity = null; | ||
| } | ||
| } | ||
|
|
||
| private void setCurrentActivity(@NonNull Activity activity) { | ||
| if (currentActivity != null && currentActivity.get() == activity) { | ||
| return; | ||
| } | ||
| currentActivity = new WeakReference<>(activity); | ||
| } | ||
|
|
||
| @SuppressLint("NewApi") | ||
| private boolean isActivityValid(@Nullable Activity activity) { | ||
| if (activity == null) { | ||
| return false; | ||
| } | ||
| if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.JELLY_BEAN_MR1) { | ||
| return !activity.isFinishing() && !activity.isDestroyed(); | ||
| } else { | ||
| return !activity.isFinishing(); | ||
| } | ||
| } | ||
| } |
This file contains 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 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.