feat: add Get/Set Environment on Scope (#5772)

* added get/set environment to scope

* updated changelog

* updated changelog

* sync scope clear

* clear

* apply to replay

* scope helper

* comment

* made scope apply its environment on other events too

* Update CHANGELOG.md

Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>

* feat: apply the scope environment to Baggage/DSC and address review feedback

* fix: read the DSC environment from the combined scope view instead of the isolation scope

* feat: apply the scope environment to logs, metrics and profiles

* test: stub the ScopeType overload of configureScope in scopes mocks

* feat(android): sync the scope environment to the NDK scope

* ci: fix Build Job ubuntu-latest [pr-shepherd]

* test(apollo-5): stub the ScopeType overload of configureScope in scopes mock

* chore: move changelog entry to Unreleased

* fix(ndk): catch only RejectedExecutionException when syncing the scope environment

---------

Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
Co-authored-by: Markus Hintersteiner <markus.hintersteiner@sentry.io>
Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>

Author: 4 people

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Features
+
+- Added `Environment` to the `Scope`, allowing you to overwrite the `Environment` set on the options ([#5772](https://github.com/getsentry/sentry-java/pull/5772))
+  - The scope `Environment` is also applied to the trace envelope header (DSC), logs, metrics and profiles, so all telemetry of a trace reports the same environment
+
 ### Fixes
 
 - Keep UI profiling running when `startProfiler` is called before a requested stop takes effect at the end of the current chunk ([#6291](https://github.com/getsentry/sentry-java/pull/6291))

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

@@ -198,6 +198,7 @@ private void backfillScope(
     setRequest(event);
     setUser(event);
     setScopeTags(event);
+    setScopeEnvironment(event);
     setBreadcrumbs(event);
     setExtras(event);
     setContexts(event);
@@ -492,6 +493,16 @@ private void setEnvironment(
     }
   }
 
+  private void setScopeEnvironment(final @NotNull SentryBaseEvent event) {
+    if (event.getEnvironment() == null) {
+      final @Nullable String scopeEnvironment =
+          readFromDisk(options, PersistingScopeObserver.ENVIRONMENT_FILENAME, String.class);
+      if (scopeEnvironment != null) {
+        event.setEnvironment(scopeEnvironment);
+      }
+    }
+  }
+
   private void setDebugMeta(
       final @NotNull SentryBaseEvent event, final @NotNull OptionsSource optionsSource) {
     DebugMeta debugMeta = event.getDebugMeta();

sentry-android-core/src/test/java/io/sentry/android/core/ApplicationExitInfoEventProcessorTest.kt

@@ -461,6 +461,18 @@ class ApplicationExitInfoEventProcessorTest {
     assertEquals("release", processed.environment)
   }
 
+  @Test
+  fun `if scope environment is persisted, it takes precedence over the options environment`() {
+    val hint = HintUtils.createWithTypeCheckHint(BackfillableHint())
+
+    val processor = fixture.getSut(tmpDir, populateOptionsCache = true)
+    fixture.persistScope(PersistingScopeObserver.ENVIRONMENT_FILENAME, "staging")
+
+    val processed = processor.process(SentryEvent(), hint)
+
+    assertEquals("staging", processed!!.environment)
+  }
+
   @Test
   fun `if release is not persisted and app was not updated, uses release from options`() {
     val hint = HintUtils.createWithTypeCheckHint(AbnormalExitHint(timestamp = 2_000))
@@ -542,6 +554,7 @@ class ApplicationExitInfoEventProcessorTest {
     fixture.options.release = "io.sentry.samples@1.2.0+232"
     fixture.options.environment = "production"
     fixture.options.dist = "custom-dist"
+    fixture.persistScope(PersistingScopeObserver.ENVIRONMENT_FILENAME, "staging")
     setLastUpdateTime(1_000)
 
     val processed = processor.process(SentryEvent(), hint)!!

sentry-android-core/src/test/java/io/sentry/android/core/internal/gestures/SentryGestureListenerClickTest.kt

@@ -15,6 +15,7 @@ import io.sentry.IScopes
 import io.sentry.PropagationContext
 import io.sentry.Scope.IWithPropagationContext
 import io.sentry.ScopeCallback
+import io.sentry.ScopeType
 import io.sentry.SentryLevel.INFO
 import io.sentry.android.core.SentryAndroidOptions
 import io.sentry.util.LazyEvaluator
@@ -85,6 +86,9 @@ class SentryGestureListenerClickTest {
       doAnswer { (it.arguments[0] as ScopeCallback).run(scope) }
         .whenever(scopes)
         .configureScope(any())
+      doAnswer { (it.arguments[1] as ScopeCallback).run(scope) }
+        .whenever(scopes)
+        .configureScope(anyOrNull<ScopeType>(), any())
       doAnswer {
           (it.arguments[0] as IWithPropagationContext).accept(propagationContext)
           propagationContext

sentry-android-core/src/test/java/io/sentry/android/core/internal/gestures/SentryGestureListenerScrollTest.kt

@@ -17,6 +17,7 @@ import io.sentry.IScopes
 import io.sentry.PropagationContext
 import io.sentry.Scope
 import io.sentry.ScopeCallback
+import io.sentry.ScopeType
 import io.sentry.SentryLevel
 import io.sentry.SentryLevel.INFO
 import io.sentry.android.core.SentryAndroidOptions
@@ -82,6 +83,9 @@ class SentryGestureListenerScrollTest {
       doAnswer { (it.arguments[0] as ScopeCallback).run(scope) }
         .whenever(scopes)
         .configureScope(any())
+      doAnswer { (it.arguments[1] as ScopeCallback).run(scope) }
+        .whenever(scopes)
+        .configureScope(anyOrNull<ScopeType>(), any())
       doAnswer {
           (it.arguments[0] as Scope.IWithPropagationContext).accept(propagationContext)
           propagationContext

sentry-android-core/src/test/java/io/sentry/android/core/internal/gestures/SentryGestureListenerTracingTest.kt

@@ -13,6 +13,7 @@ import io.sentry.IScope
 import io.sentry.IScopes
 import io.sentry.Scope
 import io.sentry.ScopeCallback
+import io.sentry.ScopeType
 import io.sentry.SentryTracer
 import io.sentry.SpanContext
 import io.sentry.SpanId
@@ -31,6 +32,7 @@ import kotlin.test.assertNotNull
 import kotlin.test.assertNull
 import org.mockito.ArgumentCaptor
 import org.mockito.kotlin.any
+import org.mockito.kotlin.anyOrNull
 import org.mockito.kotlin.check
 import org.mockito.kotlin.clearInvocations
 import org.mockito.kotlin.doAnswer
@@ -94,6 +96,9 @@ class SentryGestureListenerTracingTest {
       doAnswer { (it.arguments[0] as ScopeCallback).run(scope) }
         .whenever(scopes)
         .configureScope(any())
+      doAnswer { (it.arguments[1] as ScopeCallback).run(scope) }
+        .whenever(scopes)
+        .configureScope(anyOrNull<ScopeType>(), any())
 
       return SentryGestureListener(activity, scopes, options)
     }

sentry-android-ndk/api/sentry-android-ndk.api

@@ -20,6 +20,7 @@ public final class io/sentry/android/ndk/NdkScopeObserver : io/sentry/ScopeObser
 	public fun clearAttachments ()V
 	public fun removeExtra (Ljava/lang/String;)V
 	public fun removeTag (Ljava/lang/String;)V
+	public fun setEnvironment (Ljava/lang/String;)V
 	public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
 	public fun setTag (Ljava/lang/String;Ljava/lang/String;)V
 	public fun setTrace (Lio/sentry/SpanContext;Lio/sentry/IScope;)V

sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java

@@ -14,6 +14,7 @@
 import io.sentry.util.Objects;
 import java.util.Locale;
 import java.util.Map;
+import java.util.concurrent.RejectedExecutionException;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -53,6 +54,15 @@ public void setUser(final @Nullable User user) {
     }
   }
 
+  @Override
+  public void setEnvironment(@Nullable String environment) {
+    try {
+      options.getExecutorService().submit(() -> nativeScope.setEnvironment(environment));
+    } catch (RejectedExecutionException e) {
+      options.getLogger().log(SentryLevel.ERROR, e, "Scope sync setEnvironment has an error.");
+    }
+  }
+
   @Override
   public void addBreadcrumb(final @NotNull Breadcrumb crumb) {
     try {

sentry-android-ndk/src/test/java/io/sentry/android/ndk/NdkScopeObserverTest.kt

@@ -184,4 +184,15 @@ class NdkScopeObserverTest {
 
     verify(fixture.nativeScope).clearAttachments()
   }
+
+  @Test
+  fun `set environments forwards call to native scope`() {
+    val sut = fixture.getSut()
+
+    sut.setEnvironment(null)
+    verify(fixture.nativeScope).setEnvironment(eq(null))
+
+    sut.setEnvironment("production")
+    verify(fixture.nativeScope).setEnvironment(eq("production"))
+  }
 }

sentry-android-replay/src/test/java/io/sentry/android/replay/ReplaySmokeTest.kt

@@ -16,6 +16,7 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.sentry.IScopes
 import io.sentry.Scope
 import io.sentry.ScopeCallback
+import io.sentry.ScopeType
 import io.sentry.SentryOptions
 import io.sentry.SentryReplayEvent.ReplayType
 import io.sentry.android.replay.util.ReplayShadowMediaCodec
@@ -72,6 +73,9 @@ class ReplaySmokeTest {
         doAnswer { (it.arguments[0] as ScopeCallback).run(scope) }
           .whenever(it)
           .configureScope(any())
+        doAnswer { (it.arguments[1] as ScopeCallback).run(scope) }
+          .whenever(it)
+          .configureScope(anyOrNull<ScopeType>(), any())
 
         on { rateLimiter }.doReturn(rateLimiter)
       }