Enable swift-format soundness check, run swift-format on whole project (#133)

Author: adam-fowler

.github/workflows/soundness.yml

@@ -13,4 +13,3 @@ jobs:
       docs_check_container_image: swift:latest
       unacceptable_language_check_enabled: false  # Valkey commands contain unacceptable language
       license_header_check_enabled: false  # Temporarily disable
-      format_check_enabled: false  # Temporarily disable

Package.swift

@@ -100,7 +100,7 @@ let package = Package(
 
 if ProcessInfo.processInfo.environment["ENABLE_VALKEY_BENCHMARKS"] != nil {
     package.dependencies.append(
-        .package(url: "https://github.com/ordo-one/package-benchmark", from: "1.0.0"),
+        .package(url: "https://github.com/ordo-one/package-benchmark", from: "1.0.0")
     )
     package.targets.append(
         .executableTarget(

Sources/Valkey/Cluster/ValkeyClusterClient.swift

@@ -135,8 +135,6 @@ public final class ValkeyClusterClient: Sendable {
         self.nodeDiscovery = nodeDiscovery
     }
 
-
-
     // MARK: - Public methods -
 
     /// Sends a command to the appropriate node in the Valkey cluster and returns the response.

Sources/Valkey/Commands/ConnectionCommands.swift

@@ -316,7 +316,15 @@ extension CLIENT {
         public var skipme: Skipme?
         public var maxage: Int?
 
-        @inlinable public init(clientType: ClientType? = nil, clientId: [Int] = [], username: String? = nil, addr: String? = nil, laddr: String? = nil, skipme: Skipme? = nil, maxage: Int? = nil) {
+        @inlinable public init(
+            clientType: ClientType? = nil,
+            clientId: [Int] = [],
+            username: String? = nil,
+            addr: String? = nil,
+            laddr: String? = nil,
+            skipme: Skipme? = nil,
+            maxage: Int? = nil
+        ) {
             self.clientType = clientType
             self.clientId = clientId
             self.username = username
@@ -327,7 +335,17 @@ extension CLIENT {
         }
 
         @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
-            commandEncoder.encodeArray("CLIENT", "LIST", RESPWithToken("TYPE", clientType), RESPWithToken("ID", clientId), RESPWithToken("USER", username), RESPWithToken("ADDR", addr), RESPWithToken("LADDR", laddr), RESPWithToken("SKIPME", skipme), RESPWithToken("MAXAGE", maxage))
+            commandEncoder.encodeArray(
+                "CLIENT",
+                "LIST",
+                RESPWithToken("TYPE", clientType),
+                RESPWithToken("ID", clientId),
+                RESPWithToken("USER", username),
+                RESPWithToken("ADDR", addr),
+                RESPWithToken("LADDR", laddr),
+                RESPWithToken("SKIPME", skipme),
+                RESPWithToken("MAXAGE", maxage)
+            )
         }
     }
 
@@ -525,7 +543,15 @@ extension CLIENT {
         public var optout: Bool
         public var noloop: Bool
 
-        @inlinable public init(status: Status, clientId: Int? = nil, prefix: [String] = [], bcast: Bool = false, optin: Bool = false, optout: Bool = false, noloop: Bool = false) {
+        @inlinable public init(
+            status: Status,
+            clientId: Int? = nil,
+            prefix: [String] = [],
+            bcast: Bool = false,
+            optin: Bool = false,
+            optout: Bool = false,
+            noloop: Bool = false
+        ) {
             self.status = status
             self.clientId = clientId
             self.prefix = prefix
@@ -536,7 +562,17 @@ extension CLIENT {
         }
 
         @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
-            commandEncoder.encodeArray("CLIENT", "TRACKING", status, RESPWithToken("REDIRECT", clientId), RESPWithToken("PREFIX", prefix), RESPPureToken("BCAST", bcast), RESPPureToken("OPTIN", optin), RESPPureToken("OPTOUT", optout), RESPPureToken("NOLOOP", noloop))
+            commandEncoder.encodeArray(
+                "CLIENT",
+                "TRACKING",
+                status,
+                RESPWithToken("REDIRECT", clientId),
+                RESPWithToken("PREFIX", prefix),
+                RESPPureToken("BCAST", bcast),
+                RESPPureToken("OPTIN", optin),
+                RESPPureToken("OPTOUT", optout),
+                RESPPureToken("NOLOOP", noloop)
+            )
         }
     }
 
@@ -904,8 +940,26 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of client connections
     /// - Response: [String]: Information and statistics about client connections
     @inlinable
-    public func clientList(clientType: CLIENT.LIST.ClientType? = nil, clientId: [Int] = [], username: String? = nil, addr: String? = nil, laddr: String? = nil, skipme: CLIENT.LIST.Skipme? = nil, maxage: Int? = nil) async throws -> ByteBuffer {
-        try await send(command: CLIENT.LIST(clientType: clientType, clientId: clientId, username: username, addr: addr, laddr: laddr, skipme: skipme, maxage: maxage))
+    public func clientList(
+        clientType: CLIENT.LIST.ClientType? = nil,
+        clientId: [Int] = [],
+        username: String? = nil,
+        addr: String? = nil,
+        laddr: String? = nil,
+        skipme: CLIENT.LIST.Skipme? = nil,
+        maxage: Int? = nil
+    ) async throws -> ByteBuffer {
+        try await send(
+            command: CLIENT.LIST(
+                clientType: clientType,
+                clientId: clientId,
+                username: username,
+                addr: addr,
+                laddr: laddr,
+                skipme: skipme,
+                maxage: maxage
+            )
+        )
     }
 
     /// Sets the client eviction mode of the connection.
@@ -978,8 +1032,18 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1). Some options may introduce additional complexity.
     /// - Response: "OK": If the client was successfully put into or taken out of tracking mode.
     @inlinable
-    public func clientTracking(status: CLIENT.TRACKING.Status, clientId: Int? = nil, prefix: [String] = [], bcast: Bool = false, optin: Bool = false, optout: Bool = false, noloop: Bool = false) async throws {
-        _ = try await send(command: CLIENT.TRACKING(status: status, clientId: clientId, prefix: prefix, bcast: bcast, optin: optin, optout: optout, noloop: noloop))
+    public func clientTracking(
+        status: CLIENT.TRACKING.Status,
+        clientId: Int? = nil,
+        prefix: [String] = [],
+        bcast: Bool = false,
+        optin: Bool = false,
+        optout: Bool = false,
+        noloop: Bool = false
+    ) async throws {
+        _ = try await send(
+            command: CLIENT.TRACKING(status: status, clientId: clientId, prefix: prefix, bcast: bcast, optin: optin, optout: optout, noloop: noloop)
+        )
     }
 
     /// Returns information about server-assisted client-side caching for the connection.

Sources/Valkey/Commands/GenericCommands.swift

@@ -397,7 +397,17 @@ public struct MIGRATE<Host: RESPStringRenderable>: ValkeyCommand {
     public var authentication: Authentication?
     public var keys: [ValkeyKey]
 
-    @inlinable public init(host: Host, port: Int, keySelector: KeySelector, destinationDb: Int, timeout: Int, copy: Bool = false, replace: Bool = false, authentication: Authentication? = nil, keys: [ValkeyKey] = []) {
+    @inlinable public init(
+        host: Host,
+        port: Int,
+        keySelector: KeySelector,
+        destinationDb: Int,
+        timeout: Int,
+        copy: Bool = false,
+        replace: Bool = false,
+        authentication: Authentication? = nil,
+        keys: [ValkeyKey] = []
+    ) {
         self.host = host
         self.port = port
         self.keySelector = keySelector
@@ -412,7 +422,18 @@ public struct MIGRATE<Host: RESPStringRenderable>: ValkeyCommand {
     public var keysAffected: [ValkeyKey] { keys }
 
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
-        commandEncoder.encodeArray("MIGRATE", RESPBulkString(host), port, keySelector, destinationDb, timeout, RESPPureToken("COPY", copy), RESPPureToken("REPLACE", replace), authentication, RESPWithToken("KEYS", keys))
+        commandEncoder.encodeArray(
+            "MIGRATE",
+            RESPBulkString(host),
+            port,
+            keySelector,
+            destinationDb,
+            timeout,
+            RESPPureToken("COPY", copy),
+            RESPPureToken("REPLACE", replace),
+            authentication,
+            RESPWithToken("KEYS", keys)
+        )
     }
 }
 
@@ -640,7 +661,15 @@ public struct RESTORE<SerializedValue: RESPStringRenderable>: ValkeyCommand {
     public var seconds: Int?
     public var frequency: Int?
 
-    @inlinable public init(key: ValkeyKey, ttl: Int, serializedValue: SerializedValue, replace: Bool = false, absttl: Bool = false, seconds: Int? = nil, frequency: Int? = nil) {
+    @inlinable public init(
+        key: ValkeyKey,
+        ttl: Int,
+        serializedValue: SerializedValue,
+        replace: Bool = false,
+        absttl: Bool = false,
+        seconds: Int? = nil,
+        frequency: Int? = nil
+    ) {
         self.key = key
         self.ttl = ttl
         self.serializedValue = serializedValue
@@ -653,7 +682,16 @@ public struct RESTORE<SerializedValue: RESPStringRenderable>: ValkeyCommand {
     public var keysAffected: CollectionOfOne<ValkeyKey> { .init(key) }
 
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
-        commandEncoder.encodeArray("RESTORE", key, ttl, RESPBulkString(serializedValue), RESPPureToken("REPLACE", replace), RESPPureToken("ABSTTL", absttl), RESPWithToken("IDLETIME", seconds), RESPWithToken("FREQ", frequency))
+        commandEncoder.encodeArray(
+            "RESTORE",
+            key,
+            ttl,
+            RESPBulkString(serializedValue),
+            RESPPureToken("REPLACE", replace),
+            RESPPureToken("ABSTTL", absttl),
+            RESPWithToken("IDLETIME", seconds),
+            RESPWithToken("FREQ", frequency)
+        )
     }
 }
 
@@ -727,7 +765,15 @@ public struct SORT: ValkeyCommand {
     public var sorting: Bool
     public var destination: ValkeyKey?
 
-    @inlinable public init(key: ValkeyKey, byPattern: String? = nil, limit: Limit? = nil, getPattern: [String] = [], order: Order? = nil, sorting: Bool = false, destination: ValkeyKey? = nil) {
+    @inlinable public init(
+        key: ValkeyKey,
+        byPattern: String? = nil,
+        limit: Limit? = nil,
+        getPattern: [String] = [],
+        order: Order? = nil,
+        sorting: Bool = false,
+        destination: ValkeyKey? = nil
+    ) {
         self.key = key
         self.byPattern = byPattern
         self.limit = limit
@@ -740,7 +786,16 @@ public struct SORT: ValkeyCommand {
     public var keysAffected: [ValkeyKey] { (destination.map { [$0] } ?? []) + [key] }
 
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
-        commandEncoder.encodeArray("SORT", key, RESPWithToken("BY", byPattern), RESPWithToken("LIMIT", limit), RESPWithToken("GET", getPattern), order, RESPPureToken("ALPHA", sorting), RESPWithToken("STORE", destination))
+        commandEncoder.encodeArray(
+            "SORT",
+            key,
+            RESPWithToken("BY", byPattern),
+            RESPWithToken("LIMIT", limit),
+            RESPWithToken("GET", getPattern),
+            order,
+            RESPPureToken("ALPHA", sorting),
+            RESPWithToken("STORE", destination)
+        )
     }
 }
 
@@ -791,7 +846,14 @@ public struct SORTRO: ValkeyCommand {
     public var order: Order?
     public var sorting: Bool
 
-    @inlinable public init(key: ValkeyKey, byPattern: String? = nil, limit: Limit? = nil, getPattern: [String] = [], order: Order? = nil, sorting: Bool = false) {
+    @inlinable public init(
+        key: ValkeyKey,
+        byPattern: String? = nil,
+        limit: Limit? = nil,
+        getPattern: [String] = [],
+        order: Order? = nil,
+        sorting: Bool = false
+    ) {
         self.key = key
         self.byPattern = byPattern
         self.limit = limit
@@ -805,7 +867,15 @@ public struct SORTRO: ValkeyCommand {
     public var isReadOnly: Bool { true }
 
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
-        commandEncoder.encodeArray("SORT_RO", key, RESPWithToken("BY", byPattern), RESPWithToken("LIMIT", limit), RESPWithToken("GET", getPattern), order, RESPPureToken("ALPHA", sorting))
+        commandEncoder.encodeArray(
+            "SORT_RO",
+            key,
+            RESPWithToken("BY", byPattern),
+            RESPWithToken("LIMIT", limit),
+            RESPWithToken("GET", getPattern),
+            order,
+            RESPPureToken("ALPHA", sorting)
+        )
     }
 }
 
@@ -1049,8 +1119,30 @@ extension ValkeyConnectionProtocol {
     ///     * "OK": Success.
     ///     * "NOKEY": No keys were found in the source instance.
     @inlinable
-    public func migrate<Host: RESPStringRenderable>(host: Host, port: Int, keySelector: MIGRATE<Host>.KeySelector, destinationDb: Int, timeout: Int, copy: Bool = false, replace: Bool = false, authentication: MIGRATE<Host>.Authentication? = nil, keys: [ValkeyKey] = []) async throws -> String? {
-        try await send(command: MIGRATE(host: host, port: port, keySelector: keySelector, destinationDb: destinationDb, timeout: timeout, copy: copy, replace: replace, authentication: authentication, keys: keys))
+    public func migrate<Host: RESPStringRenderable>(
+        host: Host,
+        port: Int,
+        keySelector: MIGRATE<Host>.KeySelector,
+        destinationDb: Int,
+        timeout: Int,
+        copy: Bool = false,
+        replace: Bool = false,
+        authentication: MIGRATE<Host>.Authentication? = nil,
+        keys: [ValkeyKey] = []
+    ) async throws -> String? {
+        try await send(
+            command: MIGRATE(
+                host: host,
+                port: port,
+                keySelector: keySelector,
+                destinationDb: destinationDb,
+                timeout: timeout,
+                copy: copy,
+                replace: replace,
+                authentication: authentication,
+                keys: keys
+            )
+        )
     }
 
     /// Moves a key to another database.
@@ -1244,8 +1336,26 @@ extension ValkeyConnectionProtocol {
     ///     * 5.0.0: Added the `IDLETIME` and `FREQ` options.
     /// - Complexity: O(1) to create the new key and additional O(N*M) to reconstruct the serialized value, where N is the number of objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1*M) where M is small, so simply O(1). However for sorted set values the complexity is O(N*M*log(N)) because inserting values into sorted sets is O(log(N)).
     @inlinable
-    public func restore<SerializedValue: RESPStringRenderable>(key: ValkeyKey, ttl: Int, serializedValue: SerializedValue, replace: Bool = false, absttl: Bool = false, seconds: Int? = nil, frequency: Int? = nil) async throws {
-        _ = try await send(command: RESTORE(key: key, ttl: ttl, serializedValue: serializedValue, replace: replace, absttl: absttl, seconds: seconds, frequency: frequency))
+    public func restore<SerializedValue: RESPStringRenderable>(
+        key: ValkeyKey,
+        ttl: Int,
+        serializedValue: SerializedValue,
+        replace: Bool = false,
+        absttl: Bool = false,
+        seconds: Int? = nil,
+        frequency: Int? = nil
+    ) async throws {
+        _ = try await send(
+            command: RESTORE(
+                key: key,
+                ttl: ttl,
+                serializedValue: serializedValue,
+                replace: replace,
+                absttl: absttl,
+                seconds: seconds,
+                frequency: frequency
+            )
+        )
     }
 
     /// Iterates over the key names in the database.
@@ -1270,8 +1380,26 @@ extension ValkeyConnectionProtocol {
     ///     * [Integer]: When the store option is specified the command returns the number of sorted elements in the destination list.
     ///     * [Array]: When not passing the store option the command returns a list of sorted elements.
     @inlinable
-    public func sort(key: ValkeyKey, byPattern: String? = nil, limit: SORT.Limit? = nil, getPattern: [String] = [], order: SORT.Order? = nil, sorting: Bool = false, destination: ValkeyKey? = nil) async throws -> SORT.Response {
-        try await send(command: SORT(key: key, byPattern: byPattern, limit: limit, getPattern: getPattern, order: order, sorting: sorting, destination: destination))
+    public func sort(
+        key: ValkeyKey,
+        byPattern: String? = nil,
+        limit: SORT.Limit? = nil,
+        getPattern: [String] = [],
+        order: SORT.Order? = nil,
+        sorting: Bool = false,
+        destination: ValkeyKey? = nil
+    ) async throws -> SORT.Response {
+        try await send(
+            command: SORT(
+                key: key,
+                byPattern: byPattern,
+                limit: limit,
+                getPattern: getPattern,
+                order: order,
+                sorting: sorting,
+                destination: destination
+            )
+        )
     }
 
     /// Returns the sorted elements of a list, a set, or a sorted set.
@@ -1281,7 +1409,14 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
     /// - Response: [Array]: A list of sorted elements.
     @inlinable
-    public func sortRo(key: ValkeyKey, byPattern: String? = nil, limit: SORTRO.Limit? = nil, getPattern: [String] = [], order: SORTRO.Order? = nil, sorting: Bool = false) async throws -> RESPToken.Array {
+    public func sortRo(
+        key: ValkeyKey,
+        byPattern: String? = nil,
+        limit: SORTRO.Limit? = nil,
+        getPattern: [String] = [],
+        order: SORTRO.Order? = nil,
+        sorting: Bool = false
+    ) async throws -> RESPToken.Array {
         try await send(command: SORTRO(key: key, byPattern: byPattern, limit: limit, getPattern: getPattern, order: order, sorting: sorting))
     }