lottie-ios 3.4.2 → 3.4.3

package/Lottie.xcodeproj/project.pbxproj

@@ -554,6 +554,7 @@
 		2EAF5B0427A0798700E00531 /* AnimationFontProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EAF59F227A0798700E00531 /* AnimationFontProvider.swift */; };
 		2EAF5B0527A0798700E00531 /* AnimationFontProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EAF59F227A0798700E00531 /* AnimationFontProvider.swift */; };
 		2EAF5B0627A0798700E00531 /* AnimationFontProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EAF59F227A0798700E00531 /* AnimationFontProvider.swift */; };
+		36E57EAC28AF7ADF00B7EFDA /* HardcodedTextProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = 36E57EAB28AF7ADF00B7EFDA /* HardcodedTextProvider.swift */; };
 		6D0E635F28246BD0007C5DB6 /* Difference in Frameworks */ = {isa = PBXBuildFile; productRef = 6D0E635E28246BD0007C5DB6 /* Difference */; };
 		6D99D6432823790700E5205B /* LegacyGradientFillRenderer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6D99D6422823790700E5205B /* LegacyGradientFillRenderer.swift */; };
 		6D99D6442823790700E5205B /* LegacyGradientFillRenderer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6D99D6422823790700E5205B /* LegacyGradientFillRenderer.swift */; };
@@ -783,6 +784,7 @@
 		2EAF59EF27A0798700E00531 /* GradientValueProvider.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GradientValueProvider.swift; sourceTree = "<group>"; };
 		2EAF59F027A0798700E00531 /* PointValueProvider.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = PointValueProvider.swift; sourceTree = "<group>"; };
 		2EAF59F227A0798700E00531 /* AnimationFontProvider.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AnimationFontProvider.swift; sourceTree = "<group>"; };
+		36E57EAB28AF7ADF00B7EFDA /* HardcodedTextProvider.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HardcodedTextProvider.swift; sourceTree = "<group>"; };
 		6D99D6422823790700E5205B /* LegacyGradientFillRenderer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LegacyGradientFillRenderer.swift; sourceTree = "<group>"; };
 		6DB3BDB528243FA5002A276D /* ValueProvidersTests.swift */ = {isa = PBXFileReference; indentWidth = 2; lastKnownFileType = sourcecode.swift; path = ValueProvidersTests.swift; sourceTree = "<group>"; tabWidth = 2; };
 		6DB3BDB7282454A6002A276D /* DictionaryInitializable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DictionaryInitializable.swift; sourceTree = "<group>"; };
@@ -876,6 +878,7 @@
 				2E8040BF27A07343006E74CB /* Snapshotting+presentationLayer.swift */,
 				2EAF59A627A076BC00E00531 /* Bundle+Module.swift */,
 				2E09FA0527B6CEB600BA84E5 /* HardcodedFontProvider.swift */,
+				36E57EAB28AF7ADF00B7EFDA /* HardcodedTextProvider.swift */,
 			);
 			path = Utils;
 			sourceTree = "<group>";
@@ -1876,6 +1879,7 @@
 				6DEF696E2824A76C007D640F /* BundleTests.swift in Sources */,
 				2EAF59A727A076BC00E00531 /* Bundle+Module.swift in Sources */,
 				2E8044AE27A07347006E74CB /* Snapshotting+presentationLayer.swift in Sources */,
+				36E57EAC28AF7ADF00B7EFDA /* HardcodedTextProvider.swift in Sources */,
 				2E72128527BB32DB0027BC56 /* PerformanceTests.swift in Sources */,
 				6DB3BDC328245AA2002A276D /* ParsingTests.swift in Sources */,
 				6DB3BDB628243FA5002A276D /* ValueProvidersTests.swift in Sources */,

package/Lottie.xcworkspace/xcuserdata/calstephens.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist

@@ -18,5 +18,21 @@
             endingLineNumber = "44">
          </BreakpointContent>
       </BreakpointProxy>
+      <BreakpointProxy
+         BreakpointExtensionID = "Xcode.Breakpoint.FileBreakpoint">
+         <BreakpointContent
+            uuid = "90B95B81-4B28-4BCD-AE7B-59ED8AA81AC1"
+            shouldBeEnabled = "No"
+            ignoreCount = "0"
+            continueAfterRunningActions = "No"
+            filePath = "Sources/Private/MainThread/NodeRenderSystem/NodeProperties/NodeProperty.swift"
+            startingColumnNumber = "9223372036854775807"
+            endingColumnNumber = "9223372036854775807"
+            startingLineNumber = "49"
+            endingLineNumber = "49"
+            landmarkName = "update(frame:)"
+            landmarkType = "7">
+         </BreakpointContent>
+      </BreakpointProxy>
    </Breakpoints>
 </Bucket>

package/Sources/Private/CoreAnimation/Animations/GradientAnimations.swift

@@ -36,11 +36,23 @@ extension GradientRenderLayer {
     type: GradientContentType,
     context: LayerAnimationContext) throws
   {
-    // We have to set `colors` to a non-nil value with some valid number of colors
-    // for the color animation below to have any effect
-    colors = .init(
-      repeating: CGColor.rgb(0, 0, 0),
-      count: gradient.numberOfColors)
+    // We have to set `colors` and `locations` to non-nil values
+    // for the animations below to actually take effect
+    locations = []
+
+    // The initial value for `colors` must be an array with the exact same number of colors
+    // as the gradient that will be applied in the `CAAnimation`
+    switch type {
+    case .rgb:
+      colors = .init(
+        repeating: CGColor.rgb(0, 0, 0),
+        count: gradient.numberOfColors)
+
+    case .alpha:
+      colors = .init(
+        repeating: CGColor.rgb(0, 0, 0),
+        count: gradient.colorConfiguration(from: gradient.colors.keyframes[0].value, type: .alpha).count)
+    }
 
     try addAnimation(
       for: .colors,

package/Sources/Private/CoreAnimation/Animations/StrokeAnimation.swift

@@ -55,12 +55,13 @@ extension CAShapeLayer {
     try addOpacityAnimation(for: stroke, context: context)
 
     if let (dashPattern, dashPhase) = stroke.dashPattern?.shapeLayerConfiguration {
-      lineDashPattern = try dashPattern.map {
+      let lineDashPattern = try dashPattern.map {
         try KeyframeGroup(keyframes: $0)
-          .exactlyOneKeyframe(context: context, description: "stroke dashPattern").cgFloatValue as NSNumber
+          .exactlyOneKeyframe(context: context, description: "stroke dashPattern").cgFloatValue
       }
-      if lineDashPattern?.allSatisfy({ $0.floatValue.isZero }) == true {
-        lineDashPattern = nil
+
+      if lineDashPattern.isSupportedLayerDashPattern {
+        self.lineDashPattern = lineDashPattern as [NSNumber]
       }
 
       try addAnimation(

package/Sources/Private/CoreAnimation/CoreAnimationLayer.swift

@@ -17,6 +17,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
   init(
     animation: Animation,
     imageProvider: AnimationImageProvider,
+    textProvider: AnimationTextProvider,
     fontProvider: AnimationFontProvider,
     compatibilityTrackerMode: CompatibilityTracker.Mode,
     logger: LottieLogger)
@@ -24,6 +25,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
   {
     self.animation = animation
     self.imageProvider = imageProvider
+    self.textProvider = textProvider
     self.fontProvider = fontProvider
     self.logger = logger
     compatibilityTracker = CompatibilityTracker(mode: compatibilityTrackerMode, logger: logger)
@@ -44,6 +46,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
     animation = typedLayer.animation
     currentAnimationConfiguration = typedLayer.currentAnimationConfiguration
     imageProvider = typedLayer.imageProvider
+    textProvider = typedLayer.textProvider
     fontProvider = typedLayer.fontProvider
     didSetUpAnimation = typedLayer.didSetUpAnimation
     compatibilityTracker = typedLayer.compatibilityTracker
@@ -92,6 +95,16 @@ final class CoreAnimationLayer: BaseAnimationLayer {
     didSet { reloadImages() }
   }
 
+  /// The `AnimationTextProvider` that `TextLayer`'s use to retrieve texts,
+  /// that they should use to render their text context
+  var textProvider: AnimationTextProvider {
+    didSet {
+      // We need to rebuild the current animation after updating the text provider,
+      // since this is used in `TextLayer.setupAnimations(context:)`
+      rebuildCurrentAnimation()
+    }
+  }
+
   /// The `FontProvider` that `TextLayer`s use to retrieve the `CTFont`
   /// that they should use to render their text content
   var fontProvider: AnimationFontProvider {
@@ -203,6 +216,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
     LayerContext(
       animation: animation,
       imageProvider: imageProvider,
+      textProvider: textProvider,
       fontProvider: fontProvider,
       compatibilityTracker: compatibilityTracker,
       layerName: "root layer")
@@ -234,6 +248,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
       compatibilityTracker: compatibilityTracker,
       logger: logger,
       currentKeypath: AnimationKeypath(keys: []),
+      textProvider: textProvider,
       logHierarchyKeypaths: configuration.logHierarchyKeypaths)
 
     // Perform a layout pass if necessary so all of the sublayers
@@ -314,11 +329,18 @@ extension CoreAnimationLayer: RootAnimationLayer {
   }
 
   var isAnimationPlaying: Bool? {
-    switch playbackState {
+    switch pendingAnimationConfiguration?.playbackState {
     case .playing:
-      return animation(forKey: #keyPath(animationProgress)) != nil
-    case nil, .paused:
+      return true
+    case .paused:
       return false
+    case nil:
+      switch playbackState {
+      case .playing:
+        return animation(forKey: #keyPath(animationProgress)) != nil
+      case nil, .paused:
+        return false
+      }
     }
   }
 
@@ -383,15 +405,6 @@ extension CoreAnimationLayer: RootAnimationLayer {
     (sublayers ?? []).filter { $0 is AnimationLayer }
   }
 
-  var textProvider: AnimationTextProvider {
-    get { DictionaryTextProvider([:]) }
-    set {
-      logger.assertionFailure("""
-        The Core Animation rendering engine currently doesn't support `textProvider`s")
-        """)
-    }
-  }
-
   func reloadImages() {
     // When the image provider changes, we have to update all `ImageLayer`s
     // so they can query the most up-to-date image from the new image provider.

package/Sources/Private/CoreAnimation/Layers/AnimationLayer.swift

@@ -41,6 +41,9 @@ struct LayerAnimationContext {
   /// The AnimationKeypath represented by the current layer
   var currentKeypath: AnimationKeypath
 
+  /// The `AnimationTextProvider`
+  var textProvider: AnimationTextProvider
+
   /// Whether or not to log `AnimationKeypath`s for all of the animation's layers
   ///  - Used for `CoreAnimationLayer.logHierarchyKeypaths()`
   var logHierarchyKeypaths: Bool

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

@@ -9,6 +9,7 @@ import QuartzCore
 struct LayerContext {
   let animation: Animation
   let imageProvider: AnimationImageProvider
+  let textProvider: AnimationTextProvider
   let fontProvider: AnimationFontProvider
   let compatibilityTracker: CompatibilityTracker
   var layerName: String

package/Sources/Private/CoreAnimation/Layers/PreCompLayer.swift

@@ -68,12 +68,12 @@ final class PreCompLayer: BaseCompositionLayer {
     try setupLayerAnimations(context: context)
 
     // Precomp layers can adjust the local time of their child layers (relative to the
-    // animation's global time) via `timeRemapping` or a custom `startTime`
+    // animation's global time) via `timeRemapping` or a custom `startTime` / `timeStretch`
     let contextForChildren = context.withTimeRemapping { [preCompLayer, timeRemappingInterpolator] layerLocalFrame in
       if let timeRemappingInterpolator = timeRemappingInterpolator {
         return timeRemappingInterpolator.value(frame: layerLocalFrame) as? AnimationFrameTime ?? layerLocalFrame
       } else {
-        return layerLocalFrame + AnimationFrameTime(preCompLayer.startTime)
+        return (layerLocalFrame * AnimationFrameTime(preCompLayer.timeStretch)) + AnimationFrameTime(preCompLayer.startTime)
       }
     }
 

package/Sources/Private/CoreAnimation/Layers/ShapeLayer.swift

@@ -253,9 +253,9 @@ extension CALayer {
         pathForChildren.append(group.name)
       }
 
-      let childItems = group.items.map {
-        ShapeItemLayer.Item(item: $0, groupPath: pathForChildren)
-      }
+      let childItems = group.items
+        .filter { !$0.hidden }
+        .map { ShapeItemLayer.Item(item: $0, groupPath: pathForChildren) }
 
       return try GroupLayer(
         group: group,

package/Sources/Private/CoreAnimation/Layers/TextLayer.swift

@@ -36,6 +36,21 @@ final class TextLayer: BaseCompositionLayer {
 
   // MARK: Internal
 
+  override func setupAnimations(context: LayerAnimationContext) throws {
+    try super.setupAnimations(context: context)
+    let textAnimationContext = context.addingKeypathComponent(textLayerModel.name)
+
+    let sourceText = try textLayerModel.text.exactlyOneKeyframe(
+      context: textAnimationContext,
+      description: "text layer text")
+
+    renderLayer.text = context.textProvider.textFor(
+      keypathName: textAnimationContext.currentKeypath.fullPath,
+      sourceText: sourceText.text)
+
+    renderLayer.sizeToFit()
+  }
+
   func configureRenderLayer(with context: LayerContext) throws {
     // We can't use `CATextLayer`, because it doesn't support enough features we use.
     // Instead, we use the same `CoreTextRenderLayer` (with a custom `draw` implementation)
@@ -54,7 +69,6 @@ final class TextLayer: BaseCompositionLayer {
         """)
     }
 
-    renderLayer.text = text.text
     renderLayer.font = context.fontProvider.fontFor(family: text.fontFamily, size: CGFloat(text.fontSize))
 
     renderLayer.alignment = text.justification.textAlignment

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderNodes/GradientStrokeNode.swift

@@ -140,7 +140,7 @@ final class GradientStrokeNode: AnimatorNode, RenderNode {
 
     /// Get dash lengths
     let dashLengths = strokeProperties.dashPattern.value.map { $0.cgFloatValue }
-    if dashLengths.count > 0, !dashLengths.allSatisfy({ $0.isZero }) {
+    if dashLengths.count > 0, dashLengths.isSupportedLayerDashPattern {
       strokeRender.strokeRender.dashPhase = strokeProperties.dashPhase.value.cgFloatValue
       strokeRender.strokeRender.dashLengths = dashLengths
     } else {

package/Sources/Private/MainThread/NodeRenderSystem/Nodes/RenderNodes/StrokeNode.swift

@@ -118,7 +118,7 @@ final class StrokeNode: AnimatorNode, RenderNode {
 
     /// Get dash lengths
     let dashLengths = strokeProperties.dashPattern.value.map { $0.cgFloatValue }
-    if dashLengths.count > 0, !dashLengths.allSatisfy({ $0.isZero }) {
+    if dashLengths.count > 0, dashLengths.isSupportedLayerDashPattern {
       strokeRender.dashPhase = strokeProperties.dashPhase.value.cgFloatValue
       strokeRender.dashLengths = dashLengths
     } else {
@@ -167,3 +167,14 @@ extension Array where Element == DashElement {
     return (dashPatterns, dashPhase)
   }
 }
+
+extension Array where Element == CGFloat {
+  // If all of the items in the dash pattern are zeros, then we shouldn't attempt to render it.
+  // This causes Core Animation to have extremely poor performance for some reason, even though
+  // it doesn't affect the appearance of the animation.
+  //  - We check for `== 0.01` instead of `== 0` because `dashPattern.shapeLayerConfiguration`
+  //    converts all `0` values to `0.01` to work around a different Core Animation rendering issue.
+  var isSupportedLayerDashPattern: Bool {
+    !allSatisfy { $0 == 0.01 }
+  }
+}

package/Sources/Public/Animation/AnimationPublic.swift

@@ -172,13 +172,14 @@ extension Animation {
   ///
   public static func loadedFrom(
     url: URL,
+    session: URLSession = .shared,
     closure: @escaping Animation.DownloadClosure,
     animationCache: AnimationCacheProvider?)
   {
     if let animationCache = animationCache, let animation = animationCache.animation(forKey: url.absoluteString) {
       closure(animation)
     } else {
-      let task = URLSession.shared.dataTask(with: url) { data, _, error in
+      let task = session.dataTask(with: url) { data, _, error in
         guard error == nil, let jsonData = data else {
           DispatchQueue.main.async {
             closure(nil)

package/Sources/Public/Animation/AnimationView.swift

@@ -996,6 +996,7 @@ final public class AnimationView: AnimationViewBase {
       let coreAnimationLayer = try CoreAnimationLayer(
         animation: animation,
         imageProvider: imageProvider.cachedImageProvider,
+        textProvider: textProvider,
         fontProvider: fontProvider,
         compatibilityTrackerMode: .track,
         logger: logger)
@@ -1030,6 +1031,7 @@ final public class AnimationView: AnimationViewBase {
       let coreAnimationLayer = try CoreAnimationLayer(
         animation: animation,
         imageProvider: imageProvider.cachedImageProvider,
+        textProvider: textProvider,
         fontProvider: fontProvider,
         compatibilityTrackerMode: .abort,
         logger: logger)

package/Tests/AutomaticEngineTests.swift

@@ -19,6 +19,7 @@ final class AutomaticEngineTests: XCTestCase {
       let animationLayer = try XCTUnwrap(CoreAnimationLayer(
         animation: animation,
         imageProvider: BundleImageProvider(bundle: Bundle.main, searchPath: nil),
+        textProvider: DefaultTextProvider(),
         fontProvider: DefaultFontProvider(),
         compatibilityTrackerMode: .track,
         logger: .shared))

package/Tests/SnapshotConfiguration.swift

@@ -22,6 +22,9 @@ struct SnapshotConfiguration {
   /// A custom `AnimationImageProvider` to use when rendering this animation
   var customImageProvider: AnimationImageProvider?
 
+  /// A custom `AnimationTextProvider` to use when rendering this animation
+  var customTextProvider: AnimationTextProvider?
+
   /// A custom `AnimationFontProvider` to use when rendering this animation
   var customFontProvider: AnimationFontProvider?
 
@@ -44,7 +47,6 @@ extension SnapshotConfiguration {
     "Nonanimating/FirstText": .precision(0.99),
     "Nonanimating/verifyLineHeight": .precision(0.99),
     "Nonanimating/blend_mode_test": .precision(0.99),
-    "Issues/issue_885": .precision(0.99),
 
     /// Test cases for the `AnimationKeypath` / `AnyValueProvider` system
     "Nonanimating/keypathTest": .customValueProviders([
@@ -70,6 +72,9 @@ extension SnapshotConfiguration {
     // Test cases for `AnimatedImageProvider`
     "Nonanimating/_dog": .customImageProvider(HardcodedImageProvider(imageName: "Samples/Images/dog.png")),
 
+    // Test cases for `AnimatedTextProvider`
+    "Issues/issue_1722": .customTextProvider(HardcodedTextProvider(text: "Bounce-bounce")),
+
     // Test cases for `AnimationFontProvider`
     "Nonanimating/Text_Glyph": .customFontProvider(HardcodedFontProvider(font: UIFont(name: "Chalkduster", size: 36)!)),
 
@@ -128,6 +133,15 @@ extension SnapshotConfiguration {
     return configuration
   }
 
+  static func customTextProvider(
+    _ customTextProvider: AnimationTextProvider)
+    -> SnapshotConfiguration
+  {
+    var configuration = SnapshotConfiguration.default
+    configuration.customTextProvider = customTextProvider
+    return configuration
+  }
+
   /// A `SnapshotConfiguration` value using the given custom value providers
   static func customFontProvider(
     _ customFontProvider: AnimationFontProvider)

package/Tests/SnapshotTests.swift

@@ -256,6 +256,10 @@ extension SnapshotConfiguration {
       animationView.imageProvider = customImageProvider
     }
 
+    if let customTextProvider = snapshotConfiguration.customTextProvider {
+      animationView.textProvider = customTextProvider
+    }
+
     if let customFontProvider = snapshotConfiguration.customFontProvider {
       animationView.fontProvider = customFontProvider
     }

package/Tests/Utils/HardcodedTextProvider.swift

@@ -0,0 +1,27 @@
+// Created by Igor Katselenbogen on 08/19/22.
+// Copyright © 2022 Airbnb Inc. All rights reserved.
+
+import Lottie
+
+// MARK: - HardcodedTextProvider
+
+/// An `AnimationTextProvider` that always returns a specific hardcoded text
+class HardcodedTextProvider: AnimationTextProvider {
+
+  // MARK: Lifecycle
+
+  init(text: String) {
+    self.text = text
+  }
+
+  // MARK: Internal
+
+  func textFor(keypathName _: String, sourceText _: String) -> String {
+    text
+  }
+
+  // MARK: Private
+
+  private let text: String
+
+}

package/lottie-ios.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'lottie-ios'
-  s.version          = '3.4.2'
+  s.version          = '3.4.3'
   s.summary          = 'A library to render native animations from bodymovin json'
 
   s.description = <<-DESC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lottie-ios",
-  "version": "3.4.2",
+  "version": "3.4.3",
   "description": "Lottie is a mobile library for Android and iOS that parses Adobe After Effects animations exported as json with bodymovin and renders the vector animations natively on mobile and through React Native!",
   "main": "index.js",
   "scripts": {