feat(pubsub)!: Rename PublisherFactory to Client (#3905)

This new naming is consistent with the Publisher design:
go/cloud-rust:pubsub-publisher-design

Author: PhongChuong

src/integration-tests/src/pubsub.rs

@@ -15,15 +15,15 @@
 use crate::{Error, Result};
 
 use futures::future::join_all;
-use pubsub::client::PublisherFactory;
+use pubsub::client::Client;
 use pubsub::model::PubsubMessage;
 pub use pubsub_samples::{cleanup_test_topic, create_test_topic};
 
 pub async fn basic_publisher() -> Result<()> {
     let (topic_admin, topic) = create_test_topic().await?;
 
     tracing::info!("testing publish()");
-    let client = PublisherFactory::builder().build().await?;
+    let client = Client::builder().build().await?;
     let publisher = client.publisher(topic.name.clone()).build();
     let messages: [PubsubMessage; 2] = [
         PubsubMessage::new().set_data("Hello"),

src/pubsub/src/lib.rs

@@ -29,7 +29,7 @@
 //! * [SchemaService][client::SchemaService]
 //!
 //! For publishing messages:
-//! * [PublisherFactory][client::PublisherFactory] and [Publisher][client::Publisher]
+//! * [Client][client::Client] and [Publisher][client::Publisher]
 //!
 //! Receiving messages is not yet supported by this crate.
 //!
@@ -54,7 +54,7 @@ pub mod builder {
     pub mod publisher {
         #[doc(hidden)]
         pub use crate::generated::gapic_dataplane::builder::publisher::*;
-        pub use crate::publisher::client::PublisherFactoryBuilder;
+        pub use crate::publisher::client::ClientBuilder;
         pub use crate::publisher::publisher::PublisherBuilder;
     }
     /// Request and client builders for the [SchemaService][crate::client::SchemaService] client.
@@ -86,14 +86,14 @@ pub mod model_ext {
 ///
 /// ```
 /// # async fn sample() -> anyhow::Result<()> {
-/// use google_cloud_pubsub::client::PublisherFactory;
+/// use google_cloud_pubsub::client::Client;
 /// use google_cloud_pubsub::model::PubsubMessage;
 ///
-/// // Create a factory for creating publishers.
-/// let factory = PublisherFactory::builder().build().await?;
+/// // Create a client for creating publishers.
+/// let client = Client::builder().build().await?;
 ///
 /// // Create a publisher that handles batching for a specific topic.
-/// let publisher = factory.publisher("projects/my-project/topics/my-topic").build();
+/// let publisher = client.publisher("projects/my-project/topics/my-topic").build();
 ///
 /// // Publish several messages.
 /// // The client will automatically batch them in the background.
@@ -115,7 +115,7 @@ pub mod model_ext {
 /// ```
 pub mod client {
     pub use crate::generated::gapic::client::*;
-    pub use crate::publisher::client::PublisherFactory;
+    pub use crate::publisher::client::Client;
     pub use crate::publisher::publisher::Publisher;
 }
 

src/pubsub/src/publisher/client.rs

@@ -16,22 +16,22 @@ use crate::publisher::publisher::PublisherBuilder;
 
 /// Creates [`Publisher`](super::publisher::Publisher) instances.
 ///
-/// This is the main entry point for the publisher API. A single `PublisherFactory`
+/// This is the main entry point for the publisher API. A single `Client`
 /// can be used to create multiple `Publisher` clients for different topics.
 /// It manages the underlying gRPC connection and authentication.
 ///
 /// # Example
 ///
 /// ```
 /// # async fn sample() -> anyhow::Result<()> {
-/// # use google_cloud_pubsub::client::PublisherFactory;
+/// # use google_cloud_pubsub::client::Client;
 /// # use google_cloud_pubsub::model::PubsubMessage;
 ///
-/// // Create a factory.
-/// let factory = PublisherFactory::builder().build().await?;
+/// // Create a client.
+/// let client = Client::builder().build().await?;
 ///
 /// // Create a publisher for a specific topic.
-/// let publisher = factory.publisher("projects/my-project/topics/my-topic").build();
+/// let publisher = client.publisher("projects/my-project/topics/my-topic").build();
 ///
 /// // Publish a message.
 /// let handle = publisher.publish(PubsubMessage::new().set_data("hello world"));
@@ -41,32 +41,32 @@ use crate::publisher::publisher::PublisherBuilder;
 /// # }
 /// ```
 #[derive(Clone, Debug)]
-pub struct PublisherFactory {
+pub struct Client {
     pub(crate) inner: crate::generated::gapic_dataplane::client::Publisher,
 }
 
-/// A builder for [PublisherFactory].
+/// A builder for [Client].
 ///
 /// ```
 /// # async fn sample() -> anyhow::Result<()> {
 /// # use google_cloud_pubsub::*;
-/// # use builder::publisher::PublisherFactoryBuilder;
-/// # use client::PublisherFactory;
-/// let builder: PublisherFactoryBuilder = PublisherFactory::builder();
-/// let factory = builder
+/// # use builder::publisher::ClientBuilder;
+/// # use client::Client;
+/// let builder: ClientBuilder = Client::builder();
+/// let client = builder
 ///     .with_endpoint("https://pubsub.googleapis.com")
 ///     .build().await?;
 /// # Ok(()) }
 /// ```
-pub type PublisherFactoryBuilder =
+pub type ClientBuilder =
     gax::client_builder::ClientBuilder<client_builder::Factory, gaxi::options::Credentials>;
 
 pub(crate) mod client_builder {
-    use super::PublisherFactory;
+    use super::Client;
 
     pub struct Factory;
     impl gax::client_builder::internal::ClientFactory for Factory {
-        type Client = PublisherFactory;
+        type Client = Client;
         type Credentials = gaxi::options::Credentials;
         #[allow(unused_mut)]
         async fn build(
@@ -79,16 +79,16 @@ pub(crate) mod client_builder {
     }
 }
 
-impl PublisherFactory {
-    /// Returns a builder for [PublisherFactory].
+impl Client {
+    /// Returns a builder for [Client].
     ///
     /// ```no_run
     /// # tokio_test::block_on(async {
-    /// # use google_cloud_pubsub::client::PublisherFactory;
-    /// let factory = PublisherFactory::builder().build().await?;
+    /// # use google_cloud_pubsub::client::Client;
+    /// let client = Client::builder().build().await?;
     /// # gax::client_builder::Result::<()>::Ok(()) });
     /// ```
-    pub fn builder() -> PublisherFactoryBuilder {
+    pub fn builder() -> ClientBuilder {
         gax::client_builder::internal::new_builder(client_builder::Factory)
     }
 
@@ -105,11 +105,11 @@ impl PublisherFactory {
     /// ```
     /// # async fn sample() -> anyhow::Result<()> {
     /// # use google_cloud_pubsub::*;
-    /// # use builder::publisher::PublisherFactoryBuilder;
-    /// # use client::PublisherFactory;
+    /// # use builder::publisher::ClientBuilder;
+    /// # use client::Client;
     /// # use model::PubsubMessage;
-    /// let factory = PublisherFactory::builder().build().await?;
-    /// let publisher = factory.publisher("projects/my-project/topics/my-topic").build();
+    /// let client = Client::builder().build().await?;
+    /// let publisher = client.publisher("projects/my-project/topics/my-topic").build();
     /// let message_id = publisher.publish(PubsubMessage::new().set_data("Hello, World")).await?;
     /// # Ok(()) }
     /// ```
@@ -123,11 +123,11 @@ impl PublisherFactory {
 
 #[cfg(test)]
 mod tests {
-    use super::PublisherFactory;
+    use super::Client;
 
     #[tokio::test]
     async fn builder() -> anyhow::Result<()> {
-        let client = PublisherFactory::builder()
+        let client = Client::builder()
             .with_credentials(auth::credentials::anonymous::Builder::new().build())
             .build()
             .await?;

src/pubsub/src/publisher/publisher.rs

@@ -30,15 +30,15 @@ const MAX_BYTES: u32 = 1e7 as u32; // 10MB
 /// A `Publisher` sends messages to a specific topic. It manages message batching
 /// and sending in a background task.
 ///
-/// Publishers are created via a [`PublisherFactory`](crate::client::PublisherFactory).
+/// Publishers are created via a [`Client`](crate::client::Client).
 ///
 /// ```
 /// # async fn sample() -> anyhow::Result<()> {
 /// # use google_cloud_pubsub::*;
-/// # use client::PublisherFactory;
+/// # use client::Client;
 /// # use model::PubsubMessage;
-/// let factory = PublisherFactory::builder().build().await?;
-/// let publisher = factory.publisher("projects/my-project/topics/my-topic").build();
+/// let client = Client::builder().build().await?;
+/// let publisher = client.publisher("projects/my-project/topics/my-topic").build();
 /// let message_id = publisher.publish(PubsubMessage::new().set_data("Hello, World"));
 /// # Ok(()) }
 /// ```
@@ -122,17 +122,17 @@ impl Publisher {
 
 /// Creates `Publisher`s.
 ///
-/// Publishers are created via a [`PublisherFactory`][crate::client::PublisherFactory].
+/// Publishers are created via a [`Client`][crate::client::Client].
 ///
 /// # Example
 ///
 /// ```
 /// # async fn sample() -> anyhow::Result<()> {
 /// # use google_cloud_pubsub::*;
-/// # use builder::publisher::PublisherFactoryBuilder;
-/// # use client::PublisherFactory;
-/// let factory = PublisherFactory::builder().build().await?;
-/// let publisher = factory.publisher("projects/my-project/topics/topic").build();
+/// # use builder::publisher::ClientBuilder;
+/// # use client::Client;
+/// let client = Client::builder().build().await?;
+/// let publisher = client.publisher("projects/my-project/topics/topic").build();
 /// # Ok(()) }
 /// ```
 #[derive(Clone, Debug)]
@@ -159,10 +159,10 @@ impl PublisherBuilder {
     ///
     /// # Example
     /// ```
-    /// # use google_cloud_pubsub::client::PublisherFactory;
+    /// # use google_cloud_pubsub::client::Client;
     /// # async fn sample() -> anyhow::Result<()> {
-    /// # let factory = PublisherFactory::builder().build().await?;
-    /// let publisher = factory.publisher("projects/my-project/topics/my-topic")
+    /// # let client = Client::builder().build().await?;
+    /// let publisher = client.publisher("projects/my-project/topics/my-topic")
     ///     .set_message_count_threshold(100)
     ///     .build();
     /// # Ok(()) }
@@ -178,11 +178,11 @@ impl PublisherBuilder {
     ///
     /// # Example
     /// ```
-    /// # use google_cloud_pubsub::client::PublisherFactory;
+    /// # use google_cloud_pubsub::client::Client;
     /// # use std::time::Duration;
     /// # async fn sample() -> anyhow::Result<()> {
-    /// # let factory = PublisherFactory::builder().build().await?;
-    /// let publisher = factory.publisher("projects/my-project/topics/my-topic")
+    /// # let client = Client::builder().build().await?;
+    /// let publisher = client.publisher("projects/my-project/topics/my-topic")
     ///     .set_delay_threshold(Duration::from_millis(50))
     ///     .build();
     /// # Ok(()) }
@@ -431,7 +431,7 @@ impl Batch {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::{client::PublisherFactory, publisher::options::BatchingOptions};
+    use crate::{client::Client, publisher::options::BatchingOptions};
     use crate::{
         generated::gapic_dataplane::client::Publisher as GapicPublisher,
         model::{PublishResponse, PubsubMessage},
@@ -792,16 +792,16 @@ mod tests {
 
     #[tokio::test]
     async fn builder() -> anyhow::Result<()> {
-        let factory = PublisherFactory::builder().build().await?;
-        let builder = factory.publisher("projects/my-project/topics/my-topic".to_string());
+        let client = Client::builder().build().await?;
+        let builder = client.publisher("projects/my-project/topics/my-topic".to_string());
         let publisher = builder.set_message_count_threshold(1_u32).build();
         assert_eq!(publisher.batching_options.message_count_threshold, 1_u32);
         Ok(())
     }
 
     #[tokio::test]
     async fn default_batching() -> anyhow::Result<()> {
-        let client = PublisherFactory::builder().build().await?;
+        let client = Client::builder().build().await?;
         let publisher = client
             .publisher("projects/my-project/topics/my-topic".to_string())
             .build();
@@ -829,7 +829,7 @@ mod tests {
             .set_message_count_threshold(MAX_MESSAGES + 1)
             .set_byte_threshold(MAX_BYTES + 1);
 
-        let client = PublisherFactory::builder().build().await?;
+        let client = Client::builder().build().await?;
         let publisher = client
             .publisher("projects/my-project/topics/my-topic".to_string())
             .set_delay_threshold(oversized_options.delay_threshold)