[$1000] [HOLD for payment 2023-06-02] Include yourself and @here options in mentions auto-suggestion list

[puneetlath]

You have the ability to mention yourself and also to use @here to mention the entire group, but these options don't currently show up in the auto-suggestion box. Let's make it so that they do.

Today:

Ideal:

@szebniok do you want to take this one?

Reported by @0xmiroslav
@dhairyasenjaliya also reported the issue of reports showing up in the list

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0124eb9e68a1e7d86b
• Upwork Job ID: 1663295315309010944
• Last Price Increase: 2023-05-29

[melvin-bot]

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

[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

[allroundexperts]

Proposal

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

@here and yourself are not being shown in the mention suggestions

What is the root cause of that problem?

The root cause is that these two entries don't exist in the result that comes out of the OptionsListUtils.getNewChatOptions function here.

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

We need to create a new function called getMentionOptions that returns the mentions for a particular search term.

/**
 * Build the suggestions for mentions
 * @param {Object} personalDetails
 * @param {String} [searchValue]
 * @param {Number} [maxRecords]
 * @returns {Object}
 */
function getMentionOptions(personalDetails, searchValue = '', maxRecords = 5) {
    const suggestions = [];

    if ('here'.includes(searchValue)) {
        suggestions.push({
            text: '@here',
            alternateText: 'Notify everyone online in this room',
            icons: [
                {
                    name: '',
                    source: () => {},
                    type: 'avatar',
                },
            ],
        });
    }
    _.each(_.values(personalDetails), (detail) => {
        if (searchValue && !`${detail.displayName} ${detail.login}`.includes(searchValue)) {
            return;
        };

        suggestions.push({
            text: detail.displayName,
            alternateText: detail.login,
            icons: [
                {
                    name: detail.login,
                    source: detail.avatar,
                    type: 'avatar',
                },
            ]    
        });
    });
    return suggestions.slice(0, maxRecords);
}

We also need to change this line to:

        const mentionCode = `@${mentionObject.text === '@here' ? 'here' : mentionObject.alternateText}`;

This needs to be changed to:

            const suggestions = OptionsListUtils.getMentionOptions(this.props.personalDetails, prefix);

Results

Screen.Recording.2023-05-17.at.12.43.11.AM.mov

What alternative solutions did you explore? (Optional)

None

[puneetlath]

@allroundexperts I'm going to let @szebniok take this if he wants it, since it's a follow-up to the mentions functionality he built.

A couple thoughts I have:

1. When you just type @ with no other input, we should show @here first
2. Maybe instead of reusing OptionsListUtils.getNewChatOptions we should create a OptionsListUtils.getMentionsOptions

[allroundexperts]

@allroundexperts I'm going to let @szebniok take this if he wants it, since it's a follow-up to the mentions functionality he built.

A couple thoughts I have:

1. When you just type @ with no other input, we should show @here first
2. Maybe instead of reusing OptionsListUtils.getNewChatOptions we should create a OptionsListUtils.getMentionsOptions

@puneetlath I'm totally fine with that. I agree with your suggestions. There is a lot of room for refactors here which can be taken care of in the PR.

[puneetlath]

@szebniok mind commenting here so I can assign you?