fix: linux build (#350)

* fix: linux build * fix: add missing callback version of receive method * fix: conditionally import AuthenticationSevices * ci: run only AuthTests * add make dot-env step * Fix tests in linux * chore: add supported platforms in README * Update README.md * ci: add linux job to all workflows
supabase · Apr 22, 2024 · e62ad89 · e62ad89
1 parent dfe09bc
commit e62ad89
Show file tree

Hide file tree

Showing 11 changed files with 245 additions and 96 deletions.
diff --git a/.github/workflows/auth.yml b/.github/workflows/auth.yml
@@ -40,3 +40,21 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_15.3.app
       - name: Run tests
         run: PLATFORM="${{ matrix.platform }}" SCHEME=Auth make test-library
+
+  test-linux:
+    name: Test Auth (Linux)
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version: ["5.9", "5.10"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-deptch: 0
+      - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: ${{ matrix.swift-version }}
+      - run: make dot-env
+      - name: Run tests
+        run: swift test --filter AuthTests.
diff --git a/.github/workflows/functions.yml b/.github/workflows/functions.yml
@@ -40,3 +40,20 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_15.3.app
       - name: Run tests
         run: PLATFORM="${{ matrix.platform }}" SCHEME=Functions make test-library
+  test-linux:
+    name: Test Functions (Linux)
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version: ["5.9", "5.10"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-deptch: 0
+      - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: ${{ matrix.swift-version }}
+      - run: make dot-env
+      - name: Run tests
+        run: swift test --filter FunctionsTests.
diff --git a/.github/workflows/postgrest.yml b/.github/workflows/postgrest.yml
@@ -40,3 +40,20 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_15.3.app
       - name: Run tests
         run: PLATFORM="${{ matrix.platform }}" SCHEME=PostgREST make test-library
+  test-linux:
+    name: Test Postgrest (Linux)
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version: ["5.9", "5.10"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-deptch: 0
+      - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: ${{ matrix.swift-version }}
+      - run: make dot-env
+      - name: Run tests
+        run: swift test --filter PostgRESTTests.
diff --git a/.github/workflows/realtime.yml b/.github/workflows/realtime.yml
@@ -40,3 +40,20 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_15.3.app
       - name: Run tests
         run: PLATFORM="${{ matrix.platform }}" SCHEME=Realtime make test-library
+  test-linux:
+    name: Test Realtime (Linux)
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version: ["5.9", "5.10"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-deptch: 0
+      - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: ${{ matrix.swift-version }}
+      - run: make dot-env
+      - name: Run tests
+        run: swift test --filter RealtimeTests.
diff --git a/.github/workflows/storage.yml b/.github/workflows/storage.yml
@@ -40,3 +40,20 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_15.3.app
       - name: Run tests
         run: PLATFORM="${{ matrix.platform }}" SCHEME=Storage make test-library
+  test-linux:
+    name: Test Storage (Linux)
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version: ["5.9", "5.10"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-deptch: 0
+      - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: ${{ matrix.swift-version }}
+      - run: make dot-env
+      - name: Run tests
+        run: swift test --filter StorageTests.
diff --git a/.github/workflows/supabase.yml b/.github/workflows/supabase.yml
@@ -40,3 +40,20 @@ jobs:
         run: sudo xcode-select -s /Applications/Xcode_15.3.app
       - name: Run tests
         run: PLATFORM="${{ matrix.platform }}" SCHEME=Supabase make test-library
+  test-linux:
+    name: Test Supabase (Linux)
+    strategy:
+      fail-fast: false
+      matrix:
+        swift-version: ["5.9", "5.10"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-deptch: 0
+      - uses: swift-actions/setup-swift@v2
+        with:
+          swift-version: ${{ matrix.swift-version }}
+      - run: make dot-env
+      - name: Run tests
+        run: swift test --filter SupabaseTests.
diff --git a/README.md b/README.md
@@ -6,6 +6,22 @@ Supabase client for swift. Mirrors the design of [supabase-js](https://github.co
 
 * Documentation: [https://supabase.com/docs/reference/swift/introduction](https://supabase.com/docs/reference/swift/introduction)
 
+## Supported Platforms
+
+| Platform | Support |
+|--------|--------|
+| iOS | ✅ |
+| macOS | ✅ |
+| watchOS | ✅ |
+| tvOS | ✅ |
+| visionOS | ✅ | 
+| Linux | ☑️ |
+| Windows | ☑️ |
+
+> ✅ Official support
+> 
+> ☑️ Works but not officially supported, and not guaranttee to keep working on future versions of the library.
+
 ## Usage
 
 Install the library using the Swift Package Manager.

diff --git a/Sources/Auth/AuthClient.swift b/Sources/Auth/AuthClient.swift
@@ -1,7 +1,10 @@
 import _Helpers
-import AuthenticationServices
 import Foundation
 
+#if canImport(AuthenticationServices)
+  import AuthenticationServices
+#endif
+
 #if canImport(FoundationNetworking)
   import FoundationNetworking
 #endif
@@ -652,75 +655,77 @@ public final class AuthClient: @unchecked Sendable {
     return try await session(from: resultURL)
   }
 
-  /// Sign-in an existing user via a third-party provider using ``ASWebAuthenticationSession``.
-  ///
-  /// - Parameters:
-  ///   - provider: The third-party provider.
-  ///   - redirectTo: A URL to send the user to after they are confirmed.
-  ///   - scopes: A space-separated list of scopes granted to the OAuth application.
-  ///   - queryParams: Additional query params.
-  ///   - configure: A configuration closure that you can use to customize the internal
-  /// ``ASWebAuthenticationSession`` object.
-  ///
-  /// - Note: This method support the PKCE flow.
-  /// - Warning: Do not call `start()` on the `ASWebAuthenticationSession` object inside the
-  /// `configure` closure, as the method implementation calls it already.
-  @available(watchOS 6.2, tvOS 16.0, *)
-  @discardableResult
-  public func signInWithOAuth(
-    provider: Provider,
-    redirectTo: URL? = nil,
-    scopes: String? = nil,
-    queryParams: [(name: String, value: String?)] = [],
-    configure: @Sendable (_ session: ASWebAuthenticationSession) -> Void = { _ in }
-  ) async throws -> Session {
-    try await signInWithOAuth(
-      provider: provider,
-      redirectTo: redirectTo,
-      scopes: scopes,
-      queryParams: queryParams
-    ) { @MainActor url in
-      try await withCheckedThrowingContinuation { continuation in
-        guard let callbackScheme = (configuration.redirectToURL ?? redirectTo)?.scheme else {
-          continuation.resume(throwing: AuthError.invalidRedirectScheme)
-          return
-        }
-
-        #if !os(tvOS) && !os(watchOS)
-          var presentationContextProvider: DefaultPresentationContextProvider?
-        #endif
-
-        let session = ASWebAuthenticationSession(
-          url: url,
-          callbackURLScheme: callbackScheme
-        ) { url, error in
-          if let error {
-            continuation.resume(throwing: error)
-          } else if let url {
-            continuation.resume(returning: url)
-          } else {
-            continuation.resume(throwing: AuthError.missingURL)
+  #if canImport(AuthenticationServices)
+    /// Sign-in an existing user via a third-party provider using ``ASWebAuthenticationSession``.
+    ///
+    /// - Parameters:
+    ///   - provider: The third-party provider.
+    ///   - redirectTo: A URL to send the user to after they are confirmed.
+    ///   - scopes: A space-separated list of scopes granted to the OAuth application.
+    ///   - queryParams: Additional query params.
+    ///   - configure: A configuration closure that you can use to customize the internal
+    /// ``ASWebAuthenticationSession`` object.
+    ///
+    /// - Note: This method support the PKCE flow.
+    /// - Warning: Do not call `start()` on the `ASWebAuthenticationSession` object inside the
+    /// `configure` closure, as the method implementation calls it already.
+    @available(watchOS 6.2, tvOS 16.0, *)
+    @discardableResult
+    public func signInWithOAuth(
+      provider: Provider,
+      redirectTo: URL? = nil,
+      scopes: String? = nil,
+      queryParams: [(name: String, value: String?)] = [],
+      configure: @Sendable (_ session: ASWebAuthenticationSession) -> Void = { _ in }
+    ) async throws -> Session {
+      try await signInWithOAuth(
+        provider: provider,
+        redirectTo: redirectTo,
+        scopes: scopes,
+        queryParams: queryParams
+      ) { @MainActor url in
+        try await withCheckedThrowingContinuation { continuation in
+          guard let callbackScheme = (configuration.redirectToURL ?? redirectTo)?.scheme else {
+            continuation.resume(throwing: AuthError.invalidRedirectScheme)
+            return
           }
 
           #if !os(tvOS) && !os(watchOS)
-            // Keep a strong reference to presentationContextProvider until the flow completes.
-            _ = presentationContextProvider
+            var presentationContextProvider: DefaultPresentationContextProvider?
           #endif
-        }
-
-        configure(session)
 
-        #if !os(tvOS) && !os(watchOS)
-          if session.presentationContextProvider == nil {
-            presentationContextProvider = DefaultPresentationContextProvider()
-            session.presentationContextProvider = presentationContextProvider
+          let session = ASWebAuthenticationSession(
+            url: url,
+            callbackURLScheme: callbackScheme
+          ) { url, error in
+            if let error {
+              continuation.resume(throwing: error)
+            } else if let url {
+              continuation.resume(returning: url)
+            } else {
+              continuation.resume(throwing: AuthError.missingURL)
+            }
+
+            #if !os(tvOS) && !os(watchOS)
+              // Keep a strong reference to presentationContextProvider until the flow completes.
+              _ = presentationContextProvider
+            #endif
           }
-        #endif
 
-        session.start()
+          configure(session)
+
+          #if !os(tvOS) && !os(watchOS)
+            if session.presentationContextProvider == nil {
+              presentationContextProvider = DefaultPresentationContextProvider()
+              session.presentationContextProvider = presentationContextProvider
+            }
+          #endif
+
+          session.start()
+        }
       }
     }
-  }
+  #endif
 
   /// Gets the session data from a OAuth2 callback URL.
   @discardableResult
@@ -1281,7 +1286,7 @@ extension AuthClient {
   public static let authChangeSessionInfoKey = "AuthClient.authChangeSession"
 }
 
-#if !os(tvOS) && !os(watchOS)
+#if canImport(AuthenticationServices) && !os(tvOS) && !os(watchOS)
   @MainActor
   final class DefaultPresentationContextProvider: NSObject,
     ASWebAuthenticationPresentationContextProviding

diff --git a/Sources/Realtime/V2/WebSocketClient.swift b/Sources/Realtime/V2/WebSocketClient.swift
@@ -215,3 +215,14 @@ final class SocketStream: AsyncSequence, Sendable {
     try await task.send(message)
   }
 }
+
+#if os(Linux) || os(Windows)
+  extension URLSessionWebSocketTask {
+    func receive(completionHandler: @Sendable @escaping (Result<URLSessionWebSocketTask.Message, any Error>) -> Void) {
+      Task {
+        let result = await Result(catching: { try await self.receive() })
+        completionHandler(result)
+      }
+    }
+  }
+#endif
diff --git a/Tests/AuthTests/AuthClientTests.swift b/Tests/AuthTests/AuthClientTests.swift
@@ -324,17 +324,18 @@ final class AuthClientTests: XCTestCase {
     XCTAssertEqual(emitReceivedEvents.value.map(\.0), [.signedIn])
   }
 
-  @available(watchOS 6.2, tvOS 16.0, *)
   func testSignInWithOAuthWithInvalidRedirecTo() async {
     let sut = makeSUT()
 
     do {
       try await sut.signInWithOAuth(
         provider: .google,
-        redirectTo: nil
-      ) { _ in
-        XCTFail("Should not call launchFlow.")
-      }
+        redirectTo: nil,
+        launchFlow: { _ in
+          XCTFail("Should not call launchFlow.")
+          return URL(string: "https://supabase.com")!
+        }
+      )
     } catch let error as AuthError {
       XCTAssertEqual(error, .invalidRedirectScheme)
     } catch {