Fix: Push notification onyx updates not applied when notification is selected #42510

chrispader · 2024-05-23T10:23:25Z

Details

Fixes an issue where OnyxServerUpdate's received from push notifications are not applied to Onyx locally, when a notification is selected/clicked.

Based on #42044 because it isn't merged yet

Fixed Issues

$ #40227
PROPOSAL:

Tests

Note

test iOS and Android native only

Log in
Accept push notification prompt
Send yourself a message
Verify a push notification appears and click it
Verify you're navigated to the chat and the message displays
Go back to the homescreen
Kill the app
Send yourself another message
Verify a push notification appears and click it
Verify the app opens, you're navigated to the chat and the message displays

Offline tests

None

QA Steps

Same as Tests

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…tions

melvin-bot · 2024-05-23T10:23:30Z

@allroundexperts Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

arosiclair

Looks pretty good. I think you're right that we don't have to call DeferredOnyxUpdates.enqueueAndProcess directly. Also I merged your last PR so be sure to merge main to clear the old changes on this one.

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

src/libs/Notification/PushNotification/extractDataFromPushNotification.ts

src/libs/Notification/PushNotification/index.native.ts

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

…on/index.ts Co-authored-by: Andrew Rosiclair <arosiclair@gmail.com>

…x-updates

…ing to report screen

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

arosiclair · 2024-05-24T14:46:26Z

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

+        // const updates = wrapAirshipUpdatesDataInOnyxUpdatesFromServer({onyxData, lastUpdateID, previousUpdateID});
+        // return DeferredOnyxUpdates.enqueueAndProcess(updates);
+
+        return Promise.all(onyxUpdates.map((update) => applyOnyxData(update)));


On second thought, I think we do need to enqueueAndProcess these updates as we're applying them in a random order here.

The end goal we're looking for is that all of the push notification updates are sorted and then applied in-order. The DeferredOnyxUpdates queue should be able to do that with enqueueAndProcess. Does that make sense?

The sorting and processing is actually also achieved by calling applyOnyxData. This will trigger applyOnyxUpdatesReliably which will then trigger handleOnyxUpdateGap and DeferredOnyxUpdates.enqueue functions consecutively.

Once the deferred updates are being processed by validateAndApplyDeferredUpdates they will be sorted and applied.

So we're essentially trying to avoid unnecessary calls to handleOnyxUpdateGap to begin with. For example, let's say our clientLastUpdateID is 10 and we have push notifications for updates 11-15. Ideally, we would apply them in-order and thus, detect no gaps as we do that.

If we applyOnyxUpdatesReliably in a random order, the first update will probably be out of order so it will trigger an unnecessary call to handleOnyxUpdateGap and GetMissingOnyxMessages. The following updates should just get enqueued and then processed like you said, but that first API call was unnecessary.

So we must sort and apply these updates synchronously and we should be able to do that with enqueueAndProcess. Do you follow?

gotcha! makes sense

src/libs/Notification/PushNotification/index.native.ts

chrispader · 2024-05-29T10:26:52Z

@arosiclair i've updated the PR to use DeferredOnyxUpdates.enqueueAndProcess() directly, which will make sure the updates are sorted and applied synchronously.

Could you test if this brings the expected output when clicking on push notifications? It's hard to test this on the simulator (as i cannot build the Expensify app with (Remote) push notifications, because i'm not in the Expensify Apple Developer organization)

I'm gonna try to mock the push notification with the onyx payload later today, but first i have to work on some other stuff.

arosiclair · 2024-05-29T13:21:35Z

Could you test if this brings the expected output when clicking on push notifications? It's hard to test this on the simulator (as i cannot build the Expensify app with (Remote) push notifications, because i'm not in the Expensify Apple Developer organization)

You should be able to test on Android (emulator or device are both fine). I'll give it a test on iOS though.

src/libs/Notification/PushNotification/subscribePushNotification/index.ts

arosiclair

Alright I did some testing on iOS and have a few findings:

It's not clear what's going on with the deferred updates queue when just looking at logs. We should add a couple to enqueue and process:

Log.info('[DeferredOnyxUpdates] enqueuing updates', false, { lastUpdateIDs: Object.keys(updates)});

Log.info('[DeferredOnyxUpdates] processing updates', false, { lastUpdateIDs: Object.keys(deferredUpdates)});

It looks like clearReportNotifications is clearing notifications and their payloads before we get to enqueue them. Commenting out that function fixed the issue for me. So we need to just need to get the notifications before navigating. Something like:

function navigateToReport({reportID, reportActionID}) {
    Airship.push.getActiveNotifications().then((notifications) => {
        // ...
        DeferredOnyxUpdates.enqueueAndProcess(onyxUpdates);
  
        Navigation.isNavigationReady().then(...)
    }
}

Even with the above changes, there's still a noticeable delay for the new messages to appear after killing the app, receiving push notifications and tapping one to view the chat. With the force offline toggle enabled, the messages never appear (presumably because the updates were never merged). It's not clear in logs if that's because there's a gap that cannot be filled while offline or another reason.

…x-updates

allroundexperts · 2024-06-01T19:08:38Z

@chrispader Can you please update the checklist?

…x-updates

chrispader · 2024-06-03T12:54:52Z

@arosiclair i've applied the changes you suggested and tested it on Android. In my case, the updates from the notifications are already applied when received, therefore they also appear in the report screen when navigated there.

Calling Airship.push.getActiveNotifications() actually doesn't give me any notifications on Android, could you check if this returns any notifications on iOS? I cannot test this in the iOS simulator. This means, there also are no deferred updates getting enqueued and processed.

(The Airship docs state, that on Android getActiveNotifications() will only return notifications passed through Airship, but i think this should be the case?)

Also, we still have the PushNotification.onReceived callback which will apply all (reliably) applicable updates when received. This means that the updates that are clicked/selected should already be applied at that point.

Is our approach, to "re-apply" all open/active notifications, in case these couldn't be applied (yet) or are missing?

chrispader · 2024-06-03T12:55:43Z

Since i cannot really test this on iOS, where it seems to be the bigger problem, i'm not sure if i can properly test and work on this PR...

Could you test the current state and lmk if i can help with anything further?

chrispader · 2024-06-03T12:59:38Z

@chrispader Can you please update the checklist?

@allroundexperts i completed the checklist so this PR is not blocked by me, but we still have to ensure this works on Android and iOS

arosiclair · 2024-06-03T15:49:54Z

Calling Airship.push.getActiveNotifications() actually doesn't give me any notifications on Android, could you check if this returns any notifications on iOS?

It should work on both. That's what we use for clearReportNotifications. I'll give it a try on Android.

Also, we still have the PushNotification.onReceived callback which will apply all (reliably) applicable updates when received. This means that the updates that are clicked/selected should already be applied at that point.

Is our approach, to "re-apply" all open/active notifications, in case these couldn't be applied (yet) or are missing?

The idea is that sometimes the onReceived callback does not run and apply the onyx data after the app is killed in the background, so we would try to apply the onyx data again when you select any notification. However, I am seeing on iOS that the onReceived callback does eventually run when we re-open the app so we may be double applying right now. I'm going to do some more testing to see how we should proceed.

Since i cannot really test this on iOS, where it seems to be the bigger problem, i'm not sure if i can properly test and work on this PR...

Yeah it might be best for me to take over this PR. I'll put some work on it today

chrispader · 2024-06-03T15:53:13Z

Calling Airship.push.getActiveNotifications() actually doesn't give me any notifications on Android, could you check if this returns any notifications on iOS?

It should work on both. That's what we use for clearReportNotifications. I'll give it a try on Android.

Also, we still have the PushNotification.onReceived callback which will apply all (reliably) applicable updates when received. This means that the updates that are clicked/selected should already be applied at that point.
Is our approach, to "re-apply" all open/active notifications, in case these couldn't be applied (yet) or are missing?

The idea is that sometimes the onReceived callback does not run and apply the onyx data after the app is killed in the background, so we would try to apply the onyx data again when you select any notification. However, I am seeing on iOS that the onReceived callback does eventually run when we re-open the app so we may be double applying right now. I'm going to do some more testing to see how we should proceed.

Since i cannot really test this on iOS, where it seems to be the bigger problem, i'm not sure if i can properly test and work on this PR...

Yeah it might be best for me to take over this PR. I'll put some work on it today

thanks!

arosiclair · 2024-06-03T16:00:47Z

I'm merging this into my own branch and continuing from there

arosiclair · 2024-06-03T16:03:58Z

New PR is here: #43001

chrispader added 2 commits May 23, 2024 11:15

Merge branch 'main' into @chrispader/add-deferred-updates--queue-func…

5dce826

…tions

apply notification updates once a push notification is selected

65a43c1

chrispader requested a review from a team as a code owner May 23, 2024 10:23

melvin-bot bot requested review from allroundexperts and removed request for a team May 23, 2024 10:23

chrispader changed the title ~~Fix: Push notification onyx updates not applied when notification is selected~~ [WIP] Fix: Push notification onyx updates not applied when notification is selected May 23, 2024

chrispader mentioned this pull request May 23, 2024

[HOLD for payment 2024-06-05] [$250] CRITICAL: Tapping on Push Notification fails to retrieve Onyx updates #40227

Closed

6 tasks

arosiclair requested changes May 23, 2024

View reviewed changes

chrispader and others added 5 commits May 24, 2024 12:09

Update src/libs/Notification/PushNotification/subscribePushNotificati…

9f0a892

…on/index.ts Co-authored-by: Andrew Rosiclair <arosiclair@gmail.com>

Merge branch 'main' into @chrispader/fix/push-notifications-defer-ony…

435cb59

…x-updates

fix: pr comments

56645b7

fix: don't wait for notification updates being applied before navigat…

08bb933

…ing to report screen

fix: wrong import

aec6383

chrispader requested a review from arosiclair May 24, 2024 11:29

arosiclair requested changes May 24, 2024

View reviewed changes

chrispader added 2 commits May 28, 2024 11:12

fix: resolve gh comments

427c4fa

rename function

73ecced

chrispader requested a review from arosiclair May 28, 2024 09:13

fix: apply onyx updates in order

dc2372f

chrispader changed the title ~~[WIP] Fix: Push notification onyx updates not applied when notification is selected~~ Fix: Push notification onyx updates not applied when notification is selected May 29, 2024

arosiclair requested changes May 29, 2024

View reviewed changes

src/libs/Notification/PushNotification/subscribePushNotification/index.ts Outdated Show resolved Hide resolved

fix: missing spread operator

e2e7940

arosiclair requested changes May 30, 2024

View reviewed changes

chrispader added 2 commits May 31, 2024 13:19

Merge branch 'main' into @chrispader/fix/push-notifications-defer-ony…

5098cef

…x-updates

Merge branch 'main' into @chrispader/fix/push-notifications-defer-ony…

62b38a5

…x-updates

Merge branch 'main' into @chrispader/fix/push-notifications-defer-ony…

c2361cb

…x-updates

chrispader added 3 commits June 3, 2024 10:47

add logs to DeferredOnyxUpdates

a2a85b9

fix: wait for notifications to be fetched before navigating to report

f7895e2

fix: other logs

955247e

chrispader added 2 commits June 3, 2024 14:56

don't enqueue updates when no notifications received

6fb2993

rename logs for consistency

aa9503b

arosiclair changed the base branch from main to arosiclair-push-notif-deferred-updates June 3, 2024 16:00

arosiclair merged commit 98d3570 into Expensify:arosiclair-push-notif-deferred-updates Jun 3, 2024
14 of 15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Push notification onyx updates not applied when notification is selected #42510

Fix: Push notification onyx updates not applied when notification is selected #42510

chrispader commented May 23, 2024 •

edited

Loading

melvin-bot bot commented May 23, 2024

arosiclair left a comment

arosiclair May 24, 2024

chrispader May 28, 2024

arosiclair May 28, 2024

chrispader May 28, 2024

chrispader commented May 29, 2024

arosiclair commented May 29, 2024

arosiclair left a comment

allroundexperts commented Jun 1, 2024

chrispader commented Jun 3, 2024

chrispader commented Jun 3, 2024

chrispader commented Jun 3, 2024

arosiclair commented Jun 3, 2024

chrispader commented Jun 3, 2024

arosiclair commented Jun 3, 2024

arosiclair commented Jun 3, 2024

Fix: Push notification onyx updates not applied when notification is selected #42510

Fix: Push notification onyx updates not applied when notification is selected #42510

Conversation

chrispader commented May 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 23, 2024

arosiclair left a comment

Choose a reason for hiding this comment

arosiclair May 24, 2024

Choose a reason for hiding this comment

chrispader May 28, 2024

Choose a reason for hiding this comment

arosiclair May 28, 2024

Choose a reason for hiding this comment

chrispader May 28, 2024

Choose a reason for hiding this comment

chrispader commented May 29, 2024

arosiclair commented May 29, 2024

arosiclair left a comment

Choose a reason for hiding this comment

allroundexperts commented Jun 1, 2024

chrispader commented Jun 3, 2024

chrispader commented Jun 3, 2024

chrispader commented Jun 3, 2024

arosiclair commented Jun 3, 2024

chrispader commented Jun 3, 2024

arosiclair commented Jun 3, 2024

arosiclair commented Jun 3, 2024

chrispader commented May 23, 2024 •

edited

Loading