[HOLD for payment 2024-07-10] [$1000] Double click enter to select value on pronouns and timezone edit pages navigates "back" twice

[mvtglobally]

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. Go to avatar > settings > profile > pronouns
2. Search for a value that matches i.e "He / Him"
3. Double tap enter to select the value
4. Observe you're navigated back to the Settings page (i.e two pages in the nav stack)

Note: Same results on the timezone edit selection page.

Expected Result:

Use should only navigate back the one page in the nav stack when making a selection on the edit page.

Actual Result:

"Multi-tapping" is recognised and navigates back as many pages as you press enter. E.g twice = two pages, three times = three pages etc.

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.47-3
Reproducible in staging?: Y
Reproducible in production?:
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

double.enter.causes.double.back.1.mp4

Expensify/Expensify Issue URL:
Issue reported by: @dhanashree-sawant
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1690794214667299

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01fd11cd8ee50c8dff
• Upwork Job ID: 1691023835344474112
• Last Price Increase: 2023-08-14
• Automatic offers:
• huzaifa-99 | Contributor | 26238925

Issue Owner

Current Issue Owner: @trjExpensify

[melvin-bot]

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

[jfquevedol2198]

Updated Proposal

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

Double enter click to select value on pronouns and timezone navigates user to main page/main settings page

What is the root cause of that problem?

navigation.goBack() is wrong. When current active route is /settings/profile and we call navigation.goBack('settings/profie'), it goes to back /settings.

For this reason, when we are on Pronouns Select Page and click Enter key twice, it calls navigation.goBack('settings/profie') twice, but it goes to /settings/profile, and /settings

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

1. Update goBack method, this will prevent to goBack to current route.

    if (!canNavigate('goBack') || isActiveRoute(fallbackRoute)) {
        return;
    }

2. And Update updatePronouns, so we will prevent to update pronouns to empty.
   

   App/src/pages/settings/Profile/PronounsPage.js

   Line 74 in 4230f28

   PersonalDetails.updatePronouns(selectedPronouns.keyForList === initiallyFocusedOption.keyForList ? '' : lodashGet(selectedPronouns, 'value', ''));

   
   In this line, if new pronouns is same as current pronouns, it passes empty string in updatePronouns, so if pronouns is empty, we can perform goBack action only.

function updatePronouns(pronouns) {
    if (pronouns !== '') {
       API.write(...)
    }
    Navigation.goBack(ROUTES.SETTINGS_PROFILE);
}

What alternative solutions did you explore? (Optional)

We can update canNavigate like this:

function canNavigate(methodName, params = {}) {
    if (navigationRef.isReady() && !isActiveRoute(params['route'])) {
        return true;
    }
    Log.hmmm(`[Navigation] ${methodName} failed because navigation ref was not yet ready`, params);
    return false;
}

And, update goBack function like this:

if (!canNavigate('goBack', {route: fallbackRoute})) {
    return;
}

[trjExpensify]

Ah, this got assigned to me while I was OoO. Sorry for the delay! I can reproduce this one on desktop as well, so ticked that platform off and removed the needs reproduction label.

I'd quite like an opinion from @mountiny on the expected result here. I don't really see the real world use of "multi-tapping" enter to go back multiple pages in the nav stack, whether that be two, three or ten pages. So IMO, we should just go back the once (because that's the behaviour after the selection on the page you're pushed to). What do you think?

[melvin-bot]

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

[trjExpensify]

Bump @mountiny, maybe @shawnborton you have an opinion on this one as well. :)

[shawnborton]

"App should go back once on twice enter click to select value on pronouns or timezone page" - I don't think I understand what this means?

[trjExpensify]

😅 TL;DR

If you're a few pages deep in the nav, open up a push to page edit screen. "double tap" enter to select the value and it will navigate you back two pages in the app stack. If you triple tap, it goes back three pages etc.

IMO, we should just go back the once (because that's the behaviour after the selection on the page you're pushed to) however gung-ho you are with the enter button to make the selection.

[shawnborton]

Got it. Yup, I agree with that.

[trjExpensify]

Cool, nice! Updated the OP to reflect that and moved this on.

[melvin-bot]

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

[melvin-bot]

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

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

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

[mountiny]

I believe it just got deployed to production

[trjExpensify]

Yeah, looks like it.

[trjExpensify]

Checklist time!

[parasharrajat]

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:

• [@parasharrajat] The PR that introduced the bug has been identified. Link to the PR: Not PRs, it had been the default behavior.
• [@parasharrajat] 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: NA
• [@parasharrajat] 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: NA
• [@parasharrajat] Determine if we should create a regression test for this bug. Yes
• [@parasharrajat] 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 Steps

1. Go to Profile.
2. Open the Pronouns Settings page.
3. Verify that pressing any unselected option from the list multiple times (either with a mouse click, touch, arrow keys + enter) doesn’t navigate to or navigate back multiple times or make multiple API calls.
4. And that option gets selected as a result.

Note: links for these pages can change. Please update these as needed and easy to track.

Do you agree 👍 or 👎 ?

[trjExpensify]

Okay and confirming one regression?

[parasharrajat]

I think yes but the PR was pretty heavy for testing. There were many pages to test. It also needed two PRs.

Is it possible to keep the same price tag on this issue? cc: @huzaifa-99

[mountiny]

I am fine with keeping the full price on this one. This issue was created in August 2023, and it's been a long battle. There were regressions and I think we are still trying to find the ideal solution, but @huzaifa-99 's solution got us into a better place and it was lots of work and effort to do so $1000 seems fair.

[mountiny]

For the regression tests, I think we just need one page like PronounsPage -> /settings/profile/pronouns and make sure the tester clicks really fast to see if the page opens/ navigates mulitple times.

I dont think its viable to test all these pages

[trjExpensify]

Alright, so payment summary as follows:

• $1,000 to @parasharrajat for the C+ review (go ahead and request)
• $1,000 to @huzaifa-99 for the fix (offer sent!)

[trjExpensify]

As for the regression test, I agree with suggesting 1. Can you make this more readable and standardised in a format of numbered steps that a tester can repeatably follow if we were to add this to TestRail, @parasharrajat?

[parasharrajat]

I updated the formatting. But I can't list down steps for each page as each has separate functionality. The main step or interaction is mentioned in point 1. If the page has a selection list of options, try clicking it multiple times.

Hope this is sufficient.

[trjExpensify]

But I can't list down steps for each page as each has separate functionality.

I thought we agreed on just the one, so we can focus on pronouns or something?

I think we just need one page like PronounsPage -> /settings/profile/pronouns

[parasharrajat]

@trjExpensify Updated.

[trjExpensify]

Cool done, closing!

[dhanashree-sawant]

Hi @trjExpensify, @mountiny, @parasharrajat is this issue eligible for reporting bonus?

[trjExpensify]

Oh yeah, this is old and I didn't spot the reportedBy. So yes, I believe this is still eligible for $50 for the bug report. Are you still on Upwork?

[dhanashree-sawant]

Thanks @trjExpensify, Yes I am still on upwork, here is my profile link
https://www.upwork.com/freelancers/~016c7b8ae165dc0bda
Actually the issue was created before 31st August 2023 (the deadline after which we changed reporting bonus from 250 to 50 dollars) but at this stage of the project, I will be happy with whatever you decide.

[trjExpensify]

Yep, that makes sense. We honour those.

Payment summary as follows:

• $250 to @dhanashree-sawant for the bug report

Offer sent!

[dhanashree-sawant]

Many Thanks @trjExpensify, I have accepted the offer.

[trjExpensify]

Paid, closing.

[parasharrajat]

Payment requested as per #24074 (comment)

[JmillsExpensify]

$1,000 approved for @parasharrajat