|
| 1 | +import 'dart:math'; |
| 2 | + |
| 3 | +import 'package:flutter_test/flutter_test.dart'; |
| 4 | +import 'package:sentry_flutter/sentry_flutter.dart'; |
| 5 | +import 'package:sentry_flutter/src/integrations/app_start/app_start_tracker.dart'; |
| 6 | +import 'package:sentry_flutter/src/navigation/time_to_initial_display_tracker.dart'; |
| 7 | + |
| 8 | +import '../fake_frame_callback_handler.dart'; |
| 9 | +import '../mocks.dart'; |
| 10 | +import 'package:sentry/src/sentry_tracer.dart'; |
| 11 | + |
| 12 | +void main() { |
| 13 | + late Fixture fixture; |
| 14 | + |
| 15 | + setUp(() { |
| 16 | + fixture = Fixture(); |
| 17 | + }); |
| 18 | + |
| 19 | + group('app start', () { |
| 20 | + test('tracking creates and finishes ttid span with correct measurements', () async { |
| 21 | + final sut = fixture.getSut(); |
| 22 | + final transaction = fixture.hub.startTransaction('fake', 'fake') |
| 23 | + as SentryTracer; |
| 24 | + final startTimestamp = DateTime.now(); |
| 25 | + final appStartInfo = AppStartInfo( |
| 26 | + startTimestamp, |
| 27 | + startTimestamp.add(Duration(milliseconds: 10)), |
| 28 | + SentryMeasurement.coldAppStart(Duration(milliseconds: 10))); |
| 29 | + |
| 30 | + await sut.trackAppStart(transaction, appStartInfo, 'route ("/")'); |
| 31 | + |
| 32 | + final children = transaction.children; |
| 33 | + expect(children, hasLength(1)); |
| 34 | + |
| 35 | + final ttidSpan = children.first; |
| 36 | + expect(ttidSpan.context.operation, SentrySpanOperations.uiTimeToInitialDisplay); |
| 37 | + expect(ttidSpan.finished, isTrue); |
| 38 | + expect(ttidSpan.context.description, 'route ("/") initial display'); |
| 39 | + expect(ttidSpan.origin, SentryTraceOrigins.autoUiTimeToDisplay); |
| 40 | + |
| 41 | + final ttidMeasurement = transaction.measurements['time_to_initial_display']; |
| 42 | + expect(ttidMeasurement, isNotNull); |
| 43 | + expect(ttidMeasurement?.unit, DurationSentryMeasurementUnit.milliSecond); |
| 44 | + expect(ttidMeasurement?.value, 10); |
| 45 | + |
| 46 | + final appStartMeasurement = transaction.measurements['app_start_cold']; |
| 47 | + expect(appStartMeasurement, isNotNull); |
| 48 | + expect(appStartMeasurement?.unit, DurationSentryMeasurementUnit.milliSecond); |
| 49 | + expect(appStartMeasurement?.value, 10); |
| 50 | + }); |
| 51 | + }); |
| 52 | + |
| 53 | + group('regular route', () { |
| 54 | + test('approximation tracking creates and finishes ttid span with correct measurements', () async { |
| 55 | + final sut = fixture.getSut(); |
| 56 | + final transaction = fixture.hub.startTransaction('fake', 'fake') |
| 57 | + as SentryTracer; |
| 58 | + final startTimestamp = DateTime.now(); |
| 59 | + |
| 60 | + await sut.trackRegularRoute(transaction, startTimestamp, 'regular route'); |
| 61 | + |
| 62 | + final children = transaction.children; |
| 63 | + expect(children, hasLength(1)); |
| 64 | + |
| 65 | + final ttidSpan = children.first; |
| 66 | + expect(ttidSpan.context.operation, SentrySpanOperations.uiTimeToInitialDisplay); |
| 67 | + expect(ttidSpan.finished, isTrue); |
| 68 | + expect(ttidSpan.context.description, 'regular route initial display'); |
| 69 | + expect(ttidSpan.origin, SentryTraceOrigins.autoUiTimeToDisplay); |
| 70 | + |
| 71 | + final ttidMeasurement = transaction.measurements['time_to_initial_display']; |
| 72 | + expect(ttidMeasurement, isNotNull); |
| 73 | + expect(ttidMeasurement?.unit, DurationSentryMeasurementUnit.milliSecond); |
| 74 | + expect(ttidMeasurement?.value, greaterThan(fixture.finishAfterDuration.inMilliseconds)); |
| 75 | + expect(ttidMeasurement?.value, lessThan(fixture.finishAfterDuration.inMilliseconds + 10)); |
| 76 | + }); |
| 77 | + |
| 78 | + test('manual tracking creates and finishes ttid span with correct measurements', () async { |
| 79 | + final sut = fixture.getSut(); |
| 80 | + final transaction = fixture.hub.startTransaction('fake', 'fake') |
| 81 | + as SentryTracer; |
| 82 | + final startTimestamp = DateTime.now(); |
| 83 | + |
| 84 | + sut.markAsManual(); |
| 85 | + Future.delayed(fixture.finishAfterDuration, () { |
| 86 | + sut.completeTracking(); |
| 87 | + }); |
| 88 | + await sut.trackRegularRoute(transaction, startTimestamp, 'regular route'); |
| 89 | + |
| 90 | + final children = transaction.children; |
| 91 | + expect(children, hasLength(1)); |
| 92 | + |
| 93 | + final ttidSpan = children.first; |
| 94 | + expect(ttidSpan.context.operation, SentrySpanOperations.uiTimeToInitialDisplay); |
| 95 | + expect(ttidSpan.finished, isTrue); |
| 96 | + expect(ttidSpan.context.description, 'regular route initial display'); |
| 97 | + expect(ttidSpan.origin, SentryTraceOrigins.manualUiTimeToDisplay); |
| 98 | + |
| 99 | + final ttidMeasurement = transaction.measurements['time_to_initial_display']; |
| 100 | + expect(ttidMeasurement, isNotNull); |
| 101 | + expect(ttidMeasurement?.unit, DurationSentryMeasurementUnit.milliSecond); |
| 102 | + expect(ttidMeasurement?.value, greaterThan(fixture.finishAfterDuration.inMilliseconds)); |
| 103 | + expect(ttidMeasurement?.value, lessThan(fixture.finishAfterDuration.inMilliseconds + 10)); |
| 104 | + }); |
| 105 | + }); |
| 106 | + |
| 107 | + group('determineEndtime', () { |
| 108 | + test('can complete automatically in approximation mode', () async { |
| 109 | + final sut = fixture.getSut(); |
| 110 | + |
| 111 | + final futureEndTime = sut.determineEndTime(); |
| 112 | + |
| 113 | + expect(futureEndTime, completes); |
| 114 | + }); |
| 115 | + |
| 116 | + test('prevents automatic completion in manual mode', () async { |
| 117 | + final sut = fixture.getSut(); |
| 118 | + |
| 119 | + sut.markAsManual(); |
| 120 | + final futureEndTime = sut.determineEndTime(); |
| 121 | + |
| 122 | + expect(futureEndTime, doesNotComplete); |
| 123 | + }); |
| 124 | + |
| 125 | + test('can complete manually in manual mode', () async { |
| 126 | + final sut = fixture.getSut(); |
| 127 | + |
| 128 | + sut.markAsManual(); |
| 129 | + final futureEndTime = sut.determineEndTime(); |
| 130 | + |
| 131 | + sut.completeTracking(); |
| 132 | + expect(futureEndTime, completes); |
| 133 | + }); |
| 134 | + |
| 135 | + test('returns the correct approximation end time', () async { |
| 136 | + final startTime = DateTime.now(); |
| 137 | + final sut = fixture.getSut(); |
| 138 | + |
| 139 | + final futureEndTime = sut.determineEndTime(); |
| 140 | + |
| 141 | + final endTime = await futureEndTime; |
| 142 | + expect(endTime?.difference(startTime).inSeconds, |
| 143 | + fixture.finishAfterDuration.inSeconds); |
| 144 | + }); |
| 145 | + |
| 146 | + test('returns the correct manual end time', () async { |
| 147 | + final startTime = DateTime.now(); |
| 148 | + final sut = fixture.getSut(); |
| 149 | + |
| 150 | + sut.markAsManual(); |
| 151 | + final futureEndTime = sut.determineEndTime(); |
| 152 | + |
| 153 | + Future.delayed(fixture.finishAfterDuration, () { |
| 154 | + sut.completeTracking(); |
| 155 | + }); |
| 156 | + |
| 157 | + final endTime = await futureEndTime; |
| 158 | + expect(endTime?.difference(startTime).inSeconds, |
| 159 | + fixture.finishAfterDuration.inSeconds); |
| 160 | + }); |
| 161 | + }); |
| 162 | +} |
| 163 | + |
| 164 | +class Fixture { |
| 165 | + final hub = Hub(SentryFlutterOptions(dsn: fakeDsn)..tracesSampleRate = 1.0); |
| 166 | + final finishAfterDuration = Duration(milliseconds: 100); |
| 167 | + late final fakeFrameCallbackHandler = |
| 168 | + FakeFrameCallbackHandler(finishAfterDuration: finishAfterDuration); |
| 169 | + |
| 170 | + TimeToInitialDisplayTracker getSut() { |
| 171 | + final sut = TimeToInitialDisplayTracker(); |
| 172 | + sut.frameCallbackHandler = fakeFrameCallbackHandler; |
| 173 | + return sut; |
| 174 | + } |
| 175 | +} |
0 commit comments