Add logs for backend reachability and SequentialQueue #43227

marcaaron · 2024-06-06T21:36:15Z

This PR just adds a bunch of logs to help debug what's happening with the network connection and the sequential queue.

Note

This change is platform independent so I'm only testing it and providing screenshots for web

Details

Fixed Issues

Part of #43253 (linking like this since this PR doesn't explicitly fix the issue, only helps triage it

Tests

In the JS console, filter for logs beginning with [info] [Network]
Go offline
Go back online
Check the logs to verify the new logs are appearing

Verify that no errors appear in the JS console

Offline tests

Included above

QA Steps

Same as the above

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

tgolen · 2024-06-06T21:49:18Z

src/libs/NetworkConnection.ts

                    return;
                }
                checkInternetReachability().then((isInternetReachable: boolean) => {
                    setOfflineStatus(!isInternetReachable);
                    setNetWorkStatus(isInternetReachable);
-                    NetworkActions.setIsBackendReachable(false);
+                    NetworkActions.setIsBackendReachable(false, 'request succeeded, but internet reachability test failed');


This doesn't have anything to do with the reachability test, so I think it should be moved outside the promise (same as below). I think the intention is to always set it to false if the ping fails for any reason, but that doesn't mean the internet is reachable or not.

tgolen · 2024-06-06T21:50:20Z

src/libs/Network/SequentialQueue.ts

        return;
    }

-    if (isSequentialQueueRunning || PersistedRequests.getAll().length === 0) {
+    if (PersistedRequests.getAll().length === 0) {
+        console.debug('[SequentialQueue] Unable to flush. No requests to process.');


I'd be game to changing all of these to Log.info(). It would have been really helpful for debugging Doza's case where we had to look at logs from the previous day.

tgolen · 2024-06-06T21:54:42Z

src/libs/actions/Network.ts


-function setIsBackendReachable(isBackendReachable: boolean) {
+function setIsBackendReachable(isBackendReachable: boolean, reason: string) {
+    if (isBackendReachable) {


It would be great to add this same log for setIsOffline() below.

marcaaron · 2024-06-07T01:53:27Z

Ah shucks, I tried to get this one done today, but heading OOO now. Please feel free to take over @tgolen

tgolen · 2024-06-07T14:50:16Z

OK, will do!

…achability

melvin-bot · 2024-06-07T20:07:40Z

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

tgolen · 2024-06-10T13:06:05Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

MacOS: Desktop

OSBotify · 2024-06-10T13:16:57Z

✋ 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-06-11T22:28:53Z

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

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

OSBotify · 2024-06-13T15:31:29Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.82-4 🚀

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

Add logs for backend reachability and SequentialQueue

a6cafa0

tgolen requested changes Jun 6, 2024

View reviewed changes

tgolen self-assigned this Jun 7, 2024

tgolen added 8 commits June 7, 2024 10:11

Merge branch 'main' into marcaaron-addLogsForSequentialQueueBackendRe…

6fbb599

…achability

Prettier

69a4c79

Change debug to logs

4f8ec01

Move check outside of promise

ed85fec

Add more logs for when going offline

98e2e5b

Default reason to a blank screen

e404d1c

Restructure logic for optional reason

cfb586c

Fix another default variable

41ff6a2

tgolen marked this pull request as ready for review June 7, 2024 20:07

tgolen requested a review from a team as a code owner June 7, 2024 20:07

melvin-bot bot requested review from nkuoch and removed request for a team June 7, 2024 20:07

nkuoch approved these changes Jun 7, 2024

View reviewed changes

tgolen approved these changes Jun 10, 2024

View reviewed changes

tgolen merged commit 350b7ab into main Jun 10, 2024
16 checks passed

tgolen deleted the marcaaron-addLogsForSequentialQueueBackendReachability branch June 10, 2024 13:09

github-actions bot mentioned this pull request Jun 11, 2024

Deploy Checklist: New Expensify 2024-06-11 #43515

Closed

59 tasks

tgolen mentioned this pull request Jun 14, 2024

[CRITICAL] UX RELIABILITY - Receipt is stuck in a scanning state and the expense fails to load when the IOU preview is tapped #43253

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add logs for backend reachability and SequentialQueue #43227

Add logs for backend reachability and SequentialQueue #43227

marcaaron commented Jun 6, 2024 •

edited by tgolen

Loading

tgolen Jun 6, 2024

tgolen Jun 6, 2024

tgolen Jun 6, 2024

marcaaron commented Jun 7, 2024

tgolen commented Jun 7, 2024

melvin-bot bot commented Jun 7, 2024

tgolen commented Jun 10, 2024 •

edited

Loading

OSBotify commented Jun 10, 2024

OSBotify commented Jun 11, 2024

OSBotify commented Jun 13, 2024

Add logs for backend reachability and SequentialQueue #43227

Add logs for backend reachability and SequentialQueue #43227

Conversation

marcaaron commented Jun 6, 2024 • edited by tgolen Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

tgolen Jun 6, 2024

Choose a reason for hiding this comment

tgolen Jun 6, 2024

Choose a reason for hiding this comment

tgolen Jun 6, 2024

Choose a reason for hiding this comment

marcaaron commented Jun 7, 2024

tgolen commented Jun 7, 2024

melvin-bot bot commented Jun 7, 2024

tgolen commented Jun 10, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jun 10, 2024

OSBotify commented Jun 11, 2024

OSBotify commented Jun 13, 2024

marcaaron commented Jun 6, 2024 •

edited by tgolen

Loading

tgolen commented Jun 10, 2024 •

edited

Loading