@@ -7,6 +7,179 @@ import 'package:dio_test/util.dart';
77import 'package:test/test.dart' ;
88
99void main () {
10+ group ('ResponseType.stream consumer cancellation' , () {
11+ test ('first cancels the adapter response stream' , () async {
12+ var cancelCount = 0 ;
13+ final source = StreamController <Uint8List >(
14+ onCancel: () => cancelCount++ ,
15+ );
16+ final cancelToken = CancelToken ();
17+ final dio = Dio ()
18+ ..httpClientAdapter =
19+ _StreamingAdapter (ResponseBody (source.stream, 200 ));
20+ addTearDown (() async {
21+ cancelToken.cancel ();
22+ await Future <void >.delayed (Duration .zero);
23+ await source.close ();
24+ dio.close ();
25+ });
26+
27+ final response = await dio.get <ResponseBody >(
28+ 'https://example.test/stream' ,
29+ options: Options (responseType: ResponseType .stream),
30+ cancelToken: cancelToken,
31+ );
32+ final first = response.data! .stream.first;
33+ source.add (Uint8List .fromList ([1 ]));
34+
35+ expect (await first, [1 ]);
36+ expect (source.hasListener, isFalse);
37+ expect (cancelCount, 1 );
38+ });
39+
40+ for (final pauseBeforeCancel in [false , true ]) {
41+ test (
42+ 'cancel releases the response${pauseBeforeCancel ? ' while paused' : '' }' ,
43+ () async {
44+ final source = StreamController <Uint8List >();
45+ var closeCount = 0 ;
46+ final progress = < int > [];
47+ final cancelToken = CancelToken ();
48+ final dio = Dio ()
49+ ..httpClientAdapter = _StreamingAdapter (
50+ ResponseBody (source.stream, 200 , onClose: () => closeCount++ ),
51+ );
52+ addTearDown (() async {
53+ cancelToken.cancel ();
54+ await Future <void >.delayed (Duration .zero);
55+ await source.close ();
56+ dio.close ();
57+ });
58+
59+ final response = await dio.get <ResponseBody >(
60+ 'https://example.test/stream' ,
61+ options: Options (
62+ responseType: ResponseType .stream,
63+ receiveTimeout: const Duration (milliseconds: 30 ),
64+ ),
65+ cancelToken: cancelToken,
66+ onReceiveProgress: (count, _) => progress.add (count),
67+ );
68+ final subscription = response.data! .stream.listen ((_) {});
69+ source.add (Uint8List .fromList ([1 ]));
70+ await Future <void >.delayed (Duration .zero);
71+ if (pauseBeforeCancel) {
72+ subscription.pause ();
73+ expect (source.isPaused, isTrue);
74+ }
75+
76+ await subscription.cancel ();
77+ expect (source.hasListener, isFalse);
78+ expect (closeCount, 1 );
79+
80+ source.add (Uint8List .fromList ([2 ]));
81+ await Future <void >.delayed (const Duration (milliseconds: 60 ));
82+ expect (progress, [1 ]);
83+ expect (closeCount, 1 , reason: 'The receive timer must not fire.' );
84+
85+ cancelToken.cancel ();
86+ await Future <void >.delayed (Duration .zero);
87+ expect (
88+ closeCount,
89+ 1 ,
90+ reason: 'Later cancellation must not close again.' ,
91+ );
92+ });
93+ }
94+
95+ test ('cancel waits for asynchronous adapter cleanup' , () async {
96+ final cleanupStarted = Completer <void >();
97+ final cleanupFinished = Completer <void >();
98+ final source = StreamController <Uint8List >(
99+ onCancel: () {
100+ cleanupStarted.complete ();
101+ return cleanupFinished.future;
102+ },
103+ );
104+ final cancelToken = CancelToken ();
105+ final dio = Dio ()
106+ ..httpClientAdapter =
107+ _StreamingAdapter (ResponseBody (source.stream, 200 ));
108+ addTearDown (() async {
109+ if (! cleanupFinished.isCompleted) {
110+ cleanupFinished.complete ();
111+ }
112+ cancelToken.cancel ();
113+ await Future <void >.delayed (Duration .zero);
114+ await source.close ();
115+ dio.close ();
116+ });
117+ final response = await dio.get <ResponseBody >(
118+ 'https://example.test/stream' ,
119+ options: Options (responseType: ResponseType .stream),
120+ cancelToken: cancelToken,
121+ );
122+ var cancellationCompleted = false ;
123+ final cancellation = response.data! .stream.listen ((_) {}).cancel ().then (
124+ (_) => cancellationCompleted = true ,
125+ );
126+
127+ await Future <void >.delayed (Duration .zero);
128+ expect (cleanupStarted.isCompleted, isTrue);
129+ expect (cancellationCompleted, isFalse);
130+ cleanupFinished.complete ();
131+ await cancellation;
132+ expect (cancellationCompleted, isTrue);
133+ });
134+
135+ for (final withError in [false , true ]) {
136+ test (
137+ 'late token cancellation after source ${withError ? 'error' : 'done' }' ,
138+ () async {
139+ var sourceCancelCount = 0 ;
140+ var closeCount = 0 ;
141+ final source = StreamController <Uint8List >(
142+ onCancel: () => sourceCancelCount++ ,
143+ );
144+ final cancelToken = CancelToken ();
145+ final dio = Dio ()
146+ ..httpClientAdapter = _StreamingAdapter (
147+ ResponseBody (source.stream, 200 , onClose: () => closeCount++ ),
148+ );
149+ addTearDown (() async {
150+ await source.close ();
151+ dio.close ();
152+ });
153+ final response = await dio.get <ResponseBody >(
154+ 'https://example.test/stream' ,
155+ options: Options (responseType: ResponseType .stream),
156+ cancelToken: cancelToken,
157+ );
158+ final received = response.data! .stream.toList ();
159+ if (withError) {
160+ source.addError (StateError ('response failed' ));
161+ await expectLater (received, throwsA (isA <StateError >()));
162+ } else {
163+ source.add (Uint8List .fromList ([1 ]));
164+ source.close ();
165+ expect (
166+ await received,
167+ [
168+ Uint8List .fromList ([1 ]),
169+ ],
170+ );
171+ }
172+
173+ expect (sourceCancelCount, 1 );
174+ expect (closeCount, 0 );
175+ cancelToken.cancel ();
176+ await Future <void >.delayed (Duration .zero);
177+ expect (sourceCancelCount, 1 );
178+ expect (closeCount, 0 );
179+ });
180+ }
181+ });
182+
10183 group (handleResponseStream, () {
11184 late StreamController <Uint8List > source;
12185
@@ -392,3 +565,20 @@ void main() {
392565 });
393566 });
394567}
568+
569+ class _StreamingAdapter implements HttpClientAdapter {
570+ _StreamingAdapter (this .response);
571+
572+ final ResponseBody response;
573+
574+ @override
575+ Future <ResponseBody > fetch (
576+ RequestOptions options,
577+ Stream <Uint8List >? requestStream,
578+ Future <void >? cancelFuture,
579+ ) async =>
580+ response;
581+
582+ @override
583+ void close ({bool force = false }) {}
584+ }
0 commit comments