Migrate ComposerWithSuggestions to useOnyx #51573

blazejkustra · 2024-10-28T15:03:32Z

Details

Initial focus for this PR was to fix performance tests, particularly one case '[ReportActionCompose] press add attachment button'. However during this week another PR was merged in #51461, which removed the above test.

Fixed Issues

$ #51562
PROPOSAL: N/A

Tests

Testing Emoji Suggestions:

Open the chat interface.
Type an emoji trigger, starting with :sm followed by at least two more characters (e.g., :smile).
Verify that the suggestion box appears adjacent to the composer

Testing Mention Suggestions:

Open the chat interface.
Initiate a mention by typing the @ symbol followed by any text (e.g., @username).
Ensure the suggestion box pops up next to the composer

Test Composer overall, select emojis, try different styles (header, code, inline code etc), send message

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

android.webm

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-10-31.at.08.42.19.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-10-31T08:35:31Z

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

rojiphil · 2024-10-31T10:10:12Z

@blazejkustra Thanks for the PR. I will pick this up for review today

rojiphil · 2024-11-01T10:33:01Z

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

MacOS: Chrome / Safari

51573-web-safari-001.mp4

Android: Native

51573-android-native-001.mp4

iOS: mWeb Safari

51573-mweb-safari-001.mp4

Android: mWeb Chrome

51573-mweb-chrome-issue-001.mp4

iOS: Native

51573-ios-native-002.mp4

MacOS: Desktop

51573-desktop-001.mp4

rojiphil · 2024-11-01T11:08:39Z

@blazejkustra The PR tests well on all platforms except on mweb chrome where the app crashes.
However, I do not think this is related to the migration work done here, as this can also be reproduced in the latest main.
Can you please confirm this?

Here are the test videos and the test steps:

Note: This issue is observed in mweb chrome platform.

Reload the app and navigate to a chat.
Enter :sm so that the emoji dialog is displayed.
Press Enter key
Actual Result: The application crashes with message Cannot read properties of undefined
Expected Result: The application should not crash.

This PR

51573-mweb-chrome-issue-002.mp4

Main-v9.0.56-2

9-0-56-2-main-issue.mp4

rojiphil · 2024-11-04T07:21:11Z

Note: This issue is observed in mweb chrome platform.

Reload the app and navigate to a chat.

Enter :sm so that the emoji dialog is displayed.

Press Enter key
Actual Result: The application crashes with message Cannot read properties of undefined
Expected Result: The application should not crash.

As this bug can be reproduced even on the latest main .i.e. 9.0.56-7, I have reported this in the expensify-bugs slack channel here.

blazejkustra · 2024-11-04T11:26:19Z

My sources tell me it should be fixed with Expensify/react-native-live-markdown#531 😄

If it's unrelated to this PR, let's proceed with review @rojiphil

rojiphil · 2024-11-04T12:09:28Z

My sources tell me it should be fixed with Expensify/react-native-live-markdown#531 😄

If it's unrelated to this PR, let's proceed with review @rojiphil

Yeah. Let's proceed since it is fixed elsewhere. Apart from this issue, the code works well. Thanks.

rojiphil

@lakchote Changes LGTM and works well too except for an issue mentioned here. But it is NAB for the migration work done here and is fixed elsewhere.
Over to you for review.

lakchote

Thanks for your work @blazejkustra, and thanks for your thorough review @rojiphil.

LGTM.

OSBotify · 2024-11-04T13:31:15Z

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

github-actions · 2024-11-04T14:38:55Z

🚀 Deployed to staging by https://github.com/lakchote in version: 9.0.57-0 🚀

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

rojiphil · 2024-11-04T17:03:33Z

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

+    const [modal] = useOnyx(ONYXKEYS.MODAL);
+    const [preferredSkinTone = CONST.EMOJI_DEFAULT_SKIN_TONE] = useOnyx(ONYXKEYS.PREFERRED_EMOJI_SKIN_TONE, {selector: EmojiUtils.getPreferredSkinToneIndex});
+    const [editFocused] = useOnyx(ONYXKEYS.INPUT_FOCUSED);
+    const [parentReportActions] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${parentReportID}`, {canEvict: false, initWithStoredValues: false});


@blazejkustra I think we have a blocker issue here if parentReportID is undefined in which case the app will crash. We can reproduce this if we search for a chat with a user for whom there is no report present locally. Here is a screenshot of the crash.

@lakchote Not sure if we can have a fix soon for this. Otherwise we will have to revert the PR as this will be a blocker. Sorry for the inconvenience caused.

github-actions · 2024-11-06T00:02:28Z

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.57-10 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

blazejkustra added 2 commits October 28, 2024 16:03

Migrate ComposerWithSuggestions to useOnyx

89c73cf

Add useCallback to fix perf tests

abf3c5c

blazejkustra mentioned this pull request Oct 29, 2024

[$250] [HOLD for payment 2024-11-13] Fix performance tests failing when migrating to useOnyx() #51562

Closed

blazejkustra added 2 commits October 30, 2024 08:17

Merge branch 'main' into migrate/composerWithSuggestions

5c88609

Merge branch 'main' into migrate/composerWithSuggestions

2d18a69

blazejkustra marked this pull request as ready for review October 31, 2024 08:35

blazejkustra requested a review from a team as a code owner October 31, 2024 08:35

melvin-bot bot requested review from rojiphil and removed request for a team October 31, 2024 08:35

Merge branch 'main' into migrate/composerWithSuggestions

c0635cd

rojiphil approved these changes Nov 4, 2024

View reviewed changes

melvin-bot bot requested a review from lakchote November 4, 2024 12:16

Merge branch 'main' into migrate/composerWithSuggestions

a1201d9

lakchote approved these changes Nov 4, 2024

View reviewed changes

lakchote merged commit ce60790 into Expensify:main Nov 4, 2024
16 checks passed

github-actions bot mentioned this pull request Nov 4, 2024

Deploy Checklist: New Expensify 2024-11-04 #51953

Closed

63 tasks

rojiphil reviewed Nov 4, 2024

View reviewed changes

rojiphil mentioned this pull request Nov 14, 2024

[HOLD for payment 2024-11-14] [HOLD for payment 2024-11-13] [WAIT FOR PAYMENT - 14th November] Room - App crashes after submitting expense to user or creating a new room #51959

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate ComposerWithSuggestions to useOnyx #51573

Migrate ComposerWithSuggestions to useOnyx #51573

blazejkustra commented Oct 28, 2024 •

edited

Loading

melvin-bot bot commented Oct 31, 2024

rojiphil commented Oct 31, 2024

rojiphil commented Nov 1, 2024 •

edited

Loading

rojiphil commented Nov 1, 2024

rojiphil commented Nov 4, 2024

blazejkustra commented Nov 4, 2024

rojiphil commented Nov 4, 2024 •

edited

Loading

rojiphil left a comment

lakchote left a comment

OSBotify commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

rojiphil Nov 4, 2024

github-actions bot commented Nov 6, 2024

Migrate ComposerWithSuggestions to useOnyx #51573

Migrate ComposerWithSuggestions to useOnyx #51573

Conversation

blazejkustra commented Oct 28, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 31, 2024

rojiphil commented Oct 31, 2024

rojiphil commented Nov 1, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

rojiphil commented Nov 1, 2024

rojiphil commented Nov 4, 2024

blazejkustra commented Nov 4, 2024

rojiphil commented Nov 4, 2024 • edited Loading

rojiphil left a comment

Choose a reason for hiding this comment

lakchote left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 4, 2024

github-actions bot commented Nov 4, 2024

rojiphil Nov 4, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 6, 2024

blazejkustra commented Oct 28, 2024 •

edited

Loading

rojiphil commented Nov 1, 2024 •

edited

Loading

rojiphil commented Nov 4, 2024 •

edited

Loading