fix tests

marandaneto · marandaneto · commit e886d5ab5e2b · 2022-11-23T15:24:49.000+01:00
diff --git a/flutter/lib/src/user_interaction/sentry_user_interaction_widget.dart b/flutter/lib/src/user_interaction/sentry_user_interaction_widget.dart
@@ -88,13 +88,6 @@ class _SentryUserInteractionWidgetState
     }
     final element = tappedWidget.element;
 
-    // String? currentRouteName;
-    // if (element is StatefulElement) {
-    //   currentRouteName = ModalRoute.of(element.state.context)?.settings.name;
-    // } else if (element is StatelessElement) {
-
-    // }
-
     Map<String, dynamic>? data;
     // ignore: invalid_use_of_internal_member
     if ((_options?.sendDefaultPii ?? false) &&
@@ -109,7 +102,6 @@ class _SentryUserInteractionWidgetState
       final crumb = Breadcrumb.userInteraction(
         subCategory: category,
         viewId: keyValue,
-        // viewClass: tappedWidget.element.widget.runtimeType.toString(),
         viewClass: tappedWidget.type, // to avoid minification
         data: data,
       );
@@ -122,7 +114,8 @@ class _SentryUserInteractionWidgetState
       return;
     }
 
-    // TODO: name should be screenName.widgetName, maybe get from router?
+    // getting the name of the screen using ModalRoute.of(context).settings.name
+    // is expensive, so we expect that the keys are unique across the app
     final transactionContext = SentryTransactionContext(
       keyValue,
       'ui.action.$category',
diff --git a/flutter/test/user_interaction/sentry_user_interaction_widget_test.dart b/flutter/test/user_interaction/sentry_user_interaction_widget_test.dart
@@ -1,6 +1,14 @@
+@TestOn('vm')
+
+// ignore_for_file: invalid_use_of_internal_member
+
+import 'dart:async';
+
+import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
+import 'package:sentry/src/sentry_tracer.dart';
 
 import '../mocks.dart';
 import '../mocks.mocks.dart';
@@ -17,48 +25,179 @@ void main() {
       await tester.runAsync(() async {
         final sut = fixture.getSut();
 
-        await tapMe(tester, sut, 'Button 1');
+        await tapMe(tester, sut, 'btn_1');
 
+        Breadcrumb? crumb;
         fixture.hub.configureScope((scope) {
-          final crumb = scope.breadcrumbs.last;
-          expect(crumb.category, 'ui.click');
-          expect(crumb.data?['view.id'], 'btn_1');
-          expect(crumb.data?['view.class'], 'MaterialButton');
+          crumb = scope.breadcrumbs.last;
         });
+        expect(crumb?.category, 'ui.click');
+        expect(crumb?.data?['view.id'], 'btn_1');
+        expect(crumb?.data?['view.class'], 'MaterialButton');
       });
     });
 
     testWidgets('Add crumb for MaterialButton with label', (tester) async {
       await tester.runAsync(() async {
         final sut = fixture.getSut(sendDefaultPii: true);
 
-        await tapMe(tester, sut, 'Button 1');
+        await tapMe(tester, sut, 'btn_1');
+
+        Breadcrumb? crumb;
+        fixture.hub.configureScope((scope) {
+          crumb = scope.breadcrumbs.last;
+        });
+        expect(crumb?.data?['label'], 'Button 1');
+      });
+    });
+
+    testWidgets('Add crumb for Icon with label', (tester) async {
+      await tester.runAsync(() async {
+        final sut = fixture.getSut(sendDefaultPii: true);
+
+        await tapMe(tester, sut, 'btn_3');
+
+        Breadcrumb? crumb;
+        fixture.hub.configureScope((scope) {
+          crumb = scope.breadcrumbs.last;
+        });
+        expect(crumb?.data?['label'], 'My Icon');
+      });
+    });
+
+    testWidgets('Add crumb for CupertinoButton with label', (tester) async {
+      await tester.runAsync(() async {
+        final sut = fixture.getSut(sendDefaultPii: true);
+
+        await tapMe(tester, sut, 'btn_2');
 
+        Breadcrumb? crumb;
         fixture.hub.configureScope((scope) {
-          final crumb = scope.breadcrumbs.last;
-          expect(crumb.data?['label'], 'Button 1');
+          crumb = scope.breadcrumbs.last;
         });
+        expect(crumb?.data?['label'], 'Button 2');
       });
     });
 
-    testWidgets('Do not add crumb', (tester) async {
+    testWidgets('Do not add crumb if disabled', (tester) async {
       await tester.runAsync(() async {
         final sut = fixture.getSut(enableUserInteractionBreadcrumbs: false);
 
-        await tapMe(tester, sut, 'Button 1');
+        await tapMe(tester, sut, 'btn_1');
 
+        List<Breadcrumb>? crumbs;
         fixture.hub.configureScope((scope) {
-          expect(scope.breadcrumbs.isEmpty, true);
+          crumbs = scope.breadcrumbs;
         });
+        expect(crumbs?.isEmpty, true);
+      });
+    });
+  });
+
+  group('$SentryUserInteractionWidget performance', () {
+    late Fixture fixture;
+    setUp(() async {
+      fixture = Fixture();
+      TestWidgetsFlutterBinding.ensureInitialized();
+    });
+
+    testWidgets('Start transaction and set in the scope', (tester) async {
+      await tester.runAsync(() async {
+        final sut = fixture.getSut(
+            enableUserInteractionTracing: true,
+            enableUserInteractionBreadcrumbs: false);
+
+        await tapMe(tester, sut, 'btn_1');
+
+        SentryTracer? tracer;
+        fixture.hub.configureScope((scope) {
+          tracer = (scope.span as SentryTracer);
+        });
+        expect(tracer?.name, 'btn_1');
+        expect(tracer?.context.operation, 'ui.action.click');
+        expect(tracer?.transactionNameSource,
+            SentryTransactionNameSource.component);
+        expect(tracer?.autoFinishAfterTimer, isNotNull);
+      });
+    });
+
+    testWidgets('Start transaction and do not set in the scope if any',
+        (tester) async {
+      await tester.runAsync(() async {
+        final sut = fixture.getSut(
+            enableUserInteractionTracing: true,
+            enableUserInteractionBreadcrumbs: false);
+
+        fixture.hub.configureScope((scope) {
+          scope.span = NoOpSentrySpan();
+        });
+
+        await tapMe(tester, sut, 'btn_1');
+
+        ISentrySpan? span;
+        fixture.hub.configureScope((scope) {
+          span = scope.span;
+        });
+        expect(span, NoOpSentrySpan());
+      });
+    });
+
+    testWidgets('Extend timer if transaction already started for same widget',
+        (tester) async {
+      await tester.runAsync(() async {
+        final sut = fixture.getSut(
+            enableUserInteractionTracing: true,
+            enableUserInteractionBreadcrumbs: false);
+
+        await tapMe(tester, sut, 'btn_1');
+        Timer? currentTimer;
+
+        fixture.hub.configureScope((scope) {
+          final tracer = (scope.span as SentryTracer);
+          currentTimer = tracer.autoFinishAfterTimer;
+        });
+
+        await tapMe(tester, sut, 'btn_1');
+
+        Timer? autoFinishAfterTimer;
+        fixture.hub.configureScope((scope) {
+          final tracer = (scope.span as SentryTracer);
+          autoFinishAfterTimer = tracer.autoFinishAfterTimer;
+        });
+        expect(currentTimer, isNot(equals(autoFinishAfterTimer)));
+      });
+    });
+
+    testWidgets('Finish transaction and start new one if new tap',
+        (tester) async {
+      await tester.runAsync(() async {
+        final sut = fixture.getSut(
+            enableUserInteractionTracing: true,
+            enableUserInteractionBreadcrumbs: false);
+
+        await tapMe(tester, sut, 'btn_1');
+        SentryTracer? currentTracer;
+
+        fixture.hub.configureScope((scope) {
+          currentTracer = (scope.span as SentryTracer);
+        });
+
+        await tapMe(tester, sut, 'btn_2');
+
+        SentryTracer? tracer;
+        fixture.hub.configureScope((scope) {
+          tracer = (scope.span as SentryTracer);
+        });
+        expect(currentTracer, isNot(equals(tracer)));
       });
     });
   });
 }
 
-Future<void> tapMe(WidgetTester tester, Widget widget, String text) async {
+Future<void> tapMe(WidgetTester tester, Widget widget, String key) async {
   await tester.pumpWidget(widget);
 
-  await tester.tap(find.text(text));
+  await tester.tap(find.byKey(Key(key)));
 }
 
 class Fixture {
@@ -109,13 +248,23 @@ class MyApp extends StatelessWidget {
                 },
                 child: const Text('Button 1'),
               ),
-              MaterialButton(
+              CupertinoButton(
                 key: Key('btn_2'),
                 onPressed: () {
                   // print('button pressed 2');
                 },
                 child: const Text('Button 2'),
               ),
+              IconButton(
+                key: Key('btn_3'),
+                onPressed: () {
+                  // print('button pressed 3');
+                },
+                icon: Icon(
+                  Icons.dark_mode,
+                  semanticLabel: 'My Icon',
+                ),
+              ),
             ],
           ),
         ),
