feat: profiling for iOS/macOS (#1611)

Co-authored-by: Bruno Garcia <[email protected]>
Co-authored-by: Denis Andrašec <[email protected]>
Co-authored-by: Stefano <[email protected]>

Author: 4 people

.github/workflows/analyze.yml

@@ -60,6 +60,11 @@ jobs:
     timeout-minutes: 20
     steps:
       - uses: actions/checkout@v3
+      - name: Apply dependency override
+        if: ${{ inputs.package == 'flutter' }}
+        working-directory: ${{ inputs.package }}
+        run: |
+          sed -i.bak 's|sentry:.*|sentry:\n    path: /github/workspace/dart|g' pubspec.yaml
       - uses: axel-op/dart-package-analyzer@7a6c3c66bce78d82b729a1ffef2d9458fde6c8d2 # pin@v3
         id: analysis
         with:

.github/workflows/flutter.yml

@@ -116,6 +116,7 @@ jobs:
         with:
           path: "./flutter/coverage/lcov.info"
           min_coverage: 90
+          exclude: "lib/src/native/cocoa/binding.dart"
 
       - name: Build ${{ matrix.target }}
         run: |

.github/workflows/flutter_test.yml

@@ -104,7 +104,7 @@ jobs:
           avd-name: macOS-avd-x86_64-31
           emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
           disable-animations: true
-          script: flutter test integration_test --verbose
+          script: flutter test integration_test/all.dart --verbose
 
   cocoa:
     name: "${{ matrix.target }} | ${{ matrix.sdk }}"
@@ -155,7 +155,7 @@ jobs:
       - name: run integration test
         # Disable flutter integration tests for iOS for now (https://github.com/getsentry/sentry-dart/issues/1605#issuecomment-1695809346)
         if: ${{ matrix.target != 'ios' }}
-        run: flutter test -d "${{ steps.device.outputs.name }}" integration_test --verbose
+        run: flutter test -d "${{ steps.device.outputs.name }}" integration_test/all.dart --verbose
 
       - name: run native test
         # We only have the native unit test package in the iOS xcodeproj at the moment.

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Initial (alpha) support for profiling on iOS and macOS ([#1611](https://github.com/getsentry/sentry-dart/pull/1611))
+
 ## 7.11.0
 
 ### Fixes

dart/analysis_options.yaml

@@ -3,6 +3,7 @@ include: package:lints/recommended.yaml
 analyzer:
   exclude:
     - example/** # the example has its own 'analysis_options.yaml'
+    - test/*.mocks.dart
   errors:
     # treat missing required parameters as a warning (not a hint)
     missing_required_param: error

dart/lib/src/hub.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 import 'dart:collection';
 
 import 'package:meta/meta.dart';
+import 'profiling.dart';
 import 'propagation_context.dart';
 import 'transport/data_category.dart';
 
@@ -435,12 +436,12 @@ class Hub {
     } else {
       final item = _peek();
 
-      final samplingContext = SentrySamplingContext(
-          transactionContext, customSamplingContext ?? {});
-
       // if transactionContext has no sampled decision, run the traces sampler
-      if (transactionContext.samplingDecision == null) {
-        final samplingDecision = _tracesSampler.sample(samplingContext);
+      var samplingDecision = transactionContext.samplingDecision;
+      if (samplingDecision == null) {
+        final samplingContext = SentrySamplingContext(
+            transactionContext, customSamplingContext ?? {});
+        samplingDecision = _tracesSampler.sample(samplingContext);
         transactionContext =
             transactionContext.copyWith(samplingDecision: samplingDecision);
       }
@@ -451,6 +452,12 @@ class Hub {
         );
       }
 
+      SentryProfiler? profiler;
+      if (_profilerFactory != null &&
+          _tracesSampler.sampleProfiling(samplingDecision)) {
+        profiler = _profilerFactory?.startProfiler(transactionContext);
+      }
+
       final tracer = SentryTracer(
         transactionContext,
         this,
@@ -459,6 +466,7 @@ class Hub {
         autoFinishAfter: autoFinishAfter,
         trimEnd: trimEnd ?? false,
         onFinish: onFinish,
+        profiler: profiler,
       );
       if (bindToScope ?? false) {
         item.scope.span = tracer;
@@ -554,6 +562,14 @@ class Hub {
   ) =>
       _throwableToSpan.add(throwable, span, transaction);
 
+  @internal
+  SentryProfilerFactory? get profilerFactory => _profilerFactory;
+
+  @internal
+  set profilerFactory(SentryProfilerFactory? value) => _profilerFactory = value;
+
+  SentryProfilerFactory? _profilerFactory;
+
   SentryEvent _assignTraceContext(SentryEvent event) {
     // assign trace context
     if (event.throwable != null && event.contexts.trace == null) {

dart/lib/src/hub_adapter.dart

@@ -4,6 +4,7 @@ import 'package:meta/meta.dart';
 import 'hint.dart';
 
 import 'hub.dart';
+import 'profiling.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry.dart';
@@ -168,6 +169,16 @@ class HubAdapter implements Hub {
   ) =>
       Sentry.currentHub.setSpanContext(throwable, span, transaction);
 
+  @internal
+  @override
+  set profilerFactory(SentryProfilerFactory? value) =>
+      Sentry.currentHub.profilerFactory = value;
+
+  @internal
+  @override
+  SentryProfilerFactory? get profilerFactory =>
+      Sentry.currentHub.profilerFactory;
+
   @override
   Scope get scope => Sentry.currentHub.scope;
 }

dart/lib/src/noop_hub.dart

@@ -4,6 +4,7 @@ import 'package:meta/meta.dart';
 
 import 'hint.dart';
 import 'hub.dart';
+import 'profiling.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_client.dart';
@@ -120,6 +121,14 @@ class NoOpHub implements Hub {
   @override
   void setSpanContext(throwable, ISentrySpan span, String transaction) {}
 
+  @internal
+  @override
+  set profilerFactory(SentryProfilerFactory? value) {}
+
+  @internal
+  @override
+  SentryProfilerFactory? get profilerFactory => null;
+
   @override
   Scope get scope => Scope(_options);
 }

dart/lib/src/profiling.dart

@@ -0,0 +1,22 @@
+import 'dart:async';
+
+import 'package:meta/meta.dart';
+
+import '../sentry.dart';
+
+@internal
+abstract class SentryProfilerFactory {
+  SentryProfiler? startProfiler(SentryTransactionContext context);
+}
+
+@internal
+abstract class SentryProfiler {
+  Future<SentryProfileInfo?> finishFor(SentryTransaction transaction);
+  void dispose();
+}
+
+// See https://develop.sentry.dev/sdk/profiles/
+@internal
+abstract class SentryProfileInfo {
+  SentryEnvelopeItem asEnvelopeItem();
+}

dart/lib/src/protocol/sentry_event.dart

@@ -59,7 +59,7 @@ class SentryEvent with SentryEventLike<SentryEvent> {
   /// The ID Sentry.io assigned to the submitted event for future reference.
   final SentryId eventId;
 
-  /// A timestamp representing when the breadcrumb occurred.
+  /// A timestamp representing when the event occurred.
   final DateTime? timestamp;
 
   /// A string representing the platform the SDK is submitting from. This will be used by the Sentry interface to customize various components in the interface.