Add intro modals for Inbox and Combined Feed by khanak0509 · Pull Request #2045 · zulip/zulip-flutter

khanak0509 · 2025-12-20T16:21:10Z

Fixes: #1856
Adds one-time intro modals for inbox and combined feed screens to help new users understand what each view shows.

screenshots -

as mentioned in issue description and CZO discussion: #mobile > Intro video? intro is showing once per install of the app even if they login again . and if they reinstall the add it will visible again .

Tested on iOS emulator:
(1) Fresh install shows both modals on first visit
(2)Modals don't reappear after tapping "Got it"
(3) Modals stay dismissed across app restarts
(4) Reinstalling app shows modals again

video of testing
https://drive.google.com/file/d/1vg3yrCxwh44TSUv6730K7Lr-CPrxI1cm/view?usp=sharing

all tests passed

gnprice · 2025-12-21T01:55:43Z

See the project's README:
https://github.com/zulip/zulip-flutter#submitting-a-pull-request

Before we can review this PR, it will need tests.

khanak0509 · 2025-12-21T09:27:57Z

now I have added test and also added test detection code in dialog.dart
because the in test mode inbox_test.dart create InboxPage widgets, the modal pops up , When message_list_test.dart creates message list widgets, the modal pops up , and due to this I was getting 45 test failures because it is blocking ui

but when I added test detection it solved
now all tests are passing

chrisbobbe · 2025-12-23T20:20:25Z

See the project's README:
https://github.com/zulip/zulip-flutter#submitting-a-pull-request

Before we can review this PR, it will need to be organized into clear and coherent commits, following Zulip's commit style guide.

khanak0509 · 2025-12-26T04:26:10Z

@gnprice @chrisbobbe now could you please review it ?

gnprice · 2026-01-06T01:38:26Z

This still makes a number of irrelevant changes to other parts of the code.

@khanak0509 Before you ask others to spend time reviewing your work, you need to take the time to review it carefully yourself. See the discussion in our README (linked twice above) and in the Zulip contributing guide linked from there.

khanak0509 · 2026-01-06T04:06:17Z

Done with all the changes. Also, in lib/widgets/dialog.dart at line 188, I intentionally made this change and added curly brackets because I was getting ->

gnprice · 2026-01-06T20:56:15Z

OK, that's clean enough to be reviewed.

This still needs tests, though. The tests need to check that the app satisfies the main point of the issue: when the user first visits the inbox or combined feed, they get the intro modal, and when they visit again, they don't.

The current version adds some test cases in test/widgets/dialog_test.dart, but these are "unit tests" of the kind that don't really get to the main point.

I gave a talk last year at Fluttercon USA about how to write good tests, including more details and examples about this point. I recommend watching that talk.

khanak0509 · 2026-01-07T18:07:30Z

Thanks for sharing this. I watched it and understood the difference between unit tests and integration tests.
I have tried to implement an integration test to check whether the app satisfies the main requirement of the issue when a user visits the inbox or combined feed for the first time, they see the intro modal, and when they visit again, they don’t, as you mentioned.
Could you please let me know whether I’m on the right track or not?

gnprice · 2026-01-15T00:02:26Z

Great, glad that was helpful. This revision is closer: it effectively tests most of the behavior of showInboxIntroModal and showCombinedFeedIntroModal.

From the user's perspective, though, they don't call a function showInboxIntroModal; they visit the inbox page. So what we'd really like is a test that simulates that.

In particular, this version would still pass if the call to showInboxIntroModal were to get accidentally deleted from the InboxPage code. The tests we'd like to have here would correctly fail if that happened.

The other remaining piece for making these into end-to-end, user-oriented tests is that the tests should check the titles on the dialogs. As is, the tests would still pass if the dialogs accidentally had their titles swapped.

khanak0509 · 2026-01-15T04:07:16Z

OK, now I understood! . In the inbox test, I should navigate to HomePage() instead of calling showInboxIntroModal() directly, and same for combined feed navigate to MsgListPage() instead of calling the function. Based on this, I've made the changes. now is it fine ?

gnprice · 2026-02-12T07:11:59Z

Yep! That's the right way for the tests to work.

There are other comments to make about more specific aspects of these tests, but I'll leave that for maintainer review.

sm-sayedi · 2026-02-18T04:08:45Z

@khanak0509 Can you please resolve the conflicts?

sm-sayedi

Thanks @khanak0509 for working on this. I've gone through all the non-test changes. A few comments below.

For how to arrange changes in coherent commits, please read through the commit-discipline carefully.

For the next revision, please make sure to keep the branch up-to-date with the main.

sm-sayedi · 2026-02-18T07:55:15Z

lib/model/settings.dart

+  inboxIntroModalShown(GlobalSettingType.internal, false),
+  combinedFeedIntroModalShown(GlobalSettingType.internal, false),
+
+


Remove the additional empty lines.

sm-sayedi · 2026-02-18T09:03:32Z

lib/model/settings.dart

  /// A pseudo-setting recording whether the user has been shown the
  /// welcome dialog for upgrading from the legacy app.
  upgradeWelcomeDialogShown(GlobalSettingType.internal, false),
+  inboxIntroModalShown(GlobalSettingType.internal, false),


Let's add dartdocs for the two new values. Also, separate the new values by adding blank lines before each one.

sm-sayedi · 2026-02-18T09:04:15Z

lib/widgets/dialog.dart

+    if (!context.mounted) {
+      return; // TODO(linter): this is impossible as there's no actual async gap, but the use_build_context_synchronously lint doesn't see that
+    }


This change shouldn't be necessary once you're updated with main.

Bump on this one! There is no need for the curly braces.

sm-sayedi · 2026-02-18T09:30:23Z

test/widgets/dialog_test.dart

+        matching: find.byType(SingleChildScrollView),)).findsOne();
+    }, variant: TargetPlatformVariant.all(),);


Unnecessary change — the commas are redundant.

sm-sayedi · 2026-02-18T09:39:03Z

lib/widgets/dialog.dart

  }
 }
+
+class IntroModal extends StatelessWidget {


Let's rename this class to IntroDialog to match other classes/methods of the same file.

sm-sayedi · 2026-02-18T10:22:42Z

lib/widgets/dialog.dart

+  }
+}
+
+Future<void> showInboxIntroModal(BuildContext context) async {


Let's move this function and the other one for the combined feed into the IntroModal class. Even better to combine it into one function, similar to UpgradeWelcomeDialog.maybeShow. You can borrow some logic from that function, especially using the navigator BuildContext instead of the local one. This way, there is no need for the code to be wrapped inside addPostFrameCallback.

You can define an enum representing the different kinds of intro modals (dialogs) and pass it to this new function, and show different dialogs based on the value of that enum.

The enum can have the following definition, for now:

enum IntroDialogDestination { inbox, combinedFeed }

sm-sayedi · 2026-02-18T10:28:40Z

lib/widgets/inbox.dart

    recentDmConversationsModel?.removeListener(_modelChanged);
    recentDmConversationsModel = newStore.recentDmConversationsView
      ..addListener(_modelChanged);
+    showInboxIntroModal(context);


With the suggested changes in #2045 (comment), you can call this function inside initState, so that it's called only once per inbox page visit. onNewStore which is called by didChangeDependencies, can be called multiple times in the widget lifecycle, which is overkill for our case now.

Fixes zulip#1856

khanak0509 · 2026-02-18T11:50:48Z

done with the requested changes .

sm-sayedi

Thanks. A few comments below. I still haven't read the tests.

When submitting a (new) revision, make sure the CI is not failing. Also, I think you still haven't read commit-discipline because the commits are not coherent. When you submit a new revision, those changes typically go in the same commits as before. You just need to amend the previous commits. You can check: https://zulip.readthedocs.io/en/latest/git/fixing-commits.html.

sm-sayedi · 2026-02-19T13:00:50Z

lib/widgets/dialog.dart

+    if (!context.mounted) {
+      return; // TODO(linter): this is impossible as there's no actual async gap, but the use_build_context_synchronously lint doesn't see that
+    }


Bump on this one! There is no need for the curly braces.

sm-sayedi · 2026-02-19T13:06:32Z

lib/widgets/dialog.dart

+    if (!context.mounted) {
+      return; // TODO(linter): this is impossible as there's no actual async gap, but the use_build_context_synchronously lint doesn't see that
+    }


nit: Make this one-liner, similar to how it is in UpgradeWelcomeDialog.maybeShow.

sm-sayedi · 2026-02-19T13:07:35Z

lib/widgets/dialog.dart

+      return; // TODO(linter): this is impossible as there's no actual async gap, but the use_build_context_synchronously lint doesn't see that
+    }
+
+    final globalSettings = GlobalStoreWidget.settingsOf(context);


nit: Move this to where it is first used — just before if (globalSettings.getBool(setting)) return;.

sm-sayedi · 2026-02-19T13:09:06Z

lib/widgets/dialog.dart

+      builder: (context) => IntroDialog._(title: title, message: message),
+    );
+
+    await future;


Suggested change

await future;

await future; // Wait for the dialog to be dismissed.

nit: Just like in UpgradeWelcomeDialog.maybeShow.

sm-sayedi · 2026-02-19T13:10:56Z

lib/widgets/dialog.dart

+  final String title;
+  final String message;
+
+  static void maybeShow(IntroDialogDestination destination) async {


Let's rename this to maybeShowIn. It will read more descriptively in its call sites.

sm-sayedi · 2026-02-19T13:12:32Z

lib/widgets/dialog.dart

+      case IntroDialogDestination.inbox:
+        setting = BoolGlobalSetting.inboxIntroModalShown;


Suggested change

case IntroDialogDestination.inbox:

setting = BoolGlobalSetting.inboxIntroModalShown;

case .inbox:

setting = .inboxIntroModalShown;

And the one case below. This is a new Dart feature called "dot shorthands": https://dart.dev/language/dot-shorthands

sm-sayedi · 2026-02-19T13:14:01Z

lib/widgets/inbox.dart

+  @override
+  void initState() {
+    super.initState();
+    IntroDialog.maybeShow(IntroDialogDestination.inbox);


Suggested change

IntroDialog.maybeShow(IntroDialogDestination.inbox);

IntroDialog.maybeShow(.inbox);

Use dot shorthands here and in the other call site for the combined feed.

khanak0509 force-pushed the intro-modals-1856 branch from 515d93e to 14cb420 Compare December 21, 2025 09:19

khanak0509 force-pushed the intro-modals-1856 branch 2 times, most recently from 9a9c7e3 to b319244 Compare December 24, 2025 18:11

khanak0509 force-pushed the intro-modals-1856 branch from a88c411 to c06af13 Compare January 6, 2026 04:01

gnprice added the maintainer review PR ready for review by Zulip maintainers label Jan 22, 2026

gnprice requested a review from sm-sayedi February 12, 2026 07:12

gnprice assigned sm-sayedi Feb 14, 2026

sm-sayedi reviewed Feb 18, 2026

View reviewed changes

khanak0509 added 4 commits February 18, 2026 16:38

Add intro modals for Inbox and Combined Feed

b094287

Fixes zulip#1856

add integration tests

6f0f681

Navigate to actual pages in intro modal tests

d0d8bc8

rename IntroModal to IntroDialog, use static maybeShow

1e70438

khanak0509 force-pushed the intro-modals-1856 branch from 6a00350 to 1e70438 Compare February 18, 2026 11:48

sm-sayedi suggested changes Feb 19, 2026

View reviewed changes

		inboxIntroModalShown(GlobalSettingType.internal, false),
		combinedFeedIntroModalShown(GlobalSettingType.internal, false),

		matching: find.byType(SingleChildScrollView),)).findsOne();
		}, variant: TargetPlatformVariant.all(),);

	await future;
	await future; // Wait for the dialog to be dismissed.

		case IntroDialogDestination.inbox:
		setting = BoolGlobalSetting.inboxIntroModalShown;

	IntroDialog.maybeShow(IntroDialogDestination.inbox);
	IntroDialog.maybeShow(.inbox);

Conversation

khanak0509 commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gnprice commented Dec 21, 2025

Uh oh!

khanak0509 commented Dec 21, 2025

Uh oh!

chrisbobbe commented Dec 23, 2025

Uh oh!

khanak0509 commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gnprice commented Jan 6, 2026

Uh oh!

khanak0509 commented Jan 6, 2026

Uh oh!

gnprice commented Jan 6, 2026

Uh oh!

khanak0509 commented Jan 7, 2026

Uh oh!

gnprice commented Jan 15, 2026

Uh oh!

khanak0509 commented Jan 15, 2026

Uh oh!

gnprice commented Feb 12, 2026

Uh oh!

sm-sayedi commented Feb 18, 2026

Uh oh!

sm-sayedi left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sm-sayedi Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sm-sayedi Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

khanak0509 commented Feb 18, 2026

Uh oh!

sm-sayedi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

khanak0509 commented Dec 20, 2025 •

edited

Loading

khanak0509 commented Dec 26, 2025 •

edited

Loading

sm-sayedi left a comment •

edited

Loading

sm-sayedi Feb 18, 2026 •

edited

Loading

sm-sayedi Feb 18, 2026 •

edited

Loading