[HOLD for payment 2023-10-10] [$500] Profile - User is able to save display name with semicolon despite the error

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Issue found when executing PR #27025

Action Performed:

1. Go to staging.new.expensify.com
2. Go to Settings > Profile > Display name
3. Add a semicolon to the First name and Last name field
4. Save the changes

Expected Result:

User should not be able to save the changes because of the error 'Name cannot contain a comma or semicolon

Actual Result:

User is able to save the changes despite the error 'Name cannot contain a comma or semicolon

Workaround:

Unknown

Platforms:

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

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.74-1

Reproducible in staging?: Yes

Reproducible in production?: No

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

Notes/Photos/Videos: Any additional supporting documentation

Bug6213663_Screen_Recording_20230925_212545_New_Expensify.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~013e634bc1893121ad
• Upwork Job ID: 1706568349113417728
• Last Price Increase: 2023-09-26

[melvin-bot]

Triggered auto assignment to @miljakljajic (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[OSBotify]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open StagingDeployCash deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[melvin-bot]

Auto-assign attempt failed, all eligible assignees are OOO.

[akinwale]

Proposal

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

Forms can be saved even if they have validation errors, for instance a user can save their display name with semicolons despite the form errors.

What is the root cause of that problem?

The FormProvider onValidate callback method does not return the validation errors list as expected.

App/src/components/Form/FormProvider.js

Lines 107 to 113 in 38030f8

	const onValidate = useCallback(
	(values) => {
	const validateErrors = validate(values);
	setErrors(validateErrors);
	},
	[validate],
	);

App/src/components/Form/FormProvider.js

Lines 134 to 137 in 38030f8

	// Validate form and return early if any errors are found
	if (!_.isEmpty(onValidate(inputValues))) {
	return;
	}

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

Return the validateErrors value in the onValidate callback method.

const onValidate = useCallback(
    (values) => {
        const validateErrors = validate(values);
        setErrors(validateErrors);
+       return validateErrors;
    },
    [validate],
);

What alternative solutions did you explore? (Optional)

None.

[Pluto0104]

Proposal

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

Profile - User is able to save display name with semicolon despite the error

What is the root cause of that problem?

#27025 caused the regression.
From #25397, we have refactored the Form component to a functional component due to some issues but the above PR has a tiny problem.

App/src/components/Form/FormProvider.js

Lines 107 to 113 in f20eba2

	const onValidate = useCallback(
	(values) => {
	const validateErrors = validate(values);
	setErrors(validateErrors);
	},
	[validate],
	);

We are not returning validate errors in onValidate function.

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

We should return validate errors like this:

const onValidate = useCallback(
    (values) => {
        const validateErrors = validate(values);
        setErrors(validateErrors);
        return validateErrors;
    },
    [validate],
);

Also, we need to fix some issues in FormProvider component because it can cause other regressions.
We are not passing entire props to FormWrapper component in these code snippets, we are missing two props - formState & enabledWhenOffline.

App/src/components/Form/FormProvider.js

Line 101 in f20eba2

function FormProvider({validate, shouldValidateOnBlur, shouldValidateOnChange, children, formState, network, enabledWhenOffline, onSubmit, ...rest}) {

App/src/components/Form/FormProvider.js

Lines 237 to 241 in f20eba2

	<FormWrapper
	{...rest}
	onSubmit={submit}
	inputRefs={inputRefs}
	errors={errors}

We should pass these props to FormWrapper component.

<FormWrapper
    {...rest}
    onSubmit={submit}
    inputRefs={inputRefs}
    errors={errors}
    enabledWhenOffline={enabledWhenOffline}
    formState={formState}
>

What alternative solutions did you explore? (Optional)

N/A

[miljakljajic]

Reproducible:

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~013e634bc1893121ad

[melvin-bot]

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

[Pluto0104]

@eVoloshchak @parasharrajat I think we can address this issue as a single problem - #28148

[parasharrajat]

Yes, this is a regression from #27025. cc: @thesahindia @kowczarz

[luacmartins]

@kowczarz can you work on this since it seems like the migration PR is causing it?

[luacmartins]

I don't think this is a blocker though

[staszekscp]

@kowczarz is out of office this week, but I can take care of this one instead. I noticed that #28148 has already a PR in review, so I will focus on this task

[staszekscp]

Hey @luacmartins ! Actually after giving it a thought I believe that ankinwele's proposal would be correct for this case. The cause is valid, and this is something I would do also do.

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

[parasharrajat]

@staszekscp As this is a regression and author is OOO, may be you can create the PR for it. Thus we can also reassign the original C+ from root cause PR.

if we want to solve it as fresh issue/follow-up then its fine.

[staszekscp]

@parasharrajat, sure I can create the PR for this task, I'll let you know when it's ready with all the video recordings

[parasharrajat]

@staszekscp It seems that the main reason for these issues is missing a few pieces of required logic. Like in #28148, the prop was not passed. So I think there might be more such issues, can you please recheck the refactor code to be sure? Thanks.

[staszekscp]

I will have a look at it today. I think I'm going to open another PR in case of any follow-ups. I think it would be a bit clearer that way. Do you agree?

[parasharrajat]

Anything works.

[staszekscp]

Hey @parasharrajat! The PR is ready to be reviewed!

[Pluto0104]

Hmm, @parasharrajat I believe my solution is correct in more detail. We should fix this issue at once. Both #28148 and this issue are coming from FormProvider, right? We should pass formState to FormProvider.

[staszekscp]

@parasharrajat I have found some very minor things that I would like to discuss with @kowczarz, when he's back (on Monday, if nothing happens). In the meantime if you notice that there is some kind of regression related to the Form component, could you tag me? My findings may be helpful with solving any issues that may appear.

[parasharrajat]

Sure, I will do that.

[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.3.76-6 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix validation bug in FormProvider #28311

If no regressions arise, payment will be issued on 2023-10-10. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

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

• @eVoloshchak does not require payment (Eligible for Manual Requests)

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

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

• [@eVoloshchak] The PR that introduced the bug has been identified. Link to the PR:
• [@eVoloshchak] 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:
• [@eVoloshchak] 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:
• [@eVoloshchak] Determine if we should create a regression test for this bug.
• [@eVoloshchak] 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.
• [@miljakljajic] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[parasharrajat]

This is a regression so no payments here.