Fix: Composer not focused on click while editor's emoji modal is open#28238
Fix: Composer not focused on click while editor's emoji modal is open#28238johnmlee101 merged 35 commits intoExpensify:mainfrom
Conversation
tienifr
changed the title
|
When do you think this will be ready for review @tienifr ? |
melvin-bot
bot
requested review from
parasharrajat
and removed request for
a team
|
@parasharrajat 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] |
|
@parasharrajat The expected behaviors in above test cases are referenced from |
| * Typical uses of this would be call the focus on the ReportActionComposer. | ||
| * | ||
| * @param callback callback to register | ||
| * @param isMainComposer |
There was a problem hiding this comment.
There is no use of this unless you define the param via a comment.
| maxLines={maxComposerLines} | ||
| onFocus={onFocus} | ||
| onFocus={() => { | ||
| setUpComposeFocusManager(false); |
There was a problem hiding this comment.
Just a note: Explained here #28238 (comment).
| /** | ||
| * Focus the composer text input | ||
| * @param {Boolean} [shouldDelay=false] Impose delay before focusing the composer | ||
| * @memberof ReportActionCompose | ||
| */ | ||
| const focus = useCallback((shouldDelay = false) => { | ||
| focusWithDelay(textInputRef.current)(shouldDelay); | ||
| }, []); |
There was a problem hiding this comment.
Why did you recreate this if it was already present below? If you want to use useCallback, we can do so
| /** | |
| * Focus the composer text input | |
| * @param {Boolean} [shouldDelay=false] Impose delay before focusing the composer | |
| * @memberof ReportActionCompose | |
| */ | |
| const focus = useCallback((shouldDelay = false) => { | |
| focusWithDelay(textInputRef.current)(shouldDelay); | |
| }, []); | |
| const focus = useCallback(focusWithDelay(textInputRef.current), []); |
There was a problem hiding this comment.
This was referenced from ComposerWithSuggestions which allows the shouldDelay param:
App/src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js
Lines 383 to 385 in 30b3992
Anw, the former implementation without useCallback is still fine if you want to stick with it.
There was a problem hiding this comment.
Actually, focusWithDelay is a curry function that returns a callback that accepts shouldDelay by default. IMO, it was done in this way to be explicit about parameters. If the suggested code works, let's do that instead.
const focus = useCallback(focusWithDelay(textInputRef.current), []);
There was a problem hiding this comment.
This would cause lint error: ESLint: React Hook useCallback received a function whose dependencies are unknown. Pass an inline function instead. I think the implementation referenced from ComposerWithSuggestions is better.
| ReportActionComposeFocusManager.onComposerFocus(() => { | ||
| focus(true); | ||
| }); |
There was a problem hiding this comment.
| ReportActionComposeFocusManager.onComposerFocus(() => { | |
| focus(true); | |
| }); | |
| ReportActionComposeFocusManager.onComposerFocus(() => { | |
| focus(true); | |
| }, false); |
There was a problem hiding this comment.
The dafault param for isMainComposer is false so no need to specify this again.
There was a problem hiding this comment.
it is more readable and understandable to be explicit about it.
| } | ||
|
|
||
| return () => { | ||
| ReportActionComposeFocusManager.clear(); |
There was a problem hiding this comment.
let's create a new effect for the setting of focus thing. We should not pollute other effects
| onPress={() => { | ||
| setUpComposeFocusManager(); | ||
| }} |
There was a problem hiding this comment.
| onPress={() => { | |
| setUpComposeFocusManager(); | |
| }} | |
| onPress={setUpComposeFocusManager} |
PLease add a comment
| setIsFocused(true); | ||
| reportScrollManager.scrollToIndex({animated: true, index: props.index}, true); | ||
| setShouldShowComposeInputKeyboardAware(false); | ||
| setUpComposeFocusManager(); |
There was a problem hiding this comment.
This will cause recursion.
There was a problem hiding this comment.
In other words, We will resubscribe to focusHandler(ReportActionComposeFocusManager) every time, it gets focused where focus might be triggered from the same focushandler(ReportActionComposeFocusManager).
There was a problem hiding this comment.
The purpose of this is to let the last focused composer to re-gain focus:
We need to make sure the ReportActionComposeFocusManager can handle both:
- general composer (which includes the edit composer): If this is the last composer that was focused on, we want to refocus on this
- main composer: If there's no last composer that was focused on before, this should be the fallback composer that we need to focus
This also explains why I did the same with ComposerWithSuggestions above.
There was a problem hiding this comment.
I don't think this could cause recursion because focusCallback is overwritten.
There was a problem hiding this comment.
From code perspective, previously the onComposerFocus callback was overwritten onFocus in Composer component. Thus if we removed the callback there, we need to do the same with parent composers.
There was a problem hiding this comment.
Speaking of this, I realized that we should not subscribe the focus callback when composer mounts but when it's focused instead. Subscribe on mount is redundant.
|
BUG: Web: Edit comment does not focus the message being edited. 28.08.2024_22.12.12_REC.mp4 |
|
BUG: Web: Main composer focus does not work. 28.08.2024_22.14.26_REC.mp4 |
|
@tienifr Do you know why we are seeing these issues now? |
|
@parasharrajat Sorry for the delay, I'm checking now |
|
@parasharrajat Did you disable strict mode? Everything works well on my side without strict mode web-resize.mp4 |
|
Aha, damn StrictMode. I will recheck. |
|
I will check this in 2 hours. |
Screenshots🔲 iOS / native04.09.2024_12.43.24_REC.mp4🔲 iOS / Safari04.09.2024_12.45.41_REC.mp4🔲 MacOS / Desktop04.09.2024_12.40.05_REC.mp4🔲 MacOS / Chrome04.09.2024_12.19.12_REC.mp4🔲 Android / Chrome04.09.2024_12.50.15_REC.mp4🔲 Android / native04.09.2024_14.36.27_REC.mp4 |
|
I noticed that focusing does not work properly on iOS Safari. When we edit a message while another edit composer is focused, focus does not switch to new edit composer. @tienifr |
|
Overall, the PR looks good. I noticed that focus work different on safari mobile. What are your thoughts on this? Also, on mweb chrome, the main composer does not hide when we edit a message. |
|
As soon as the above queries are cleared, I will complete the checklist. I have already tested the PR. @tienifr |
|
@tienifr Would love to hear you first? |
|
@parasharrajat I'm checking |
|
@tienifr Anything? |
|
@parasharrajat Here's what I found on Safari
Screen.Recording.2024-09-07.at.21.59.54.mov
Screen.Recording.2024-09-07.at.22.04.21.movThese issues happen even on staging, here's the logic to trigger focus on edit composer and hide main composer but it doesn't work on Safari, I think it's because of the keyboard animation. After using setTimeout likes we already did in android native, it works well App/src/libs/focusTextInputAfterAnimation/index.android.ts Lines 20 to 24 in 7ebfaa0 Screen.Recording.2024-09-07.at.22.08.21.movI'm not sure we should fix it here, since they already happen on staging/main and not really related to this issue. We can create the separate issue and find the deeper RCA |
parasharrajat
left a comment
parasharrajat
left a comment
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
@johnmlee101 Can you take a look at this PR? Thanks |
|
@johnmlee101 friendly bump |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/johnmlee101 in version: 9.0.34-0 🚀
|
|
🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.34-3 🚀
|
5 participants
Details
Composer is not focused on click while editor's emoji modal is still open. This PR fixes that.
Fixed Issues
$ #25892
PROPOSAL: #25892 (comment)
Tests
Web & Desktop
=====
=====
=====
=====
mWeb & Android & iOS
=====
=====
=====
=====
Offline tests
NA
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
web-compressed.mov
web1-compressed.mov
web2-compressed.mov
Mobile Web - Chrome
Screenrecording_20231004_163233.mp4
Screenrecording_20231004_163521.mp4
Mobile Web - Safari
safari-compressed.mov
safari2-compressed.mov
Desktop
desktop-compressed.mov
iOS
ios-compressed.mov
ios2-compressed.mov
Android
android-compressed.mov
android-compressed.mov
android-compressed.mov