Fix network connection multiple reachablity request #44901

OlimpiaZurek · 2024-07-05T13:14:10Z

Details

This PR changes the network connection logic to remove the hasPendingNetworkCheck flag, delegating its responsibility to the NetInfo library.
The goal is to simplify the code and rely on the library's internal mechanisms for managing pending network checks.

Fixed Issues

$ #44269
PROPOSAL:

Tests

Switch to offline (simulate this using Chrome's devtools Network tab)
See this network log appearing every 60s:

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: 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

melvin-bot · 2024-07-05T13:14:39Z

@hayata-suenaga 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]

srikarparsi · 2024-07-08T07:39:45Z

I can take this @hayata-suenaga, assigned to the associated issue

srikarparsi · 2024-07-09T19:00:39Z

Hi @OlimpiaZurek! Do you think you could add tests similar to this issue to make sure everything still works?

OlimpiaZurek · 2024-07-10T10:52:42Z

@srikarparsi I added test steps to the description.

muttmuure · 2024-07-10T15:02:03Z

@rushatgabhane can you help move this one along?

rushatgabhane · 2024-07-10T23:29:42Z

might be a dumb question. do patches not require any changes in package.json?

rushatgabhane

@OlimpiaZurek im not sure if this is fixing the issue. The ping command is being made constantly. That is what we're attempting to fix, right?

Go offline
Navigate to a different report

Screen.Recording.2024-07-11.at.02.31.47.mov

OlimpiaZurek · 2024-07-11T08:56:15Z

might be a dumb question. do patches not require any changes in package.json?

no additional changes to package.json are required if you we simply updating an existing patch

rushatgabhane · 2024-07-11T09:09:50Z

thank you!

@OlimpiaZurek what are your thoughts on #44901 (review)

OlimpiaZurek · 2024-07-11T09:11:08Z

@rushatgabhane The purpose of this fix is to prevent excessive Ping and Reconnect commands when there is a poor internet connection. More details can be found here..
Please see the screenshots attached below the issue description: #44269 (comment)

This issue is challenging to reproduce, but our investigation revealed that it might be caused by the NetInfo library sending multiple reachability requests in parallel. So, we fixed it and patched this fix to the react-native-netinfo library.

The behavior in the attached video works as expected. The check for internet reachability should occur every 5 seconds when the internet was not previously detected (offline mode).

rushatgabhane · 2024-07-11T12:04:37Z

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

Screen.Recording.2024-07-11.at.16.mp4

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-07-11.at.16.mp4

iOS: mWeb Safari

Screen.Recording.2024-07-11.at.16.18.30.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-11.at.02.31.47.mov

MacOS: Desktop

Screen.Recording.2024-07-11.at.16.25.59.mov

rushatgabhane

LGTM

srikarparsi

lgtm

srikarparsi · 2024-07-11T19:17:40Z

Let's make sure to test this on staging as well thoroughly

OSBotify · 2024-07-11T19:29:07Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

MrRefactor · 2024-07-12T12:51:00Z

patches/@react-native-community+netinfo+11.2.1+002+turbomodule.patch

@@ -2609,32 +2619,6 @@ index 6982220..b515270 100644
 +    readonly eventEmitter: NativeEventEmitter;
 };
 export default _default;
-diff --git a/node_modules/@react-native-community/netinfo/package.json b/node_modules/@react-native-community/netinfo/package.json


Hey @OlimpiaZurek what is the reason for this change? codegen config is necessary for newArch builds

@MrRefactor This change was applied automatically when patching the netinfo library using the patch-package. I checked and it looks like netinfo supports new arch, so it should work for newArch builds.

based on this PR react-native-netinfo/react-native-netinfo#655 that change is necessary, for me without that change, 0.74 builds are failing

Got it. I will prepare a PR to revert this change.

OSBotify · 2024-07-15T21:05:35Z

🚀 Deployed to staging by https://github.com/srikarparsi in version: 9.0.7-3 🚀

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

OSBotify · 2024-07-15T22:14:19Z

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 9.0.7-4 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-17T00:20:58Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.7-8 🚀

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

OSBotify · 2024-07-18T13:51:05Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.8-6 🚀

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

Fix network connection multiple reachablity request

21a8552

OlimpiaZurek requested a review from a team as a code owner July 5, 2024 13:14

melvin-bot bot requested review from hayata-suenaga and removed request for a team July 5, 2024 13:14

OlimpiaZurek mentioned this pull request Jul 5, 2024

[HOLD for payment 2024-10-22] [HOLD for payment 2024-07-24] [$250] ping and ReconnectApp are called back to back on a bad wifi network #44269

Closed

6 tasks

srikarparsi self-requested a review July 8, 2024 07:39

srikarparsi removed the request for review from hayata-suenaga July 8, 2024 07:39

muttmuure requested a review from rushatgabhane July 10, 2024 15:01

rushatgabhane suggested changes Jul 10, 2024

View reviewed changes

rushatgabhane approved these changes Jul 11, 2024

View reviewed changes

srikarparsi approved these changes Jul 11, 2024

View reviewed changes

srikarparsi merged commit d7e95b0 into Expensify:main Jul 11, 2024
16 of 68 checks passed

MrRefactor reviewed Jul 12, 2024

View reviewed changes

Kicu mentioned this pull request Jul 15, 2024

[No QA] Fix missing parts of react-native-community/netinfo patch #45389

Merged

48 tasks

github-actions bot mentioned this pull request Jul 15, 2024

Deploy Checklist: New Expensify 2024-07-15 #45421

Closed

srikarparsi mentioned this pull request Aug 9, 2024

Decrease ping timeout to 2s #44541

Closed

48 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix network connection multiple reachablity request #44901

Fix network connection multiple reachablity request #44901

OlimpiaZurek commented Jul 5, 2024 •

edited

Loading

melvin-bot bot commented Jul 5, 2024

srikarparsi commented Jul 8, 2024

srikarparsi commented Jul 9, 2024

OlimpiaZurek commented Jul 10, 2024

muttmuure commented Jul 10, 2024

rushatgabhane commented Jul 10, 2024

rushatgabhane left a comment

OlimpiaZurek commented Jul 11, 2024

rushatgabhane commented Jul 11, 2024

OlimpiaZurek commented Jul 11, 2024

rushatgabhane commented Jul 11, 2024 •

edited

Loading

rushatgabhane left a comment

srikarparsi left a comment

srikarparsi commented Jul 11, 2024

OSBotify commented Jul 11, 2024

MrRefactor Jul 12, 2024

OlimpiaZurek Jul 15, 2024

MrRefactor Jul 15, 2024

OlimpiaZurek Jul 15, 2024 •

edited

Loading

OSBotify commented Jul 15, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 18, 2024

Fix network connection multiple reachablity request #44901

Fix network connection multiple reachablity request #44901

Conversation

OlimpiaZurek commented Jul 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 5, 2024

srikarparsi commented Jul 8, 2024

srikarparsi commented Jul 9, 2024

OlimpiaZurek commented Jul 10, 2024

muttmuure commented Jul 10, 2024

rushatgabhane commented Jul 10, 2024

rushatgabhane left a comment

Choose a reason for hiding this comment

OlimpiaZurek commented Jul 11, 2024

rushatgabhane commented Jul 11, 2024

OlimpiaZurek commented Jul 11, 2024

rushatgabhane commented Jul 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane left a comment

Choose a reason for hiding this comment

srikarparsi left a comment

Choose a reason for hiding this comment

srikarparsi commented Jul 11, 2024

OSBotify commented Jul 11, 2024

MrRefactor Jul 12, 2024

Choose a reason for hiding this comment

OlimpiaZurek Jul 15, 2024

Choose a reason for hiding this comment

MrRefactor Jul 15, 2024

Choose a reason for hiding this comment

OlimpiaZurek Jul 15, 2024 • edited Loading

Choose a reason for hiding this comment

OSBotify commented Jul 15, 2024

OSBotify commented Jul 15, 2024

OSBotify commented Jul 17, 2024

OSBotify commented Jul 18, 2024

OlimpiaZurek commented Jul 5, 2024 •

edited

Loading

rushatgabhane commented Jul 11, 2024 •

edited

Loading

OlimpiaZurek Jul 15, 2024 •

edited

Loading