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

Fix crashes when personal details are not available #9385

Merged
merged 9 commits into from
Jul 1, 2022

Conversation

aldo-expensify
Copy link
Contributor

@aldo-expensify aldo-expensify commented Jun 9, 2022

Details

This is fixing two cases where we can end up with a crash after tapping a user's avatar to see the personal details:

Problem 1: Only Android/IOS - tapping the avatar after opening a conversation with an account that doesn't exist

Bug and solution described here: #9182 (comment)

Problem 2: You tapped too fast and the request PersonalDetails_GetForEmails has not finished yet

When we select a new contact from the search panel, the following API requests happen:

  • CreateChatReport to create the chat
  • PersonalDetails_GetForEmails to get the personal details

If the user clicks the avatar in the conversation that opens the personal details panels before PersonalDetails_GetForEmails finishes, the app crashes.

Note on offline behaviour: You cannot create a new chat while offline, so I think there is nothing to test when offline

Fixed Issues

$ #9182

#9182 (comment)

Tests

Problem 1: Only Android/IOS

  1. Using the native app in Android or IOS
  2. Open the contact search panel
    image
  3. Search for an account that doesn't exist
  4. Tap the account to create a new conversation
  5. Tap on the avatar of the other user to open the personal details tab
  6. Personal details tab should open just fine (you may see the loading indicator for a short moment if the request PersonalDetails_GetForEmails has not finished yet)

Problem 2: You tapped too fast and the request PersonalDetails_GetForEmails has not finished yet

  1. Open the contact search panel
    image
  2. Search for an account you haven't messaged (it can be an account that doesn't exist)
  3. Click the account to open the conversation
  4. Very quickly click the avatar of the other user (can be in the center or in the bar on top) to open the personal details panel
  5. If the personal details have not loaded yet, it should show an loading indicator and not crash the App

If you have the PHP Api running locally, it is very easy to reproduce by just adding a sleep(10); in the part of the API handling the command PersonalDetails_GetForEmails

Another way of making it easier to reproduce is using chrome tools > network > throttle

QA

Same steps as Tests, and you can try using chrome tools > network > throttle to make it easier to click the avatar before the request has finished.

  • 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
  • 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.

PR Reviewer Checklist

  • 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 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.

QA Steps

  • Verify that no errors appear in the JS console

Screenshots

Web

image
image

Mobile Web

Simulator.Screen.Recording.-.iPhone.13.-.2022-06-10.at.11.02.39.mp4

Desktop

Screen.Recording.2022-06-10.at.11.00.09.AM.mov

iOS

Simulator.Screen.Recording.-.iPhone.13.-.2022-06-10.at.10.51.28.mp4

Android

XRecorder_10062022_103832.mp4

@aldo-expensify aldo-expensify changed the title Show spinner when personal details are not available Fix crashes when personal details are not available Jun 10, 2022
@aldo-expensify aldo-expensify marked this pull request as ready for review June 10, 2022 19:49
@aldo-expensify aldo-expensify requested review from marcaaron and a team as code owners June 10, 2022 19:49
@melvin-bot melvin-bot bot requested review from amyevans and removed request for a team June 10, 2022 19:49
@aldo-expensify
Copy link
Contributor Author

aldo-expensify commented Jun 10, 2022

image

I think I may have miss-clicked and dragged Marc into the review, unless there is a feature that I don't know of that always includes Marc 😆

@marcaaron
Copy link
Contributor

I just added myself as a "code owner" (kind of hate this name as I don't own anything) as it's the easiest way to subscribe to changes on some specific files that I'm interested in. Usually removing myself if I have nothing to add.

@aldo-expensify
Copy link
Contributor Author

I just added myself as a "code owner" (kind of hate this name as I don't own anything) as it's the easiest way to subscribe to changes on some specific files that I'm interested in. Usually removing myself if I have nothing to add.

I see! good to know :)

Comment on lines 410 to 414
// Waiting until ONYX variables are loaded before displaying the component
if (_.isEmpty(this.props.personalDetails)) {
return null;
}

Copy link
Contributor Author

@aldo-expensify aldo-expensify Jun 10, 2022

Choose a reason for hiding this comment

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

Hum, I think this may cause a white screen to show for a few moments. Maybe I should have put a spinner. I'll try that if the whole approach makes sense.

@@ -403,6 +407,11 @@ class ReportActionsView extends React.Component {
return null;
}

// Waiting until ONYX variables are loaded before displaying the component
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably we are not waiting for Onyx, but the API response to set these expected details?

Copy link
Contributor

Choose a reason for hiding this comment

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

Would also maybe consider moving this to the ReportScreen... seems we have a few "loading" type interactions there and instead of returning null we can show the loading state?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I retested this and I didn't find any case where _.isEmpty(this.props.personalDetails) is true. At this point I'm not sure why I added it.

I just removed it, I don't think it makes sense because:

  • if this.props.personalDetails is an empty object, we won't crash when we open the DetailsPage because of the new spinner
  • ReportActionsView doesn't really use the personal details, so it is wrong to hold it from rendering because PersonalDetails are not ready
  • if this.props.personalDetails is null or undefined, it would crash earlier here

@aldo-expensify
Copy link
Contributor Author

Update: removed useless check

@@ -127,7 +131,7 @@ class ReportActionsView extends React.Component {

// If the reportID is not found then we have either not loaded this chat or the user is unable to access it.
// We will attempt to fetch it and redirect if still not accessible.
if (!this.props.report.reportID) {
if (!this.props.report.reportID || !this.props.personalDetails[this.props.report.reportID]) {
Copy link
Contributor

Choose a reason for hiding this comment

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

The personalDetails object has a key that is a reportID? IIRC personalDetails are keyed by logins.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are totally right about that... investigating more...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the long wait. I think I found a better way to handle this stuff:

Just like Report.fetchChatReportsByIDs chains a call to PersonalDetails.getFromReportParticipants here, I chained a PersonalDetails.getFromReportParticipants call here when we call Reports.fetchOrCreateChatReport. This way we don't depend on Report.fetchChatReportsByIDs being called (which happens inconsistently depending on the platform as explained here)

I know the new API refactor avoids chaining, but this is an easy fix, consistent with the old chaining approach and fixes the crash for IOS/Android, so I think it is fine as a temporary solution until all this gets refactored.

Comment on lines 73 to 75
<View style={[styles.flex1, styles.alignItemsCenter, styles.justifyContentCenter]}>
<ActivityIndicator color={themeColors.spinner} size="large" />
</View>
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB, but you could use the <FullscreenLoadingIndicator /> component here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll give it a try, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, that works. Because of the name, I assumed it would block the whole screen and not just the sidebar.

@aldo-expensify
Copy link
Contributor Author

Friendly bump @marcaaron

@marcaaron marcaaron merged commit f19a4d9 into main Jul 1, 2022
@marcaaron marcaaron deleted the aldo_fix-crash-missing-personal-details branch July 1, 2022 01:15
@OSBotify
Copy link
Contributor

OSBotify commented Jul 1, 2022

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

@@ -66,6 +67,10 @@ const getPhoneNumber = (details) => {

const DetailsPage = (props) => {
const details = props.personalDetails[props.route.params.login];
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that this line is probably what is causing this crash: #9545

It doesn't seem like a very safe way to access properties. It appears like there can be cases where props.route.params is undefined. Is that a valid case? Should this use lodashGet instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think you are right. If you just open https://new.expensify.com/details without the param login, it crashes. I'll spin a small PR to fix it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, this feels low priority, I don't know how a user ended up with the URL without the parameter.

@OSBotify
Copy link
Contributor

OSBotify commented Jul 8, 2022

🚀 Deployed to staging by @marcaaron in version: 1.1.81-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @roryabraham in version: 1.1.82-5 🚀

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

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