forked from getsentry/sentry-dart
-
Notifications
You must be signed in to change notification settings - Fork 0
/
widgets_binding_observer_test.dart
382 lines (287 loc) · 12 KB
/
widgets_binding_observer_test.dart
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
import 'dart:ui';
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:mockito/mockito.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
import 'package:sentry_flutter/src/binding_utils.dart';
import 'package:sentry_flutter/src/widgets_binding_observer.dart';
import 'mocks.mocks.dart';
void main() {
group('WidgetsBindingObserver', () {
late SentryFlutterOptions flutterTrackingEnabledOptions;
late SentryFlutterOptions flutterTrackingDisabledOptions;
setUp(() {
TestWidgetsFlutterBinding.ensureInitialized();
flutterTrackingEnabledOptions = SentryFlutterOptions();
flutterTrackingEnabledOptions.useFlutterBreadcrumbTracking();
flutterTrackingDisabledOptions = SentryFlutterOptions();
flutterTrackingDisabledOptions.useNativeBreadcrumbTracking();
});
testWidgets('memory pressure breadcrumb', (WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final message = const JSONMessageCodec()
.encodeMessage(<String, dynamic>{'type': 'memoryPressure'});
await instance.defaultBinaryMessenger
.handlePlatformMessage('flutter/system', message, (_) {});
final breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.single as Breadcrumb;
expect(
breadcrumb.message,
'App had memory pressure. This indicates that the operating system '
'would like applications to release caches to free up more memory.',
);
expect(breadcrumb.level, SentryLevel.warning);
expect(breadcrumb.type, 'system');
expect(breadcrumb.category, 'device.event');
instance.removeObserver(observer);
});
testWidgets('disable memory pressure breadcrumb',
(WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingDisabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final message = const JSONMessageCodec()
.encodeMessage(<String, dynamic>{'type': 'memoryPressure'});
await instance.defaultBinaryMessenger
.handlePlatformMessage('flutter/system', message, (_) {});
verifyNever(hub.addBreadcrumb(captureAny));
instance.removeObserver(observer);
});
testWidgets('lifecycle breadcrumbs', (WidgetTester tester) async {
Future<void> sendLifecycle(String event) async {
final messenger = TestWidgetsFlutterBinding.ensureInitialized()
.defaultBinaryMessenger;
final message =
const StringCodec().encodeMessage('AppLifecycleState.$event');
await messenger.handlePlatformMessage(
'flutter/lifecycle', message, (_) {});
}
Map<String, String> mapForLifecycle(String state) {
return <String, String>{'state': state};
}
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
// paused lifecycle event
await sendLifecycle('paused');
var breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.last as Breadcrumb;
expect(breadcrumb.category, 'app.lifecycle');
expect(breadcrumb.type, 'navigation');
expect(breadcrumb.data, mapForLifecycle('paused'));
expect(breadcrumb.level, SentryLevel.info);
// resumed lifecycle event
await sendLifecycle('resumed');
breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.last as Breadcrumb;
expect(breadcrumb.category, 'app.lifecycle');
expect(breadcrumb.type, 'navigation');
expect(breadcrumb.data, mapForLifecycle('resumed'));
expect(breadcrumb.level, SentryLevel.info);
// inactive lifecycle event
await sendLifecycle('inactive');
breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.last as Breadcrumb;
expect(breadcrumb.category, 'app.lifecycle');
expect(breadcrumb.type, 'navigation');
expect(breadcrumb.data, mapForLifecycle('inactive'));
expect(breadcrumb.level, SentryLevel.info);
// detached lifecycle event
await sendLifecycle('detached');
breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.last as Breadcrumb;
expect(breadcrumb.category, 'app.lifecycle');
expect(breadcrumb.type, 'navigation');
expect(breadcrumb.data, mapForLifecycle('detached'));
expect(breadcrumb.level, SentryLevel.info);
instance.removeObserver(observer);
});
testWidgets('disable lifecycle breadcrumbs', (WidgetTester tester) async {
Future<void> sendLifecycle(String event) async {
final messenger = TestWidgetsFlutterBinding.ensureInitialized()
.defaultBinaryMessenger;
final message =
const StringCodec().encodeMessage('AppLifecycleState.$event');
await messenger.handlePlatformMessage(
'flutter/lifecycle', message, (_) {});
}
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingDisabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
await sendLifecycle('paused');
verifyNever(hub.addBreadcrumb(captureAny));
instance.removeObserver(observer);
});
testWidgets('metrics changed breadcrumb', (WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = tester.binding;
instance.addObserver(observer);
final window = instance.window;
const newWidth = 123.0;
const newHeight = 456.0;
window.physicalSizeTestValue = Size(newWidth, newHeight);
final breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.single as Breadcrumb;
expect(breadcrumb.message, 'Screen size changed');
expect(breadcrumb.category, 'device.screen');
expect(breadcrumb.type, 'navigation');
expect(breadcrumb.level, SentryLevel.info);
expect(breadcrumb.data, <String, dynamic>{
'new_pixel_ratio': window.devicePixelRatio,
'new_height': newHeight,
'new_width': newWidth,
});
instance.removeObserver(observer);
});
testWidgets('only unique metrics emit events', (WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = tester.binding;
instance.addObserver(observer);
final window = instance.window;
window.physicalSizeTestValue = window.physicalSize;
const newPixelRatio = 1.618;
window.devicePixelRatioTestValue = newPixelRatio;
final breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.single as Breadcrumb;
expect(breadcrumb.message, 'Screen size changed');
expect(breadcrumb.category, 'device.screen');
expect(breadcrumb.type, 'navigation');
expect(breadcrumb.level, SentryLevel.info);
expect(breadcrumb.data, <String, dynamic>{
'new_pixel_ratio': newPixelRatio,
'new_height': window.physicalSize.height,
'new_width': window.physicalSize.width,
});
instance.removeObserver(observer);
});
testWidgets('no breadcrumb on unrelated metrics changes',
(WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = tester.binding;
instance.addObserver(observer);
final window = instance.window;
window.viewInsetsTestValue = WindowPadding.zero;
verifyNever(hub.addBreadcrumb(captureAny));
instance.removeObserver(observer);
});
testWidgets('disable metrics changed breadcrumb',
(WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingDisabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final window = instance.window;
window.onMetricsChanged!();
verifyNever(hub.addBreadcrumb(captureAny));
instance.removeObserver(observer);
});
testWidgets('platform brightness breadcrumb', (WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final window = instance.window;
window.onPlatformBrightnessChanged!();
final brightness = instance.window.platformBrightness;
final brightnessDescription =
brightness == Brightness.dark ? 'dark' : 'light';
final breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.single as Breadcrumb;
expect(breadcrumb.message,
'Platform brightness was changed to $brightnessDescription.');
expect(breadcrumb.category, 'device.event');
expect(breadcrumb.type, 'system');
expect(breadcrumb.level, SentryLevel.info);
expect(breadcrumb.data, <String, String>{
'action': 'BRIGHTNESS_CHANGED_TO_${brightnessDescription.toUpperCase()}'
});
instance.removeObserver(observer);
});
testWidgets('disable platform brightness breadcrumb',
(WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingDisabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final window = instance.window;
window.onPlatformBrightnessChanged!();
verifyNever(hub.addBreadcrumb(captureAny));
instance.removeObserver(observer);
});
testWidgets('text scale factor brightness changed breadcrumb',
(WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub,
options: flutterTrackingEnabledOptions,
);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final window = instance.window;
window.onTextScaleFactorChanged!();
final newTextScaleFactor = instance.window.textScaleFactor;
final breadcrumb =
verify(hub.addBreadcrumb(captureAny)).captured.single as Breadcrumb;
expect(breadcrumb.message,
'Text scale factor changed to $newTextScaleFactor.');
expect(breadcrumb.level, SentryLevel.info);
expect(breadcrumb.type, 'system');
expect(breadcrumb.category, 'device.event');
expect(breadcrumb.data, <String, String>{
'action': 'TEXT_SCALE_CHANGED_TO_$newTextScaleFactor'
});
instance.removeObserver(observer);
});
testWidgets('disable text scale factor brightness changed breadcrumb',
(WidgetTester tester) async {
final hub = MockHub();
final observer = SentryWidgetsBindingObserver(
hub: hub, options: flutterTrackingDisabledOptions);
final instance = BindingUtils.getWidgetsBindingInstance();
instance!.addObserver(observer);
final window = instance.window;
window.onTextScaleFactorChanged!();
verifyNever(hub.addBreadcrumb(captureAny));
instance.removeObserver(observer);
});
});
}