fix: TimePicker – support replacement & removal by full selection

[paultsimura]

Details

Allow replacing and removing the TimePicker values when selecting both digits of either Hours or Minutes.

Fixed Issues

$ #33143
PROPOSAL: #33143 (comment)

Tests

Same as QA

Offline tests

Same as QA

QA Steps

1. Go to Settings > Profile > Status
2. Click Clear after > Click Custom > Time
3. Highlight the minutes.
4. Delete the value (backspace or delete).

• Verify that Minutes are set to 00
• Verify that the cursor has moved to the start of Minutes

5. Highlight the hours.
6. Delete the value (backspace or delete).

• Verify that Hours are set to 00
• Verify that the cursor has moved to the start of Hours

7. Highlight the hours.
8. Paste the value of 0 or 1.

• Verify that the value was set as the first digit, and the cursor moved to the second position.

9. Highlight the hours.
10. Paste the value of 2 to 12.

• Verify that the value was set as 02 ... 09, 10, 11, 12
• Verify that the cursor has moved to the start of Minutes

11. Highlight the hours.
12. Paste the value of 13 to 24.

• Verify that the value was set as pasted value - 12, and am switched to pm
• Verify that the cursor has moved to the start of Minutes

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(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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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-compressed.mp4

Android: mWeb Chrome

chrome-compressed.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2023-12-20.at.20.51.52-compressed.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2023-12-20.at.20.54.53-compressed.mp4

MacOS: Chrome / Safari

Screen.Recording.2023-12-20.at.12.59.03-compressed.mp4

MacOS: Desktop

Screen.Recording.2023-12-20.at.13.17.33-compressed.mp4

[paultsimura]

@s77rt I've run into the same issue we once tried to battle with the mentions: on Android and iOS, there is a difference in the order of calling onSelectionChange and onChangeText.

Therefore, handling the full-value replacement with paste is not working on Android: the selection is updated first, and then - the onChangeText is called, so the selection is always on the position {2, 2} when handling the hours change (if we are pasting a value).

This should be fixed after we move to Fabric: facebook/react-native#36930 (comment)

For now, I would suggest not implementing the paste-replacement, only the removal (which is in the context of the issue). We've tried a ton of workarounds in the original issue, but had no major luck:
Issue: #28170
Slack thread: https://expensify.slack.com/archives/C01GTK53T8Q/p1696421170146759

[s77rt]

Can you check the money request flow? The amount supports the selection replacement. That may be helpful if we can follow the same approach

[paultsimura]

Money request flow doesn't use the more complicated approach of replacing the symbols in place (we have only 2 digits in the Time Picker, and the value should be handled according to the position of the cursor).
The money request form acts as a regular numeric input, so they don't check the selection value while updating the amount.

[paultsimura]

I'll try one different approach in the meantime 🤔

[melvin-bot]

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

[paultsimura]

@s77rt all yours.
Please test different cases of full replacement/removal on your side as well – I did a lot of tests but might have missed something.

Also, just a note: that the TimePicker itself remains quite buggy. I didn't have the capacity and expected behaviors roadmap to fix all the by-symbol inputs, but it's out of the scope of this issue anyway.

[s77rt]

This is working much better than main but we may need to refactor the component. We are still unable to type 22 in the hours input.

Do you know why we are having 3 numbers in each input instead of just 2?

Screen.Recording.2023-12-24.at.1.16.51.PM.mov

[paultsimura]

@s77rt 22 is not allowed because the AM/PM format supports only numbers 0-12

[paultsimura]

Regarding the 3 numbers — it is just how the input works. We input the number and cut out the remaining digit.
This flow is described in the comments as well.

[s77rt]

Yes but I expected to get it converted to 10pm same as 19 is converted to 7pm

[paultsimura]

It will be converted if you paste 22 as a full replacement

[paultsimura]

@s77rt please test the updated Hours and Minutes logic (along with my comments above).
I have updated it to the following: when entering 1 as the first digit, we replace the second with 0 if it's greater than 2. This is to avoid the unexpected 24h-12h conversion when entering 1 on the first position while there is 3-9 on the second position.

This is the most user-friendly behavior I could come up with so far. Unfortunately, because of the edge cases, I could not use the simplified code you provided, but I did use some improvements from it.

[s77rt]

Bugs when pressing the delete key / the backspace key

Bug 1:

• Select the hours
• Press delete twice
• undefined is set as hours

Bug 2:

• Select the minutes
• Press delete or backspace key three times
• The cursor will be at the hours position and you will be able to insert a digit and it will take the 3rd position

Screen.Recording.2023-12-27.at.8.25.36.PM.mov

[s77rt]

Bug:

1. Write 45 in minutes
2. Select the 4 and delete it
3. Expected results: 05 but got 50

Screen.Recording.2023-12-29.at.3.24.35.PM.mov

[paultsimura]

Bug:

1. Write 45 in minutes
2. Select the 4 and delete it
3. Expected results: 05 but got 50

Fixed, thanks.

[s77rt]

Outdated tests:
4. Verify that the cursor has moved to the end of Hours start of Minutes
14. I think we can remove this one

[s77rt]

You can mark the remaining comments as resolved

[s77rt]

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(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 form input styles:
  • I verified that all the inputs inside a form are aligned with each other.
  • I added Design label 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.mov

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

[paultsimura]

Done ✔️

[s77rt]

Thanks!

[paultsimura]

@pecanoro done, thank you. Please re-check

[OSBotify]

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

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.21-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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