Disable scope sync for cloned scopes (#1628)

getsentry · Sep 11, 2023 · c9d3212 · c9d3212
1 parent 6852b33
commit c9d3212
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@
 
 - Normalize data properties of `SentryUser` and `Breadcrumb` before sending over method channel ([#1591](https://github.com/getsentry/sentry-dart/pull/1591))
 - Fixing memory leak issue in SentryFlutterPlugin (Android Plugin) ([#1588](https://github.com/getsentry/sentry-dart/pull/1588))
+- Disable scope sync for cloned scopes ([#1628](https://github.com/getsentry/sentry-dart/pull/1628))
 
 ### Dependencies
 

diff --git a/dart/lib/src/scope.dart b/dart/lib/src/scope.dart
@@ -142,6 +142,7 @@ class Scope {
       List.unmodifiable(_eventProcessors);
 
   final SentryOptions _options;
+  bool _enableScopeSync = true;
 
   final List<SentryAttachment> _attachments = [];
 
@@ -423,7 +424,8 @@ class Scope {
       ..level = level
       ..fingerprint = List.from(fingerprint)
       .._transaction = _transaction
-      ..span = span;
+      ..span = span
+      .._enableScopeSync = false;
 
     clone._setUserSync(user);
 
@@ -461,7 +463,7 @@ class Scope {
   }
 
   Future<void> _callScopeObservers(_OnScopeObserver action) async {
-    if (_options.enableScopeSync) {
+    if (_options.enableScopeSync && _enableScopeSync) {
       for (final scopeObserver in _options.scopeObservers) {
         await action(scopeObserver);
       }

diff --git a/dart/test/scope_test.dart b/dart/test/scope_test.dart
@@ -375,6 +375,14 @@ void main() {
     expect(1, fixture.mockScopeObserver.numberOfRemoveTagCalls);
   });
 
+  test('clone has disabled scope sync', () async {
+    final sut = fixture.getSut(scopeObserver: fixture.mockScopeObserver);
+    final clone = sut.clone();
+
+    await clone.setContexts("fixture-contexts-key", "fixture-contexts-value");
+    expect(0, fixture.mockScopeObserver.numberOfSetContextsCalls);
+  });
+
   group('Scope apply', () {
     final scopeUser = SentryUser(
       id: '800',

diff --git a/dio/test/dio_event_processor_test.dart b/dio/test/dio_event_processor_test.dart
@@ -67,7 +67,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -96,7 +96,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -125,7 +125,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -177,7 +177,7 @@ void main() {
           throwable: throwable,
           exceptions: [
             fixture.sentryError(throwable),
-            fixture.sentryError(dioError)
+            fixture.sentryError(dioError),
           ],
         );
         final processedEvent = sut.apply(event) as SentryEvent;
@@ -207,7 +207,7 @@ void main() {
           data: 'foobar',
           headers: Headers.fromMap(<String, List<String>>{
             'foo': ['bar'],
-            'set-cookie': ['foo=bar']
+            'set-cookie': ['foo=bar'],
           }),
           requestOptions: request,
           isRedirect: true,
@@ -219,7 +219,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -248,7 +248,7 @@ void main() {
         response: Response<dynamic>(
           data: 'foobar',
           headers: Headers.fromMap(<String, List<String>>{
-            'foo': ['bar']
+            'foo': ['bar'],
           }),
           requestOptions: request,
           isRedirect: true,
@@ -260,7 +260,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -320,7 +320,7 @@ void main() {
           throwable: throwable,
           exceptions: [
             fixture.sentryError(throwable),
-            fixture.sentryError(dioError)
+            fixture.sentryError(dioError),
           ],
         );
         final processedEvent = sut.apply(event) as SentryEvent;
@@ -338,7 +338,7 @@ void main() {
       final dataByType = {
         ResponseType.plain: ['plain'],
         ResponseType.bytes: [
-          [1337]
+          [1337],
         ],
         ResponseType.json: [
           9001,
@@ -347,7 +347,7 @@ void main() {
           true,
           ['list'],
           {'map-key': 'map-value'},
-        ]
+        ],
       };
 
       for (final entry in dataByType.entries) {
@@ -375,7 +375,7 @@ void main() {
             throwable: throwable,
             exceptions: [
               fixture.sentryError(throwable),
-              fixture.sentryError(dioError)
+              fixture.sentryError(dioError),
             ],
           );
           final processedEvent = sut.apply(event) as SentryEvent;

diff --git a/dio/test/failed_request_interceptor_test.dart b/dio/test/failed_request_interceptor_test.dart
@@ -113,7 +113,7 @@ class Fixture {
 
   FailedRequestInterceptor getSut({
     List<SentryStatusCode> failedRequestStatusCodes = const [
-      SentryStatusCode.defaultRange()
+      SentryStatusCode.defaultRange(),
     ],
     List<String> failedRequestTargets = const ['.*'],
   }) {

diff --git a/dio/test/mocks.dart b/dio/test/mocks.dart
@@ -42,7 +42,7 @@ final fakeEvent = SentryEvent(
       type: 'navigation',
       data: <String, dynamic>{'screen': 'MainActivity', 'state': 'created'},
       level: SentryLevel.info,
-    )
+    ),
   ],
   contexts: Contexts(
     operatingSystem: const SentryOperatingSystem(