msglist: Follow user_settings.twenty_four_hour_time for message timestamps

Fixes-partly: #1015

Author: chrisbobbe

lib/widgets/message_list.dart

@@ -2019,25 +2019,18 @@ enum MessageTimestampStyle {
   static final _timeFormat24WithSeconds =            DateFormat('Hms');
   static final _timeFormatLocaleDefaultWithSeconds = DateFormat('jms');
 
-  // ignore: unused_element
   static DateFormat _resolveTimeFormat(TwentyFourHourTimeMode mode) => switch (mode) {
     TwentyFourHourTimeMode.twelveHour => _timeFormat12,
     TwentyFourHourTimeMode.twentyFourHour => _timeFormat24,
     TwentyFourHourTimeMode.localeDefault => _timeFormatLocaleDefault,
   };
 
-  // ignore: unused_element
   static DateFormat _resolveTimeFormatWithSeconds(TwentyFourHourTimeMode mode) => switch (mode) {
     TwentyFourHourTimeMode.twelveHour => _timeFormat12WithSeconds,
     TwentyFourHourTimeMode.twentyFourHour => _timeFormat24WithSeconds,
     TwentyFourHourTimeMode.localeDefault => _timeFormatLocaleDefaultWithSeconds,
   };
 
-  static final _lightboxFormat =
-    DateFormat.yMMMd().addPattern(_timeFormat24WithSeconds.pattern);
-  static final _fullFormat =
-    DateFormat.yMMMd().addPattern(_timeFormatLocaleDefault.pattern);
-
   /// Format a [Message.timestamp] for this mode.
   // TODO(i18n): locale-specific formatting (see #45 for a plan with ffi)
   String? format(
@@ -2054,9 +2047,18 @@ enum MessageTimestampStyle {
       case dateOnlyRelative:
         return _formatDateOnlyRelative(asDateTime,
           now: now, zulipLocalizations: zulipLocalizations);
-      case timeOnly: return _timeFormat12.format(asDateTime);
-      case lightbox: return _lightboxFormat.format(asDateTime);
-      case full: return _fullFormat.format(asDateTime);
+      case timeOnly:
+        return _resolveTimeFormat(twentyFourHourTimeMode).format(asDateTime);
+      case lightbox:
+        return DateFormat
+          .yMMMd()
+          .addPattern(_resolveTimeFormatWithSeconds(twentyFourHourTimeMode).pattern)
+          .format(asDateTime);
+      case full:
+        return DateFormat
+          .yMMMd()
+          .addPattern(_resolveTimeFormat(twentyFourHourTimeMode).pattern)
+          .format(asDateTime);
     }
   }
 }

test/widgets/lightbox_test.dart

@@ -382,12 +382,12 @@ void main() {
       await setupPage(tester, message: message, thumbnailUrl: null, users: [sender]);
       check(store.getUser(sender.userId)).isNotNull();
 
-      checkAppBarNameAndDate(tester, 'Old name', 'Jul 23, 2024 23:12:24');
+      checkAppBarNameAndDate(tester, 'Old name', 'Jul 23, 2024 11:12:24 PM');
 
       await store.handleEvent(RealmUserUpdateEvent(id: 1,
         userId: sender.userId, fullName: 'New name'));
       await tester.pump();
-      checkAppBarNameAndDate(tester, 'New name', 'Jul 23, 2024 23:12:24');
+      checkAppBarNameAndDate(tester, 'New name', 'Jul 23, 2024 11:12:24 PM');
 
       debugNetworkImageHttpClientProvider = null;
     });
@@ -400,7 +400,7 @@ void main() {
       await setupPage(tester, message: message, thumbnailUrl: null, users: []);
       check(store.getUser(sender.userId)).isNull();
 
-      checkAppBarNameAndDate(tester, 'Sender name', 'Jul 23, 2024 23:12:24');
+      checkAppBarNameAndDate(tester, 'Sender name', 'Jul 23, 2024 11:12:24 PM');
 
       debugNetworkImageHttpClientProvider = null;
     });

test/widgets/message_list_test.dart

@@ -1641,55 +1641,76 @@ void main() {
   group('MessageTimestampStyle', () {
     void doTests(
       MessageTimestampStyle style,
-      List<(String timestampStr, String? expected)> cases, {
+      List<(
+        String timestampStr,
+        String? expectedTwelveHour,
+        String? expectedTwentyFourHour,
+      )> cases, {
       DateTime? now,
     }) {
       now ??= DateTime.parse("2023-01-10 12:00");
-      for (final (timestampStr, expected) in cases) {
-        test('${style.name}: $timestampStr returns $expected', () {
-          addTearDown(testBinding.reset);
-          final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
-
-          withClock(Clock.fixed(now!), () {
-            final timestamp = DateTime.parse(timestampStr)
-              .millisecondsSinceEpoch ~/ 1000;
-            final result = style.format(
-              timestamp,
-              now: testBinding.utcNow().toLocal(),
-              twentyFourHourTimeMode: TwentyFourHourTimeMode.localeDefault,
-              zulipLocalizations: zulipLocalizations);
-            check(result).equals(expected);
+      for (final (timestampStr, expectedTwelveHour, expectedTwentyFourHour) in cases) {
+        for (final mode in TwentyFourHourTimeMode.values) {
+          final expected = switch (mode) {
+            TwentyFourHourTimeMode.twelveHour => expectedTwelveHour,
+            TwentyFourHourTimeMode.twentyFourHour => expectedTwentyFourHour,
+            // This expectation will hold as long as we're always using the
+            // default locale, en_US, which uses the twelve-hour format.
+            // TODO(#1727) test with other locales
+            TwentyFourHourTimeMode.localeDefault => expectedTwelveHour,
+          };
+
+          test('${style.name} in ${mode.name}: $timestampStr returns $expected', () {
+            addTearDown(testBinding.reset);
+            final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
+
+            withClock(Clock.fixed(now!), () {
+              final timestamp = DateTime.parse(timestampStr)
+                .millisecondsSinceEpoch ~/ 1000;
+              final result = style.format(
+                timestamp,
+                now: testBinding.utcNow().toLocal(),
+                twentyFourHourTimeMode: mode,
+                zulipLocalizations: zulipLocalizations);
+              check(result).equals(expected);
+            });
           });
-        });
+        }
       }
     }
 
     for (final style in MessageTimestampStyle.values) {
       switch (style) {
         case MessageTimestampStyle.none:
-          doTests(style, [('2023-01-10 12:00', null)]);
+          doTests(style, [('2023-01-10 12:00', null, null)]);
         case MessageTimestampStyle.dateOnlyRelative:
           final zulipLocalizations = GlobalLocalizations.zulipLocalizations;
           doTests(style,
             now: DateTime.parse("2023-01-10 12:00"),
             [
-              ("2023-01-10 12:00", zulipLocalizations.today),
-              ("2023-01-10 00:00", zulipLocalizations.today),
-              ("2023-01-10 23:59", zulipLocalizations.today),
-              ("2023-01-09 23:59", zulipLocalizations.yesterday),
-              ("2023-01-09 00:00", zulipLocalizations.yesterday),
-              ("2023-01-08 00:00", "Jan 8"),
-              ("2022-12-31 00:00", "Dec 31, 2022"),
+              ("2023-01-10 12:00", zulipLocalizations.today,     zulipLocalizations.today),
+              ("2023-01-10 00:00", zulipLocalizations.today,     zulipLocalizations.today),
+              ("2023-01-10 23:59", zulipLocalizations.today,     zulipLocalizations.today),
+              ("2023-01-09 23:59", zulipLocalizations.yesterday, zulipLocalizations.yesterday),
+              ("2023-01-09 00:00", zulipLocalizations.yesterday, zulipLocalizations.yesterday),
+              ("2023-01-08 00:00", "Jan 8", "Jan 8"),
+              ("2022-12-31 00:00", "Dec 31, 2022", "Dec 31, 2022"),
               // Future times
-              ("2023-01-10 19:00", zulipLocalizations.today),
-              ("2023-01-11 00:00", "Jan 11, 2023"),
+              ("2023-01-10 19:00", zulipLocalizations.today, zulipLocalizations.today),
+              ("2023-01-11 00:00", "Jan 11, 2023", "Jan 11, 2023"),
             ]);
         case MessageTimestampStyle.timeOnly:
-          doTests(style, [('2023-01-10 12:00', '12:00 PM')]);
+          doTests(style, [('2023-01-10 12:00', '12:00 PM', '12:00')]);
         case MessageTimestampStyle.lightbox:
-          doTests(style, [('2023-01-10 12:00', 'Jan 10, 2023 12:00:00')]);
+          doTests(style,
+            [('2023-01-10 12:00',
+              'Jan 10, 2023 12:00:00 PM',
+              'Jan 10, 2023 12:00:00')]);
         case MessageTimestampStyle.full:
-          doTests(style, [('2023-01-10 12:00', 'Jan 10, 2023 12:00 PM')]);
+          doTests(style,
+            [('2023-01-10 12:00',
+              'Jan 10, 2023 12:00 PM',
+              'Jan 10, 2023 12:00')]);
       }
     }
   });