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

Call listenForReconnect on App init #10314

Merged
merged 6 commits into from
Aug 11, 2022
Merged

Call listenForReconnect on App init #10314

merged 6 commits into from
Aug 11, 2022

Conversation

yuwenmemon
Copy link
Contributor

@yuwenmemon yuwenmemon commented Aug 8, 2022

Pullerbearing (@aldo-expensify)
cc @luacmartins and @NikkiWines for a second set of eyes

Details

We are not Subscribing to NetInfo until we enter the AuthScreens, which means we don't track online/offline status until you sign in. Calling listenForReconnect allows us to do that.

Fixed Issues

$ #10219

Tests/QA

  1. Go to the sign in page of new Expensify
  2. Enter your login details but not your password
  3. Press Forgot? on the password page
  4. Go offline
  5. Verify that you see the offline status indicator:

Screen Shot 2022-08-08 at 3 59 35 PM

  1. Go online and sign in
  2. Once signed in, go offline again
  3. Verify that you see the offline status indicator again under the chat input box.
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

@yuwenmemon yuwenmemon self-assigned this Aug 8, 2022
@yuwenmemon yuwenmemon requested a review from a team as a code owner August 8, 2022 23:00
@melvin-bot melvin-bot bot requested review from aldo-expensify and removed request for a team August 8, 2022 23:00
NikkiWines
NikkiWines previously approved these changes Aug 9, 2022
Copy link
Contributor

@NikkiWines NikkiWines left a comment

Choose a reason for hiding this comment

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

Works like a charm 👍

@@ -252,6 +252,7 @@ function openProfile() {
}

// When the app reconnects from being offline, fetch all initialization data
NetworkConnection.listenForReconnect();
Copy link
Contributor

@luacmartins luacmartins Aug 9, 2022

Choose a reason for hiding this comment

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

Hmm I'm not sure that we should be calling listenForReconnect here, nor onReconnect for that matter (my bad 😅 ). The reason being that it also registers our reconnect callbacks even when the user is not logged in! You can see calls to ReconnectApp being triggered when you are logged out and come back online, which will inevitably fail with a session expired error.

I think that we should clean this up by:

  1. Call subscribeToNetInfo in Expensify.js. Now we subscribe both our public and auth screens to NetInfo.
  2. Remove subscribeToNetInfo from listenForReconnect here
  3. Move this call to onReconnect to AuthScreens' componentDidMount method

Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! That's a great insight. I can give that a try and see how it works.

@yuwenmemon
Copy link
Contributor Author

Updated and retested!

Copy link
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

I think the offline state is not being kept correctly, do this steps:

  1. try to login with account that doesn't exists
  2. make yourself offline (chrome dev tools - network tab)
  3. you will see the offline indicator 👍
  4. click "Back"
  5. The offline indicator is gone and the "Continue" button is enabled, even if you are still offline. Clicking "Continue" now will put you in an endless spinner.
Screen.Recording.2022-08-09.at.3.53.17.PM.mov

@yuwenmemon
Copy link
Contributor Author

Ah good catch - it looks like we re clearing the isOffline state in the Network Onyx Key when calling clearStorageAndRedirect. Fixed!

Copy link
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

That fixed it ;)

Copy link
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

One more thing... when you are offline in the login form (Phone/email input), you can type and press enter submitting the form, even if there is no internet. This sends the requests, fails, and if you regain connection, you see the button spinning for ever. Steps:

  1. Go to the login form
  2. Disable connection
  3. Type an email and press enter
  4. See in the network tab the request being sent and failing
  5. Enable the connection
  6. The button has a permanent spinner

(this was already happening before your last change)

I guess you return early in the submit function if you detect we are offline?

validateAndSubmitForm() {
const login = this.state.login.trim();
if (!login) {
this.setState({formError: 'common.pleaseEnterEmailOrPhoneNumber'});
return;
}

@yuwenmemon yuwenmemon force-pushed the yuwen-offlineIndicator branch from c5fff92 to 757ff0c Compare August 10, 2022 17:48
@yuwenmemon
Copy link
Contributor Author

Great catch @aldo-expensify! Updated!

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Left a couple of comments. There's still a bug similar to what @aldo-expensify described before:

  1. Enter your email
  2. Click Forgot?
  3. Go offline
  4. Click back
  5. There's no offline indicator, the submit button is not disabled and submitting an email results in an endless spinner.
web.mov

src/libs/actions/SignInRedirect.js Show resolved Hide resolved
src/libs/actions/SignInRedirect.js Show resolved Hide resolved
@yuwenmemon
Copy link
Contributor Author

@luacmartins are you sure you are on the most recent version of the branch? This is not happening for me:

Kapture.2022-08-10.at.16.47.08.mp4

@luacmartins
Copy link
Contributor

Lol I thought I had pulled the latest changes, but clearly not 🤣 Sorry about that! LGTM! The change from enabled -> disabled when we go back from Forgot to the LoginForm seems jarring but NAB IMO

@yuwenmemon yuwenmemon merged commit ddfc956 into main Aug 11, 2022
@yuwenmemon yuwenmemon deleted the yuwen-offlineIndicator branch August 11, 2022 18:53
@OSBotify
Copy link
Contributor

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

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.

5 participants