Swift 6 Complete Concurrency Checking (#85)

Addressing: #54

# Swift6 - Complete Concurrency Checking

## ♻️ Current situation & Problem
Xcode is throwing concurrency warnings for the `SpeziLLM`,
`SpeziLLMFog`, `SpeziLLMLocal`, `SpeziLLMLocalDownload`, and
`SpeziLLMLocalOpenAI` targets because they currently have concurrency
concerns.

## ⚙️ Release Notes 
* Swift 6 - Enabling Complete Concurrency Checking using SwiftPM
* Warnings in `SpeziLLM`, `SpeziLLMFog`, `SpeziLLMLocal` and
`SpeziLLMLocalDownload` are resolved. For the remaining targets, it
would be best to wait until #64 is merged.


## 📚 Documentation
**No additional changes.**


## ✅ Testing
Warnings will be resolved after #64 is merged.


## 📝 Code of Conduct & Contributing Guidelines 

By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md):
- [x] I agree to follow the [Code of
Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).

---------

Co-authored-by: Philipp Zagar <[email protected]>

Author: jdisho

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.9
+// swift-tools-version:6.0
 
 //
 // This source file is part of the Stanford Spezi open source project

Sources/SpeziLLM/LLMPlatformState.swift

@@ -10,7 +10,7 @@
 /// Describes the current state of the ``LLMPlatform`` which is responsible for sending ``LLMSchema``s to execution via ``LLMSession``s.
 /// 
 /// The ``LLMPlatformState`` is quite minimal with only ``LLMPlatformState/idle`` and ``LLMPlatformState/processing`` states.
-public enum LLMPlatformState {
+public enum LLMPlatformState: Sendable {
     /// Indicates that the ``LLMPlatform`` is currently idle and doesn't execute any ``LLMSession``s.
     case idle
     /// Indicates that the ``LLMPlatform`` is currently processing and executing ``LLMSession``s.

Sources/SpeziLLM/LLMSessionProvider.swift

@@ -45,7 +45,7 @@ public struct _LLMSessionProvider<Schema: LLMSchema>: DynamicProperty {     // s
     }
 
     /// Creates a `Binding` to the ``LLMSession``that one can pass around. Useful for passing the ``LLMSession`` as a `Binding` to the ``LLMChatView``.
-    public var projectedValue: Binding<Schema.Platform.Session> {
+    @MainActor public var projectedValue: Binding<Schema.Platform.Session> {
         Binding {
             wrappedValue
         } set: {

Sources/SpeziLLM/Models/LLMContextEntity.swift

@@ -14,9 +14,9 @@ import Foundation
 /// A ``LLMContextEntity`` can be thought of as a single message entity within a ``LLMContext``
 /// It consists of a ``LLMContextEntity/Role``, a unique identifier, a timestamp in the form of a `Date` as well as an `String`-based ``LLMContextEntity/content`` property which can contain Markdown-formatted text.
 /// Furthermore, the ``LLMContextEntity/complete`` flag indicates if the current state of the ``LLMContextEntity`` is final and the content will not be updated anymore.
-public struct LLMContextEntity: Codable, Equatable, Hashable, Identifiable {
+public struct LLMContextEntity: Codable, Equatable, Hashable, Identifiable, Sendable {
     /// Represents a tool call by the LLM, including its parameters
-    public struct ToolCall: Codable, Equatable, Hashable {
+    public struct ToolCall: Codable, Equatable, Hashable, Sendable {
         /// The ID of the function call, uniquely identifying the specific function call and matching the response to it.
         public let id: String
         /// The name of the function call.
@@ -39,7 +39,7 @@ public struct LLMContextEntity: Codable, Equatable, Hashable, Identifiable {
     }
 
     /// Indicates which ``LLMContextEntity/Role`` is associated with a ``LLMContextEntity``.
-    public enum Role: Codable, Equatable, Hashable {
+    public enum Role: Codable, Equatable, Hashable, Sendable {
         case user
         case assistant(toolCalls: [ToolCall] = [])
         case system

Sources/SpeziLLM/Models/LLMState.swift

@@ -11,7 +11,7 @@ import Foundation
 /// Describes possible states that the ``LLMSession`` can be in.
 ///
 /// Based on the ``LLMState``, `SpeziLLM` performs proper actions on the model as well as state management.
-public enum LLMState: CustomStringConvertible, Equatable {
+public enum LLMState: CustomStringConvertible, Equatable, Sendable {
     /// The Spezi ``LLMSession`` is allocated, but the underlying model has not yet been initialized.
     case uninitialized
     /// The Spezi ``LLMSession`` is in the process of being initialized.

Sources/SpeziLLMFog/Connection/URLSession+CertVerification.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 import os
-import Security
+@preconcurrency import Security
 
 
 final class TransportCertificateValidationDelegate: NSObject, URLSessionDelegate {

Sources/SpeziLLMFog/LLMFogError.swift

@@ -112,13 +112,7 @@ public enum LLMFogError: LLMError {
 
 
 extension LLMFogSession {
-    private static let modelNotFoundRegex: Regex = {
-        guard let regex = try? Regex("model '([\\w:]+)' not found, try pulling it first") else {
-            preconditionFailure("SpeziLLMFog: Error Regex could not be parsed")
-        }
-
-        return regex
-    }()
+    private static let modelNotFoundRegex = "model '([\\w:]+)' not found, try pulling it first"
 
 
     func handleErrorCode(statusCode: Int, message: String?) -> LLMFogError {
@@ -128,7 +122,7 @@ extension LLMFogSession {
             return .invalidAPIToken
         case 404:
             if let message,
-               message.contains(Self.modelNotFoundRegex) {
+               message.range(of: Self.modelNotFoundRegex, options: .regularExpression) != nil {
                 LLMFogSession.logger.error("SpeziLLMFog: Model could not be accessed, ensure to pull it first on the Ollama fog node: \(message)")
                 return .modelAccessError(message)
             }

Sources/SpeziLLMLocal/LLMLocalSession+Generate.swift

@@ -9,7 +9,7 @@
 import Foundation
 import MLX
 import MLXLLM
-import MLXLMCommon
+@preconcurrency import MLXLMCommon
 import MLXRandom
 import os
 import SpeziChat

Sources/SpeziLLMLocalDownload/LLMLocalDownloadManager.swift

@@ -79,49 +79,53 @@ public final class LLMLocalDownloadManager: NSObject {
     }
 
     /// Starts a `URLSessionDownloadTask` to download the specified model.
+    @MainActor
     public func startDownload() async {
         if modelExist {
-            Task { @MainActor in
-                self.state = .downloaded
-            }
+            state = .downloaded
             return
         }
 
         await cancelDownload()
         downloadTask = Task(priority: .userInitiated) {
             do {
                 try await downloadWithHub()
-                await MainActor.run {
-                    self.state = .downloaded
-                }
+                state = .downloaded
             } catch {
-                await MainActor.run {
-                    self.state = .error(
-                        AnyLocalizedError(
-                            error: error,
-                            defaultErrorDescription: LocalizedStringResource("LLM_DOWNLOAD_FAILED_ERROR", bundle: .atURL(from: .module))
+                state = .error(
+                    AnyLocalizedError(
+                        error: error,
+                        defaultErrorDescription: LocalizedStringResource(
+                            "LLM_DOWNLOAD_FAILED_ERROR",
+                            bundle: .atURL(from: .module)
                         )
                     )
-                }
+                )
             }
         }
     }
 
     /// Cancels the download of a specified model via a `URLSessionDownloadTask`.
+    @MainActor
     public func cancelDownload() async {
         downloadTask?.cancel()
-        await MainActor.run {
-            self.state = .idle
-        }
+        state = .idle
     }
-    
-    @MainActor
+
     private func downloadWithHub() async throws {
+        // Sadly, we need this workaround to make the Swift compiler (strict concurrency checking) happy
+        @MainActor
+        func mutate(progress: Progress) {
+              self.state = .downloading(progress: progress)
+        }
+
         let repo = Hub.Repo(id: model.hubID)
         let modelFiles = ["*.safetensors", "config.json"]
 
         try await HubApi.shared.snapshot(from: repo, matching: modelFiles) { progress in
-            self.state = .downloading(progress: progress)
+            Task { @MainActor [mutate] in
+                mutate(progress)
+            }
         }
     }
 }

Sources/SpeziLLMOpenAI/FunctionCalling/LLMFunctionParameterWrapper+ArrayTypes.swift

@@ -38,14 +38,14 @@ extension _LLMFunctionParameterWrapper where T: AnyArray, T.Element: BinaryInteg
                 "description": String(description),
                 "items": [
                     "type": "integer",
-                    "const": const.map { String($0) } as Any?,
-                    "multipleOf": multipleOf as Any?,
-                    "minimum": minimum.map { Double($0) } as Any?,
-                    "maximum": maximum.map { Double($0) } as Any?
+                    "const": const.map { String($0) } as (any Sendable)?,
+                    "multipleOf": multipleOf as (any Sendable)?,
+                    "minimum": minimum.map { Double($0) } as (any Sendable)?,
+                    "maximum": maximum.map { Double($0) } as (any Sendable)?
                 ].compactMapValues { $0 },
-                "minItems": minItems as Any?,
-                "maxItems": maxItems as Any?,
-                "uniqueItems": uniqueItems as Any?
+                "minItems": minItems as (any Sendable)?,
+                "maxItems": maxItems as (any Sendable)?,
+                "uniqueItems": uniqueItems as (any Sendable)?
             ].compactMapValues { $0 }))
         } catch {
             preconditionFailure("SpeziLLMOpenAI: Failed to create validated function call schema definition of `LLMFunction/Parameter`: \(error)")
@@ -79,13 +79,13 @@ extension _LLMFunctionParameterWrapper where T: AnyArray, T.Element: BinaryFloat
                 "description": String(description),
                 "items": [
                     "type": "number",
-                    "const": const.map { String($0) } as Any?,
-                    "minimum": minimum.map { Double($0) } as Any?,
-                    "maximum": maximum.map { Double($0) } as Any?
+                    "const": const.map { String($0) } as (any Sendable)?,
+                    "minimum": minimum.map { Double($0) } as (any Sendable)?,
+                    "maximum": maximum.map { Double($0) } as (any Sendable)?
                 ].compactMapValues { $0 },
-                "minItems": minItems as Any?,
-                "maxItems": maxItems as Any?,
-                "uniqueItems": uniqueItems as Any?
+                "minItems": minItems as (any Sendable)?,
+                "maxItems": maxItems as (any Sendable)?,
+                "uniqueItems": uniqueItems as (any Sendable)?
             ].compactMapValues { $0 }))
         } catch {
             preconditionFailure("SpeziLLMOpenAI: Failed to create validated function call schema definition of `LLMFunction/Parameter`: \(error)")
@@ -115,11 +115,11 @@ extension _LLMFunctionParameterWrapper where T: AnyArray, T.Element == Bool {
                 "description": String(description),
                 "items": [
                     "type": "boolean",
-                    "const": const.map { String($0) } as Any?
+                    "const": const.map { String($0) } as (any Sendable)?
                 ].compactMapValues { $0 },
-                "minItems": minItems as Any?,
-                "maxItems": maxItems as Any?,
-                "uniqueItems": uniqueItems as Any?
+                "minItems": minItems as (any Sendable)?,
+                "maxItems": maxItems as (any Sendable)?,
+                "uniqueItems": uniqueItems as (any Sendable)?
             ].compactMapValues { $0 }))
         } catch {
             preconditionFailure("SpeziLLMOpenAI: Failed to create validated function call schema definition of `LLMFunction/Parameter`: \(error)")
@@ -153,13 +153,13 @@ extension _LLMFunctionParameterWrapper where T: AnyArray, T.Element: StringProto
                 "description": String(description),
                 "items": [
                     "type": "string",
-                    "pattern": pattern.map { String($0) } as Any?,
-                    "const": const.map { String($0) } as Any?,
-                    "enum": `enum`.map { $0.map { String($0) } } as Any?
+                    "pattern": pattern.map { String($0) } as (any Sendable)?,
+                    "const": const.map { String($0) } as (any Sendable)?,
+                    "enum": `enum`.map { $0.map { String($0) } } as (any Sendable)?
                 ].compactMapValues { $0 },
-                "minItems": minItems as Any?,
-                "maxItems": maxItems as Any?,
-                "uniqueItems": uniqueItems as Any?
+                "minItems": minItems as (any Sendable)?,
+                "maxItems": maxItems as (any Sendable)?,
+                "uniqueItems": uniqueItems as (any Sendable)?
             ].compactMapValues { $0 }))
         } catch {
             preconditionFailure("SpeziLLMOpenAI: Failed to create validated function call schema definition of `LLMFunction/Parameter`: \(error)")