Merge pull request #848 from kiwicom/847-concurrency-annotations

Add concurrency annotations

.github/workflows/ci.yml

@@ -7,11 +7,11 @@ on:
     branches: [ main ]
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_15.0.app/Contents/Developer
+  DEVELOPER_DIR: /Applications/Xcode_16.0.app/Contents/Developer
 
 jobs:
   build:
-    runs-on: macos-14
+    runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
     - name: Build

.github/workflows/publish-docc.yml

@@ -6,11 +6,11 @@ on:
   workflow_dispatch:
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_15.0.app/Contents/Developer
+  DEVELOPER_DIR: /Applications/Xcode_16.0.app/Contents/Developer
 
 jobs:
   documentation:
-    runs-on: macos-14
+    runs-on: macos-15
     steps:
     - uses: actions/checkout@v4
     - name: Generate DocC

.github/workflows/regenerate_snapshots.yml

@@ -10,11 +10,11 @@ on:
         required: true
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_15.0.app/Contents/Developer
+  DEVELOPER_DIR: /Applications/Xcode_16.0.app/Contents/Developer
 
 jobs:
   generate_snapshots:
-    runs-on: macos-14
+    runs-on: macos-15
     steps:
       - uses: actions/checkout@v4
         with:

Automation/update_country_flags.py

@@ -20,7 +20,7 @@
 
 source_template = source_header + '''public extension CountryFlag {{
 
-    enum CountryCode: String, CaseIterable {{
+    enum CountryCode: String, CaseIterable, Sendable {{
 {cases}
     }}
 }}

Automation/update_icons.py

@@ -23,7 +23,7 @@
 
 source_template = source_header + '''public extension Icon {{
 
-    enum Symbol: CaseIterable, Equatable {{
+    enum Symbol: CaseIterable, Equatable, Sendable {{
 {cases}
 
         public var value: String {{
@@ -97,8 +97,8 @@ def iconsFolderPath():
 
         swift_icon_key = dots_to_camel_case(swift_icon_name)
         case_lines.append(f"        /// Orbit `{swift_icon_name}` icon symbol.\n        case {swift_icon_key}")
-        value_lines.append(f"                case .{swift_icon_key}: return \"{swift_value}\"")
-            
+        value_lines.append(f"                case .{swift_icon_key}: \"{swift_value}\"")
+
     updated_file_content = source_template.format(cases = '\n'.join(case_lines), values = '\n'.join(value_lines))
 
     with open(icons_swift_path, "w+") as source_file:

Sources/Orbit/Components/BadgeList.swift

@@ -148,7 +148,7 @@ public extension BadgeList where Icon == Orbit.Icon, Label == Text {
 // MARK: - Types
 
 /// A type of Orbit ``BadgeList``.
-public enum BadgeListType: Equatable, Hashable {
+public enum BadgeListType: Equatable, Hashable, Sendable {
     case neutral
     case status(_ status: Status?)
     // FIXME: Remove and use override modifiers

Sources/Orbit/Components/ButtonLink.swift

@@ -148,7 +148,7 @@ public extension ButtonLink where Label == Text, LeadingIcon == Orbit.Icon, Trai
 // MARK: - Types
 
 /// A predefined type of Orbit ``ButtonLink``.
-public enum ButtonLinkType: Equatable {
+public enum ButtonLinkType: Equatable, Sendable {
     case primary
     case critical
     case status(_ status: Status?)

Sources/Orbit/Components/Checkbox.swift

@@ -141,7 +141,7 @@ public extension Checkbox where Title == Text, Description == Text {
 // MARK: - Types
 
 /// A state of Orbit ``Checkbox``.
-public enum CheckboxState {
+public enum CheckboxState: Sendable {
     case normal
     case error
 }

Sources/Orbit/Components/ChoiceTile.swift

@@ -421,14 +421,14 @@ public extension ChoiceTile where Badge == Orbit.Badge<EmptyView, Text, EmptyVie
 // MARK: - Types
 
 /// Indicator used for Orbit ``ChoiceTile``.
-public enum ChoiceTileIndicator {
+public enum ChoiceTileIndicator: Sendable {
     case radio
     case checkbox
     case `switch`
 }
 
 /// Alignment variant of Orbit ``ChoiceTile``.
-public enum ChoiceTileAlignment {
+public enum ChoiceTileAlignment: Sendable {
     case `default`
     case center
 }

Sources/Orbit/Components/Heading.swift

@@ -150,7 +150,7 @@ public extension Heading {
 public extension Heading {
 
     /// Orbit ``Heading`` style that represents the default size and color of a title.
-    enum Style: Equatable {
+    enum Style: Equatable, Sendable {
         /// 28 pts.
         case title1
         /// 22 pts.

Sources/Orbit/Components/HorizontalScroll.swift

@@ -374,7 +374,7 @@ public struct HorizontalScroll<Content: View>: View {
 // MARK: - Types
 
 /// Width for all items used in Orbit ``HorizontalScroll``.
-public enum HorizontalScrollItemWidth {
+public enum HorizontalScrollItemWidth: Sendable {
     /// Width ratio calculated from the available container width.
     case ratio(CGFloat = 0.48, maxWidth: CGFloat? = Layout.readableMaxWidth - 270)
     /// Custom fixed width.

Sources/Orbit/Components/Icon.swift

@@ -180,7 +180,7 @@ public extension Icon {
 public extension Icon {
 
     /// Preferred Orbit ``Icon`` size in both dimensions. The actual size may differ based on icon content.
-    enum Size: Equatable {
+    enum Size: Equatable, Sendable {
         /// Size 16.
         case small
         /// Size 20.
@@ -210,7 +210,7 @@ public extension Icon {
 // MARK: - Private
 private extension Icon {
 
-    enum Content {
+    enum Content: Sendable {
         case symbol(Symbol)
         case sfSymbol(String)
 

Sources/Orbit/Components/ListChoice.swift

@@ -333,10 +333,10 @@ public extension ListChoice where Title == Text, Description == Text, Header ==
 // MARK: - Types
 
 /// Disclosure used in Orbit ``ListChoice``.
-public enum ListChoiceDisclosure: Equatable {
+public enum ListChoiceDisclosure: Equatable, Sendable {
 
     /// Orbit ``ListChoiceDisclosure`` button type.
-    public enum ButtonType {
+    public enum ButtonType: Sendable {
         case add
         case remove
     }

Sources/Orbit/Components/Radio.swift

@@ -141,7 +141,7 @@ public extension Radio where Title == Text, Description == Text {
 // MARK: - Types
 
 /// A state of Orbit ``Radio``.
-public enum RadioState {
+public enum RadioState: Sendable {
     case normal
     case error
 }

Sources/Orbit/Components/Skeleton.swift

@@ -102,9 +102,9 @@ public struct Skeleton: View {
 extension Skeleton {
 
     /// Orbit ``Skeleton`` shape and size preset.
-    public enum Preset {
-        
-        public enum Atomic {
+    public enum Preset: Sendable {
+
+        public enum Atomic: Sendable {
             case circle
             case rectangle
         }

Sources/Orbit/Components/Tile.swift

@@ -261,7 +261,8 @@ public extension Tile where Title == Heading, Description == Text, Icon == Orbit
 
 // MARK: - Types
 
-public enum TileDisclosure: Equatable {
+// FIXME: remove @unchecked if `LocalizedStringKey` becomes `Sendable`
+public enum TileDisclosure: Equatable, @unchecked Sendable {
     /// Icon with optional color override.
     case icon(Icon.Symbol, alignment: VerticalAlignment = .center)
     /// ButtonLink indicator.

Sources/Orbit/Foundation/Borders/BorderRadius.swift

@@ -3,7 +3,7 @@ import CoreGraphics
 /// Orbit predefined border radiuses.
 ///
 /// - Note: [Orbit.kiwi documentation](https://orbit.kiwi/foundation/border-radiuses/)
-public enum BorderRadius {
+public enum BorderRadius: Sendable {
     /// 2 pts border radius.
     public static let xxSmall: CGFloat = 2
     /// 3 pts border radius.

Sources/Orbit/Foundation/Borders/BorderWidth.swift

@@ -2,7 +2,7 @@ import CoreGraphics
 import UIKit
 
 /// Predefiend Orbit border widths.
-public enum BorderWidth {
+public enum BorderWidth: Sendable {
     /// 1 pixel border width.
     public static let hairline: CGFloat = 1.0 / UIScreen.main.scale
     /// 0.5 pt border width.

Sources/Orbit/Foundation/Colors/Gradients.swift

@@ -1,7 +1,7 @@
 import SwiftUI
 
 /// Predefined Orbit gradient styles.
-public enum Gradient {
+public enum Gradient: Sendable {
 
     case bundleBasic
     case bundleMedium

Sources/Orbit/Foundation/CountryFlags/CountryFlags.swift

@@ -2,7 +2,7 @@
 // Generated by 'Automation/update_country_flags.py'
 public extension CountryFlag {
 
-    enum CountryCode: String, CaseIterable {
+    enum CountryCode: String, CaseIterable, Sendable {
 
         /// Country code for Andorra
         case ad
@@ -633,6 +633,7 @@ public extension CountryFlag {
         /// Country code for Suriname
         case sr
 
+        /// Country code for South Sudan
         case ss
 
         /// Country code for São Tomé and Príncipe
@@ -641,6 +642,7 @@ public extension CountryFlag {
         /// Country code for El Salvador
         case sv
 
+        /// Country code for Saint Martin
         case sx
 
         /// Country code for Syria
@@ -743,6 +745,7 @@ public extension CountryFlag {
         /// Country code for Samoa
         case ws
 
+        /// Country code for Kosovo
         case xk
 
         /// Country code for Yemen

Sources/Orbit/Foundation/Elevations/Elevation.swift

@@ -3,7 +3,7 @@ import SwiftUI
 /// Predefined Orbit elevation that brings content closer to user.
 ///
 /// Elevation levels with higher numbers are usually visually closer to the user.
-public enum Elevation {
+public enum Elevation: Sendable {
     case level1
     case level2
     case level3
@@ -12,7 +12,7 @@ public enum Elevation {
 }
 
 /// A shape to use as a surface on which Orbit `elevation` is applied.
-public enum ElevationShape {
+public enum ElevationShape: Sendable {
     /// Elevation effect shape is based on provided content.
     ///
     /// To improve performance, the elevation can be applied on multiple views at once

Sources/Orbit/Foundation/Icons/Icons.swift

@@ -2,7 +2,7 @@
 // Generated by 'Automation/update_icons.py'
 public extension Icon {
 
-    enum Symbol: CaseIterable, Equatable {
+    enum Symbol: CaseIterable, Equatable, Sendable {
         /// Orbit `accommodation` icon symbol.
         case accommodation
         /// Orbit `accountCircle` icon symbol.

Sources/Orbit/Foundation/Spacing/Spacing.swift

@@ -3,7 +3,7 @@ import SwiftUI
 /// Predefined Orbit spacing to help making interface clear and easy to scan.
 ///
 /// - Note: [Orbit.kiwi documentation](https://orbit.kiwi/foundation/spacing/)
-public enum Spacing: CGFloat {
+public enum Spacing: CGFloat, Sendable {
     /// 2 pts.
     case xxxSmall = 2
     /// 4 pts.

Sources/Orbit/Foundation/Typography/Font.swift

@@ -11,7 +11,7 @@ public extension Font {
     static var fontSizeToLineHeightRatio: CGFloat = 1.3333
 
     /// Default Orbit fonts used for rendering text.
-    static var orbitFonts: [Font.Weight: URL?] = [
+    @MainActor static var orbitFonts: [Font.Weight: URL?] = [
         .ultraLight:    Bundle.orbit.url(forResource: "Circular20-Book", withExtension: "otf"),
         .thin:          Bundle.orbit.url(forResource: "Circular20-Book", withExtension: "otf"),
         .light:         Bundle.orbit.url(forResource: "Circular20-Book", withExtension: "otf"),
@@ -44,7 +44,7 @@ public extension Font {
     }
 
     /// Registers Orbit fonts set in the `Font.orbitFonts` property for use in all Orbit text components.
-    static func registerOrbitFonts() {
+    @MainActor static func registerOrbitFonts() {
         var registeredFonts: [URL: CGFont] = [:]
 
         for case let (weight, url?) in orbitFonts {

Sources/Orbit/Support/BindingSource.swift

@@ -6,6 +6,8 @@ public enum OptionalBindingSource<Value> {
     case state(Value)
 }
 
+extension OptionalBindingSource: Sendable where Value: Sendable {}
+
 /// A view that provides either a binding to its content or an internal state, based on provided ``OptionalBindingSource`` value.
 ///
 /// The binding can either be supplied, in which case it is used directly,

Sources/Orbit/Support/Components/TabStyle.swift

@@ -3,7 +3,7 @@ import SwiftUI
 /// Orbit ``Tabs`` style applied to the active tab.
 ///
 /// To apply a style, use the `activeTabStyle()` modifier.
-public enum TabStyle: Equatable {
+public enum TabStyle: Equatable, Sendable {
     case `default`
     case underlined(Color)
     case underlinedGradient(Orbit.Gradient)