ETCD Client Delete Functionality (#5)

* Added delete functionality to ETCD

* Fix documentation for delete

* Re-add accidental comment that was removed

---------

Co-authored-by: “Ayushi <“attiwari@uwaterloo.ca”>

Author: ayushi2103

Sources/ETCD/ETCDClient.swift

@@ -80,9 +80,26 @@ public final class EtcdClient: @unchecked Sendable {
 
     /// Fetch the value for a key from the ETCD server.
     ///
-    /// - Parameter key: The key to fetch the value for. Parameter is of type Sequence<UInt8>.
+    /// - 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>.
+    public func delete(_ key: some Sequence<UInt8>) async throws {
+        var deleteRangeRequest = Etcdserverpb_DeleteRangeRequest()
+        deleteRangeRequest.key = Data(key)
+        let call = client.deleteRange(deleteRangeRequest)
+        _ = try await call.response.get()
+    }
+    
+    /// Deletes the value for a key from the ETCD server.
+    ///
+    /// - Parameter key: The key to delete the value for. Parameter is of type String.
+    public func delete(_ key: String) async throws {
+        return try await delete(key.utf8)
+    }
 }

Sources/ETCD/proto/etcd.grpc.swift

@@ -25,6 +25,11 @@ internal protocol Etcdserverpb_KVClientProtocol: GRPCClient {
     _ request: Etcdserverpb_PutRequest,
     callOptions: CallOptions?
   ) -> UnaryCall<Etcdserverpb_PutRequest, Etcdserverpb_PutResponse>
+
+  func deleteRange(
+    _ request: Etcdserverpb_DeleteRangeRequest,
+    callOptions: CallOptions?
+  ) -> UnaryCall<Etcdserverpb_DeleteRangeRequest, Etcdserverpb_DeleteRangeResponse>
 }
 
 extension Etcdserverpb_KVClientProtocol {
@@ -69,6 +74,26 @@ extension Etcdserverpb_KVClientProtocol {
       interceptors: self.interceptors?.makePutInterceptors() ?? []
     )
   }
+
+  /// DeleteRange deletes the given range from the key-value store.
+  /// A delete request increments the revision of the key-value store
+  /// and generates a delete event in the event history for every deleted key.
+  ///
+  /// - Parameters:
+  ///   - request: Request to send to DeleteRange.
+  ///   - callOptions: Call options.
+  /// - Returns: A `UnaryCall` with futures for the metadata, status and response.
+  internal func deleteRange(
+    _ request: Etcdserverpb_DeleteRangeRequest,
+    callOptions: CallOptions? = nil
+  ) -> UnaryCall<Etcdserverpb_DeleteRangeRequest, Etcdserverpb_DeleteRangeResponse> {
+    return self.makeUnaryCall(
+      path: Etcdserverpb_KVClientMetadata.Methods.deleteRange.path,
+      request: request,
+      callOptions: callOptions ?? self.defaultCallOptions,
+      interceptors: self.interceptors?.makeDeleteRangeInterceptors() ?? []
+    )
+  }
 }
 
 @available(*, deprecated)
@@ -142,6 +167,11 @@ internal protocol Etcdserverpb_KVAsyncClientProtocol: GRPCClient {
     _ request: Etcdserverpb_PutRequest,
     callOptions: CallOptions?
   ) -> GRPCAsyncUnaryCall<Etcdserverpb_PutRequest, Etcdserverpb_PutResponse>
+
+  func makeDeleteRangeCall(
+    _ request: Etcdserverpb_DeleteRangeRequest,
+    callOptions: CallOptions?
+  ) -> GRPCAsyncUnaryCall<Etcdserverpb_DeleteRangeRequest, Etcdserverpb_DeleteRangeResponse>
 }
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@@ -177,6 +207,18 @@ extension Etcdserverpb_KVAsyncClientProtocol {
       interceptors: self.interceptors?.makePutInterceptors() ?? []
     )
   }
+
+  internal func makeDeleteRangeCall(
+    _ request: Etcdserverpb_DeleteRangeRequest,
+    callOptions: CallOptions? = nil
+  ) -> GRPCAsyncUnaryCall<Etcdserverpb_DeleteRangeRequest, Etcdserverpb_DeleteRangeResponse> {
+    return self.makeAsyncUnaryCall(
+      path: Etcdserverpb_KVClientMetadata.Methods.deleteRange.path,
+      request: request,
+      callOptions: callOptions ?? self.defaultCallOptions,
+      interceptors: self.interceptors?.makeDeleteRangeInterceptors() ?? []
+    )
+  }
 }
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@@ -204,6 +246,18 @@ extension Etcdserverpb_KVAsyncClientProtocol {
       interceptors: self.interceptors?.makePutInterceptors() ?? []
     )
   }
+
+  internal func deleteRange(
+    _ request: Etcdserverpb_DeleteRangeRequest,
+    callOptions: CallOptions? = nil
+  ) async throws -> Etcdserverpb_DeleteRangeResponse {
+    return try await self.performAsyncUnaryCall(
+      path: Etcdserverpb_KVClientMetadata.Methods.deleteRange.path,
+      request: request,
+      callOptions: callOptions ?? self.defaultCallOptions,
+      interceptors: self.interceptors?.makeDeleteRangeInterceptors() ?? []
+    )
+  }
 }
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@@ -230,6 +284,9 @@ internal protocol Etcdserverpb_KVClientInterceptorFactoryProtocol: Sendable {
 
   /// - Returns: Interceptors to use when invoking 'put'.
   func makePutInterceptors() -> [ClientInterceptor<Etcdserverpb_PutRequest, Etcdserverpb_PutResponse>]
+
+  /// - Returns: Interceptors to use when invoking 'deleteRange'.
+  func makeDeleteRangeInterceptors() -> [ClientInterceptor<Etcdserverpb_DeleteRangeRequest, Etcdserverpb_DeleteRangeResponse>]
 }
 
 internal enum Etcdserverpb_KVClientMetadata {
@@ -239,6 +296,7 @@ internal enum Etcdserverpb_KVClientMetadata {
     methods: [
       Etcdserverpb_KVClientMetadata.Methods.range,
       Etcdserverpb_KVClientMetadata.Methods.put,
+      Etcdserverpb_KVClientMetadata.Methods.deleteRange,
     ]
   )
 
@@ -254,6 +312,12 @@ internal enum Etcdserverpb_KVClientMetadata {
       path: "/etcdserverpb.KV/Put",
       type: GRPCCallType.unary
     )
+
+    internal static let deleteRange = GRPCMethodDescriptor(
+      name: "DeleteRange",
+      path: "/etcdserverpb.KV/DeleteRange",
+      type: GRPCCallType.unary
+    )
   }
 }
 
@@ -268,6 +332,11 @@ internal protocol Etcdserverpb_KVProvider: CallHandlerProvider {
   /// A put request increments the revision of the key-value store
   /// and generates one event in the event history.
   func put(request: Etcdserverpb_PutRequest, context: StatusOnlyCallContext) -> EventLoopFuture<Etcdserverpb_PutResponse>
+
+  /// DeleteRange deletes the given range from the key-value store.
+  /// A delete request increments the revision of the key-value store
+  /// and generates a delete event in the event history for every deleted key.
+  func deleteRange(request: Etcdserverpb_DeleteRangeRequest, context: StatusOnlyCallContext) -> EventLoopFuture<Etcdserverpb_DeleteRangeResponse>
 }
 
 extension Etcdserverpb_KVProvider {
@@ -300,6 +369,15 @@ extension Etcdserverpb_KVProvider {
         userFunction: self.put(request:context:)
       )
 
+    case "DeleteRange":
+      return UnaryServerHandler(
+        context: context,
+        requestDeserializer: ProtobufDeserializer<Etcdserverpb_DeleteRangeRequest>(),
+        responseSerializer: ProtobufSerializer<Etcdserverpb_DeleteRangeResponse>(),
+        interceptors: self.interceptors?.makeDeleteRangeInterceptors() ?? [],
+        userFunction: self.deleteRange(request:context:)
+      )
+
     default:
       return nil
     }
@@ -325,6 +403,14 @@ internal protocol Etcdserverpb_KVAsyncProvider: CallHandlerProvider, Sendable {
     request: Etcdserverpb_PutRequest,
     context: GRPCAsyncServerCallContext
   ) async throws -> Etcdserverpb_PutResponse
+
+  /// DeleteRange deletes the given range from the key-value store.
+  /// A delete request increments the revision of the key-value store
+  /// and generates a delete event in the event history for every deleted key.
+  func deleteRange(
+    request: Etcdserverpb_DeleteRangeRequest,
+    context: GRPCAsyncServerCallContext
+  ) async throws -> Etcdserverpb_DeleteRangeResponse
 }
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
@@ -364,6 +450,15 @@ extension Etcdserverpb_KVAsyncProvider {
         wrapping: { try await self.put(request: $0, context: $1) }
       )
 
+    case "DeleteRange":
+      return GRPCAsyncServerHandler(
+        context: context,
+        requestDeserializer: ProtobufDeserializer<Etcdserverpb_DeleteRangeRequest>(),
+        responseSerializer: ProtobufSerializer<Etcdserverpb_DeleteRangeResponse>(),
+        interceptors: self.interceptors?.makeDeleteRangeInterceptors() ?? [],
+        wrapping: { try await self.deleteRange(request: $0, context: $1) }
+      )
+
     default:
       return nil
     }
@@ -379,6 +474,10 @@ internal protocol Etcdserverpb_KVServerInterceptorFactoryProtocol: Sendable {
   /// - Returns: Interceptors to use when handling 'put'.
   ///   Defaults to calling `self.makeInterceptors()`.
   func makePutInterceptors() -> [ServerInterceptor<Etcdserverpb_PutRequest, Etcdserverpb_PutResponse>]
+
+  /// - Returns: Interceptors to use when handling 'deleteRange'.
+  ///   Defaults to calling `self.makeInterceptors()`.
+  func makeDeleteRangeInterceptors() -> [ServerInterceptor<Etcdserverpb_DeleteRangeRequest, Etcdserverpb_DeleteRangeResponse>]
 }
 
 internal enum Etcdserverpb_KVServerMetadata {
@@ -388,6 +487,7 @@ internal enum Etcdserverpb_KVServerMetadata {
     methods: [
       Etcdserverpb_KVServerMetadata.Methods.range,
       Etcdserverpb_KVServerMetadata.Methods.put,
+      Etcdserverpb_KVServerMetadata.Methods.deleteRange,
     ]
   )
 
@@ -403,5 +503,11 @@ internal enum Etcdserverpb_KVServerMetadata {
       path: "/etcdserverpb.KV/Put",
       type: GRPCCallType.unary
     )
+
+    internal static let deleteRange = GRPCMethodDescriptor(
+      name: "DeleteRange",
+      path: "/etcdserverpb.KV/DeleteRange",
+      type: GRPCCallType.unary
+    )
   }
 }