Add Basic Windows & Linux Support (#184)

* Seems to compile and sort of run tests

* Fix a few more issues

* Fix naming and unneeded import

* Get CI a little further

* Use platform specific snapshots

* More snapshots

* Try again with non-Darwin

* Turns out we just need a darwin and non-darwin snapshots dir

* Fix header look up for client creation

* update ci configuration

* Skip problematic test on Windows and Linux

* Use a supported version of Swift for the linux CI

* Go back to specific folders for each platform, it's just easier to deal with

* Attempt to disable conversion and skip broken test

* Cleaning up the PR a little

* Add missing test files

* Update tests

* Address some PR feedback

* Recomment out test

* Drop down to see if using a Semaphore works across platforms

* Allow threading in a local storage client

* Remove defaults from designated initializer and put defaults in platform specific convenience inits

* Give linux a convenience init so tests can use it

* Remove default local storage

* Fix mock generation

* Remove old tests

* Remove autocanonicalization problems by making Apikey consistent casing.

* Re-record all snapshots to prevent auto-canonicalization issues across toolchains

* Turn on autocrlf to see if that gets the test snapshots further

* fix line endings for snapshots

* fix initializer

* Remove unneeded testing workaround

* Update tests to use empty response where needed

* Fix empty implementation to work across platforms

* Fix test that breaks to only run if not Windows or Linux

* use correct operator

* Fix binary packaging

* Use URLs and remove convenience

* Fix cancellation

* fix example

* Fix actuallyCancel logic

Author: brianmichel

.gitattributes

@@ -0,0 +1 @@
+/Tests/**/__Snapshots__/**/*.txt eol=lf

.github/workflows/ci.yml

@@ -14,9 +14,9 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  library:
+  library-darwin:
     runs-on: macos-13
-    name: Test Library
+    name: Test Library (Darwin)
     steps:
       - uses: actions/checkout@v3
       - name: Select Xcode 15.0.1
@@ -25,7 +25,7 @@ jobs:
         run: make test-library
 
   library-evolution:
-    name: Library (evolution)
+    name: Library (evolution, Darwin)
     runs-on: macos-13
     steps:
       - uses: actions/checkout@v4
@@ -34,6 +34,33 @@ jobs:
       - name: Build for library evolution
         run: make build-for-library-evolution
 
+  library-linux:
+    runs-on: ubuntu-latest
+    name: Test Library (Linux)
+    steps:
+      - uses: swift-actions/setup-swift@v1
+        with:
+          swift-version: "5.9"
+      - uses: actions/checkout@v3
+      - name: Run Tests
+        run: swift test
+
+  library-windows:
+      runs-on: windows-latest
+      name: Test Library (Windows)
+      steps:
+        # We use BCNY's repo since they have newer builds of Swift
+        # which have fixed libcurl in Foundation.
+        - uses: compnerd/gha-setup-swift@main
+          with:
+            release-tag-name: "20231203.0"
+            github-repo: "thebrowsercompany/swift-build"
+            release-asset-name: installer-amd64.exe
+            github-token: ${{ secrets.GITHUB_TOKEN }}
+        - uses: actions/checkout@v3
+        - name: Run Tests
+          run: swift test
+
   examples:
     runs-on: macos-13
     name: Build Examples
@@ -45,4 +72,3 @@ jobs:
         run: cp Examples/Examples/_Secrets.swift Examples/Examples/Secrets.swift
       - name: Build examples
         run: make build-examples
-        

.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "cSpell.words": [
+    "apikey",
+    "HTTPURL",
+    "pkce",
+    "postgrest",
+    "preconcurrency",
+    "Supabase",
+    "whitespaces",
+    "xctest"
+  ]
+}

Examples/Examples/ExamplesApp.swift

@@ -20,5 +20,6 @@ struct ExamplesApp: App {
 
 let supabase = SupabaseClient(
   supabaseURL: Secrets.supabaseURL,
-  supabaseKey: Secrets.supabaseAnonKey
+  supabaseKey: Secrets.supabaseAnonKey,
+  options: .init(auth: .init(storage: KeychainLocalStorage(service: "supabase.gotrue.swift", accessGroup: nil)))
 )

Examples/UserManagement/Supabase.swift

@@ -9,6 +9,7 @@ import Foundation
 import Supabase
 
 let supabase = SupabaseClient(
-  supabaseURL: "https://PROJECT_ID.supabase.co",
-  supabaseKey: "YOUR_SUPABASE_ANON_KEY"
+  supabaseURL: URL(string: "https://PROJECT_ID.supabase.co")!,
+  supabaseKey: "YOUR_SUPABASE_ANON_KEY",
+  options: .init(auth: .init(storage: KeychainLocalStorage(service: "supabase.gotrue.swift", accessGroup: nil)))
 )

Package.resolved

@@ -4,6 +4,28 @@
 import Foundation
 import PackageDescription
 
+var dependencies: [Package.Dependency] = [
+  .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.8.1"),
+  .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.0.0"),
+  .package(url: "https://github.com/pointfreeco/swift-concurrency-extras", from: "1.0.0"),
+  .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "3.0.0"),
+]
+
+var goTrueDependencies: [Target.Dependency] = [
+  "_Helpers",
+  .product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
+  .product(name: "Crypto", package: "swift-crypto"),
+]
+
+#if !os(Windows) && !os(Linux)
+dependencies += [
+  .package(url: "https://github.com/kishikawakatsumi/KeychainAccess", from: "4.2.2"),
+]
+goTrueDependencies += [
+  .product(name: "KeychainAccess", package: "KeychainAccess"),
+]
+#endif
+
 let package = Package(
   name: "Supabase",
   platforms: [
@@ -24,12 +46,7 @@ let package = Package(
       targets: ["Supabase", "Functions", "PostgREST", "Auth", "Realtime", "Storage"]
     ),
   ],
-  dependencies: [
-    .package(url: "https://github.com/kishikawakatsumi/KeychainAccess", from: "4.2.2"),
-    .package(url: "https://github.com/pointfreeco/swift-snapshot-testing", from: "1.8.1"),
-    .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "1.0.0"),
-    .package(url: "https://github.com/pointfreeco/swift-concurrency-extras", from: "1.0.0"),
-  ],
+  dependencies: dependencies,
   targets: [
     .target(
       name: "_Helpers",
@@ -47,16 +64,13 @@ let package = Package(
     ),
     .target(
       name: "Auth",
-      dependencies: [
-        "_Helpers",
-        .product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
-        .product(name: "KeychainAccess", package: "KeychainAccess"),
-      ]
+      dependencies: goTrueDependencies
     ),
     .testTarget(
       name: "AuthTests",
       dependencies: [
         "Auth",
+        "_Helpers",
         .product(name: "SnapshotTesting", package: "swift-snapshot-testing"),
         .product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
       ],

Package.swift

@@ -34,7 +34,7 @@ public actor AuthClient {
       url: URL,
       headers: [String: String] = [:],
       flowType: AuthFlowType = Configuration.defaultFlowType,
-      localStorage: AuthLocalStorage = Configuration.defaultLocalStorage,
+      localStorage: AuthLocalStorage,
       encoder: JSONEncoder = AuthClient.Configuration.jsonEncoder,
       decoder: JSONDecoder = AuthClient.Configuration.jsonDecoder,
       fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) }
@@ -101,7 +101,7 @@ public actor AuthClient {
     url: URL,
     headers: [String: String] = [:],
     flowType: AuthFlowType = AuthClient.Configuration.defaultFlowType,
-    localStorage: AuthLocalStorage = AuthClient.Configuration.defaultLocalStorage,
+    localStorage: AuthLocalStorage,
     encoder: JSONEncoder = AuthClient.Configuration.jsonEncoder,
     decoder: JSONDecoder = AuthClient.Configuration.jsonDecoder,
     fetch: @escaping FetchHandler = { try await URLSession.shared.data(for: $0) }

Sources/Auth/AuthClient.swift

@@ -62,10 +62,4 @@ extension AuthClient.Configuration {
 
   /// The default ``AuthFlowType`` used when initializing a ``AuthClient`` instance.
   public static let defaultFlowType: AuthFlowType = .pkce
-
-  /// The default ``AuthLocalStorage`` instance used by the ``AuthClient``.
-  public static let defaultLocalStorage: AuthLocalStorage = KeychainLocalStorage(
-    service: "supabase.gotrue.swift",
-    accessGroup: nil
-  )
 }