google-cloud-pubsub 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ba8847f393a5fc464ab63f9d6bca1a7e501c8457afa477486a9bd9c44e6d126
-  data.tar.gz: '034684fa844d264673c7e79ea17deeea9edc329de16376863e736a5f0825c256'
+  metadata.gz: c1306c932b52a6c12aa2aa1e6ba1100ca90ae78a364ce07d8c5844c517c547f4
+  data.tar.gz: f6b9413d4d64cebd698f02b7e7a169da5066c9f05d967432ac69737f1e8d76e5
 SHA512:
-  metadata.gz: 8a0e87a57f3fbb1522fd4cf5d93d1c0e03e10ecc5cd2c65b2f0ecfc8aabda230370f6118e9f52c9aadc4763ada09ff6bd0128539fa6469f68d22a327292f3403
-  data.tar.gz: b18e4d310dbfa486b4b40ed4a6bd657c484c4416517b890bc65889644f928d523b8c447b9b0d3b15980cc80673a9fc2ec3927a6eaff9dd742038f999ac51cee0
+  metadata.gz: ebd17aea2e53e2b4fbcaa7b5dd76954fe73aa6eb36402db2014e7d7904df0db022f49a7a2cac574567b9f58c70632f7d4360b12c9a96fed15e1f1f133e3a9df2
+  data.tar.gz: a1c0e15330824046f66db7ccb5105b16ee07984c36080338d38302ace2c1c5fded2c3e59ba4979c0d4e63c7becdc425a1b25587fda71508b86492cd03fadf8ba

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 1.5.0 / 2020-03-25
+
+#### Features
+
+* Add max_duration_per_lease_extension to Subscription#listen and Subscriber
+
 ### 1.4.0 / 2020-03-11
 
 #### Features

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

@@ -104,6 +104,7 @@ module Google
         # received messages.
         #
         # @return [Subscriber] returns self so calls can be chained.
+        #
         def start
           start_pool = synchronize do
             @started = true
@@ -129,6 +130,7 @@ module Google
         # received messages have been processed or released.
         #
         # @return [Subscriber] returns self so calls can be chained.
+        #
         def stop
           stop_pool = synchronize do
             @started = false
@@ -158,6 +160,7 @@ module Google
         #   subscriber is fully stopped. Default will block indefinitely.
         #
         # @return [Subscriber] returns self so calls can be chained.
+        #
         def wait! timeout = nil
           wait_pool = synchronize do
             @stream_pool.map do |stream|
@@ -190,6 +193,7 @@ module Google
         # Whether the subscriber has been started.
         #
         # @return [boolean] `true` when started, `false` otherwise.
+        #
         def started?
           synchronize { @started }
         end
@@ -198,6 +202,7 @@ module Google
         # Whether the subscriber has been stopped.
         #
         # @return [boolean] `true` when stopped, `false` otherwise.
+        #
         def stopped?
           synchronize { @stopped }
         end
@@ -279,6 +284,9 @@ module Google
 
         ##
         # The number of received messages to be collected by subscriber. Default is 1,000.
+        #
+        # @return [Integer] The maximum number of messages.
+        #
         def max_outstanding_messages
           @inventory[:max_outstanding_messages]
         end
@@ -289,6 +297,9 @@ module Google
 
         ##
         # The total byte size of received messages to be collected by subscriber. Default is 100,000,000 (100MB).
+        #
+        # @return [Integer] The maximum number of bytes.
+        #
         def max_outstanding_bytes
           @inventory[:max_outstanding_bytes]
         end
@@ -297,19 +308,33 @@ module Google
 
         ##
         # The number of seconds that received messages can be held awaiting processing. Default is 3,600 (1 hour).
+        #
+        # @return [Integer] The maximum number of seconds.
+        #
         def max_total_lease_duration
           @inventory[:max_total_lease_duration]
         end
         # @deprecated Use {#max_total_lease_duration}.
         alias inventory_extension max_total_lease_duration
 
+        ##
+        # The maximum amount of time in seconds for a single lease extension attempt. Bounds the delay before a message
+        # redelivery if the subscriber fails to extend the deadline. Default is 0 (disabled).
+        #
+        # @return [Integer] The maximum number of seconds.
+        #
+        def max_duration_per_lease_extension
+          @inventory[:max_duration_per_lease_extension]
+        end
+
         ##
         # @private
         def stream_inventory
           {
-            limit:     @inventory[:max_outstanding_messages].fdiv(@streams).ceil,
-            bytesize:  @inventory[:max_outstanding_bytes].fdiv(@streams).ceil,
-            extension: @inventory[:max_total_lease_duration]
+            limit:                            @inventory[:max_outstanding_messages].fdiv(@streams).ceil,
+            bytesize:                         @inventory[:max_outstanding_bytes].fdiv(@streams).ceil,
+            extension:                        @inventory[:max_total_lease_duration],
+            max_duration_per_lease_extension: @inventory[:max_duration_per_lease_extension]
           }
         end
 
@@ -351,6 +376,7 @@ module Google
           @inventory[:max_outstanding_messages] = Integer(@inventory[:max_outstanding_messages] || 1000)
           @inventory[:max_outstanding_bytes] = Integer(@inventory[:max_outstanding_bytes] || 100_000_000)
           @inventory[:max_total_lease_duration] = Integer(@inventory[:max_total_lease_duration] || 3600)
+          @inventory[:max_duration_per_lease_extension] = Integer(@inventory[:max_duration_per_lease_extension] || 0)
         end
 
         def default_error_callbacks

data/lib/google/cloud/pubsub/subscriber/inventory.rb

@@ -30,14 +30,15 @@ module Google
 
           include MonitorMixin
 
-          attr_reader :stream, :limit, :bytesize, :extension
+          attr_reader :stream, :limit, :bytesize, :extension, :max_duration_per_lease_extension
 
-          def initialize stream, limit:, bytesize:, extension:
+          def initialize stream, limit:, bytesize:, extension:, max_duration_per_lease_extension:
             super()
             @stream = stream
             @limit = limit
             @bytesize = bytesize
             @extension = extension
+            @max_duration_per_lease_extension = max_duration_per_lease_extension
             @inventory = {}
             @wait_cond = new_cond
           end
@@ -152,7 +153,9 @@ module Google
           end
 
           def calc_delay
-            (stream.subscriber.deadline - 3) * rand(0.8..0.9)
+            delay = (stream.subscriber.deadline - 3) * rand(0.8..0.9)
+            delay = [delay, max_duration_per_lease_extension].min if max_duration_per_lease_extension.positive?
+            delay
           end
         end
       end

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

@@ -699,6 +699,9 @@ module Google
         #       subscriber. Default is 100,000,000 (100MB). (Note: replaces `:bytesize`, which is deprecated.)
         #     * `:max_total_lease_duration` [Integer] The number of seconds that received messages can be held awaiting
         #       processing. Default is 3,600 (1 hour). (Note: replaces `:extension`, which is deprecated.)
+        #     * `:max_duration_per_lease_extension` [Integer] The maximum amount of time in seconds for a single lease
+        #       extension attempt. Bounds the delay before a message redelivery if the subscriber fails to extend the
+        #       deadline. Default is 0 (disabled).
         # @param [Hash] threads The number of threads to create to handle
         #   concurrent calls by each stream opened by the subscriber. Optional.
         #
@@ -774,6 +777,25 @@ module Google
         #   # Shut down the subscriber when ready to stop receiving messages.
         #   subscriber.stop.wait!
         #
+        # @example Set the maximum amount of time before redelivery if the subscriber fails to extend the deadline:
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   sub = pubsub.subscription "my-topic-sub"
+        #
+        #   subscriber = sub.listen inventory: { max_duration_per_lease_extension: 20 } do |received_message|
+        #     # Process message very slowly with possibility of failure.
+        #     process rec_message.data # takes minutes
+        #     rec_message.acknowledge!
+        #   end
+        #
+        #   # Start background threads that will call block passed to listen.
+        #   subscriber.start
+        #
+        #   # Shut down the subscriber when ready to stop receiving messages.
+        #   subscriber.stop.wait!
+        #
         def listen deadline: nil, message_ordering: nil, streams: nil, inventory: nil, threads: {}, &block
           ensure_service!
           deadline ||= self.deadline

data/lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

@@ -293,6 +293,15 @@ module Google
       #     operations on the subscription. If `expiration_policy` is not set, a
       #     *default policy* with `ttl` of 31 days will be used. The minimum allowed
       #     value for `expiration_policy.ttl` is 1 day.
+      # @!attribute [rw] filter
+      #   @return [String]
+      #     An expression written in the Cloud Pub/Sub filter language. If non-empty,
+      #     then only `PubsubMessage`s whose `attributes` field matches the filter are
+      #     delivered on this subscription. If empty, then no messages are filtered
+      #     out.
+      #     <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+      #     API might be changed in backward-incompatible ways and is not recommended
+      #     for production use. It is not subject to any SLA or deprecation policy.
       # @!attribute [rw] dead_letter_policy
       #   @return [Google::Cloud::PubSub::V1::DeadLetterPolicy]
       #     A policy that specifies the conditions for dead lettering messages in
@@ -306,8 +315,41 @@ module Google
       #     <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
       #     API might be changed in backward-incompatible ways and is not recommended
       #     for production use. It is not subject to any SLA or deprecation policy.
+      # @!attribute [rw] retry_policy
+      #   @return [Google::Cloud::PubSub::V1::RetryPolicy]
+      #     A policy that specifies how Cloud Pub/Sub retries message delivery for this
+      #     subscription.
+      #
+      #     If not set, the default retry policy is applied. This generally implies
+      #     that messages will be retried as soon as possible for healthy subscribers.
+      #     RetryPolicy will be triggered on NACKs or acknowledgement deadline
+      #     exceeded events for a given message.
+      #     <b>EXPERIMENTAL:</b> This API might be changed in backward-incompatible
+      #     ways and is not recommended for production use. It is not subject to any
+      #     SLA or deprecation policy.
       class Subscription; end
 
+      # A policy that specifies how Cloud Pub/Sub retries message delivery.
+      #
+      # Retry delay will be exponential based on provided minimum and maximum
+      # backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
+      #
+      # RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded
+      # events for a given message.
+      #
+      # Retry Policy is implemented on a best effort basis. At times, the delay
+      # between consecutive deliveries may not match the configuration. That is,
+      # delay can be more or less than configured backoff.
+      # @!attribute [rw] minimum_backoff
+      #   @return [Google::Protobuf::Duration]
+      #     The minimum delay between consecutive deliveries of a given message.
+      #     Value should be between 0 and 600 seconds. Defaults to 10 seconds.
+      # @!attribute [rw] maximum_backoff
+      #   @return [Google::Protobuf::Duration]
+      #     The maximum delay between consecutive deliveries of a given message.
+      #     Value should be between 0 and 600 seconds. Defaults to 600 seconds.
+      class RetryPolicy; end
+
       # Dead lettering is done on a best effort basis. The same message might be
       # dead lettered multiple times.
       #

data/lib/google/cloud/pubsub/v1/publisher_client.rb

@@ -110,6 +110,8 @@ module Google
           end
 
           # Returns a fully-qualified topic resource name string.
+          # @deprecated Multi-pattern resource names will have unified creation and parsing helper functions.
+          # This helper function will be deleted in the next major version.
           # @param project [String]
           # @param topic [String]
           # @return [String]
@@ -678,11 +680,13 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
           #
           #   # TODO: Initialize `policy`:
           #   policy = {}
-          #   response = publisher_client.set_iam_policy(formatted_resource, policy)
+          #   response = publisher_client.set_iam_policy(resource, policy)
 
           def set_iam_policy \
               resource,
@@ -720,8 +724,10 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
-          #   response = publisher_client.get_iam_policy(formatted_resource)
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
+          #   response = publisher_client.get_iam_policy(resource)
 
           def get_iam_policy \
               resource,
@@ -764,11 +770,13 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   publisher_client = Google::Cloud::PubSub::Publisher.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
           #
           #   # TODO: Initialize `permissions`:
           #   permissions = []
-          #   response = publisher_client.test_iam_permissions(formatted_resource, permissions)
+          #   response = publisher_client.test_iam_permissions(resource, permissions)
 
           def test_iam_permissions \
               resource,

data/lib/google/cloud/pubsub/v1/subscriber_client.rb

@@ -134,6 +134,8 @@ module Google
           end
 
           # Returns a fully-qualified topic resource name string.
+          # @deprecated Multi-pattern resource names will have unified creation and parsing helper functions.
+          # This helper function will be deleted in the next major version.
           # @param project [String]
           # @param topic [String]
           # @return [String]
@@ -501,6 +503,14 @@ module Google
           #   value for `expiration_policy.ttl` is 1 day.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::ExpirationPolicy`
           #   can also be provided.
+          # @param filter [String]
+          #   An expression written in the Cloud Pub/Sub filter language. If non-empty,
+          #   then only `PubsubMessage`s whose `attributes` field matches the filter are
+          #   delivered on this subscription. If empty, then no messages are filtered
+          #   out.
+          #   <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+          #   API might be changed in backward-incompatible ways and is not recommended
+          #   for production use. It is not subject to any SLA or deprecation policy.
           # @param dead_letter_policy [Google::Cloud::PubSub::V1::DeadLetterPolicy | Hash]
           #   A policy that specifies the conditions for dead lettering messages in
           #   this subscription. If dead_letter_policy is not set, dead lettering
@@ -515,6 +525,19 @@ module Google
           #   for production use. It is not subject to any SLA or deprecation policy.
           #   A hash of the same form as `Google::Cloud::PubSub::V1::DeadLetterPolicy`
           #   can also be provided.
+          # @param retry_policy [Google::Cloud::PubSub::V1::RetryPolicy | Hash]
+          #   A policy that specifies how Cloud Pub/Sub retries message delivery for this
+          #   subscription.
+          #
+          #   If not set, the default retry policy is applied. This generally implies
+          #   that messages will be retried as soon as possible for healthy subscribers.
+          #   RetryPolicy will be triggered on NACKs or acknowledgement deadline
+          #   exceeded events for a given message.
+          #   <b>EXPERIMENTAL:</b> This API might be changed in backward-incompatible
+          #   ways and is not recommended for production use. It is not subject to any
+          #   SLA or deprecation policy.
+          #   A hash of the same form as `Google::Cloud::PubSub::V1::RetryPolicy`
+          #   can also be provided.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -541,7 +564,9 @@ module Google
               labels: nil,
               enable_message_ordering: nil,
               expiration_policy: nil,
+              filter: nil,
               dead_letter_policy: nil,
+              retry_policy: nil,
               options: nil,
               &block
             req = {
@@ -554,7 +579,9 @@ module Google
               labels: labels,
               enable_message_ordering: enable_message_ordering,
               expiration_policy: expiration_policy,
-              dead_letter_policy: dead_letter_policy
+              filter: filter,
+              dead_letter_policy: dead_letter_policy,
+              retry_policy: retry_policy
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Cloud::PubSub::V1::Subscription)
             @create_subscription.call(req, options, &block)
@@ -1279,11 +1306,13 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   subscriber_client = Google::Cloud::PubSub::Subscriber.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
           #
           #   # TODO: Initialize `policy`:
           #   policy = {}
-          #   response = subscriber_client.set_iam_policy(formatted_resource, policy)
+          #   response = subscriber_client.set_iam_policy(resource, policy)
 
           def set_iam_policy \
               resource,
@@ -1321,8 +1350,10 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   subscriber_client = Google::Cloud::PubSub::Subscriber.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
-          #   response = subscriber_client.get_iam_policy(formatted_resource)
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
+          #   response = subscriber_client.get_iam_policy(resource)
 
           def get_iam_policy \
               resource,
@@ -1365,11 +1396,13 @@ module Google
           #   require "google/cloud/pubsub"
           #
           #   subscriber_client = Google::Cloud::PubSub::Subscriber.new(version: :v1)
-          #   formatted_resource = Google::Cloud::PubSub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
+          #
+          #   # TODO: Initialize `resource`:
+          #   resource = ''
           #
           #   # TODO: Initialize `permissions`:
           #   permissions = []
-          #   response = subscriber_client.test_iam_permissions(formatted_resource, permissions)
+          #   response = subscriber_client.test_iam_permissions(resource, permissions)
 
           def test_iam_permissions \
               resource,

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module PubSub
-      VERSION = "1.4.0".freeze
+      VERSION = "1.5.0".freeze
     end
 
     Pubsub = PubSub unless const_defined? :Pubsub

data/lib/google/pubsub/v1/pubsub_pb.rb

@@ -83,7 +83,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     map :labels, :string, :string, 9
     optional :enable_message_ordering, :bool, 10
     optional :expiration_policy, :message, 11, "google.pubsub.v1.ExpirationPolicy"
+    optional :filter, :string, 12
     optional :dead_letter_policy, :message, 13, "google.pubsub.v1.DeadLetterPolicy"
+    optional :retry_policy, :message, 14, "google.pubsub.v1.RetryPolicy"
+  end
+  add_message "google.pubsub.v1.RetryPolicy" do
+    optional :minimum_backoff, :message, 1, "google.protobuf.Duration"
+    optional :maximum_backoff, :message, 2, "google.protobuf.Duration"
   end
   add_message "google.pubsub.v1.DeadLetterPolicy" do
     optional :dead_letter_topic, :string, 1
@@ -223,6 +229,7 @@ module Google::Cloud::PubSub::V1
   ListTopicSnapshotsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListTopicSnapshotsResponse").msgclass
   DeleteTopicRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.DeleteTopicRequest").msgclass
   Subscription = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.Subscription").msgclass
+  RetryPolicy = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.RetryPolicy").msgclass
   DeadLetterPolicy = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.DeadLetterPolicy").msgclass
   ExpirationPolicy = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ExpirationPolicy").msgclass
   PushConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PushConfig").msgclass

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby