perf: optimise transition on Desktop when click on start chat #33055

hurali97 · 2023-12-14T11:45:42Z

Details

This fixes the transition lag on Desktop, when user clicks on start chat.

Fixed Issues

$ #28916
PROPOSAL: #28916 (comment)

Tests

Open the desktop app
Click FAB button
Select Send message
Verify that the modal opens smoothly, without any lag or freezes
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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

mWeb-android.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mWeb-ios.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Since we are only using role property from the element, so it sounds better to store only the role property in the hook.

Doing so, re-render won't render the parent Button component

…y-App into hur/perf/desktop-start-chat-transition-lag

hurali97 · 2023-12-15T09:52:34Z

src/hooks/useActiveElementRole/index.js

-export default function useActiveElement() {
-    const [active, setActive] = useState(document.activeElement);
+export default function useActiveElementRole() {
+    const activeRoleRef = useRef(document.activeElement.role);


I have used ref here deliberately, since the role prop is being used to pass to the config in Button and used in BaseSelectionList for disabling enter shortcut.

I have tested it and it looks okay to me, but I will still want to test this thoroughly, so if the reviewer can help me state out the steps on how to test this thoroughly. 👍

melvin-bot · 2023-12-18T08:10:56Z

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

Julesssss

Generating an AdHoc build so we can test a signed build.

OSBotify · 2023-12-18T09:43:52Z

🧪🧪 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/33055/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/33055/index.html

Desktop 💻	Web 🕸️
❌ FAILED ❌	https://33055.pr-testing.expensify.com
The QR code can't be generated, because the Desktop build failed

…y-App into hur/perf/desktop-start-chat-transition-lag

hurali97 · 2023-12-20T10:11:43Z

@Julesssss Can you tell why Desktop build is failing? OR is there a way I can test it on my local? I tried running npm run desktop-build-staging but I get aws keys error probably because I don't have those.

Julesssss · 2023-12-20T10:28:36Z

Desktop build have been failing due to a github Action issue, maybe thats why 🤷 I'll re-run it now

OSBotify · 2023-12-20T10:48:34Z

🧪🧪 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/33055/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/33055/NewExpensify.dmg	https://33055.pr-testing.expensify.com

…y-App into hur/perf/desktop-start-chat-transition-lag

eVoloshchak

There's a bug on all platforms, skeleton UI is shown instead of contacts indefinitely. This is a conflict with latest changes from main, since these builds work correctly

Screen.Recording.2023-12-30.at.19.47.15.mov

hurali97 · 2024-01-02T08:45:22Z

@eVoloshchak is this a bug on this PR or on main already?

eVoloshchak · 2024-01-03T17:45:09Z

@hurali97, only on this PR, main works properly. Also tried applying these changes to the latest main, same result

hurali97 · 2024-01-04T12:39:01Z

@eVoloshchak Thanks, I will take a look at this and probably update by Monday, since we are off tomorrow. Just a quick question, as things stand the transition issue is fixed in this PR but we have this infinite loader issue now?

…y-App into hur/perf/desktop-start-chat-transition-lag

hurali97 · 2024-01-08T07:33:17Z

@eVoloshchak The issue is now fixed.

VE.mp4

eVoloshchak · 2024-01-08T14:44:24Z

@hurali97, awesome, works for me too
Could you resolve the conflicts and I'll proceed with the checklist?
Thanks!

…y-App into hur/perf/desktop-start-chat-transition-lag

eVoloshchak · 2024-01-09T22:31:30Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: Native

Screen.Recording.2024-01-10.at.00.14.13.mov

Android: mWeb Chrome

Screen.Recording.2024-01-09.at.23.33.38.mov

iOS: Native

Screen.Recording.2024-01-09.at.23.36.59.mov

iOS: mWeb Safari

Screen.Recording.2024-01-09.at.23.35.36.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-09.at.23.32.42.mov

MacOS: Desktop

Screen.Recording.2024-01-09.at.23.41.30.mov

eVoloshchak · 2024-01-09T22:47:56Z

@hurali97, looking good, but missing test steps for the QA

Open the desktop app
Click FAB button
Select Send message
Verify that the modal opens smoothly, without any lag or freezes

…y-App into hur/perf/desktop-start-chat-transition-lag

eVoloshchak

LGTM!

OSBotify · 2024-01-10T16:12:44Z

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

situchan · 2024-01-11T04:56:40Z

src/components/Button/index.tsx

+            [shouldDisableEnterShortcut],
+        );
+
+        useKeyboardShortcut(CONST.KEYBOARD_SHORTCUTS.ENTER, keyboardShortcutCallback, config);


Seems like regression came from this change.
Let's try to fix this before being deploy blocker.

@situchan PR created here. Will be ready for review shortly 👍

ok, app deployed already and now this is deploy blocker.
I can do quick review if needed.
cc: @Julesssss

OSBotify · 2024-01-11T09:58:43Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.24-4 🚀

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

OSBotify · 2024-01-15T11:40:03Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.24-8 🚀

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

hurali97 added 4 commits December 14, 2023 16:17

refactor: change to useActiveElementRole

1bb1b1e

Since we are only using role property from the element, so it sounds better to store only the role property in the hook.

refactor: separate logic for keyboard shortcut in a leaf component

f526678

Doing so, re-render won't render the parent Button component

perf: update the options once screen transition is finished

c3507cc

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

69daf4d

…y-App into hur/perf/desktop-start-chat-transition-lag

hurali97 commented Dec 15, 2023

View reviewed changes

hurali97 marked this pull request as ready for review December 18, 2023 08:10

hurali97 requested a review from a team as a code owner December 18, 2023 08:10

melvin-bot bot requested review from eVoloshchak and removed request for a team December 18, 2023 08:10

Julesssss assigned hurali97 Dec 18, 2023

Julesssss reviewed Dec 18, 2023

View reviewed changes

Julesssss added the Ready To Build label Dec 18, 2023

hurali97 added 2 commits December 19, 2023 13:36

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

5db0c22

…y-App into hur/perf/desktop-start-chat-transition-lag

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

23800dc

…y-App into hur/perf/desktop-start-chat-transition-lag

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

50f8558

…y-App into hur/perf/desktop-start-chat-transition-lag

eVoloshchak suggested changes Dec 30, 2023

View reviewed changes

Julesssss mentioned this pull request Jan 4, 2024

[HOLD for payment 2024-01-22] [$1000] Desktop - FAB - Modal for 'Send Message' freezes when opened #28916

Closed

6 tasks

hurali97 added 2 commits January 4, 2024 18:07

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

1520de2

…y-App into hur/perf/desktop-start-chat-transition-lag

fix: infinite skeleton loader

29c796e

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

f912b63

…y-App into hur/perf/desktop-start-chat-transition-lag

Merge branch 'main' of https://github.com/callstack-internal/Expensif…

3ee3afa

…y-App into hur/perf/desktop-start-chat-transition-lag

eVoloshchak approved these changes Jan 10, 2024

View reviewed changes

melvin-bot bot requested a review from Julesssss January 10, 2024 15:52

Julesssss approved these changes Jan 10, 2024

View reviewed changes

Julesssss merged commit 5a3bc6e into Expensify:main Jan 10, 2024

bernhardoj mentioned this pull request Jan 11, 2024

[$125] Request money - The 'Enter' key fails to select the email/workspace/phone when requesting money. #34239

Closed

6 tasks

situchan reviewed Jan 11, 2024

View reviewed changes

hurali97 mentioned this pull request Jan 11, 2024

fix: enter key not working #34313

Merged

50 tasks

github-actions bot mentioned this pull request Jan 11, 2024

Deploy Checklist: New Expensify 2024-01-11 #34327

Closed

54 tasks

lanitochka17 mentioned this pull request Jan 11, 2024

[HOLD for payment 2024-01-24] [HOLD for payment 2024-01-22] FAB - Skeleton appears first on Start chat page #34371

Closed

6 tasks

bernhardoj mentioned this pull request Jan 13, 2024

[$500] Error shows up whenever tried to go back using keyboard #34474

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

perf: optimise transition on Desktop when click on start chat #33055

perf: optimise transition on Desktop when click on start chat #33055

hurali97 commented Dec 14, 2023 •

edited

Loading

hurali97 Dec 15, 2023

melvin-bot bot commented Dec 18, 2023

Julesssss left a comment

OSBotify commented Dec 18, 2023

hurali97 commented Dec 20, 2023

Julesssss commented Dec 20, 2023

OSBotify commented Dec 20, 2023

eVoloshchak left a comment

hurali97 commented Jan 2, 2024

eVoloshchak commented Jan 3, 2024

hurali97 commented Jan 4, 2024

hurali97 commented Jan 8, 2024

eVoloshchak commented Jan 8, 2024

eVoloshchak commented Jan 9, 2024 •

edited

Loading

eVoloshchak commented Jan 9, 2024

eVoloshchak left a comment

OSBotify commented Jan 10, 2024

situchan Jan 11, 2024

hurali97 Jan 11, 2024

situchan Jan 11, 2024

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

perf: optimise transition on Desktop when click on start chat #33055

perf: optimise transition on Desktop when click on start chat #33055

Conversation

hurali97 commented Dec 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hurali97 Dec 15, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Dec 18, 2023

Julesssss left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 18, 2023

hurali97 commented Dec 20, 2023

Julesssss commented Dec 20, 2023

OSBotify commented Dec 20, 2023

eVoloshchak left a comment

Choose a reason for hiding this comment

hurali97 commented Jan 2, 2024

eVoloshchak commented Jan 3, 2024

hurali97 commented Jan 4, 2024

hurali97 commented Jan 8, 2024

eVoloshchak commented Jan 8, 2024

eVoloshchak commented Jan 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eVoloshchak commented Jan 9, 2024

eVoloshchak left a comment

Choose a reason for hiding this comment

OSBotify commented Jan 10, 2024

situchan Jan 11, 2024

Choose a reason for hiding this comment

hurali97 Jan 11, 2024

Choose a reason for hiding this comment

situchan Jan 11, 2024

Choose a reason for hiding this comment

OSBotify commented Jan 11, 2024

OSBotify commented Jan 15, 2024

hurali97 commented Dec 14, 2023 •

edited

Loading

eVoloshchak commented Jan 9, 2024 •

edited

Loading