update tests

getsentry · Sep 7, 2023 · a58034f · a58034f
1 parent 4e0241f
commit a58034f
Show file tree

Hide file tree

Showing 7 changed files with 111 additions and 8 deletions.
diff --git a/dart/lib/src/hub.dart b/dart/lib/src/hub.dart
@@ -562,6 +562,9 @@ class Hub {
   ) =>
       _throwableToSpan.add(throwable, span, transaction);
 
+  @internal
+  ProfilerFactory? get profilerFactory => _profilerFactory;
+
   @internal
   set profilerFactory(ProfilerFactory? value) => _profilerFactory = value;
 

diff --git a/dart/lib/src/hub_adapter.dart b/dart/lib/src/hub_adapter.dart
@@ -97,8 +97,10 @@ class HubAdapter implements Hub {
   SentryId get lastEventId => Sentry.lastEventId;
 
   @override
-  Future<SentryId> captureTransaction(SentryTransaction transaction,
-          {SentryTraceContextHeader? traceContext}) =>
+  Future<SentryId> captureTransaction(
+    SentryTransaction transaction, {
+    SentryTraceContextHeader? traceContext,
+  }) =>
       Sentry.currentHub.captureTransaction(
         transaction,
         traceContext: traceContext,
@@ -172,6 +174,10 @@ class HubAdapter implements Hub {
   set profilerFactory(ProfilerFactory? value) =>
       Sentry.currentHub.profilerFactory = value;
 
+  @internal
+  @override
+  ProfilerFactory? get profilerFactory => Sentry.currentHub.profilerFactory;
+
   @override
   Scope get scope => Sentry.currentHub.scope;
 }
diff --git a/dart/lib/src/noop_hub.dart b/dart/lib/src/noop_hub.dart
@@ -125,6 +125,10 @@ class NoOpHub implements Hub {
   @override
   set profilerFactory(ProfilerFactory? value) {}
 
+  @internal
+  @override
+  ProfilerFactory? get profilerFactory => null;
+
   @override
   Scope get scope => Scope(_options);
 }
diff --git a/flutter/lib/src/profiling.dart b/flutter/lib/src/profiling.dart
@@ -30,7 +30,8 @@ class NativeProfilerFactory implements ProfilerFactory {
       return;
     }
 
-    if (Platform.isMacOS || Platform.isIOS) {
+    if (options.platformChecker.platform.isMacOS ||
+        options.platformChecker.platform.isIOS) {
       // ignore: invalid_use_of_internal_member
       hub.profilerFactory = NativeProfilerFactory(SentryNative());
     }
@@ -53,6 +54,8 @@ class NativeProfilerFactory implements ProfilerFactory {
   }
 }
 
+// TODO this may move to the native code in the future - instead of unit-testing,
+//      do an integration test once https://github.com/getsentry/sentry-dart/issues/1605 is done.
 // ignore: invalid_use_of_internal_member
 class NativeProfiler implements Profiler {
   final SentryNative _native;

diff --git a/flutter/test/mocks.mocks.dart b/flutter/test/mocks.mocks.dart
@@ -7,14 +7,15 @@ import 'dart:async' as _i6;
 
 import 'package:flutter/src/services/binary_messenger.dart' as _i5;
 import 'package:flutter/src/services/message_codec.dart' as _i4;
-import 'package:flutter/src/services/platform_channel.dart' as _i9;
+import 'package:flutter/src/services/platform_channel.dart' as _i10;
 import 'package:mockito/mockito.dart' as _i1;
 import 'package:sentry/sentry.dart' as _i2;
+import 'package:sentry/src/profiling.dart' as _i9;
 import 'package:sentry/src/protocol.dart' as _i3;
 import 'package:sentry/src/sentry_envelope.dart' as _i7;
 import 'package:sentry/src/sentry_tracer.dart' as _i8;
 
-import 'mocks.dart' as _i10;
+import 'mocks.dart' as _i11;
 
 // ignore_for_file: type=lint
 // ignore_for_file: avoid_redundant_argument_values
@@ -142,7 +143,6 @@ class MockTransport extends _i1.Mock implements _i2.Transport {
 /// A class which mocks [SentryTracer].
 ///
 /// See the documentation for Mockito's code generation for more information.
-// ignore: invalid_use_of_internal_member
 class MockSentryTracer extends _i1.Mock implements _i8.SentryTracer {
   MockSentryTracer() {
     _i1.throwOnMissingStub(this);
@@ -178,6 +178,22 @@ class MockSentryTracer extends _i1.Mock implements _i8.SentryTracer {
         returnValueForMissingStub: null,
       );
   @override
+  set profiler(_i9.Profiler? _profiler) => super.noSuchMethod(
+        Invocation.setter(
+          #profiler,
+          _profiler,
+        ),
+        returnValueForMissingStub: null,
+      );
+  @override
+  set profileInfo(_i9.ProfileInfo? _profileInfo) => super.noSuchMethod(
+        Invocation.setter(
+          #profileInfo,
+          _profileInfo,
+        ),
+        returnValueForMissingStub: null,
+      );
+  @override
   _i2.SentrySpanContext get context => (super.noSuchMethod(
         Invocation.getter(#context),
         returnValue: _FakeSentrySpanContext_0(
@@ -410,7 +426,7 @@ class MockSentryTracer extends _i1.Mock implements _i8.SentryTracer {
 /// A class which mocks [MethodChannel].
 ///
 /// See the documentation for Mockito's code generation for more information.
-class MockMethodChannel extends _i1.Mock implements _i9.MethodChannel {
+class MockMethodChannel extends _i1.Mock implements _i10.MethodChannel {
   MockMethodChannel() {
     _i1.throwOnMissingStub(this);
   }
@@ -523,6 +539,14 @@ class MockHub extends _i1.Mock implements _i2.Hub {
         ),
       ) as _i3.SentryId);
   @override
+  set profilerFactory(_i9.ProfilerFactory? value) => super.noSuchMethod(
+        Invocation.setter(
+          #profilerFactory,
+          value,
+        ),
+        returnValueForMissingStub: null,
+      );
+  @override
   _i6.Future<_i3.SentryId> captureEvent(
     _i3.SentryEvent? event, {
     dynamic stackTrace,
@@ -710,7 +734,7 @@ class MockHub extends _i1.Mock implements _i2.Hub {
             #customSamplingContext: customSamplingContext,
           },
         ),
-        returnValue: _i10.startTransactionShim(
+        returnValue: _i11.startTransactionShim(
           name,
           operation,
           description: description,

diff --git a/flutter/test/profiling_test.dart b/flutter/test/profiling_test.dart
@@ -0,0 +1,46 @@
+@TestOn('vm')
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mockito/mockito.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+import 'package:sentry_flutter/src/profiling.dart';
+import 'package:sentry_flutter/src/sentry_native.dart';
+import 'package:sentry_flutter/src/sentry_native_channel.dart';
+import 'mocks.dart';
+import 'mocks.mocks.dart';
+import 'sentry_flutter_test.dart';
+
+void main() {
+  group('$NativeProfilerFactory', () {
+    Hub hubWithSampleRate(double profilesSampleRate) {
+      final o = SentryFlutterOptions(dsn: fakeDsn);
+      o.platformChecker = getPlatformChecker(platform: MockPlatform.iOs());
+      o.profilesSampleRate = profilesSampleRate;
+
+      final hub = MockHub();
+      when(hub.options).thenAnswer((_) => o);
+      return hub;
+    }
+
+    test('attachTo() respects sampling rate', () async {
+      var hub = hubWithSampleRate(0.0);
+      NativeProfilerFactory.attachTo(hub);
+      verifyNever(hub.profilerFactory = any);
+
+      hub = hubWithSampleRate(0.1);
+      NativeProfilerFactory.attachTo(hub);
+      verify(hub.profilerFactory = any);
+    });
+
+    test('creates a profiler', () async {
+      final nativeMock = TestMockSentryNative();
+      final sut = NativeProfilerFactory(nativeMock);
+      final profiler = sut.startProfiling(SentryTransactionContext(
+        'name',
+        'op',
+      ));
+      expect(nativeMock.numberOfStartProfilingCalls, 1);
+      expect(profiler, isNotNull);
+    });
+  });
+}
diff --git a/flutter/test/sentry_flutter_test.dart b/flutter/test/sentry_flutter_test.dart
@@ -5,6 +5,7 @@ import 'package:package_info_plus/package_info_plus.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
 import 'package:sentry_flutter/src/integrations/integrations.dart';
 import 'package:sentry_flutter/src/integrations/screenshot_integration.dart';
+import 'package:sentry_flutter/src/profiling.dart';
 import 'package:sentry_flutter/src/renderer/renderer.dart';
 import 'package:sentry_flutter/src/sentry_native.dart';
 import 'package:sentry_flutter/src/version.dart';
@@ -65,6 +66,7 @@ void main() {
         (options) async {
           options.dsn = fakeDsn;
           options.devMode = true;
+          options.profilesSampleRate = 1.0;
           integrations = options.integrations;
           transport = options.transport;
           sentryFlutterOptions = options;
@@ -100,6 +102,7 @@ void main() {
           afterIntegration: OnErrorIntegration);
 
       expect(SentryNative().nativeChannel, isNotNull);
+      expect(Sentry.currentHub.profilerFactory, isNull);
 
       await Sentry.close();
     }, testOn: 'vm');
@@ -113,6 +116,7 @@ void main() {
         (options) async {
           options.dsn = fakeDsn;
           options.devMode = true;
+          options.profilesSampleRate = 1.0;
           integrations = options.integrations;
           transport = options.transport;
           sentryFlutterOptions = options;
@@ -146,6 +150,8 @@ void main() {
           afterIntegration: OnErrorIntegration);
 
       expect(SentryNative().nativeChannel, isNotNull);
+      expect(Sentry.currentHub.profilerFactory,
+          isInstanceOf<NativeProfilerFactory>());
 
       await Sentry.close();
     }, testOn: 'vm');
@@ -159,6 +165,7 @@ void main() {
         (options) async {
           options.dsn = fakeDsn;
           options.devMode = true;
+          options.profilesSampleRate = 1.0;
           integrations = options.integrations;
           transport = options.transport;
           sentryFlutterOptions = options;
@@ -192,6 +199,8 @@ void main() {
           afterIntegration: OnErrorIntegration);
 
       expect(SentryNative().nativeChannel, isNotNull);
+      expect(Sentry.currentHub.profilerFactory,
+          isInstanceOf<NativeProfilerFactory>());
 
       await Sentry.close();
     }, testOn: 'vm');
@@ -205,6 +214,7 @@ void main() {
         (options) async {
           options.dsn = fakeDsn;
           options.devMode = true;
+          options.profilesSampleRate = 1.0;
           integrations = options.integrations;
           transport = options.transport;
           sentryFlutterOptions = options;
@@ -241,6 +251,7 @@ void main() {
           afterIntegration: OnErrorIntegration);
 
       expect(SentryNative().nativeChannel, isNull);
+      expect(Sentry.currentHub.profilerFactory, isNull);
 
       await Sentry.close();
     }, testOn: 'vm');
@@ -254,6 +265,7 @@ void main() {
         (options) async {
           options.dsn = fakeDsn;
           options.devMode = true;
+          options.profilesSampleRate = 1.0;
           integrations = options.integrations;
           transport = options.transport;
           sentryFlutterOptions = options;
@@ -290,6 +302,7 @@ void main() {
           afterIntegration: OnErrorIntegration);
 
       expect(SentryNative().nativeChannel, isNull);
+      expect(Sentry.currentHub.profilerFactory, isNull);
 
       await Sentry.close();
     }, testOn: 'vm');
@@ -303,6 +316,7 @@ void main() {
         (options) async {
           options.dsn = fakeDsn;
           options.devMode = true;
+          options.profilesSampleRate = 1.0;
           integrations = options.integrations;
           transport = options.transport;
           sentryFlutterOptions = options;
@@ -340,6 +354,7 @@ void main() {
           afterIntegration: WidgetsFlutterBindingIntegration);
 
       expect(SentryNative().nativeChannel, isNull);
+      expect(Sentry.currentHub.profilerFactory, isNull);
 
       await Sentry.close();
     });
@@ -429,6 +444,8 @@ void main() {
           beforeIntegration: RunZonedGuardedIntegration,
           afterIntegration: WidgetsFlutterBindingIntegration);
 
+      expect(Sentry.currentHub.profilerFactory, isNull);
+
       await Sentry.close();
     });