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: Web - Split - Enter and CMD+Enter open user profile instead of splitting expense. #43794

Merged
merged 8 commits into from
Jul 19, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Jun 15, 2024

Details

Fixed Issues

$ #41848
PROPOSAL: #41848 (comment)

Tests

  1. Go to group chat.
  2. Go to + > Split expense.
  3. Enter amount > Next.
  4. On confirmation page, hit CMD+Enter.
  5. Verify the request is submitted.
  6. Repeat step 2 and 3 > hit Enter
  7. Verify the request is submitted.
  8. Repeat step 2 and 3
  9. Focus on any amount input using tab key > hit Enter
  10. Verify the request is submitted.
  11. Repeat step 2 and 3
  12. Focus on any participant using up/down arrow key > hit Enter
  13. Verify participant details page is opened.
  14. Go back and Focus on any participant using up/down arrow key
  15. After participant is focused use Tab key to focus amount input
  16. Hit CMD+Enter/Enter > Verify the request is submitted
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to group chat.
  2. Go to + > Split expense.
  3. Enter amount > Next.
  4. On confirmation page, hit CMD+Enter.
  5. Verify the request is submitted.
  6. Repeat step 2 and 3 > hit Enter
  7. Verify the request is submitted.
  8. Repeat step 2 and 3
  9. Focus on any amount input using tab key > hit Enter
  10. Verify the request is submitted.
  11. Repeat step 2 and 3
  12. Focus on any participant using up/down arrow key > hit Enter
  13. Verify participant details page is opened.
  14. Go back and Focus on any participant using up/down arrow key
  15. After participant is focused use Tab key to focus amount input
  16. Hit CMD+Enter/Enter > Verify the request is submitted

QA Steps

  1. Go to group chat.
  2. Go to + > Split expense.
  3. Enter amount > Next.
  4. On confirmation page, hit CMD+Enter.
  5. Verify the request is submitted.
  6. Repeat step 2 and 3 > hit Enter
  7. Verify the request is submitted.
  8. Repeat step 2 and 3
  9. Focus on any amount input using tab key > hit Enter
  10. Verify the request is submitted.
  11. Repeat step 2 and 3
  12. Focus on any participant using up/down arrow key > hit Enter
  13. Verify participant details page is opened.
  14. Go back and Focus on any participant using up/down arrow key
  15. After participant is focused use Tab key to focus amount input
  16. Hit CMD+Enter/Enter > Verify the request is submitted
  • 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_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

…plitting expense.

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@Krishna2323 Krishna2323 requested a review from a team as a code owner June 15, 2024 02:48
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team June 15, 2024 02:48
Copy link

melvin-bot bot commented Jun 15, 2024

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

@mananjadhav
Copy link
Collaborator

@Krishna2323 Can you confirm if this is resolved and it's ready for review?

@Krishna2323
Copy link
Contributor Author

@mananjadhav, no that's not resolved, still looking for a solution, I will explain the problem if I couldn't resolve it today.

@Krishna2323
Copy link
Contributor Author

@mananjadhav,

When the dropdown button has multiple option, we are not setting the buttonRef.

ref={(ref) => {
caretButton.current = ref;
}}

But when we have simple button the buttonRef is correctly set and the press works?

Why do we need the buttonRef? The buttonRef is required because SettlementButton uses KYCWall and in KYCWall we need the anchorRef (buttonRef) to open the options popover if there are multiple.

// Use event target as fallback if anchorRef is null for safety
const targetElement = anchorRef.current ?? (event?.currentTarget as HTMLDivElement);

@Krishna2323
Copy link
Contributor Author

@mananjadhav, Directly setting the ref like ref={buttonRef} would work but we also have to set caretButton.So I think we can use useEffect to set the caretButton.

ref={(ref) => {
caretButton.current = ref;
}}

Setting the buttonRef like this won't work and it will throw an error, Cannot assign to 'current' because it is a read-only property.

 ref={(ref) => { 
     caretButton.current = ref; 
     buttonRef.current = ref;
 }} 

Signed-off-by: Krishna Gupta <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

Pls checkout 7c4f38e

@mananjadhav
Copy link
Collaborator

@Krishna2323 Using useEffect is fine. I wanted to confirm why did we disable the eslint rule?

@mananjadhav
Copy link
Collaborator

@Krishna2323 Is this ready for review? Can you please sync the latest main here?

@Krishna2323
Copy link
Contributor Author

@mananjadhav, this is ready, I will check the eslint rule in few moments.

Signed-off-by: krishna2323 <belivethatkg@gmail.com>
@Krishna2323
Copy link
Contributor Author

@mananjadhav, eslint rule removed.

@mananjadhav
Copy link
Collaborator

The code change looks fine to me. Will get this tested today.

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jul 14, 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
android-split-on-enter.mov
Android: mWeb Chrome
mweb-chrome-split-on-enter.mov
iOS: Native
ios-split-on-enter.mov
iOS: mWeb Safari
mweb-safari-split-on-enter.mov
MacOS: Chrome / Safari
web-split-on-enter-1.mov
web-split-on-enter-2.mov
MacOS: Desktop
desktop-split-on-enter-1.mov

@melvin-bot melvin-bot bot requested a review from mountiny July 16, 2024 21:53
mountiny
mountiny previously approved these changes Jul 19, 2024
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.

@Krishna2323 thanks, can you please add that one missing doc?

src/components/SettlementButton.tsx Show resolved Hide resolved
Signed-off-by: krishna2323 <belivethatkg@gmail.com>
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.

Thanks! @mananjadhav @Krishna2323 lets be on a look out for regressions, these PRs are often tricky

@mountiny mountiny merged commit 331309f into Expensify:main Jul 19, 2024
10 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.

@rlinoz
Copy link
Contributor

rlinoz commented Jul 22, 2024

Hey, this is preventing drop down buttons to work entirely

Screen.Recording.2024-07-22.at.17.31.32.mov

Reverting it here: #45964

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

}
caretButton.current = buttonRef.current;
}, [buttonRef, options.length, shouldAlwaysShowDropdownMenu]);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mananjadhav @mountiny, this code caused the regression, I have found the solution and will raise PR today. We need to use mergeRefs instead of this.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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.

5 participants