(Lio/sentry/SentryOptions;Lio/sentry/android/replay/gestures/TouchRecorderCallback;)V
public fun onRootViewsChanged (Landroid/view/View;Z)V
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayCache.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayCache.kt
index c1bfeb1e526..3db92ea5d80 100644
--- a/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayCache.kt
+++ b/sentry-android-replay/src/main/java/io/sentry/android/replay/ReplayCache.kt
@@ -80,6 +80,7 @@ public class ReplayCache(
if (replayCacheDir == null || bitmap.isRecycled) {
return
}
+ replayCacheDir?.mkdirs()
val screenshot = File(replayCacheDir, "$frameTimestamp.jpg").also {
it.createNewFile()
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/SessionReplayOptions.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/SessionReplayOptions.kt
new file mode 100644
index 00000000000..e3e6605a968
--- /dev/null
+++ b/sentry-android-replay/src/main/java/io/sentry/android/replay/SessionReplayOptions.kt
@@ -0,0 +1,31 @@
+package io.sentry.android.replay
+
+import io.sentry.SentryReplayOptions
+
+// since we don't have getters for redactAllText and redactAllImages, they won't be accessible as
+// properties in Kotlin, therefore we create these extensions where a getter is dummy, but a setter
+// delegates to the corresponding method in SentryReplayOptions
+
+/**
+ * Redact all text content. Draws a rectangle of text bounds with text color on top. By default
+ * only views extending TextView are redacted.
+ *
+ * Default is enabled.
+ */
+var SentryReplayOptions.redactAllText: Boolean
+ @Deprecated("Getter is unsupported.", level = DeprecationLevel.ERROR)
+ get() = error("Getter not supported")
+ set(value) = setRedactAllText(value)
+
+/**
+ * Redact all image content. Draws a rectangle of image bounds with image's dominant color on top.
+ * By default only views extending ImageView with BitmapDrawable or custom Drawable type are
+ * redacted. ColorDrawable, InsetDrawable, VectorDrawable are all considered non-PII, as they come
+ * from the apk.
+ *
+ *
Default is enabled.
+ */
+var SentryReplayOptions.redactAllImages: Boolean
+ @Deprecated("Getter is unsupported.", level = DeprecationLevel.ERROR)
+ get() = error("Getter not supported")
+ set(value) = setRedactAllImages(value)
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/ViewExtensions.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/ViewExtensions.kt
new file mode 100644
index 00000000000..37061a5b77c
--- /dev/null
+++ b/sentry-android-replay/src/main/java/io/sentry/android/replay/ViewExtensions.kt
@@ -0,0 +1,18 @@
+package io.sentry.android.replay
+
+import android.view.View
+
+/**
+ * Marks this view to be redacted in session replay.
+ */
+fun View.sentryReplayRedact() {
+ setTag(R.id.sentry_privacy, "redact")
+}
+
+/**
+ * Marks this view to be ignored from redaction in session.
+ * All its content will be visible in the replay, use with caution.
+ */
+fun View.sentryReplayIgnore() {
+ setTag(R.id.sentry_privacy, "ignore")
+}
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/Windows.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/Windows.kt
index 8ef595f1934..48c7eb58138 100644
--- a/sentry-android-replay/src/main/java/io/sentry/android/replay/Windows.kt
+++ b/sentry-android-replay/src/main/java/io/sentry/android/replay/Windows.kt
@@ -134,7 +134,7 @@ internal fun interface OnRootViewsChangedListener {
/**
* A utility that holds the list of root views that WindowManager updates.
*/
-internal class RootViewsSpy private constructor() {
+internal object RootViewsSpy {
val listeners: CopyOnWriteArrayList = object : CopyOnWriteArrayList() {
override fun add(element: OnRootViewsChangedListener?): Boolean {
@@ -168,15 +168,13 @@ internal class RootViewsSpy private constructor() {
}
}
- companion object {
- fun install(): RootViewsSpy {
- return RootViewsSpy().apply {
- // had to do this as a first message of the main thread queue, otherwise if this is
- // called from ContentProvider, it might be too early and the listener won't be installed
- Handler(Looper.getMainLooper()).postAtFrontOfQueue {
- WindowManagerSpy.swapWindowManagerGlobalMViews { mViews ->
- delegatingViewList.apply { addAll(mViews) }
- }
+ fun install(): RootViewsSpy {
+ return apply {
+ // had to do this as a first message of the main thread queue, otherwise if this is
+ // called from ContentProvider, it might be too early and the listener won't be installed
+ Handler(Looper.getMainLooper()).postAtFrontOfQueue {
+ WindowManagerSpy.swapWindowManagerGlobalMViews { mViews ->
+ delegatingViewList.apply { addAll(mViews) }
}
}
}
diff --git a/sentry-android-replay/src/main/java/io/sentry/android/replay/viewhierarchy/ViewHierarchyNode.kt b/sentry-android-replay/src/main/java/io/sentry/android/replay/viewhierarchy/ViewHierarchyNode.kt
index 145cefff3d4..90b96f134bb 100644
--- a/sentry-android-replay/src/main/java/io/sentry/android/replay/viewhierarchy/ViewHierarchyNode.kt
+++ b/sentry-android-replay/src/main/java/io/sentry/android/replay/viewhierarchy/ViewHierarchyNode.kt
@@ -7,6 +7,7 @@ import android.view.View
import android.widget.ImageView
import android.widget.TextView
import io.sentry.SentryOptions
+import io.sentry.android.replay.R
import io.sentry.android.replay.util.isRedactable
import io.sentry.android.replay.util.isVisibleToUser
import io.sentry.android.replay.util.totalPaddingTopSafe
@@ -233,14 +234,46 @@ sealed class ViewHierarchyNode(
}
}
- private fun shouldRedact(view: View, options: SentryOptions): Boolean {
- return options.experimental.sessionReplay.redactClasses.contains(view.javaClass.canonicalName)
+ private const val SENTRY_IGNORE_TAG = "sentry-ignore"
+ private const val SENTRY_REDACT_TAG = "sentry-redact"
+
+ private fun Class<*>.isAssignableFrom(set: Set): Boolean {
+ var cls: Class<*>? = this
+ while (cls != null) {
+ val canonicalName = cls.canonicalName
+ if (canonicalName != null && set.contains(canonicalName)) {
+ return true
+ }
+ cls = cls.superclass
+ }
+ return false
+ }
+
+ private fun View.shouldRedact(options: SentryOptions): Boolean {
+ if ((tag as? String)?.lowercase()?.contains(SENTRY_IGNORE_TAG) == true ||
+ getTag(R.id.sentry_privacy) == "ignore"
+ ) {
+ return false
+ }
+
+ if ((tag as? String)?.lowercase()?.contains(SENTRY_REDACT_TAG) == true ||
+ getTag(R.id.sentry_privacy) == "redact"
+ ) {
+ return true
+ }
+
+ if (this.javaClass.isAssignableFrom(options.experimental.sessionReplay.ignoreViewClasses)) {
+ return false
+ }
+
+ return this.javaClass.isAssignableFrom(options.experimental.sessionReplay.redactViewClasses)
}
fun fromView(view: View, parent: ViewHierarchyNode?, distance: Int, options: SentryOptions): ViewHierarchyNode {
val (isVisible, visibleRect) = view.isVisibleToUser()
- when {
- view is TextView && options.experimental.sessionReplay.redactAllText -> {
+ val shouldRedact = isVisible && view.shouldRedact(options)
+ when (view) {
+ is TextView -> {
parent.setImportantForCaptureToAncestors(true)
return TextViewHierarchyNode(
layout = view.layout,
@@ -252,7 +285,7 @@ sealed class ViewHierarchyNode(
width = view.width,
height = view.height,
elevation = (parent?.elevation ?: 0f) + view.elevation,
- shouldRedact = isVisible,
+ shouldRedact = shouldRedact,
distance = distance,
parent = parent,
isImportantForContentCapture = true,
@@ -261,7 +294,7 @@ sealed class ViewHierarchyNode(
)
}
- view is ImageView && options.experimental.sessionReplay.redactAllImages -> {
+ is ImageView -> {
parent.setImportantForCaptureToAncestors(true)
return ImageViewHierarchyNode(
x = view.x,
@@ -273,7 +306,7 @@ sealed class ViewHierarchyNode(
parent = parent,
isVisible = isVisible,
isImportantForContentCapture = true,
- shouldRedact = isVisible && view.drawable?.isRedactable() == true,
+ shouldRedact = shouldRedact && view.drawable?.isRedactable() == true,
visibleRect = visibleRect
)
}
@@ -287,7 +320,7 @@ sealed class ViewHierarchyNode(
(parent?.elevation ?: 0f) + view.elevation,
distance = distance,
parent = parent,
- shouldRedact = isVisible && shouldRedact(view, options),
+ shouldRedact = shouldRedact,
isImportantForContentCapture = false, /* will be set by children */
isVisible = isVisible,
visibleRect = visibleRect
diff --git a/sentry-android-replay/src/main/res/public.xml b/sentry-android-replay/src/main/res/public.xml
deleted file mode 100644
index 379be515be2..00000000000
--- a/sentry-android-replay/src/main/res/public.xml
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
diff --git a/sentry-android-replay/src/main/res/values/public.xml b/sentry-android-replay/src/main/res/values/public.xml
new file mode 100644
index 00000000000..cc60000bcd3
--- /dev/null
+++ b/sentry-android-replay/src/main/res/values/public.xml
@@ -0,0 +1,5 @@
+
+
+
+ Default is enabled.
- */
- private boolean redactAllText = true;
-
- /**
- * Redact all image content. Draws a rectangle of image bounds with image's dominant color on top.
- * By default only views extending ImageView with BitmapDrawable or custom Drawable type are
- * redacted. ColorDrawable, InsetDrawable, VectorDrawable are all considered non-PII, as they come
- * from the apk.
+ *
If you're using an obfuscation tool, make sure to add the respective proguard rules to keep
+ * the class names.
*
- *
Default is enabled.
+ *
Default is empty.
*/
- private boolean redactAllImages = true;
+ private Set redactViewClasses = new CopyOnWriteArraySet<>();
/**
- * Redact all views with the specified class names. The class name is the fully qualified class
- * name of the view, e.g. android.widget.TextView.
+ * Ignore all views with the specified class names from redaction. The class name is the fully
+ * qualified class name of the view, e.g. android.widget.TextView. The subclasses of the specified
+ * classes will be ignored as well.
+ *
+ * If you're using an obfuscation tool, make sure to add the respective proguard rules to keep
+ * the class names.
*
*
Default is empty.
*/
- private Set redactClasses = new CopyOnWriteArraySet<>();
+ private Set ignoreViewClasses = new CopyOnWriteArraySet<>();
/**
* Defines the quality of the session replay. The higher the quality, the more accurate the replay
@@ -95,10 +96,14 @@ public enum SentryReplayQuality {
/** The maximum duration of a full session replay, defaults to 1h. */
private long sessionDuration = 60 * 60 * 1000L;
- public SentryReplayOptions() {}
+ public SentryReplayOptions() {
+ setRedactAllText(true);
+ setRedactAllImages(true);
+ }
public SentryReplayOptions(
final @Nullable Double sessionSampleRate, final @Nullable Double onErrorSampleRate) {
+ this();
this.sessionSampleRate = sessionSampleRate;
this.onErrorSampleRate = onErrorSampleRate;
}
@@ -141,28 +146,56 @@ public void setSessionSampleRate(final @Nullable Double sessionSampleRate) {
this.sessionSampleRate = sessionSampleRate;
}
- public boolean getRedactAllText() {
- return redactAllText;
+ /**
+ * Redact all text content. Draws a rectangle of text bounds with text color on top. By default
+ * only views extending TextView are redacted.
+ *
+ * Default is enabled.
+ */
+ public void setRedactAllText(final boolean redactAllText) {
+ if (redactAllText) {
+ addRedactViewClass(TEXT_VIEW_CLASS_NAME);
+ ignoreViewClasses.remove(TEXT_VIEW_CLASS_NAME);
+ } else {
+ addIgnoreViewClass(TEXT_VIEW_CLASS_NAME);
+ redactViewClasses.remove(TEXT_VIEW_CLASS_NAME);
+ }
}
- public void setRedactAllText(final boolean redactAllText) {
- this.redactAllText = redactAllText;
+ /**
+ * Redact all image content. Draws a rectangle of image bounds with image's dominant color on top.
+ * By default only views extending ImageView with BitmapDrawable or custom Drawable type are
+ * redacted. ColorDrawable, InsetDrawable, VectorDrawable are all considered non-PII, as they come
+ * from the apk.
+ *
+ *
Default is enabled.
+ */
+ public void setRedactAllImages(final boolean redactAllImages) {
+ if (redactAllImages) {
+ addRedactViewClass(IMAGE_VIEW_CLASS_NAME);
+ ignoreViewClasses.remove(IMAGE_VIEW_CLASS_NAME);
+ } else {
+ addIgnoreViewClass(IMAGE_VIEW_CLASS_NAME);
+ redactViewClasses.remove(IMAGE_VIEW_CLASS_NAME);
+ }
}
- public boolean getRedactAllImages() {
- return redactAllImages;
+ @NotNull
+ public Set getRedactViewClasses() {
+ return this.redactViewClasses;
}
- public void setRedactAllImages(final boolean redactAllImages) {
- this.redactAllImages = redactAllImages;
+ public void addRedactViewClass(final @NotNull String className) {
+ this.redactViewClasses.add(className);
}
- public Set getRedactClasses() {
- return this.redactClasses;
+ @NotNull
+ public Set getIgnoreViewClasses() {
+ return this.ignoreViewClasses;
}
- public void addClassToRedact(final String className) {
- this.redactClasses.add(className);
+ public void addIgnoreViewClass(final @NotNull String className) {
+ this.ignoreViewClasses.add(className);
}
@ApiStatus.Internal