Recovery code input fix by neonbhai · Pull Request #36774 · Expensify/App

neonbhai · 2024-02-18T18:27:27Z

Details

Fixed Issues

$ #35947
PROPOSAL: #35947 (comment)

Tests

Precondition:
User should have 2-FA enabled

Open Expensify
Enter email address from precondition
Navigate to email and locate the magic link - change to staging if needed
Open an new tab and navigate to the staging link
Verify the 2FA required page is displayed
Navigate back to the original tab
Click on "Use recovery code" to change to "Use 2 factor authentication code"
Enter authentication code with space at the beginning
Verify the whole code gets pasted (with space)
Submit the code
Verify submit is successful

Verify that no errors appear in the JS console

Offline tests

Cannot login when offline

QA Steps

Same as Tests step

PR Author Checklist

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

mweb.mov

iOS: Native

ios.native.mov

iOS: mWeb Safari

mweb.safari.mov

MacOS: Chrome / Safari

819ed13c-2602-4435-81ba-4df3f7d13e00.mp4

MacOS: Desktop

desktop.screencast.mov

neonbhai · 2024-02-20T12:32:01Z

Hi @getusha!

Regarding trimming onTextInput Native devices tend to show a lag when text is trimmed here

Video

iOS:

Screen.Recording.2024-02-19.at.5.41.57.AM.mov

Android:

Screen.Recording.2024-02-19.at.3.15.24.AM.mov

The root cause seems to be upstream, and since this behavior didn't exist before I'm concerned it might be reported as a regression

This behavior could be a bit disorienting (and feels like something is not working) for other devices.

I've updated logic to trim input when submitting, over restricting user action.

Please let me know your thoughts!

melvin-bot · 2024-02-20T14:28:17Z

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

getusha · 2024-02-21T18:50:01Z

Regarding trimming onTextInput Native devices tend to show a lag when text is trimmed here

@neonbhai looks like a bug from react-native happens even after removing onChangeText line.

getusha · 2024-02-21T18:53:30Z

diff --git a/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js b/
src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
index 4afba77b77..d6d3569354 100755
--- a/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
+++ b/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
@@ -179,7 +179,7 @@ function BaseValidateCodeForm(props) {
             setInput = setRecoveryCode;
             setInput = setRecoveryCode;
diff --git a/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js b/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
index 4afba77b77..d6d3569354 100755
--- a/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
+++ b/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
@@ -179,7 +179,7 @@ function BaseValidateCodeForm(props) {
             setInput = setRecoveryCode;
         }
 
-        setInput(text);
+        setInput(text.trim().slice(0, CONST.RECOVERY_CODE_LENGTH));
         setFormError((prevError) => ({...prevError, [key]: ''}));

what do you think about this change?

getusha · 2024-02-26T13:39:32Z

@neonbhai any updates? also looks like we've got a conflict

getusha · 2024-02-28T09:16:13Z

@neonbhai bump

neonbhai · 2024-02-29T14:50:59Z

Hi, trimming before setInput looks like a better change!
Apologizing for delay, finalizing PR shortly!

…-code-input-fix

neonbhai · 2024-03-01T04:02:10Z

@getusha I've added some changes, please take a look

We will not be able to have maxLength prop at 8 characters as we get this behavior after trimming:

Video

Screen.Recording.2024-03-01.at.9.05.12.AM.mov

trim() seems to be applied after maxlength truncation. Slicing also comes even later so doesn't help us.

We can either:

Allow space when editing
Change Required: Remove the trimming behavior
This saves us from the laggy trim on native devices.
Trim input
(current changes in PR)
We can then try solving the laggy trim bug upstream

I'm leaning towards 1 since we do allow space on latest main. Let me know your thoughts!

getusha · 2024-03-03T20:49:53Z

@neonbhai i don't understand, are we talking about a different kind of issue? i am not suggesting to use maxlength in my diff, keeping the maxLength as your proposal and the diff i provided is an additional.

#36774 (comment)

neonbhai · 2024-03-03T22:22:16Z

I am not suggesting to use maxlength in my diff, keeping the maxLength as your proposal and the diff i provided is an additional.

That makes sense, I apologize I misunderstood. Slicing the input here would give us this behavior:

Video

Screen.Recording.2024-03-04.at.2.40.10.AM.mov

This seems inconsistent with other form inputs behaviors where additional characters are ignored after limit.

To fix

We can add a check like this before setting input here

if(recoveryCode.length === CONST.RECOVERY_CODE_LENGTH) {
    return;
}

Resulting behavior:

Video

Screen.Recording.2024-03-04.at.3.49.58.AM.mov

The cursor would move to the end, when trying to edit, but I guess that will be okay?

cc: @getusha

getusha · 2024-03-05T22:20:32Z

thanks @neonbhai for the detailed explanation

looks like RECOVERY_CODE_LENGTH is redundant and we can remove it.

neonbhai · 2024-03-08T04:39:52Z

@getusha ready for review!

getusha · 2024-03-11T10:58:14Z

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

Screen.Recording.2024-03-13.at.10.39.14.at.night.mov

Android: mWeb Chrome

Screen.Recording.2024-03-13.at.1.27.20.in.the.afternoon.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-13.at.22.07.06.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.-.2024-03-13.at.22.00.07.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-03-13.at.1.14.57.in.the.afternoon.mov

MacOS: Desktop

Screen.Recording.2024-03-13.at.10.10.50.at.night.mov

OSBotify · 2024-03-15T10:29:19Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.53-0 🚀

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

OSBotify · 2024-03-18T16:18:57Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.53-2 🚀

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

neonbhai added 3 commits February 18, 2024 23:02

Increase editing space for recovery code

bc076b5

Add logic to trim text on input

04fb210

Update recovery code trim logic

6465479

neonbhai marked this pull request as ready for review February 20, 2024 14:28

neonbhai requested a review from a team as a code owner February 20, 2024 14:28

melvin-bot Bot requested review from getusha and removed request for a team February 20, 2024 14:28

neonbhai added 3 commits February 29, 2024 20:21

Merge branch 'main' of https://github.com/Expensify/App into recovery…

c6ddf5e

…-code-input-fix

Trim recovery code on text input

1dce287

Increase editing space for recovery code input

3630b1b

neonbhai and others added 3 commits March 8, 2024 08:09

Merge branch 'Expensify:main' into recovery-code-input-fix

e395de7

Remove unused const

bba0864

Merge branch 'Expensify:main' into recovery-code-input-fix

a5d9fe2

getusha approved these changes Mar 13, 2024

View reviewed changes

melvin-bot Bot requested a review from puneetlath March 13, 2024 19:44

puneetlath approved these changes Mar 13, 2024

View reviewed changes

puneetlath merged commit 077824c into Expensify:main Mar 13, 2024

github-actions Bot mentioned this pull request Mar 15, 2024

Deploy Checklist: New Expensify 2024-03-15 #38382

Closed

35 tasks

neonbhai mentioned this pull request Mar 17, 2024

[HOLD for payment 2024-03-25] [$500] Web - 2FA - Authentication code value is not accepted when put Space and than correct it #35947

Closed

6 tasks

Uh oh!

Conversation

neonbhai commented Feb 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

neonbhai commented Feb 20, 2024

Uh oh!

melvin-bot Bot commented Feb 20, 2024

Uh oh!

getusha commented Feb 21, 2024

Uh oh!

getusha commented Feb 21, 2024

Uh oh!

getusha commented Feb 26, 2024

Uh oh!

getusha commented Feb 28, 2024

Uh oh!

neonbhai commented Feb 29, 2024

Uh oh!

neonbhai commented Mar 1, 2024

Uh oh!

getusha commented Mar 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neonbhai commented Mar 3, 2024

Uh oh!

getusha commented Mar 5, 2024

Uh oh!

neonbhai commented Mar 8, 2024

Uh oh!

getusha commented Mar 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

OSBotify commented Mar 15, 2024

Uh oh!

OSBotify commented Mar 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

neonbhai commented Feb 18, 2024 •

edited

Loading

getusha commented Mar 3, 2024 •

edited

Loading

getusha commented Mar 11, 2024 •

edited

Loading