Migrate animations to app assets and .lottie files #29975

kosmydel · 2023-10-19T13:35:02Z

Details

Fixed Issues

$ #28160
$ #26857
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Check the animations working from QA steps (I verified checked animations in that list)

Offline tests

Load the app
Turn off the network in the developer tools
Go to the view with the animation (i.g. Settings -> Preferences)

Offline test

Screen.Recording.2023-11-06.at.10.43.46.mov

QA Steps

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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native / iOS: Native

ios_android.mov

Android: mWeb Chrome / iOS: mWeb Safari

mweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

updating the expensify card admin settings and features help doc per this issue here https://github.com/Expensify/Expensify/issues/311376

updating the formatting to include numbered steps for certain sections

updating the formatting

src/pages/signin/SignInHeroImage.js

web/index.html

roryabraham · 2023-10-30T18:27:32Z

How did you convert these to .lottie? Asking because we have a paid LottieFiles account so can get their optimized version of the .lottie file conversions.

roryabraham

As suggested in slack, let's split this up into two:

One PR to upgrade lottie to 6.4.0, stop using react-native-web-lottie, and delete our patch in react-native-web-lottie
Another to switch from .json to .lottie

kosmydel · 2023-11-02T09:35:51Z

How did you convert these to .lottie? Asking because we have a paid LottieFiles account so can get their optimized version of the .lottie file conversions.

Hey,
I've used this converter. I haven't used the optimized version of .lottie files. Can you provide me with the optimized ones?

As suggested in slack, let's split this up into two:

One PR to upgrade lottie to 6.4.0, stop using react-native-web-lottie, and delete our patch in react-native-web-lottie

Another to switch from .json to .lottie

Sure, I will prepare two separate PRs.

However, if there are any problems with the JSON animations library (as the lottie-react-native library under the hood uses separate libraries for JSON and .lottie files) it might add some unnecessary work. But I hope it will go smoothly without any problems.

roryabraham · 2023-11-02T18:33:20Z

#30772 merged to main so we should be able to rebase this PR and get it up for review again. Thanks @kosmydel!

roryabraham · 2023-11-04T00:59:09Z

Sorry for the delay, I can't get the optimized Lottie assets to you just now as LottieFiles has been down for a few days, presumably due to the ongoing Cloudflare outage

roryabraham · 2023-11-07T00:03:12Z

@kosmydel, it turns out that some of the "optimized" DotLottie file formats are bigger than the "un-optimized" DotLottie. Also seems like LottieFiles isn't really working as expected right now, so let's not block on that.

kosmydel · 2023-11-07T08:58:00Z

Sure! I've pulled the main, quickly tested it, and it is ready for review.
cc @mananjadhav

Keep in mind, that since we are moving the animations to the assets, animations are lazy loaded, so they appear with a little delay.

roryabraham · 2023-11-07T22:10:57Z

Awaiting C+ review from @mananjadhav

mananjadhav · 2023-11-08T13:37:46Z

Half way through the code, will finish this today.

mananjadhav · 2023-11-08T20:54: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(themeColors.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 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

android-ios-animations.mov

Android: mWeb Chrome

mweb-chrome-animations.mov

iOS: Native

ios-animations.mov

iOS: mWeb Safari

mweb-safari-animations.mov

MacOS: Chrome / Safari

web-lottie-animations-5.mov

web-lottie-animations-4.mov

web-lottie-animations-3.mov

web-lottie-animations-2.mov

web-lottie-animations-1.mov

MacOS: Desktop

desktop-lottie-animations.mov

mananjadhav · 2023-11-08T21:11:57Z

I am testing each of the lottie animations. I could test all but one Magician. I am not sure if there's a test way of adding Physical card.

mananjadhav · 2023-11-08T22:24:29Z

@roryabraham Except for one animation, I was able to test all.

roryabraham · 2023-11-08T23:34:58Z

@kosmydel I think you need to merge main here. I think the conflicts will merge cleanly because the changes in package.json and package-lock.json are already on main.

kosmydel · 2023-11-09T07:53:53Z

@kosmydel I think you need to merge main here. I think the conflicts will merge cleanly because the changes in package.json and package-lock.json are already on main.

@roryabraham I've resolved conflicts and quickly tested a few animations. The conflicts were with this PR fixing a bug in the .json version which was recently merged.

OSBotify · 2023-11-09T08:15:47Z

✋ 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 · 2023-11-10T16:00:06Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:53:33Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

OSBotify · 2023-11-14T22:13:36Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:56:52Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

gabrielessner and others added 15 commits October 19, 2023 12:30

Update Card-Settings.md

0312d40

updating the expensify card admin settings and features help doc per this issue here https://github.com/Expensify/Expensify/issues/311376

Update Card-Settings.md

4deed95

updating the formatting to include numbered steps for certain sections

Update Card-Settings.md

9b97e4a

updating the formatting

migrate to lottie-react-native with web support

4401d80

fix loading space

f2244ed

Merge branch 'main' into @kosmydel/lottie-react-native-web-support

5db4409

Merge branch 'main' into @kosmydel/lottie-react-native-web-support

ce75dc1

Migrate to dotLottie files

90c0940

Cleanup after migration to dotLottie files

671c376

refactor

06a3477

fix typing

fa6e106

prettier

3c6666c

add offline support

e20fa3b

fix offline view on web

85239c1

refactor

ddce7de

blazejkustra suggested changes Oct 30, 2023

View reviewed changes

src/pages/signin/SignInHeroImage.js Outdated Show resolved Hide resolved

web/index.html Outdated Show resolved Hide resolved

kosmydel added 3 commits October 30, 2023 13:21

address review

6f1e60f

lint

af01da4

Merge branch 'main' into @kosmydel/lottie-react-native-web-support

8aafc76

roryabraham requested changes Oct 30, 2023

View reviewed changes

mczernek approved these changes Oct 31, 2023

View reviewed changes

kosmydel mentioned this pull request Nov 2, 2023

Upgrade lottie-react-native to 6.4.0 #30772

Merged

74 tasks

kosmydel added 4 commits November 6, 2023 10:19

Merge branch 'main' into @kosmydel/lottie-react-native-web-support

b5c386a

remove json player

9397845

fix tests

af2b2df

clean DotLottieAnimation type

847cdbf

roryabraham self-requested a review November 7, 2023 00:03

Merge branch 'main' into @kosmydel/lottie-react-native-web-support

01c4add

kosmydel marked this pull request as ready for review November 7, 2023 08:45

mananjadhav approved these changes Nov 8, 2023

View reviewed changes

roryabraham previously approved these changes Nov 8, 2023

View reviewed changes

Merge branch 'main' into @kosmydel/lottie-react-native-web-support

6c52316

kosmydel dismissed roryabraham’s stale review via 6c52316 November 9, 2023 07:51

roryabraham approved these changes Nov 9, 2023

View reviewed changes

roryabraham merged commit 5a94095 into Expensify:main Nov 9, 2023
15 checks passed

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

ishpaul777 mentioned this pull request Nov 10, 2023

[HOLD for payment 2024-01-03] Settings - Animation in Settings is not smooth: background comes first then the animation #31196

Closed

6 tasks

kosmydel mentioned this pull request Nov 13, 2023

mWeb - The animation is not loading at all when use is offline #31236

Closed

6 tasks

This was referenced Nov 14, 2023

[HOLD for payment 2023-11-21] Migrate Lottie animations from bundle to app assets #28160

Closed

[$500] [HOLD for payment 2023-11-21] [Tracking] Start using DotLottie animation assets instead of lottie JSON #26857

Closed

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

allgandalf mentioned this pull request Feb 3, 2024

Bank account - Animation in One moment page is not displayed #35747

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate animations to app assets and .lottie files #29975

Migrate animations to app assets and .lottie files #29975

kosmydel commented Oct 19, 2023 •

edited

Loading

roryabraham commented Oct 30, 2023

roryabraham left a comment

kosmydel commented Nov 2, 2023

roryabraham commented Nov 2, 2023

roryabraham commented Nov 4, 2023

roryabraham commented Nov 7, 2023

kosmydel commented Nov 7, 2023

roryabraham commented Nov 7, 2023

mananjadhav commented Nov 8, 2023

mananjadhav commented Nov 8, 2023 •

edited

Loading

mananjadhav commented Nov 8, 2023

mananjadhav commented Nov 8, 2023

roryabraham commented Nov 8, 2023

kosmydel commented Nov 9, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

Migrate animations to app assets and .lottie files #29975

Migrate animations to app assets and .lottie files #29975

Conversation

kosmydel commented Oct 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

roryabraham commented Oct 30, 2023

roryabraham left a comment

Choose a reason for hiding this comment

kosmydel commented Nov 2, 2023

roryabraham commented Nov 2, 2023

roryabraham commented Nov 4, 2023

roryabraham commented Nov 7, 2023

kosmydel commented Nov 7, 2023

roryabraham commented Nov 7, 2023

mananjadhav commented Nov 8, 2023

mananjadhav commented Nov 8, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mananjadhav commented Nov 8, 2023

mananjadhav commented Nov 8, 2023

roryabraham commented Nov 8, 2023

kosmydel commented Nov 9, 2023

OSBotify commented Nov 9, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

kosmydel commented Oct 19, 2023 •

edited

Loading

mananjadhav commented Nov 8, 2023 •

edited

Loading