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: Update Wallet and Generic Folder empty state to use lottie animations. #48040

Merged
merged 27 commits into from
Sep 20, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Aug 27, 2024

Details

Fixed Issues

$ #48013
PROPOSAL: #48013 (comment)

Tests

  1. Go to search page > Select a workspace with no expenses > Verify Folder Empty State Animation is shown
  2. Select Trips from LHS (filters) > Verify Trips Empty State Animation is shown
  3. From FAB select Book travel > Verify Trips Empty State Animation is shown
  4. Open a workspace with no tags, categories
  5. Open policy tags page > Verify Folder Empty State Animation is shown
  6. Open policy categories page > Verify Folder Empty State Animation is shown
  7. Open report fields page > Verify Folder Empty State Animation is shown
  8. Click Add field > Select list as type
  9. Go to list values > Verify Folder Empty State illustration is shown
  10. Go to settings/wallet > Verify Bank Vault animation is shown
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to search page > Select a workspace with no expenses > Verify Folder Empty State Animation is shown
  2. Select Trips from LHS (filters) > Verify Trips Empty State Animation is shown
  3. From FAB select Book travel > Verify Trips Empty State Animation is shown
  4. Open a workspace with no tags, categories
  5. Open policy tags page > Verify Folder Empty State Animation is shown
  6. Open policy categories page > Verify Folder Empty State Animation is shown
  7. Open report fields page > Verify Folder Empty State Animation is shown
  8. Click Add field > Select list as type
  9. Go to list values > Verify Folder Empty State illustration is shown
  10. Go to settings/wallet > Verify Bank Vault animation is shown

QA Steps

  1. Go to search page > Select a workspace with no expenses > Verify Folder Empty State Animation is shown
  2. Select Trips from LHS (filters) > Verify Trips Empty State Animation is shown
  3. From FAB select Book travel > Verify Trips Empty State Animation is shown
  4. Open a workspace with no tags, categories
  5. Open policy tags page > Verify Folder Empty State Animation is shown
  6. Open policy categories page > Verify Folder Empty State Animation is shown
  7. Open report fields page > Verify Folder Empty State Animation is shown
  8. Click Add field > Select list as type
  9. Go to list values > Verify Folder Empty State illustration is shown
  10. Go to settings/wallet > Verify Bank Vault animation is shown
  • 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
android_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

@Krishna2323 Krishna2323 requested review from a team as code owners August 27, 2024 00:35
@melvin-bot melvin-bot bot requested review from hungvu193 and removed request for a team August 27, 2024 00:35
Copy link

melvin-bot bot commented Aug 27, 2024

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

@Krishna2323 Krishna2323 marked this pull request as draft August 27, 2024 00:36
@Krishna2323
Copy link
Contributor Author

@Expensify/design, could you please review the result and let me know if it looks good? The size of the illustration is slightly larger than before. Additionally, for the categories selector page empty state, does the Edit categories button placement look fine? It was previously positioned at the bottom of the page.

Before After
empty_state_search_before empty_state_search_after
search_trip_after_before search_trip_after
categories_empty_state_before categories_empty_state_after
wallet_page_before wallet_page_after
list_values_before list_values_after

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Aug 27, 2024

Quick question for the @Expensify/design team. On desktop and mobile we seem to be using 32px padding on the card here, but in our other empty state card component we go from 32px to 20px on mobile. Do we wanna do the same here. The padding around the button seem a tad big in this screenshot:

image

@shawnborton
Copy link
Contributor

but in our other empty state card component we go from 32px to 20px on mobile.

Can you show me an example of that? I don't feel too strongly here... the 32px keeps things fluffy but I can see where it might feel off given that the workspace cards and other places go from 32px to 20px.

@shawnborton
Copy link
Contributor

@Krishna2323 everything is looking good to me, including button placement for categories! I'm going to follow up and get you a smaller version of the folder animation so that it feels more close to the older static version we had.

@dannymcclain
Copy link
Contributor

I'd love to see the 20px padding for small viewports/the RHP. I agree with Jon that the padding looks a tad large.

@shawnborton
Copy link
Contributor

Updated Lottie file is here: GenericEmptystate-082724-1.json.zip

@roryabraham can you compress that for us when you get a chance? Thanks!

@roryabraham
Copy link
Contributor

unfortunately LottieFiles seems to be down this morning and it's not letting me upload anything. I'll have to try again later. I'll set a reminder

@shawnborton
Copy link
Contributor

Sounds good, keep us posted!

@shawnborton
Copy link
Contributor

@Krishna2323 would it be easy for you to change the padding of this area on mobile:
CleanShot 2024-08-27 at 12 58 24@2x

To be 20px?
CleanShot 2024-08-27 at 12 59 02@2x

@Krishna2323
Copy link
Contributor Author

@Krishna2323 would it be easy for you to change the padding of this area on mobile

Yes, will do that.

@roryabraham
Copy link
Contributor

Updated animation GenericEmptyState animation: GenericEmptyState.lottie.zip

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Aug 28, 2024

Can you show me an example of that? I don't feel too strongly here... the 32px keeps things fluffy but I can see where it might feel off given that the workspace cards and other places go from 32px to 20px.

@shawnborton :

CleanShot 2024-08-29 at 09 54 24@2x

@Krishna2323
Copy link
Contributor Author

@Expensify/design, I have updated the empty state animation, and it looks correct to me, but I noticed one weird behaviour on the report field list page. When the RHP opens, the animation in the background stops. I’ve been trying to find a solution for that, but I haven't found any clues yet. @hungvu193, do you have any ideas about this?

Monosnap.screencast.2024-08-29.06-48-41.mp4

@dubielzyk-expensify
Copy link
Contributor

This screen looks wrong to me and it's duplicating the animation which we don't want.
CleanShot 2024-08-29 at 14 17 10@2x

Maybe it would play if we don't have the animation in the Right Hand Panel as well? cc @Expensify/design

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 29, 2024

. When the RHP opens, the animation in the background stops. I’ve been trying to find a solution for that, but I haven't found any clues yet. @hungvu193, do you have any ideas about this?

It came from #47960, we're hiding lottie view when navigation is not focused.

Screen.Recording.2024-08-29.at.14.11.36.mov

const unsubscribeNavigationFocus = navigation.addListener('focus', () => {
setIsHidden(false);
});

if (targetRouteName !== NAVIGATORS.RIGHT_MODAL_NAVIGATOR) {
setIsHidden(true);
}

@hungvu193
Copy link
Contributor

It was aimed to fix #47273. So I think that wont be an issue then? Would love to hear from design team.

@shawnborton
Copy link
Contributor

This screen looks wrong to me and it's duplicating the animation which we don't want.

@dubielzyk-expensify why do you think it looks wrong? I guess it's technically an empty list, so we're showing the empty state we use for empty lists there... I don't feel strongly though, I could see using a lighter empty state for this one.

@shawnborton
Copy link
Contributor

I think ideally the animation would still play in the background when the RHP is open though... so I would love to solve that if possible.

@hungvu193
Copy link
Contributor

hungvu193 commented Aug 29, 2024

I think ideally the animation would still play in the background when the RHP is open though... so I would love to solve that if possible.

Can you please comment in the original issue that I mentioned above?. It's not related to this PR 😄

@Krishna2323
Copy link
Contributor Author

@shawnborton @dannymcclain, looks better now?

Monosnap.screencast.2024-09-18.18-22-54.mp4

@dannymcclain
Copy link
Contributor

I think that's looking pretty good to me! Will wait for Shawn's feedback too.

@shawnborton
Copy link
Contributor

That does feel better, yup.

@shawnborton
Copy link
Contributor

Gonna run a test build but let's get this into final review!

Copy link
Contributor

@shawnborton
Copy link
Contributor

Hmm I'm definitely not trying to be difficult, but in this case here I would still expect the animation to be 220px tall - it would just be horizontally centered within the available background area. Instead it looks like we are shrinking based on the 400px width that it has:
CleanShot 2024-09-18 at 23 55 50@2x

Perhaps it's a simple fix? Take a look at this:

CleanShot.2024-09-18.at.23.59.26.mp4

@Krishna2323
Copy link
Contributor Author

Yeah, seems like a easy fix. Let me check.

Signed-off-by: krishna2323 <[email protected]>
@@ -5168,10 +5170,11 @@ const styles = (theme: ThemeColors) =>

emptyStateFolderWebStyles: {
...sizing.w100,
minWidth: 300,
minWidth: 400,
Copy link
Contributor

@hungvu193 hungvu193 Sep 19, 2024

Choose a reason for hiding this comment

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

@Krishna2323 Friendly reminder that you need to make sure you test this one on smaller device like iPhone8 or iPhoneSE

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, thanks for the reminder. I tested on the web by resizing, but I still need to test on all platforms.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hungvu193, tested on all platforms. I think you start reviewing now.

Monosnap.screencast.2024-09-20.04-45-12.mp4

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks man! Appreciate it, I'll give it a final review today!

@hungvu193
Copy link
Contributor

hungvu193 commented Sep 20, 2024

I'm blocked from testing because of this bug
Nevermind, force refresh will resolve it

Screen.Recording.2024-09-20.at.10.54.09.mov

@hungvu193
Copy link
Contributor

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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-09-20.at.13.53.41.mov
Android: mWeb Chrome
Screen.Recording.2024-09-10.at.17.46.15.mov
iOS: Native
Screen.Recording.2024-09-10.at.16.12.34.mov
iOS: mWeb Safari
Screen.Recording.2024-09-10.at.15.50.42.mov
MacOS: Chrome / Safari
Screen.Recording.2024-09-10.at.15.21.33.mov
MacOS: Desktop
Screen.Recording.2024-09-10.at.15.14.28.mov

minModalHeight = 400,
}: EmptyStateComponentProps) {
const styles = useThemeStyles();
const [videoAspectRatio, setVideoAspectRatio] = useState(VIDEO_ASPECT_RATIO);
const {isSmallScreenWidth} = useResponsiveLayout();
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB because it seems like all the styles are right in the screen recordings, but I think we might be able to use shouldUseNarrowLayout here, and generally that should be the default go-to instead of isSmallScreenWidth

@roryabraham roryabraham merged commit 513e6b3 into Expensify:main Sep 20, 2024
17 of 19 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/roryabraham in version: 9.0.40-0 🚀

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

@MonilBhavsar
Copy link
Contributor

This PR seem to have caused a regression #49744

@hungvu193
Copy link
Contributor

This PR seem to have caused a regression #49744

This PR only updated the lottie animation files so it won't cause that regression. Ideally, the regression will be from one of the PR that updated LottieView recently.

Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.0.40-6 🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants