[HOLD for payment 2023-04-27] [$1000] Pronouns search results are not arranged alphabetically

[kavimuru]

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 the app
2. Open settings
3. Open profile
4. Open pronouns
5. Search with '/' to get maximum results and observe the search results

Expected Result:

App should arrange pronouns search result alphabetically

Actual Result:

App does not arrange pronouns search result alphabetically eg: 'She / Her / Hers' are above 'Mer / Mers'

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.2.97-2
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

pronouns.not.alphabetical.issue.mp4

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

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01b466ff328355bffb
• Upwork Job ID: 1646856150614585344
• Last Price Increase: 2023-04-14

[MelvinBot]

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

[MelvinBot]

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

[garrettmknight]

Discussing internally to see if this was intentional for any reason before opening it up.

[garrettmknight]

Got agreement, let's make it alphabetical!

[MelvinBot]

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

[MelvinBot]

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

[MelvinBot]

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

[tienifr]

Proposal

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

Pronouns search results are not sorted in alphabetic order.

What is the root cause of that problem?

Currently the pronounsList in PronounsPage is not sorted, it's only filtered by user's search value.

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

Sort the filtered pronouns list in getFilteredSortedPronouns() function in alphabetic order.

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

Lines 72 to 73 in a177ba3

	return _.filter(this.pronounsList,
	pronous => pronous.text.toLowerCase().indexOf(searchedValue.toLowerCase()) >= 0);

For example:

return _.chain(this.pronounsList)
            .filter(pronous => pronous.text.toLowerCase().indexOf(searchedValue.toLowerCase()) >= 0)
            .sortBy(pronous => pronous.text.toLocaleLowerCase())
            .value();

What alternative solutions did you explore? (Optional)

NA

Result

[Prince-Mendiratta]

Proposal

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

In this issue, when the user enters the text that is common to all pronouns, that is, '/', then the whole list of pronouns is shown. This list however is not sorted alphabetically.

What is the root cause of that problem?

In the translate files, the keys for each pronoun is not sorted alphabetically. This causes the list to render without being sorted as well.

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

To solve this issue, three approaches can be considered:

Solution A
We can reorder the pronouns key in the translation files itself, which will render the pronouns alphabetically. This approach is not future proof though as in the future if anyone were to add a new pronoun, they would have to do so alphabetically and considering the direction this world is heading we might have hundreds of pronouns haha so might want to check for that case.

Solution B
We can use the _.sortBy function to sort the list before passing it to the _.filter function in the getFilteredPronouns method. This will happen for each input the user enters.

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

Line 67 in da822f8

getFilteredPronouns() {

Solution C
We need to sort the whole list just once using the _.sortBy function in the loadPronouns method. This sorted list needs to be assigned to the this.pronounsList variable, which will ensure that all future operations are performed on the sorted list.

[PrashantMangukiya]

Proposal

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

Pronouns search results are not arranged alphabetically.

What is the root cause of that problem?

We are filtering pronoun list via this function

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

Lines 67 to 74 in bcada91

	getFilteredPronouns() {
	const searchedValue = this.state.searchValue.trim();
	if (searchedValue.length === 0) {
	return [];
	}
	return _.filter(this.pronounsList,
	pronous => pronous.text.toLowerCase().indexOf(searchedValue.toLowerCase()) >= 0);
	}

We can see at line 72 we are returning list without any sorting. So this is the root cause of the problem.

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

We have to sort the pronoun list list as shown below

getFilteredPronouns() {
    const searchedValue = this.state.searchValue.trim();
    if (searchedValue.length === 0) {
        return [];
    }

   return _.chain(this.pronounsList)
            .filter(pronouns => pronouns.text.toLowerCase().indexOf(searchedValue.toLowerCase()) >= 0)
            .sortBy(pronoun => pronoun.text.toLowerCase())
            .value()
}

What alternative solutions did you explore? (Optional)

We can also sort pronoun list while we load it via loadPronouns() function here

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

Lines 81 to 107 in bcada91

	loadPronouns() {
	const currentPronouns = lodashGet(this.props.currentUserPersonalDetails, 'pronouns', '');
	this.pronounsList = _.map(this.props.translate('pronouns'), (value, key) => {
	const fullPronounKey = `${CONST.PRONOUNS.PREFIX}${key}`;
	const isCurrentPronouns = fullPronounKey === currentPronouns;
	if (isCurrentPronouns) {
	this.initiallyFocusedOption = {
	text: value,
	keyForList: key,
	};
	}
	return {
	text: value,
	value: fullPronounKey,
	keyForList: key,
	// Include the green checkmark icon to indicate the currently selected value
	customIcon: isCurrentPronouns ? greenCheckmark : undefined,
	// This property will make the currently selected value have bold text
	boldStyle: isCurrentPronouns,
	};
	});
	}

So updated code should be as shown under:

loadPronouns() {
    const currentPronouns = lodashGet(this.props.currentUserPersonalDetails, 'pronouns', '');
   
    // Make const
    const pronounsList = _.map(this.props.translate('pronouns'), (value, key) => {
         ...
    });
    
    // Add this line
    this.pronounsList = _.sortBy(pronounsList, pronoun => pronoun.text.toLowerCase());
}

Results

Web.mov

[MelvinBot]

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

[jayeshmangwani]

Proposal

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

Pronouns search results are not sorted alphabetically

What is the root cause of that problem?

When we are returning the this.pronounsList at that time we are not sorting the list

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

Lines 84 to 107 in 0b5394e

	this.pronounsList = _.map(this.props.translate('pronouns'), (value, key) => {
	const fullPronounKey = `${CONST.PRONOUNS.PREFIX}${key}`;
	const isCurrentPronouns = fullPronounKey === currentPronouns;
	if (isCurrentPronouns) {
	this.initiallyFocusedOption = {
	text: value,
	keyForList: key,
	};
	}
	return {
	text: value,
	value: fullPronounKey,
	keyForList: key,
	// Include the green checkmark icon to indicate the currently selected value
	customIcon: isCurrentPronouns ? greenCheckmark : undefined,
	// This property will make the currently selected value have bold text
	boldStyle: isCurrentPronouns,
	};
	});
	}

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

we should use here sortBy function from the underscore like this

this.pronounsList = _.chain(this.props.translate('pronouns')) // <= ADD THIS LINE
    .map((value, key) => {
        const fullPronounKey = `${CONST.PRONOUNS.PREFIX}${key}`;
        const isCurrentPronouns = fullPronounKey === currentPronouns;

        if (isCurrentPronouns) {
            this.initiallyFocusedOption = {
                text: value,
                keyForList: key,
            };
        }

        return {
            text: value,
            value: fullPronounKey,
            keyForList: key,

            // Include the green checkmark icon to indicate the currently selected value
            customIcon: isCurrentPronouns ? greenCheckmark : undefined,

            // This property will make the currently selected value have bold text
            boldStyle: isCurrentPronouns,
        };
    })
    .sortBy(prounce => prounce.text) // <= ADD THIS LINE
    .value(); // <= ADD THIS LINE

What alternative solutions did you explore? (Optional)

none

[fedirjh]

Thanks everyone for the proposals , all proposals are quite similar. IMO by sorting the pronouns list in the loadPronouns function, we ensure that the sorted list is always available and any subsequent filtering operations are performed on the already sorted list. This approach would also avoid unnecessary sorting operations in the getFilteredPronouns function, which would improve performance.

Based on this , we can proceed with @Prince-Mendiratta's Proposal : Solution C.

@danieldoglas All yours.

🎀 👀 🎀 C+ reviewed

[MelvinBot]

📣 @Prince-Mendiratta You have been assigned to this job by @garrettmknight!
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 📖

[garrettmknight]

Everyone has offers.

[Prince-Mendiratta]

PR is up for review!

Accepted the offer on upwork.

Thanks!

cc @fedirjh

[MelvinBot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[MelvinBot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.3.2-5 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• [PronounsPage] sort pronouns list alphabetically #17558

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

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

[MelvinBot]

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:

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

[garrettmknight]

Reassigning since I'm OOO next week when this should be paid assuming no regressions.

[MelvinBot]

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

[fedirjh]

• The PR that introduced the bug has been identified. Link to the PR: New Pronouns page #12301
• The offending PR has been commented on : N/A It appears to be more aligned with a feature request rather than a regression.
• A discussion in #expensify-bugs has been started: N/A this was a new page, code didn't exist before that
• Determine if we should create a regression test for this bug: N/A This may not be critical enough to justify the effort of creating a new test case

[puneetlath]

All paid. Thanks everyone!