[BREAKING] Compile with Swift strict concurrency checking (#4)

* Add Sendable annotations

* Remove async methods on Repository

Turns out this wasn't safe because Repository isn't sendable, async methods are nonisolated, and therefore it required sending `self` across isolation domains.

* Update CHANGELOG.md

Author: bdewey

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.5.0]
+
+* **Breaking change** Fix strict Swift concurrency warnings. This required removing the `async` methods
+from `Repository` and making them be extensions on `AsyncThrowingStream` and `FetchProgressStream` instead.
+
 ## [0.4.0]
 
 * Add code to serialize Git connection settings

Sources/AsyncSwiftGit/BranchType.swift

@@ -4,7 +4,7 @@ import Clibgit2
 import Foundation
 
 /// A type of branch.
-public struct BranchType: OptionSet {
+public struct BranchType: OptionSet, Sendable {
   public var rawValue: UInt32
 
   public init(rawValue: UInt32) {

Sources/AsyncSwiftGit/CheckoutOptions.swift

@@ -37,7 +37,7 @@ final class CheckoutOptions {
   }
 }
 
-public struct CheckoutProgress: CustomStringConvertible {
+public struct CheckoutProgress: CustomStringConvertible, Sendable {
   public var path: String?
   public var completedSteps: Int
   public var totalSteps: Int

Sources/AsyncSwiftGit/ConflictError.swift

@@ -3,7 +3,7 @@
 import Foundation
 
 /// Thrown when two branches conflict.
-public struct ConflictError: Error, LocalizedError {
+public struct ConflictError: Error, LocalizedError, Sendable {
   public let conflictingPaths: [String]
 
   public var errorDescription: String? {

Sources/AsyncSwiftGit/Credentials.swift

@@ -10,7 +10,7 @@ private class Wrapper<T> {
   }
 }
 
-public enum Credentials {
+public enum Credentials: Sendable {
   case `default`
   case sshAgent
   case plaintext(username: String, password: String)

Sources/AsyncSwiftGit/FetchOptions.swift

@@ -4,7 +4,7 @@ import Clibgit2
 import Foundation
 
 /// A structure to report on fetching progress.
-public struct FetchProgress: Equatable {
+public struct FetchProgress: Equatable, Sendable {
   public let receivedObjects: Int
   public let indexedObjects: Int
   public let totalObjects: Int
@@ -25,7 +25,7 @@ public struct FetchProgress: Equatable {
   }
 }
 
-public enum FetchPruneOption {
+public enum FetchPruneOption: Sendable {
   case unspecified
   case prune
   case noPrune

Sources/AsyncSwiftGit/GitConnectionSettings.swift

@@ -13,14 +13,14 @@ public extension CodingUserInfoKey {
 /// You can determine if the contents of this type are valid for synchronization by using ``isValid``.
 ///
 /// If the type is valid, you can get ``Credentials`` for connection and a ``Signature`` for authoring commits.
-public struct GitConnectionSettings: Codable, Equatable {
-  public enum AuthenticationType: String, Codable {
+public struct GitConnectionSettings: Codable, Equatable, Sendable {
+  public enum AuthenticationType: String, Codable, Sendable {
     case usernamePassword = "https" // There are serialized versions of settings that called this "https"
     case ssh
     case none
   }
 
-  public struct SSHKeyPair: Codable, Equatable {
+  public struct SSHKeyPair: Codable, Equatable, Sendable {
     public var publicKey = ""
     public var privateKey = ""
 

Sources/AsyncSwiftGit/GitError.swift

@@ -4,7 +4,7 @@ import Clibgit2
 import Foundation
 
 /// Represents an error from an internal Clibgit2 API call.
-public struct GitError: Error, CustomStringConvertible, LocalizedError {
+public struct GitError: Error, CustomStringConvertible, LocalizedError, Sendable {
   /// The numeric error code from the Git API.
   public let errorCode: Int32
 

Sources/AsyncSwiftGit/ObjectID.swift

@@ -4,7 +4,7 @@ import Clibgit2
 import Foundation
 
 /// Make a `git_oid` more Swifty
-public struct ObjectID: CustomStringConvertible, Hashable {
+public struct ObjectID: CustomStringConvertible, Hashable, Sendable {
   init(_ oid: git_oid) {
     self.oid = oid
   }

Sources/AsyncSwiftGit/ObjectType.swift

@@ -4,7 +4,7 @@ import Clibgit2
 import Foundation
 
 /// Mirrors `git_object_t` to be a little more swift-y
-public enum ObjectType: Int32 {
+public enum ObjectType: Int32, Sendable {
   /// Object can be any of the following
   case any = -2
 

Sources/AsyncSwiftGit/PushOptions.swift

@@ -13,7 +13,7 @@ private extension Logger {
   }()
 }
 
-public enum PushProgress: Equatable {
+public enum PushProgress: Equatable, Sendable {
   case sideband(String)
   case push(current: Int, total: Int, bytes: Int)
 }

Sources/AsyncSwiftGit/Repository.swift

@@ -36,7 +36,7 @@ public protocol GitConflictResolver {
 }
 
 /// A value that represents progress towards a goal.
-public enum Progress<ProgressType, ResultType> {
+public enum Progress<ProgressType: Sendable, ResultType: Sendable>: Sendable {
   /// Progress towards the goal, storing the progress value.
   case progress(ProgressType)
 
@@ -512,25 +512,6 @@ public final class Repository {
     return resultStream
   }
 
-  @discardableResult
-  /// Fetch from a named remote, waiting until the fetch is 100% complete before returning.
-  /// - Parameters:
-  ///   - remote: The remote to fetch
-  ///   - credentials: Credentials to use for the fetch.
-  /// - returns: The reference name for default branch for the remote.
-  public func fetch(remote: String, credentials: Credentials = .default) async throws -> String? {
-    var defaultBranch: String!
-    for try await progress in fetchProgress(remote: remote, credentials: credentials) {
-      switch progress {
-      case .completed(let branch):
-        defaultBranch = branch
-      default:
-        break
-      }
-    }
-    return defaultBranch
-  }
-
   /// Creates an `AsyncThrowingStream` that reports on the progress of checking out a reference.
   /// - Parameters:
   ///   - referenceShorthand: The reference to checkout. This can be a shorthand name (e.g., `main`) and git will resolve it using precedence rules to a full reference (`refs/heads/main`).
@@ -607,13 +588,6 @@ public final class Repository {
     }
   }
 
-  public func checkout(
-    revspec: String,
-    checkoutStrategy: git_checkout_strategy_t = GIT_CHECKOUT_SAFE
-  ) async throws {
-    for try await _ in checkoutProgress(referenceShorthand: revspec, checkoutStrategy: checkoutStrategy) {}
-  }
-
   /// The current set of ``StatusEntry`` structs that represent the current status of all items in the repository.
   public var statusEntries: [StatusEntry] {
     get throws {
@@ -1349,6 +1323,35 @@ public final class Repository {
   }
 }
 
+public enum FetchError: Error {
+  /// There was an unexpected error: The fetch stream did not complete.
+  case unexpectedError
+}
+
+public extension Repository.FetchProgressStream {
+  @discardableResult
+  /// Fetch the entire contents of the stream and return the default branch name for the remote.
+  /// - returns: The reference name for default branch for the remote.
+  func fetchAll() async throws -> String? {
+    for try await progress in self {
+      switch progress {
+      case .completed(let branch):
+        return branch
+      default:
+        break
+      }
+    }
+    throw FetchError.unexpectedError
+  }
+}
+
+public extension AsyncThrowingStream {
+  /// Waits until the given stream completes.
+  func complete() async throws {
+    for try await _ in self {}
+  }
+}
+
 private func treeWalkCallback(root: UnsafePointer<Int8>?, entryPointer: OpaquePointer?, payload: UnsafeMutableRawPointer?) -> Int32 {
   guard let payload = payload, let entryPointer = entryPointer, let root = root else {
     return Repository.TreeWalkResult.continue.rawValue

Sources/AsyncSwiftGit/SerializedGitConnectionSettings.swift

@@ -4,7 +4,7 @@ import CryptoKit
 import Foundation
 
 /// Serialization container for ``GitConnectionSettings``
-public enum SerializedGitConnectionSettings: Codable {
+public enum SerializedGitConnectionSettings: Codable, Sendable {
   case plaintext(settings: GitConnectionSettings)
   case passwordProtected(data: Data)
 

Sources/AsyncSwiftGit/StatusEntry.swift

@@ -4,13 +4,13 @@ import Clibgit2
 import Foundation
 
 /// A status entry, providing the differences between the file as it exists in HEAD and the index, and providing the differences between the index and the working directory.
-public struct StatusEntry: Hashable {
+public struct StatusEntry: Hashable, Sendable {
   /// Status flags for a single file.
   ///
   /// A combination of these values will be returned to indicate the status of a file. Status compares the working directory, the index, and the current HEAD of the repository.
   /// The `GIT_STATUS_INDEX` set of flags represents the status of file in the index relative to the HEAD, and the `GIT_STATUS_WT` set of flags represent the status
   /// of the file in the working directory relative to the index.
-  public struct Status: RawRepresentable, OptionSet, Hashable {
+  public struct Status: RawRepresentable, OptionSet, Hashable, Sendable {
     public var rawValue: Int
 
     public init(rawValue: Int) {
@@ -42,7 +42,7 @@ public struct StatusEntry: Hashable {
   /// Represents names used for an entry in a pair of locations in the repository.
   ///
   /// Example locations include `HEAD` (what's been committed), ``Index`` (what is staged to be committed), and the working directory.
-  public enum PathPair: Hashable {
+  public enum PathPair: Hashable, Sendable {
     /// The entry has different paths in the different locations.
     case renamed(oldPath: String, newPath: String)
 

Tests/AsyncSwiftGitTests/RepositoryTests.swift

@@ -67,7 +67,7 @@ final class RepositoryTests: XCTestCase {
     }
     let repository = try Repository(createAt: location, bare: false)
     try repository.addRemote("origin", url: URL(string: "https://github.com/bdewey/jubliant-happiness")!)
-    try await repository.fetch(remote: "origin")
+    try await repository.fetchProgress(remote: "origin").complete()
     for try await progress in repository.checkoutProgress(referenceShorthand: "origin/main") {
       print(progress)
     }
@@ -93,7 +93,7 @@ final class RepositoryTests: XCTestCase {
     let timeFromRepo = try repository.head!.commit.commitTime
     XCTAssertEqual(commitTime.timeIntervalSince1970, timeFromRepo.timeIntervalSince1970, accuracy: 1)
     try repository.addRemote("origin", url: URL(string: "https://github.com/bdewey/jubliant-happiness")!)
-    try await repository.fetch(remote: "origin")
+    try await repository.fetchProgress(remote: "origin").complete()
     var (ahead, behind) = try repository.commitsAheadBehind(other: "origin/main")
     XCTAssertEqual(ahead, 1)
     XCTAssertEqual(behind, 1)
@@ -135,7 +135,7 @@ final class RepositoryTests: XCTestCase {
       print("\(commit)")
       commitCount += 1
     }
-    XCTAssertEqual(commitCount, 9)
+    XCTAssertEqual(commitCount, 12)
   }
 
   func testTreeEnumeration() async throws {
@@ -217,7 +217,7 @@ final class RepositoryTests: XCTestCase {
     let clientRepository = try Repository(createAt: clientURL)
     let serverRepository = try Repository(createAt: serverURL)
     try clientRepository.addRemote("origin", url: serverURL)
-    try await clientRepository.fetch(remote: "origin")
+    try await clientRepository.fetchProgress(remote: "origin").complete()
     let initialTuple = try clientRepository.commitsAheadBehind(other: "origin/main")
     XCTAssertEqual(initialTuple.ahead, 0)
     XCTAssertEqual(initialTuple.behind, 0)
@@ -231,7 +231,7 @@ final class RepositoryTests: XCTestCase {
     try serverRepository.add()
     try serverRepository.commit(message: "test2", signature: Signature(name: "bkd", email: "[email protected]", time: Date()))
 
-    try await clientRepository.fetch(remote: "origin")
+    try await clientRepository.fetchProgress(remote: "origin").complete()
     let fetchedTuple = try clientRepository.commitsAheadBehind(other: "origin/main")
     XCTAssertEqual(fetchedTuple.ahead, 0)
     XCTAssertEqual(fetchedTuple.behind, 2)