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

perf: Reduce heavy operations in Request Money flow #39063

Merged

Conversation

TMisiukiewicz
Copy link
Contributor

@TMisiukiewicz TMisiukiewicz commented Mar 27, 2024

Details

Fixed Issues

$ #39133
PROPOSAL:

Tests

Steps for Scan tab

  1. Upload a receipt/take a photo
  2. Press Next

Steps for Manual tab

  1. Go to "Manual tab"
  2. Fill the amount
  3. Press "Next"

Steps for Distance tab

  1. Go to Distance tab
  2. Fill the Start and Stop
  3. Press "Next"

Request money from workspace - test it in Scan/Manual/Distance tabs

  1. Tap Global Create
  2. Tap Request Money
  3. Follow the steps for Scan/Manual/Distance
  4. Type "workspace" in search and verify it is not blocking UI while typing
  5. Tap the workspace name
  6. Verify you've been moved to the next step smoothly

Split - workspace - test it in Scan/Manual/Distance tabs

  1. Tap Global Create
  2. Tap Request Money
  3. Follow the steps for Scan/Manual/Distance
  4. Type "workspace" in search and verify it is not blocking UI while typing
  5. Press "Split" next to the workspace name and press "Next"
  6. Verify you've been moved to the next step smoothly and workspace name is visible in the "Split with"

Split - users - test it in Scan/Manual/Distance tabs

  1. Tap Global Create
  2. Tap Request Money
  3. Follow the steps for Scan/Manual/Distance
  4. Press "Split" next to at least two users
  5. Press "Next"
  6. Verify you've been moved to the next step and users are visible in the "Split with"

Send money

  1. Tap Global Create
  2. Tap Send Money
  3. Type any existing user name/email in search and verify it is not blocking UI while typing
  4. Tap the user name
  5. Verify you've been moved to the next step smoothly

Request from DM - test it in Scan/Manual/Distance tabs

  1. Open a DM
  2. Open a create menu
  3. Press "Request money"
  4. Follow the steps for Scan/Manual
  5. Verify you've been moved to the next step

Send money from DM - test it in Scan/Manual/Distance tabs

  1. Open a DM
  2. Open a create menu
  3. Press "Send money"
  4. Fill the amount of money
  5. Verify you've been moved to the next step

Request from workspace chat - test it in Scan/Manual/Distance tabs

  1. Open a workspace chat
  2. Open a create menu
  3. Press "Request money"
  4. Follow the steps for Scan/Manual/Distance
  5. Verify you've been moved to the next step

Split bill from workspace chat - test it in Scan/Manual/Distance tabs

  1. Open a workspace chat
  2. Open a create menu
  3. Press "Split bill"
  4. Follow the steps for Scan/Manual/Distance
  5. Verify you've been moved to the next step
  • Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Steps for Scan tab

  1. Upload a receipt/take a photo
  2. Press Next

Steps for Manual tab

  1. Go to "Manual tab"
  2. Fill the amount
  3. Press "Next"

Steps for Distance tab

  1. Go to Distance tab
  2. Fill the Start and Stop
  3. Press "Next"

Request money from workspace - test it in Scan/Manual/Distance tabs

  1. Tap Global Create
  2. Tap Request Money
  3. Follow the steps for Scan/Manual/Distance
  4. Type "workspace" in search and verify it is not blocking UI while typing
  5. Tap the workspace name
  6. Verify you've been moved to the next step smoothly

Split - workspace - test it in Scan/Manual/Distance tabs

  1. Tap Global Create
  2. Tap Request Money
  3. Follow the steps for Scan/Manual/Distance
  4. Type "workspace" in search and verify it is not blocking UI while typing
  5. Press "Split" next to the workspace name and press "Next"
  6. Verify you've been moved to the next step smoothly and workspace name is visible in the "Split with"

Split - users - test it in Scan/Manual/Distance tabs

  1. Tap Global Create
  2. Tap Request Money
  3. Follow the steps for Scan/Manual/Distance
  4. Press "Split" next to at least two users
  5. Press "Next"
  6. Verify you've been moved to the next step and users are visible in the "Split with"

Send money

  1. Tap Global Create
  2. Tap Send Money
  3. Type any existing user name/email in search and verify it is not blocking UI while typing
  4. Tap the user name
  5. Verify you've been moved to the next step smoothly

Request from DM - test it in Scan/Manual/Distance tabs

  1. Open a DM
  2. Open a create menu
  3. Press "Request money"
  4. Follow the steps for Scan/Manual
  5. Verify you've been moved to the next step

Send money from DM - test it in Scan/Manual/Distance tabs

  1. Open a DM
  2. Open a create menu
  3. Press "Send money"
  4. Fill the amount of money
  5. Verify you've been moved to the next step

Request from workspace chat - test it in Scan/Manual/Distance tabs

  1. Open a workspace chat
  2. Open a create menu
  3. Press "Request money"
  4. Follow the steps for Scan/Manual/Distance
  5. Verify you've been moved to the next step

Split bill from workspace chat - test it in Scan/Manual/Distance tabs

  1. Open a workspace chat
  2. Open a create menu
  3. Press "Split bill"
  4. Follow the steps for Scan/Manual/Distance
  5. Verify you've been moved to the next step
  • 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.mov
Android: mWeb Chrome
ANDROID.WEB.mov
iOS: Native
IOS.mp4
iOS: mWeb Safari
IOS.WEB.mp4
MacOS: Chrome / Safari
WEB.mov
MacOS: Desktop
DESKTOP.mov

@TMisiukiewicz TMisiukiewicz marked this pull request as ready for review March 28, 2024 08:43
@TMisiukiewicz TMisiukiewicz requested a review from a team as a code owner March 28, 2024 08:43
@melvin-bot melvin-bot bot requested review from akinwale and removed request for a team March 28, 2024 08:43
Copy link

melvin-bot bot commented Mar 28, 2024

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

@mountiny mountiny removed the request for review from akinwale March 28, 2024 09:28
@mountiny
Copy link
Contributor

Seeking a C+ to address this immediately

@mountiny mountiny requested a review from akinwale March 28, 2024 09:32
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

@akinwale @TMisiukiewicz Could you update the test steps to test all the various money reqeust flows?

  • Request money - manual, scan, distance
  • Send money
  • Split request
  • Test the same from within DM chat, IOU report or workspace chat
  • Test Split with workspace

})(
memo(
MoneyTemporaryForRefactorRequestParticipantsSelector,
(prevProps, nextProps) =>
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we sure we dont have to add more checks for this memo?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the memo with additional check for betas. The only non-checked props now are

  1. callback functions
  2. Onyx prop: reports

I think check for reports would need a deep equality comparision, which might be a costy operation

MoneyTemporaryForRefactorRequestParticipantsSelector,
(prevProps, nextProps) =>
_.isEqual(prevProps.participants, nextProps.participants) &&
prevProps.didScreenTransitionEnd === nextProps.didScreenTransitionEnd &&
Copy link
Contributor

@akinwale akinwale Mar 28, 2024

Choose a reason for hiding this comment

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

@TMisiukiewicz Is there a particular reason we're checking didScreenTransitionEnd here, especially as the event never fires on Android?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in this page, didScreenTransitionEnd is used to prevent generating options unless the transition ended, to avoid doing heavy calculations while animation is happening. Without checking it, we'd infinitely get stuck on the skeleton

@akinwale
Copy link
Contributor

akinwale commented Mar 28, 2024

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
39063-android-native.mp4
Android: mWeb Chrome
39063-android-chrome.mp4
iOS: Native
39063-ios-native.mp4
iOS: mWeb Safari
39063-ios-safari.mp4
MacOS: Chrome / Safari
39063-web.mp4
MacOS: Desktop
39063-desktop.mp4

@akinwale
Copy link
Contributor

@TMisiukiewicz The search term "Workspac" doesn't return results, but this is happening on main as well. Is this something we want to fix here, @mountiny?

Screen.Recording.2024-03-28.at.11.02.41.mp4

@TMisiukiewicz
Copy link
Contributor Author

@akinwale @mountiny this should be fixed once we apply the filtering from #37909 in this screen

Copy link
Contributor

@akinwale akinwale left a comment

Choose a reason for hiding this comment

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

LGTM.

@melvin-bot melvin-bot bot requested a review from mountiny March 28, 2024 13:37
@TMisiukiewicz
Copy link
Contributor Author

@mountiny test steps are up to date now

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Ok thank you, lets try this one!

@mountiny mountiny merged commit 7603719 into Expensify:main Mar 28, 2024
16 checks passed
Copy link

melvin-bot bot commented Mar 28, 2024

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot bot added the Emergency label Mar 28, 2024
@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.

@mountiny
Copy link
Contributor

Tests were passing

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.58-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-8 🚀

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants