Apply onyx updates from push notifications reliably #36047

arosiclair · 2024-02-07T17:03:04Z

HELD on https://github.com/Expensify/Web-Expensify/pull/40706

Details

Use lastUpdateID and previousUpdateID in push notification's payload to apply the onyx update reliably like we do with updates from Pusher.

Fixed Issues

$ #33191

Tests

Important

Devs need to run ./script/bwm.sh

Group DMs

Log into users A, B and C in three windows (eg: chrome, incognito and safari)
Open a group chat on all windows
Send a message
Reply
Verify both messages are received in all windows without refresh

Attachments

Send another message with an image attachment
Verify the message sends correctly
Verify the attachment displays correctly

Mentions

As user A send a message mentioning B
Verify the message is received on all windows and displays correctly in the LHN and the chat

Web Notifications

Send another message from user A
Accept any notification prompt from user B
Verify the message displays with a notification

Mobile Push Notifications

Log into user B on native mobile
Accept any notification prompt
Got to the home page
Send another message from user A
Verify a push notification displays
For devs: verify logs appear for the reliable update similar to below:

[PushNotification] received report comment notification in the foreground - {"reportID":1491456387272220,"reportActionID":"8084627642280013422"}
[PushNotification] reliable onyx update received - {"lastUpdateID":2753,"previousUpdateID":2750,"onyxDataCount":2}
[OnyxUpdateManager] Applying update type: pusher with lastUpdateID: 2753 - {}
[OnyxUpdateManager] Update received was older than or the same as current state, returning without applying the updates other than successData and failureData - ""

Offline tests

None

QA Steps

Same as Tests

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…ble-push-notifs

src/libs/Notification/PushNotification/subscribeToReportCommentPushNotifications.ts

melvin-bot · 2024-02-09T19:20:13Z

@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 · 2024-02-09T19:21:02Z

Woops, this is not ready for review yet

…ir-reliable-push-notifs

arosiclair · 2024-02-12T22:05:29Z

This is ready for code review and can be tested internally.

@allroundexperts you won't be able to test until some backend changes are deployed. I'll follow up when that's done.

arosiclair · 2024-02-21T17:23:01Z

There is a merge freeze for the rest of the week, but this is ready for review and testing @allroundexperts. Backend changes are deployed.

arosiclair · 2024-02-26T22:21:55Z

Off hold again. Bump @allroundexperts

allroundexperts · 2024-02-29T19:21:43Z

On my list for tomorrow!

allroundexperts · 2024-03-01T07:19:26Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-03-05.at.12.25.58.AM.mov

Screen.Recording.2024-03-05.at.12.27.41.AM.mov

Screen.Recording.2024-03-05.at.2.04.00.AM.mov

MacOS: Desktop

allroundexperts · 2024-03-01T16:10:25Z

Still reviewing this. Testing all the cases above seems to be taking longer time.

allroundexperts · 2024-03-04T19:33:57Z

@arosiclair I'm able to see the fix applied only about 1/2 of the times. For the remaining half times, it never gets applied unless I open another chat and come back.

Screen.Recording.2024-03-05.at.12.34.20.AM.mov

arosiclair · 2024-03-04T20:10:43Z

@arosiclair I'm able to see the fix applied only about 1/2 of the times. For the remaining half times, it never gets applied unless I open another chat and come back.

Can you give a little more info? What are you expecting to see that isn't happening?

allroundexperts · 2024-03-04T20:12:42Z

Can you give a little more info? What are you expecting to see that isn't happening?

I'm expecting new messages to appear without having to reload the page. This does not seem to happen always. Many times the new messages only appear after I reload the page.

allroundexperts

I was able to test this on web only. The notifications part seem to be working well for web.

melvin-bot · 2024-03-04T21:17:25Z

@amyevans 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 · 2024-03-04T22:00:57Z

I was able to test this on web only. The notifications part seem to be working well for web.

Did you have an issue testing Android?

allroundexperts · 2024-03-05T12:46:16Z

I was able to test this on web only. The notifications part seem to be working well for web.

Did you have an issue testing Android?

The notifications don't appear on the emulator.

arosiclair · 2024-03-05T15:24:46Z

The notifications don't appear on the emulator.

Hm okay. Can you do a test on mobile @amyevans? I can help if needed. You'll only need to test the Mobile Push Notifications part.

amyevans · 2024-03-05T15:29:03Z

Yeah I can give it a shot this morning!

amyevans

Code looks good!

Outcome of the Slack thread: I am unable to test so Andrew will just test again to double check

The merge-base changed after approval.

…ble-push-notifs

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

Retested web and mobile notifications 👌

Android: Native

iOS: Native

Will re-test again on staging

OSBotify · 2024-03-06T16:50:43Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-03-06T22:04:45Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.4.48-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

arosiclair · 2024-03-07T14:06:31Z

Just did a couple log searches to verify staging. We're looking good!

OSBotify · 2024-03-07T23:50:45Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.4.48-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

use lastUpdateID and previousUpdateID to apply updates

d4718f6

arosiclair self-assigned this Feb 7, 2024

arosiclair added 3 commits February 7, 2024 12:08

log when data is present or missing

151b9ed

DRY up reliable update code

9e7951a

Merge branch 'main' of github.com:Expensify/App into arosiclair-relia…

5b49220

…ble-push-notifs

arosiclair commented Feb 8, 2024

View reviewed changes

src/libs/Notification/PushNotification/subscribeToReportCommentPushNotifications.ts Outdated Show resolved Hide resolved

arosiclair mentioned this pull request Feb 8, 2024

[HOLD for payment 2024-03-14] HIGH: Onyx updates from push notifications can get applied out of order #33191

Closed

arosiclair changed the title ~~Apply onyx updates from push notifications reliably~~ [HOLD] Apply onyx updates from push notifications reliably Feb 8, 2024

arosiclair marked this pull request as ready for review February 9, 2024 19:20

arosiclair requested a review from a team as a code owner February 9, 2024 19:20

melvin-bot bot requested review from allroundexperts and removed request for a team February 9, 2024 19:20

arosiclair marked this pull request as draft February 9, 2024 19:20

arosiclair added 3 commits February 9, 2024 17:00

Merge branch 'arosiclair-should-show-push-notification' into arosicla…

8da57de

…ir-reliable-push-notifs

re-add background refresh

02ad87a

use new airship update type

33f9c41

arosiclair marked this pull request as ready for review February 12, 2024 22:04

arosiclair changed the title ~~[HOLD] Apply onyx updates from push notifications reliably~~ Apply onyx updates from push notifications reliably Feb 21, 2024

arosiclair changed the title ~~Apply onyx updates from push notifications reliably~~ [HOLD 2/26] Apply onyx updates from push notifications reliably Feb 21, 2024

arosiclair changed the title ~~[HOLD 2/26] Apply onyx updates from push notifications reliably~~ Apply onyx updates from push notifications reliably Feb 26, 2024

allroundexperts approved these changes Mar 4, 2024

View reviewed changes

melvin-bot bot requested a review from amyevans March 4, 2024 21:17

amyevans previously approved these changes Mar 6, 2024

View reviewed changes

arosiclair added the InternalQA This pull request required internal QA label Mar 6, 2024

Merge branch 'main' of github.com:Expensify/App into arosiclair-relia…

c2b95d9

…ble-push-notifs

arosiclair requested a review from amyevans March 6, 2024 16:42

amyevans approved these changes Mar 6, 2024

View reviewed changes

amyevans merged commit d22196a into main Mar 6, 2024
15 checks passed

amyevans deleted the arosiclair-reliable-push-notifs branch March 6, 2024 16:45

github-actions bot mentioned this pull request Mar 6, 2024

Deploy Checklist: New Expensify 2024-03-06 #37845

Closed

63 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Apply onyx updates from push notifications reliably #36047

Apply onyx updates from push notifications reliably #36047

arosiclair commented Feb 7, 2024 •

edited

Loading

melvin-bot bot commented Feb 9, 2024

arosiclair commented Feb 9, 2024

arosiclair commented Feb 12, 2024

arosiclair commented Feb 21, 2024

arosiclair commented Feb 26, 2024

allroundexperts commented Feb 29, 2024

allroundexperts commented Mar 1, 2024 •

edited

Loading

allroundexperts commented Mar 1, 2024

allroundexperts commented Mar 4, 2024 •

edited

Loading

arosiclair commented Mar 4, 2024

allroundexperts commented Mar 4, 2024

allroundexperts left a comment

melvin-bot bot commented Mar 4, 2024

arosiclair commented Mar 4, 2024

allroundexperts commented Mar 5, 2024

arosiclair commented Mar 5, 2024

amyevans commented Mar 5, 2024

amyevans left a comment

arosiclair commented Mar 6, 2024

OSBotify commented Mar 6, 2024

OSBotify commented Mar 6, 2024

arosiclair commented Mar 7, 2024

OSBotify commented Mar 7, 2024

Apply onyx updates from push notifications reliably #36047

Apply onyx updates from push notifications reliably #36047

Conversation

arosiclair commented Feb 7, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 9, 2024

arosiclair commented Feb 9, 2024

arosiclair commented Feb 12, 2024

arosiclair commented Feb 21, 2024

arosiclair commented Feb 26, 2024

allroundexperts commented Feb 29, 2024

allroundexperts commented Mar 1, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts commented Mar 1, 2024

allroundexperts commented Mar 4, 2024 • edited Loading

arosiclair commented Mar 4, 2024

allroundexperts commented Mar 4, 2024

allroundexperts left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 4, 2024

arosiclair commented Mar 4, 2024

allroundexperts commented Mar 5, 2024

arosiclair commented Mar 5, 2024

amyevans commented Mar 5, 2024

amyevans left a comment

Choose a reason for hiding this comment

arosiclair commented Mar 6, 2024

OSBotify commented Mar 6, 2024

OSBotify commented Mar 6, 2024

arosiclair commented Mar 7, 2024

OSBotify commented Mar 7, 2024

arosiclair commented Feb 7, 2024 •

edited

Loading

allroundexperts commented Mar 1, 2024 •

edited

Loading

allroundexperts commented Mar 4, 2024 •

edited

Loading