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
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter/scheduler.dart';
import 'package:flutter_test/flutter_test.dart';
void main() {
testWidgets('TickerMode', (WidgetTester tester) async {
const Widget widget = TickerMode(
enabled: false,
child: CircularProgressIndicator(),
);
expect(widget.toString, isNot(throwsException));
await tester.pumpWidget(widget);
expect(tester.binding.transientCallbackCount, 0);
await tester.pumpWidget(const TickerMode(
enabled: true,
child: CircularProgressIndicator(),
));
expect(tester.binding.transientCallbackCount, 1);
await tester.pumpWidget(const TickerMode(
enabled: false,
child: CircularProgressIndicator(),
));
expect(tester.binding.transientCallbackCount, 0);
});
testWidgets('Navigation with TickerMode', (WidgetTester tester) async {
await tester.pumpWidget(MaterialApp(
home: const LinearProgressIndicator(),
routes: <String, WidgetBuilder>{
'/test': (BuildContext context) => const Text('hello'),
},
));
expect(tester.binding.transientCallbackCount, 1);
tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/test');
expect(tester.binding.transientCallbackCount, 2);
await tester.pump();
expect(tester.binding.transientCallbackCount, 2);
await tester.pump(const Duration(seconds: 5));
expect(tester.binding.transientCallbackCount, 0);
tester.state<NavigatorState>(find.byType(Navigator)).pop();
expect(tester.binding.transientCallbackCount, 1);
await tester.pump();
expect(tester.binding.transientCallbackCount, 2);
await tester.pump(const Duration(seconds: 5));
expect(tester.binding.transientCallbackCount, 1);
});
testWidgets('SingleTickerProviderStateMixin can handle not being used', (WidgetTester tester) async {
const Widget widget = BoringTickerTest();
expect(widget.toString, isNot(throwsException));
await tester.pumpWidget(widget);
await tester.pumpWidget(Container());
// the test is that this doesn't crash, like it used to...
});
group('TickerProviderStateMixin assertion control test', () {
testWidgets('SingleTickerProviderStateMixin create multiple tickers', (WidgetTester tester) async {
final Widget widget = _SingleTickerCreateMultipleTicker();
await tester.pumpWidget(widget);
final dynamic exception = tester.takeException();
expect(exception, isNotNull);
expect(exception, isFlutterError);
final FlutterError error = exception as FlutterError;
expect(error.diagnostics.length, 3);
expect(error.diagnostics[2].level, DiagnosticLevel.hint);
expect(error.diagnostics[2].toStringDeep(), equalsIgnoringHashCodes(
'If a State is used for multiple AnimationController objects, or\n'
'if it is passed to other objects and those objects might use it\n'
'more than one time in total, then instead of mixing in a\n'
'SingleTickerProviderStateMixin, use a regular\n'
'TickerProviderStateMixin.\n',
));
expect(error.toStringDeep(), equalsIgnoringHashCodes(
'FlutterError\n'
' _SingleTickerCreateMultipleTickerState is a\n'
' SingleTickerProviderStateMixin but multiple tickers were created.\n'
' A SingleTickerProviderStateMixin can only be used as a\n'
' TickerProvider once.\n'
' If a State is used for multiple AnimationController objects, or\n'
' if it is passed to other objects and those objects might use it\n'
' more than one time in total, then instead of mixing in a\n'
' SingleTickerProviderStateMixin, use a regular\n'
' TickerProviderStateMixin.\n',
));
});
testWidgets('SingleTickerProviderStateMixin dispose while active', (WidgetTester tester) async {
final GlobalKey<_SingleTickerTestState> key = GlobalKey<_SingleTickerTestState>();
final Widget widget = _SingleTickerTest(key: key);
await tester.pumpWidget(widget);
FlutterError? error;
key.currentState!.controller.repeat();
try {
key.currentState!.dispose();
} on FlutterError catch (e) {
error = e;
} finally {
expect(error, isNotNull);
expect(error!.diagnostics.length, 4);
expect(error.diagnostics[2].level, DiagnosticLevel.hint);
expect(
error.diagnostics[2].toStringDeep(),
'Tickers used by AnimationControllers should be disposed by\n'
'calling dispose() on the AnimationController itself. Otherwise,\n'
'the ticker will leak.\n',
);
expect(error.diagnostics[3], isA<DiagnosticsProperty<Ticker>>());
expect(error.toStringDeep().split('\n').take(13).join('\n'), equalsIgnoringHashCodes(
'FlutterError\n'
' _SingleTickerTestState#00000(ticker active) was disposed with an\n'
' active Ticker.\n'
' _SingleTickerTestState created a Ticker via its\n'
' SingleTickerProviderStateMixin, but at the time dispose() was\n'
' called on the mixin, that Ticker was still active. The Ticker\n'
' must be disposed before calling super.dispose().\n'
' Tickers used by AnimationControllers should be disposed by\n'
' calling dispose() on the AnimationController itself. Otherwise,\n'
' the ticker will leak.\n'
' The offending ticker was:\n'
' Ticker(created by _SingleTickerTestState#00000)\n'
' The stack trace when the Ticker was actually created was:',
));
key.currentState!.controller.stop();
}
});
testWidgets('SingleTickerProviderStateMixin dispose while active', (WidgetTester tester) async {
final GlobalKey<_SingleTickerTestState> key = GlobalKey<_SingleTickerTestState>();
final Widget widget = _SingleTickerTest(key: key);
await tester.pumpWidget(widget);
FlutterError? error;
key.currentState!.controller.repeat();
try {
key.currentState!.dispose();
} on FlutterError catch (e) {
error = e;
} finally {
expect(error, isNotNull);
expect(error!.diagnostics.length, 4);
expect(error.diagnostics[2].level, DiagnosticLevel.hint);
expect(
error.diagnostics[2].toStringDeep(),
'Tickers used by AnimationControllers should be disposed by\n'
'calling dispose() on the AnimationController itself. Otherwise,\n'
'the ticker will leak.\n',
);
expect(error.diagnostics[3], isA<DiagnosticsProperty<Ticker>>());
expect(error.toStringDeep().split('\n').take(13).join('\n'), equalsIgnoringHashCodes(
'FlutterError\n'
' _SingleTickerTestState#00000(ticker active) was disposed with an\n'
' active Ticker.\n'
' _SingleTickerTestState created a Ticker via its\n'
' SingleTickerProviderStateMixin, but at the time dispose() was\n'
' called on the mixin, that Ticker was still active. The Ticker\n'
' must be disposed before calling super.dispose().\n'
' Tickers used by AnimationControllers should be disposed by\n'
' calling dispose() on the AnimationController itself. Otherwise,\n'
' the ticker will leak.\n'
' The offending ticker was:\n'
' Ticker(created by _SingleTickerTestState#00000)\n'
' The stack trace when the Ticker was actually created was:',
));
key.currentState!.controller.stop();
}
});
testWidgets('TickerProviderStateMixin dispose while any ticker is active', (WidgetTester tester) async {
final GlobalKey<_MultipleTickerTestState> key = GlobalKey<_MultipleTickerTestState>();
final Widget widget = _MultipleTickerTest(key: key);
await tester.pumpWidget(widget);
FlutterError? error;
key.currentState!.controllers.first.repeat();
try {
key.currentState!.dispose();
} on FlutterError catch (e) {
error = e;
} finally {
expect(error, isNotNull);
expect(error!.diagnostics.length, 4);
expect(error.diagnostics[2].level, DiagnosticLevel.hint);
expect(
error.diagnostics[2].toStringDeep(),
'Tickers used by AnimationControllers should be disposed by\n'
'calling dispose() on the AnimationController itself. Otherwise,\n'
'the ticker will leak.\n',
);
expect(error.diagnostics[3], isA<DiagnosticsProperty<Ticker>>());
expect(error.toStringDeep().split('\n').take(12).join('\n'), equalsIgnoringHashCodes(
'FlutterError\n'
' _MultipleTickerTestState#00000(tickers: tracking 2 tickers) was\n'
' disposed with an active Ticker.\n'
' _MultipleTickerTestState created a Ticker via its\n'
' TickerProviderStateMixin, but at the time dispose() was called on\n'
' the mixin, that Ticker was still active. All Tickers must be\n'
' disposed before calling super.dispose().\n'
' Tickers used by AnimationControllers should be disposed by\n'
' calling dispose() on the AnimationController itself. Otherwise,\n'
' the ticker will leak.\n'
' The offending ticker was:\n'
' _WidgetTicker(created by _MultipleTickerTestState#00000)',
));
key.currentState!.controllers.first.stop();
}
});
});
testWidgets('SingleTickerProviderStateMixin does not call State.toString', (WidgetTester tester) async {
await tester.pumpWidget(const _SingleTickerTest());
expect(tester.state<_SingleTickerTestState>(find.byType(_SingleTickerTest)).toStringCount, 0);
});
testWidgets('TickerProviderStateMixin does not call State.toString', (WidgetTester tester) async {
await tester.pumpWidget(const _MultipleTickerTest());
expect(tester.state<_MultipleTickerTestState>(find.byType(_MultipleTickerTest)).toStringCount, 0);
});
}
class BoringTickerTest extends StatefulWidget {
const BoringTickerTest({ Key? key }) : super(key: key);
@override
State<BoringTickerTest> createState() => _BoringTickerTestState();
}
class _BoringTickerTestState extends State<BoringTickerTest> with SingleTickerProviderStateMixin {
@override
Widget build(BuildContext context) => Container();
}
class _SingleTickerTest extends StatefulWidget {
const _SingleTickerTest({Key? key}) : super(key: key);
@override
_SingleTickerTestState createState() => _SingleTickerTestState();
}
class _SingleTickerTestState extends State<_SingleTickerTest> with SingleTickerProviderStateMixin {
late AnimationController controller;
@override
void initState() {
super.initState();
controller = AnimationController(
vsync: this,
duration: const Duration(seconds: 100),
);
}
@override
Widget build(BuildContext context) {
return Container();
}
int toStringCount = 0;
@override
String toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) {
toStringCount += 1;
return super.toString(minLevel: minLevel);
}
}
class _MultipleTickerTest extends StatefulWidget {
const _MultipleTickerTest({Key? key}) : super(key: key);
@override
_MultipleTickerTestState createState() => _MultipleTickerTestState();
}
class _MultipleTickerTestState extends State<_MultipleTickerTest> with TickerProviderStateMixin {
List<AnimationController> controllers = <AnimationController>[];
@override
void initState() {
super.initState();
const Duration duration = Duration(seconds: 100);
controllers.add(AnimationController(vsync: this, duration: duration));
controllers.add(AnimationController(vsync: this, duration: duration));
}
@override
Widget build(BuildContext context) {
return Container();
}
int toStringCount = 0;
@override
String toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) {
toStringCount += 1;
return super.toString(minLevel: minLevel);
}
}
class _SingleTickerCreateMultipleTicker extends StatefulWidget {
@override
_SingleTickerCreateMultipleTickerState createState() => _SingleTickerCreateMultipleTickerState();
}
class _SingleTickerCreateMultipleTickerState extends State<_SingleTickerCreateMultipleTicker> with SingleTickerProviderStateMixin {
@override
void initState() {
super.initState();
AnimationController(
duration: const Duration(seconds: 5),
vsync: this,
);
AnimationController(
duration: const Duration(seconds: 6),
vsync: this,
);
}
@override
Widget build(BuildContext context) {
return Container();
}
}