Apply Onyx updates in an ordered fashion

[tgolen]

HOLD on the conferences, since we have a feature freeze. But we can review and have it ready to merge after Friday!

Details

Fixed Issues

$ #24606
PROPOSAL:

Tests

There are 5 test flows to be made here.

1. General

• Confirm that the app continues to work as expected on normal flows - sending messages, receiving messages, creating workspaces, etc

2. Enabling the beta

1. Prepare your environment (leave your application logged in, open the Network inspector to see the requests and the console to see the logs) and leave a report open
2. Tag @danieldoglas when you've finished 1 and ask him to add your test email to the beta (send him your test email)
3. When you're added to the test and @danieldoglas confirms it, send a message on NewDot on the previously opened report
4. You should see:
   • A call to AddComment
   • The log [OnyxUpdateManager] Client has not gotten reliable updates before so reconnecting the app to start the process
   • A call to ReconnectApp
   • And, after that, the app should continue to work normally.

To repeat this area of the test, you can execute Onyx.set("OnyxUpdatesLastUpdateIDAppliedToClient",""); and start again after you're part of the beta.

3. Working on the beta

1. Sign into two different clients (web and any other platform) with two different accounts
2. User A should have the reliable updates beta enabled, It doesn't make any difference for user B.
3. User A on web, go to preferences and turn on force offline mode
4. User A, send a comment to User B
5. User A, go back to preferences (but don't do anything)
6. User A, switch to another tab to simulate background mode
7. User B on another platform, send two comments to User A
8. User B, delete the first comment
9. User A on web, go to NewDot tab
10. User A, turn off the force offline mode option
11. Verify that User A never sees the first comment from User B
12. Verify that both users see two comments (one from each user)

4. Testing that GetMissingOnyxUpdate calls are being made

1. Check the value for OnyxUpdatesLastUpdateIDAppliedToClient on your current DB (by accessing Application > IndexedDB > OnyxDB > keyvaluepairs)
2. Use Onyx.set("OnyxUpdatesLastUpdateIDAppliedToClient", {currentValue - 1});
3. Send a new comment
4. Confirm that you can see a log with Gap detected in update IDs from server so fetching incremental updates
5. Confirm that your client did a GetMissingOnyxMessages request

5. Testing that we're not saving old data received late

1. On User A, Check the value for OnyxUpdatesLastUpdateIDAppliedToClient on your current DB (by accessing Application > IndexedDB > OnyxDB > keyvaluepairs)
2. Use Onyx.set("OnyxUpdatesLastUpdateIDAppliedToClient", {currentValue + 10000});
3. From User B, send a new comment to client A
4. Confirm that you can see a log with [OnyxUpdateManager] Update received was older than current state, returning without applying the updates
5. Confirm that your client did NOT show the new message that was received (this is expected since we're ignoring it)

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• Verify that no errors appear in the JS console

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 / Chrome
  • iOS / native
  • iOS / 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 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 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 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

I tested by login in without the beta enabled, the enable the beta and send a message

I was able to confirm that the ReconnectApp request was made, and that we started to track the ID after it.

Screen.Recording.2023-08-30.at.21.31.33.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[danieldoglas]

Ok I think we're gonna need a few changes here since this didn't work out of the box

[allroundexperts]

Looks good to me!

[melvin-bot]

@techievivek 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]

[melvin-bot]

@MonilBhavsar 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]

[MonilBhavsar]

even if our current value is out of date

Just curious how can this happen if the requests are fetching the current state. Doesn't happen at all?

[danieldoglas]

We talked personally and I explained this!

[MonilBhavsar]

number | string, as in OnyxUpdatesFromServer ?

[danieldoglas]

This shouldn't be a problem, though I agree we should fix it. I'll open another PR after this so we don't lose the C+ reviews, is that OK for you?

[MonilBhavsar]

Sounds good. Feel free to request a review

[danieldoglas]

@MonilBhavsar #27121

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.67-0 🚀

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

[mvtglobally]

@tgolen Can you pls confirm if we only need to QA 3**. Working on the beta** steps?

[danieldoglas]

@mvtglobally I think you can do 3 onwards. I've just activated the beta on staging for all applause accounts, so it should work for you!

Also, it's possible we'll see other regressions because of this change. I'm not sure about that, but I'll check the list later!

[OSBotify]

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.67-3 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.68-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

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