Upgrade lottie-react-native to 6.3.1 #28267
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
melvin-bot
bot
requested review from
dangrous
and removed request for
a team
|
@roryabraham do you want to review this? Happy to do so but looks like it's your issue |
|
Sure, sorry for the delay. Going to run a test build to make this faster to test |
|
🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪 |
kosmydel
suggested changes
Oct 2, 2023
Comment on lines
42
to
56
| + const aspectRatioStyle = sources.sourceJson | ||
| + ? { aspectRatio: (source as any).w / (source as any).h } | ||
| + : undefined; | ||
| + | ||
| + const styleObject = StyleSheet.flatten(style); | ||
| + let sizeStyle; | ||
| + if ( | ||
| + !styleObject || | ||
| + (styleObject.width === undefined && styleObject.height === undefined) | ||
| + ) { | ||
| + sizeStyle = | ||
| + autoSize && sources.sourceJson | ||
| + ? { width: (source as any).w } | ||
| + : StyleSheet.absoluteFill; | ||
| + } |
There was a problem hiding this comment.
I don't think that we want to simply revert the breaking changes in the patch.
There was a problem hiding this comment.
@kosmydel
Hello )
You're probably right
But what's the point of depriving us of default styles?
Which we can always override using props
Which allows us to calculate the height and aspect ratio of the element without unnecessary problems
There was a problem hiding this comment.
Can we override using props? I don't really like patching
There was a problem hiding this comment.
We might also consider passing aspectRatio as a value/prop instead of calculating it. Just an idea.
There was a problem hiding this comment.
It can be done )
But then we will have to hard code the aspect ratio )
Or
We can take the aspect ratio calculation function from the patch I made
But then does it make sense for each loti component that we use to set the aspect ratio as styles?
If with the patch we will have automatic aspect ratio support
There was a problem hiding this comment.
We should probably also put it into some useMemo. I think that this is still much better than doing it in a patch. Especially when I am working on this related issue. And patching would require regular maintenance if the original library changes.
But there is a problem with this approach. When we move to the .lottie files we can't access the .w and .h so easily, as these animations won't be JSON objects anymore. I'm not sure how should we handle it.
cc @situchan @roryabraham what do you think?
|
I'm OOO this week so unassigning myself as a reviewer, I think y'all should probably have it covered! |
6 tasks
This reverts commit d9ff6fa.
|
@situchan |
kosmydel
reviewed
Oct 5, 2023
src/components/ConfirmationPage.js
Outdated
| @@ -46,7 +46,7 @@ function ConfirmationPage(props) { | |||
| source={props.animation} | |||
| autoPlay | |||
| loop | |||
| style={styles.confirmationAnimation} | |||
| style={[styles.confirmationAnimation, styles.aspectRatioLottie(props.animation)]} | |||
There was a problem hiding this comment.
We could possibly add some kind of wrapper to the <Lottie> component, adding this style, instead of copying the same line several times, with the argument, that is already passed to the component.
Just an idea.
|
@situchan |
situchan
suggested changes
Oct 8, 2023
package-lock.json
Outdated
| "integrity": "sha512-vhdeZstXMfuVKwnddYWjJgQ/1whGL58IJEJu/iSf0XQ5gAb4pp/+vy91mdYQLezlb8Aw4Vu3fKnqErJL2hwchg==", | ||
| "version": "6.3.1", | ||
| "resolved": "https://registry.npmjs.org/lottie-react-native/-/lottie-react-native-6.3.1.tgz", | ||
| "integrity": "sha512-M18nAVYeGMF//bhL27D2zuMcrFPH0jbD/deBvcWi0CCcfZf6LQfx45xt+cuDqwr5nh6dMm+ta8KfZJmkbNhtlg==", | ||
| "requires": { |
There was a problem hiding this comment.
Not sure why this file I generated is different from this branch.
Replace package-lock.json with this done:
ios/Podfile.lock
Outdated
| @@ -188,33 +188,33 @@ PODS: | |||
| - GoogleUtilities/Network (~> 7.4) | |||
There was a problem hiding this comment.
We only need to update lottie related frameworks. Revert all other changes which are out of scope.
Just replace with this file I generated:
situchan
reviewed
Oct 8, 2023
src/styles/styles.js
Outdated
| @@ -3779,6 +3779,13 @@ const styles = (theme) => ({ | |||
| lineHeight: variables.lineHeightLarge, | |||
| }, | |||
|
|
|||
| aspectRatioLottie: (source) => { | |||
| if (typeof source === 'object' && !source.uri) { | |||
There was a problem hiding this comment.
We can add more safety condition here, though all Lottie JSON may include w, h properties.
Suggested change
| if (typeof source === 'object' && !source.uri) { | |
| if (!source.uri && typeof source === 'object' && source.w && source.h) { |
src/styles/styles.js
Outdated
| if (typeof source === 'object' && !source.uri) { | ||
| return {aspectRatio: source.w / source.h}; | ||
| } | ||
| return {aspectRatio: '1'}; |
There was a problem hiding this comment.
I prefer setting this undefined and let user fully customize style properties.
If both width and height are defined, they're skipped because aspectRatio overwrites them.
Suggested change
| return {aspectRatio: '1'}; | |
| return {}; |
|
Check this video which demonstrates all animations are working well. You should test like this on all platforms. ios.mov |
Reviewer Checklist
Screenshots/VideosWebweb.movMobile Web - Chromemchrome.movMobile Web - Safarimsafari.movDesktopdesktop.moviOSios.movAndroidandroid.mov |
situchan
approved these changes
Oct 9, 2023
|
@ZhenjaHorbach can you please resolve the conflicts? |
Done ) |
|
✋ 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
bot
added
the
DeployBlockerCash
Performance Comparison Report 📊Significant Changes To Duration
Show details
Meaningless Changes To DurationShow entries
Show details
|
|
@Expensify/mobile-deployers 📣 Please look into this performance regression as it's a deploy blocker. |
97 tasks
| @@ -0,0 +1,3 @@ | |||
| import Lottie from './Lottie'; | |||
There was a problem hiding this comment.
Why Lottie.tsx is written in TS and index.js in JS? I think Lottie catalog can be removed and Lottie.tsx file in components catalog should be sufficient.
There was a problem hiding this comment.
Why
Lottie.tsxis written in TS andindex.jsin JS?
This is already existing pattern, i.e. MapView but agree to write TS for all
I think Lottie catalog can be removed and
Lottie.tsxfile incomponentscatalog should be sufficient.
Agree. Unless platform specific or has propTypes in js
There was a problem hiding this comment.
Regarding the first point, I did it by analogy with other catalogs)
And about the second one, maybe you're right
Seems a little redundant
Should I create a new PR?
|
🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀
|
2 similar comments
|
🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀
|
|
🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀
|
|
🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
Upgrade E/App to use lottie-react-native 6.3.1+
Fixed Issues
$ #28132
PROPOSAL: #28132 (comment)
Tests
Offline tests
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Web
screen-recording-2023-10-08-at-235606_1uah9PAL.mp4
Mobile Web - Chrome
screen-recording-2023-10-09-at-000924_UD19wRwo.mp4
Mobile Web - Safari
screen-recording-2023-10-09-at-002042_Zf909vHa.mp4
Desktop
screen-recording-2023-10-08-at-235908_90zeamRV.mp4
iOS
screen-recording-2023-10-09-at-002514_Weq83e0S.1.mp4
Android
screen-recording-2023-10-09-at-010520_vgOYOsTn.mp4