Migrate ReportActionCompose to function #18648

stas-kravchuk · 2023-05-09T16:02:16Z

Details

Refactoring the ReportActionCompose.js component from class to functional one.

Fixed Issues

$ #16263

Tests

Write and send a message
Insert emoji from emoji picker in empty input
Type some message and try to insert emoji into different places where the cursor is placed (with different selections)
Insert emoji with emoji suggestion (with : )
Type huge text to test composer size change with different amounts of lines
Add/send an attachment
Verify that the focus on the text input is being saved after the attachment modal is open, emoji picker is open, the message sending, etc
Click on the arrows button to see the composer in expand/collapsed view (full size mode)
Add mention, send message with mention

Offline tests

None needed.

QA Steps

Same as in "Tests"

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…ction component

…dependencies

…Callback with use memo, fix bug with emoji show only after 3 symbols

…ompose (replace class file with function one)

…gic, add few TODO comment, remove dev file ReportActionComposeF

github-actions · 2023-05-09T16:02:30Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

roryabraham · 2023-05-22T19:08:43Z

src/pages/home/report/ReportActionCompose.js

+            </OfflineWithFeedback>
+            {isDraggingOver && <ReportDropUI />}
+            {!_.isEmpty(suggestionValues.suggestedEmojis) && suggestionValues.shouldShowEmojiSuggestionMenu && (
+                <ArrowKeyFocusManager


We added a useArrowKeyFocusManager hook, let's use that instead. It's a bit simpler.

…pose-to-function

roryabraham · 2023-08-17T18:23:39Z

Can't merge due to unsigned commits

situchan · 2023-08-17T18:30:52Z

Seems last 2 commits should be reverted and force push with signed commit

cc: @Szymon20000

Co-authored-by: Situ Chandra Shil <108292595+situchan@users.noreply.github.com>

situchan · 2023-08-18T15:00:04Z

@Szymon20000 please fix conflict. Apply changes from #24512

mountiny · 2023-08-18T15:01:03Z

@situchan I dont see conflicts on GH

situchan · 2023-08-18T15:02:18Z

There should be conflict since #24512 was merged

mountiny · 2023-08-18T15:20:02Z

Oh interesting its not showing the specifc files, I can see it now

…migrate-reportactioncompose-to-function

OSBotify · 2023-08-18T18:33:47Z

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

ginsuma · 2023-08-21T16:46:14Z

This hook should be divided into two hooks.

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

Lines 948 to 980 in dd50e91

    
           useEffect(() => { 
        
               const unsubscribeNavigationBlur = navigation.addListener('blur', () => KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress)); 
        
               const unsubscribeNavigationFocus = navigation.addListener('focus', () => { 
        
                   KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress); 
        
                   setUpComposeFocusManager(); 
        
               }); 
        
               KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress); 
        
               setUpComposeFocusManager(); 
        
               updateComment(commentRef.current); 
        
               // Shows Popover Menu on Workspace Chat at first sign-in 
        
               if (!disabled) { 
        
                   Welcome.show({ 
        
                       routes: lodashGet(navigation.getState(), 'routes', []), 
        
                       showPopoverMenu, 
        
                   }); 
        
               } 
        
               if (comment.length !== 0) { 
        
                   Report.setReportWithDraft(reportID, true); 
        
               } 
        
               return () => { 
        
                   ReportActionComposeFocusManager.clear(); 
        
                   KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress); 
        
                   unsubscribeNavigationBlur(); 
        
                   unsubscribeNavigationFocus(); 
        
               }; 
        
               // eslint-disable-next-line react-hooks/exhaustive-deps 
        
           }, []);

One hook has focusComposerOnKeyPress as a dependency.

useEffect(() => {
    const unsubscribeNavigationBlur = navigation.addListener('blur', () => KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress));
    const unsubscribeNavigationFocus = navigation.addListener('focus', () => {
        KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress);
        setUpComposeFocusManager();
    });
    KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress);

    return () => {
        KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress);
        unsubscribeNavigationBlur();
        unsubscribeNavigationFocus();
    };
    // eslint-disable-next-line react-hooks/exhaustive-deps
}, [focusComposerOnKeyPress]);

Because we used useCallback for focusComposerOnKeyPress, so we need to update the listeners whenfocusComposerOnKeyPress changes. Currently, we get a regression:

Open RHP by direct link.
Close RHP.
Blur the main composer.
Press the keys.

Expected result: the main composer focuses and receives the keys.
cc: @stas-kravchuk @situchan @roryabraham

OSBotify · 2023-08-21T22:24:10Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.56-0 🚀

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

OSBotify · 2023-08-24T03:07:11Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

chrispader · 2023-08-30T13:00:43Z

This hook should be divided into two hooks.

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

Lines 948 to 980 in dd50e91

useEffect(() => {

const unsubscribeNavigationBlur = navigation.addListener('blur', () => KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress));

const unsubscribeNavigationFocus = navigation.addListener('focus', () => {

KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress);

setUpComposeFocusManager();

});

KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress);

setUpComposeFocusManager();

updateComment(commentRef.current);

// Shows Popover Menu on Workspace Chat at first sign-in

if (!disabled) {

Welcome.show({

routes: lodashGet(navigation.getState(), 'routes', []),

showPopoverMenu,

});

}

if (comment.length !== 0) {

Report.setReportWithDraft(reportID, true);

}

return () => {

ReportActionComposeFocusManager.clear();

KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress);

unsubscribeNavigationBlur();

unsubscribeNavigationFocus();

};

// eslint-disable-next-line react-hooks/exhaustive-deps

}, []);

One hook has focusComposerOnKeyPress as a dependency.
useEffect(() => {
    const unsubscribeNavigationBlur = navigation.addListener('blur', () => KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress));
    const unsubscribeNavigationFocus = navigation.addListener('focus', () => {
        KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress);
        setUpComposeFocusManager();
    });
    KeyDownListener.addKeyDownPressListner(focusComposerOnKeyPress);

    return () => {
        KeyDownListener.removeKeyDownPressListner(focusComposerOnKeyPress);
        unsubscribeNavigationBlur();
        unsubscribeNavigationFocus();
    };
    // eslint-disable-next-line react-hooks/exhaustive-deps
}, [focusComposerOnKeyPress]);
Because we used useCallback for focusComposerOnKeyPress, so we need to update the listeners whenfocusComposerOnKeyPress changes. Currently, we get a regression:

Open RHP by direct link.

Close RHP.

Blur the main composer.

Press the keys.

Expected result: the main composer focuses and receives the keys. cc: @stas-kravchuk @situchan @roryabraham

Hey @ginsuma !

This section of code got moved to ComposerWithSuggestions.js here.

What do you mean about needing to split this hook into two? The useEffect has focusComposerOnKeyPress as a dependency, which means the effect will trigger, whenever it changes. navigation and setUpComposeFocusManager are also in the dependency array, as those are used too.

Isn't that what we want here?

roryabraham · 2023-09-01T16:17:31Z

Not sure – @ginsuma can you please report the problem in #expensify-bugs?

ginsuma · 2023-09-01T16:19:31Z

This is outdated now. The problem was two weeks ago, and we fixed it in ComposerWithSuggestions
cc: @chrispader @roryabraham

parasharrajat · 2023-09-08T11:00:18Z

src/pages/home/report/ReportActionCompose.js

+
+    const onSelectionChange = useCallback(
+        (e) => {
+            LayoutAnimation.configureNext(LayoutAnimation.create(50, LayoutAnimation.Types.easeInEaseOut, LayoutAnimation.Properties.opacity));


This can mess with animations. This might have been worked on this PR to solve the emoji picker freeze bug but later on, the same bug popped back. #21540

As soon as Reanimated 3.5.0 lands we should start using Reanimated for LayoutAnimations going forward

Ollyws · 2023-10-10T12:07:00Z

src/pages/home/report/ReportActionCompose.js

+            setIsCommentEmpty(!!newComment.match(/^(\s)*$/));
+            setValue(newComment);
+            if (commentValue !== newComment) {
+                const remainder = ComposerUtils.getCommonSuffixLength(commentRef.current, newComment);


Changing this argument to commentRef.current caused an issue with the cursor position when pasting emojis, we reverted this to it's originally intended value commentValue in #28310

stas-kravchuk added 6 commits May 9, 2023 18:32

refactor: in-progress - migrate ReportActionCompose from class to fun…

f846039

…ction component

refactor: in-progress - add few comments, minor changes in callbacks …

fc5bab7

…dependencies

refactor: WIP - move few functions out of component, replace some use…

0711917

…Callback with use memo, fix bug with emoji show only after 3 symbols

refactor: WIP - move code from ReportActionComposeF to ReportAction c…

c116987

…ompose (replace class file with function one)

refactor: WIP - remove prevProps useref - replace it with useffect lo…

25707c5

…gic, add few TODO comment, remove dev file ReportActionComposeF

refactor: rewrite few const and callback to useMemo

6225871

stas-kravchuk added 2 commits May 10, 2023 15:59

merge main into branch

8e51311

refactor: prettier changes, moved onDrop event to separate useCallback

df2c91a

stas-kravchuk mentioned this pull request May 10, 2023

[$1000] Migrate ReportActionCompose.js to function component #16263

Closed

1 task

stas-kravchuk added 7 commits May 11, 2023 17:32

merge main into branch

56d8f98

merge main into branch

57cec6a

fix: return personalDetails onyx prop after merge conflict fix

d4812a9

fix: fix bug with ENTER press when suggestions exist, prettier style fix

bc662c0

merge main into branch

83c3339

refactor: change isEmptyChat to useMemo from useCallback

fcc9b09

merge main into branch

5fba379

roryabraham reviewed May 22, 2023

View reviewed changes

Christoph Pader added 7 commits May 25, 2023 14:43

Merge branch 'main' into @stas-kravchuk/16263-migrate-reportactioncom…

c974548

…pose-to-function

Merge branch 'main' into @stas-kravchuk/16263-migrate-reportactioncom…

fde9665

…pose-to-function

fix: import

d7ad673

use "useKeyboardShortcut" instead of manually subscribing

fd5fdf9

simplify arrow key handling

5a66c1e

Merge branch 'main' into @stas-kravchuk/16263-migrate-reportactioncom…

f819841

…pose-to-function

fix: 2 minor issues

72c6834

stas-kravchuk changed the title ~~[WIP] Migrate ReportActionCompose to function~~ Migrate ReportActionCompose to function Jun 2, 2023

stas-kravchuk marked this pull request as ready for review June 2, 2023 07:49

stas-kravchuk requested a review from a team as a code owner June 2, 2023 07:49

melvin-bot bot requested review from 0xmiros and removed request for a team June 2, 2023 07:49

Szymon Kapała and others added 2 commits August 18, 2023 15:10

prettier signed

6c40eb1

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

af0ea24

Co-authored-by: Situ Chandra Shil <108292595+situchan@users.noreply.github.com>

Szymon20000 force-pushed the @stas-kravchuk/16263-migrate-reportactioncompose-to-function branch from a10c273 to af0ea24 Compare August 18, 2023 13:10

Merge remote-tracking branch 'origin/main' into @stas-kravchuk/16263-…

d32859c

…migrate-reportactioncompose-to-function

Szymon20000 dismissed roryabraham’s stale review via d32859c August 18, 2023 16:28

Szymon20000 added 3 commits August 18, 2023 18:29

linting

0fd1d9d

linting

db53793

linting 3

cea152b

roryabraham approved these changes Aug 18, 2023

View reviewed changes

roryabraham merged commit 7cbd602 into Expensify:main Aug 18, 2023
11 checks passed

ginsuma mentioned this pull request Aug 21, 2023

[HOLD for payment 2023-09-20] [$1000] Web - User can use the composer and chat while the RHP is open #23403

Closed

6 tasks

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

hungvu193 mentioned this pull request Aug 22, 2023

[HOLD for payment 2023-09-27] [HOLD for payment 2023-09-06] [$1000] Mention list doesnt automatically popup when typing @ #25649

Closed

6 tasks

parasharrajat reviewed Sep 8, 2023

View reviewed changes

parasharrajat mentioned this pull request Sep 8, 2023

[HOLD for payment 2023-09-06] [$2000] IOS - Application Not Responding after adding built-in emoji from Keyboard and NewDot #21540

Closed

6 tasks

Ollyws mentioned this pull request Sep 26, 2023

[HOLD for payment 2023-10-09] [$500] Web - Pasting emojis freezes cursor position in composer box (works fine in edit message) #27672

Closed

6 tasks

Ollyws reviewed Oct 10, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate ReportActionCompose to function #18648

Migrate ReportActionCompose to function #18648

stas-kravchuk commented May 9, 2023 •

edited

Loading

github-actions bot commented May 9, 2023 •

edited

Loading

roryabraham May 22, 2023

roryabraham commented Aug 17, 2023

situchan commented Aug 17, 2023

situchan commented Aug 18, 2023

mountiny commented Aug 18, 2023

situchan commented Aug 18, 2023

mountiny commented Aug 18, 2023

OSBotify commented Aug 18, 2023

ginsuma commented Aug 21, 2023 •

edited

Loading

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

chrispader commented Aug 30, 2023

roryabraham commented Sep 1, 2023

ginsuma commented Sep 1, 2023

parasharrajat Sep 8, 2023 •

edited

Loading

roryabraham Sep 11, 2023

Ollyws Oct 10, 2023

Migrate ReportActionCompose to function #18648

Migrate ReportActionCompose to function #18648

Conversation

stas-kravchuk commented May 9, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented May 9, 2023 • edited Loading

roryabraham May 22, 2023

Choose a reason for hiding this comment

roryabraham commented Aug 17, 2023

situchan commented Aug 17, 2023

situchan commented Aug 18, 2023

mountiny commented Aug 18, 2023

situchan commented Aug 18, 2023

mountiny commented Aug 18, 2023

OSBotify commented Aug 18, 2023

ginsuma commented Aug 21, 2023 • edited Loading

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

chrispader commented Aug 30, 2023

roryabraham commented Sep 1, 2023

ginsuma commented Sep 1, 2023

parasharrajat Sep 8, 2023 • edited Loading

Choose a reason for hiding this comment

roryabraham Sep 11, 2023

Choose a reason for hiding this comment

Ollyws Oct 10, 2023

Choose a reason for hiding this comment

stas-kravchuk commented May 9, 2023 •

edited

Loading

github-actions bot commented May 9, 2023 •

edited

Loading

ginsuma commented Aug 21, 2023 •

edited

Loading

parasharrajat Sep 8, 2023 •

edited

Loading