Add ValkeyCommand.isBlocking (#94)

Author: adam-fowler

Sources/Valkey/Commands/GenericCommands.swift

@@ -838,6 +838,8 @@ public struct WAIT: ValkeyCommand {
         self.timeout = timeout
     }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("WAIT", numreplicas, timeout)
     }
@@ -857,6 +859,8 @@ public struct WAITAOF: ValkeyCommand {
         self.timeout = timeout
     }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("WAITAOF", numlocal, numreplicas, timeout)
     }

Sources/Valkey/Commands/ListCommands.swift

@@ -72,6 +72,8 @@ public struct BLMOVE: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { [source, destination] }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BLMOVE", source, destination, wherefrom, whereto, timeout)
     }
@@ -110,6 +112,8 @@ public struct BLMPOP: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { key }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BLMPOP", timeout, RESPArrayWithCount(key), `where`, RESPWithToken("COUNT", count))
     }
@@ -129,6 +133,8 @@ public struct BLPOP: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { key }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BLPOP", key, timeout)
     }
@@ -148,6 +154,8 @@ public struct BRPOP: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { key }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BRPOP", key, timeout)
     }
@@ -169,6 +177,8 @@ public struct BRPOPLPUSH: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { [source, destination] }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BRPOPLPUSH", source, destination, timeout)
     }

Sources/Valkey/Commands/SortedSetCommands.swift

@@ -53,6 +53,8 @@ public struct BZMPOP: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { key }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BZMPOP", timeout, RESPArrayWithCount(key), `where`, RESPWithToken("COUNT", count))
     }
@@ -70,6 +72,8 @@ public struct BZPOPMAX: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { key }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BZPOPMAX", key, timeout)
     }
@@ -87,6 +91,8 @@ public struct BZPOPMIN: ValkeyCommand {
 
     public var keysAffected: [ValkeyKey] { key }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("BZPOPMIN", key, timeout)
     }

Sources/Valkey/Commands/StreamCommands.swift

@@ -630,6 +630,8 @@ public struct XREAD<Id: RESPStringRenderable>: ValkeyCommand {
         self.streams = streams
     }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("XREAD", RESPWithToken("COUNT", count), RESPWithToken("BLOCK", milliseconds), RESPWithToken("STREAMS", streams))
     }
@@ -695,6 +697,8 @@ public struct XREADGROUP<Group: RESPStringRenderable, Consumer: RESPStringRender
         self.streams = streams
     }
 
+    public var isBlocking: Bool { true }
+
     @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {
         commandEncoder.encodeArray("XREADGROUP", RESPWithToken("GROUP", groupBlock), RESPWithToken("COUNT", count), RESPWithToken("BLOCK", milliseconds), RESPPureToken("NOACK", noack), RESPWithToken("STREAMS", streams))
     }

Sources/Valkey/ValkeyCommand.swift

@@ -23,6 +23,9 @@ public protocol ValkeyCommand: Sendable {
     /// shard to connect to.
     var keysAffected: Keys { get }
 
+    /// Does this command block the connection
+    var isBlocking: Bool { get }
+
     /// Encode Valkey Command into RESP
     /// - Parameter commandEncoder: ValkeyCommandEncoder
     func encode(into commandEncoder: inout ValkeyCommandEncoder)
@@ -31,6 +34,8 @@ public protocol ValkeyCommand: Sendable {
 extension ValkeyCommand {
     /// Default to no keys affected
     public var keysAffected: [ValkeyKey] { [] }
+    /// Default is not blocking
+    public var isBlocking: Bool { false }
 }
 
 /// Wrapper for Valkey command that returns the response as a `RESPToken`

Sources/_ValkeyCommandsBuilder/ValkeyCommandJSON.swift

@@ -305,6 +305,7 @@ struct ValkeyCommand: Decodable {
     let deprecatedSince: String?
     let replacedBy: String?
     let docFlags: [String]?
+    let commandFlags: [String]?
     let aclCategories: [String]?
     let arguments: [Argument]?
     let replySchema: ReplySchema?
@@ -320,6 +321,7 @@ struct ValkeyCommand: Decodable {
         self.deprecatedSince = try container.decodeIfPresent(String.self, forKey: .deprecatedSince)
         self.replacedBy = try container.decodeIfPresent(String.self, forKey: .replacedBy)
         self.docFlags = try container.decodeIfPresent([String].self, forKey: .docFlags)
+        self.commandFlags = try container.decodeIfPresent([String].self, forKey: .commandFlags)
         self.aclCategories = try container.decodeIfPresent([String].self, forKey: .aclCategories)
         if let arguments = try container.decodeIfPresent([InternalArgument].self, forKey: .arguments) {
             if let keySpecs = try container.decodeIfPresent([KeySpec].self, forKey: .keySpecs) {
@@ -352,6 +354,7 @@ struct ValkeyCommand: Decodable {
         case deprecatedSince = "deprecated_since"
         case replacedBy = "replaced_by"
         case docFlags = "doc_flags"
+        case commandFlags = "command_flags"
         case aclCategories = "acl_categories"
         case arguments
         case replySchema = "reply_schema"

Sources/_ValkeyCommandsBuilder/ValkeyCommandsRender.swift

@@ -258,7 +258,9 @@ extension String {
             let (keysAffectedType, keysAffected) = constructKeysAffected(keyArguments)
             self.append("\(tab)    public var keysAffected: \(keysAffectedType) { \(keysAffected) }\n\n")
         }
-
+        if command.commandFlags?.contains("BLOCKING") == true {
+            self.append("\(tab)    public var isBlocking: Bool { true }\n\n")
+        }
         self.append("\(tab)    @inlinable public func encode(into commandEncoder: inout ValkeyCommandEncoder) {\n")
         self.append("\(tab)        commandEncoder.encodeArray(\(commandArgumentsString))\n")
         self.append("\(tab)    }\n")