Add a benchmark executable

Author: Joannis

Package.swift

@@ -20,7 +20,8 @@ let package = Package(
     products: [
         .library(name: "RediStack", targets: ["RediStack"]),
         .library(name: "RediStackTestUtils", targets: ["RediStackTestUtils"]),
-        .library(name: "RedisTypes", targets: ["RedisTypes"])
+        .library(name: "RedisTypes", targets: ["RedisTypes"]),
+        .executable(name: "RediStackPerformanceTester", targets: ["RediStackPerformanceTester"]),
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-atomics.git", from: "1.1.0"),
@@ -44,6 +45,13 @@ let package = Package(
             ]
         ),
         .target(name: "RedisTypes", dependencies: ["RediStack"]),
+        .executableTarget(
+            name: "RediStackPerformanceTester",
+            dependencies: [
+                "RediStack",
+                "RESP3",
+            ]
+        ),
         .target(
             name: "RediStackTestUtils",
             dependencies: [

Sources/RediStackPerformanceTester/RESP3ParsingBenchmark.swift

@@ -0,0 +1,22 @@
+import NIOCore
+import RESP3
+
+func benchmarkRESP3Parsing() throws {
+    let valueBuffer = ByteBuffer(string: "*2\r\n$3\r\nGET\r\n$7\r\nwelcome\r\n")
+    let values: [RESP3Token.Value] = [
+        .blobString(ByteBuffer(string: "GET")),
+        .blobString(ByteBuffer(string: "welcome")),
+    ]
+    
+    try benchmark {
+        var valueBuffer = valueBuffer
+
+        guard
+            let token = try RESP3Token(consuming: &valueBuffer),
+            case .array(let array) = token.value,
+            array.map(\.value) == values
+        else {
+            fatalError("\(#function) Test failed: Invalid test result")
+        }
+    }
+}

Sources/RediStackPerformanceTester/RESP3ProtocolBenchmark.swift

@@ -0,0 +1,43 @@
+import RediStack
+import RESP3
+import Foundation
+import NIOCore
+import NIOEmbedded
+
+func benchmarkRESP3Protocol() throws {
+    let channel = EmbeddedChannel()
+
+    // Precalculate the server response
+    try channel.connect(to: .init(unixDomainSocketPath: "/fakeserver")).wait()
+    let serverReply = "Hello, world"
+    let redisReplyBuffer = ByteBuffer(string: "$\(serverReply.count)\r\n\(serverReply)\r\n")
+
+    try benchmark {
+        // Client sends a command
+        // GET welcome
+        // TODO: Replace when we get RESP3 serialization
+        try channel.writeOutbound(ByteBuffer(string: "*2\r\n$3\r\nGET\r\n$7\r\nwelcome\r\n"))
+
+        // Server reads the command
+        _ = try channel.readOutbound(as: ByteBuffer.self)
+        // Server replies
+        try channel.writeInbound(redisReplyBuffer)
+
+        // Client reads the reply
+        guard var serverReplyBuffer = try channel.readInbound(as: ByteBuffer.self) else {
+            fatalError("Missing reply")
+        }
+        
+        guard case .blobString(var blobString) = try RESP3Token(consuming: &serverReplyBuffer)?.value else {
+            fatalError("Invalid reply")
+        }
+
+        guard blobString.readString(length: blobString.readableBytes) == serverReply else {
+            fatalError("Invalid test result")
+        }
+    }
+
+    guard case .clean = try channel.finish() else {
+        fatalError("Test didn't exit cleanly")
+    }
+}

Sources/RediStackPerformanceTester/RESPParsingBenchmark.swift

@@ -0,0 +1,18 @@
+import NIOCore
+import RediStack
+
+func benchmarkRESPParsing() throws {
+    let valueBuffer = ByteBuffer(string: "*2\r\n$3\r\nGET\r\n$7\r\nwelcome\r\n")
+    let result: [RESPValue] = [
+        .bulkString(ByteBuffer(string: "GET")),
+        .bulkString(ByteBuffer(string: "welcome")),
+    ]
+    let translator = RESPTranslator()
+    try benchmark {
+        var valueBuffer = valueBuffer
+        let value = try translator.parseBytes(from: &valueBuffer)
+        guard case .array(result) = value else {
+            fatalError("\(#function) Test failed: Invalid test result")
+        }
+    }
+}

Sources/RediStackPerformanceTester/RESPProtocolBenchmark.swift

@@ -0,0 +1,45 @@
+import RediStack
+import RESP3
+import Foundation
+import NIOCore
+import NIOEmbedded
+
+func benchmarkRESPProtocol() throws {
+    let channel = EmbeddedChannel()
+    try channel.pipeline.addBaseRedisHandlers().wait()
+
+    // Precalculate the server response
+    try channel.connect(to: .init(unixDomainSocketPath: "/fakeserver")).wait()
+    var redisReplyBuffer = ByteBuffer()
+    let serverValue = "Hello, world"
+    let replyValue = RESPValue.simpleString(ByteBuffer(string: serverValue))
+    RESPTranslator().write(replyValue, into: &redisReplyBuffer)
+
+    try benchmark {
+        let promise = channel.eventLoop.makePromise(of: RESPValue.self)
+
+        // Client sends a command
+        try channel.writeOutbound(RedisCommand(
+            message: .array([
+                .bulkString(ByteBuffer(string: "GET")),
+                .bulkString(ByteBuffer(string: "welcome")),
+            ]),
+            responsePromise: promise
+        ))
+
+        // Server reads the command
+        _ = try channel.readOutbound(as: ByteBuffer.self)
+        // Server replies
+        try channel.writeInbound(redisReplyBuffer)
+
+        // Client reads the reply
+        let serverReply = try promise.futureResult.wait()
+        guard serverReply.string == serverValue else {
+            fatalError("Invalid test result")
+        }
+    }
+
+    guard case .clean = try channel.finish() else {
+        fatalError("Test didn't exit cleanly")
+    }
+}

Sources/RediStackPerformanceTester/main.swift

@@ -0,0 +1,28 @@
+import RediStack
+import Foundation
+import NIOCore
+import NIOEmbedded
+import RESP3
+
+func benchmark(label: String = #function, _ n: Int = 100_000, run: () throws -> Void) throws {
+    let start = Date()
+    for _ in 0..<n {
+        try run()
+    }
+    let end = Date()
+    let mode: String
+
+#if DEBUG
+    mode = "DEBUG"
+#else
+    mode = "RELEASE"
+#endif
+
+    print("\(label): Test took \(end.timeIntervalSince(start)) seconds on \(mode)")
+}
+
+try benchmarkRESPProtocol()
+try benchmarkRESP3Protocol()
+
+try benchmarkRESPParsing()
+try benchmarkRESP3Parsing()