Merge branch 'main' into no/optimize

Author: runningcode

.github/workflows/codeql-analysis.yml

@@ -36,7 +36,7 @@ jobs:
           cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@60168efe1c415ce0f5521ea06d5c2062adbeed1b # pin@v2
+        uses: github/codeql-action/init@ff0a06e83cb2de871e5a09832bc6a81e7276941f # pin@v2
         with:
           languages: 'java'
 
@@ -45,4 +45,4 @@ jobs:
           ./gradlew buildForCodeQL --no-build-cache
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@60168efe1c415ce0f5521ea06d5c2062adbeed1b # pin@v2
+        uses: github/codeql-action/analyze@ff0a06e83cb2de871e5a09832bc6a81e7276941f # pin@v2

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .idea/
 .gradle/
+.run/
 build/
 artifacts/
 out/

CHANGELOG.md

@@ -4,11 +4,52 @@
 
 ### Fixes
 
+- No longer send out empty log envelopes ([#4497](https://github.com/getsentry/sentry-java/pull/4497))
+
+## 8.14.0
+
+### Fixes
+
+- Fix Session Replay masking for newer versions of Jetpack Compose (1.8+) ([#4485](https://github.com/getsentry/sentry-java/pull/4485))
+
+### Features
+
+- Add New User Feedback Widget ([#4450](https://github.com/getsentry/sentry-java/pull/4450))
+    - This widget is a custom button that can be used to show the user feedback form
+- Add New User Feedback form ([#4384](https://github.com/getsentry/sentry-java/pull/4384))
+    - We now introduce SentryUserFeedbackDialog, which extends AlertDialog, inheriting the show() and cancel() methods, among others.
+      To use it, just instantiate it and call show() on the instance (Sentry must be previously initialized).
+      For customization options, please check the [User Feedback documentation](https://docs.sentry.io/platforms/android/user-feedback/configuration/).
+      ```java
+      import io.sentry.android.core.SentryUserFeedbackDialog;
+      
+      new SentryUserFeedbackDialog.Builder(context).create().show();
+      ```
+      ```kotlin
+      import io.sentry.android.core.SentryUserFeedbackDialog
+    
+      SentryUserFeedbackDialog.Builder(context).create().show()
+      ```
+- Add `user.id`, `user.name` and `user.email` to log attributes ([#4486](https://github.com/getsentry/sentry-java/pull/4486))
+- User `name` attribute has been deprecated, please use `username` instead ([#4486](https://github.com/getsentry/sentry-java/pull/4486))
+- Add device (`device.brand`, `device.model` and `device.family`) and OS (`os.name` and `os.version`) attributes to logs ([#4493](https://github.com/getsentry/sentry-java/pull/4493))
+- Serialize `preContext` and `postContext` in `SentryStackFrame` ([#4482](https://github.com/getsentry/sentry-java/pull/4482))
+
+### Internal
+
+- User Feedback now uses SentryUser.username instead of SentryUser.name ([#4494](https://github.com/getsentry/sentry-java/pull/4494))
+
+## 8.13.3
+
+### Fixes
+
 - Send UI Profiling app start chunk when it finishes ([#4423](https://github.com/getsentry/sentry-java/pull/4423))
 - Republish Javadoc [#4457](https://github.com/getsentry/sentry-java/pull/4457)
 - Finalize `OkHttpEvent` even if no active span in `SentryOkHttpInterceptor` [#4469](https://github.com/getsentry/sentry-java/pull/4469)
+- Session Replay: Do not capture current replay for cached events from the past ([#4474](https://github.com/getsentry/sentry-java/pull/4474))
 - Session Replay: Correctly capture Dialogs and non full-sized windows ([#4354](https://github.com/getsentry/sentry-java/pull/4354))
 - Session Replay: Fix inconsistent `segment_id` ([#4471](https://github.com/getsentry/sentry-java/pull/4471))
+- Session Replay: Fix crash on devices with the Unisoc/Spreadtrum T606 chipset ([#4477](https://github.com/getsentry/sentry-java/pull/4477))
 
 ## 8.13.2
 

build-logic/src/main/kotlin/io.sentry.javadoc.aggregate.gradle.kts

@@ -20,7 +20,7 @@ subprojects {
 
 val javadocCollection = javadocPublisher.incoming.artifactView { lenient(true) }.files
 
-tasks.register("aggregateJavadoc", AggregateJavadoc::class) {
+tasks.register("aggregateJavadocs", AggregateJavadoc::class) {
     group = "documentation"
     description = "Aggregates Javadocs from all subprojects into a single directory."
     javadocFiles.set(javadocCollection)

gradle.properties

@@ -14,7 +14,7 @@ org.gradle.workers.max=2
 android.useAndroidX=true
 
 # Release information
-versionName=8.13.2
+versionName=8.14.0
 
 # Override the SDK name on native crashes on Android
 sentryAndroidSdkName=sentry.native.android

sentry-android-core/api/sentry-android-core.api

@@ -385,6 +385,32 @@ public final class io/sentry/android/core/SentryPerformanceProvider {
 	public fun shutdown ()V
 }
 
+public class io/sentry/android/core/SentryUserFeedbackButton : android/widget/Button {
+	public fun <init> (Landroid/content/Context;)V
+	public fun <init> (Landroid/content/Context;Landroid/util/AttributeSet;)V
+	public fun <init> (Landroid/content/Context;Landroid/util/AttributeSet;I)V
+	public fun <init> (Landroid/content/Context;Landroid/util/AttributeSet;II)V
+	public fun setOnClickListener (Landroid/view/View$OnClickListener;)V
+}
+
+public final class io/sentry/android/core/SentryUserFeedbackDialog : android/app/AlertDialog {
+	public fun setCancelable (Z)V
+	public fun setOnDismissListener (Landroid/content/DialogInterface$OnDismissListener;)V
+	public fun show ()V
+}
+
+public class io/sentry/android/core/SentryUserFeedbackDialog$Builder {
+	public fun <init> (Landroid/content/Context;)V
+	public fun <init> (Landroid/content/Context;I)V
+	public fun <init> (Landroid/content/Context;ILio/sentry/android/core/SentryUserFeedbackDialog$OptionsConfiguration;)V
+	public fun <init> (Landroid/content/Context;Lio/sentry/android/core/SentryUserFeedbackDialog$OptionsConfiguration;)V
+	public fun create ()Lio/sentry/android/core/SentryUserFeedbackDialog;
+}
+
+public abstract interface class io/sentry/android/core/SentryUserFeedbackDialog$OptionsConfiguration {
+	public abstract fun configure (Landroid/content/Context;Lio/sentry/SentryFeedbackOptions;)V
+}
+
 public class io/sentry/android/core/SpanFrameMetricsCollector : io/sentry/IPerformanceContinuousCollector, io/sentry/android/core/internal/util/SentryFrameMetricsCollector$FrameMetricsCollectorListener {
 	protected final field lock Lio/sentry/util/AutoClosableReentrantLock;
 	public fun <init> (Lio/sentry/android/core/SentryAndroidOptions;Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;)V

sentry-android-core/src/main/java/io/sentry/android/core/DefaultAndroidEventProcessor.java

@@ -3,13 +3,18 @@
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
+import android.os.Build;
 import io.sentry.DateUtils;
 import io.sentry.EventProcessor;
 import io.sentry.Hint;
 import io.sentry.IpAddressUtils;
+import io.sentry.NoOpLogger;
+import io.sentry.SentryAttributeType;
 import io.sentry.SentryBaseEvent;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
+import io.sentry.SentryLogEvent;
+import io.sentry.SentryLogEventAttributeValue;
 import io.sentry.SentryReplayEvent;
 import io.sentry.android.core.internal.util.AndroidThreadChecker;
 import io.sentry.android.core.performance.AppStartMetrics;
@@ -23,6 +28,7 @@
 import io.sentry.protocol.SentryTransaction;
 import io.sentry.protocol.User;
 import io.sentry.util.HintUtils;
+import io.sentry.util.LazyEvaluator;
 import io.sentry.util.Objects;
 import java.util.Collections;
 import java.util.List;
@@ -42,6 +48,8 @@ final class DefaultAndroidEventProcessor implements EventProcessor {
   private final @NotNull BuildInfoProvider buildInfoProvider;
   private final @NotNull SentryAndroidOptions options;
   private final @NotNull Future<DeviceInfoUtil> deviceInfoUtil;
+  private final @NotNull LazyEvaluator<String> deviceFamily =
+      new LazyEvaluator<>(() -> ContextUtils.getFamily(NoOpLogger.getInstance()));
 
   public DefaultAndroidEventProcessor(
       final @NotNull Context context,
@@ -81,6 +89,13 @@ public DefaultAndroidEventProcessor(
     return event;
   }
 
+  @Override
+  public @Nullable SentryLogEvent process(@NotNull SentryLogEvent event) {
+    setDevice(event);
+    setOs(event);
+    return event;
+  }
+
   /**
    * The last exception is usually used for picking the issue title, but the convention is to send
    * inner exceptions first, e.g. [inner, outer] This doesn't work very well on Android, as some
@@ -199,6 +214,34 @@ private void mergeOS(final @NotNull SentryBaseEvent event) {
     }
   }
 
+  private void setDevice(final @NotNull SentryLogEvent event) {
+    try {
+      event.setAttribute(
+          "device.brand",
+          new SentryLogEventAttributeValue(SentryAttributeType.STRING, Build.BRAND));
+      event.setAttribute(
+          "device.model",
+          new SentryLogEventAttributeValue(SentryAttributeType.STRING, Build.MODEL));
+      event.setAttribute(
+          "device.family",
+          new SentryLogEventAttributeValue(SentryAttributeType.STRING, deviceFamily.getValue()));
+    } catch (Throwable e) {
+      options.getLogger().log(SentryLevel.ERROR, "Failed to retrieve device info", e);
+    }
+  }
+
+  private void setOs(final @NotNull SentryLogEvent event) {
+    try {
+      event.setAttribute(
+          "os.name", new SentryLogEventAttributeValue(SentryAttributeType.STRING, "Android"));
+      event.setAttribute(
+          "os.version",
+          new SentryLogEventAttributeValue(SentryAttributeType.STRING, Build.VERSION.RELEASE));
+    } catch (Throwable e) {
+      options.getLogger().log(SentryLevel.ERROR, "Failed to retrieve os system", e);
+    }
+  }
+
   // Data to be applied to events that was created in the running process
   private void processNonCachedEvent(
       final @NotNull SentryBaseEvent event, final @NotNull Hint hint) {

sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java

@@ -6,6 +6,7 @@
 import io.sentry.ILogger;
 import io.sentry.InitPriority;
 import io.sentry.ProfileLifecycle;
+import io.sentry.SentryFeedbackOptions;
 import io.sentry.SentryIntegrationPackageStorage;
 import io.sentry.SentryLevel;
 import io.sentry.protocol.SdkVersion;
@@ -126,6 +127,18 @@ final class ManifestMetadataReader {
   static final String ENABLE_AUTO_TRACE_ID_GENERATION =
       "io.sentry.traces.enable-auto-id-generation";
 
+  static final String FEEDBACK_NAME_REQUIRED = "io.sentry.feedback.is-name-required";
+
+  static final String FEEDBACK_SHOW_NAME = "io.sentry.feedback.show-name";
+
+  static final String FEEDBACK_EMAIL_REQUIRED = "io.sentry.feedback.is-email-required";
+
+  static final String FEEDBACK_SHOW_EMAIL = "io.sentry.feedback.show-email";
+
+  static final String FEEDBACK_USE_SENTRY_USER = "io.sentry.feedback.use-sentry-user";
+
+  static final String FEEDBACK_SHOW_BRANDING = "io.sentry.feedback.show-branding";
+
   /** ManifestMetadataReader ctor */
   private ManifestMetadataReader() {}
 
@@ -477,6 +490,21 @@ static void applyMetadata(
         options
             .getLogs()
             .setEnabled(readBool(metadata, logger, ENABLE_LOGS, options.getLogs().isEnabled()));
+
+        final @NotNull SentryFeedbackOptions feedbackOptions = options.getFeedbackOptions();
+        feedbackOptions.setNameRequired(
+            readBool(metadata, logger, FEEDBACK_NAME_REQUIRED, feedbackOptions.isNameRequired()));
+        feedbackOptions.setShowName(
+            readBool(metadata, logger, FEEDBACK_SHOW_NAME, feedbackOptions.isShowName()));
+        feedbackOptions.setEmailRequired(
+            readBool(metadata, logger, FEEDBACK_EMAIL_REQUIRED, feedbackOptions.isEmailRequired()));
+        feedbackOptions.setShowEmail(
+            readBool(metadata, logger, FEEDBACK_SHOW_EMAIL, feedbackOptions.isShowEmail()));
+        feedbackOptions.setUseSentryUser(
+            readBool(
+                metadata, logger, FEEDBACK_USE_SENTRY_USER, feedbackOptions.isUseSentryUser()));
+        feedbackOptions.setShowBranding(
+            readBool(metadata, logger, FEEDBACK_SHOW_BRANDING, feedbackOptions.isShowBranding()));
       }
       options
           .getLogger()

sentry-android-core/src/main/java/io/sentry/android/core/SentryUserFeedbackButton.java

@@ -0,0 +1,122 @@
+package io.sentry.android.core;
+
+import android.annotation.SuppressLint;
+import android.content.Context;
+import android.content.res.TypedArray;
+import android.os.Build;
+import android.util.AttributeSet;
+import android.util.TypedValue;
+import android.widget.Button;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class SentryUserFeedbackButton extends Button {
+
+  private @Nullable OnClickListener delegate;
+
+  public SentryUserFeedbackButton(Context context) {
+    super(context);
+    init(context, null, 0, 0);
+  }
+
+  public SentryUserFeedbackButton(Context context, AttributeSet attrs) {
+    super(context, attrs);
+    init(context, attrs, 0, 0);
+  }
+
+  public SentryUserFeedbackButton(Context context, AttributeSet attrs, int defStyleAttr) {
+    super(context, attrs, defStyleAttr);
+    init(context, attrs, defStyleAttr, 0);
+  }
+
+  public SentryUserFeedbackButton(
+      Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
+    super(context, attrs, defStyleAttr, defStyleRes);
+    init(context, attrs, defStyleAttr, defStyleRes);
+  }
+
+  @SuppressLint("SetTextI18n")
+  @SuppressWarnings("deprecation")
+  private void init(
+      final @NotNull Context context,
+      final @Nullable AttributeSet attrs,
+      final int defStyleAttr,
+      final int defStyleRes) {
+    try (final @NotNull TypedArray typedArray =
+            context.obtainStyledAttributes(
+                attrs, R.styleable.SentryUserFeedbackButton, defStyleAttr, defStyleRes)) {
+      final float dimensionScale = context.getResources().getDisplayMetrics().density;
+      final float drawablePadding =
+          typedArray.getDimension(R.styleable.SentryUserFeedbackButton_android_drawablePadding, -1);
+      final int drawableStart =
+          typedArray.getResourceId(R.styleable.SentryUserFeedbackButton_android_drawableStart, -1);
+      final boolean textAllCaps =
+          typedArray.getBoolean(R.styleable.SentryUserFeedbackButton_android_textAllCaps, false);
+      final int background =
+          typedArray.getResourceId(R.styleable.SentryUserFeedbackButton_android_background, -1);
+      final float padding =
+          typedArray.getDimension(R.styleable.SentryUserFeedbackButton_android_padding, -1);
+      final int textColor =
+          typedArray.getColor(R.styleable.SentryUserFeedbackButton_android_textColor, -1);
+      final @Nullable String text =
+          typedArray.getString(R.styleable.SentryUserFeedbackButton_android_text);
+
+      // If the drawable padding is not set, set it to 4dp
+      if (drawablePadding == -1) {
+        setCompoundDrawablePadding((int) (4 * dimensionScale));
+      }
+
+      // If the drawable start is not set, set it to the default drawable
+      if (drawableStart == -1) {
+        setCompoundDrawablesRelativeWithIntrinsicBounds(
+            R.drawable.sentry_user_feedback_button_logo_24, 0, 0, 0);
+      }
+
+      // Set the text all caps
+      setAllCaps(textAllCaps);
+
+      // If the background is not set, set it to the default background
+      if (background == -1) {
+        setBackgroundResource(R.drawable.sentry_oval_button_ripple_background);
+      }
+
+      // If the padding is not set, set it to 12dp
+      if (padding == -1) {
+        int defaultPadding = (int) (12 * dimensionScale);
+        setPadding(defaultPadding, defaultPadding, defaultPadding, defaultPadding);
+      }
+
+      // If the text color is not set, set it to the default text color
+      if (textColor == -1) {
+        // We need the TypedValue to resolve the color from the theme
+        final @NotNull TypedValue typedValue = new TypedValue();
+        context.getTheme().resolveAttribute(android.R.attr.colorForeground, typedValue, true);
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+          setTextColor(context.getResources().getColor(typedValue.resourceId, context.getTheme()));
+        } else {
+          setTextColor(context.getResources().getColor(typedValue.resourceId));
+        }
+      }
+
+      // If the text is not set, set it to "Report a Bug"
+      if (text == null) {
+        setText("Report a Bug");
+      }
+    }
+
+    // Set the default ClickListener to open the SentryUserFeedbackDialog
+    setOnClickListener(delegate);
+  }
+
+  @Override
+  public void setOnClickListener(final @Nullable OnClickListener listener) {
+    delegate = listener;
+    super.setOnClickListener(
+        v -> {
+          new SentryUserFeedbackDialog.Builder(getContext()).create().show();
+          if (delegate != null) {
+            delegate.onClick(v);
+          }
+        });
+  }
+}