Properly handle previous data formats when saving the updates from the server to Onyx #27180

danieldoglas · 2023-09-11T17:28:20Z

Details

Fixed Issues

$ #27163

Tests

If you're starting a new instance with a new login, the original error won't happen, so you'll need to force it out.

Login
use Onyx.set('OnyxUpdatesLastUpdateIDAppliedToClient', null); in the console
Send a message to anyone. You'll see that we'll call ReconnectApp in the network tab
Confirm the property onyxUpdatesFromServer exists in Application > IndexedDb > OnyxDB > keyvaluepairs
Use Onyx.set('onyxUpdatesFromServer', {INVALID_FORMAT}); in the console to set that property to an invalid format and confirm it will log [OnyxUpdateManager] Invalid format found for updates, cleaning and unpausing the queue
1. you can test the following wrong formats:
  1. Onyx.set('onyxUpdatesFromServer', {'type': ''});
  2. Onyx.set('onyxUpdatesFromServer', {'type': 'https'});
  3. Onyx.set('onyxUpdatesFromServer', {'type': 'https', 'request': {}});
  4. Onyx.set('onyxUpdatesFromServer', {'type': 'pusher', 'request': {}, 'response': {}});
Execute 2-4 again and confirm the flow still works

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-09-11T17:28:59Z

@neil-marcellini 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]

src/libs/actions/OnyxUpdateManager.js

tgolen · 2023-09-11T18:22:45Z

src/libs/actions/OnyxUpdateManager.js

@@ -35,6 +37,18 @@ export default () => {
                return;
            }

+            // Since we used the same key that used to store another object, let's confirm that the current object is
+            // following the new format before we proceed. If it isn't, then let's clear the object in Onyx.


Any idea how long we have to keep this code here for? We should be able to remove it after about a month or so, right?

I would say 1 week after it reaches production (then we should have 90% of the people using the new version)

tgolen · 2023-09-11T18:23:01Z

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 Note: this can only be tested on web/desktop due to access with the console
- Android / Chrome Note: this can only be tested on web/desktop due to access with the console
- iOS / native Note: this can only be tested on web/desktop due to access with the console
- iOS / Safari Note: this can only be tested on web/desktop due to access with the console
- 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(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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Note: this can only be tested on web/desktop due to access with the console

Mobile Web - Safari

Note: this can only be tested on web/desktop due to access with the console

Desktop

iOS

Note: this can only be tested on web/desktop due to access with the console

Android

Note: this can only be tested on web/desktop due to access with the console

tgolen · 2023-09-11T18:30:48Z

I think this PR needs proper tests like setting the previous object type in Onyx from the JS console and verifying the bug doesn't happen. I might be able to add that if I have time today, but I don't think this is super urgent and I have some other stuff that is.

neil-marcellini

I think I'm lacking some context around this to fully understand it, but the code looks fine. It would be great to have more of a problem description in the PR description. Please also include tests.

Sounds like Tim is going to take this over? Lmk when it's ready for another review.

neil-marcellini · 2023-09-12T21:04:37Z

src/libs/actions/OnyxUpdateManager.js

+            // following the new format before we proceed. If it isn't, then let's clear the object in Onyx.
+            if (
+                !_.isObject(val) ||
+                !Object.prototype.hasOwnProperty.call(val, 'type') ||


NAB: We could use _.has instead since we generally prefer underscore functions.

Thanks, I didn't know that existed. Updated to it

danieldoglas · 2023-09-13T05:44:46Z

@neil-marcellini @tgolen I've fixed the test steps

tgolen

NAB: We usually use import lodashHas from 'lodash/has'; as opposed to using the one from underscore. I think it's fine to use the underscore one here. The function from lodash supports more complex cases like lodashHas(obj, 'a[0].b.c');

tgolen · 2023-09-14T16:08:50Z

@danieldoglas I'm trying to run through the tests before merging this, and I'm having some issues. Here is what I did:

Sign out of account completely and refresh
Sign into my account
Run Onyx.set('OnyxUpdatesLastUpdateIDAppliedToClient', null);
Send a message to someone
💥 There is no network request for ReconnectApp

If I look at the JS console, the sequential queue is paused and that's really the last thing that happens

tgolen · 2023-09-14T16:17:11Z

I did a little debugging and the queue is paused because shouldPauseQueue is set on the response of AddComment, which is normally OK. I then eventually saw these errors in my JS console about Onyx timing out and running out of memory:

So, I imagine that is what my problem is, and I have no idea why that would happen.

tgolen · 2023-09-14T16:20:09Z

I posted to slack here: https://expensify.slack.com/archives/C035J5C9FAP/p1694708298588159?thread_ts=1693594227.145039&cid=C035J5C9FAP

If you're able to run through the tests, can you please upload a video or screenshot of it working?

danieldoglas · 2023-09-15T06:15:44Z

@tgolen actually there was a problem with the new check, I was using a OR instead of AND. This was fixed! The error with storage in onyx is not related to this PR

tgolen · 2023-09-15T18:35:42Z

OK, I'm testing it again. I'm not ever getting the log line from step 5. Is there a certain way to trigger it? I tried AddComment again and it didn't trigger it and onyxUpdatesFromServer is still set to "" in IndexedDB

danieldoglas · 2023-09-17T15:19:45Z

@tgolen, I think I left the instructions a bit confusing. The log will only appear for invalid formats, when you leave it empty it will just ignore it and do nothing because of this check:

https://github.com/Expensify/App/blob/dsilva_fixDeployBlockerWithOnyx/src/libs/actions/OnyxUpdateManager.js#L36-L38

I've confirmed it will log for other invalid formats.

tgolen

Note to self: Next time, we should have done an onyx migration :D I odn't know why I didn't think of it here.

OSBotify · 2023-09-17T23:34:05Z

✋ 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 · 2023-09-18T10:39:51Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.71-0 🚀

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

kavimuru · 2023-09-19T13:37:01Z

@danieldoglas @tgolen Could you help us with step 2 and step 5.

2.use Onyx.set('OnyxUpdatesLastUpdateIDAppliedToClient', null); in the console
5.Use Onyx.set('onyxUpdatesFromServer', {INVALID_FORMAT}); in the console to set that property to an invalid format and confirm it will log [OnyxUpdateManager] Invalid format found for updates, cleaning and unpausing the queue
you can test the following wrong formats:
Onyx.set('onyxUpdatesFromServer', {'type': ''});
Onyx.set('onyxUpdatesFromServer', {'type': 'https'});
Onyx.set('onyxUpdatesFromServer', {'type': 'https', 'request': {}});
Onyx.set('onyxUpdatesFromServer', {'type': 'pusher', 'request': {}, 'response': {}});

I tried and got an error in console for step 2

tgolen · 2023-09-19T23:40:10Z

Ah, I didn't realize that was only possible to do in local dev environments. I think it's safe to treat this one as [No QA] and you can go ahead and mark it off.

OSBotify · 2023-09-20T08:12:21Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.71-12 🚀

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

added a check if the value was a number and return if it is

e90946a

danieldoglas requested a review from a team as a code owner September 11, 2023 17:28

danieldoglas self-assigned this Sep 11, 2023

melvin-bot bot requested review from neil-marcellini and removed request for a team September 11, 2023 17:28

danieldoglas added 5 commits September 12, 2023 01:30

adding comment

0236648

adding prettier

6187e71

changing to is object instead

9be34e8

changing if to check format of the update

a98dc74

import _

6425ff1

tgolen reviewed Sep 11, 2023

View reviewed changes

src/libs/actions/OnyxUpdateManager.js Outdated Show resolved Hide resolved

danieldoglas added 2 commits September 12, 2023 02:02

linter and addressing comments

3c59fb4

missing linter

e4172fd

danieldoglas requested a review from tgolen September 11, 2023 18:10

prettier

1810160

tgolen changed the title ~~Added a check if the lastUpdateID property value was a number and return if it is~~ Properly handle previous data formats when saving the updates from the server to Onyx Sep 11, 2023

tgolen previously approved these changes Sep 11, 2023

View reviewed changes

neil-marcellini reviewed Sep 12, 2023

View reviewed changes

changing to underscore function

89455eb

danieldoglas dismissed tgolen’s stale review via 89455eb September 13, 2023 05:39

tgolen previously approved these changes Sep 13, 2023

View reviewed changes

danieldoglas added 2 commits September 15, 2023 14:06

changing OR to AND

941fbc9

fixing clause, adding OR and unpausing sequential queue

5029f33

danieldoglas dismissed tgolen’s stale review via 5029f33 September 15, 2023 06:15

danieldoglas requested a review from tgolen September 15, 2023 06:15

tgolen approved these changes Sep 17, 2023

View reviewed changes

tgolen merged commit beaf3fa into main Sep 17, 2023

tgolen deleted the dsilva_fixDeployBlockerWithOnyx branch September 17, 2023 23:28

OSBotify mentioned this pull request Sep 18, 2023

Deploy Checklist: New Expensify 2023-09-18 #27654

Closed

91 tasks

mountiny mentioned this pull request Sep 19, 2023

ReconnectApp is called after sending or receiving message with reliableUpdates beta #27754

Closed

6 tasks

kavimuru mentioned this pull request Sep 19, 2023

Onyx not defined error appears in console when run the script #27815

Closed

6 tasks

izarutskaya mentioned this pull request Sep 20, 2023

PR27180- Web- Unable to use Onyx.set('OnyxUpdatesLastUpdateIDAppliedToClient', null); as error #27829

Closed

6 tasks

melvin-bot bot mentioned this pull request Sep 20, 2023

[HOLD for payment 2023-09-27] Unable to send attachment and new message is not shown in LHN after sending attachment #27163

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Properly handle previous data formats when saving the updates from the server to Onyx #27180

Properly handle previous data formats when saving the updates from the server to Onyx #27180

danieldoglas commented Sep 11, 2023 •

edited

Loading

melvin-bot bot commented Sep 11, 2023

tgolen Sep 11, 2023

danieldoglas Sep 11, 2023

tgolen commented Sep 11, 2023 •

edited

Loading

tgolen commented Sep 11, 2023

neil-marcellini left a comment

neil-marcellini Sep 12, 2023

danieldoglas Sep 13, 2023

danieldoglas commented Sep 13, 2023

tgolen left a comment

tgolen commented Sep 14, 2023

tgolen commented Sep 14, 2023

tgolen commented Sep 14, 2023

danieldoglas commented Sep 15, 2023 •

edited

Loading

tgolen commented Sep 15, 2023

danieldoglas commented Sep 17, 2023

tgolen left a comment

OSBotify commented Sep 17, 2023

OSBotify commented Sep 18, 2023

kavimuru commented Sep 19, 2023

tgolen commented Sep 19, 2023

OSBotify commented Sep 20, 2023

Properly handle previous data formats when saving the updates from the server to Onyx #27180

Properly handle previous data formats when saving the updates from the server to Onyx #27180

Conversation

danieldoglas commented Sep 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 11, 2023

tgolen Sep 11, 2023

Choose a reason for hiding this comment

danieldoglas Sep 11, 2023

Choose a reason for hiding this comment

tgolen commented Sep 11, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

tgolen commented Sep 11, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini Sep 12, 2023

Choose a reason for hiding this comment

danieldoglas Sep 13, 2023

Choose a reason for hiding this comment

danieldoglas commented Sep 13, 2023

tgolen left a comment

Choose a reason for hiding this comment

tgolen commented Sep 14, 2023

tgolen commented Sep 14, 2023

tgolen commented Sep 14, 2023

danieldoglas commented Sep 15, 2023 • edited Loading

tgolen commented Sep 15, 2023

danieldoglas commented Sep 17, 2023

tgolen left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 17, 2023

OSBotify commented Sep 18, 2023

kavimuru commented Sep 19, 2023

tgolen commented Sep 19, 2023

OSBotify commented Sep 20, 2023

danieldoglas commented Sep 11, 2023 •

edited

Loading

tgolen commented Sep 11, 2023 •

edited

Loading

danieldoglas commented Sep 15, 2023 •

edited

Loading