test [nfc]: Introduce apiExceptionBadEventQueueId

This is another common type of error that is expected to be reused
more later

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

Author: PIG208

test/example_data.dart

@@ -39,6 +39,18 @@ ZulipApiException apiBadRequest({
     data: {}, message: message);
 }
 
+/// The error for the "events" route when the target event queue has been
+/// garbage collected.
+///
+/// https://zulip.com/api/get-events#bad_event_queue_id-errors
+ZulipApiException apiExceptionBadEventQueueId({
+  String queueId = 'fb67bf8a-c031-47cc-84cf-ed80accacda8',
+}) {
+  return ZulipApiException(
+    routeName: 'events', httpStatus: 400, code: 'BAD_EVENT_QUEUE_ID',
+    data: {'queue_id': queueId}, message: 'Bad event queue ID: $queueId');
+}
+
 /// The error the server gives when the client's credentials
 /// (API key together with email and realm URL) are no longer valid.
 ///

test/model/store_test.dart

@@ -757,11 +757,8 @@ void main() {
     }
 
     void prepareExpiredEventQueue() {
-      connection.prepare(httpStatus: 400, json: {
-        'result': 'error', 'code': 'BAD_EVENT_QUEUE_ID',
-        'queue_id': updateMachine.queueId,
-        'msg': 'Bad event queue ID: ${updateMachine.queueId}',
-      });
+      connection.prepare(apiException: eg.apiExceptionBadEventQueueId(
+        queueId: updateMachine.queueId));
     }
 
     Future<void> prepareHandleEventError() async {

test/widgets/message_list_test.dart

@@ -7,7 +7,6 @@ import 'package:flutter/rendering.dart';
 import 'package:flutter_checks/flutter_checks.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:http/http.dart' as http;
-import 'package:zulip/api/exception.dart';
 import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/initial_snapshot.dart';
 import 'package:zulip/api/model/model.dart';
@@ -143,9 +142,8 @@ void main() {
       updateMachine.debugPauseLoop();
       updateMachine.poll();
 
-      updateMachine.debugPrepareLoopError(ZulipApiException(
-        routeName: 'events', httpStatus: 400, code: 'BAD_EVENT_QUEUE_ID',
-        data: {'queue_id': updateMachine.queueId}, message: 'Bad event queue ID.'));
+      updateMachine.debugPrepareLoopError(
+        eg.apiExceptionBadEventQueueId(queueId: updateMachine.queueId));
       updateMachine.debugAdvanceLoop();
       await tester.pump();
       // Event queue has been replaced; but the [MessageList] hasn't been