feat: ordered mention suggestions #42553

gijoe0295 · 2024-05-23T18:55:28Z

Details

Implement mention suggestions with order of relevancy when in a group chat or a chat connected to a workspace:

People within the chat (members of the Report)
People within the Workspace
Other Contacts

Fixed Issues

$ #42009
PROPOSAL: #42009 (comment)

Tests

Type @ in a group chat with several participants
Verify the order of suggestions: group members >> other contacts, both in alphabetical order
Type in a letter
Verify the list is filtered to the individuals containing that letter with the same hierarchy preserved as described above

Type @ in a Workspace room, where only a fraction of the workspace members are in the room
Verify the order of suggestions: room members >> workspace members >> other contacts, all in alphabetical order
Type in a letter
Verify the list is filtered to the individuals containing that letter with the same hierarchy preserved as described above

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Same as Tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-05-24.at.02.14.42-source.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

Group chat

Workspace room

MacOS: Desktop

melvin-bot · 2024-05-23T19:30:18Z

@alitoshmatov Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

alitoshmatov · 2024-05-26T17:32:11Z

@gijoe0295 Can you check this in groups, in my case suggestion is not showing report members first

gijoe0295 · 2024-05-26T18:16:58Z

@alitoshmatov could you add me to that group? gijoe0295@gmail.com please.

alitoshmatov · 2024-05-26T18:20:05Z

@gijoe0295 Can't add to an existing group

alitoshmatov · 2024-05-26T18:21:49Z

Looks like this is happening only with old groups. I couldn't reproduce the issue when creating a new croup even choosing the same members

gijoe0295 · 2024-05-27T10:47:54Z

Looks like this is happening only with old groups

This sounds a problem. Let me investigate it.

…at-ordered-mention-suggestions

gijoe0295 · 2024-06-01T09:27:31Z

Hi @alitoshmatov I couldn't reproduce your issue with old groups. Could you please log the currentReport, policyEmployeeAccountIDs and personalDetails so I can debug with ease?

alitoshmatov · 2024-06-02T18:13:16Z

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx

+        if (!ReportUtils.isGroupChat(currentReport) && !ReportUtils.doesReportBelongToWorkspace(currentReport, policyEmployeeAccountIDs, policyID)) {
+            return personalDetails;
+        }


Looks like this condition is met in my case, that is why weighted ordering didn't work. Removing it helped and showed group members first. I think we don't need this condition. Can we remove it safely?
@gijoe0295

As per OP:

when in a group chat or a chat connected to a workspace

Removing this condition would introduce unnecessary computation of weightedPersonalDetails for normal reports.

I think there's some incorrect data with your currentReport. If it was a group chat, the condition would work properly. Maybe let's log out then log in to see if it got the correct data?

Sorry, I confused the cases in the condition, that's why my conclusion was wrong

I see that for a report to be a group chat it should have chatType=group but it is empty for this case. Maybe it is a thing with older groups. I checked this with multiple old groups in two accounts and the same true for all

Below is currentReport, policyEmployeeAccountIDs, policyID

{ "reportID": "1164088907436698", "reportName": "Chat Report", "type": "chat", "chatType": "", "ownerAccountID": 0, "managerID": 0, "policyID": "_FAKE_", "participants": { "14579716": { "hidden": false }, "14582230": { "hidden": false }, "14640187": { "hidden": false }, "14640366": { "hidden": false }, "14640421": { "hidden": false } }, "participantAccountIDs": [ 14582230, 14640187, 14640366, 14640421 ], "visibleChatMemberAccountIDs": [ 14582230, 14640187, 14640366, 14640421 ], "isPinned": false, "lastReadTime": "2024-04-12 15:49:29.672", "lastReadSequenceNumber": 0, "lastVisibleActionCreated": "2024-04-12 15:49:29.672", "lastVisibleActionLastModified": "2024-04-12 15:49:29.672", "lastMessageText": "@alitoshmatov2001+test@gmail.com Hello world, new @alitoshmatov2001+android@gm…", "lastActionType": "ADDCOMMENT", "lastActorAccountID": "14579716", "notificationPreference": "always", "stateNum": 0, "statusNum": 0, "oldPolicyName": "", "isOwnPolicyExpenseChat": false, "lastMessageHtml": "<mention-user>@alitoshmatov2001+test@gmail.com</mention-user> Hello world, new <mention-user>@alitoshmatov2001+android@gmail.com</mention-user>", "hasOutstandingChildRequest": false, "writeCapability": "all", "description": "", "total": 0, "unheldTotal": 0, "currency": "USD", "isWaitingOnBankAccount": false, "nonReimbursableTotal": 0, "isCancelledIOU": false, "permissions": [ "read", "write" ], "submitterPayPalMeAddress": "", "welcomeMessage": "", "errorFields": {} }

I see that for a report to be a group chat it should have chatType=group but it is empty for this case.

I think this is another bug and not related to this PR. Before group chats, we had group DMs. Maybe the migration from group DMs had some problems.

cc @yuwenmemon We found several group chats with empty chatType (should be group), do you have any clue on this? Should we ignore it since it is not related to this PR?

I think we should proceed with this PR

@gijoe0295 Yeah maybe let's raise in expensify-bugs: https://expensify.enterprise.slack.com/archives/C049HHMV9SM

…at-ordered-mention-suggestions

gijoe0295 · 2024-06-11T07:02:04Z

@alitoshmatov Do you have any other feedbacks?

alitoshmatov · 2024-06-12T10:45:02Z

I will complete the checklist

alitoshmatov · 2024-06-13T09:54:56Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

ordered-mentions-mweb.mov

iOS: Native

members-ios.mp4

iOS: mWeb Safari

ordered-mentions-safari.mp4

MacOS: Chrome / Safari

ordered-mentions-web.mov

MacOS: Desktop

ordered-mentions-desktop.mov

alitoshmatov

LGTM!

yuwenmemon · 2024-06-14T15:50:12Z

src/pages/home/report/ReportActionCompose/SuggestionMention.tsx

+            detail
+                ? {
+                      ...detail,
+                      weight: getPersonalDetailsWeight(detail, policyEmployeeAccountIDs),


NAB: A more apt name could be maybe something like orderWeight

OSBotify · 2024-06-14T23:16:21Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.4.84-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-06-17T23:48:34Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.84-3 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

ordered mention suggestions

3a2f068

gijoe0295 marked this pull request as ready for review May 23, 2024 19:30

gijoe0295 requested a review from a team as a code owner May 23, 2024 19:30

melvin-bot bot removed the request for review from a team May 23, 2024 19:30

melvin-bot bot requested a review from alitoshmatov May 23, 2024 19:30

Merge branch 'main' of https://github.com/gijoe0295/App into gijoe/fe…

61ddeb3

…at-ordered-mention-suggestions

alitoshmatov reviewed Jun 2, 2024

View reviewed changes

Merge branch 'main' of https://github.com/gijoe0295/App into gijoe/fe…

7572842

…at-ordered-mention-suggestions

alitoshmatov approved these changes Jun 13, 2024

View reviewed changes

melvin-bot bot requested a review from yuwenmemon June 13, 2024 09:55

yuwenmemon approved these changes Jun 14, 2024

View reviewed changes

yuwenmemon merged commit 1fd7ecc into Expensify:main Jun 14, 2024
18 of 20 checks passed

This was referenced Jun 14, 2024

Investigate workflow job failing on main: typecheck / typecheck #43778

Closed

Investigate workflow job failing on main: confirmPassingBuild #43779

Closed

Deploy Checklist: New Expensify 2024-06-14 #43793

Closed

lanitochka17 mentioned this pull request Jun 17, 2024

[HOLD for payment 2024-08-09] [$250] Mention List - Users are not alphabetically ordered #43845

Closed

6 tasks

melvin-bot bot mentioned this pull request Jun 17, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] [$250] Order Suggested Mentions according to relevancy when in a Group Chat #42009

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ordered mention suggestions #42553

feat: ordered mention suggestions #42553

gijoe0295 commented May 23, 2024 •

edited

Loading

melvin-bot bot commented May 23, 2024

alitoshmatov commented May 26, 2024

gijoe0295 commented May 26, 2024

alitoshmatov commented May 26, 2024

alitoshmatov commented May 26, 2024

gijoe0295 commented May 27, 2024

gijoe0295 commented Jun 1, 2024

alitoshmatov Jun 2, 2024

gijoe0295 Jun 4, 2024

alitoshmatov Jun 4, 2024

gijoe0295 Jun 6, 2024

alitoshmatov Jun 6, 2024

yuwenmemon Jun 6, 2024

gijoe0295 commented Jun 11, 2024

alitoshmatov commented Jun 12, 2024

alitoshmatov commented Jun 13, 2024

alitoshmatov left a comment

yuwenmemon Jun 14, 2024

OSBotify commented Jun 14, 2024

OSBotify commented Jun 17, 2024

feat: ordered mention suggestions #42553

feat: ordered mention suggestions #42553

Conversation

gijoe0295 commented May 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Group chat

Workspace room

melvin-bot bot commented May 23, 2024

alitoshmatov commented May 26, 2024

gijoe0295 commented May 26, 2024

alitoshmatov commented May 26, 2024

alitoshmatov commented May 26, 2024

gijoe0295 commented May 27, 2024

gijoe0295 commented Jun 1, 2024

alitoshmatov Jun 2, 2024

Choose a reason for hiding this comment

gijoe0295 Jun 4, 2024

Choose a reason for hiding this comment

alitoshmatov Jun 4, 2024

Choose a reason for hiding this comment

gijoe0295 Jun 6, 2024

Choose a reason for hiding this comment

alitoshmatov Jun 6, 2024

Choose a reason for hiding this comment

yuwenmemon Jun 6, 2024

Choose a reason for hiding this comment

gijoe0295 commented Jun 11, 2024

alitoshmatov commented Jun 12, 2024

alitoshmatov commented Jun 13, 2024

Reviewer Checklist

Screenshots/Videos

alitoshmatov left a comment

Choose a reason for hiding this comment

yuwenmemon Jun 14, 2024

Choose a reason for hiding this comment

OSBotify commented Jun 14, 2024

OSBotify commented Jun 17, 2024

gijoe0295 commented May 23, 2024 •

edited

Loading