Use Sendable instead of @unchecked Sendable on LottieAnimation

airbnb · Aug 2, 2023 · 347925e · 347925e
1 parent b3ffa3f
commit 347925e
Show file tree

Hide file tree

Showing 36 changed files with 77 additions and 44 deletions.
diff --git a/Lottie.xcodeproj/project.pbxproj b/Lottie.xcodeproj/project.pbxproj
@@ -3229,6 +3229,7 @@
 				MARKETING_VERSION = 1.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
+				OTHER_SWIFT_FLAGS = "-warnings-as-errors";
 				PRODUCT_BUNDLE_IDENTIFIER = com.airbnb.Lottie;
 				PRODUCT_NAME = Lottie;
 				SKIP_INSTALL = YES;
@@ -3262,6 +3263,7 @@
 				MARKETING_VERSION = 1.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
+				OTHER_SWIFT_FLAGS = "-warnings-as-errors";
 				PRODUCT_BUNDLE_IDENTIFIER = com.airbnb.Lottie;
 				PRODUCT_NAME = Lottie;
 				SKIP_INSTALL = YES;
@@ -3334,6 +3336,7 @@
 				MARKETING_VERSION = 1.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
+				OTHER_SWIFT_FLAGS = "-warnings-as-errors";
 				PRODUCT_BUNDLE_IDENTIFIER = com.airbnb.Lottie;
 				PRODUCT_NAME = Lottie;
 				SDKROOT = macosx;
@@ -3368,6 +3371,7 @@
 				MARKETING_VERSION = 1.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
+				OTHER_SWIFT_FLAGS = "-warnings-as-errors";
 				PRODUCT_BUNDLE_IDENTIFIER = com.airbnb.Lottie;
 				PRODUCT_NAME = Lottie;
 				SDKROOT = macosx;
@@ -3400,6 +3404,7 @@
 				MARKETING_VERSION = 1.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
+				OTHER_SWIFT_FLAGS = "-warnings-as-errors";
 				PRODUCT_BUNDLE_IDENTIFIER = com.airbnb.Lottie;
 				PRODUCT_NAME = Lottie;
 				SDKROOT = appletvos;
@@ -3434,6 +3439,7 @@
 				MARKETING_VERSION = 1.0;
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu11 gnu++17";
+				OTHER_SWIFT_FLAGS = "-warnings-as-errors";
 				PRODUCT_BUNDLE_IDENTIFIER = com.airbnb.Lottie;
 				PRODUCT_NAME = Lottie;
 				SDKROOT = appletvos;

diff --git a/Sources/Private/Model/Assets/Asset.swift b/Sources/Private/Model/Assets/Asset.swift
@@ -7,6 +7,8 @@
 
 import Foundation
 
+// MARK: - Asset
+
 public class Asset: Codable, DictionaryInitializable {
 
   // MARK: Lifecycle
@@ -41,3 +43,9 @@ public class Asset: Codable, DictionaryInitializable {
     case id
   }
 }
+
+// MARK: Sendable
+
+/// Since `Asset` isn't `final`, we have to use `@unchecked Sendable` instead of `Sendable.`
+/// All `Asset` subclasses are immutable `Sendable` values.
+extension Asset: @unchecked Sendable { }
diff --git a/Sources/Private/Model/Assets/AssetLibrary.swift b/Sources/Private/Model/Assets/AssetLibrary.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class AssetLibrary: Codable, AnyInitializable {
+final class AssetLibrary: Codable, AnyInitializable, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Assets/ImageAsset.swift b/Sources/Private/Model/Assets/ImageAsset.swift
@@ -9,7 +9,7 @@ import Foundation
 
 // MARK: - ImageAsset
 
-public final class ImageAsset: Asset {
+public final class ImageAsset: Asset, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Assets/PrecompAsset.swift b/Sources/Private/Model/Assets/PrecompAsset.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class PrecompAsset: Asset {
+final class PrecompAsset: Asset, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Keyframes/KeyframeGroup.swift b/Sources/Private/Model/Keyframes/KeyframeGroup.swift
@@ -203,6 +203,10 @@ extension KeyframeGroup: Hashable where T: Hashable {
   }
 }
 
+// MARK: Sendable
+
+extension KeyframeGroup: Sendable where T: Sendable { }
+
 extension Keyframe {
   /// Creates a copy of this `Keyframe` with the same timing data, but a different value
   func withValue<Value>(_ newValue: Value) -> Keyframe<Value> {

diff --git a/Sources/Private/Model/Layers/ImageLayerModel.swift b/Sources/Private/Model/Layers/ImageLayerModel.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A layer that holds an image.
-final class ImageLayerModel: LayerModel {
+final class ImageLayerModel: LayerModel, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Layers/LayerModel.swift b/Sources/Private/Model/Layers/LayerModel.swift
@@ -226,3 +226,9 @@ extension Array where Element == LayerModel {
     }
   }
 }
+
+// MARK: - LayerModel + Sendable
+
+/// Since `LayerModel` isn't `final`, we have to use `@unchecked Sendable` instead of `Sendable.`
+/// All `LayerModel` subclasses are immutable `Sendable` values.
+extension LayerModel: @unchecked Sendable { }
diff --git a/Sources/Private/Model/Layers/PreCompLayerModel.swift b/Sources/Private/Model/Layers/PreCompLayerModel.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A layer that holds another animation composition.
-final class PreCompLayerModel: LayerModel {
+final class PreCompLayerModel: LayerModel, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Layers/ShapeLayerModel.swift b/Sources/Private/Model/Layers/ShapeLayerModel.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A layer that holds vector shape objects.
-final class ShapeLayerModel: LayerModel {
+final class ShapeLayerModel: LayerModel, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Layers/SolidLayerModel.swift b/Sources/Private/Model/Layers/SolidLayerModel.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A layer that holds a solid color.
-final class SolidLayerModel: LayerModel {
+final class SolidLayerModel: LayerModel, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Layers/TextLayerModel.swift b/Sources/Private/Model/Layers/TextLayerModel.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A layer that holds text.
-final class TextLayerModel: LayerModel {
+final class TextLayerModel: LayerModel, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Objects/Marker.swift b/Sources/Private/Model/Objects/Marker.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A time marker
-final class Marker: Codable, DictionaryInitializable {
+final class Marker: Codable, Sendable, DictionaryInitializable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Ellipse.swift b/Sources/Private/Model/ShapeItems/Ellipse.swift
@@ -17,7 +17,7 @@ enum PathDirection: Int, Codable {
 
 // MARK: - Ellipse
 
-final class Ellipse: ShapeItem {
+final class Ellipse: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Fill.swift b/Sources/Private/Model/ShapeItems/Fill.swift
@@ -17,7 +17,7 @@ enum FillRule: Int, Codable {
 
 // MARK: - Fill
 
-final class Fill: ShapeItem {
+final class Fill: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/GradientFill.swift b/Sources/Private/Model/ShapeItems/GradientFill.swift
@@ -9,15 +9,15 @@ import Foundation
 
 // MARK: - GradientType
 
-enum GradientType: Int, Codable {
+enum GradientType: Int, Codable, Sendable {
   case none
   case linear
   case radial
 }
 
 // MARK: - GradientFill
 
-final class GradientFill: ShapeItem {
+final class GradientFill: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/GradientStroke.swift b/Sources/Private/Model/ShapeItems/GradientStroke.swift
@@ -9,7 +9,7 @@ import Foundation
 
 // MARK: - LineCap
 
-enum LineCap: Int, Codable {
+enum LineCap: Int, Codable, Sendable {
   case none
   case butt
   case round
@@ -18,7 +18,7 @@ enum LineCap: Int, Codable {
 
 // MARK: - LineJoin
 
-enum LineJoin: Int, Codable {
+enum LineJoin: Int, Codable, Sendable {
   case none
   case miter
   case round
@@ -27,7 +27,7 @@ enum LineJoin: Int, Codable {
 
 // MARK: - GradientStroke
 
-final class GradientStroke: ShapeItem {
+final class GradientStroke: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Group.swift b/Sources/Private/Model/ShapeItems/Group.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// An item that define a a group of shape items
-final class Group: ShapeItem {
+final class Group: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Merge.swift b/Sources/Private/Model/ShapeItems/Merge.swift
@@ -9,7 +9,7 @@ import Foundation
 
 // MARK: - MergeMode
 
-enum MergeMode: Int, Codable {
+enum MergeMode: Int, Codable, Sendable {
   case none
   case merge
   case add
@@ -20,7 +20,7 @@ enum MergeMode: Int, Codable {
 
 // MARK: - Merge
 
-final class Merge: ShapeItem {
+final class Merge: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Rectangle.swift b/Sources/Private/Model/ShapeItems/Rectangle.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class Rectangle: ShapeItem {
+final class Rectangle: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Repeater.swift b/Sources/Private/Model/ShapeItems/Repeater.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class Repeater: ShapeItem {
+final class Repeater: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/RoundedCorners.swift b/Sources/Private/Model/ShapeItems/RoundedCorners.swift
@@ -9,7 +9,7 @@ import Foundation
 
 // MARK: - RoundedCorners
 
-final class RoundedCorners: ShapeItem {
+final class RoundedCorners: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Shape.swift b/Sources/Private/Model/ShapeItems/Shape.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// An item that defines an custom shape
-final class Shape: ShapeItem {
+final class Shape: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/ShapeItem.swift b/Sources/Private/Model/ShapeItems/ShapeItem.swift
@@ -52,7 +52,7 @@ extension ShapeType: ClassFamily {
 
 // MARK: - ShapeType
 
-enum ShapeType: String, Codable {
+enum ShapeType: String, Codable, Sendable {
   case ellipse = "el"
   case fill = "fl"
   case gradientFill = "gf"
@@ -165,3 +165,9 @@ extension Array where Element == ShapeItem {
     }
   }
 }
+
+// MARK: - ShapeItem + Sendable
+
+/// Since `ShapeItem` isn't `final`, we have to use `@unchecked Sendable` instead of `Sendable.`
+/// All `ShapeItem` subclasses are immutable `Sendable` values.
+extension ShapeItem: @unchecked Sendable { }
diff --git a/Sources/Private/Model/ShapeItems/ShapeTransform.swift b/Sources/Private/Model/ShapeItems/ShapeTransform.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class ShapeTransform: ShapeItem {
+final class ShapeTransform: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Star.swift b/Sources/Private/Model/ShapeItems/Star.swift
@@ -9,15 +9,15 @@ import Foundation
 
 // MARK: - StarType
 
-enum StarType: Int, Codable {
+enum StarType: Int, Codable, Sendable {
   case none
   case star
   case polygon
 }
 
 // MARK: - Star
 
-final class Star: ShapeItem {
+final class Star: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Stroke.swift b/Sources/Private/Model/ShapeItems/Stroke.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class Stroke: ShapeItem {
+final class Stroke: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/ShapeItems/Trim.swift b/Sources/Private/Model/ShapeItems/Trim.swift
@@ -16,7 +16,7 @@ enum TrimType: Int, Codable {
 
 // MARK: - Trim
 
-final class Trim: ShapeItem {
+final class Trim: ShapeItem, Sendable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Text/Font.swift b/Sources/Private/Model/Text/Font.swift
@@ -9,7 +9,7 @@ import Foundation
 
 // MARK: - Font
 
-final class Font: Codable, DictionaryInitializable {
+final class Font: Codable, Sendable, DictionaryInitializable {
 
   // MARK: Lifecycle
 
@@ -41,7 +41,7 @@ final class Font: Codable, DictionaryInitializable {
 // MARK: - FontList
 
 /// A list of fonts
-final class FontList: Codable, DictionaryInitializable {
+final class FontList: Codable, Sendable, DictionaryInitializable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Model/Text/Glyph.swift b/Sources/Private/Model/Text/Glyph.swift
@@ -8,7 +8,7 @@
 import Foundation
 
 /// A model that holds a vector character
-final class Glyph: Codable, DictionaryInitializable {
+final class Glyph: Codable, Sendable, DictionaryInitializable {
 
   // MARK: Lifecycle
 

diff --git a/Sources/Private/Utility/Primitives/VectorsExtensions.swift b/Sources/Private/Utility/Primitives/VectorsExtensions.swift
@@ -69,7 +69,7 @@ extension Double {
 // MARK: - LottieVector2D
 
 /// Needed for decoding json {x: y:} to a CGPoint
-public struct LottieVector2D: Codable, Hashable {
+public struct LottieVector2D: Codable, Hashable, Sendable {
 
   // MARK: Lifecycle