[HOLD for payment 2023-06-13] [$1000] Contact Method - Validation error message doesn't disappear upon requesting new magic code

[kbecciv]

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

Action Performed:

1. Login to ND.
2. Go to Settings > Profile > Contact method > New contact method.
3. Add any contact method.
4. Once redirected to the Contact method page, click on the contact method you entered.
5. Enter any random numbers.
6. Ensure you are shown an error.
7. Click on the resend magic code text.

Expected Result:

Input is cleared and you are focused on the first input box. Error message should disappear.

Actual Result:

Input is cleared and focused on the first input, but error message still persists requesting a new code and try again.

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

Reproducible in staging?: Yes

Reproducible in production?: n/a

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

https://platform.applause.com/services/links/v1/external/d3721b2fe38422b24fa746eb47d7892d16fccf9337780c8d13264980a75745e8

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/~013b03109026ba1aa6
• Upwork Job ID: 1661075549036351488
• Last Price Increase: 2023-05-30

[melvin-bot]

Triggered auto assignment to @puneetlath (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

[melvin-bot]

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

[melvin-bot]

Current assignee @puneetlath is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

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

[melvin-bot]

Current assignee @puneetlath is eligible for the External assigner, not assigning anyone new.

[Pujan92]

Proposal

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

Validation error message doesn't disappear upon requesting new magic code

What is the root cause of that problem?

While requesting the new magic code we are not cleaning the previous error in the onyx which seems the cause for the issue.

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

Add a line to reset errorField validateLogin null also here in onyx while requesting a new magic code.
validateLogin: null

App/src/libs/actions/User.js

Lines 136 to 138 in 228f409

	errorFields: {
	validateCodeSent: null,
	},

IMO, we should clear and refocus the input magic code and clear the error as soon as user presses "Resend Magic Code". And show "Link has been re-sent" message only after user receives the api response.

To fix the above point from this comment we need to clear the validate code field and focus the same we need below two functions call required within resendValidateCode.

setValidateCode('');
inputValidateCodeRef.current.focus();

Result

https://github.com/Expensify/App/assets/14358475/31610824-7b99-4551-a14a-5a5c77c6aa58

[dummy-1111]

Proposal

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

Validation error message doesn't disappear when requesting new magic code

What is the root cause of that problem?

The validation error message is passed to this component as errors props

App/src/pages/settings/Profile/Contacts/ValidateCodeForm/BaseValidateCodeForm.js

Lines 154 to 159 in e9f6a37

	<OfflineWithFeedback
	pendingAction={lodashGet(loginData, 'pendingFields.validateLogin', null)}
	errors={ErrorUtils.getLatestErrorField(loginData, 'validateLogin')}
	errorRowStyles={[styles.mt2]}
	onClose={() => User.clearContactMethodErrors(props.contactMethod, 'validateLogin')}
	>

Here ErrorUtils.getLatestErrorField(loginData, 'validateLogin') get errors from loginData['errorFields']['validateLogin] as you can see below

App/src/libs/ErrorUtils.js

Line 76 in e9f6a37

const errorsForField = lodashGet(onyxData, ['errorFields', fieldName], {});

loginData is from props loginList and loginList is from Onyx store with key ONYXKEYS.LOGIN_LIST as you can see below

App/src/pages/settings/Profile/Contacts/ValidateCodeForm/BaseValidateCodeForm.js

Line 66 in 952a962

const loginData = props.loginList[props.contactMethod];

App/src/pages/settings/Profile/Contacts/ContactMethodDetailsPage.js

Lines 293 to 295 in e9f6a37

	loginList: {
	key: ONYXKEYS.LOGIN_LIST,
	},

The root cause of this issue is here. We only set validateCodeSent of errorFields when requesting magic code, but the error message comes from validateLogin of errorFields.

App/src/libs/actions/User.js

Lines 130 to 144 in e9f6a37

	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: ONYXKEYS.LOGIN_LIST,
	value: {
	[contactMethod]: {
	validateCodeSent: false,
	errorFields: {
	validateCodeSent: null,
	},
	pendingFields: {
	validateCodeSent: CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE,
	},
	},
	},
	},

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

We need to reset the validateLogin of errorFields when requesting magic code.
Replace the below code

App/src/libs/actions/User.js

Lines 136 to 138 in e9f6a37

	errorFields: {
	validateCodeSent: null,
	},

with

   errorFields: {
     validateCodeSent: null,
     validateLogin: null,
   },

And add the following code here

App/src/pages/settings/Profile/Contacts/ValidateCodeForm/BaseValidateCodeForm.js

Lines 80 to 82 in 12b9b0e

	const resendValidateCode = () => {
	User.requestContactMethodValidateCode(props.contactMethod);
	};

        setValidateCode('');
        inputValidateCodeRef.current.clear();

And the following code isn't needed and remove it.

App/src/pages/settings/Profile/Contacts/ValidateCodeForm/BaseValidateCodeForm.js

Lines 69 to 75 in 12b9b0e

	useEffect(() => {
	if (!props.hasMagicCodeBeenSent) {
	return;
	}
	setValidateCode('');
	inputValidateCodeRef.current.clear();
	}, [props.hasMagicCodeBeenSent]);

This works perfectly

Mac Chrome

mac_chrome_19471.mp4

What alternative solutions did you explore? (Optional)

[sobitneupane]

@puneetlath Can you please clarify the expected output?

As of now, when user presses "Resend Magic Code", only after receiving api response, "Link has been re-sent" message is displayed and input in cleared.

So, would we expect the error to be cleared as soon as the user presses "Resend Magic Code"?

IMO, we should clear and refocus the input magic code and clear the error as soon as user presses "Resend Magic Code". And show "Link has been re-sent" message only after user receives the api response.

[puneetlath]

@sobitneupane I agree with that. That sounds good.

[sobitneupane]

@Pujan92 Would you like to update your proposal to yield this outcome?

[dummy-1111]

@sobitneupane
My proposal has already the result. Did you check?

[Pujan92]

@Pujan92 Would you like to update your proposal to yield this outcome?

@sobitneupane I just updated my proposal.

[dummy-1111]

Proposal

Updated

[sobitneupane]

Proposal from @Pujan92 looks good to me.

🎀👀🎀 C+ reviewed
cc: @puneetlath

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[melvin-bot]

📣 @Pujan92 You have been assigned to this job by @puneetlath!
Please apply to this job in Upwork 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 📖

[Pujan92]

@sobitneupane @puneetlath PR is ready for review!

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

• Fix: Contact Method - Validation error message doesn't disappear upon requesting new magic code #19950

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

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 n/a
• Contributor that fixed the issue @Pujan92
• Contributor+ that helped on the issue and/or PR @sobitneupane

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:

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

[melvin-bot]

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

[puneetlath]

Sent Upwork hiring offers.

@lschurr adding you for payment since I'll be OOO next week. Thanks!

[lschurr]

Not overdue. This will be paid tomorrow.

[sobitneupane]

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:

• [@sobitneupane] The PR that introduced the bug has been identified. Link to the PR:

#15751

• [@sobitneupane] 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:

#15751 (comment)

• [@sobitneupane] 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:

https://expensify.slack.com/archives/C049HHMV9SM/p1686632713430389

[sobitneupane]

Regression Test Proposal

1. Click on Settings -> Profile -> Contact Method
2. Either add a new contact method or select the existing one where verification is yet to be done
3. Enter incorrect magic code
4. Click on "Resend magic code"
5. Verify the error and the existing code gets cleared as soon as "Resend magic code" is clicked.

Do we agree 👍 or 👎

[lschurr]

Cool - these have been paid. I'll create a GH for a new regression test today.

[lschurr]

All set.