Fix wrong default environment in Session (getsentry#2610)

lbloder · romtsn · web-flow · commit 8ec2c16fc291 · 2023-03-22T16:21:12.000+01:00
Co-authored-by: Roman Zavarnitsyn &lt;rom4ek93@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Fix wrong default environment in Session ([#2610](https://github.com/getsentry/sentry-java/pull/2610))
+
 ## 6.16.0
 
 ### Features
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
@@ -164,7 +164,7 @@ class ManifestMetadataReaderTest {
         ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)
 
         // Assert
-        assertNull(fixture.options.environment)
+        assertEquals("production", fixture.options.environment)
     }
 
     @Test
diff --git a/sentry/src/main/java/io/sentry/MainEventProcessor.java b/sentry/src/main/java/io/sentry/MainEventProcessor.java
@@ -23,12 +23,6 @@
 @ApiStatus.Internal
 public final class MainEventProcessor implements EventProcessor, Closeable {
 
-  /**
-   * Default value for {@link SentryEvent#getEnvironment()} set when both event and {@link
-   * SentryOptions} do not have the environment field set.
-   */
-  private static final String DEFAULT_ENVIRONMENT = "production";
-
   private final @NotNull SentryOptions options;
   private final @NotNull SentryThreadFactory sentryThreadFactory;
   private final @NotNull SentryExceptionFactory sentryExceptionFactory;
@@ -163,8 +157,7 @@ private void setRelease(final @NotNull SentryBaseEvent event) {
 
   private void setEnvironment(final @NotNull SentryBaseEvent event) {
     if (event.getEnvironment() == null) {
-      event.setEnvironment(
-          options.getEnvironment() != null ? options.getEnvironment() : DEFAULT_ENVIRONMENT);
+      event.setEnvironment(options.getEnvironment());
     }
   }
 
diff --git a/sentry/src/main/java/io/sentry/SentryOptions.java b/sentry/src/main/java/io/sentry/SentryOptions.java
@@ -44,6 +44,12 @@ public class SentryOptions {
   /** Default Log level if not specified Default is DEBUG */
   static final SentryLevel DEFAULT_DIAGNOSTIC_LEVEL = SentryLevel.DEBUG;
 
+  /**
+   * Default value for {@link SentryEvent#getEnvironment()} set when {@link SentryOptions} do not
+   * have the environment field set.
+   */
+  private static final String DEFAULT_ENVIRONMENT = "production";
+
   /**
    * Are callbacks that run for every event. They can either return a new event which in most cases
    * means just adding data OR return null in case the event will be dropped and not sent.
@@ -771,10 +777,10 @@ public void setRelease(@Nullable String release) {
   /**
    * Returns the environment
    *
-   * @return the environment or null if not set
+   * @return the environment or 'production' if not set
    */
   public @Nullable String getEnvironment() {
-    return environment;
+    return environment != null ? environment : DEFAULT_ENVIRONMENT;
   }
 
   /**
diff --git a/sentry/src/test/java/io/sentry/SentryOptionsTest.kt b/sentry/src/test/java/io/sentry/SentryOptionsTest.kt
@@ -320,6 +320,20 @@ class SentryOptionsTest {
         assertTrue(options.scopeObservers.contains(observer))
     }
 
+    @Test
+    fun `when environment is not set, falls back to default value`() {
+        val options = SentryOptions()
+        assertEquals("production", options.environment)
+    }
+
+    @Test
+    fun `when environment is set, correct value is returned`() {
+        val options = SentryOptions().apply {
+            environment = "debug"
+        }
+        assertEquals("debug", options.environment)
+    }
+
     @Test
     fun `copies options from another SentryOptions instance`() {
         val externalOptions = ExternalOptions()

Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,7 @@ class ManifestMetadataReaderTest {`
`164`	`164`	`ManifestMetadataReader.applyMetadata(context, fixture.options, fixture.buildInfoProvider)`
`165`	`165`
`166`	`166`	`// Assert`
`167`		`- assertNull(fixture.options.environment)`
	`167`	`+ assertEquals("production", fixture.options.environment)`
`168`	`168`	`}`
`169`	`169`
`170`	`170`	`@Test`