Get Range (#8)

* get key range

* Updated get and tests.

* Updated get to use rangeRequest

* Updated PR comments

---------

Co-authored-by: “Ayushi <“[email protected]”>

Author: ayushi2103

Sources/ETCD/ETCDClient.swift

@@ -63,15 +63,13 @@ public final class EtcdClient: @unchecked Sendable {
         try await set(key.utf8, value: value.utf8)
     }
 
-    /// Fetch the value for a key from the ETCD server.
+    /// Fetches a range from the ETCD server.
     ///
-    /// - Parameter key: The key to fetch the value for. Parameter is of type Sequence<UInt8>.
+    /// - Parameter rangeRequest: The rangeRequst to get
     /// - Returns: A `Value` containing the fetched value, or `nil` if no value was found.
-    public func get(_ key: some Sequence<UInt8>) async throws -> Data? {
-        var rangeRequest = Etcdserverpb_RangeRequest()
-        rangeRequest.key = Data(key)
-
-        let call = client.range(rangeRequest)
+    public func getRange(_ rangeRequest: RangeRequest) async throws -> Data? {
+        let protoRangeRequest = rangeRequest.toProto()
+        let call = client.range(protoRangeRequest)
         let response = try await call.response.get()
 
         guard let kv = response.kvs.first else {
@@ -80,14 +78,6 @@ public final class EtcdClient: @unchecked Sendable {
         return kv.value
     }
 
-    /// Fetch the value for a key from the ETCD server.
-    ///
-    /// - Parameter key: The key to fetch the value for. Parameter is of type String.
-    /// - Returns: A `Value` containing the fetched value, or `nil` if no value was found.
-    public func get(_ key: String) async throws -> Data? {
-        return try await get(key.utf8)
-    }
-    
     /// Delete the value for a key from the ETCD server.
     ///
     /// - Parameter key: The key to delete. Parameter is of type Sequence<UInt8>.

Sources/ETCD/RangeRequest.swift

@@ -0,0 +1,85 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the swift-etcd-client-gsoc open source project
+//
+// Copyright (c) 2024 Apple Inc. and the swift-etcd-client-gsoc project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of swift-etcd-client-gsoc project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+public struct RangeRequest {
+    public enum SortOrder: Int {
+        case none = 0
+        case ascend = 1
+        case descend = 2
+    }
+    
+    public enum SortTarget: Int {
+        case key = 0
+        case version = 1
+        case create = 2
+        case mod = 3
+        case value = 4
+    }
+
+    public var key: Data
+    public var rangeEnd: Data?
+    public var limit: Int = 0
+    public var revision: Int = 0
+    public var sortOrder: SortOrder = .none
+    public var sortTarget: SortTarget = .key
+    public var serializable: Bool = false
+    public var keysOnly: Bool = false
+    public var countOnly: Bool = false
+    public var minModRevision: Int = 0
+    public var maxModRevision: Int = 0
+    public var minCreateRevision: Int = 0
+    public var maxCreateRevision: Int = 0
+    
+    
+    init(protoRangeRequest: Etcdserverpb_RangeRequest) {
+        self.key = protoRangeRequest.key
+        self.rangeEnd = protoRangeRequest.rangeEnd
+        self.limit = Int(protoRangeRequest.limit)
+        self.revision = Int(protoRangeRequest.revision)
+        self.sortOrder = SortOrder(rawValue: protoRangeRequest.sortOrder.rawValue) ?? .none
+        self.sortTarget = SortTarget(rawValue: protoRangeRequest.sortTarget.rawValue) ?? .key
+        self.serializable = protoRangeRequest.serializable
+        self.keysOnly = protoRangeRequest.keysOnly
+        self.countOnly = protoRangeRequest.countOnly
+        self.minModRevision = Int(protoRangeRequest.minModRevision)
+        self.maxModRevision = Int(protoRangeRequest.maxModRevision)
+        self.minCreateRevision = Int(protoRangeRequest.minCreateRevision)
+        self.maxCreateRevision = Int(protoRangeRequest.maxCreateRevision)
+    }
+    
+    public init(key: Data, rangeEnd: Data? = nil) {
+        self.key = key
+        self.rangeEnd = rangeEnd
+    }
+    
+    func toProto() -> Etcdserverpb_RangeRequest {
+        var protoRangeRequest = Etcdserverpb_RangeRequest()
+        protoRangeRequest.key = self.key
+        protoRangeRequest.rangeEnd = self.rangeEnd ?? Data()
+        protoRangeRequest.limit = Int64(self.limit)
+        protoRangeRequest.revision = Int64(self.revision)
+        protoRangeRequest.sortOrder = Etcdserverpb_RangeRequest.SortOrder(rawValue: self.sortOrder.rawValue) ?? .none
+        protoRangeRequest.sortTarget = Etcdserverpb_RangeRequest.SortTarget(rawValue: self.sortTarget.rawValue) ?? .key
+        protoRangeRequest.serializable = self.serializable
+        protoRangeRequest.keysOnly = self.keysOnly
+        protoRangeRequest.countOnly = self.countOnly
+        protoRangeRequest.minModRevision = Int64(self.minModRevision)
+        protoRangeRequest.maxModRevision = Int64(self.maxModRevision)
+        protoRangeRequest.minCreateRevision = Int64(self.minCreateRevision)
+        protoRangeRequest.maxCreateRevision = Int64(self.maxCreateRevision)
+        return protoRangeRequest
+    }
+}

Sources/ETCDExample/ETCDExample.swift

@@ -38,14 +38,16 @@ struct Example {
                 try await Task.sleep(for: .seconds(1))
 
                 try await etcdClient.set("foo", value: "bar")
-                if let value = try await etcdClient.get("foo") {
+                let key = "foo".data(using: .utf8)!
+                let rangeRequest = RangeRequest(key: key)
+                if let value = try await etcdClient.get(rangeRequest: rangeRequest) {
                     if let stringValue = String(data: value, encoding: .utf8) {
                         print("Value is: \(stringValue)")
                         try await etcdClient.delete("foo")
                         print("Key deleted")
 
                         // Trying to get the value again
-                        let deletedValue = try await etcdClient.get("foo")
+                        let deletedValue = try await etcdClient.get(rangeRequest: rangeRequest)
                         if deletedValue == nil {
                             print("Key not found after deletion")
                         } else {

Tests/ETCDTests/ETCDTests.swift

@@ -26,14 +26,18 @@ final class EtcdClientTests: XCTestCase {
 
     func testSetAndGetStringValue() async throws {
         try await etcdClient.set("testKey", value: "testValue")
-        let result = try await etcdClient.get("testKey")
+        let key = "testKey".data(using: .utf8)!
+        let rangeRequest = RangeRequest(key: key)
+        let result = try await etcdClient.getRange(rangeRequest)
 
         XCTAssertNotNil(result)
         XCTAssertEqual(String(data: result!, encoding: .utf8), "testValue")
     }
 
     func testGetNonExistentKey() async throws {
-        let result = try await etcdClient.get("nonExistentKey")
+        let key = "nonExistentKey".data(using: .utf8)!
+        let rangeRequest = RangeRequest(key: key)
+        let result = try await etcdClient.getRange(rangeRequest)
         XCTAssertNil(result)
     }
 
@@ -42,24 +46,27 @@ final class EtcdClientTests: XCTestCase {
         let value = "testValue"
         try await etcdClient.set(key, value: value)
 
-        var fetchedValue = try await etcdClient.get(key)
+        let rangeRequestKey = "testKey".data(using: .utf8)!
+        let rangeRequest = RangeRequest(key: rangeRequestKey)
+        var fetchedValue = try await etcdClient.getRange(rangeRequest)
         XCTAssertNotNil(fetchedValue)
 
         try await etcdClient.delete(key)
 
-        fetchedValue = try await etcdClient.get(key)
+        fetchedValue = try await etcdClient.getRange(rangeRequest)
         XCTAssertNil(fetchedValue)
     }
 
     func testDeleteNonExistentKey() async throws {
-        let key = "testKey"
+        let key = "testKey".data(using: .utf8)!
+        let rangeRequest = RangeRequest(key: key)
 
-        var fetchedValue = try await etcdClient.get(key)
+        var fetchedValue = try await etcdClient.getRange(rangeRequest)
         XCTAssertNil(fetchedValue)
 
         try await etcdClient.delete(key)
 
-        fetchedValue = try await etcdClient.get(key)
+        fetchedValue = try await etcdClient.getRange(rangeRequest)
         XCTAssertNil(fetchedValue)
     }
 
@@ -68,14 +75,18 @@ final class EtcdClientTests: XCTestCase {
         let value = "testValue"
         try await etcdClient.set(key, value: value)
 
-        let fetchedValue = try await etcdClient.get(key)
+        let rangeRequestKey = "testKey".data(using: .utf8)!
+        let rangeRequest = RangeRequest(key: rangeRequestKey)
+        let fetchedValue = try await etcdClient.getRange(rangeRequest)
         XCTAssertNotNil(fetchedValue)
         XCTAssertEqual(String(data: fetchedValue!, encoding: .utf8), value)
 
         let updatedValue = "updatedValue"
         try await etcdClient.put(key, value: updatedValue)
 
-        let fetchedUpdatedValue = try await etcdClient.get(key)
+        let rangeRequestUpdatedKey = "testKey".data(using: .utf8)!
+        let rangeRequestUpdated = RangeRequest(key: rangeRequestUpdatedKey)
+        let fetchedUpdatedValue = try await etcdClient.getRange(rangeRequestUpdated)
         XCTAssertNotNil(fetchedUpdatedValue)
         XCTAssertEqual(String(data: fetchedUpdatedValue!, encoding: .utf8), updatedValue)
     }