Rename KafkaProducer.sendAsync -> .send (#70)

Author: felixschlegel

README.md

@@ -6,7 +6,7 @@ SwiftKafka is a Swift Package in development that provides a convenient way to c
 
 ### Producer API
 
-The `sendAsync(_:)` method of `KafkaProducer` returns a message-id that can later be used to identify the corresponding acknowledgement. Acknowledgements are received through the `acknowledgements` [`AsyncSequence`](https://developer.apple.com/documentation/swift/asyncsequence). Each acknowledgement indicates that producing a message was successful or returns an error.
+The `send(_:)` method of `KafkaProducer` returns a message-id that can later be used to identify the corresponding acknowledgement. Acknowledgements are received through the `acknowledgements` [`AsyncSequence`](https://developer.apple.com/documentation/swift/asyncsequence). Each acknowledgement indicates that producing a message was successful or returns an error.
 
 ```swift
 let config = KafkaProducerConfiguration(bootstrapServers: ["localhost:9092"])
@@ -25,7 +25,7 @@ await withThrowingTaskGroup(of: Void.self) { group in
 
     // Task receiving acknowledgements
     group.addTask {
-        let messageID = try await producer.sendAsync(
+        let messageID = try await producer.send(
             KafkaProducerMessage(
                 topic: "topic-name",
                 value: "Hello, World!"

Sources/SwiftKafka/KafkaAcknowledgedMessage.swift

@@ -18,7 +18,7 @@ import NIOCore
 /// A message produced by the client and acknowledged by the Kafka cluster.
 public struct KafkaAcknowledgedMessage: Hashable {
     /// The unique identifier assigned by the ``KafkaProducer`` when the message was send to Kafka.
-    /// The same identifier is returned by ``KafkaProducer/sendAsync(_:)`` and can be used to correlate
+    /// The same identifier is returned by ``KafkaProducer/send(_:)`` and can be used to correlate
     /// a sent message and an acknowledged message.
     public var id: KafkaProducerMessageID
     /// The topic that the message was sent to.

Sources/SwiftKafka/KafkaProducer.swift

@@ -214,23 +214,24 @@ public actor KafkaProducer {
         }
     }
 
-    /// Send messages to the Kafka cluster asynchronously, aka "fire and forget".
-    /// This function is non-blocking.
+    /// Send messages to the Kafka cluster asynchronously. This method is non-blocking.
+    /// Message send results shall be handled through the ``KafkaMessageAcknowledgements`` `AsyncSequence`.
+    ///
     /// - Parameter message: The ``KafkaProducerMessage`` that is sent to the KafkaCluster.
     /// - Returns: Unique ``KafkaProducerMessageID``matching the ``KafkaAcknowledgedMessage/id`` property
     /// of the corresponding ``KafkaAcknowledgedMessage``.
     /// - Throws: A ``KafkaError`` if sending the message failed.
     @discardableResult
-    public func sendAsync(_ message: KafkaProducerMessage) throws -> KafkaProducerMessageID {
+    public func send(_ message: KafkaProducerMessage) throws -> KafkaProducerMessageID {
         switch self.state {
         case .started:
-            return try self._sendAsync(message)
+            return try self._send(message)
         case .shuttingDown, .shutDown:
             throw KafkaError.connectionClosed(reason: "Tried to produce a message with a closed producer")
         }
     }
 
-    private func _sendAsync(_ message: KafkaProducerMessage) throws -> KafkaProducerMessageID {
+    private func _send(_ message: KafkaProducerMessage) throws -> KafkaProducerMessageID {
         let topicHandle = try self.createTopicHandleIfNeeded(topic: message.topic)
 
         let keyBytes: [UInt8]?

Tests/IntegrationTests/SwiftKafkaTests.swift

@@ -273,7 +273,7 @@ final class SwiftKafkaTests: XCTestCase {
         var messageIDs = Set<KafkaProducerMessageID>()
 
         for message in messages {
-            messageIDs.insert(try await producer.sendAsync(message))
+            messageIDs.insert(try await producer.send(message))
         }
 
         var acknowledgedMessages = Set<KafkaAcknowledgedMessage>()

Tests/SwiftKafkaTests/KafkaProducerTests.swift

@@ -51,7 +51,7 @@ final class KafkaProducerTests: XCTestCase {
         self.config = nil
     }
 
-    func testSendAsync() async throws {
+    func testSend() async throws {
         let (producer, acks) = try await KafkaProducer.makeProducerWithAcknowledgements(config: self.config, logger: .kafkaTest)
 
         await withThrowingTaskGroup(of: Void.self) { group in
@@ -70,7 +70,7 @@ final class KafkaProducerTests: XCTestCase {
                     value: "Hello, World!"
                 )
 
-                let messageID = try await producer.sendAsync(message)
+                let messageID = try await producer.send(message)
 
                 for await messageResult in acks {
                     guard case .success(let acknowledgedMessage) = messageResult else {
@@ -90,7 +90,7 @@ final class KafkaProducerTests: XCTestCase {
         }
     }
 
-    func testSendAsyncEmptyMessage() async throws {
+    func testSendEmptyMessage() async throws {
         let (producer, acks) = try await KafkaProducer.makeProducerWithAcknowledgements(config: self.config, logger: .kafkaTest)
 
         await withThrowingTaskGroup(of: Void.self) { group in
@@ -108,7 +108,7 @@ final class KafkaProducerTests: XCTestCase {
                     value: ByteBuffer()
                 )
 
-                let messageID = try await producer.sendAsync(message)
+                let messageID = try await producer.send(message)
 
                 for await messageResult in acks {
                     guard case .success(let acknowledgedMessage) = messageResult else {
@@ -128,7 +128,7 @@ final class KafkaProducerTests: XCTestCase {
         }
     }
 
-    func testSendAsyncTwoTopics() async throws {
+    func testSendTwoTopics() async throws {
         let (producer, acks) = try await KafkaProducer.makeProducerWithAcknowledgements(config: self.config, logger: .kafkaTest)
         await withThrowingTaskGroup(of: Void.self) { group in
 
@@ -152,8 +152,8 @@ final class KafkaProducerTests: XCTestCase {
 
                 var messageIDs = Set<KafkaProducerMessageID>()
 
-                messageIDs.insert(try await producer.sendAsync(message1))
-                messageIDs.insert(try await producer.sendAsync(message2))
+                messageIDs.insert(try await producer.send(message1))
+                messageIDs.insert(try await producer.send(message2))
 
                 var acknowledgedMessages = Set<KafkaAcknowledgedMessage>()
 
@@ -203,7 +203,7 @@ final class KafkaProducerTests: XCTestCase {
                 )
 
                 do {
-                    try await producer.sendAsync(message)
+                    try await producer.send(message)
                     XCTFail("Method should have thrown error")
                 } catch {}