fix: Reports empty state is blank briefly #59711

nkdengineer · 2025-04-06T18:42:46Z

Explanation of Change

Fixed Issues

$ #59097
#59623
PROPOSAL:

Tests

Go to the Reports tab.
Search for something that does not exist and observe the empty state animation.
Navigate to a different tab, e.g., Settings.
Go back to Search using the Back button.
The empty state animation should be displayed.
Go to Reports.
Go to any status that will return empty state (or perform a search that will return no result).
Tap filters icon.
Swipe back using iOS gesture (not app back button).
Verify that: Reports empty state will not be blank after returning from filters and after renaming the saved search.

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-04-06T18:44:55Z

@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 · 2025-04-10T12:29:17Z

@nkdengineer Please fix the prettier. Also, please check if the performance issue is due to our PR. Thanks

nkdengineer · 2025-04-10T17:35:37Z

@rojiphil i fixed

rojiphil · 2025-04-10T17:42:52Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

59711-web-chrome-001.mp4

MacOS: Desktop

59711-desktop-001.mp4

Android: Native

59711-android-hybrid-001.mp4

Android: mWeb Chrome

59711-mweb-chrome-001.mp4

iOS: Native

59711-ios-hybrid-001.mp4

iOS: mWeb Safari

59711-mweb-safari-001.mp4

rojiphil

Thanks @nkdengineer for the updated PR.

@luacmartins Changes LGTM and works well.
Over to you for final review. Thanks.

luacmartins · 2025-04-10T19:02:26Z

src/components/Lottie/index.tsx

@@ -103,6 +103,7 @@ function Lottie({source, webStyle, shouldLoadAfterInteractions, ...props}: Props
            // eslint-disable-next-line react/jsx-props-no-spreading
            {...props}
            source={animationFile}
+            key={`${hasNavigatedAway}`}


Why are we using a template string? Can we just pass the variable?

@luacmartins hasNavigatedAway has type 'boolean' and it is not assignable to type 'Key | null | undefined'.

Thanks for clarifying. That looks a bit odd though, maybe we could have used a different key, but I won't block on that

luacmartins · 2025-04-10T22:50:36Z

src/components/Lottie/index.tsx

@@ -103,6 +103,7 @@ function Lottie({source, webStyle, shouldLoadAfterInteractions, ...props}: Props
            // eslint-disable-next-line react/jsx-props-no-spreading
            {...props}
            source={animationFile}
+            key={`${hasNavigatedAway}`}


Thanks for clarifying. That looks a bit odd though, maybe we could have used a different key, but I won't block on that

OSBotify · 2025-04-10T23:00:43Z

✋ 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 · 2025-04-11T00:51:49Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.27-0 🚀

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

github-actions · 2025-04-16T22:12:58Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.1.28-15 🚀

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

nkdengineer added 2 commits April 7, 2025 01:39

fix: Reports empty state is blank briefly

68b5c31

fix lint

ccc3735

nkdengineer marked this pull request as ready for review April 6, 2025 18:44

nkdengineer requested a review from a team as a code owner April 6, 2025 18:44

melvin-bot bot requested review from rojiphil and removed request for a team April 6, 2025 18:44

nkdengineer mentioned this pull request Apr 6, 2025

Reports- Reports empty state is blank briefly after returning from Filters/renaming search #59623

Closed

8 tasks

nkdengineer added 2 commits April 9, 2025 21:39

Merge branch 'main' into fix/59623

4af33b4

fix animantion

96f8c4e

nkdengineer added 2 commits April 11, 2025 00:08

Merge branch 'main' into fix/59623

e0420fd

fix prettier

1275cfa

rojiphil approved these changes Apr 10, 2025

View reviewed changes

melvin-bot bot requested a review from luacmartins April 10, 2025 17:45

luacmartins assigned nkdengineer Apr 10, 2025

luacmartins reviewed Apr 10, 2025

View reviewed changes

luacmartins approved these changes Apr 10, 2025

View reviewed changes

luacmartins merged commit 27d54f3 into Expensify:main Apr 10, 2025
19 checks passed

github-actions bot mentioned this pull request Apr 11, 2025

Deploy Checklist: New Expensify 2025-04-11 #60076

Closed

33 tasks

melvin-bot bot mentioned this pull request Apr 16, 2025

[Due for payment 2025-04-23] [Due for payment 2025-04-14] [$125] Empty state animation does not show when switching the tabs #59097

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Reports empty state is blank briefly #59711

fix: Reports empty state is blank briefly #59711

Uh oh!

nkdengineer commented Apr 6, 2025

Uh oh!

melvin-bot bot commented Apr 6, 2025

Uh oh!

rojiphil commented Apr 10, 2025

Uh oh!

nkdengineer commented Apr 10, 2025

Uh oh!

rojiphil commented Apr 10, 2025

Uh oh!

rojiphil left a comment

Uh oh!

luacmartins Apr 10, 2025

Uh oh!

nkdengineer Apr 10, 2025

Uh oh!

luacmartins Apr 10, 2025

Uh oh!

luacmartins Apr 10, 2025

Uh oh!

Uh oh!

OSBotify commented Apr 10, 2025

Uh oh!

github-actions bot commented Apr 11, 2025

Uh oh!

github-actions bot commented Apr 16, 2025

Uh oh!

Uh oh!

fix: Reports empty state is blank briefly #59711

fix: Reports empty state is blank briefly #59711

Uh oh!

Conversation

nkdengineer commented Apr 6, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 6, 2025

Uh oh!

rojiphil commented Apr 10, 2025

Uh oh!

nkdengineer commented Apr 10, 2025

Uh oh!

rojiphil commented Apr 10, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

rojiphil left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

nkdengineer Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

luacmartins Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

luacmartins Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Apr 10, 2025

Uh oh!

github-actions bot commented Apr 11, 2025

Uh oh!

github-actions bot commented Apr 16, 2025

Uh oh!

Uh oh!