fake_api: Support preparing a queue of responses.

To preserve the original behavior, we add a flag that enables appending
responses only when it is set to true.

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

test/api/fake_api.dart

@@ -1,3 +1,4 @@
+import 'dart:collection';
 import 'dart:convert';
 
 import 'package:flutter/foundation.dart';
@@ -37,10 +38,9 @@ class FakeHttpClient extends http.BaseClient {
     return result;
   }
 
-  _PreparedResponse? _nextResponse;
+  final Queue<_PreparedResponse> _preparedResponses = Queue();
 
-  // Please add more features to this mocking API as needed.  For example:
-  //  * preparing more than one request, and logging more than one request
+  // Please add more features to this mocking API as needed.
 
   /// Prepare the response for the next request.
   ///
@@ -49,40 +49,44 @@ class FakeHttpClient extends http.BaseClient {
   /// will be `body` if non-null, or `jsonEncode(json)` if `json` is non-null,
   /// or else ''.  The `body` and `json` parameters must not both be non-null.
   ///
-  /// If `exception` is non-null, then `httpStatus`, `body`, and `json` must
-  /// all be null, and the next request will throw the given exception.
+  /// If `exception` is non-null, then `httpStatus`, `body`, and `json` must all
+  /// be null, and the next request will throw the given exception.
+  ///
+  /// If `append` is true, the prepared response will be added to a First-in
+  /// First-out responses queue.
   void prepare({
     Object? exception,
     int? httpStatus,
     Map<String, dynamic>? json,
     String? body,
     Duration delay = Duration.zero,
+    bool append = false,
   }) {
-    assert(_nextResponse == null,
+    assert(append || _preparedResponses.isEmpty,
       'FakeApiConnection.prepare was called while already expecting a request');
     if (exception != null) {
       assert(httpStatus == null && json == null && body == null);
-      _nextResponse = _PreparedException(exception: exception, delay: delay);
+      _preparedResponses.addLast(_PreparedException(exception: exception, delay: delay));
     } else {
       assert((json == null) || (body == null));
       final String resolvedBody = switch ((body, json)) {
         (var body?, _) => body,
         (_, var json?) => jsonEncode(json),
         _              => '',
       };
-      _nextResponse = _PreparedSuccess(
+      _preparedResponses.addLast(_PreparedSuccess(
         httpStatus: httpStatus ?? 200,
         bytes: utf8.encode(resolvedBody),
         delay: delay,
-      );
+      ));
     }
   }
 
   @override
   Future<http.StreamedResponse> send(http.BaseRequest request) {
     previousRequests.add(request);
 
-    if (_nextResponse == null) {
+    if (_preparedResponses.isEmpty) {
       throw FlutterError.fromParts([
         ErrorSummary(
           'An API request was attempted in a test when no response was prepared.'),
@@ -91,8 +95,7 @@ class FakeHttpClient extends http.BaseClient {
           'call to [FakeApiConnection.prepare].'),
       ]);
     }
-    final response = _nextResponse!;
-    _nextResponse = null;
+    final response = _preparedResponses.removeFirst();
 
     final http.StreamedResponse Function() computation;
     switch (response) {
@@ -221,17 +224,22 @@ class FakeApiConnection extends ApiConnection {
   ///
   /// In either case, the next request will complete a duration of `delay`
   /// after being started.
+  ///
+  /// If `append` is true, the prepared response will be added to a First-in
+  /// First-out responses queue.
   void prepare({
     Object? exception,
     int? httpStatus,
     Map<String, dynamic>? json,
     String? body,
     Duration delay = Duration.zero,
+    bool append = false,
   }) {
     client.prepare(
       exception: exception,
       httpStatus: httpStatus, json: json, body: body,
       delay: delay,
+      append: append,
     );
   }
 }