fix/15627: Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode #16093

tienifr · 2023-03-18T06:37:07Z

Details

Updating the workspace avatar while offline and then going online after that will switch the avatar to the previous one for a few seconds. This is also happens to other fields: profile picture, display name, pronouns,...

This PR:

syncs (re-orders) the update requests and reconnect request on re-connection to make sure reconnect request should always be triggered after update requests
cancels all reconnect requests in edge cases where reordering requests is impossible

Fixed Issues

$ #15627
$ #15627 (comment)

Tests

Login with any account.
Go to any workspace that doesn’t have the avatar
Turn off the internet
Change the avatar, after that press Back
Turn on the internet connection
Verify that workspace’s avatar does not turn into placeholder for a while after fully changes to the new one

Edge case:

Turn off internet connection
Open Settings > Profile > Display Name, change anything
Turn on internet connection
Wait until the offline indicator is hidden
Press Save immediately after the offline indicator is hidden
Verify that there's no switching between old and new display name

As a data synchronization issue on offline/online switch, it also impacts other fields: profile picture, display name, pronouns,...

Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

Login with any account.
Go to any workspace that doesn’t have the avatar
Turn off the internet
Change the avatar, after that press Back
Turn on the internet connection
Verify that workspace’s avatar does not turn into placeholder for a while after fully changes to the new one

Edge case:

Turn off internet connection
Open Settings > Profile > Display Name, change anything
Turn on internet connection
Wait until the offline indicator is hidden
Press Save immediately after the offline indicator is hidden
Verify that there's no switching between old and new display name

As a data synchronization issue on offline/online switch, it also impacts other fields: profile picture, display name, pronouns,...

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screencast.from.18-03-2023.16.03.46.webm

Mobile Web - Chrome

chrome15627.mp4

Mobile Web - Safari

safari15627.mp4

Desktop

desktop15627.mp4

iOS

ios15627.mp4

Android

Screen.Recording.2023-03-19.at.14.26.34.1.mp4

MelvinBot · 2023-03-20T06:20:13Z

@MonilBhavsar @eVoloshchak One of you needs to 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]

eVoloshchak · 2023-03-21T11:31:15Z

@tienifr, there's a bug when updating the profile picture, the image is flickering multiple times

Screen.Recording.2023-03-21.at.13.25.01.mov

I also noticed image flickerning when changing workspace avatar (but for a plit-second), I suppose that's the local url being replaced with a remote url, but the remote image needs some time to load, during which the image is greyed-out, thus the flickering.

Screen.Recording.2023-03-21.at.12.56.09.mov

src/libs/actions/PersistedRequests.js

src/libs/HttpUtils.js

tienifr · 2023-03-21T15:18:21Z

@eVoloshchak Yes, I can see the image is flickering multiple times, but it happens even on staging and it's not related to this PR. Should we handle it in other PR? Thanks
https://user-images.githubusercontent.com/113963320/226652428-e7371721-8205-4fc1-b2ec-49bb88036485.mp4

src/CONST.js

eVoloshchak · 2023-03-21T15:21:54Z

@eVoloshchak Yes, I can see the image is flickering multiple times, but it happens even on staging and it's not related to this PR. Should we handle it in other PR?

Yeah, this should be handled as a separate issue then. Could you report this in #expensify-bugs please?

tienifr · 2023-03-21T15:23:34Z

Yes

…l places

tienifr · 2023-03-21T15:27:08Z

@eVoloshchak Done all your comments, thanks

eVoloshchak · 2023-03-21T15:33:03Z

@eVoloshchak Done all your comments, thanks

There's a couple left

tienifr · 2023-03-21T15:37:57Z

Yes, my fault, I've updated my PR

eVoloshchak · 2023-03-21T20:22:59Z

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 / Chrome
- iOS / native
- iOS / 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 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 correct English and 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 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 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

Screen.Recording.2023-03-21.at.22.37.00.mov

Mobile Web - Chrome

Screen_Recording_20230321-224831_Chrome.mp4

Mobile Web - Safari

Screen.Recording.2023-03-21.at.22.39.32.mov

Desktop

Screen.Recording.2023-03-21.at.22.35.40.mov

iOS

IMG_0009.MP4

Android

Screen_Recording_20230321-224950_New.Expensify.mp4

eVoloshchak

Looks good and tests well

cc: @MonilBhavsar

tienifr · 2023-03-22T09:36:24Z

@MonilBhavsar Do we proceed this one?

MonilBhavsar

Code looks good to me. Testing now

tienifr · 2023-03-23T03:12:15Z

@MonilBhavsar how it's going?

MonilBhavsar · 2023-03-23T06:42:19Z

Sorry for delay, I had issues with my VM. Will get back to this

MonilBhavsar · 2023-03-23T11:17:59Z

I would also suggest making PR title to somewhat general like - "Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode"

tienifr · 2023-03-23T11:55:01Z

@MonilBhavsar I just updated the PR title

MonilBhavsar

Thanks!
Works fine! Let's see 🤞

OSBotify · 2023-03-23T12:10:36Z

✋ 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-03-24T19:06:08Z

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

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

OSBotify · 2023-03-27T10:32:50Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

marcaaron

Hey I'm just passing through here as this PR popped up on my radar as being kind of suspect...

I could be misunderstanding this - but in general, I think we should not be modifying the contents of persisted requests in the write queue. If there is some problem related to concurrency of request data then it feels like a possible bandaid approach to remove the "problematic" command.

Let me know if my interpretation is off here.

marcaaron · 2023-05-12T17:16:36Z

src/libs/HttpUtils.js

@@ -21,6 +21,9 @@ Onyx.connect({
 // We use the AbortController API to terminate pending request in `cancelPendingRequests`
 let cancellationController = new AbortController();

+// To terminate pending ReconnectApp requests https://github.com/Expensify/App/issues/15627


Please do not leave links to issues in the code. If someone needs to figure out where and why this was added they can use git blame.

marcaaron · 2023-05-12T17:19:50Z

src/libs/actions/PersistedRequests.js

+        .concat(requestsToPersist)
+        .partition(request => request.command !== CONST.NETWORK.COMMAND.RECONNECT_APP)
+        .flatten()
+        .value();


What exactly is happening here? 🤔

Is the goal to move the ReconnectApp calls to a different order? Why are we doing it this?

You may need to take a look at the PR details or my linked proposal here #15627 to get the context.

Is the goal to move the ReconnectApp calls to a different order?

Yes, the goal is to re-order ReconnectApp to always fire last.

Why?

Whenever we switch from offline to online, ReconnectApp request is fired to retrieve the latest updates while we're offline (new messages, pending IOU,...). Prior to this PR, ReconnectApp is fired first regardless of any pending update requests:

The update action is made, the component is updated with optimistic data

ReconnectApp retrieves the old data (data before the update), the component is updated as the old data

Update request retrieves the updated data, the component is updated as the success data

This causes the component to flicker between optimistic, old and success data. Thus, I think the correct flow is to update first then ReconnectApp.

Note that if we do this, the order of other requests will remain the same.

For example:

A > B > ReconnectApp > C

to

A > B > C > ReconnectApp

Cool - probably no way for you to know this - but the changes violate a basic principle of how the network layer is supposed to work (i.e. "write" requests happen in the order they are triggered). Reordering this call might "fix" the issue - but it doesn't make it the "correct flow". I think we're going to discuss internally how to solve this appropriately, thanks!

marcaaron · 2023-05-12T17:20:12Z

src/libs/HttpUtils.js

+    return processHTTPRequest(url, type, formData, data.canCancel, command);
+}
+
+function cancelPendingReconnectAppRequest() {


Why does this need it's own cancel controller?

In some edge cases where we cannot re-order the ReconnectApp requests we should cancel them and re-queue them later. Basically the idea is to make sure ReconnectApp always fires last.

For example if the update action was made immediately after switching online (i.e. ReconnectApp has already been fired but not completed yet).

the idea is to make sure ReconnectApp always fires last

Yeah, again, it feels like we are making a weird exceptional case for ReconnectApp. IMO, there should be nothing special about ReconnectApp. The perception that it needs to "happen last" is entirely related to the data that it's returning. This change should have been held on a wider conversation with the team. It's sort of clear to me that the network layer isn't perfect and can't handle every edge case. But feels like we are hacking around a deficiency by breaking some core assumptions about how things work.

marcaaron · 2023-06-16T20:44:03Z

Heads up I'm reverting these changes and reopening this issue. The hack we used here is blocking a critical performance feature.

fix: workspace avatar delays new changes when switching on/offline mode

794a51d

tienifr force-pushed the fix/15627-sync-update-and-reconnect-on-reconnection branch from 826f78e to 794a51d Compare March 20, 2023 04:43

tienifr marked this pull request as ready for review March 20, 2023 06:20

tienifr requested a review from a team as a code owner March 20, 2023 06:20

melvin-bot bot requested review from eVoloshchak and MonilBhavsar and removed request for a team March 20, 2023 06:20

tienifr mentioned this pull request Mar 20, 2023

[PAID OUT] [$1000] Workspace’s avatar turns into placeholder for a second after user changes workspace in offline mode and goes online. #15627

Closed

6 tasks

eVoloshchak suggested changes Mar 21, 2023

View reviewed changes

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

src/libs/HttpUtils.js Outdated Show resolved Hide resolved

fix: remove ReconnectApp comand to const

9d1f6aa

eVoloshchak suggested changes Mar 21, 2023

View reviewed changes

src/CONST.js Outdated Show resolved Hide resolved

fix: change function name and replace ReconnectApp by new const at al…

7949d59

…l places

fix: change const key

4a4b0ce

eVoloshchak approved these changes Mar 21, 2023

View reviewed changes

MonilBhavsar reviewed Mar 22, 2023

View reviewed changes

tienifr changed the title ~~fix/15627: Workspace’s avatar turns into placeholder for a second after user changes workspace in offline mode and goes online~~ fix/15627: Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode Mar 23, 2023

MonilBhavsar approved these changes Mar 23, 2023

View reviewed changes

MonilBhavsar merged commit 63b96d3 into Expensify:main Mar 23, 2023

MonilBhavsar mentioned this pull request Mar 23, 2023

[$1000] Workspace name changes to old name when user switch from offline to online #16090

Closed

6 tasks

OSBotify mentioned this pull request Mar 24, 2023

Deploy Checklist: New Expensify 2023-03-24 #16489

Closed

44 tasks

marcaaron reviewed May 12, 2023

View reviewed changes

marcaaron mentioned this pull request Jun 16, 2023

Send mostRecentReportActionLastModified with ReconnectApp #18807

Merged

60 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix/15627: Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode #16093

fix/15627: Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode #16093

tienifr commented Mar 18, 2023 •

edited

Loading

MelvinBot commented Mar 20, 2023

eVoloshchak commented Mar 21, 2023

tienifr commented Mar 21, 2023

eVoloshchak commented Mar 21, 2023

tienifr commented Mar 21, 2023

tienifr commented Mar 21, 2023

eVoloshchak commented Mar 21, 2023

tienifr commented Mar 21, 2023

eVoloshchak commented Mar 21, 2023 •

edited

Loading

eVoloshchak left a comment

tienifr commented Mar 22, 2023

MonilBhavsar left a comment

tienifr commented Mar 23, 2023

MonilBhavsar commented Mar 23, 2023

MonilBhavsar commented Mar 23, 2023

tienifr commented Mar 23, 2023

MonilBhavsar left a comment

OSBotify commented Mar 23, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

marcaaron left a comment

marcaaron May 12, 2023

marcaaron May 12, 2023

tienifr May 14, 2023 •

edited

Loading

marcaaron May 15, 2023

marcaaron May 12, 2023

tienifr May 14, 2023 •

edited

Loading

marcaaron May 15, 2023

marcaaron commented Jun 16, 2023

fix/15627: Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode #16093

fix/15627: Requeue ReconnectApp API requests to fix old data getting rendered when going from offline to online mode #16093

Conversation

tienifr commented Mar 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 20, 2023

eVoloshchak commented Mar 21, 2023

tienifr commented Mar 21, 2023

eVoloshchak commented Mar 21, 2023

tienifr commented Mar 21, 2023

tienifr commented Mar 21, 2023

eVoloshchak commented Mar 21, 2023

tienifr commented Mar 21, 2023

eVoloshchak commented Mar 21, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak left a comment

Choose a reason for hiding this comment

tienifr commented Mar 22, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

tienifr commented Mar 23, 2023

MonilBhavsar commented Mar 23, 2023

MonilBhavsar commented Mar 23, 2023

tienifr commented Mar 23, 2023

MonilBhavsar left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 23, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

marcaaron left a comment

Choose a reason for hiding this comment

marcaaron May 12, 2023

Choose a reason for hiding this comment

marcaaron May 12, 2023

Choose a reason for hiding this comment

tienifr May 14, 2023 • edited Loading

Choose a reason for hiding this comment

marcaaron May 15, 2023

Choose a reason for hiding this comment

marcaaron May 12, 2023

Choose a reason for hiding this comment

tienifr May 14, 2023 • edited Loading

Choose a reason for hiding this comment

marcaaron May 15, 2023

Choose a reason for hiding this comment

marcaaron commented Jun 16, 2023

tienifr commented Mar 18, 2023 •

edited

Loading

eVoloshchak commented Mar 21, 2023 •

edited

Loading

tienifr May 14, 2023 •

edited

Loading

tienifr May 14, 2023 •

edited

Loading