Fix canShowHeader logic

janicduplessis commented 2 weeks ago

Details

I noticed that the loading indicator for loading new messages is not displayed.

I traced it back to this commit which refactored the logic to a variable, but incorrectly.

It changed

if (!isOffline && !hasHeaderRendered.current) {

to

const canShowHeader = !isOffline && !hasHeaderRendered.current;
...
if (!canShowHeader) {

The correct change is:

const canShowHeader = isOffline || hasHeaderRendered.current;
...
if (!canShowHeader) {

When testing on iOS I also noticed the scrollingVerticalOffset check was preventing the loading indicator from showing some times. I don't see why it would be needed and didn't seem to introduce any problem when testing loading other chats.

After this the header now shows correctly on 2nd render as the code was meant to do.

Tests

[x] Verify that no errors appear in the JS console
[x] Test comment linking and see that loading newer messages now display a loading indicator

Offline tests

QA Steps

[ ] Verify that no errors appear in the JS console
[ ] Test comment linking and see that loading newer messages now display a loading indicator

Steps to test comment linking:

Go in a long chat and scroll to an old message
Right click and "Copy link"
Go in another chat and paste the link
Clear the cache (Account Settings -> Troubleshoot -> Clear cache and restart)
Go back to the chat with the link and click it
You will be in the middle of a chat and can test loading older / newer messages

PR Author Checklist

[x] I linked the correct issue in the ### Fixed Issues section above
[x] I wrote clear testing steps that cover the changes made in this PR
- [x] I added steps for local testing in the Tests section
- [x] I added steps for the expected offline behavior in the Offline steps section
- [x] I added steps for Staging and/or Production testing in the QA steps section
- [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- [x] 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)
- [x] 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).
[x] I included screenshots or videos for tests on all platforms
[x] I ran the tests on all platforms & verified they passed on:
- [x] Android: Native
- [x] Android: mWeb Chrome
- [x] iOS: Native
- [x] iOS: mWeb Safari
- [x] MacOS: Chrome / Safari
- [x] MacOS: Desktop
[x] 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)
[x] I followed proper code patterns (see Reviewing the code)
- [x] 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)
- [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- [x] I verified that comments were added to code that is not self explanatory
- [x] 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.
- [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - [x] 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:
- [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- [x] 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)
- [x] 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.
- [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
[x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
[x] I followed the guidelines as stated in the Review Guidelines
[x] 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)
[x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
[x] 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
[x] I verified that if a function's arguments changed that all usages have also been updated correctly
[x] If any new file was added I verified that:
- [x] 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
[x] If a new CSS style is added I verified that:
- [x] A similar style doesn't already exist
- [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
[x] 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.
[x] 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)
[x] 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.
[x] 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.
[x] 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:
- [x] I verified that all the inputs inside a form are aligned with each other.
- [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
[x] 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.
[x] 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: mWeb Chrome

iOS: Native

https://github.com/Expensify/App/assets/2677334/1e10e14c-bbee-4d35-b9f6-c42a6b5b16cd

iOS: mWeb Safari

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/2677334/b704385e-891a-4896-a45f-427b417c2da4

MacOS: Desktop

melvin-bot[bot] commented 2 weeks ago

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

janicduplessis commented 2 weeks ago

@perunt Would you be able to confirm this change is ok since you wrote that code initially?

janicduplessis commented 2 weeks ago

I also noticed on iOS there seems to be an issue where newer messages don't load initially unless you scroll back up a little, you can see in the video in the screenshots section. I will investigate that in a follow up.

jayeshmangwani commented 1 week ago

@janicduplessis Is this a follow-up PR of any other PR?

janicduplessis commented 1 week ago

I found the issue while working on https://github.com/Expensify/App/pull/40610, but it is not directly related.

jayeshmangwani commented 1 week ago

@rojiphil This PR is somewhat related to this PR https://github.com/Expensify/App/pull/40610, Would you complete the checklist here, or should I start the review?

rojiphil commented 1 week ago

I traced it back to this commit which refactored the logic to a variable, but incorrectly.

@janicduplessis From the PR description it looks like the root cause lies elsewhere and is unrelated to PR #40610.

rojiphil commented 1 week ago

Would you complete the checklist here, or should I start the review?

@jayeshmangwani Please go ahead if you are available here. I am not sure if I can get to this in the next 2-3 days.

mountiny commented 1 week ago

@jayeshmangwani Please go ahead with this PR

jayeshmangwani commented 1 week ago

On it...

jayeshmangwani commented 1 week ago

@janicduplessis Is there any way to test the Android loader? I have tried with the Steps in the Tests and deep link, but not able to see the Loader for Android native

https://github.com/Expensify/App/assets/35371050/f65307d6-b2ec-4893-a6d6-0a25ab091151

jayeshmangwani commented 1 week ago

Is there any way to test the Android loader? I have tried with the Steps in the Tests and deep link, but not able to see the Loader for Android native

@janicduplessis

mountiny commented 1 week ago

Running a build @janicduplessis are you able to help @jayeshmangwani please?

github-actions[bot] commented 1 week ago

:test_tube::test_tube: Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! :test_tube::test_tube:	Android :robot:	iOS :apple:
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/42332/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/42332/index.html

Desktop :computer:	Web :spider_web:
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/42332/NewExpensify.dmg	https://42332.pr-testing.expensify.com

:eyes: View the workflow run that generated this build :eyes:

janicduplessis commented 1 week ago

@jayeshmangwani The seems to be another issue on mobile where the newer messages are not loading unless you scroll up some. Does it work if you try to scroll up for about 1-2 screens of height then scroll back down?

janicduplessis commented 1 week ago

I will try to look at that issue next.

jayeshmangwani commented 1 week ago

Does it work if you try to scroll up for about 1-2 screens of height then scroll back down?

Now, After trying several times, I am able to show the loader a few times

jayeshmangwani commented 1 week ago

Reviewer Checklist

[x] I have verified the author checklist is complete (all boxes are checked off).
[x] I verified the correct issue is linked in the ### Fixed Issues section above
[x] I verified testing steps are clear and they cover the changes made in this PR
- [x] I verified the steps for local testing are in the Tests section
- [x] I verified the steps for Staging and/or Production testing are in the QA steps section
- [x] 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)
- [x] 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)
[x] I checked that screenshots or videos are included for tests on all platforms
[x] I included screenshots or videos for tests on all platforms
[x] I verified tests pass on all platforms & I tested again on:
- [x] Android: Native
- [x] Android: mWeb Chrome
- [x] iOS: Native
- [x] iOS: mWeb Safari
- [x] MacOS: Chrome / Safari
- [x] MacOS: Desktop
[x] 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
[x] I verified proper code patterns were followed (see Reviewing the code)
- [x] 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).
- [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- [x] I verified that comments were added to code that is not self explanatory
- [x] 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.
- [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- [x] 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)
- [x] 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.
- [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
[x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
[x] I verified that this PR follows the guidelines as stated in the Review Guidelines
[x] 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)
[x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
[x] 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
[x] If a new component is created I verified that:
- [x] A similar component doesn't exist in the codebase
- [x] All props are defined accurately and each prop has a /** comment above it */
- [x] The file is named correctly
- [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- [x] The only data being stored in the state is data necessary for rendering and nothing else
- [x] 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)
- [x] 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)
- [x] All JSX used for rendering exists in the render method
- [x] 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
[x] If any new file was added I verified that:
- [x] 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
[x] If a new CSS style is added I verified that:
- [x] A similar style doesn't already exist
- [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
[x] 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.
[x] 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)
[x] 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.
[x] 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.
[x] 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:
- [x] I verified that all the inputs inside a form are aligned with each other.
- [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
[x] 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.
[x] 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.
[x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/35371050/01394c15-8916-42ae-8790-71b72f339f7e

Android: mWeb Chrome

https://github.com/Expensify/App/assets/35371050/18c41f9c-0446-4c62-8d05-17fcdacaf910

iOS: Native

https://github.com/Expensify/App/assets/35371050/62a708ed-a772-4939-ad9f-33eff72875d1

iOS: mWeb Safari

https://github.com/Expensify/App/assets/35371050/61694ef8-ac82-42dd-a8df-b631070f73f7

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/35371050/dc1e74cc-0890-4be9-92c4-c22af241d981

MacOS: Desktop

https://github.com/Expensify/App/assets/35371050/2577de62-3883-4dd6-896b-c02e0677e35d

jayeshmangwani commented 1 week ago

Code changes looks good, and Tests Well.

NAB: Videos are missing for some platforms

OSBotify commented 4 days ago

:hand: 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 commented 3 days ago

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

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

OSBotify commented 2 days ago

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

OSBotify commented 2 days ago

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

Expensify / App