Hide mention suggestions while opening file picker #19541

therealsujitk · 2023-05-24T15:27:34Z

Details

We already use a state variable shouldBlockEmojiCalc to prevent the emoji suggestions list from opening while the file picker is being opened. This PR simply renames this variable to shouldBlockSuggestionsCalc and applies it to both emoji and mention suggestions.

Fixed Issues

$ #18992
PROPOSAL: #18992 (comment)

Tests

Type '@' in the composer to get the mention suggestions list
Click the Actions (+) button and click on Add attachment
Verify that the suggestion list isn't visible while the file picker is being opened on web, is visible on native devices
Close the file picker and click on the composer, verify that the suggestions list opens on web, is still open on native devices.

Note: This PR doesn't fix existing issues on Safari (mWeb & Desktop) - #19541 (comment)

Verify that no errors appear in the JS console

Offline tests

QA Steps

Type '@' in the composer to get the mention suggestions list
Click the Actions (+) button and click on Add attachment
Verify that the suggestion list isn't visible while the file picker is being opened on web, is visible on native devices
Close the file picker and click on the composer, verify that the suggestions list opens on web, is still open on native devices.

Note: This PR doesn't fix existing issues on Safari (mWeb & Desktop) - #19541 (comment)

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screencast.from.24-05-23.08.19.45.PM.IST.webm

Mobile Web - Chrome

screen-20230526-152932.mp4

Mobile Web - Safari

VID-20230526-WA0002.mp4

Desktop

Screen.Recording.2023-05-26.at.5.45.36.PM.mov

iOS

Android

screen-20230525-122013.mp4

melvin-bot · 2023-05-24T15:27:40Z

@pecanoro @0xmiroslav One of you needs to 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]

therealsujitk · 2023-05-26T04:04:15Z

@0xmiroslav I could use a little help here, this works perfectly on desktop browsers however I'm facing some issues on mobile web (tested on android chrome).

I noticed (for me at least), on mobile browsers the composer is not focused before the file picker is opened like it does on desktop browsers (onSelectionChange() is not being triggered) and this prevents the suggestion list from being opened until there's been a selection change because setShouldBlockSuggestionsCalcToFalse() isn't called yet.

I believe this is the reason the composer's onClick function is used. It calls setShouldBlockSuggestionsCalcToFalse() before onSelectionChange but setState() (inside setShouldBlockSuggestionsCalcToFalse()) is asynchronous. It works on staging, but I suspect this is a fluke.

App/src/pages/home/report/ReportActionCompose.js

Line 1085 in 0925c25

onClick={this.setShouldBlockEmojiCalcToFalse}

Replacing onClick with onMouseDown seems to work, but this doesn't seem like a foolproof solution.

Bug output

Notice how the suggestions list doesn't show up event on multiple taps (until onSelectionChange() is triggered) - second attempt.

screen-20230526-132808.mp4

therealsujitk · 2023-05-26T09:52:44Z

@0xmiroslav alright I figured it out.

onClick is triggered after onSelectionChange, this is why the issue comes up, we should switch this to onMouseDown.
There is absolutely no reason for shouldBlockSuggestionsCalc to be a state variable, changing this to a normal variable will also rid the possibility of there ever being a race condition issue.

I'll be proceeding with these changes. I'd just like to confirm with @jjcoffee (the person who wrote this code), was there any reason for the onClick other than setting the block variable to false on mWeb?

jjcoffee · 2023-05-26T10:15:11Z

@therealsujitk No, I think it just being there for mWeb sounds about right to me!

0xmiros · 2023-05-26T11:40:37Z

@therealsujitk let's keep same behavior as emoji suggestions for now. Rest things can be out of scope if already happening on main.
The main bug to fix here is to prevent flickering.

0xmiros · 2023-05-26T11:42:46Z

deprecate setShouldBlockSuggestionsCalcToFalse and use this.shouldBlockSuggestionsCalc = false; directly everywhere

therealsujitk · 2023-05-26T12:02:22Z

I tested on Safari and there was a similar issue to the one I mentioned above (It's on staging as well). It appears the PR (#18227) was not tested properly. I fixed it by manually calling onSelectionChange() from the onClick event.

Screen.Recording.2023-05-26.at.5.27.51.PM.mov

therealsujitk · 2023-05-26T12:27:23Z

@pecanoro @0xmiroslav PR is ready for review.

0xmiros · 2023-05-26T12:46:23Z

src/pages/home/report/ReportActionCompose.js

    onSelectionChange(e) {
        LayoutAnimation.configureNext(LayoutAnimation.create(50, LayoutAnimation.Types.easeInEaseOut, LayoutAnimation.Properties.opacity));
-        this.setState({selection: e.nativeEvent.selection});
-        if (!this.state.value || e.nativeEvent.selection.end < 1) {
-            this.resetSuggestions();
+
+        if (e) {
+            this.setState({selection: e.nativeEvent.selection});
+            if (!this.state.value || e.nativeEvent.selection.end < 1) {
+                this.resetSuggestions();
+                this.shouldBlockSuggestionsCalc = false;
+                return;
+            }
+        }
+
+        if (this.shouldBlockSuggestionsCalc) {
+            this.shouldBlockSuggestionsCalc = false;
            return;
        }
+


I don't like this change. When click composer, calculateEmojiSuggestion and calculateMentionSuggestion is called 2 times always.

It's already known issue that onSelectionChange is not called on web when composer focused so can be out of scope.
Let's keep this PR simple as possible.

If you want me to remove it I can, but keep in mind that after I do the issue I mentioned will occur for mWeb, desktop, macOS browsers. Is that fine?

It's already happening on main right?

Yes, except the mWeb issue occurs more now for some reason. It was working previously by luck because of where it was placed in the code.

can you share 2 videos on mWeb ? from main and from this PR?

Understood I'll make the changes! I'd prefer if we create a separate issue for this and don't just forget about it because it seems like bad code. I probably won't work on it thought, this has given me quite a headache 😅.

Understood I'll make the changes! I'd prefer if we create a separate issue for this and don't just forget about it because it seems like bad code. I probably won't work on it thought, this has given me quite a headache 😅.

cc: @pecanoro

I think that refactor work will be done by someone who is working on #16263.
There will be many obstacles while converting this component to functional.

ok, let's put that code at the top of both functions

Ah, we can't do this 😞. The calculateEmojiSuggestion function is first called when shouldBlockSuggestionsCalc is true. It sets it to false and returns, immediately after calculateMentionSuggestion is called which is set to false because of calculateEmojiSuggestion so it doesn't return even though it should.

To solve this we'll need two variables shouldBlockEmmojiCalc & shouldBlockMentionCalc. Should I proceed?

src/pages/home/report/ReportActionCompose.js

0xmiros · 2023-05-26T15:19:46Z

@therealsujitk steps are incomplete in Tests/QA steps

therealsujitk · 2023-05-26T15:23:54Z

@therealsujitk steps are incomplete in Tests/QA steps

Updated 👍

0xmiros · 2023-05-26T15:26:34Z

We usually use "Verify" term than "Ensure"

therealsujitk · 2023-05-26T15:31:01Z

We usually use "Verify" term than "Ensure"

Updated 👍

0xmiros · 2023-05-26T15:40:45Z

Verify that the suggestion list isn't visible on web, visible on native while the file picker is being opened

therealsujitk · 2023-05-26T15:45:31Z

Verify that the suggestion list isn't visible on web, visible on native while the file picker is being opened

Updated 👍

0xmiros · 2023-05-26T15:46:18Z

Bug on native:

Screen.Recording.2023-05-26.at.5.44.54.PM.mov

I confirmed that this also happens on production so out of scope

0xmiros · 2023-05-26T15:58:19Z

Bug on mSafari:

msafari.mov

This is happening to emoji suggestions list on production

therealsujitk · 2023-05-26T16:22:27Z

This is happening to emoji suggestions list on production

Yeah, this is related to the issue we were discussing for hours. So, out of scope.

0xmiros · 2023-05-26T16:30:09Z

@pecanoro can you please confirm above bugs can be out of scope?
We had lots of discussions in this PR and in summary:

this PR fixes the main bug on chrome.
safari, mWeb issue still remaining but the behavior changed - completely hide instead of half-height
native issue but not related to this PR

All of these already happen to emoji suggestions list on production app

therealsujitk · 2023-05-29T05:16:57Z

@pecanoro friendly bump.

Edit: Sorry, I didn't know it was a holiday.

therealsujitk · 2023-05-30T03:34:51Z

@pecanoro do you think you could review this PR today?

pecanoro · 2023-05-31T09:54:26Z

Yes! Reviewing the PR today, sorry for the delay!

pecanoro · 2023-05-31T11:30:29Z

I read the whole discussion and tested it, but I am still a bit unsure why we can't fix the mentions not showing up after closing the attachment modal. If the same bug was present for the platforms, we should fix them all. I feel we are changing just one bug (half-height) for another one (completely hidden)

0xmiros · 2023-05-31T11:36:59Z

why we can't fix the mentions not showing up after closing the attachment modal

We can fix here but it's beyond the accepted proposal. And need more research for ideal solution to fix Safari, mWeb issues.
So the extended scope will be:

fix emoji suggestions bugs missed in Prevent emoji suggestions flicker on file picker opening on desktop web #18227
apply same to mention suggestions

therealsujitk · 2023-05-31T12:00:04Z

As of now we don't have a good solution to fix the out-of-scope bugs, the only one I could come up with until now is to call onSelectionChange manually in onClick which is a hack and will result in calling onSelectionChange twice on desktop web.

This PR simply keeps the behaviour of the mention suggestion list consistent with the emoji suggestion list and doesn't introduce any new bugs.

pecanoro · 2023-05-31T14:18:21Z

Ok, ok! You guys convinced me. But the bug needs to be reported so we can develop a solution. And maybe even post in the original PR to let them know it didn't work as expected.

pecanoro · 2023-05-31T14:18:48Z

@0xmiroslav We need the checklist before I can merge it.

0xmiros · 2023-05-31T14:53:18Z

Ok, ok! You guys convinced me. But the bug needs to be reported so we can develop a solution. And maybe even post in the original PR to let them know it didn't work as expected.

Sure! I will report bug in slack soon

0xmiros · 2023-05-31T14:54:20Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

therealsujitk · 2023-06-01T11:33:23Z

@pecanoro friendly bump.

OSBotify · 2023-06-01T12:31:27Z

✋ 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 · 2023-06-02T12:41:13Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.23-0 🚀

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

OSBotify · 2023-06-02T13:20:44Z

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.23-0 🚀

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

OSBotify · 2023-06-05T19:06:14Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.23-7 🚀

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

OSBotify · 2023-06-05T19:30:50Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.23-7 🚀

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

Hide mention suggestions while opening file picker

9e0cb2f

therealsujitk requested a review from a team as a code owner May 24, 2023 15:27

melvin-bot bot requested review from 0xmiros and pecanoro and removed request for a team May 24, 2023 15:27

Add shouldBlockSuggestionsCalc to initial state

ad9a141

therealsujitk added 3 commits May 26, 2023 15:26

Change shouldBlockSuggestionsCalc to a normal variable

388ea7d

Fix suggestions list issues with mWeb

bdde009

Merge branch 'main' into fix-18992

4664dce

Manually call onSelectionChange onClick

a26441a

Deprecate setShouldBlockSuggestionsCalcToFalse

39d7ca2

0xmiros reviewed May 26, 2023

View reviewed changes

therealsujitk added 2 commits May 26, 2023 20:32

Fix suggestions list issues with mWeb and revert changes

5f0c1ad

Add missing semicolon

495d715

therealsujitk requested a review from 0xmiros May 26, 2023 15:08

0xmiros reviewed May 26, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose.js Show resolved Hide resolved

0xmiros approved these changes May 31, 2023

View reviewed changes

pecanoro approved these changes Jun 1, 2023

View reviewed changes

pecanoro merged commit edf9b18 into Expensify:main Jun 1, 2023

OSBotify mentioned this pull request Jun 2, 2023

Deploy Checklist: New Expensify 2023-06-02 #20042

Closed

32 tasks

melvin-bot bot mentioned this pull request Jun 5, 2023

[HOLD for payment 2023-06-12] [$1000] Mentions results are displayed with half height on click of add attachment #18992

Closed

6 tasks

Hide mention suggestions while opening file picker #19541

Hide mention suggestions while opening file picker #19541

Conversation

therealsujitk commented May 24, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 24, 2023

therealsujitk commented May 26, 2023 • edited Loading

therealsujitk commented May 26, 2023

jjcoffee commented May 26, 2023

0xmiros commented May 26, 2023

0xmiros commented May 26, 2023

therealsujitk commented May 26, 2023

therealsujitk commented May 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

therealsujitk May 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xmiros commented May 26, 2023 • edited Loading

therealsujitk commented May 26, 2023

0xmiros commented May 26, 2023

therealsujitk commented May 26, 2023

0xmiros commented May 26, 2023

therealsujitk commented May 26, 2023

0xmiros commented May 26, 2023

0xmiros commented May 26, 2023

therealsujitk commented May 26, 2023 • edited Loading

0xmiros commented May 26, 2023

therealsujitk commented May 29, 2023 • edited Loading

therealsujitk commented May 30, 2023

pecanoro commented May 31, 2023

pecanoro commented May 31, 2023

0xmiros commented May 31, 2023

therealsujitk commented May 31, 2023

pecanoro commented May 31, 2023

pecanoro commented May 31, 2023

0xmiros commented May 31, 2023

0xmiros commented May 31, 2023

Reviewer Checklist

Screenshots/Videos

therealsujitk commented Jun 1, 2023

OSBotify commented Jun 1, 2023

OSBotify commented Jun 2, 2023

OSBotify commented Jun 2, 2023

OSBotify commented Jun 5, 2023

OSBotify commented Jun 5, 2023

therealsujitk commented May 24, 2023 •

edited

Loading

therealsujitk commented May 26, 2023 •

edited

Loading

therealsujitk May 26, 2023 •

edited

Loading

0xmiros commented May 26, 2023 •

edited

Loading

therealsujitk commented May 26, 2023 •

edited

Loading

therealsujitk commented May 29, 2023 •

edited

Loading