Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the issue of RHP not opening smoothly #48143

Conversation

wildan-m
Copy link
Contributor

@wildan-m wildan-m commented Aug 28, 2024

Details

Fix the issue of RHP not opening smoothly after selecting any option in room details.

Fixed Issues

$ #44812
PROPOSAL: #44812 (comment)

Tests

Non Desktop

  1. Log out ND if user is logged in
  2. Navigate to a public room, e.g. https://staging.new.expensify.com/r/4865807136424891
  3. Tap the header to open the details
  4. Select any option
  • Verify that no errors appear in the JS console

Desktop

  1. Log out ND if user is logged in
  2. In OS menu, Click View > Toggle Developer Tools
  3. In Console tab, execute window.location.href = '/r/4865807136424891'
  4. Navigate to a public room, e.g. https://staging.new.expensify.com/r/4865807136424891
  5. Tap the header to open the details
  6. Select any option
  • Verify that no errors appear in the JS console

Offline tests

Same as test

QA Steps

Same as test

  • 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 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 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 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.

Screenshots/Videos

Android: Native
WhatsApp.Video.2024-08-28.at.13.03.21.mp4
Android: mWeb Chrome
Kapture.2024-08-29.at.09.35.18.mp4
iOS: Native
Kapture.2024-08-28.at.10.23.28.mp4
iOS: mWeb Safari
Kapture.2024-08-28.at.13.11.38.mp4
MacOS: Chrome / Safari
Kapture.2024-08-28.at.13.15.07.mp4
MacOS: Desktop
Kapture.2024-08-29.at.09.25.41.mp4

@wildan-m wildan-m requested a review from a team as a code owner August 28, 2024 06:38
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team August 28, 2024 06:38
Copy link

melvin-bot bot commented Aug 28, 2024

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

@wildan-m wildan-m changed the title Wildan/fix/44812 react navigation lottie transition Fix the issue of RHP not opening smoothly Aug 28, 2024
@sobitneupane
Copy link
Contributor

@wildan-m There is some jitter/lag on other platforms as well. Can we apply the change you suggested in the issue to other platforms as well?

@wildan-m
Copy link
Contributor Author

@sobitneupane The optimization has been implemented across all platforms. Is there ever a scenario where we wouldn't need it? Should we include the shouldLoadAfterInteraction prop?

@wildan-m
Copy link
Contributor Author

wildan-m commented Sep 3, 2024

@sobitneupane bump #48143 (comment)

@sobitneupane
Copy link
Contributor

Is there ever a scenario where we wouldn't need it?

I am not sure if there is any. Let's make sure to test it extensively.

Should we include the shouldLoadAfterInteraction prop?

Sorry. I didn't get you. Is it an existing prop? I would require more context.

@wildan-m
Copy link
Contributor Author

wildan-m commented Sep 4, 2024

@sobitneupane, shouldLoadAfterInteraction is a new prop introduced as a feature flag for this PR.

I’ve noticed that the delay is quite noticeable on desktop especially the background image. Should we consider enabling this feature only for small screens, as larger devices tend to have better responsiveness?

@sobitneupane
Copy link
Contributor

I’ve noticed that the delay is quite noticeable on desktop especially the background image. Should we consider enabling this feature only for small screens, as larger devices tend to have better responsiveness?

@wildan-m Can you please upload videos for each case?

@sobitneupane
Copy link
Contributor

shouldLoadAfterInteraction is a new prop introduced as a feature flag for this PR.

So, Are you saying that, in addition to the current change, we will be passing the shouldLoadAfterInteraction prop to LottieView and Image to let those components know if the interaction is complete?

@wildan-m
Copy link
Contributor Author

wildan-m commented Sep 5, 2024

@sobitneupane this is before and after video, is this delay differences acceptable?

Before After
Kapture.2024-09-05.at.13.06.18.mp4
Kapture.2024-09-05.at.13.04.30.mp4

@sobitneupane
Copy link
Contributor

sobitneupane commented Sep 6, 2024

@wildan-m Can we limit the change made in this PR to RHP only? The issue occurs on RHP. So, if it is possible to limit the change in RHP(and small screen), we should be good.

@wildan-m
Copy link
Contributor Author

wildan-m commented Sep 6, 2024

@sobitneupane do you know existing function to detect if a page opened in RHP ? passing shouldLoadAssetAfterInteraction props will modify too many child components of SignInModal

@wildan-m
Copy link
Contributor Author

wildan-m commented Sep 6, 2024

@sobitneupane signinpagemodal identify RHP by anonimity

if (!isAnonymousUser) {
// Signing in RHP is only for anonymous users
Navigation.isNavigationReady().then(() => Navigation.dismissModal());
App.openApp();
}

Should we do the same for lottie and bg image?

@wildan-m
Copy link
Contributor Author

wildan-m commented Sep 6, 2024

@sobitneupane the PR has been updated

const aspectRatioStyle = styles.aspectRatioLottie(source);

// If the image fails to load, app is in background state, animation file isn't ready, or the splash screen isn't hidden yet,
// we'll just render an empty view as the fallback to prevent
// 1. memory leak, see issue: https://github.com/Expensify/App/issues/36645
// 2. heavy rendering, see issue: https://github.com/Expensify/App/issues/34696
if (isError || appState.isBackground || !animationFile || splashScreenState !== CONST.BOOT_SPLASH_STATE.HIDDEN) {
// 3. lag on react navigation transitions, see issue: https://github.com/Expensify/App/issues/44812
if (isError || appState.isBackground || !animationFile || splashScreenState !== CONST.BOOT_SPLASH_STATE.HIDDEN || (!isInteractionComplete && isLastRouteInRHP && isSmallScreenWidth)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wildan-m I believe we are applying the change to larger screen as well. So, should we get rid of isSmallScreenWidth from the condition. Please let me know if I am missing something.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sobitneupane my isLastRouteInRHP function does not cover current screen, it will be false if the prev screen is not in RHP, i.e. call sign in page from sign in button. I thought that isSmallScreenWidth might still needed.

Kapture.2024-09-09.at.21.02.59.mp4

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are your thoughts on using isAnonymous?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sobitneupane I believe just using navigationRef?.isReady() is enough. When loading through a direct link, it's always false, but when the sign-in page modal comes from other screens, it's always true. What's your opinion?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wildan-m It should be fine using isAnonymous if the issue is existent only for anonymous user even is small screen devices. I am not sure about navigationRef?.isReady().

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sobitneupane Do you know if there are any other anonymously loaded lottie files besides Hands.lottie? I will create a shouldLoadAfterInteraction for the Lottie component to prevent the code from affecting other Lottie assets. Let me know if you have any objections.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sobitneupane the code has been updated

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots/Videos

Android: Native
Screen.Recording.2024-09-12.at.17.44.36.mov
iOS: Native
Screen.Recording.2024-09-12.at.17.35.07.mov
iOS: mWeb Safari
Screen.Recording.2024-09-12.at.17.27.41.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-12.at.17.23.07.mov
MacOS: Desktop
Screen.Recording.2024-09-12.at.17.41.53.mov

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@melvin-bot melvin-bot bot requested a review from nkuoch September 12, 2024 12:21
@nkuoch nkuoch merged commit 37161bc into Expensify:main Sep 12, 2024
16 of 18 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/nkuoch in version: 9.0.34-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.0.34-3 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants