test [nfc]: Introduce eg.apiBadRequest

This changes the message string in a few of the call sites, where
the string was already an arbitrary one rather than a realistic
specific string.  That's still NFC because the tests weren't
depending on the specific string.

Author: gnprice

test/api/route/messages_test.dart

@@ -65,12 +65,8 @@ void main() {
     test('modern; message not found', () {
       return FakeApiConnection.with_((connection) async {
         final message = eg.streamMessage();
-        final fakeResponseJson = {
-          'code': 'BAD_REQUEST',
-          'msg': 'Invalid message(s)',
-          'result': 'error',
-        };
-        connection.prepare(httpStatus: 400, json: fakeResponseJson);
+        connection.prepare(
+          apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
         final result = await checkGetMessageCompat(connection,
           expectLegacy: false,
           messageId: message.id,

test/example_data.dart

@@ -27,6 +27,18 @@ Object nullCheckError() {
   try { null!; } catch (e) { return e; } // ignore: null_check_always_fails
 }
 
+/// A Zulip API error with the generic "BAD_REQUEST" error code.
+///
+/// The server returns this error code for a wide range of error conditions;
+/// it's the default within the server code when no more-specific code is chosen.
+ZulipApiException apiBadRequest({
+    String routeName = 'someRoute', String message = 'Something failed'}) {
+  return ZulipApiException(
+    routeName: routeName,
+    httpStatus: 400, code: 'BAD_REQUEST',
+    data: {}, message: message);
+}
+
 /// The error the server gives when the client's credentials
 /// (API key together with email and realm URL) are no longer valid.
 ///

test/model/message_list_test.dart

@@ -247,8 +247,7 @@ void main() {
     await prepareMessages(foundOldest: false, messages: initialMessages);
     check(connection.takeRequests()).single;
 
-    connection.prepare(httpStatus: 400, json: {
-      'result': 'error', 'code': 'BAD_REQUEST', 'msg': 'Bad request'});
+    connection.prepare(apiException: eg.apiBadRequest());
     check(async.pendingTimers).isEmpty();
     await check(model.fetchOlder()).throws<ZulipApiException>();
     checkNotified(count: 2);
@@ -1061,8 +1060,7 @@ void main() {
         addTearDown(() => BackoffMachine.debugDuration = null);
         await prepareNarrow(narrow, initialMessages);
 
-        connection.prepare(httpStatus: 400, json: {
-          'result': 'error', 'code': 'BAD_REQUEST', 'msg': 'Bad request'});
+        connection.prepare(apiException: eg.apiBadRequest());
         BackoffMachine.debugDuration = const Duration(seconds: 1);
         await check(model.fetchOlder()).throws<ZulipApiException>();
         final backoffTimerA = async.pendingTimers.single;
@@ -1094,8 +1092,7 @@ void main() {
         check(model).fetchOlderCoolingDown.isFalse();
         check(backoffTimerA.isActive).isTrue();
 
-        connection.prepare(httpStatus: 400, json: {
-          'result': 'error', 'code': 'BAD_REQUEST', 'msg': 'Bad request'});
+        connection.prepare(apiException: eg.apiBadRequest());
         BackoffMachine.debugDuration = const Duration(seconds: 2);
         await check(model.fetchOlder()).throws<ZulipApiException>();
         final backoffTimerB = async.pendingTimers.last;

test/widgets/action_sheet_test.dart

@@ -100,12 +100,7 @@ void main() {
   }
 
   void prepareRawContentResponseError() {
-    final fakeResponseJson = {
-      'code': 'BAD_REQUEST',
-      'msg': 'Invalid message(s)',
-      'result': 'error',
-    };
-    connection.prepare(httpStatus: 400, json: fakeResponseJson);
+    connection.prepare(apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
   }
 
   group('topic action sheet', () {
@@ -377,8 +372,7 @@ void main() {
           isChannelMuted: false,
           visibilityPolicy: UserTopicVisibilityPolicy.followed);
 
-        connection.prepare(httpStatus: 400, json: {
-          'result': 'error', 'code': 'BAD_REQUEST', 'msg': ''});
+        connection.prepare(apiException: eg.apiBadRequest());
         await tester.tap(unfollow);
         await tester.pumpAndSettle();
 
@@ -629,11 +623,8 @@ void main() {
           final message = eg.streamMessage();
           await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
 
-          connection.prepare(httpStatus: 400, json: {
-            'code': 'BAD_REQUEST',
-            'msg': 'Invalid message(s)',
-            'result': 'error',
-          });
+          connection.prepare(
+            apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
           await tapButton(tester);
           await tester.pump(Duration.zero); // error arrives; error dialog shows
 
@@ -698,11 +689,8 @@ void main() {
         await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
         final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
 
-        connection.prepare(httpStatus: 400, json: {
-          'code': 'BAD_REQUEST',
-          'msg': 'Invalid message(s)',
-          'result': 'error',
-        });
+        connection.prepare(
+          apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
         await tapButton(tester);
         await tester.pump(Duration.zero); // error arrives; error dialog shows
 
@@ -716,11 +704,8 @@ void main() {
         await setupToMessageActionSheet(tester, message: message, narrow: TopicNarrow.ofMessage(message));
         final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
 
-        connection.prepare(httpStatus: 400, json: {
-          'code': 'BAD_REQUEST',
-          'msg': 'Invalid message(s)',
-          'result': 'error',
-        });
+        connection.prepare(
+          apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
         await tapButton(tester, starred: true);
         await tester.pump(Duration.zero); // error arrives; error dialog shows
 

test/widgets/compose_box_test.dart

@@ -553,13 +553,8 @@ void main() {
 
     testWidgets('ZulipApiException', (tester) async {
       await setupAndTapSend(tester, prepareResponse: (message) {
-        connection.prepare(
-          httpStatus: 400,
-          json: {
-            'result': 'error',
-            'code': 'BAD_REQUEST',
-            'msg': 'You do not have permission to initiate direct message conversations.',
-          });
+        connection.prepare(apiException: eg.apiBadRequest(
+          message: 'You do not have permission to initiate direct message conversations.'));
       });
       final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
       await tester.tap(find.byWidget(checkErrorDialog(tester,

test/widgets/emoji_reaction_test.dart

@@ -452,12 +452,7 @@ void main() {
 
       connection.prepare(
         delay: const Duration(seconds: 2),
-        httpStatus: 400, json: {
-          'code': 'BAD_REQUEST',
-          'msg': 'Invalid message(s)',
-          'result': 'error',
-        });
-
+        apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
       await tester.tap(find.descendant(
         of: find.byType(BottomSheet),
         matching: find.text('\u{1f4a4}'))); // 'zzz' emoji

test/widgets/message_list_test.dart

@@ -595,15 +595,10 @@ void main() {
           await setupMessageListPage(tester,
             narrow: narrow, messages: [message], unreadMsgs: unreadMsgs);
           check(isMarkAsReadButtonVisible(tester)).isTrue();
-
-          connection.prepare(httpStatus: 400, json: {
-            'code': 'BAD_REQUEST',
-            'msg': 'Invalid message(s)',
-            'result': 'error',
-          });
-
           checkAppearsLoading(tester, false);
 
+          connection.prepare(
+            apiException: eg.apiBadRequest(message: 'Invalid message(s)'));
           await tester.tap(find.byType(MarkAsReadWidget));
           await tester.pump();
           checkAppearsLoading(tester, true);