notif: Use associated account as initial account; if opened from background #1240

rajveermalviya · 2024-12-30T20:35:10Z

Previously, when two accounts (Account-1 and Account-2) were logged in, the app always defaulted to showing the home page of Account-1 on launch. If the app was closed and the user opened a notification from Account-2, the navigation stack would be:
HomePage(Account-1) -> MessageListPage(Account-2)

This commit fixes that behaviour, now when a notification is opened while the app is closed, the home page will correspond to the account associated with the notification's conversation.

This addresses #1210 for background notifications.

chrisbobbe

Here's a quick review :) in particular I haven't yet tested this manually on the office Android device.

chrisbobbe · 2024-12-30T20:49:26Z

lib/widgets/app.dart

+      final navigator = await ZulipApp.navigator;
+      final context = navigator.context;
+      assert(context.mounted);
+      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


Interesting. For a moment, seeing the await, I thought this comment must be wrong. But in fact I see that context isn't _handleGenerateInitialRoutes's context param, it's the final context that shadows that param. How about giving this one a different name, like navigatorContext?

Also nit: the TODO(linter) comment is too long; let's put it above this line, and it probably needs to be split onto multiple lines too

chrisbobbe · 2024-12-30T20:50:38Z

lib/widgets/app.dart

+    // TODO(#524) choose initial account as last one used
+    final initialAccountId = globalStore.accounts.firstOrNull?.id;
+
+    return (String intialRoute) {


nit: spelling of "initial"

chrisbobbe · 2024-12-30T20:52:58Z

test/notifications/display_test.dart

@@ -1096,6 +1096,44 @@ void main() {
      takeStartingRoutes();
      matchesNavigation(check(pushedRoutes).single, account, message);
    });
+
+    testWidgets('uses associated account as intial account; if intial route', (tester) async {


nit: spelling of "initial"

chrisbobbe · 2024-12-30T20:56:00Z

test/notifications/display_test.dart

+        narrow: switch (data.recipient) {
+        FcmMessageChannelRecipient(:var streamId, :var topic) =>
+          TopicNarrow(streamId, topic),
+        FcmMessageDmRecipient(:var allRecipientIds) =>
+          DmNarrow(allRecipientIds: allRecipientIds, selfUserId: data.userId),
+      }).buildUrl();


nit: Indentation looks wrong here (code inside switch should be indented)

chrisbobbe · 2024-12-30T20:57:07Z

test/notifications/display_test.dart

+        FcmMessageDmRecipient(:var allRecipientIds) =>
+          DmNarrow(allRecipientIds: allRecipientIds, selfUserId: data.userId),
+      }).buildUrl();
+      tester.binding.platformDispatcher.defaultRouteNameTestValue = intentDataUrl.toString();


This looks like it needs a corresponding teardown, with clearDefaultRouteNameTestValue. (Same with the existing place we set this, actually)

rajveermalviya · 2024-12-30T21:45:21Z

Thanks for the review @chrisbobbe! Pushed a revision, PTAL.

chrisbobbe

Thanks! Small comments below, and all looks good in a quick manual test on an Android emulator.

Does this PR change behavior on iOS? We haven't implemented navigation on tapping a notification on iOS yet; that's #1147. I haven't tested on iOS because Apple makes it complicated to test client-side notification changes: https://github.com/zulip/zulip-mobile/blob/main/docs/howto/push-notifications.md#testing-client-side-changes-on-ios

chrisbobbe · 2024-12-30T21:51:28Z

test/notifications/display_test.dart

@@ -1070,6 +1070,7 @@ void main() {

    testWidgets('at app launch', (tester) async {
      addTearDown(testBinding.reset);
+      addTearDown(tester.binding.platformDispatcher.clearDefaultRouteNameTestValue);


This would be best in its own commit, since it's about an unrelated test.

Moved this and the formating change in this test to a separate commit.

chrisbobbe · 2024-12-30T22:03:19Z

lib/widgets/app.dart

+
+    final globalStore = GlobalStoreWidget.of(context);
+    // TODO(#524) choose initial account as last one used
+    final initialAccountId = globalStore.accounts.firstOrNull?.id;


How about doing this (checking the contents of globalStore.accounts) inside the returned InitialRouteListFactory callback? That's what we do in the open-from-notification case.

Then in particular we don't have to think about what happens if the firstOrNull account is logged out between a call to _ZulipAppState.build and the time when Flutter decides to call this InitialRouteListFactory callback.

—ah, I see: its position outside the callback is the same in main. How about a prep commit that just puts the query on globalStore.accounts into the callback, then?

Seems also nice if it's below the open-from-notification code in that callback, so it's easier to see that it's not part of that logic.

…tValue`

…ground Previously, when two accounts (Account-1 and Account-2) were logged in, the app always defaulted to showing the home page of Account-1 on launch. If the app was closed and the user opened a notification from Account-2, the navigation stack would be: HomePage(Account-1) -> MessageListPage(Account-2) This commit fixes that behaviour, now when a notification is opened while the app is closed, the home page will correspond to the account associated with the notification's conversation. This addresses zulip#1210 for background notifications.

rajveermalviya · 2025-01-06T11:19:05Z

Thanks for the review @chrisbobbe. Pushed a new revision, PTAL.

chrisbobbe

Thanks! Small comments below.

chrisbobbe · 2025-01-24T23:49:43Z

lib/widgets/app.dart

@@ -152,6 +152,21 @@ class _ZulipAppState extends State<ZulipApp> with WidgetsBindingObserver {
    return super.didPushRouteInformation(routeInformation);
  }

+  InitialRouteListFactory _handleGenerateInitialRoutes(BuildContext context) {


app [nfc]: Pull out _handleGenerateInitialRoutes

This commit message is misleading 🙂; the change doesn't follow the common pattern of just moving some code out to a helper function for better organization. Putting the globalStore.accounts query inside the callback, instead of outside, is significant and worth mentioning; in fact it might not be NFC. The reason I gave in #1240 (comment) was:

Then in particular we don't have to think about what happens if the firstOrNull account is logged out between a call to _ZulipAppState.build and the time when Flutter decides to call this InitialRouteListFactory callback.

Does that seem right, or am I missing something?

It would be even clearer if it were split into two commits: one that changes when globalStore.accounts is queried, and one for making the helper function (the pure refactor).

chrisbobbe · 2025-01-25T00:02:43Z

lib/notifications/display.dart

+    final payload = NotificationOpenPayload.parseUrl(url);
+
+    final account = globalStore.accounts.firstWhereOrNull((account) =>
+      account.realmUrl == payload.realmUrl && account.userId == payload.userId);


How likely do we think it is that these realm URLs could differ in boring ways that shouldn't matter? Like https://chat.zulip.org/ vs. ``https://chat.zulip.org`. Do we need to just compare .origin instead, like we do for most (all?) other realm-URL checks?

rajveermalviya added the maintainer review PR ready for review by Zulip maintainers label Dec 30, 2024

rajveermalviya requested a review from chrisbobbe December 30, 2024 20:37

chrisbobbe reviewed Dec 30, 2024

View reviewed changes

rajveermalviya force-pushed the pr-notif-route-account branch 2 times, most recently from 1b7b732 to 54adf40 Compare December 30, 2024 21:42

rajveermalviya requested a review from chrisbobbe December 30, 2024 21:45

chrisbobbe reviewed Dec 30, 2024

View reviewed changes

rajveermalviya added 3 commits January 2, 2025 21:29

notif test [nfc]: Cleanup `TestPlatformDispatcher.defaultRouteNameTes…

c961903

…tValue`

app [nfc]: Pull out _handleGenerateInitialRoutes

4d68974

rajveermalviya force-pushed the pr-notif-route-account branch from 54adf40 to ae30cd3 Compare January 2, 2025 16:14

rajveermalviya requested a review from chrisbobbe January 6, 2025 11:19

PIG208 assigned chrisbobbe Jan 8, 2025

chrisbobbe reviewed Jan 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

notif: Use associated account as initial account; if opened from background #1240

notif: Use associated account as initial account; if opened from background #1240

rajveermalviya commented Dec 30, 2024

chrisbobbe left a comment

chrisbobbe Dec 30, 2024

chrisbobbe Dec 30, 2024

chrisbobbe Dec 30, 2024

chrisbobbe Dec 30, 2024

chrisbobbe Dec 30, 2024

chrisbobbe Dec 30, 2024

rajveermalviya commented Dec 30, 2024

chrisbobbe left a comment

chrisbobbe Dec 30, 2024

rajveermalviya Jan 6, 2025

chrisbobbe Dec 30, 2024 •

edited

Loading

chrisbobbe Dec 30, 2024

rajveermalviya commented Jan 6, 2025

chrisbobbe left a comment

chrisbobbe Jan 24, 2025

chrisbobbe Jan 25, 2025

chrisbobbe Jan 25, 2025

notif: Use associated account as initial account; if opened from background #1240

Are you sure you want to change the base?

notif: Use associated account as initial account; if opened from background #1240

Conversation

rajveermalviya commented Dec 30, 2024

chrisbobbe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajveermalviya commented Dec 30, 2024

chrisbobbe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisbobbe Dec 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajveermalviya commented Jan 6, 2025

chrisbobbe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisbobbe Dec 30, 2024 •

edited

Loading