[HOLD for payment 2023-08-08] [$1000] Dev: Web - App crashes when trying to unlink secondary contact method

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

---

Action Performed:

1. Open a tab where account A is signed-in
2. Add secondary contact method B, and do not verify that contact method
3. Open a new window > Navigate to sign-in page
4. Enter secondary contact method B & click on the continue button
5. Click on 'unlink' button
6. Open email > copy 'validate link' > prefix the link localhost address > press enter

Expected Result:

App shouldn't crash & should unlink the secondary contact method

Actual Result:

App crashes

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.40-5
Reproducible in staging?: n
Reproducible in production?: n
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

Screencast.from.2023-07-14.15-40-28.mp4

Expensify/Expensify Issue URL:
Issue reported by: @Natnael-Guchima
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1689338260193289

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0125c02caca7cbee50
• Upwork Job ID: 1682413664782585856
2023-07-21
• Automatic offers:
• mollfpr | Reviewer | 25738337
• StevenKKC | Contributor | 25738338
• Natnael-guchima | Reporter | 25738340

[melvin-bot]

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

[ygshbht]

Proposal

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

In the current Expensify app, attempting to unlink a secondary contact method leads to an application crash. This unexpected behaviour is triggered under the condition that the secondary contact method is unverified. This issue is particularly associated with the process of secondary contact validation and de-linking.

What is the root cause of that problem?

Investigation points to the translate function, which is used to handle language-specific translations of phrase keys in the application. It appears that when this function doesn't find a phrase key in the language dictionaries, it throws an error that leads to the application crash.

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

A more robust alternative is to utilize the translateIfPhraseKey function which, unlike translate, returns the original message when a matching phrase is not found, rather than throwing an error. This graceful degradation prevents the application from crashing due to an error thrown.

Moreover, the translateIfPhraseKey function seems specifically designed for situations where the phrase keys might be dynamic or potentially non-existent in the language dictionaries, thus making it a more resilient choice.

Therefore, by replacing the translate function with translateIfPhraseKey in the specific code path related to unlinking secondary contact methods, we can avoid this issue and improve the overall robustness of the application.

What alternative solutions did you explore? (Optional)

Alternatively, like others, if the message is pre-translated, we could directly display the message as received. This approach bypasses the application of the translate or translateIfPhraseKey functions for this scenario, streamlining the process and diminishing the possibility of an application crash.

Result:

Studio_Project_V1.mp4

[StevenKKC]

Proposal

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

App crashes when trying to unlink secondary contact method.

What is the root cause of that problem?

If unlink secondary contact method, unlinkLogin function will be called.
In this function, set account.message Onyx data to the translated message. (i.e. Secondary login successfully unlinked!)

App/src/libs/actions/Session/index.js

Lines 763 to 770 in ca8d279

	{
	onyxMethod: Onyx.METHOD.MERGE,
	key: ONYXKEYS.ACCOUNT,
	value: {
	isLoading: false,
	message: Localize.translateLocal('unlinkLoginForm.succesfullyUnlinkedLogin'),
	},
	},

After unlink success, ONYXKEYS.ACCOUNT.MESSAGE will be displayed.

App/src/pages/signin/UnlinkLoginForm.js

Lines 65 to 72 in ca8d279

	{!_.isEmpty(props.account.message) && (
	// DotIndicatorMessage mostly expects onyxData errors so we need to mock an object so that the messages looks similar to prop.account.errors
	<DotIndicatorMessage
	style={[styles.mb5, styles.flex0]}
	type="success"
	messages={{0: props.translate(props.account.message)}}
	/>
	)}

Since props.account.message (i.e. account.message Onyx data) is already translated, and there is no Secondary login successfully unlinked! key in language dictionary, so the error is generated and app crashes.

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

We should store message key to Onyx in order to display proper translated message.

    {
        onyxMethod: Onyx.METHOD.MERGE,
        key: ONYXKEYS.ACCOUNT,
        value: {
            isLoading: false,
-           message: Localize.translateLocal('unlinkLoginForm.succesfullyUnlinkedLogin'),
+           message: 'unlinkLoginForm.succesfullyUnlinkedLogin',
        },
    },

What alternative solutions did you explore? (Optional)

None.

[sonialiap]

Didn't get to triaging this bug, I'll take a look at it tomorrow!

[sonialiap]

The app isn't crashing for me but I'm not receiving the magic link after step 5 🐛

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0125c02caca7cbee50

[melvin-bot]

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

[melvin-bot]

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

[kameshwarnayak]

Proposal

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

Web - App crashes when trying to unlink secondary contact method

What is the root cause of that problem?

In the unlinkLogin success data we are passing the translated value instead of the phraseKey

App/src/libs/actions/Session/index.js

Line 635 in cd851d0

message: Localize.translateLocal('unlinkLoginForm.succesfullyUnlinkedLogin'),

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

Instead of passing the translated value, pass the phraseKey. This is the way it is done in entire application. The above line will become

    message: 'unlinkLoginForm.succesfullyUnlinkedLogin',

This is the standard we are following in the entire application. Check the below code

App/src/libs/actions/Session/index.js

Line 599 in cd851d0

message: 'unlinkLoginForm.linkSent',

Result :

f29ce87d-8a66-45b0-bf6f-de56cdad3816.mp4

What alternative solutions did you explore? (Optional)

None

[mollfpr]

Thank you guys for the proposals!

I agree we should store localized messages in the Onyx with the phrase key instead the translated message. So the user will have the correct message shown based on their selected language. The proposal from @StevenKKC looks good to me.

🎀 👀 🎀 C+ reviewed!

[melvin-bot]

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

[MonilBhavsar]

Looks good 👍

[melvin-bot]

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

Offer link
Upwork job

[melvin-bot]

📣 @StevenKKC 🎉 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 📖

[melvin-bot]

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

Offer link
Upwork job

[Natnael-Guchima]

Accepted the offer. Thanks👍

[StevenKKC]

@mollfpr PR #23561 is ready for review.

[melvin-bot]

Based on my calculations, the pull request did not get merged within 3 working days of assignment. Please, check out my computations here:

• when @StevenKKC got assigned: 2023-07-25 10:04:10 Z
• when the PR got merged: 2023-07-28 12:47:30 UTC
• days elapsed: 3

On to the next one 🚀

[mollfpr]

The C+ approval is on Jul 26, so this is still eligible for the bonus.

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

• fix crash when trying to unlink secondary contact #23561

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

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:

• @mollfpr requires payment offer (Reviewer)
• @StevenKKC requires payment offer (Contributor)

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:

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

[mollfpr]

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

#15811

[@mollfpr] 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://github.com/Expensify/App/pull/15811/files#r1286197062

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

We have a checklist to ensure the copy/text is localized correctly in the reviewer checklist. So regression step should be enough.

[@mollfpr] Determine if we should create a regression test for this bug.
[@mollfpr] 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.

(Web only)

1. Login App
2. Add a secondary contact method, and do not verify that contact method
3. Open a new window and navigate to the sign-in page
4. Enter the secondary contact method & click on the continue button
5. Click on the 'unlink' button
6. Open the email and copy the 'validate link'
7. Prefix the link localhost address and paste it to the address bar
8. Verify that the app does not crash

[sonialiap]

@Natnael-Guchima report $250 - paid ✔️
@StevenKKC fix+bonus $1500 - paid ✔️
@mollfpr review+bonus $1500 - paid ✔️