POTEL 41 - Set InitPriority for Android, Manifest option for forceInit (

#3675) * Support spans across batches * changelog * POC use correct options for multi init * Add settings for controlling init priority * Set InitPriority for Android, Manifest option for forceInit * Move auto init priority = low code * Update sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java Co-authored-by: Markus Hintersteiner <[email protected]> * changelog --------- Co-authored-by: Markus Hintersteiner <[email protected]>
getsentry · Sep 16, 2024 · 9b2603b · 9b2603b
1 parent c58587b
commit 9b2603b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@
 
 - Add init priority settings ([#3674](https://github.com/getsentry/sentry-java/pull/3674))
   - You may now set `forceInit=true` (`force-init` for `.properties` files) to ensure a call to Sentry.init / SentryAndroid.init takes effect
+- Add force init option to Android Manifest
+  - Use `<meta-data android:name="io.sentry.force-init" android:value="true" />` to ensure Sentry Android auto init is not easily overwritten 
 
 ### Fixes
 

diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java b/sentry-android-core/src/main/java/io/sentry/android/core/ManifestMetadataReader.java
@@ -5,6 +5,7 @@
 import android.content.pm.PackageManager;
 import android.os.Bundle;
 import io.sentry.ILogger;
+import io.sentry.InitPriority;
 import io.sentry.SentryIntegrationPackageStorage;
 import io.sentry.SentryLevel;
 import io.sentry.protocol.SdkVersion;
@@ -104,6 +105,8 @@ final class ManifestMetadataReader {
 
   static final String ENABLE_METRICS = "io.sentry.enable-metrics";
 
+  static final String FORCE_INIT = "io.sentry.force-init";
+
   /** ManifestMetadataReader ctor */
   private ManifestMetadataReader() {}
 
@@ -263,6 +266,13 @@ static void applyMetadata(
         options.setSendClientReports(
             readBool(metadata, logger, CLIENT_REPORTS_ENABLE, options.isSendClientReports()));
 
+        final boolean isAutoInitEnabled = readBool(metadata, logger, AUTO_INIT, true);
+        if (isAutoInitEnabled) {
+          options.setInitPriority(InitPriority.LOW);
+        }
+
+        options.setForceInit(readBool(metadata, logger, FORCE_INIT, options.isForceInit()));
+
         options.setCollectAdditionalContext(
             readBool(
                 metadata,

diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/ManifestMetadataReaderTest.kt
@@ -1420,4 +1420,29 @@ class ManifestMetadataReaderTest {
         // Assert
         assertFalse(fixture.options.isEnableMetrics)
     }
+
+    @Test
+    fun `applyMetadata reads forceInit flag to options`() {
+        // Arrange
+        val bundle = bundleOf(ManifestMetadataReader.FORCE_INIT to true)
+        val context = fixture.getContext(metaData = bundle)
+
+        // Act
+        ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+        // Assert
+        assertTrue(fixture.options.isForceInit)
+    }
+
+    @Test
+    fun `applyMetadata reads forceInit flag to options and keeps default if not found`() {
+        // Arrange
+        val context = fixture.getContext()
+
+        // Act
+        ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
+
+        // Assert
+        assertFalse(fixture.options.isForceInit)
+    }
 }
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -2593,6 +2593,7 @@ public SentryOptions() {
    */
   private SentryOptions(final boolean empty) {
     if (!empty) {
+      setInitPriority(InitPriority.LOWEST);
       setSpanFactory(new DefaultSpanFactory());
       // SentryExecutorService should be initialized before any
       // SendCachedEventFireAndForgetIntegration