google-cloud-pubsub 2.15.3 → 3.0.2

data/lib/google/cloud/pubsub/admin_clients.rb

@@ -0,0 +1,116 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/cloud/pubsub/v1/topic_admin/client"
+require "google/cloud/pubsub/v1/subscription_admin/client"
+
+module Google
+  module Cloud
+    module PubSub
+      module TopicAdmin
+        ##
+        # The TopicAdmin client is used to manage topics.
+        #
+        # This client is a subclass of the auto-generated TopicAdmin client, and provides
+        # the same methods. However, it raises errors on data plane operations
+        # to prevent misuse.
+        #
+        class Client < Google::Cloud::PubSub::V1::TopicAdmin::Client
+          # @private
+          alias publish_internal publish
+
+          ##
+          # The `publish` method is a data plane operation.
+          #
+          # @raise [NotImplementedError] This method is not implemented on the
+          #   admin client. Use {Google::Cloud::PubSub::Publisher} instead.
+          #
+          def publish *args, **kwargs
+            raise NotImplementedError,
+                  "The `publish` method is a data plane operation. " \
+                  "Use Google::Cloud::PubSub::Publisher instead."
+          end
+        end
+      end
+
+      module SubscriptionAdmin
+        ##
+        # The SubscriptionAdmin client is used to manage subscriptions.
+        #
+        # This client is a subclass of the auto-generated SubscriptionAdmin client, and
+        # provides the same methods. However, it raises errors on data plane
+        # operations to prevent misuse.
+        #
+        class Client < Google::Cloud::PubSub::V1::SubscriptionAdmin::Client
+          # @private
+          alias modify_ack_deadline_internal modify_ack_deadline
+          # @private
+          alias acknowledge_internal acknowledge
+          # @private
+          alias pull_internal pull
+          # @private
+          alias streaming_pull_internal streaming_pull
+
+          ##
+          # The `modify_ack_deadline` method is a data plane operation.
+          #
+          # @raise [NotImplementedError] This method is not implemented on the
+          #   admin client. Use {Google::Cloud::PubSub::Subscriber} instead.
+          #
+          def modify_ack_deadline *args, **kwargs
+            raise NotImplementedError,
+                  "The `modify_ack_deadline` method is a data plane operation. " \
+                  "Use Google::Cloud::PubSub::Subscriber instead."
+          end
+
+          ##
+          # The `acknowledge` method is a data plane operation.
+          #
+          # @raise [NotImplementedError] This method is not implemented on the
+          #   admin client. Use {Google::Cloud::PubSub::Subscriber} instead.
+          #
+          def acknowledge *args, **kwargs
+            raise NotImplementedError,
+                  "The `acknowledge` method is a data plane operation. " \
+                  "Use Google::Cloud::PubSub::Subscriber instead."
+          end
+
+          ##
+          # The `pull` method is a data plane operation.
+          #
+          # @raise [NotImplementedError] This method is not implemented on the
+          #   admin client. Use {Google::Cloud::PubSub::Subscriber} instead.
+          #
+          def pull *args, **kwargs
+            raise NotImplementedError,
+                  "The `pull` method is a data plane operation. " \
+                  "Use Google::Cloud::PubSub::Subscriber instead."
+          end
+
+          ##
+          # The `streaming_pull` method is a data plane operation.
+          #
+          # @raise [NotImplementedError] This method is not implemented on the
+          #   admin client. Use {Google::Cloud::PubSub::Subscriber} instead.
+          #
+          def streaming_pull *args, **kwargs
+            raise NotImplementedError,
+                  "The `streaming_pull` method is a data plane operation. " \
+                  "Use Google::Cloud::PubSub::Subscriber instead."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/pubsub/async_publisher.rb

@@ -27,15 +27,15 @@ module Google
     module PubSub
       ##
       # Used to publish multiple messages in batches to a topic. See
-      # {Google::Cloud::PubSub::Topic#async_publisher}
+      # {Google::Cloud::PubSub::Publisher#async_publisher}
       #
       # @example
       #   require "google/cloud/pubsub"
       #
       #   pubsub = Google::Cloud::PubSub.new
       #
-      #   topic = pubsub.topic "my-topic"
-      #   topic.publish_async "task completed" do |result|
+      #   publisher = pubsub.publisher "my-topic"
+      #   publisher.publish_async "task completed" do |result|
       #     if result.succeeded?
       #       log_publish_success result.data
       #     else
@@ -43,7 +43,7 @@ module Google
       #     end
       #   end
       #
-      #   topic.async_publisher.stop!
+      #   publisher.async_publisher.stop!
       #
       # @attr_reader [String] topic_name The name of the topic the messages are published to. The value is a
       #   fully-qualified topic name in the form `projects/{project_id}/topics/{topic_id}`.
@@ -116,7 +116,7 @@ module Google
         ##
         # Add a message to the async publisher to be published to the topic.
         # Messages will be collected in batches and published together.
-        # See {Google::Cloud::PubSub::Topic#publish_async}
+        # See {Google::Cloud::PubSub::Publisher#publish_async}
         #
         # @param [String, File] data The message payload. This will be converted
         #   to bytes encoded as ASCII-8BIT.
@@ -262,8 +262,8 @@ module Google
         # enabled, messages published with the same `ordering_key` will be
         # delivered in the order they were published.
         #
-        # See {#message_ordering?}. See {Topic#publish_async},
-        # {Subscription#listen}, and {Message#ordering_key}.
+        # See {#message_ordering?}. See {Publisher#publish_async},
+        # {Subscriber#listen}, and {Message#ordering_key}.
         #
         def enable_message_ordering!
           synchronize { @ordered = true }
@@ -275,8 +275,8 @@ module Google
         # will be delivered in the order they were published. When disabled,
         # messages may be delivered in any order.
         #
-        # See {#enable_message_ordering!}. See {Topic#publish_async},
-        # {Subscription#listen}, and {Message#ordering_key}.
+        # See {#enable_message_ordering!}. See {Publisher#publish_async},
+        # {Subscriber#listen}, and {Message#ordering_key}.
         #
         # @return [Boolean]
         #

data/lib/google/cloud/pubsub/batch_publisher.rb

@@ -27,8 +27,8 @@ module Google
       #
       #   pubsub = Google::Cloud::PubSub.new
       #
-      #   topic = pubsub.topic "my-topic"
-      #   msgs = topic.publish do |batch_publisher|
+      #   publisher = pubsub.publisher "my-topic"
+      #   msgs = publisher.publish do |batch_publisher|
       #     batch_publisher.publish "task 1 completed", foo: :bar
       #     batch_publisher.publish "task 2 completed", foo: :baz
       #     batch_publisher.publish "task 3 completed", foo: :bif
@@ -86,8 +86,8 @@ module Google
         #
         #   pubsub = Google::Cloud::PubSub.new
         #
-        #   topic = pubsub.topic "my-topic"
-        #   msgs = topic.publish do |batch_publisher|
+        #   publisher = pubsub.publisher "my-topic"
+        #   msgs = publisher.publish do |batch_publisher|
         #     batch_publisher.publish "task 1 completed", foo: :bar
         #     batch_publisher.publish "task 2 completed", foo: :baz
         #     batch_publisher.publish "task 3 completed", foo: :bif

data/lib/google/cloud/pubsub/convert.rb

@@ -69,7 +69,7 @@ module Google
             data_bytes = String(data).dup.force_encoding(Encoding::ASCII_8BIT).freeze
 
             # Convert attributes to strings to match the protobuf definition
-            attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
+            attributes = attributes.to_h { |k, v| [String(k), String(v)] }
 
             # Ordering Key must always be a string
             ordering_key = String(ordering_key).freeze

data/lib/google/cloud/pubsub/errors.rb

@@ -41,7 +41,7 @@ module Google
       end
 
       ##
-      # Indicates that the {Subscriber} for a {Subscription} with message
+      # Indicates that the {MessageListener} for a {Subscriber} with message
       # ordering enabled has observed that a message has been delivered out of
       # order.
       #
@@ -57,11 +57,11 @@ module Google
 
       ##
       # Indicates that messages using the {#ordering_key} are not being
-      # published due to error. Future calls to {Topic#publish_async} with the
+      # published due to error. Future calls to {Publisher#publish_async} with the
       # {#ordering_key} will fail with this error.
       #
       # To allow future messages with the {#ordering_key} to be published, the
-      # {#ordering_key} must be passed to {Topic#resume_publish}.
+      # {#ordering_key} must be passed to {Publisher#resume_publish}.
       #
       # If this error is retrieved from {PublishResult#error}, inspect `cause`
       # for the error raised while publishing.

data/lib/google/cloud/pubsub/flow_controller.rb

@@ -84,7 +84,6 @@ module Google
 
         protected
 
-        # rubocop:disable Style/IdenticalConditionalBranches
         # rubocop:disable Style/GuardClause
 
         def acquire_or_wait message_size
@@ -117,7 +116,6 @@ module Google
           end
         end
 
-        # rubocop:enable Style/IdenticalConditionalBranches
         # rubocop:enable Style/GuardClause
 
         def is_new_and_others_wait? waiter

data/lib/google/cloud/pubsub/message.rb

@@ -24,7 +24,7 @@ module Google
       #
       # Represents a Pub/Sub Message.
       #
-      # Message objects are created by {Topic#publish}. {Subscription#pull}
+      # Message objects are created by {Publisher#publish}. {Subscriber#pull}
       # returns an array of {ReceivedMessage} objects, each of which contains a
       # Message object. Each {ReceivedMessage} object can be acknowledged and/or
       # delayed.
@@ -35,22 +35,22 @@ module Google
       #   pubsub = Google::Cloud::PubSub.new
       #
       #   # Publish a message
-      #   topic = pubsub.topic "my-topic"
-      #   message = topic.publish "task completed"
+      #   publisher = pubsub.publisher "my-topic"
+      #   message = publisher.publish "task completed"
       #   message.data #=> "task completed"
       #
       #   # Listen for messages
-      #   sub = pubsub.subscription "my-topic-sub"
-      #   subscriber = sub.listen do |received_message|
+      #   subscriber = pubsub.subscriber "my-topic-sub"
+      #   listener = subscriber.listen do |received_message|
       #     # process message
       #     received_message.acknowledge!
       #   end
       #
       #   # Start background threads that will call the block passed to listen.
-      #   subscriber.start
+      #   listener.start
       #
       #   # Shut down the subscriber when ready to stop receiving messages.
-      #   subscriber.stop!
+      #   listener.stop!
       #
       class Message
         ##
@@ -62,7 +62,7 @@ module Google
         # This can be used to publish several messages in bulk.
         def initialize data = nil, attributes = {}
           # Convert attributes to strings to match the protobuf definition
-          attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
+          attributes = attributes.to_h { |k, v| [String(k), String(v)] }
 
           @grpc = Google::Cloud::PubSub::V1::PubsubMessage.new(
             data:       String(data).dup.force_encoding(Encoding::ASCII_8BIT),
@@ -81,8 +81,7 @@ module Google
         # Optional attributes for the message.
         def attributes
           return @grpc.attributes.to_h if @grpc.attributes.respond_to? :to_h
-          # Enumerable doesn't have to_h on Ruby 2.0, so fallback to this
-          Hash[@grpc.attributes.to_a]
+          @grpc.attributes.to_a.to_h
         end
 
         ##
@@ -114,7 +113,7 @@ module Google
         # or scalability, as the service automatically distributes messages for
         # different ordering keys across subscribers.
         #
-        # See {Topic#publish_async} and {Subscription#listen}.
+        # See {Publisher#publish_async} and {Subscriber#listen}.
         #
         # @return [String]
         #

data/lib/google/cloud/pubsub/{subscriber → message_listener}/enumerator_queue.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      class Subscriber
+      class MessageListener
         # @private
         class EnumeratorQueue
           def initialize sentinel = nil

data/lib/google/cloud/pubsub/{subscriber → message_listener}/inventory.rb

@@ -18,7 +18,7 @@ require "monitor"
 module Google
   module Cloud
     module PubSub
-      class Subscriber
+      class MessageListener
         ##
         # @private
         class Inventory
@@ -36,10 +36,9 @@ module Google
           attr_reader :extension
           attr_reader :max_duration_per_lease_extension
           attr_accessor :min_duration_per_lease_extension
-          attr_reader :use_legacy_flow_control
 
           def initialize stream, limit:, bytesize:, extension:, max_duration_per_lease_extension:,
-                         min_duration_per_lease_extension:, use_legacy_flow_control:
+                         min_duration_per_lease_extension:
             super()
             @stream = stream
             @limit = limit
@@ -47,7 +46,6 @@ module Google
             @extension = extension
             @max_duration_per_lease_extension = max_duration_per_lease_extension
             @min_duration_per_lease_extension = min_duration_per_lease_extension
-            @use_legacy_flow_control = use_legacy_flow_control
             @inventory = {}
             @wait_cond = new_cond
           end

data/lib/google/cloud/pubsub/{subscriber → message_listener}/sequencer.rb

@@ -18,7 +18,7 @@ require "monitor"
 module Google
   module Cloud
     module PubSub
-      class Subscriber
+      class MessageListener
         ##
         # @private The sequencer's job is simple, keep track of all the
         # streams's recieved message and deliver the messages with an

data/lib/google/cloud/pubsub/{subscriber → message_listener}/stream.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 
-require "google/cloud/pubsub/subscriber/sequencer"
-require "google/cloud/pubsub/subscriber/enumerator_queue"
-require "google/cloud/pubsub/subscriber/inventory"
+require "google/cloud/pubsub/message_listener/sequencer"
+require "google/cloud/pubsub/message_listener/enumerator_queue"
+require "google/cloud/pubsub/message_listener/inventory"
 require "google/cloud/pubsub/service"
 require "google/cloud/errors"
 require "monitor"
@@ -24,7 +24,7 @@ require "concurrent"
 module Google
   module Cloud
     module PubSub
-      class Subscriber
+      class MessageListener
         ##
         # @private
         class Stream
@@ -231,7 +231,8 @@ module Google
             end
 
             # Call the StreamingPull API to get the response enumerator
-            enum = @subscriber.service.streaming_pull @request_queue.each
+            options = { :"metadata" => { :"x-goog-request-params" =>  @subscriber.subscription_name } }
+            enum = @subscriber.service.streaming_pull @request_queue.each, options
 
             loop do
               synchronize do
@@ -245,7 +246,7 @@ module Google
               break if synchronize { @stopped }
 
               begin
-                # Cannot syncronize the enumerator, causes deadlock
+                # Cannot synchronize the enumerator, causes deadlock
                 response = enum.next
                 new_exactly_once_delivery_enabled = response&.subscription_properties&.exactly_once_delivery_enabled
                 received_messages = response.received_messages
@@ -253,7 +254,7 @@ module Google
                 # Use synchronize so changes happen atomically
                 synchronize do
                   update_min_duration_per_lease_extension new_exactly_once_delivery_enabled
-                  @exactly_once_delivery_enabled = new_exactly_once_delivery_enabled unless new_exactly_once_delivery_enabled.nil? 
+                  @exactly_once_delivery_enabled = new_exactly_once_delivery_enabled unless new_exactly_once_delivery_enabled.nil?
                   @subscriber.exactly_once_delivery_enabled = @exactly_once_delivery_enabled
 
                   # Create receipt of received messages reception
@@ -271,7 +272,7 @@ module Google
                   # No need to synchronize the callback future
                   register_callback rec_msg
                 end if !@exactly_once_delivery_enabled # Exactly once delivery scenario is handled by callback
-                
+
                 synchronize { pause_streaming! }
               rescue StopIteration
                 break
@@ -371,8 +372,8 @@ module Google
           end
 
           def pause_streaming?
-            return if @stopped
-            return if @paused
+            return false if @stopped
+            return false if @paused
 
             @inventory.full?
           end
@@ -386,8 +387,8 @@ module Google
           end
 
           def unpause_streaming?
-            return if @stopped
-            return if @paused.nil?
+            return false if @stopped
+            return false if @paused.nil?
 
             @inventory.count < @inventory.limit * 0.8
           end
@@ -399,8 +400,8 @@ module Google
               req.modify_deadline_ack_ids += @inventory.ack_ids
               req.modify_deadline_seconds += @inventory.ack_ids.map { @subscriber.deadline }
               req.client_id = @subscriber.service.client_id
-              req.max_outstanding_messages = @inventory.use_legacy_flow_control ? 0 : @inventory.limit
-              req.max_outstanding_bytes = @inventory.use_legacy_flow_control ? 0 : @inventory.bytesize
+              req.max_outstanding_messages = @inventory.limit
+              req.max_outstanding_bytes = @inventory.bytesize
             end
           end
 

data/lib/google/cloud/pubsub/{subscriber → message_listener}/timed_unary_buffer.rb

@@ -22,7 +22,7 @@ require "retriable"
 module Google
   module Cloud
     module PubSub
-      class Subscriber
+      class MessageListener
         ##
         # @private
         class TimedUnaryBuffer