Fix parsing issue, add support for DotLottieConfiguration in SwiftUI LottieView #2277

calda · 2024-01-05T01:21:04Z

This PR fixes two issues:

For #2269, we were failing to parse the animation. It's missing some fields that iOS requires, but that web doesn't require. We can relax the parsing a bit to allow this animation to parse successfully.

When testing the animation after fixing the parsing issue, I ran in to #2228. I bundled that animation and its image assets in a dotLottie file, but it was completely blank because the DotLottieConfiguration.imageProvider was being ignored.

Before #2269	Before fixing #2228	After

calda · 2024-01-05T01:22:18Z

Sources/Private/CoreAnimation/Layers/LayerModel+makeAnimationLayer.swift

@@ -51,6 +51,9 @@ extension LayerModel {
    case (.null, _):
      return TransformLayer(layerModel: self)

+    case (.unknown, _):
+      return nil


This fixes an issue where a layer with an unknown type would log a compatibility error and fall back to the main thread rendering engine, even though the main thread engine wouldn't be able to handle it either

Should we add a this comment to the code?

Should we also do something about the default case? It seems like without it the compiler would have warned us about this issue.

Sure, I updated this to switch exhaustively

calda · 2024-01-05T01:23:01Z

Sources/Private/Model/Assets/AssetLibrary.swift

        decodedAssets[precompAsset.id] = precompAsset
        precompAssets[precompAsset.id] = precompAsset
-      } else {
-        let imageAsset = try container.decode(ImageAsset.self)
+      } else if let imageAsset = try? container.decode(ImageAsset.self) {


If an image asset fails to parse for some reason, we can recover gracefully instead of throwing an error and rejecting the animation

calda · 2024-01-05T01:23:36Z

Sources/Private/Model/DictionaryInitializable.swift

@@ -8,7 +8,7 @@
 // MARK: - InitializableError

 enum InitializableError: Error {
-  case invalidInput
+  case invalidInput(file: StaticString = #file, line: UInt = #line)


Adding in file and line context makes it easier to debug where these errors are coming from

calda · 2024-01-05T01:24:25Z

Sources/Private/Model/Layers/LayerModel.swift

@@ -93,7 +93,7 @@ class LayerModel: Codable, DictionaryInitializable {
    inFrame = try container.decode(Double.self, forKey: .inFrame)
    outFrame = try container.decode(Double.self, forKey: .outFrame)
    startTime = try container.decode(Double.self, forKey: .startTime)
-    transform = try container.decode(Transform.self, forKey: .transform)
+    transform = try container.decodeIfPresent(Transform.self, forKey: .transform) ?? .default


All of the individual properties in a Transform are optional and have default values, so we can easily make the Transform itself optional with a default

calda · 2024-01-05T01:26:40Z

Sources/Public/Animation/LottieView.swift

+  ///  - Defaults to `[.imageProvider]`
+  ///  - If a component is specified here, that value in the `DotLottieConfiguration`
+  ///    of an active dotLottie animation will override any value provided via other methods.
+  public func dotLottieConfigurationComponents(


Since the DotLottieConfiguration overrides any value you pass in via .imageProvider(...), .loopMode(...), or .speed(...), it seems like a good idea to make this behavior configurable. Otherwise it would be impossible to use a custom loop mode or speed when playing some dotLottie animations.

emerge-tools · 2024-01-05T01:33:38Z

1 build increased size

Name	Version	Download	Change	Install	Change
SizeTest com.airbnb.lottie.sizetest.iOS	1.0 (1)	752.5 kB	⬆️ 5.9 kB (0.79%)	2.3 MB	⬆️ 20.4 kB (0.93%)

SizeTest 1.0 (1)
com.airbnb.lottie.sizetest.iOS

⚖️ Compare build
⏱️ Analyze build performance

Total install size change: ⬆️ 20.4 kB (0.93%)
Total download size change: ⬆️ 5.9 kB (0.79%)

Largest size changes

Item	Install Size Change
📝 Lottie.Dictionary.value(for,file,line)	⬆️ 8.2 kB
🗑 Lottie.Dictionary.value(for)	⬇️ -7.2 kB
Strings.Swift File Paths	⬆️ 4.4 kB
📝 Lottie.LottieView.applyCurrentAnimationConfiguration(to)	⬆️ 1.9 kB
DYLD.Fixups	⬆️ 1.3 kB

🛸 Powered by Emerge Tools

miguel-jimenez-0529

LGTM

miguel-jimenez-0529 · 2024-01-08T18:59:58Z

Sources/Private/CoreAnimation/Layers/LayerModel+makeAnimationLayer.swift

@@ -51,6 +51,9 @@ extension LayerModel {
    case (.null, _):
      return TransformLayer(layerModel: self)

+    case (.unknown, _):
+      return nil


Should we also do something about the default case? It seems like without it the compiler would have warned us about this issue.

miguel-jimenez-0529 · 2024-01-08T19:06:41Z

Sources/Private/Model/Assets/AssetLibrary.swift

-        let precompAsset = try container.decode(PrecompAsset.self)
+    while
+      !container.isAtEnd,
+      let keyContainer = try? containerForKeys.nestedContainer(keyedBy: PrecompAsset.CodingKeys.self)


Should we add resilient decoder https://github.com/airbnb/ResilientDecoding in case we need the error at another time?

We don't use the Codable decoding implementation by default (the dictionary-based implementation is the default in Lottie 4.0+ since it's a lot faster), so no need to invest much in the Codable implementation

miguel-jimenez-0529 · 2024-01-08T19:08:14Z

Sources/Private/Utility/LottieAnimationSource.swift

-      return dotLottieFile.animation()?.animation
+      return dotLottieFile.animation()


This PR contains the following updates: | Package | Update | Change | |---|---|---| | [airbnb/lottie-spm](https://github.com/airbnb/lottie-spm) | minor | `from: "4.3.4"` -> `from: "4.4.0"` | --- ### Release Notes <details> <summary>airbnb/lottie-spm (airbnb/lottie-spm)</summary> ### [`v4.4.0`](https://github.com/airbnb/lottie-spm/releases/tag/4.4.0) [Compare Source](https://github.com/airbnb/lottie-spm/compare/4.3.4...4.4.0) #### New features - Add privacy manifest ([https://github.com/airbnb/lottie-ios/pull/2252](https://github.com/airbnb/lottie-ios/pull/2252)) - Codesign Lottie.xcframework ([https://github.com/airbnb/lottie-ios/pull/2259](https://github.com/airbnb/lottie-ios/pull/2259)) - Add time remapping support to Core Animation rendering engine ([https://github.com/airbnb/lottie-ios/pull/2286](https://github.com/airbnb/lottie-ios/pull/2286)) - Add official visionOS support to lottie-ios repo ([https://github.com/airbnb/lottie-ios/pull/2287](https://github.com/airbnb/lottie-ios/pull/2287)) - lottie-spm now supports visionOS ([https://github.com/airbnb/lottie-spm/pull/12](https://github.com/airbnb/lottie-spm/pull/12)) - Adopt policy on minimum supported Swift / Xcode version, update minimum versions to Swift 5.7 / Xcode 14.1 ([https://github.com/airbnb/lottie-ios/pull/2260](https://github.com/airbnb/lottie-ios/pull/2260)) #### Bug fixes - Update LottieView to display placeholder using `overlay` instead of `ZStack` ([https://github.com/airbnb/lottie-ios/pull/2289](https://github.com/airbnb/lottie-ios/pull/2289)) - Fix issue where Core Animation rendering engine couldn't display last frame of animation when paused ([https://github.com/airbnb/lottie-ios/pull/2254](https://github.com/airbnb/lottie-ios/pull/2254)) - Do not create `DotLottieImageProvider` instance if there's no image files ([https://github.com/airbnb/lottie-ios/pull/2271](https://github.com/airbnb/lottie-ios/pull/2271)) - Mark DotLottieCache as Sendable ([https://github.com/airbnb/lottie-ios/pull/2245](https://github.com/airbnb/lottie-ios/pull/2245)) - Fix issue where AnimationKeypath in SolidLayer could be incorrect ([https://github.com/airbnb/lottie-ios/pull/2278](https://github.com/airbnb/lottie-ios/pull/2278)) - Fix issue where Repeater could be displayed incorrectly ([https://github.com/airbnb/lottie-ios/pull/2276](https://github.com/airbnb/lottie-ios/pull/2276)) - Include dSYMs in xcframework build ([https://github.com/airbnb/lottie-ios/pull/2284](https://github.com/airbnb/lottie-ios/pull/2284)) - Fix parsing issue, add support for DotLottieConfiguration in SwiftUI LottieView ([https://github.com/airbnb/lottie-ios/pull/2277](https://github.com/airbnb/lottie-ios/pull/2277)) - Fix issue where DotLottieImageProvider didn't handle base64 images ([https://github.com/airbnb/lottie-ios/pull/2283](https://github.com/airbnb/lottie-ios/pull/2283)) - Fix issue where manually interpolated keyframes could animate incorrectly ([https://github.com/airbnb/lottie-ios/pull/2285](https://github.com/airbnb/lottie-ios/pull/2285)) **Full Changelog**: airbnb/lottie-ios@4.3.4...4.4.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: Self-hosted Renovate Bot <361546+cgrindel-self-hosted-renovate[bot]@users.noreply.github.enterprise.com>

…LottieView (airbnb#2277)

calda added 3 commits January 4, 2024 09:41

WIP

6445e5f

Properly consume DotLottieConfiguration in LottieView

0a5b6f8

Update snapshots

470cf26

calda commented Jan 5, 2024

View reviewed changes

Clean up

f90b2c6

Update Xcode version for running tests to hopefully fix flaky test case

0f5342b

calda mentioned this pull request Jan 8, 2024

Looping doesn't work with dotLottie in UIKit #2272

Closed

miguel-jimenez-0529 approved these changes Jan 8, 2024

View reviewed changes

calda added 2 commits January 8, 2024 11:34

Simplify animation to make it less flaky

94dd969

Switch exhaustively

19f8cdf

calda enabled auto-merge (squash) January 8, 2024 19:36

calda merged commit 9c1dac7 into master Jan 8, 2024
14 checks passed

calda deleted the cal--2269 branch January 8, 2024 21:03

iago849 pushed a commit to atteamapps/lottie-ios that referenced this pull request Feb 8, 2024

Fix parsing issue, add support for DotLottieConfiguration in SwiftUI …

b1ce644

…LottieView (airbnb#2277)

MoroziOS pushed a commit to MoroziOS/tmg-lottie-ios that referenced this pull request May 22, 2024

Fix parsing issue, add support for DotLottieConfiguration in SwiftUI …

5a544a3

…LottieView (airbnb#2277)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix parsing issue, add support for DotLottieConfiguration in SwiftUI LottieView #2277

Fix parsing issue, add support for DotLottieConfiguration in SwiftUI LottieView #2277

calda commented Jan 5, 2024

calda Jan 5, 2024

miguel-jimenez-0529 Jan 8, 2024

miguel-jimenez-0529 Jan 8, 2024

calda Jan 8, 2024

calda Jan 5, 2024

calda Jan 5, 2024

calda Jan 5, 2024

calda Jan 5, 2024

emerge-tools bot commented Jan 5, 2024 •

edited

Loading

miguel-jimenez-0529 left a comment

miguel-jimenez-0529 Jan 8, 2024

miguel-jimenez-0529 Jan 8, 2024

calda Jan 8, 2024

miguel-jimenez-0529 Jan 8, 2024

		return dotLottieFile.animation()?.animation
		return dotLottieFile.animation()

Fix parsing issue, add support for DotLottieConfiguration in SwiftUI LottieView #2277

Fix parsing issue, add support for DotLottieConfiguration in SwiftUI LottieView #2277

Conversation

calda commented Jan 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emerge-tools bot commented Jan 5, 2024 • edited Loading

1 build increased size

SizeTest 1.0 (1)com.airbnb.lottie.sizetest.iOS

miguel-jimenez-0529 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emerge-tools bot commented Jan 5, 2024 •

edited

Loading

SizeTest 1.0 (1)
com.airbnb.lottie.sizetest.iOS