[HOLD for payment 2023-07-26] [$1000] Change language also trigger submit Sign in validation form when magic codes are fullfilled

[kavimuru]

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

---

Action Performed:

1. Go to Sign in page
2. Enter any Expensify account
3. Fill-in incorrect magic codes
4. Verify that the form show "Incorrect magic code"
5. Scroll to bottom, change to another language

Expected Result:

The Sign in validation form should not be auto submitted

Actual Result:

The Sign in validation form is auto submitted

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

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.35-5
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
Notes/Photos/Videos: Any additional supporting documentation

Desktop.2023.06.30.-.20.27.50.06.mp4

Screen.Recording.2023-06-30.at.17.07.48.mov

Expensify/Expensify Issue URL:
Issue reported by: @hoangzinh

Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1688119742990839

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01a3cba7e2b4d05772
• Upwork Job ID: 1678889176475852800
• Last Price Increase: 2023-07-11

[melvin-bot]

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

[kavimuru]

Proposal

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

Change language also trigger submit Sign in validation form when magic codes are fullfilled

What is the root cause of that problem?

• In MagicCodeInput component, we have a useEffect that will be triggered when props.onFulfill be changed
  

  App/src/components/MagicCodeInput.js

  Lines 147 to 152 in 3404111

  	useEffect(() => {
  	validateAndSubmit();
  	// We have not added the editIndex as the dependency because we don't want to run this logic after focusing on an input to edit it after the user has completed the code.
  	// eslint-disable-next-line react-hooks/exhaustive-deps
  	}, [props.value, props.shouldSubmitOnComplete, props.onFulfill]);

• When we make the callback onFulfill to pass as a props to MagicCodeInput component in the BaseValidateCodeForm component, this callback will be updated whenever the props.preferredLocale is changed
  

  App/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

  Line 220 in 3404111

  }, [props.account.requiresTwoFactorAuth, props.credentials, props.preferredLocale, twoFactorAuthCode, validateCode]);

  
  => That means when the preferredLocale is changed => It changes how onFulfill callback should be => also trigger this MagicCodeInput useEffect to call validateAndSubmit

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

I think the purpose of this this MagicCodeInput useEffect is auto validate form if the magic codes are fulfilled. So we don't really need to trigger it when props.onFulfill is updated => I suggest we should remove props.onFulfill from dependency list here

[hoangzinh]

Proposal

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

Change language also trigger submit Sign in validation form when magic codes are fullfilled

What is the root cause of that problem?

• In MagicCodeInput component, we have a useEffect that will be triggered when props.onFulfill be changed
  

  App/src/components/MagicCodeInput.js

  Lines 147 to 152 in 3404111

  	useEffect(() => {
  	validateAndSubmit();
  	// We have not added the editIndex as the dependency because we don't want to run this logic after focusing on an input to edit it after the user has completed the code.
  	// eslint-disable-next-line react-hooks/exhaustive-deps
  	}, [props.value, props.shouldSubmitOnComplete, props.onFulfill]);

• When we make the callback onFulfill to pass as a props to MagicCodeInput component in the BaseValidateCodeForm component, this callback will be updated whenever the props.preferredLocale is changed
  

  App/src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

  Line 220 in 3404111

  }, [props.account.requiresTwoFactorAuth, props.credentials, props.preferredLocale, twoFactorAuthCode, validateCode]);

  
  => That means when the preferredLocale is changed => It changes how onFulfill callback should be => also trigger this MagicCodeInput useEffect to call validateAndSubmit

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

I think the purpose of this this MagicCodeInput useEffect is auto validate form if the magic codes are fulfilled. So we don't really need to trigger it when props.onFulfill is updated => I suggest we should remove props.onFulfill from dependency list here

[melvin-bot]

@michaelhaxhiu Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[melvin-bot]

@michaelhaxhiu Eep! 4 days overdue now. Issues have feelings too...

[melvin-bot]

@michaelhaxhiu 8 days overdue is a lot. Should this be a Weekly issue? If so, feel free to change it!

[michaelhaxhiu]

Sorry for the delay folks.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01a3cba7e2b4d05772

[melvin-bot]

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

[melvin-bot]

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

[michaelhaxhiu]

Weird bug. Thanks for the early proposal. I'll leave it to @mananjadhav to start the review process

[mananjadhav]

I think @hoangzinh's proposal looks good here. I can see we're already using // eslint-disable-next-line react-hooks/exhaustive-deps, so it won't throw an error.

🎀 👀 🎀 C+ Reviewed.

[melvin-bot]

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

[melvin-bot]

📣 @mananjadhav Please request via NewDot manual requests for the Reviewer role ($1000)

[melvin-bot]

📣 @mananjadhav We're missing your Upwork ID to automatically send you an offer for the Reviewer role.
Once you apply to the Upwork job, your Upwork ID will be stored and you will be automatically hired for future jobs!

[mountiny]

Thanks!

[melvin-bot]

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

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 📖

[melvin-bot]

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

Upwork job

[hoangzinh]

@mananjadhav @mountiny Thanks for accepting my proposal. The PR is ready #22781. Please help me to review it. Thanks

[mountiny]

merged

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

• Fix change language also trigger submit Sign in validation form when magic codes are fullfilled #22781

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

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

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:

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

[mananjadhav]

@michaelhaxhiu here's the items for the checklist.

1. We migrated the MagicCodeInput to functional component in this PR. This is where we added the onFulFill dependency.
2. I've commented here.
3. I don't think we should have any activity here, because this is very edge case and could've been covered.
4. I also don't think we need a regression test, we've added our change related comment in the code.

@michaelhaxhiu This is ready for payout on Jul 26, and also eligible for the timeline bonus. I'll raise my request on NewDot for this one. Can you payout the reporting bonus and contributor fees for @hoangzinh?

[michaelhaxhiu]

Payment summary:

• @hoangzinh External issue reporter $250
• @hoangzinh Contributor that fixed the issue $1500
• @mananjadhav Contributor+ that helped on the issue and/or PR $1500 via New Dot

[michaelhaxhiu]

All set, just need manan to ensure he requests payment in new dot. Closing.

[JmillsExpensify]

Reviewed details for @mananjadhav. This is accurate and approved for payment in NewDot.