Apply Onyx failureData on fetch failure #27650

luacmartins · 2023-09-18T09:32:40Z

Details

Coming from this comment, we fail to apply Onyx failureData if the fetch request fails because response is undefined and we return early in the code.

Fixed Issues

$ #26143

Tests

Log into any account that has chats with a long history
Open that chat
Go offline
Scroll through cached chat history to the top of the page
Notice that the loading skeleton shows up and then disappears
Go online without leaving the chat
Scroll down a bit and then back to the top of the page
Verify that you can load more messages

Verify that no errors appear in the JS console

Offline tests

Covered above

QA Steps

Same as tests

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

luacmartins · 2023-09-21T09:57:30Z

@marcaaron would love your review of this solution

luacmartins · 2023-09-26T01:53:17Z

cc @tgolen since we discussed this

tgolen

The rest looks fine to me. I'd love to have you look at this too @marcaaron

tgolen · 2023-09-26T02:30:41Z

src/libs/Middleware/SaveResponseInOnyx.js

@@ -16,19 +16,12 @@ const requestsToIgnoreLastUpdateID = ['OpenApp', 'ReconnectApp', 'GetMissingOnyx
 function SaveResponseInOnyx(requestResponse, request) {
    return requestResponse.then((response) => {
        // Make sure we have response data (i.e. response isn't a promise being passed down to us by a failed retry request and response undefined)
-        if (!response) {
+        if (!response && !request.successData && !request.failureData) {
            return;


I wonder if we should return Promise.resolve()` here to be consistent.

marcaaron · 2023-09-26T04:21:14Z

Just to go back to the linked issue for a second and hope to understand the problem better...

ReadOldestAction fails

We call SaveResponseInOnyx but response is undefined

Why is the response undefined and how does it fail?

luacmartins · 2023-09-26T04:32:39Z

It seems like this fetch call fails and we don't catch it

src/libs/Middleware/SaveResponseInOnyx.js

melvin-bot · 2023-10-03T17:45:56Z

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

situchan · 2023-10-03T18:11:30Z

src/libs/Middleware/SaveResponseInOnyx.js

-        if (!response) {
-            return;
-        }
+    return requestResponse.then((response = {}) => {
        const onyxUpdates = response.onyxData;


I wonder if there's case of response = null, which will make crash on this line.

I haven't come across that case yet since I've only seen response = undefined or an actual response object. I could add the null check back if we think it's valuable

situchan · 2023-10-04T07:04:28Z

It was difficult for me to test ReadOldestAction api command.
Instead, I tested OpenPaymentsPage command and confirmed failureData is applied correctly.

App/src/libs/actions/PaymentMethods.js

Lines 46 to 52 in 7f063c7

    
           failureData: [ 
        
               { 
        
                   onyxMethod: Onyx.METHOD.MERGE, 
        
                   key: ONYXKEYS.IS_LOADING_PAYMENT_METHODS, 
        
                   value: false, 
        
               }, 
        
           ],

Before fix:

before.mov

After fix:

after.mov

melvin-bot · 2023-10-04T07:22:45Z

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

luacmartins · 2023-10-04T15:56:28Z

Had to resolve conflicts. Ready for review again.

situchan · 2023-10-04T16:10:50Z

Lint failing

luacmartins · 2023-10-04T16:24:34Z

Fixed styles 😢

tgolen · 2023-10-04T16:36:28Z

Well, that was a nice and simple fix

OSBotify · 2023-10-04T16:44:15Z

✋ 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-10-05T00:38:42Z

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

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

OSBotify · 2023-10-06T07:53:39Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.78-4 🚀

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

OSBotify · 2023-10-06T08:25:51Z

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

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

OSBotify · 2023-10-09T22:34:25Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

OSBotify · 2023-10-09T22:43:18Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

OSBotify · 2023-10-09T23:19:12Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

fix failure data update on fetch failure

7f7c23c

luacmartins self-assigned this Sep 18, 2023

luacmartins added 4 commits September 18, 2023 17:33

return promise

01181bf

fix tests

db65e70

Merge branch 'main' into cmartins-fixFailedToFetch

2d03318

apply failureData for fetch failures

fbaaac8

luacmartins force-pushed the cmartins-fixFailedToFetch branch from 09b7377 to fbaaac8 Compare September 21, 2023 09:13

luacmartins added 3 commits September 21, 2023 17:17

apply onyx update for requests without response

e663d93

use optional chaining

d4bbf03

fix style

2cf25c1

tgolen reviewed Sep 26, 2023

View reviewed changes

marcaaron reviewed Sep 26, 2023

View reviewed changes

src/libs/Middleware/SaveResponseInOnyx.js Outdated Show resolved Hide resolved

src/libs/Middleware/SaveResponseInOnyx.js Outdated Show resolved Hide resolved

luacmartins added 2 commits October 3, 2023 11:32

Merge branch 'main' into cmartins-fixFailedToFetch

51cf955

revert changes, use empty object default for response

5e8de92

luacmartins requested review from tgolen, danieldoglas and marcaaron October 3, 2023 17:45

luacmartins marked this pull request as ready for review October 3, 2023 17:45

luacmartins requested a review from a team as a code owner October 3, 2023 17:45

melvin-bot bot requested review from situchan and removed request for a team October 3, 2023 17:45

situchan reviewed Oct 3, 2023

View reviewed changes

marcaaron previously approved these changes Oct 3, 2023

View reviewed changes

danieldoglas previously approved these changes Oct 3, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath October 4, 2023 07:22

resolve conflicts

1ec33c5

luacmartins dismissed stale reviews from danieldoglas and marcaaron via 1ec33c5 October 4, 2023 15:56

luacmartins requested review from danieldoglas and marcaaron October 4, 2023 15:56

danieldoglas previously approved these changes Oct 4, 2023

View reviewed changes

fix style

6a40f69

luacmartins dismissed danieldoglas’s stale review via 6a40f69 October 4, 2023 16:24

luacmartins requested a review from danieldoglas October 4, 2023 16:24

tgolen approved these changes Oct 4, 2023

View reviewed changes

tgolen merged commit 743a041 into main Oct 4, 2023
14 checks passed

tgolen deleted the cmartins-fixFailedToFetch branch October 4, 2023 16:36

OSBotify mentioned this pull request Oct 5, 2023

Deploy Checklist: New Expensify 2023-10-05 #28883

Closed

57 tasks

bernhardoj mentioned this pull request Oct 6, 2023

[$1000] Workspace -User needs to tap ‘Back’ twice to return to previous screen from ‘Connect BA' offline #21277

Closed

6 tasks

melvin-bot bot mentioned this pull request Oct 6, 2023

[HOLD for payment 2023-10-13] Chat - Chat history not loading after returning from offline #26143

Closed

6 tasks

OSBotify mentioned this pull request Oct 6, 2023

Deploy Checklist: New Expensify 2023-10-06 #28983

Closed

tienifr mentioned this pull request Oct 19, 2023

[HOLD for payment 2023-10-13] [HOLD for payment 2023-10-12] [$500] Dev: Web - Hmm it's not there message appears if open private notes in offline mode #27591

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Apply Onyx failureData on fetch failure #27650

Apply Onyx failureData on fetch failure #27650

luacmartins commented Sep 18, 2023 •

edited

Loading

luacmartins commented Sep 21, 2023

luacmartins commented Sep 26, 2023

tgolen left a comment

tgolen Sep 26, 2023

marcaaron commented Sep 26, 2023 •

edited

Loading

luacmartins commented Sep 26, 2023

melvin-bot bot commented Oct 3, 2023

situchan Oct 3, 2023

luacmartins Oct 3, 2023

situchan commented Oct 4, 2023 •

edited

Loading

melvin-bot bot commented Oct 4, 2023

luacmartins commented Oct 4, 2023

situchan commented Oct 4, 2023

luacmartins commented Oct 4, 2023

tgolen commented Oct 4, 2023

OSBotify commented Oct 4, 2023

OSBotify commented Oct 5, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

Apply Onyx failureData on fetch failure #27650

Apply Onyx failureData on fetch failure #27650

Conversation

luacmartins commented Sep 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

luacmartins commented Sep 21, 2023

luacmartins commented Sep 26, 2023

tgolen left a comment

Choose a reason for hiding this comment

tgolen Sep 26, 2023

Choose a reason for hiding this comment

marcaaron commented Sep 26, 2023 • edited Loading

luacmartins commented Sep 26, 2023

melvin-bot bot commented Oct 3, 2023

situchan Oct 3, 2023

Choose a reason for hiding this comment

luacmartins Oct 3, 2023

Choose a reason for hiding this comment

situchan commented Oct 4, 2023 • edited Loading

melvin-bot bot commented Oct 4, 2023

luacmartins commented Oct 4, 2023

situchan commented Oct 4, 2023

luacmartins commented Oct 4, 2023

tgolen commented Oct 4, 2023

OSBotify commented Oct 4, 2023

OSBotify commented Oct 5, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 6, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

OSBotify commented Oct 9, 2023

luacmartins commented Sep 18, 2023 •

edited

Loading

marcaaron commented Sep 26, 2023 •

edited

Loading

situchan commented Oct 4, 2023 •

edited

Loading