[MentionsV2] Room mentions suggestions by robertKozik · Pull Request #39697 · Expensify/App

robertKozik · 2024-04-05T11:44:01Z

Details

This PR introduces suggestions support for new type of mentions - room mentions.

Fixed Issues

$ #39532
PROPOSAL: N/A - design doc

Tests

Create several rooms within workspace
Open room chat and start typing room mentions (room name with # prefix), verify that suggestions are displayed above the composer.
Verify that every room inside suggestions is connected with the same policy as opened room
Open 1:1 Chat
Open a room that doesn't belong to a policy, verify that no auto-complete widget is present while typing room mention

Verify that no errors appear in the JS console

Offline tests

Same as test steps

QA Steps

Same as test steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-05.at.13.00.54.mov

Android: mWeb Chrome

Screen.Recording.2024-04-05.at.13.28.01.mov

iOS: Native

Screen.Recording.2024-04-05.at.13.47.21.mov

iOS: mWeb Safari

Screen.Recording.2024-04-05.at.13.34.55.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

Screen.Recording.2024-04-05.at.13.39.42.mov

…omMentionsSuggestions

melvin-bot · 2024-04-05T16:28:46Z

@paultsimura 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]

paultsimura · 2024-04-06T10:11:51Z

@rlinoz could you please give me access to the doc, or attach the screenshots of the relevant section?

paultsimura · 2024-04-06T10:46:27Z

This PR enables room mentions in any report that belongs to the same policy (e.g. in policy expense chats, expense reports, threads in them, etc.), while the issue description says it should be available only in policy rooms – what is the real expectation here?

src/components/MentionSuggestions.tsx

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

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

paultsimura · 2024-04-06T21:05:01Z

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

+                if (!ReportUtils.isGroupPolicy(report) || !isValidRoomName(report?.reportName ?? '')) {
+                    // checking validity of room name removes Policy Expense Chats
+                    return;
+                }


Did you consider using just ReportUtils.isChatRoom?

I'm not entirely convinced that isChatRoom would be the best fit here. This check seems to filter out reports that are not connected with group policy, while the additional room name validation check filters out the Policy Expense chats.

I'm not deeply familiar with report handling, so if you believe isChatRoom would work well in this context based on your experience, I'm open to it.

From a discussion in Slack:
Please create a separate function in ReportUtils:

function canReportBeMentionedWithinPolicy(report: OnyxEntry<Report>, policyId: string): boolean { if (report?.policyID !== policyId) { return false; } return isChatRoom(report) && !isThread(report); }

And use it for filtering the reports here.

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

rlinoz · 2024-04-08T13:08:55Z

This PR enables room mentions in any report that belongs to the same policy (e.g. in policy expense chats, expense reports, threads in them, etc.), while the issue description says it should be available only in policy rooms – what is the real expectation here?

I updated the issue, but we should be able to mention policy rooms in any report that belongs to a policy.

paultsimura · 2024-04-09T15:20:59Z

@robertKozik could you please merge main as well?

…omMentionsSuggestions

robertKozik · 2024-04-09T17:40:24Z

@paultsimura done!

paultsimura · 2024-04-10T06:35:10Z

@robertKozik please address this as well:

https://github.com/Expensify/App/pull/39697/files#r1557984758

paultsimura · 2024-04-10T06:35:33Z

I'll be filling the checklist in the meantime

paultsimura · 2024-04-10T07:25:17Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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

android09.18.mp4

Android: mWeb Chrome

chrome09.18.mp4

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-04-10.at.09.15.3709.18.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-04-10.at.09.14.5909.18.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-04-10.at.08.58.1609.07.mp4

MacOS: Desktop

Screen.Recording.2024-04-10.at.09.02.2609.07.mp4

robertKozik · 2024-04-10T07:44:18Z

@robertKozik please address this as well:

https://github.com/Expensify/App/pull/39697/files#r1557984758

Sure, done 😉

paultsimura

LGTM ✔️

rlinoz

Works great!

Just a couple of typos

rlinoz · 2024-04-10T12:28:02Z

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

        // eslint-disable-next-line react/no-unused-prop-types -- its used in the withOnyx HOC
        parentReportID: string | undefined;
+
+        /** Whether chat is a reoprt from group policy */


Suggested change

/** Whether chat is a reoprt from group policy */

/** Whether chat is a report from group policy */

I don't think we should say "chat" here. I think it's just:

Suggested change

/** Whether chat is a reoprt from group policy */

/** Whether report is from group policy */

rlinoz · 2024-04-10T12:30:26Z

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

                nextState.shouldShowSuggestionMenu = !!suggestions.length;
            }

+            const shouldDisplayMenetionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) || prefix === '');


typo

Suggested change

const shouldDisplayMenetionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) || prefix === '');

const shouldDisplayMentionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) || prefix === '');

Suggested change

const shouldDisplayMenetionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) || prefix === '');

const shouldDisplayRoomMentionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) || prefix === '');

This variable is only for room mentions, right?

puneetlath · 2024-04-10T14:51:35Z

It looks like the style is a little bit different than what is in the design doc. Can we try to match that?

puneetlath · 2024-04-10T14:52:25Z

cc @shawnborton

puneetlath · 2024-04-11T14:24:23Z

Slack doesn't seem to sort alphabetically. I'm sure there's some rhyme or reason to how they order, though I'm not sure what it is.

rlinoz · 2024-04-11T14:33:21Z

Testing on slack it seems quite random though

Missed one comment

robertKozik · 2024-04-11T18:32:17Z

Sorting would be a simple change, let me know if we decided on implementing it 👀

rlinoz · 2024-04-11T20:37:17Z

I think we can go ahead and sort alphabetically and later decide on a better way.

robertKozik · 2024-04-11T22:45:51Z

@rlinoz done

rlinoz · 2024-04-11T23:08:39Z

@robertKozik looks good to me, but lint is upset

robertKozik · 2024-04-11T23:11:21Z

Damn, didn't noticed - should be alright now

robertKozik · 2024-04-12T11:26:08Z

Do you think we can merge it today? It will unblock the live search issue

rlinoz

Looks good!

All yours @puneetlath

puneetlath

Looks good! Just a comment about comments 😄

puneetlath · 2024-04-12T13:52:27Z

src/components/MentionSuggestions.tsx


 type Mention = {
-    /** Display name of the user */
+    /** Display name of the mention */


Suggested change

/** Display name of the mention */

/** Display text of the mention */

I think? Actually not sure.

puneetlath · 2024-04-12T13:53:19Z

src/components/MentionSuggestions.tsx


-    /** Email/phone number of the user */
-    login?: string;
+    /** handle of the mention */


I'm not totally understanding from these prop descriptions what the difference between text, alternateText, and handle is. Maybe we could make these comments a bit more descriptive?

robertKozik · 2024-04-12T16:44:06Z

@puneetlath updated the comments. Please check if now it's more descriptive 😄

puneetlath

Thanks for updating! Let's just make the capitalization consistent and then I'm happy :)

src/components/MentionSuggestions.tsx

Co-authored-by: Puneet Lath <puneet@expensify.com>

robertKozik · 2024-04-12T17:23:37Z

Done! 🎉

puneetlath

Thanks for bearing with me

OSBotify · 2024-04-12T17:58:24Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-04-18T04:56:35Z

🚀 Deployed to staging by https://github.com/rlinoz in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:57:34Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

robertKozik added 3 commits April 5, 2024 11:19

make icons optional inside mentions render component

1ec5cc3

implement room mentions suggestions

f9635d0

Merge remote-tracking branch 'upstream/main' into 39532-mentionsV2-ro…

d411dfe

…omMentionsSuggestions

robertKozik marked this pull request as ready for review April 5, 2024 16:28

robertKozik requested a review from a team as a code owner April 5, 2024 16:28

melvin-bot bot requested review from paultsimura and removed request for a team April 5, 2024 16:28

paultsimura reviewed Apr 6, 2024

View reviewed changes

puneetlath requested changes Apr 8, 2024

View reviewed changes

src/pages/home/report/ReportActionCompose/ReportActionCompose.tsx Outdated Show resolved Hide resolved

rlinoz self-requested a review April 8, 2024 16:05

adress review comments

23b1e92

robertKozik requested review from paultsimura and puneetlath April 9, 2024 13:41

Merge remote-tracking branch 'upstream/main' into 39532-mentionsV2-ro…

8a0a9ad

…omMentionsSuggestions

use canReportBeMentionedWithinPolicy function

398b32f

paultsimura approved these changes Apr 10, 2024

View reviewed changes

rlinoz reviewed Apr 10, 2024

View reviewed changes

This comment was marked as off-topic.

Sign in to view

generalize mention type to be less user specific

8836cf2

sort room mentions

f834530

prettier

45cd559

rlinoz previously approved these changes Apr 12, 2024

View reviewed changes

robertKozik requested a review from puneetlath April 12, 2024 11:38

puneetlath requested changes Apr 12, 2024

View reviewed changes

update mentions comments

117a093

robertKozik dismissed rlinoz’s stale review via 117a093 April 12, 2024 16:41

Merge branch 'main' into 39532-mentionsV2-roomMentionsSuggestions

1a6cfa9

puneetlath requested changes Apr 12, 2024

View reviewed changes

src/components/MentionSuggestions.tsx Outdated Show resolved Hide resolved

src/components/MentionSuggestions.tsx Outdated Show resolved Hide resolved

Make capitalization consistent

8b64eb2

Co-authored-by: Puneet Lath <puneet@expensify.com>

puneetlath approved these changes Apr 12, 2024

View reviewed changes

rlinoz approved these changes Apr 12, 2024

View reviewed changes

rlinoz merged commit 5f04270 into Expensify:main Apr 12, 2024

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

	/** Whether chat is a reoprt from group policy */
	/** Whether chat is a report from group policy */

	/** Whether chat is a reoprt from group policy */
	/** Whether report is from group policy */

	const shouldDisplayMenetionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) \|\| prefix === '');
	const shouldDisplayMentionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) \|\| prefix === '');

	const shouldDisplayMenetionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) \|\| prefix === '');
	const shouldDisplayRoomMentionsSuggestions = isGroupPolicyReport && (isValidRoomName(suggestionWord.toLowerCase()) \|\| prefix === '');

	/** Display name of the mention */
	/** Display text of the mention */

Conversation

robertKozik commented Apr 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 5, 2024

Uh oh!

paultsimura commented Apr 6, 2024

Uh oh!

paultsimura commented Apr 6, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rlinoz commented Apr 8, 2024

Uh oh!

paultsimura commented Apr 9, 2024

Uh oh!

robertKozik commented Apr 9, 2024

Uh oh!

paultsimura commented Apr 10, 2024

Uh oh!

paultsimura commented Apr 10, 2024

Uh oh!

paultsimura commented Apr 10, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

robertKozik commented Apr 10, 2024

Uh oh!

paultsimura left a comment

Choose a reason for hiding this comment

Uh oh!

rlinoz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

puneetlath commented Apr 10, 2024

Uh oh!

puneetlath commented Apr 10, 2024

Uh oh!

This comment was marked as off-topic.

puneetlath commented Apr 11, 2024

Uh oh!

rlinoz commented Apr 11, 2024

Uh oh!

robertKozik commented Apr 11, 2024

Uh oh!

rlinoz commented Apr 11, 2024

Uh oh!

robertKozik commented Apr 11, 2024

Uh oh!

rlinoz commented Apr 11, 2024

Uh oh!

robertKozik commented Apr 11, 2024

Uh oh!

robertKozik commented Apr 12, 2024

Uh oh!

rlinoz left a comment

robertKozik commented Apr 5, 2024 •

edited

Loading