fix: handle forward-delete properly in the amount text input #25815

akinwale · 2023-08-24T05:41:02Z

Details

Forward-delete in the text input means deleting text to the right hand side of the current cursor placement. This PR fixes the issue with the cursor jumping around when a forward-delete operation occurs.

Additional notes regarding the TextInputWithCurrencySymbol refactor will be posted below.

Fixed Issues

$ #25578
PROPOSAL: #25578 (comment)

Tests

Open the global create menu and then select "Request Money"
Input an amount (e.g., "12345678").
Position the cursor in between 2 or more digits, e.g. between 3 and 4 or between 4 and 5.
Press the keyboard's dedicated forward-delete button (if one is present).
Verify that a digit to the right hand side of the cursor is deleted, and the cursor does not jump around.
On Mac, press the keyboard shortcut: Fn+Delete.
Repeat step 5.
On Mac, press the keyboard shortcut: Control+D.
Repeat step 5.
Place the cursor at the end of the amount input.
Press the Backspace or Delete (on Mac) key.
Verify that the cursor does not jump a digit to the left.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests.

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 / Chrome
- iOS / native
- iOS / 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

25578-web.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

25578-desktop.mp4

iOS

Android

melvin-bot · 2023-08-24T05:41:06Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-08-24T05:41:07Z

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

akinwale · 2023-08-24T06:22:07Z

@narefyev91

I had to refactor TextInputWithCurrencySymbol by splitting it into an Android-platform specific file (index.android.js) and the the index.js for the other platforms. This is due to a change that was introduced with this PR which skips selection changes for certain updates to the text input.

This led to the issue outlined in the steps below.

Take the following value: 12345678 and place the cursor in between 2 and 3 like so: 12|345678.
Forward-delete two digits to the right of the cursor so we have the following result: 12|5678
Place the cursor at the end of the input: 125678|
Press backspace to remove the 8 in front of the cursor. Since the last selection change was skipped, this will cause the cursor to jump to the front of 7, or in some cases 6, instead of being at the end of 7, so we have 1256|7 instead of 12567|.

Since the issue that the mentioned PR fixes only happens on Android, and the related proposal mentioned creating an Android-platform specific file, I have gone ahead to do this in this PR so that other platforms can work as expected.

Forward-delete is a no-op on Android, so this regression will never happen on Android even with a hardware keyboard connected (Delete key presses are not recognised).

narefyev91 · 2023-08-24T12:03:38Z

@akinwale can you please sync your fork with latest main and also update branch and double check that code is still working

akinwale · 2023-08-24T12:24:45Z

@narefyev91 Done. Tested OK on all platforms.

I also added iOS for the Control-D shortcut, because it's possible to connect a hardware keyboard to an iPhone or an iPad, and the keyboard shortcut is recognised as forward-delete.

narefyev91 · 2023-08-24T12:43:36Z

@akinwale can you please check ios-web

Screen.Recording.2023-08-24.at.15.42.07.mov

…eyboard shortcut

akinwale · 2023-08-24T13:30:31Z

@akinwale can you please check ios-web

@narefyev91 This seems to be a weird edge-case with the way iOS Safari handles the Control key for the keyboard shortcut. I have pushed a new commit with a specific fix for this. Everything tests OK on other platforms with this change.

narefyev91 · 2023-08-24T14:36:42Z

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 / Chrome
- iOS / native
- iOS / 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 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

Web

web.mov

Mobile Web - Chrome

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

narefyev91

LGTM! Nice and complex finding!
🎀 👀 🎀 C+ reviewed

marcaaron · 2023-08-24T21:50:25Z

src/pages/iou/steps/MoneyRequestAmountForm.js

+     */
+    const textInputKeyPress = ({nativeEvent}) => {
+        const key = nativeEvent.key.toLowerCase();
+        if (Browser.isMobileSafari() && key === 'control') {


'control' -> CONST.PLATFORM_SPECIFIC_KEYS.CTRL.DEFAULT ?

Makes sense. I've seen these key constants in the past, but then I forgot all about them. It's fixed now.

akinwale · 2023-08-25T02:13:17Z

Retested on all platforms OK after fixing the merge conflict.

akinwale · 2023-08-28T12:43:59Z

@marcaaron Bump on review. I have fixed additional merge conflicts and cleaned up DRY issues with the code. I have also tested again on all platforms, after the modifications, to make sure that everything works as expected. Thanks.

akinwale · 2023-08-29T00:39:53Z

Fixed another merge conflict and retested on all platforms. At least, we're all synced with the latest main now.

OSBotify · 2023-08-29T03:01:35Z

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

OSBotify · 2023-08-30T01:53:48Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.59-0 🚀

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

OSBotify · 2023-08-31T01:03:33Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.60-0 🚀

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

OSBotify · 2023-08-31T01:46:58Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.60-0 🚀

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

OSBotify · 2023-08-31T01:54:06Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

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

OSBotify · 2023-08-31T22:51:10Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.60-3 🚀

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

akinwale requested a review from a team as a code owner August 24, 2023 05:41

melvin-bot bot removed the request for review from a team August 24, 2023 05:41

melvin-bot bot requested a review from narefyev91 August 24, 2023 05:41

akinwale mentioned this pull request Aug 24, 2023

[HOLD for payment 2023-09-07] [$500] Web - Keyboard Delete Key Functions Incorrectly: Deletes in Wrong Direction and Has No Effect #25578

Closed

6 tasks

handle forward-delete properly in the amount text input

4f8386e

akinwale force-pushed the task-25578 branch from 75a8b19 to 4f8386e Compare August 24, 2023 06:41

akinwale added 2 commits August 24, 2023 13:06

Merge remote-tracking branch 'upstream/main' into task-25578

6a0d797

handle Control-D keyboard shortcut on iOS

acd68df

fix edge-case with iOS Safari's handling of the Control key for the k…

e99accb

…eyboard shortcut

narefyev91 approved these changes Aug 24, 2023

View reviewed changes

melvin-bot bot requested a review from marcaaron August 24, 2023 14:37

marcaaron assigned akinwale Aug 24, 2023

marcaaron requested changes Aug 24, 2023

View reviewed changes

akinwale added 2 commits August 25, 2023 02:54

use a constant to match for the 'control' key press

ac07f86

fix merge conflict

a814bae

akinwale requested a review from marcaaron August 25, 2023 02:13

akinwale added 3 commits August 25, 2023 19:36

fix more merge conflicts

ace45f1

tidy up TextInputWithCurrencySymbol refactor

a88c1b3

use anonymous function for onSelectionChange

998e56c

fix merge conflict

fd28e88

marcaaron approved these changes Aug 29, 2023

View reviewed changes

marcaaron merged commit fd755ee into Expensify:main Aug 29, 2023

OSBotify mentioned this pull request Aug 30, 2023

Deploy Checklist: New Expensify 2023-08-30 #26268

Closed

OSBotify mentioned this pull request Aug 31, 2023

Deploy Checklist: New Expensify 2023-08-31 #26359

Closed

69 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: handle forward-delete properly in the amount text input #25815

fix: handle forward-delete properly in the amount text input #25815

akinwale commented Aug 24, 2023

melvin-bot bot commented Aug 24, 2023

melvin-bot bot commented Aug 24, 2023

akinwale commented Aug 24, 2023

narefyev91 commented Aug 24, 2023

akinwale commented Aug 24, 2023 •

edited

Loading

narefyev91 commented Aug 24, 2023

akinwale commented Aug 24, 2023

narefyev91 commented Aug 24, 2023

narefyev91 left a comment

marcaaron Aug 24, 2023

akinwale Aug 25, 2023 •

edited

Loading

akinwale commented Aug 25, 2023

akinwale commented Aug 28, 2023

akinwale commented Aug 29, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

fix: handle forward-delete properly in the amount text input #25815

fix: handle forward-delete properly in the amount text input #25815

Conversation

akinwale commented Aug 24, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 24, 2023

melvin-bot bot commented Aug 24, 2023

akinwale commented Aug 24, 2023

narefyev91 commented Aug 24, 2023

akinwale commented Aug 24, 2023 • edited Loading

narefyev91 commented Aug 24, 2023

akinwale commented Aug 24, 2023

narefyev91 commented Aug 24, 2023

Reviewer Checklist

Screenshots/Videos

narefyev91 left a comment

Choose a reason for hiding this comment

marcaaron Aug 24, 2023

Choose a reason for hiding this comment

akinwale Aug 25, 2023 • edited Loading

Choose a reason for hiding this comment

akinwale commented Aug 25, 2023

akinwale commented Aug 28, 2023

akinwale commented Aug 29, 2023

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

akinwale commented Aug 24, 2023 •

edited

Loading

akinwale Aug 25, 2023 •

edited

Loading