wip msglist: Fix speed calculations in scroll to bottom; TODO issue

This logic for deciding how long the scroll-to-bottom animation
should take, introduced in 5abeb88 (zulip#223), didn't have any tests.

As a result, when its unstated assumption about the message list --
that scrolling up from the end was represented by positive scroll
positions -- was broken a few months later (in bdac26f), nothing
alerted us to that.

I did notice a few times over the past year or so that the effect of
the scroll-to-bottom button seemed jerky, as if it were trying to
move much farther in each frame than it should.  Now I know why.

(Discovered this in the course of revisiting this code in order to
adapt it to the more radical change to the message list's scroll
positions which is coming up: "zero" won't be the end, but somewhere
in the middle.)

Author: gnprice

lib/widgets/message_list.dart

@@ -697,11 +697,12 @@ class ScrollToBottomButton extends StatelessWidget {
   final ScrollController scrollController;
 
   Future<void> _scrollToBottom() {
-    final distance = scrollController.position.pixels;
+    final target = 0.0;
+    final distance = target - scrollController.position.pixels;
     final durationMsAtSpeedLimit = (1000 * distance / 8000).ceil();
     final durationMs = max(300, durationMsAtSpeedLimit);
     return scrollController.animateTo(
-      0,
+      target,
       duration: Duration(milliseconds: durationMs),
       curve: Curves.ease);
   }

test/widgets/message_list_test.dart

@@ -510,6 +510,40 @@ void main() {
       // … and for good measure confirm the button disappeared.
       check(isButtonVisible(tester)).equals(false);
     });
+
+    testWidgets('scrolls at reasonable speed', (tester) async {
+      const referenceSpeed = 8000.0;
+      const distance = 40000.0;
+      await setupMessageListPage(tester, messageCount: 1000);
+      final controller = findMessageListScrollController(tester)!;
+
+      // Scroll a long distance up, many screenfuls.
+      controller.jumpTo(-distance);
+      await tester.pump();
+      check(controller.position.pixels).equals(-distance);
+
+      // Tap button.
+      await tester.tap(find.byType(ScrollToBottomButton));
+      await tester.pump();
+
+      // Measure speed.
+      final log = <double>[];
+      double pos = controller.position.pixels;
+      while (pos < 0) {
+        check(log.length).isLessThan(30);
+        await tester.pump(const Duration(seconds: 1));
+        final lastPos = pos;
+        pos = controller.position.pixels;
+        log.add(pos - lastPos);
+      }
+      // Check the main question: the speed stayed in range throughout.
+      const maxSpeed = 2 * referenceSpeed;
+      check(log).every((it) => it..isGreaterThan(0)..isLessThan(maxSpeed));
+      // Also check the test's assumptions: the scroll reached the end…
+      check(pos).equals(0);
+      // … and scrolled far enough to effectively test the max speed.
+      check(log.sum).isGreaterThan(2 * maxSpeed);
+    });
   });
 
   group('TypingStatusWidget', () {