[HOLD for payment 2024-06-28] [$250] Extra spaces are not trimmed in the next page for the routing number and Account number

[m-natarajan]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 1.4.79-6
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Expensify/Expensify Issue URL:
Issue reported by: @allgandalf
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1717537508312169

Action Performed:

1. Go to a workspace
2. Enable workflows
3. Click on connect bank account
4. Select manual and enter the account details as : 011401533 and account number 1111222233331111 give some space before both these numbers and press next

Expected Result:

Spaces are trimmed in the confirmation page

Actual Result:

Spaces are present on the confirmation page, we should trim them while saving as a account number cannot have spaces before or after.

Workaround:

unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Screen.Recording.2024-06-05.at.3.11.25.AM.mov

Recording.176.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0134151ac2072ab6de
• Upwork Job ID: 1798588655835680495
• Last Price Increase: 2024-06-06
• Automatic offers:
• allgandalf | Contributor | 102633932
• Krishna2323 | Contributor | 102704572

Issue Owner

Current Issue Owner: @MitchExpensify / @Christinadobrzyn

[melvin-bot]

Triggered auto assignment to @Christinadobrzyn (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[allgandalf]

@Christinadobrzyn Can i be the C+ here? as i reported this issue and have more context about the same.

[Krishna2323]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Extra spaces are not trimmed in the next page for the routing number and Account number

What is the root cause of that problem?

We are not using useStepFormSubmit in Manual. useStepFormSubmit saves the trimmed value (that is passed by FormProvider onSubmit) as the new draft.

App/src/pages/ReimbursementAccount/BankInfo/substeps/Manual.tsx

Line 65 in 088939b

onSubmit={onNext}

What changes do you think we should make in order to solve the problem?

Use useReimbursementAccountStepFormSubmit like we do in other components and for input wrappers pass shouldSaveDraft={!isEditing}

App/src/pages/ReimbursementAccount/PersonalInfo/substeps/FullName.tsx

Lines 52 to 56 in 088939b

	const handleSubmit = useReimbursementAccountStepFormSubmit({
	fieldIds: STEP_FIELDS,
	onNext,
	shouldSaveDraft: isEditing,
	});

    const handleSubmit = useReimbursementAccountStepFormSubmit({
        fieldIds: [BANK_INFO_STEP_KEYS.ROUTING_NUMBER, BANK_INFO_STEP_KEYS.ACCOUNT_NUMBER],
        onNext,
        shouldSaveDraft: isEditing,
    });

We will also check for other pages like this, which uses substeps.

What alternative solutions did you explore? (Optional)

[dragnoir]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Extra spaces are not trimmed in the next page for the routing number and Account number

What is the root cause of that problem?

Values saved from Manual step with spaces and used on the next step.

App/src/pages/ReimbursementAccount/BankInfo/substeps/Manual.tsx

Lines 73 to 76 in 952d844

	<InputWrapper
	InputComponent={TextInput}
	ref={inputCallbackRef}
	inputID={BANK_INFO_STEP_KEYS.ROUTING_NUMBER}

What changes do you think we should make in order to solve the problem?

The best way to solve this issue id to make sure we don't go to the next step with wrong values (with spaces).

I suggest adding a more check on Manual step to make sure we don't accept values with spaces. This will make sure all values sent to the next steps and saved on the Onyx data are correct and safe

App/src/pages/ReimbursementAccount/BankInfo/substeps/Manual.tsx

Line 40 in 952d844

const validate = useCallback((values: FormOnyxValues<typeof ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM>): FormInputErrors<typeof ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM> => {

1- The values sent to the validate function are trimmed by default. You can console.log values and you will see that the space added on the form is not within those values

App/src/pages/ReimbursementAccount/BankInfo/substeps/Manual.tsx

Line 40 in 952d844

const validate = useCallback((values: FormOnyxValues<typeof ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM>): FormInputErrors<typeof ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM> => {

for this we need to add shouldTrimValues={false} to FormProvider so we can validate the correct values.

App/src/pages/ReimbursementAccount/BankInfo/substeps/Manual.tsx

Line 63 in 952d844

<FormProvider

2- We need to add a new regex for spaces before and after
We can add a new const

REGEX: {
  US_ACCOUNT_NUMBER: /^[0-9]{4,17}$/,
  MASKED_US_ACCOUNT_NUMBER: /^[X]{0,13}[0-9]{4}$/,
  SWIFT_BIC: /^[A-Za-z0-9]{8,11}$/,
+ START_OR_END_WITH_SPACE: /^\s|\s$/,
},

3- We update the validate function to check if the values has spaces at the start or at the end

if (values.accountNumber  &&  CONST.BANK_ACCOUNT.REGEX.START_OR_END_WITH_SPACE.test(values.accountNumber)) {
  errors.accountNumber  =  'bankAccount.error.accountNumber';
}

We do the same for the routingNumber

What alternative solutions did you explore?

[Christinadobrzyn]

@allgandalf I'm going to add the label so it's fair share but we can ask the assigned C+ if you can take it.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0134151ac2072ab6de

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @ahmedGaber93 (External)

[Christinadobrzyn]

Hey @ahmedGaber93 - would you mind if @allgandalf took over as C+ since they reported this issue and have some more context?

[allgandalf]

I'm going to add the lable so it's fair share

@Christinadobrzyn fair point, i’m okay with @ahmedGaber93 taking this over, willing to help them if they need any help on the PR phase 👍

[ahmedGaber93]

Hey @ahmedGaber93 - would you mind if @allgandalf took over as C+ since they reported this issue and have some more context?

@Christinadobrzyn Yeah, that's fair. Please unassign me and assign @allgandalf.

[melvin-bot]

📣 @allgandalf 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[allgandalf]

Thanks for your proposals @Krishna2323 @dragnoir

@dragnoir , In ND, at other places we silently trim the extra spaces for example. while entering phone number in personal details, we trim them, so i don't think we should block the user if they enter extra white spaces, so to stay consistent within our app, we should allow them to enter with spaces and then silently trim the value. Also the expected result of this GH is to trim those extra spaces.

@Krishna2323 , your solution would work fine for this bug, but before moving forward can you update your proposal to highlight the following points:

• Can you be a little brief in your RCA, We are not using useStepFormSubmit in Manual. is not much clear, i can interpret what you mean but when the internal engineer reviews your proposal they might not get the exact RCA :)
• Your solution works fine, but why do we need to create another hook useStepFormSubmit when we have useReimbursementAccountStepFormSubmit, won't it be more optimal to re-use the same hook? or am i missing something here?, like you mentioned we already use the same hook in many components.

Approach wise your proposal LGTM, but can you please address the above points once :) thanks

[Krishna2323]

@allgandalf, proposal updated.

[allgandalf]

@Krishna2323 ,shouldSaveDraft should always be set to true other that that your RCA is correct and solution is complete!

@Krishna2323's proposal, looks good to me, initial proposal summary can be found here

🎀👀🎀 C+ reviewed

[melvin-bot]

Triggered auto assignment to @iwiznia, see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[iwiznia]

useStepFormSubmit saves the trimmed value (that is passed by FormProvider onSubmit) as the new draft.

I don't see this component trimming the values, @Krishna2323 can you point out where that component would trim the value?

[Krishna2323]

@iwiznia, currently we pass onNext to onSubmit prop which doesn't do anything expect from moving to next page, but when we use the callback from useStepFormSubmit hook as the callback to onSubmit prop, the callback gets the form value and updates the draft values. The form value passed to onSubmit callback are already trimmed.

App/src/pages/ReimbursementAccount/BankInfo/substeps/Manual.tsx

Line 65 in 088939b

onSubmit={onNext}

App/src/hooks/useStepFormSubmit.ts

Lines 24 to 35 in 8d11d0b

	(values: FormOnyxValues<T>) => {
	if (shouldSaveDraft) {
	const stepValues = fieldIds.reduce((acc, key) => {
	acc[key] = values[key];
	return acc;
	}, {} as Record<(typeof fieldIds)[number], OnyxValues[T][Exclude<keyof OnyxValues[T], keyof BaseForm>]>);
	FormActions.setDraftValues(formId, stepValues);
	}
	onNext();
	},

App/src/components/Form/FormProvider.tsx

Lines 197 to 198 in 8d11d0b

	// Prepare values before submitting
	const trimmedStringValues = shouldTrimValues ? ValidationUtils.prepareValues(inputValues) : inputValues;

[iwiznia]

Got it.

[melvin-bot]

📣 @Krishna2323 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[Krishna2323]

@allgandalf, PR ready for review.

[allgandalf]

Thanks for the PR @Krishna2323 , will review today 👍

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.85-7 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• fix: Extra spaces are not trimmed in the next page for the routing number and Account number. #43744

If no regressions arise, payment will be issued on 2024-06-28. 🎊

For reference, here are some details about the assignees on this issue:

• @Krishna2323 requires payment automatic offer (Contributor)
• @allgandalf requires payment automatic offer (Contributor)

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@allgandalf] The PR that introduced the bug has been identified. Link to the PR:
• [@allgandalf] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@allgandalf] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@allgandalf] Determine if we should create a regression test for this bug.
• [@allgandalf] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@MitchExpensify / @Christinadobrzyn] Link the GH issue for creating/updating the regression test once above steps have been agreed upon: https://github.com/Expensify/Expensify/issues/409420

[MitchExpensify]

Payment summary:

• $250 @Krishna2323 requires payment automatic offer (Contributor) PAID in upwork
• $250 @allgandalf requires payment automatic offer (Contributor) PAID in upwork

[Christinadobrzyn]

There are no regressions, so I'm paying this out based on this payment summary - #43135 (comment)

@allgandalf can you let us know about a regression test?

[allgandalf]

• The PR that introduced the bug has been identified. Link to the PR:

  • feat: BankInfo step #31121

• The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:

  • https://github.com/Expensify/App/pull/31121/files#r1661160072

• A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:

  • N/A

• Determine if we should create a regression test for this bug. :

  • Yes

• If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.:

Regression Test Proposal

1. Go to a workspace
2. Enable workflows
3. Click on connect bank account
4. Select manual and enter the routing number as : 011401533 and account number 1111222233331111 give some whitespace before both these numbers and press next
5. Verify the routing number and account number are trimmed on the confirmation page

Do we agree 👍 or 👎

[Christinadobrzyn]

Regression test here - https://github.com/Expensify/Expensify/issues/409420

Payment summary here - #43135 (comment)

Closing as complete!