Implementing cross-platform support by supporting Linux-friendly HTTP clients

.github/workflows/ci.yml

@@ -10,15 +10,29 @@ on:
     branches: [ "main" ]
 
 jobs:
-  build_and_test:
+  build_and_test_macos:
     runs-on: macos-latest
     steps:
-    - uses: swift-actions/setup-swift@v2
-      with:
-        swift-version: "6.0.1"
+    - uses: actions/checkout@v4
     - name: Get swift version
       run: swift --version
+    - name: Build
+      run: swift build -q
+    - name: Run tests
+      run: swift test -q
+
+  build_and_test_linux:
+    runs-on: ubuntu-latest
+    container:
+      image: swift:6.0.1-jammy
+    steps:
+    - name: Install dependencies
+      run: |
+        apt-get update
+        apt-get install -y curl git
     - uses: actions/checkout@v4
+    - name: Get swift version
+      run: swift --version
     - name: Build
       run: swift build -q
     - name: Run tests
@@ -33,7 +47,5 @@ jobs:
       uses: Homebrew/actions/setup-homebrew@master
     - name: Install swiftformat
       run: brew install swiftformat
-    - name: Run linter
-      run: swiftformat --config rules.swiftformat .
-    - name: Verify that `swiftformat --config rules.swiftformat .` did not change outputs (if it did, please re-run it and re-commit!)
-      run: git diff --exit-code
+    - name: Check formatting
+      run: swiftformat --config rules.swiftformat --lint .

Package.swift

@@ -16,11 +16,17 @@ let package = Package(
       name: "SwiftOpenAI",
       targets: ["SwiftOpenAI"]),
   ],
+  dependencies: [
+    .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.25.2"),
+  ],
   targets: [
     // Targets are the basic building blocks of a package, defining a module or a test suite.
     // Targets can depend on other targets in this package and products from dependencies.
     .target(
-      name: "SwiftOpenAI"),
+      name: "SwiftOpenAI",
+      dependencies: [
+        .product(name: "AsyncHTTPClient", package: "async-http-client", condition: .when(platforms: [.linux])),
+      ]),
     .testTarget(
       name: "SwiftOpenAITests",
       dependencies: ["SwiftOpenAI"]),

README.md

@@ -2,6 +2,9 @@
 <img width="1090" alt="repoOpenAI" src="https://github.com/jamesrochabrun/SwiftOpenAI/assets/5378604/51bc5736-a32f-4a9f-922e-209d950e28f7">
 
 ![iOS 15+](https://img.shields.io/badge/iOS-15%2B-blue.svg)
+![macOS 13+](https://img.shields.io/badge/macOS-13%2B-blue.svg)
+![watchOS 9+](https://img.shields.io/badge/watchOS-9%2B-blue.svg)
+![Linux](https://img.shields.io/badge/Linux-blue.svg)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
 [![swift-version](https://img.shields.io/badge/swift-5.9-brightgreen.svg)](https://github.com/apple/swift)
 [![swiftui-version](https://img.shields.io/badge/swiftui-brightgreen)](https://developer.apple.com/documentation/swiftui)
@@ -99,6 +102,14 @@ to stay on the bleeding edge.
 
 ## Compatibility
 
+### Platform Support
+
+SwiftOpenAI supports both Apple platforms and Linux.
+- **Apple platforms** include iOS 15+, macOS 13+, and watchOS 9+.
+- **Linux**: SwiftOpenAI on Linux uses AsyncHTTPClient to work around URLSession bugs in Apple's Foundation framework, and can be used with the [Vapor](https://vapor.codes/) server framework.
+
+### OpenAI-Compatible Providers
+
 SwiftOpenAI supports various providers that are OpenAI-compatible, including but not limited to:
 
 - [Azure OpenAI](#azure-openai)

Sources/OpenAI/AIProxy/AIProxyCertificatePinning.swift

@@ -4,7 +4,7 @@
 //
 //  Created by Lou Zell on 6/23/24.
 //
-
+#if !os(Linux)
 import Foundation
 import OSLog
 
@@ -181,3 +181,4 @@ private func getServerCert(secTrust: SecTrust) -> SecCertificate? {
     return SecTrustGetCertificateAtIndex(secTrust, 0)
   }
 }
+#endif

Sources/OpenAI/AIProxy/AIProxyService.swift

@@ -4,7 +4,7 @@
 //
 //  Created by Lou Zell on 3/27/24.
 //
-
+#if !os(Linux)
 import Foundation
 
 private let aiproxySecureDelegate = AIProxyCertificatePinningDelegate()
@@ -34,19 +34,20 @@ struct AIProxyService: OpenAIService {
     organizationID: String? = nil,
     debugEnabled: Bool)
   {
-    session = URLSession(
-      configuration: .default,
-      delegate: aiproxySecureDelegate,
-      delegateQueue: nil)
     decoder = JSONDecoder()
     self.partialKey = partialKey
     self.clientID = clientID
     self.organizationID = organizationID
     self.debugEnabled = debugEnabled
     openAIEnvironment = .init(baseURL: serviceURL ?? "https://api.aiproxy.pro", proxyPath: nil, version: "v1")
+    httpClient = URLSessionHTTPClientAdapter(
+      urlSession: URLSession(
+        configuration: .default,
+        delegate: aiproxySecureDelegate,
+        delegateQueue: nil))
   }
 
-  let session: URLSession
+  let httpClient: HTTPClient
   let decoder: JSONDecoder
   let openAIEnvironment: OpenAIEnvironment
 
@@ -1314,3 +1315,4 @@ struct AIProxyService: OpenAIService {
   private let organizationID: String?
 
 }
+#endif

Sources/OpenAI/AIProxy/Endpoint+AIProxy.swift

@@ -4,7 +4,7 @@
 //
 //  Created by Lou Zell on 3/26/24.
 //
-
+#if !os(Linux)
 import DeviceCheck
 import Foundation
 import OSLog
@@ -242,3 +242,4 @@ private func copy_mac_address() -> CFData? {
   return nil
 }
 #endif
+#endif

Sources/OpenAI/Azure/DefaultOpenAIAzureService.swift

@@ -6,16 +6,21 @@
 //
 
 import Foundation
+#if os(Linux)
+import FoundationNetworking
+#endif
+
+// MARK: - DefaultOpenAIAzureService
 
 final public class DefaultOpenAIAzureService: OpenAIService {
 
   public init(
     azureConfiguration: AzureOpenAIConfiguration,
-    urlSessionConfiguration: URLSessionConfiguration = .default,
+    httpClient: HTTPClient,
     decoder: JSONDecoder = .init(),
     debugEnabled: Bool)
   {
-    session = URLSession(configuration: urlSessionConfiguration)
+    self.httpClient = httpClient
     self.decoder = decoder
     openAIEnvironment = OpenAIEnvironment(
       baseURL: "https://\(azureConfiguration.resourceName)/openai.azure.com",
@@ -27,7 +32,7 @@ final public class DefaultOpenAIAzureService: OpenAIService {
     self.debugEnabled = debugEnabled
   }
 
-  public let session: URLSession
+  public let httpClient: HTTPClient
   public let decoder: JSONDecoder
   public let openAIEnvironment: OpenAIEnvironment
 

Sources/OpenAI/LocalModelService/LocalModelService.swift

@@ -14,11 +14,11 @@ struct LocalModelService: OpenAIService {
     baseURL: String,
     proxyPath: String? = nil,
     overrideVersion: String? = nil,
-    configuration: URLSessionConfiguration = .default,
+    httpClient: HTTPClient,
     decoder: JSONDecoder = .init(),
     debugEnabled: Bool)
   {
-    session = URLSession(configuration: configuration)
+    self.httpClient = httpClient
     self.decoder = decoder
     self.apiKey = apiKey
     openAIEnvironment = OpenAIEnvironment(baseURL: baseURL, proxyPath: proxyPath, version: overrideVersion ?? "v1")
@@ -49,7 +49,7 @@ struct LocalModelService: OpenAIService {
       "Currently, this API is not supported. We welcome and encourage contributions to our open-source project. Please consider opening an issue or submitting a pull request to add support for this feature.")
   }
 
-  let session: URLSession
+  let httpClient: HTTPClient
   let decoder: JSONDecoder
   let openAIEnvironment: OpenAIEnvironment