[fix]: Able to save a phone number with some spaces before and After the number #36961

allgandalf · 2024-02-20T21:54:50Z

Details

There was a bug which allowed the user to save phone numbers with whitespaces, this needed to be fixed because we needed trimmed values to go in the BE

Fixed Issues

$ #36072
PROPOSAL: #36072 (comment)

Tests

Same as QA step

Verify that no errors appear in the JS console

Offline tests

Cannot perform as verification is required before entering company details

QA Steps

Open New Expensify app.
Log in with a applause.expensifail account (that does not have any bank account already added)
Navigate to the add bank account modal
Select the Manual method to add a bank account
On the "Connect Bank Account" page, enter the routing and account numbers
Checkmark the "I accept the Expensify Terms of Service"
In the company information
Fill out the company information
Fill out the phone number information with some spaces before and after the number
Click Save and continue

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

MacOS: Chrome / Safari

simplescreenrecorder-2024-02-23_19.12.38.mp4

MacOS: Desktop

WhatsApp.Video.2024-02-23.at.7.16.28.PM.mp4

iOS: mWeb Safari

WhatsApp.Video.2024-02-21.at.3.33.24.AM.mp4

iOS: Native

WhatsApp.Video.2024-02-21.at.3.33.50.AM.mp4

Android: mWeb Chrome

Android: Native

simplescreenrecorder-2024-02-21_03.35.45.mp4

melvin-bot · 2024-02-20T21:54:55Z

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

cubuspl42 · 2024-02-21T08:43:16Z

I'm sorry that I'm doing it this late, but I started a thread on Slack to figure out the details of the expected behavior. I'm having second thoughts about presenting an error to the user.

allgandalf · 2024-02-21T18:10:41Z

From the comment on the slack thread i guess we should throw an error over here then, so no change needed i guess ? @cubuspl42

cubuspl42 · 2024-02-22T11:20:20Z

One of the internal engineers pressed "Agree". Also, I believe that the common sense should be always prioritized.

I'm sorry to put the extra work on you. I'll ask you to pivot to that behavior.

On the optimistic side, I think the code diff might be quite small!

allgandalf · 2024-02-22T11:21:57Z

will do, can you please ask them to update the bug description ?

…

On Thu, Feb 22, 2024 at 4:50 PM Jakub Trzebiatowski < ***@***.***> wrote: One of the internal engineers pressed "Agree". Also, I believe that the common sense should be always prioritized. I'm sorry to put the extra work on you. I'll ask you to pivot to that behavior. On the optimistic side, I think the code diff might be quite small! — Reply to this email directly, view it on GitHub <#36961 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/A2LMYICDMGXWTTDMEDX2ZJ3YU4SX7AVCNFSM6AAAAABDR5PKSWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNJZGI2DENBWGM> . You are receiving this because you authored the thread.Message ID: ***@***.***>

cubuspl42 · 2024-02-22T12:07:55Z

@GandalfGwaihir I don't think this is required. Sometimes we pivot during the PR implementation. If we get the PR approved by the internal engineer, we'll be fine.

allgandalf · 2024-02-22T17:17:11Z

~~@cubuspl42 , what changes would you suggest now, as we store the values in onyx but also use Inputwrapper? can you give me a brief of the changes ?~~

NVM, solved the issue, will update the new videos tomorrow @cubuspl42

src/pages/ReimbursementAccount/BusinessInfo/substeps/PhoneNumberBusiness.tsx

allgandalf · 2024-02-23T13:47:27Z

New videos have been updated @cubuspl42

allgandalf · 2024-03-06T18:16:10Z

@cubuspl42 , ready for review

src/hooks/useReimbursementAccountStepFormSubmit.ts

allgandalf · 2024-03-10T20:07:36Z

Hello @cubuspl42 , we solved a much larger problem over here, after you latest comments i checked where we get isEditing from and why it is the way it is currently, so here is the explanation:

App/src/hooks/useSubStep/index.ts

Line 12 in 77375e8

const isEditing = useRef(false);

We get isEditing from useSubStep:

App/src/pages/ReimbursementAccount/BusinessInfo/BusinessInfo.tsx

Line 89 in 77375e8

    
           const {componentToRender: SubStep, isEditing, screenIndex, nextScreen, prevScreen, moveTo, goToTheLastStep} = useSubStep({bodyContent, startFrom, onFinished: submit});

which is passed to our phone number page:

App/src/pages/ReimbursementAccount/BusinessInfo/BusinessInfo.tsx

Lines 122 to 125 in 77375e8

    
           <SubStep 
        
               isEditing={isEditing} 
        
               onNext={nextScreen} 
        
               onMove={moveTo}

So in PhoneNumberBusiness.tsx:
This isEditing is used to set the text of the submit button:

App/src/pages/ReimbursementAccount/BusinessInfo/substeps/PhoneNumberBusiness.tsx

Lines 51 to 53 in 77375e8

    
           <FormProvider 
        
               formID={ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM} 
        
               submitButtonText={translate(isEditing ? 'common.confirm' : 'common.next')}

So instead of touching this, i made changes based on your suggestions, to use shouldSaveDraft and instead of relying on isEditing to save draft values below:

App/src/hooks/useReimbursementAccountStepFormSubmit.ts

Line 29 in 77375e8

if (isEditing) {

We set shouldSaveDraft to true by default on every page.

This helps a lot, we should remove isEditing prop from useReimbursementAccountStepFormSubmit because it has no use there isEditing is used at multiple other places and might cause regression if we make changes to that prop.

So instead this solutions works really well.

Also if we don't want to save drafts on any page, there we can pass simply shouldSaveDraft: false as well.

Also I found similar bugs on other Company pages as well, company name, address all were saved with blank spaces

I have fixed them in this PR itself, so I wanted to ask Will the compensation for this Bug be increased now as we are dealing with a lot larger problem now and have avoided atleast 15-16 future similar bugs? (Provided you accept the current proposed solution`

I have found 16 instances where this bug will no longer occur if we implement the current changes:
Address.tsx, FullName, DateOfBirth NameBusiness TaxIdBusiness WebsiteBusiness AddressBusiness PhoneNumberBusiness SocialSecurityNumber TypeBusiness IncorporationDateBusiness IncorporationStateBusiness AddressUBO LegalNameUBO DateOfBirthUBO SocialSecurityNumberUBO

So i think it would be really fair on my part to increase the bounty as i have spent extra time going deep into the codebase and exploring other parts of the code where we might fix this issue from the root :)

This change also makes us consistent with other form pages in our app, for example down below when we enter display name, we trim the input, so that here too would be consistent with the app behavior:

simplescreenrecorder-2024-03-11_01.43.40.mp4

src/hooks/useReimbursementAccountStepFormSubmit.ts

...sementAccount/BeneficialOwnerInfo/substeps/BeneficialOwnerDetailsFormSubsteps/AddressUBO.tsx

src/hooks/useReimbursementAccountStepFormSubmit.ts

allgandalf · 2024-03-11T10:59:16Z

Implemented suggested changes @cubuspl42 , can you please checkoff the checklist, thanks

cubuspl42 · 2024-03-12T09:34:57Z

src/pages/ReimbursementAccount/BusinessInfo/substeps/PhoneNumberBusiness.tsx

@@ -44,6 +44,8 @@ function PhoneNumberBusiness({reimbursementAccount, onNext, isEditing}: PhoneNum
    const handleSubmit = useReimbursementAccountStepFormSubmit({
        fieldIds: STEP_FIELDS,
        onNext,
+        // We want to remove sanitize user input i.e. remove leading and trailing whitespaces


Suggestion:

// During draft saving, the phone number is sanitized (i.e. leading and trailing whitespace is removed)

Link between draft saving and sanitization

Small language mistake fixed (whtespaces)

Stressing that we want this for the phone numbers specifically

Fixed it, thanks

cubuspl42 · 2024-03-14T09:02:30Z

Same as QA step

In the future, try to ensure that "Tests" make sense for engineers. "Same as QA steps" doesn't work if the QA steps mention stuff like "applause.expensifail account".

cubuspl42 · 2024-03-14T09:03:31Z

and without +

I think that this is just outdated, right? Same in the PR title.

allgandalf · 2024-03-14T09:07:29Z

resolved your comments @cubuspl42

cubuspl42 · 2024-03-14T11:27:51Z

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: mWeb Chrome

trim-phone-number-android-web-compressed.mp4

iOS: Native

trim-phone-number-ios-compressed.mp4

iOS: mWeb Safari

trim-phone-number-ios-web-compressed.mp4

MacOS: Chrome / Safari

trim-phone-number-web-converted.mp4

MacOS: Desktop

OSBotify · 2024-03-14T14:08:02Z

✋ 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 · 2024-03-15T10:29:25Z

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

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

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

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

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

Add whitespace check

4add919

allgandalf requested a review from a team as a code owner February 20, 2024 21:54

melvin-bot bot requested review from cubuspl42 and removed request for a team February 20, 2024 21:54

allgandalf added 2 commits February 23, 2024 00:00

Set isEditing to true to trim the input

2fa5415

Set isEditing to true to trim the input

59830b8

cubuspl42 reviewed Feb 23, 2024

View reviewed changes

src/pages/ReimbursementAccount/BusinessInfo/substeps/PhoneNumberBusiness.tsx Outdated Show resolved Hide resolved

allgandalf added 2 commits March 6, 2024 23:20

Merge branch 'Expensify:main' into issue-36072

9f8c94b

use shouldSaveDraft

1f945a2

Add useCallback dependency

2b73c75

cubuspl42 suggested changes Mar 7, 2024

View reviewed changes

src/hooks/useReimbursementAccountStepFormSubmit.ts Outdated Show resolved Hide resolved

allgandalf added 2 commits March 11, 2024 01:01

Final fix for all pages

f71c96a

Final fix for all pages

e3cb6ab

Final fix for all pages

1425e82

cubuspl42 suggested changes Mar 11, 2024

View reviewed changes

src/hooks/useReimbursementAccountStepFormSubmit.ts Outdated Show resolved Hide resolved

...sementAccount/BeneficialOwnerInfo/substeps/BeneficialOwnerDetailsFormSubsteps/AddressUBO.tsx Show resolved Hide resolved

cubuspl42 reviewed Mar 11, 2024

View reviewed changes

src/hooks/useReimbursementAccountStepFormSubmit.ts Show resolved Hide resolved

add shuldSaveDraft

7c73dc8

cubuspl42 reviewed Mar 12, 2024

View reviewed changes

Update PhoneNumberBusiness.tsx

7c2e74d

allgandalf changed the title ~~[fix]: Able to save a phone number with some spaces before and without +~~ [fix]: Able to save a phone number with some vm spaces before and After the number Mar 14, 2024

allgandalf changed the title ~~[fix]: Able to save a phone number with some vm spaces before and After the number~~ [fix]: Able to save a phone number with some spaces before and After the number Mar 14, 2024

cubuspl42 approved these changes Mar 14, 2024

View reviewed changes

melvin-bot bot requested a review from nkuoch March 14, 2024 11:28

nkuoch approved these changes Mar 14, 2024

View reviewed changes

nkuoch merged commit 206d293 into Expensify:main Mar 14, 2024
19 of 20 checks passed

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

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

Closed

35 tasks

melvin-bot bot mentioned this pull request Mar 18, 2024

[HOLD for payment 2024-03-25] [$500] Bank account – Able to save a phone number with some spaces before and without + #36072

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[fix]: Able to save a phone number with some spaces before and After the number #36961

[fix]: Able to save a phone number with some spaces before and After the number #36961

allgandalf commented Feb 20, 2024 •

edited

Loading

melvin-bot bot commented Feb 20, 2024

cubuspl42 commented Feb 21, 2024 •

edited

Loading

allgandalf commented Feb 21, 2024

cubuspl42 commented Feb 22, 2024

allgandalf commented Feb 22, 2024 via email

cubuspl42 commented Feb 22, 2024

allgandalf commented Feb 22, 2024 •

edited

Loading

allgandalf commented Feb 23, 2024

allgandalf commented Mar 6, 2024

allgandalf commented Mar 10, 2024 •

edited

Loading

allgandalf commented Mar 11, 2024

cubuspl42 Mar 12, 2024

allgandalf Mar 13, 2024

cubuspl42 commented Mar 14, 2024

cubuspl42 commented Mar 14, 2024

allgandalf commented Mar 14, 2024 •

edited

Loading

cubuspl42 commented Mar 14, 2024

OSBotify commented Mar 14, 2024

OSBotify commented Mar 15, 2024

OSBotify commented Mar 18, 2024

[fix]: Able to save a phone number with some spaces before and After the number #36961

[fix]: Able to save a phone number with some spaces before and After the number #36961

Conversation

allgandalf commented Feb 20, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 20, 2024

cubuspl42 commented Feb 21, 2024 • edited Loading

allgandalf commented Feb 21, 2024

cubuspl42 commented Feb 22, 2024

allgandalf commented Feb 22, 2024 via email

cubuspl42 commented Feb 22, 2024

allgandalf commented Feb 22, 2024 • edited Loading

allgandalf commented Feb 23, 2024

allgandalf commented Mar 6, 2024

allgandalf commented Mar 10, 2024 • edited Loading

Also I found similar bugs on other Company pages as well, company name, address all were saved with blank spaces

allgandalf commented Mar 11, 2024

cubuspl42 Mar 12, 2024

Choose a reason for hiding this comment

allgandalf Mar 13, 2024

Choose a reason for hiding this comment

cubuspl42 commented Mar 14, 2024

cubuspl42 commented Mar 14, 2024

allgandalf commented Mar 14, 2024 • edited Loading

cubuspl42 commented Mar 14, 2024

Reviewer Checklist

Screenshots/Videos

OSBotify commented Mar 14, 2024

OSBotify commented Mar 15, 2024

OSBotify commented Mar 18, 2024

allgandalf commented Feb 20, 2024 •

edited

Loading

cubuspl42 commented Feb 21, 2024 •

edited

Loading

allgandalf commented Feb 22, 2024 •

edited

Loading

allgandalf commented Mar 10, 2024 •

edited

Loading

allgandalf commented Mar 14, 2024 •

edited

Loading