Skip to content

test: Get route-transition duration robustly,instead of hard-coding #1920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MdSaifAliMolla wants to merge 3 commits into
base: main
Choose a base branch
from
+33 −22
Open

test: Get route-transition duration robustly,instead of hard-coding #1920

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8bbc189
test: Use transitionDurationObserver in emoji_reaction_test
MdSaifAliMolla Oct 31, 2025
2101dfd
test: Use transitionDurationObserver in action_sheet_test
MdSaifAliMolla Oct 31, 2025
6cbfe0b
test: Use TransitionDurationObserver in compose_box_test
MdSaifAliMolla Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions test/widgets/action_sheet_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ Future<void> setupToMessageActionSheet(WidgetTester tester, {
// the long-press might land where no child hit-tests as true,
// like if it's in padding around a Paragraph.
await tester.longPress(find.byType(MessageContent), warnIfMissed: false);
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);
// Check the action sheet did in fact open, so we don't defeat any tests that
// use simple `find.byIcon`-style checks to test presence/absence of a button.
check(find.byType(BottomSheet)).findsOne();
Expand Down Expand Up @@ -199,26 +199,29 @@ void main() {
check(find.byType(InboxPageBody)).findsOne();

await tester.longPress(find.text(someChannel.name).hitTestable());
await tester.pump(const Duration(milliseconds: 250));
await transitionDurationObserver.pumpPastTransition(tester);
}

Future<void> showFromSubscriptionList(WidgetTester tester) async {
transitionDurationObserver = TransitionDurationObserver();
Comment on lines 205 to +206
Copy link
Member

@gnprice gnprice Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm — it seems awfully messy for there to be so many different functions that are setting this shared variable. When does it need to get set? How did you confirm for yourself that you've set it in all of the places it needs to get set in?

In short, this setup seems likely to cause bugs.

await tester.pumpWidget(TestZulipApp(accountId: eg.selfAccount.id,
navigatorObservers: [transitionDurationObserver],
child: const HomePage()));
await tester.pump();
await tester.tap(find.byIcon(ZulipIcons.hash_italic));
await tester.pump();
check(find.byType(SubscriptionListPageBody)).findsOne();

await tester.longPress(find.text(someChannel.name).hitTestable());
await tester.pump(const Duration(milliseconds: 250));
await transitionDurationObserver.pumpPastTransition(tester);
}

Future<void> showFromMsglistAppBar(WidgetTester tester, {
ZulipStream? channel,
required Narrow narrow,
}) async {
channel ??= someChannel;
transitionDurationObserver = TransitionDurationObserver();

connection.prepare(json: eg.newestGetMessagesResult(
foundOldest: true, messages: []).toJson());
Expand All @@ -229,31 +232,34 @@ void main() {
}
await tester.pumpWidget(TestZulipApp(
accountId: eg.selfAccount.id,
navigatorObservers: [transitionDurationObserver],
child: MessageListPage(
initNarrow: narrow)));
await tester.pumpAndSettle();

await tester.longPress(find.descendant(
of: find.byType(ZulipAppBar),
matching: find.text(channel.name)));
await tester.pump(const Duration(milliseconds: 250));
await transitionDurationObserver.pumpPastTransition(tester);
}

Future<void> showFromRecipientHeader(WidgetTester tester, {
StreamMessage? message,
}) async {
message ??= someMessage;
transitionDurationObserver = TransitionDurationObserver();

connection.prepare(json: eg.newestGetMessagesResult(
foundOldest: true, messages: [message]).toJson());
await tester.pumpWidget(TestZulipApp(accountId: eg.selfAccount.id,
navigatorObservers: [transitionDurationObserver],
child: const MessageListPage(initNarrow: CombinedFeedNarrow())));
await tester.pumpAndSettle();

await tester.longPress(find.descendant(
of: find.byType(RecipientHeader),
matching: find.text(message.displayRecipient ?? '')));
await tester.pump(const Duration(milliseconds: 250));
await transitionDurationObserver.pumpPastTransition(tester);
}

Future<void> showFromTopicListAppBar(WidgetTester tester, {int? streamId}) async {
Expand Down Expand Up @@ -738,8 +744,8 @@ void main() {
check(find.byType(InboxPageBody)).findsOne();

await tester.longPress(find.text(topic));
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);
Copy link
Member

@gnprice gnprice Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this instance, we're using transitionDurationObserver and it appears to work, even though a few lines above here there was a pumpWidget(TestZulipApp(… and it didn't pass navigatorObservers.

Does that mean we don't need to set navigatorObservers after all in the other "showFoo" functions where this PR adds it? Or, conversely, is it a bug that we're not setting it here?

}

Future<void> showFromAppBar(WidgetTester tester, {
Expand All @@ -765,8 +771,8 @@ void main() {
matching: find.text(
effectiveTopic.displayName ?? eg.defaultRealmEmptyTopicDisplayName));
await tester.longPress(topicRow);
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);
}

Future<void> showFromRecipientHeader(WidgetTester tester, {
Expand All @@ -784,8 +790,8 @@ void main() {
await tester.longPress(find.descendant(
of: find.byType(RecipientHeader),
matching: find.text(effectiveMessage.topic.displayName!)));
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);
}

final actionSheetFinder = find.byType(BottomSheet);
Expand Down Expand Up @@ -2049,9 +2055,11 @@ void main() {
delay: const Duration(milliseconds: 500));
await tapCopyMessageTextButton(tester);
// … and pump a frame to finish the NavigationState.pop animation…
await tester.pump(const Duration(milliseconds: 250));
await transitionDurationObserver.pumpPastTransition(tester);
// … before the request finishes. This is the repro condition for #732.
await tester.pump(const Duration(milliseconds: 250));
await tester.pump(Duration(milliseconds: 500));
// … pump for snackbar to show; default duration of snackbar enter animation
await tester.pump(Duration(milliseconds: 250));
Comment on lines 2059 to +2062
Copy link
Member

@gnprice gnprice Dec 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this change about? (And what does the comment mean? It doesn't seem to make any sense syntactically — this new comment line starts with a "…" as if it's continuing something, but the previous comment ends with a "." and the end of a sentence.)


final snackbar = tester.widget<SnackBar>(find.byType(SnackBar));
check(snackbar.behavior).equals(SnackBarBehavior.floating);
Expand Down Expand Up @@ -2282,8 +2290,8 @@ void main() {

// See comment in setupToMessageActionSheet about warnIfMissed: false
await tester.longPress(find.byType(MessageContent), warnIfMissed: false);
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);
check(find.byType(BottomSheet)).findsOne();
checkButtonIsPresent(expected);

Expand Down
11 changes: 7 additions & 4 deletions test/widgets/compose_box_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ void main() {
late PerAccountStore store;
late FakeApiConnection connection;
late ComposeBoxState state;
late TransitionDurationObserver transitionDurationObserver;

// Caution: when testing edit-message UI, this will often be stale;
// read state.controller instead.
Expand Down Expand Up @@ -96,6 +97,7 @@ void main() {
store = await testBinding.globalStore.perAccount(selfAccount.id);

connection = store.connection as FakeApiConnection;
transitionDurationObserver = TransitionDurationObserver();

connection.prepare(json:
eg.newestGetMessagesResult(foundOldest: true, messages: messages).toJson());
Expand All @@ -104,6 +106,7 @@ void main() {
connection.prepare(json: GetStreamTopicsResult(topics: []).toJson());
}
await tester.pumpWidget(TestZulipApp(accountId: selfAccount.id,
navigatorObservers: [transitionDurationObserver],
child: MessageListPage(initNarrow: narrow)));
await tester.pumpAndSettle();
connection.takeRequests();
Expand Down Expand Up @@ -1718,8 +1721,8 @@ void main() {
}) async {
await tester.longPress(find.byWidgetPredicate((widget) =>
widget is MessageWithPossibleSender && widget.item.message.id == messageId));
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);
final findEditButton = find.descendant(
of: find.byType(BottomSheet),
matching: find.byIcon(ZulipIcons.edit, skipOffstage: false));
Expand Down Expand Up @@ -1875,7 +1878,7 @@ void main() {
await startEditInteractionFromActionSheet(tester, messageId: messageToEdit.id,
originalRawContent: 'message to edit',
delay: Duration.zero);
await tester.pump(const Duration(milliseconds: 250)); // bottom-sheet animation
await transitionDurationObserver.pumpPastTransition(tester); // bottom-sheet animation

await tester.tap(failedMessageFinder);
await tester.pump();
Expand All @@ -1899,7 +1902,7 @@ void main() {
await startEditInteractionFromActionSheet(tester, messageId: messageToEdit.id,
originalRawContent: 'message to edit',
delay: Duration.zero);
await tester.pump(const Duration(milliseconds: 250)); // bottom-sheet animation
await transitionDurationObserver.pumpPastTransition(tester); // bottom-sheet animation

await tester.tap(failedMessageFinder);
await tester.pump();
Expand Down
4 changes: 2 additions & 2 deletions test/widgets/emoji_reaction_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,8 +433,8 @@ void main() {
await tester.pumpAndSettle();
// request the message action sheet
await tester.longPress(find.byType(MessageContent));
// sheet appears onscreen; default duration of bottom-sheet enter animation
await tester.pump(const Duration(milliseconds: 250));
// sheet appears onscreen
await transitionDurationObserver.pumpPastTransition(tester);

await store.handleEvent(RealmEmojiUpdateEvent(id: 1, realmEmoji: {
'1': eg.realmEmojiItem(emojiCode: '1', emojiName: 'buzzing'),
Expand Down