Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[No QA] Use Ping endpoint for internet reachability instead of API root #18460

Merged
merged 6 commits into from
May 15, 2023

Conversation

roryabraham
Copy link
Contributor

@roryabraham roryabraham commented May 4, 2023

HOLD on https://github.com/Expensify/Web-Expensify/pull/37294

Details

Pings a new API endpoint that makes sure our database is reachable in addition to just our API's webserver. Note: This doesn't seem to affect Android. From the react-native-community/netinfo docs:

[reachabilityTest is] only used on platforms which do not supply internet reachability natively or if useNativeReachability is false.

The native reachability APIs are generally much faster and more reliable than the polling mechanism used by web, so I'm not sure we should set useNativeReachability=false

Fixed Issues

$ #9211

Tests

This must be tested by an Expensify engineer.

  1. Hardcode this conditional to true
  2. Open the network console, verify that internetReachability requests go to api?command=Ping. They should respond with a jsonCode of 200. You should also see a status field of UP (though we're not using that.
  3. In your Expensidev VM, run sudo systemctl stop auth
  4. Back in the browser, Ping API commands should start responding with a jsonCode of 502, and the app should switch to offline mode.
  5. In your Expensidev VM, run sudo systemctl restart auth
  6. Back in the browser, Ping should go back to responding with 200 and the app should go back online.
  • Verify that no errors appear in the JS console

Offline tests

This is kind of all related to online/offline.

QA Steps

None

  • 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
    • 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 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 image image image
Mobile Web - Chrome
Mobile Web - Safari
Desktop image image image
iOS
iOS.mov
Android

@roryabraham roryabraham self-assigned this May 4, 2023
@roryabraham roryabraham changed the title [HOLD] Use Ping endpoint for internet reachability instead of API root [HOLD] [No QA] Use Ping endpoint for internet reachability instead of API root May 4, 2023
@roryabraham roryabraham marked this pull request as ready for review May 5, 2023 00:04
@roryabraham roryabraham requested a review from a team as a code owner May 5, 2023 00:04
@melvin-bot melvin-bot bot removed the request for review from a team May 5, 2023 00:04
@melvin-bot
Copy link

melvin-bot bot commented May 5, 2023

@mananjadhav @cristipaval 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]

@roryabraham roryabraham removed the request for review from mananjadhav May 5, 2023 00:22
@roryabraham
Copy link
Contributor Author

Removing C+ review because it's not possible for @mananjadhav to test this

src/libs/NetworkConnection.js Outdated Show resolved Hide resolved
# Conflicts:
#	src/libs/NetworkConnection.js
@roryabraham
Copy link
Contributor Author

Conflicts resolved and PR updated.

@roryabraham roryabraham requested a review from iwiznia May 9, 2023 22:21
@roryabraham roryabraham changed the title [HOLD] [No QA] Use Ping endpoint for internet reachability instead of API root [No QA] Use Ping endpoint for internet reachability instead of API root May 13, 2023
@cristipaval cristipaval merged commit fa01696 into main May 15, 2023
@cristipaval cristipaval deleted the Rory-PingAuth branch May 15, 2023 10:10
@Beamanator
Copy link
Contributor

Looks like this should have been on hold for https://github.com/Expensify/Web-Expensify/pull/37294 😅

@Beamanator
Copy link
Contributor

Actually I don't understand how this calls the Ping endpoint so I'm not sure anymore 😅

@mountiny
Copy link
Contributor

I have CPed the Web PR but I am seeing this in the logs
image

I will revert this PR as it seems like its the rootcause

@@ -82,7 +82,16 @@ function subscribeToNetInfo() {
// When App is served locally (or from Electron) this address is always reachable - even offline
// Using the API url ensures reachability is tested over internet
reachabilityUrl: `${CONFIG.EXPENSIFY.DEFAULT_API_ROOT}api`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn this have the Ping command in the ULR?

@Julesssss
Copy link
Contributor

Revert PR

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.14-1 🚀

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

@cristipaval
Copy link
Contributor

Looks like this should have been on hold for Expensify/Web-Expensify#37294 😅

sorry for merging it. I did it because I saw that the title was updated and the hold was removed 😬

@Julesssss
Copy link
Contributor

No worries, we're merging things manically for EC3 at the moment and it's not ideal.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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

@roryabraham
Copy link
Contributor Author

Shit, took this off HOLD too early.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants