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.

Sign up for GitHub

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

Jump to bottom

Fix crash when opening a split bill preview on an #announce room #31291

Merged
merged 4 commits into from
Nov 27, 2023
Merged

Fix crash when opening a split bill preview on an #announce room #31291

merged 4 commits into from
Nov 27, 2023

Conversation

bernhardoj
Copy link
Contributor

Details

On an #announce room, when we do a split bill and log in on other devices, the split bill preview will be in loading and show a skeleton. When we press it, the app will crash as the page expected the transaction data is ready.

Fixed Issues

$ #31136
PROPOSAL: #31136 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Create a workspace if you don't have one
  2. Open the #announce room
  3. Do a split bill in the room
  4. Log in on another device (with the same/different account, if you use a different account, make sure invite it to the workspace)
  5. Visit the #announce room
  6. The split bill preview should show as a skeleton
  7. Press the preview
  8. Verify a not found page is shown and that no crash happens.
  • 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 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 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 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 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
Screen.Recording.2023-11-14.at.14.14.56.mov
Android: mWeb Chrome
Screen.Recording.2023-11-14.at.14.12.30.mov
iOS: Native
Screen.Recording.2023-11-14.at.14.13.31.mov
iOS: mWeb Safari
Screen.Recording.2023-11-14.at.14.14.32.mov
MacOS: Chrome / Safari
Screen.Recording.2023-11-14.at.14.08.19.mov
MacOS: Desktop
Screen.Recording.2023-11-14.at.14.08.39.mov

@bernhardoj bernhardoj requested a review from a team as a code owner November 14, 2023 06:25
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team November 14, 2023 06:25
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Nov 14, 2023

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

bernhardoj
bernhardoj commented Nov 14, 2023
View reviewed changes
src/pages/iou/SplitBillDetailsPage.js Outdated
@@ -66,6 +66,7 @@ const propTypes = {
const defaultProps = {
personalDetails: {},
reportActions: {},
transaction: {},
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 decided to use the alternate solution as this also fix the prop types console error.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Nov 18, 2023 •
edited
Loading

@bernhardoj I was wondering if instead of Not found page we should just avoid making the skeleton clickable? @grgia What do you think?

web-split-bill-preview-crash.mov

and btw for some reason the skeleton view doesn't transition into the split bill view. All I see is the skeleton view, are you seeing this problem?

@bernhardoj
Copy link
Contributor Author

@mananjadhav yes, I see that problem too which I also mentioned in the proposal. Looks like that issue only happens on workspace chat.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Nov 19, 2023 •
edited
Loading

@mananjadhav yes, I see that problem too which I also mentioned in the proposal. Looks like that issue only happens on workspace chat.

@bernhardoj Yeah I am able to reproduce this on staging as well. Is the bug reported anywhere? If not then can you please report this in the issue/slack, we'll have to fix that.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Nov 19, 2023 •
edited
Loading

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 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 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(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 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 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 **Revised** https://github.com/Expensify/App/assets/3069065/5d86eacc-5dfc-412f-9181-8116d187786b

Old video
https://github.com/Expensify/App/assets/3069065/b77a5ee7-f4c7-4abd-8eff-d48a970761db

Android: mWeb Chrome

Revised
https://github.com/Expensify/App/assets/3069065/c733621f-ee4c-4e6a-9725-f9e724b83516

Old video
https://github.com/Expensify/App/assets/3069065/11f7a149-c5aa-4062-b4c3-db08e918c574

iOS: Native

Revised
https://github.com/Expensify/App/assets/3069065/7646d7b4-fa0a-405a-9b4a-adb203a84473

Old video
https://github.com/Expensify/App/assets/3069065/9c77d477-feb8-4cdd-98a1-c162d5cec5e1

iOS: mWeb Safari

Revised
https://github.com/Expensify/App/assets/3069065/3056dd3b-410d-4904-acb6-2f5d979fd48c

Old video
https://github.com/Expensify/App/assets/3069065/f9d519a5-4a64-4dc7-8f9d-2055fff5ec22

MacOS: Chrome / Safari

Revised
https://github.com/Expensify/App/assets/3069065/3bfe0b80-bb26-4a4d-ba40-1db60365eb02

Old video
https://github.com/Expensify/App/assets/3069065/d46e8afb-a986-48e2-ada1-6a725fc3531d

MacOS: Desktop

Revised
Uploading desktop-split-skeleton.mov…

Old video
https://github.com/Expensify/App/assets/3069065/b9bd2613-b7c1-4939-8d7c-e4713f24ff5f

@melvin-bot melvin-bot bot requested a review from grgia November 19, 2023 17:36
@grgia
Copy link
Contributor

grgia commented Nov 20, 2023

@bernhardoj I was wondering if instead of Not found page we should just avoid making the skeleton clickable? @grgia What do you think?

I agree that making it not clickable feels better than seeing "page not found" while loading @mananjadhav

@bernhardoj
Copy link
Contributor Author

@mananjadhav Updated the code to disable the IOU preview.

bernhardoj
bernhardoj commented Nov 20, 2023
View reviewed changes
src/components/ReportActionItem/MoneyRequestPreview.js
return (
<PressableWithFeedback
onPress={props.onPreviewPressed}
onPress={shouldDisableOnPress ? undefined : props.onPreviewPressed}
Copy link
Contributor Author

@bernhardoj bernhardoj Nov 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

We need to manually disable it by passing an undefined onPress because if we use disabled props, onLongPress will also not work and therefore long pressing an IOU preview (on a mobile screen) won't show a context menu.

bernhardoj
bernhardoj commented Nov 20, 2023
View reviewed changes
src/components/ReportActionItem/MoneyRequestPreview.js
onPressIn={() => DeviceCapabilities.canUseTouchScreen() && ControlSelection.block()}
onPressOut={() => ControlSelection.unblock()}
onLongPress={showContextMenu}
accessibilityLabel={props.isBillSplit ? props.translate('iou.split') : props.translate('iou.cash')}
accessibilityHint={CurrencyUtils.convertToDisplayString(requestAmount, requestCurrency)}
style={[styles.moneyRequestPreviewBox, ...props.containerStyles]}
style={[styles.moneyRequestPreviewBox, ...props.containerStyles, shouldDisableOnPress && styles.cursorDefault]}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

let me know if we should use default or not-allowed cursor

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 default, since that's what we do for our other skeleton UI cc @mananjadhav

mananjadhav
mananjadhav approved these changes Nov 22, 2023
View reviewed changes
Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Completed the checklist baed on the updated code and disable pressed status.

@grgia All yours.

@mananjadhav
Copy link
Collaborator

quick bump @grgia.

@grgia grgia merged commit 0c125f9 into Expensify:main Nov 27, 2023
19 checks passed
@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.

@github-actions github-actions bot mentioned this pull request Nov 27, 2023
Closed
53 tasks
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.4-0 🚀

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

@Christinadobrzyn Christinadobrzyn mentioned this pull request Nov 27, 2023
Closed
6 tasks
@lanitochka17 lanitochka17 mentioned this pull request Nov 28, 2023
Closed
6 tasks
@kbecciv kbecciv mentioned this pull request Nov 28, 2023
Closed
6 tasks
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.4-3 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grgia grgia grgia approved these changes

@mananjadhav mananjadhav mananjadhav approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bernhardoj @mananjadhav @grgia @OSBotify