-
-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathstate_controller_test.dart
More file actions
714 lines (597 loc) · 20.9 KB
/
state_controller_test.dart
File metadata and controls
714 lines (597 loc) · 20.9 KB
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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
// ignore_for_file: unnecessary_lambdas, unused_element
// ignore_for_file: deprecated_member_use_from_same_package
import 'dart:async';
import 'package:control/control.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter_test/flutter_test.dart';
void main() => group('StateController', () {
_$concurrencyGroup();
_$genericHandleGroup();
_$exceptionalGroup();
_$assertionGroup();
_$methodsGroup();
_$onErrorGroup();
});
void _$concurrencyGroup() => group('concurrency', () {
test('sequential', () async {
final controller = _FakeControllerSequential();
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(0));
expect(controller.subscribers, equals(0));
expect(controller.isDisposed, isFalse);
final done = Future.wait(<Future<void>>[
controller.add(1),
controller.subtract(2),
controller.add(4),
]);
expect(controller.isProcessing, isTrue);
await expectLater(done, completes);
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(3));
expect(controller.subscribers, equals(0));
expect(() => controller.addListener(() {}), returnsNormally);
expect(controller.subscribers, equals(1));
controller.dispose();
expect(controller.subscribers, equals(0));
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(3));
expect(controller.isDisposed, isTrue);
expect(() => controller.removeListener(() {}), returnsNormally);
});
test('droppable', () async {
final controller = _FakeControllerDroppable();
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(0));
expect(controller.subscribers, equals(0));
expect(controller.isDisposed, isFalse);
// Start first operation (will succeed)
final first = controller.add(1);
expect(controller.isProcessing, isTrue);
// These will be dropped (controller is busy)
final dropped1 = controller.subtract(2);
final dropped2 = controller.add(4);
// Dropped operations complete with null
await expectLater(dropped1, completion(isNull));
await expectLater(dropped2, completion(isNull));
// First operation completes
await expectLater(first, completes);
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(1)); // Only first operation executed
expect(controller.subscribers, equals(0));
expect(() => controller.addListener(() {}), returnsNormally);
expect(controller.subscribers, equals(1));
controller.dispose();
expect(controller.subscribers, equals(0));
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(1));
expect(controller.isDisposed, isTrue);
expect(() => controller.removeListener(() {}), returnsNormally);
});
test('concurrent', () async {
final controller = _FakeControllerConcurrent();
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(0));
expect(controller.subscribers, equals(0));
expect(controller.isDisposed, isFalse);
final done = Future.wait(<Future<void>>[
controller.add(1),
controller.subtract(2),
controller.add(4),
]);
expect(controller.isProcessing, isTrue);
await expectLater(done, completes);
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(3));
expect(controller.subscribers, equals(0));
expect(() => controller.addListener(() {}), returnsNormally);
expect(controller.subscribers, equals(1));
controller.dispose();
expect(controller.subscribers, equals(0));
expect(controller.isProcessing, isFalse);
expect(controller.state, equals(3));
expect(controller.isDisposed, isTrue);
expect(() => controller.removeListener(() {}), returnsNormally);
});
});
void _$exceptionalGroup() => group('exceptional', () {
test('throws if dispose called multiple times', () {
final controller = _FakeControllerConcurrent()..dispose();
expect(() => controller.dispose(), throwsA(isA<AssertionError>()));
});
test('handles edge case of adding large values', () async {
const largeValue = 9223372036854775807;
final controller = _FakeControllerConcurrent();
await expectLater(controller.add(largeValue), completes);
expect(controller.state, equals(largeValue));
controller.dispose();
});
test('handles edge case of subtracting large values', () async {
const largeNegativeValue = 9223372036854775807;
final controller = _FakeControllerConcurrent();
await expectLater(controller.subtract(largeNegativeValue), completes);
expect(controller.state, equals(-largeNegativeValue));
controller.dispose();
});
test('processes multiple operations efficiently', () async {
final stopwatch = Stopwatch()..start();
try {
final controller = _FakeControllerConcurrent();
final done = Future.wait(<Future<void>>[
for (var i = 0; i < 1000; i++) controller.add(1),
]);
await expectLater(done, completes);
expect(controller.state, equals(1000));
controller.dispose();
} finally {
debugPrint('${(stopwatch..stop()).elapsedMicroseconds} μs');
}
});
test('should correctly manage multiple listeners', () {
final controller = _FakeControllerConcurrent();
void listener1() {}
void listener2() {}
expect(controller.subscribers, equals(0));
controller
..addListener(listener1)
..addListener(listener2);
expect(controller.subscribers, equals(2));
controller.removeListener(listener1);
expect(controller.subscribers, equals(1));
controller.removeListener(listener2);
expect(controller.subscribers, equals(0));
});
});
void _$assertionGroup() => group('assertion', () {
test('should assert when notifyListeners called on disposed controller', () {
final controller = _FakeControllerSequential();
controller.dispose(); // ignore: cascade_invocations
expect(controller.isDisposed, isTrue);
expect(
() => controller.addWithNotifyListeners(1),
throwsA(
isA<AssertionError>().having(
(e) => e.message,
'message',
contains('A _FakeControllerSequential was already disposed.'),
),
),
);
});
test('should assert when addListener called on disposed controller', () {
final controller = _FakeControllerSequential();
controller.dispose(); // ignore: cascade_invocations
expect(controller.isDisposed, isTrue);
void listener() {}
expect(
() => controller.addListener(listener),
throwsA(
isA<AssertionError>().having(
(e) => e.message,
'message',
contains('A _FakeControllerSequential was already disposed.'),
),
),
);
});
});
void _$genericHandleGroup() => group('generic handle', () {
test('returns value from handler', () async {
final controller = _FakeControllerConcurrent();
final result = await controller.getValue(42);
expect(result, equals(42));
controller.dispose();
});
test('sequential returns value', () async {
final controller = _FakeControllerSequential();
final result = await controller.getValue(100);
expect(result, equals(100));
controller.dispose();
});
test('droppable returns value when not busy', () async {
final controller = _FakeControllerDroppable();
final result = await controller.getValue(77);
expect(result, equals(77));
controller.dispose();
});
test('droppable returns null when busy', () async {
final controller = _FakeControllerDroppable();
// Start first operation
final first = controller.getValue(1);
// Try second operation while first is running - returns null
final second = await controller.getValue(2);
expect(second, isNull); // Dropped, returns null
// First operation completes with value
await expectLater(first, completion(1));
controller.dispose();
});
});
void _$methodsGroup() => group('methods', () {
test('merge', () async {
final controllerOne = _FakeControllerSequential();
final controllerTwo = _FakeControllerSequential();
final mergedListenable = Controller.merge([controllerOne, controllerTwo]);
// Check that the result is an object of type Listenable
expect(mergedListenable, isA<Listenable>());
// Check that subscribers to mergedListenable listen for changes
// in both controllers
var listenerCalled = 0;
mergedListenable.addListener(() => listenerCalled++);
controllerOne.add(1).ignore();
await Future<void>.delayed(Duration.zero);
expect(listenerCalled, equals(1));
controllerTwo.add(1).ignore();
await Future<void>.delayed(Duration.zero);
expect(listenerCalled, equals(2));
});
test('toStream', () async {
final controller = _FakeControllerConcurrent();
expect(controller.toStream(), isA<Stream<int>>());
// ignore: unawaited_futures
expectLater(
controller.toStream(),
emitsInOrder(<Object>[1, 0, -1, 2, emitsDone]),
);
await expectLater(
Future.wait([
controller.add(1),
controller.subtract(1),
controller.subtract(1),
controller.add(3),
]),
completes,
);
controller.dispose();
});
test('toValueListenable', () async {
final controller = _FakeControllerConcurrent();
final listenable = controller.toValueListenable();
expect(listenable, isA<ValueListenable<int>>());
expect(listenable.value, equals(controller.state));
await expectLater(
Future.wait([controller.add(2), controller.subtract(1)]),
completes,
);
expect(listenable.value, equals(controller.state));
final completer = Completer<void>();
listenable.addListener(completer.complete);
controller.add(1).ignore();
await expectLater(completer.future, completes);
expect(completer.isCompleted, isTrue);
controller.dispose();
});
test('select', () async {
final controller = _FakeControllerConcurrent();
// Test selector without filter
final selected = controller.select<String>((state) => 'value:$state');
expect(selected, isA<ValueListenable<String>>());
expect(selected.value, equals('value:0'));
// Test that selector updates on state change
var listenerCallCount = 0;
void listener() => listenerCallCount++;
selected.addListener(listener);
await controller.add(5);
expect(selected.value, equals('value:5'));
expect(listenerCallCount, equals(1));
await controller.subtract(3);
expect(selected.value, equals('value:2'));
expect(listenerCallCount, equals(2));
selected.removeListener(listener);
await controller.add(1);
expect(listenerCallCount, equals(2)); // Listener not called after removal
controller.dispose();
});
test('select with filter', () async {
final controller = _FakeControllerConcurrent();
// Test selector with filter - only notify if value changes
final selected = controller.select<bool>(
(state) => state > 0,
(prev, next) => prev != next, // Only notify if boolean value changes
);
expect(selected.value, equals(false)); // Initial state is 0
var listenerCallCount = 0;
void listener() => listenerCallCount++;
selected.addListener(listener);
// Change from 0 to 5 (false to true) - should notify
await controller.add(5);
expect(selected.value, equals(true));
expect(listenerCallCount, equals(1));
// Change from 5 to 10 (true to true) - should NOT notify due to filter
await controller.add(5);
expect(selected.value, equals(true));
expect(listenerCallCount, equals(1)); // No change in boolean value
// Change from 10 to -5 (true to false) - should notify
await controller.subtract(15);
expect(selected.value, equals(false));
expect(listenerCallCount, equals(2));
selected.removeListener(listener);
controller.dispose();
});
test('select on disposed controller', () async {
final controller = _FakeControllerConcurrent();
final selected = controller.select<String>((state) => 'value:$state');
void listener() {}
selected.addListener(listener);
controller.dispose();
// Should not throw when adding listener to disposed controller's selected
expect(() => selected.addListener(() {}), returnsNormally);
expect(() => selected.removeListener(listener), returnsNormally);
});
test('select value accessed without subscription', () async {
final controller = _FakeControllerConcurrent();
final selected = controller.select<int>((state) => state * 2);
// Access value before subscribing - should compute on-demand
expect(selected.value, equals(0));
await controller.add(5);
expect(selected.value, equals(10)); // Should compute from current state
controller.dispose();
});
test('select disposes cleanly', () async {
final controller = _FakeControllerConcurrent();
final selected = controller.select<int>((state) => state * 2);
var callCount = 0;
void listener() => callCount++;
// Add and remove listener multiple times
selected.addListener(listener);
await controller.add(1);
expect(callCount, equals(1));
selected.removeListener(listener);
await controller.add(2);
expect(callCount, equals(1)); // No change after removal
// Add listener again
selected.addListener(listener);
await controller.add(3);
expect(callCount, equals(2));
// Dispose selected - should clean up subscription
if (selected is ChangeNotifier) {
(selected as ChangeNotifier).dispose();
}
controller.dispose();
});
});
void _$onErrorGroup() => group('onError', () {
group('sequential', () {
test('should call onError and error callback '
'when an exception is thrown', () async {
final controller = _FakeControllerSequential();
var errorCalled = 0;
void onError() {
errorCalled++;
throw Exception();
}
var doneCalled = 0;
void onDone() => doneCalled++;
controller.makeError(
onError: () async {
onError();
throw Exception();
},
onDone: () async => onDone(),
);
await Future<void>.delayed(Duration.zero);
expect(errorCalled, same(1));
expect(doneCalled, same(1));
});
test('should execute handler, handle errors, '
'and call done callback within runZonedGuarded', () async {
final controller = _FakeControllerSequential();
var errorCalled = 0;
void onError() {
errorCalled++;
throw Exception();
}
var doneCalled = 0;
void onDone() {
doneCalled++;
throw Exception();
}
controller.makeError(
onError: () async => onError(),
onDone: () async => onDone(),
);
await Future<void>.delayed(Duration.zero);
expect(errorCalled, same(1));
expect(doneCalled, same(1));
});
});
group('droppable', () {
test('should call onError and error callback '
'when an exception is thrown', () async {
final controller = _FakeControllerDroppable();
var errorCalled = 0;
void onError() {
errorCalled++;
throw Exception();
}
var doneCalled = 0;
void onDone() => doneCalled++;
controller.makeError(
onError: () async {
onError();
throw Exception();
},
onDone: () async => onDone(),
);
await Future<void>.delayed(Duration.zero);
expect(errorCalled, same(1));
expect(doneCalled, same(1));
});
test('should execute handler, handle errors, '
'and call done callback within runZonedGuarded', () async {
final controller = _FakeControllerDroppable();
var errorCalled = 0;
void onError() {
errorCalled++;
throw Exception();
}
var doneCalled = 0;
void onDone() {
doneCalled++;
throw Exception();
}
controller.makeError(
onError: () async => onError(),
onDone: () async => onDone(),
);
await Future<void>.delayed(Duration.zero);
expect(errorCalled, same(1));
expect(doneCalled, same(1));
});
});
group('concurrent', () {
test('should call onError and error callback '
'when an exception is thrown', () async {
final controller = _FakeControllerConcurrent();
var errorCalled = 0;
void onError() {
errorCalled++;
throw Exception();
}
var doneCalled = 0;
void onDone() => doneCalled++;
controller.makeError(
onError: () async {
onError();
throw Exception();
},
onDone: () async => onDone(),
);
await Future<void>.delayed(Duration.zero);
expect(errorCalled, same(1));
expect(doneCalled, same(1));
});
test('should execute handler, handle errors, '
'and call done callback within runZonedGuarded', () async {
final controller = _FakeControllerConcurrent();
var errorCalled = 0;
void onError() {
errorCalled++;
throw Exception();
}
var doneCalled = 0;
void onDone() {
doneCalled++;
throw Exception();
}
controller.makeError(
onError: () async => onError(),
onDone: () async => onDone(),
);
await Future<void>.delayed(Duration.zero);
expect(errorCalled, same(1));
expect(doneCalled, same(1));
});
test('should call observer onCreate with error handling', () async {
final oldObserver = Controller.observer;
var createCalled = false;
// Observer that throws on onCreate
Controller.observer = _SimpleTestObserver(
onCreateCallback: () {
createCalled = true;
throw Exception('onCreate error');
},
);
// Create controller - should not throw despite observer error
final controller = _FakeControllerConcurrent();
expect(createCalled, isTrue);
Controller.observer = oldObserver;
controller.dispose();
});
test('should call observer onDispose with error handling', () async {
final controller = _FakeControllerConcurrent();
final oldObserver = Controller.observer;
var disposeCalled = false;
// Observer that throws on onDispose
Controller.observer = _SimpleTestObserver(
onDisposeCallback: () {
disposeCalled = true;
throw Exception('onDispose error');
},
);
// Dispose controller - should not throw despite observer error
controller.dispose();
expect(disposeCalled, isTrue);
Controller.observer = oldObserver;
});
});
});
abstract class _FakeControllerBase extends StateController<int> {
_FakeControllerBase({int? initialState})
: super(initialState: initialState ?? 0);
Future<void> add(int value) => handle(() async {
await Future<void>.delayed(Duration.zero);
setState(state + value);
});
Future<void> subtract(int value) => handle(() async {
await Future<void>.delayed(Duration.zero);
setState(state - value);
});
/// Test generic handle - returns a value
Future<int?> getValue(int value) => handle<int>(() async {
await Future<void>.delayed(Duration.zero);
return value;
});
}
final class _FakeControllerSequential extends _FakeControllerBase
with SequentialControllerHandler {
void addWithNotifyListeners(int value) {
state + value; // ignore: unnecessary_statements
notifyListeners();
}
void makeError({void Function()? onError, void Function()? onDone}) => handle(
() async {
throw Exception();
},
error: (_, _) async => onError?.call(),
done: () async => onDone?.call(),
);
}
final class _FakeControllerDroppable extends _FakeControllerBase
with DroppableControllerHandler {
void makeError({void Function()? onError, void Function()? onDone}) => handle(
() async {
throw Exception();
},
error: (_, _) async => onError?.call(),
done: () async => onDone?.call(),
);
}
final class _FakeControllerConcurrent extends _FakeControllerBase
with ConcurrentControllerHandler {
void makeError({void Function()? onError, void Function()? onDone}) => handle(
() async {
throw Exception();
},
error: (_, _) async => onError?.call(),
done: () async => onDone?.call(),
);
}
final class _SimpleTestObserver implements IControllerObserver {
_SimpleTestObserver({
this.onCreateCallback,
this.onDisposeCallback,
this.onErrorCallback, // ignore: unused_element_parameter
});
final void Function()? onCreateCallback;
final void Function()? onDisposeCallback;
final void Function(Object error)? onErrorCallback;
@override
void onCreate(Controller controller) {
onCreateCallback?.call();
}
@override
void onDispose(Controller controller) {
onDisposeCallback?.call();
}
@override
void onHandler(HandlerContext context) {}
@override
void onStateChanged<S extends Object>(
StateController<S> controller,
S prevState,
S nextState,
) {}
@override
void onError(Controller controller, Object error, StackTrace stackTrace) {
onErrorCallback?.call(error);
}
}