Add blocked_main_thread to sync file spans

CHANGELOG.md

@@ -14,6 +14,7 @@
     - Method `hint.addAll(Map<String, dynamic> keysAndValues)` now takes `Map<String, dynamic>` instead of `Map<String, Object>`
     - Method `set(String key, dynamic value)` now takes value of `dynamic` instead of `Object`
     - Method `hint.get(String key)` now returns `dynamic` instead of `Object?`
+- Add `blocked_main_thread` to sync file spans ([#1801](https://github.com/getsentry/sentry-dart/pull/1801))
 
 ## 7.15.0
 
@@ -27,7 +28,7 @@
 - Starting with Flutter 3.16, Sentry adds the [`appFlavor`](https://api.flutter.dev/flutter/services/appFlavor-constant.html) to the `flutter_context` ([#1799](https://github.com/getsentry/sentry-dart/pull/1799))
 - Add beforeScreenshotCallback to SentryFlutterOptions ([#1805](https://github.com/getsentry/sentry-dart/pull/1805))
 - Add support for `readTransaction` in `sqflite` ([#1819](https://github.com/getsentry/sentry-dart/pull/1819))
-  
+
 ### Dependencies
 
 - Bump Android SDK from v7.0.0 to v7.2.0 ([#1788](https://github.com/getsentry/sentry-dart/pull/1788), [#1815](https://github.com/getsentry/sentry-dart/pull/1815))

dart/lib/src/sentry_options.dart

@@ -1,5 +1,6 @@
 import 'dart:async';
 import 'dart:developer';
+import 'dart:isolate';
 
 import 'package:meta/meta.dart';
 import 'package:http/http.dart';
@@ -446,6 +447,11 @@ class SentryOptions {
   late SentryStackTraceFactory stackTraceFactory =
       SentryStackTraceFactory(this);
 
+  @internal
+  IsMainIsolateCallback isMainIsolate = () {
+    return Isolate.current.debugName == 'main';
+  };
+
   void _debugLogger(
     SentryLevel level,
     String message, {
@@ -527,3 +533,6 @@ void dartLogger(
     stackTrace: stackTrace,
   );
 }
+
+/// A callback used to check if we are on the main isolate.
+typedef IsMainIsolateCallback = bool Function();

file/lib/src/sentry_file.dart

@@ -490,6 +490,9 @@ class SentryFile implements File {
     span?.origin = SentryTraceOrigins.autoFile;
     span?.setData('file.async', false);
 
+    final isMainIsolate = _hub.options.isMainIsolate();
+    span?.setData('blocked_main_thread', isMainIsolate);
+
     final Map<String, dynamic> breadcrumbData = {};
     breadcrumbData['file.async'] = false;
 

file/test/sentry_file_test.dart

@@ -657,6 +657,286 @@ void main() {
       );
     });
   });
+
+  group('$SentryFile span sets `blocked_main_thread`', () {
+    late Fixture fixture;
+
+    setUp(() {
+      fixture = Fixture();
+    });
+
+    tearDown(() {});
+
+    void _assertSpan(bool isMainIsolate) {
+      final call = fixture.client.captureTransactionCalls.first;
+      final span = call.transaction.spans.first;
+      expect(span.data['blocked_main_thread'], isMainIsolate);
+    }
+
+    test('to `true` when calling `copySync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.copySync('test_resources/testfile_copy.txt');
+      await tr.finish();
+
+      _assertSpan(true);
+    });
+
+    test('to `false` when not calling `copySync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      final newFile = sut.copySync('test_resources/testfile_copy.txt');
+      await tr.finish();
+
+      _assertSpan(false);
+
+      newFile.deleteSync();
+    });
+
+    test('to `true` when calling `createSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.createSync();
+      await tr.finish();
+
+      _assertSpan(true);
+    });
+
+    test('to `false` when not calling `createSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.createSync();
+      await tr.finish();
+
+      _assertSpan(false);
+    });
+
+    // deleteSync
+
+    test('to `true` when calling `deleteSync` on main', () async {
+      final file = File('test_resources/testfile_delete.txt');
+      file.createSync();
+      expect(file.existsSync(), true);
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.deleteSync();
+      await tr.finish();
+
+      _assertSpan(true);
+    });
+
+    test('to `false` when not calling `deleteSync` on main', () async {
+      final file = File('test_resources/testfile_delete.txt');
+      file.createSync();
+      expect(file.existsSync(), true);
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.deleteSync();
+      await tr.finish();
+
+      _assertSpan(false);
+    });
+
+    // readAsBytesSync
+
+    test('to `true` when calling `readAsBytesSync` on main', () async {
+      final file = File('test_resources/sentry.png');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.readAsBytesSync();
+      await tr.finish();
+
+      _assertSpan(true);
+    });
+
+    test('to `false` when not calling `readAsBytesSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.readAsBytesSync();
+      await tr.finish();
+
+      _assertSpan(false);
+    });
+
+    // readAsLinesSync
+
+    test('to `true` when calling `readAsLinesSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+
+      sut.readAsLinesSync();
+
+      await tr.finish();
+
+      _assertSpan(true);
+    });
+
+    test('to `false` when not calling `readAsLinesSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.readAsLinesSync();
+      await tr.finish();
+
+      _assertSpan(false);
+    });
+
+    // readAsStringSync
+
+    test('to `true` when calling `readAsStringSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+
+      sut.readAsStringSync();
+
+      await tr.finish();
+
+      _assertSpan(true);
+    });
+
+    test('to `false` when not calling `readAsStringSync` on main', () async {
+      final file = File('test_resources/testfile.txt');
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      sut.readAsStringSync();
+      await tr.finish();
+
+      _assertSpan(false);
+    });
+
+    // renameSync
+
+    test('to `true` when calling `renameSync` on main', () async {
+      final file = File('test_resources/old_name.txt');
+      file.createSync();
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: true,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      final newFile = sut.renameSync('test_resources/testfile_copy.txt');
+      await tr.finish();
+
+      _assertSpan(true);
+
+      newFile.deleteSync();
+    });
+
+    test('to `false` when not calling `renameSync` on main', () async {
+      final file = File('test_resources/old_name.txt');
+      file.createSync();
+
+      final sut = fixture.getSut(
+        file,
+        sendDefaultPii: true,
+        tracesSampleRate: 1.0,
+        isMainIsolate: false,
+      );
+
+      final tr = fixture.hub.startTransaction('name', 'op', bindToScope: true);
+      final newFile = sut.renameSync('test_resources/testfile_copy.txt');
+      await tr.finish();
+
+      _assertSpan(false);
+
+      newFile.deleteSync();
+    });
+  });
 }
 
 class Fixture {
@@ -667,10 +947,14 @@ class Fixture {
   SentryFile getSut(
     File file, {
     bool sendDefaultPii = false,
+    bool isMainIsolate = false,
     double? tracesSampleRate,
   }) {
     options.sendDefaultPii = sendDefaultPii;
     options.tracesSampleRate = tracesSampleRate;
+    options.isMainIsolate = () {
+      return isMainIsolate;
+    };
 
     hub = Hub(options);
     hub.bindClient(client);