perf: optimise composer send behaviour

[hurali97]

Details

This fixes major things wrong with ReportScreen and it's children, ReportActionCompose and ComposerWithSuggestions. The highlight is the personalDetails prop from onyx as on high traffic accounts personalDetails becomes a huge object and is expensive to pass as a prop and have the component render/ re-render. So each time a message is sent, we are manipulating onyx for the report_, reportActions_ and personalDetails keys first with the optimistic data and then with the successful data. Most of the ReportScreen and it's children doesn't really need personalDetails as a prop from onyx as they are passing that prop to certain utility functions to calculate for example, icon. So this personalDetails prop can be removed and we can use directly from the utility as we have Onyx.connect already present in the utility files.

Apart from this, some props including report and reportActions have been simplified to become lightweight so that the can be passed easily down to the children. Previously, we were passing the whole object and it had properties that we don't need. Also, to prevent unnecessary re-rendering of ReportActionCompose the empty state is lifted and moved to ReportActionCompose alongside the SendButton and EmojiButton. Also, sortedReportActions aren't really needed to pass to ReportActionsListItemRenderer as it uses the prop to only evaluate whether it's a group or not. So we have passed a new prop displayAsGroup to the component directly instead of passing the whole actions array.

Fixed Issues

$ #26347
PROPOSAL: #26347 (comment)

Tests

Testing Steps:

• Open a Report and focus the composer

• Start typing some letters and then hit send

• Once the message is sent, start typing again and then press send

• No message should be present in the composer and the behaviour should feel smooth

• Verify that no errors appear in the JS console

Offline tests

QA Steps

• 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: mWeb Chrome
  • iOS: Native
  • iOS: mWeb 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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 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 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

Android: Native

android-recording.mov

Android: mWeb Chrome

android-web-recording.mov

iOS: Native

ios-recording.mp4

iOS: mWeb Safari

ios-web-recording.mp4

MacOS: Chrome / Safari

web-recording.mov

MacOS: Desktop

desktop-recording.mov

[melvin-bot]

@aimane-chnaif 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]

[aimane-chnaif]

@hurali97 please fix conflict

[hurali97]

Figuring out why Reassure tests are failing and will update the PR accordingly.

[hurali97]

@aimane-chnaif All green now !

[aimane-chnaif]

As it's failing on main, someone will fix urgently so let's wait

[aimane-chnaif]

@hurali97 please pull main. It's fixed now

[aimane-chnaif]

        return (
            <ReportActionItemCreated
                reportID={props.report.reportID}
                policyID={props.report.policyID}
+               personalDetails={personalDetails}
            />
        );

Can we apply this change in ReportActionItem.js to fix this issue?
prevProps.personalDetails === nextProps.personalDetails, also needs added in ReportActionItemCreated memo

Screen.Recording.2024-01-30.at.3.21.41.PM.mov

Screen.Recording.2024-01-30.at.3.07.50.PM.mov

[aimane-chnaif]

iOS app crashes on composer Send button click. Seems like recent regression after recent merge

Screen.Recording.2024-01-30.at.3.34.44.PM.mov

[hurali97]

@aimane-chnaif Thanks for doing a regression. I have fixed these issues now 👍

[github-actions]

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/30168/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/30168/index.html
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/30168/NewExpensify.dmg	https://30168.pr-testing.expensify.com

---

👀 View the workflow run that generated this build 👀

[aimane-chnaif]

Seems like auto-focus composer when switch chat is broken on staging web. Works fine on production. Deploy blocker maybe?

(for future reference: staging - v1.4.34-0, production - v1.4.33-5)

Screen.Recording.2024-01-31.at.12.03.58.PM.mov

[aimane-chnaif]

I think we can now merge this as no bugs found at this moment from our side.
But still be on a look out for any regressions QA is reporting since this is big refactor.

[mountiny]

Let's go then, code looks good to me, this was a massive effort, thanks everyone!

[mountiny]

Let's go then, code looks good to me, this was a massive effort, thanks everyone!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.35-0 🚀

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

[rlinoz]

I believe this PR caused this regression: #35559

[aimane-chnaif]

@hurali97 Not sure this was mentioned before but why keys here are inconsistent with useMemo here?

App/src/pages/home/ReportScreen.js

Lines 173 to 203 in 9ab4fe9

	const report = useMemo(
	() => ({
	lastReadTime: reportProp.lastReadTime,
	reportID: reportProp.reportID,
	policyID: reportProp.policyID,
	lastVisibleActionCreated: reportProp.lastVisibleActionCreated,
	statusNum: reportProp.statusNum,
	stateNum: reportProp.stateNum,
	writeCapability: reportProp.writeCapability,
	type: reportProp.type,
	errorFields: reportProp.errorFields,
	isPolicyExpenseChat: reportProp.isPolicyExpenseChat,
	parentReportID: reportProp.parentReportID,
	parentReportActionID: reportProp.parentReportActionID,
	chatType: reportProp.chatType,
	pendingFields: reportProp.pendingFields,
	isDeletedParentAction: reportProp.isDeletedParentAction,
	reportName: reportProp.reportName,
	description: reportProp.description,
	managerID: reportProp.managerID,
	total: reportProp.total,
	nonReimbursableTotal: reportProp.nonReimbursableTotal,
	reportFields: reportProp.reportFields,
	ownerAccountID: reportProp.ownerAccountID,
	currency: reportProp.currency,
	participantAccountIDs: reportProp.participantAccountIDs,
	isWaitingOnBankAccount: reportProp.isWaitingOnBankAccount,
	iouReportID: reportProp.iouReportID,
	isOwnPolicyExpenseChat: reportProp.isOwnPolicyExpenseChat,
	notificationPreference: reportProp.notificationPreference,
	}),

App/src/pages/home/ReportScreen.js

Lines 645 to 661 in 9ab4fe9

	memo(
	ReportScreen,
	(prevProps, nextProps) =>
	prevProps.isSidebarLoaded === nextProps.isSidebarLoaded &&
	_.isEqual(prevProps.reportActions, nextProps.reportActions) &&
	_.isEqual(prevProps.reportMetadata, nextProps.reportMetadata) &&
	prevProps.isComposerFullSize === nextProps.isComposerFullSize &&
	_.isEqual(prevProps.betas, nextProps.betas) &&
	_.isEqual(prevProps.policies, nextProps.policies) &&
	prevProps.accountManagerReportID === nextProps.accountManagerReportID &&
	prevProps.userLeavingStatus === nextProps.userLeavingStatus &&
	prevProps.report.reportID === nextProps.report.reportID &&
	prevProps.report.policyID === nextProps.report.policyID &&
	prevProps.report.isOptimisticReport === nextProps.report.isOptimisticReport &&
	prevProps.report.statusNum === nextProps.report.statusNum &&
	_.isEqual(prevProps.report.pendingFields, nextProps.report.pendingFields) &&
	prevProps.currentReportID === nextProps.currentReportID,

notificationPreference is good example. It's added in useMemo but not in memo. This caused #35562

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.35-7 🚀

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

[tgolen]

Is this referenced somehere? I can't find it anywhere.

[mountiny]

Ah that would be for threads, it would have to be used for that little element showing how many replies are in thread, who responded, right?