google-cloud-pubsub 0.20.0 → 2.6.1

data/lib/google/cloud/pubsub/snapshot/list.rb

@@ -0,0 +1,178 @@
+# Copyright 2017 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 "delegate"
+
+module Google
+  module Cloud
+    module PubSub
+      class Snapshot
+        ##
+        # Snapshot::List is a special case Array with additional values.
+        class List < DelegateClass(::Array)
+          ##
+          # If not empty, indicates that there are more snapshots
+          # that match the request and this value should be passed to
+          # the next {Google::Cloud::PubSub::Project#snapshots} to continue.
+          attr_accessor :token
+
+          ##
+          # @private Create a new Snapshot::List with an array of values.
+          def initialize arr = []
+            @prefix = nil
+            @token = nil
+            @max = nil
+            super arr
+          end
+
+          ##
+          # Whether there a next page of snapshots.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud/pubsub"
+          #
+          #   pubsub = Google::Cloud::PubSub.new
+          #
+          #   snapshots = pubsub.snapshots
+          #   if snapshots.next?
+          #     next_snapshots = snapshots.next
+          #   end
+          #
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of snapshots.
+          #
+          # @return [Snapshot::List]
+          #
+          # @example
+          #   require "google/cloud/pubsub"
+          #
+          #   pubsub = Google::Cloud::PubSub.new
+          #
+          #   snapshots = pubsub.snapshots
+          #   if snapshots.next?
+          #     next_snapshots = snapshots.next
+          #   end
+          #
+          def next
+            return nil unless next?
+            ensure_service!
+            next_snapshots
+          end
+
+          ##
+          # Retrieves remaining results by repeatedly invoking {#next} until
+          # {#next?} returns `false`. Calls the given block once for each
+          # result, which is passed as the argument to the block.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method will make repeated API calls until all remaining results
+          # are retrieved. (Unlike `#each`, for example, which merely iterates
+          # over the results returned by a single API call.) Use with caution.
+          #
+          # @param [Integer] request_limit The upper limit of API requests to
+          #   make to load all snapshots. Default is no limit.
+          # @yield [snapshot] The block for accessing each snapshot.
+          # @yieldparam [Snapshot] snapshot The snapshot object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each snapshot by passing a block:
+          #   require "google/cloud/pubsub"
+          #
+          #   pubsub = Google::Cloud::PubSub.new
+          #
+          #   snapshots = pubsub.snapshots
+          #   snapshots.all do |snapshot|
+          #     puts snapshot.name
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud/pubsub"
+          #
+          #   pubsub = Google::Cloud::PubSub.new
+          #
+          #   snapshots = pubsub.snapshots
+          #   all_names = snapshots.all.map do |snapshot|
+          #     snapshot.name
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud/pubsub"
+          #
+          #   pubsub = Google::Cloud::PubSub.new
+          #
+          #   snapshots = pubsub.snapshots
+          #   snapshots.all(request_limit: 10) do |snapshot|
+          #     puts snapshot.name
+          #   end
+          #
+          def all request_limit: nil, &block
+            request_limit = request_limit.to_i if request_limit
+            return enum_for :all, request_limit: request_limit unless block_given?
+            results = self
+            loop do
+              results.each(&block)
+              if request_limit
+                request_limit -= 1
+                break if request_limit.negative?
+              end
+              break unless results.next?
+              results = results.next
+            end
+          end
+
+          ##
+          # @private New Snapshots::List from a
+          # Google::Cloud::PubSub::V1::ListSnapshotsRequest object.
+          def self.from_grpc grpc_list, service, max = nil
+            subs = new(Array(grpc_list.snapshots).map do |grpc|
+              Snapshot.from_grpc grpc, service
+            end)
+            token = grpc_list.next_page_token
+            token = nil if token == "".freeze
+            subs.instance_variable_set :@token,   token
+            subs.instance_variable_set :@service, service
+            subs.instance_variable_set :@max,     max
+            subs
+          end
+
+          protected
+
+          ##
+          # @private Raise an error unless an active connection to the service
+          # is available.
+          def ensure_service!
+            raise "Must have active connection to service" unless @service
+          end
+
+          def next_snapshots
+            options = { prefix: @prefix, token: @token, max: @max }
+            grpc = @service.list_snapshots options
+            self.class.from_grpc grpc, @service, @max
+          end
+        end
+      end
+    end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
+  end
+end

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

@@ -0,0 +1,205 @@
+# Copyright 2017 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/errors"
+require "google/cloud/pubsub/snapshot/list"
+require "google/cloud/pubsub/v1"
+
+module Google
+  module Cloud
+    module PubSub
+      ##
+      # # Snapshot
+      #
+      # A named resource created from a subscription to retain a stream of
+      # messages from a topic. A snapshot is guaranteed to retain:
+      #
+      # * The existing backlog on the subscription. More precisely, this is
+      #   defined as the messages in the subscription's backlog that are
+      #   unacknowledged upon the successful completion of the
+      #   `create_snapshot` operation; as well as:
+      # * Any messages published to the subscription's topic following the
+      #   successful completion of the `create_snapshot` operation.
+      #
+      # @example
+      #   require "google/cloud/pubsub"
+      #
+      #   pubsub = Google::Cloud::PubSub.new
+      #   sub = pubsub.subscription "my-sub"
+      #
+      #   snapshot = sub.create_snapshot "my-snapshot"
+      #   snapshot.name #=> "projects/my-project/snapshots/my-snapshot"
+      #
+      class Snapshot
+        ##
+        # @private The Service object.
+        attr_accessor :service
+
+        ##
+        # @private The gRPC Google::Cloud::PubSub::V1::Snapshot object.
+        attr_accessor :grpc
+
+        ##
+        # @private Create an empty {Snapshot} object.
+        def initialize
+          @service = nil
+          @grpc = Google::Cloud::PubSub::V1::Snapshot.new
+        end
+
+        ##
+        # The name of the snapshot.
+        #
+        # @return [String] A fully-qualified snapshot name in the form
+        #   `projects/{project_id}/snapshots/{snapshot_id}`.
+        def name
+          @grpc.name
+        end
+
+        ##
+        # The {Topic} from which this snapshot is retaining messages.
+        #
+        # @return [Topic]
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #   sub = pubsub.subscription "my-sub"
+        #
+        #   snapshot = sub.create_snapshot "my-snapshot"
+        #   snapshot.topic.name #=> "projects/my-project/topics/my-topic"
+        #
+        def topic
+          Topic.from_name @grpc.topic, service
+        end
+
+        ##
+        # The snapshot is guaranteed to exist up until this time.
+        # A newly-created snapshot expires no later than 7 days from the time of
+        # its creation. Its exact lifetime is determined at creation by the
+        # existing backlog in the source subscription. Specifically, the
+        # lifetime of the snapshot is 7 days - (age of oldest unacked message in
+        # the subscription). For example, consider a subscription whose oldest
+        # unacked message is 3 days old. If a snapshot is created from this
+        # subscription, the snapshot -- which will always capture this 3-day-old
+        # backlog as long as the snapshot exists -- will expire in 4 days.
+        #
+        # @return [Time] The time until which the snapshot is guaranteed to
+        #   exist.
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #   sub = pubsub.subscription "my-sub"
+        #
+        #   snapshot = sub.create_snapshot "my-snapshot"
+        #   snapshot.topic.name #=> "projects/my-project/topics/my-topic"
+        #   snapshot.expiration_time
+        #
+        def expiration_time
+          self.class.timestamp_from_grpc @grpc.expire_time
+        end
+
+        ##
+        # A hash of user-provided labels associated with this snapshot.
+        # Labels can be used to organize and group snapshots.See [Creating and
+        # Managing Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # The returned hash is frozen and changes are not allowed. Use
+        # {#labels=} to update the labels for this snapshot.
+        #
+        # @return [Hash] The frozen labels hash.
+        #
+        def labels
+          @grpc.labels.to_h.freeze
+        end
+
+        ##
+        # Sets the hash of user-provided labels associated with this
+        # snapshot. Labels can be used to organize and group snapshots.
+        # Label keys and values can be no longer than 63 characters, can only
+        # contain lowercase letters, numeric characters, underscores and dashes.
+        # International characters are allowed. Label values are optional. Label
+        # keys must start with a letter and each label in the list must have a
+        # different key. See [Creating and Managing
+        # Labels](https://cloud.google.com/pubsub/docs/labels).
+        #
+        # @param [Hash] new_labels The new labels hash.
+        #
+        def labels= new_labels
+          raise ArgumentError, "Value must be a Hash" if new_labels.nil?
+          labels_map = Google::Protobuf::Map.new :string, :string
+          Hash(new_labels).each { |k, v| labels_map[String(k)] = String(v) }
+          update_grpc = @grpc.dup
+          update_grpc.labels = labels_map
+          @grpc = service.update_snapshot update_grpc, :labels
+        end
+
+        ##
+        # Removes an existing snapshot. All messages retained in the snapshot
+        # are immediately dropped. After a snapshot is deleted, a new one may be
+        # created with the same name, but the new one has no association with
+        # the old snapshot or its subscription, unless the same subscription is
+        # specified.
+        #
+        # @return [Boolean] Returns `true` if the snapshot was deleted.
+        #
+        # @example
+        #   require "google/cloud/pubsub"
+        #
+        #   pubsub = Google::Cloud::PubSub.new
+        #
+        #   pubsub.snapshots.each do |snapshot|
+        #     snapshot.delete
+        #   end
+        #
+        def delete
+          ensure_service!
+          service.delete_snapshot name
+          true
+        end
+
+        ##
+        # @private New Snapshot from a Google::Cloud::PubSub::V1::Snapshot
+        # object.
+        def self.from_grpc grpc, service
+          new.tap do |f|
+            f.grpc = grpc
+            f.service = service
+          end
+        end
+
+        ##
+        # @private Get a Time object from a Google::Protobuf::Timestamp object.
+        def self.timestamp_from_grpc grpc_timestamp
+          return nil if grpc_timestamp.nil?
+          Time.at grpc_timestamp.seconds, Rational(grpc_timestamp.nanos, 1000)
+        end
+
+        protected
+
+        ##
+        # @private Raise an error unless an active connection to the service is
+        # available.
+        def ensure_service!
+          raise "Must have active connection to service" unless service
+        end
+      end
+    end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
+  end
+end

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

@@ -0,0 +1,54 @@
+# Copyright 2017 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.
+
+
+module Google
+  module Cloud
+    module PubSub
+      class Subscriber
+        # @private
+        class EnumeratorQueue
+          def initialize sentinel = nil
+            @queue    = Queue.new
+            @sentinel = sentinel
+          end
+
+          def push obj
+            @queue.push obj
+          end
+
+          def quit_and_dump_queue
+            objs = []
+            objs << @queue.pop until @queue.empty?
+            # Signal that the enumerator is ready to end
+            @queue.push @sentinel
+            objs
+          end
+
+          def each
+            return enum_for :each unless block_given?
+
+            loop do
+              obj = @queue.pop
+              break if obj.equal? @sentinel
+              yield obj
+            end
+          end
+        end
+      end
+    end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
+  end
+end

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

@@ -0,0 +1,173 @@
+# Copyright 2017 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 "monitor"
+
+module Google
+  module Cloud
+    module PubSub
+      class Subscriber
+        ##
+        # @private
+        class Inventory
+          InventoryItem = Struct.new :bytesize, :pulled_at do
+            def self.from rec_msg
+              new rec_msg.to_proto.bytesize, Time.now
+            end
+          end
+
+          include MonitorMixin
+
+          attr_reader :stream
+          attr_reader :limit
+          attr_reader :bytesize
+          attr_reader :extension
+          attr_reader :max_duration_per_lease_extension
+          attr_reader :use_legacy_flow_control
+
+          def initialize stream, limit:, bytesize:, extension:, max_duration_per_lease_extension:,
+                         use_legacy_flow_control:
+            super()
+            @stream = stream
+            @limit = limit
+            @bytesize = bytesize
+            @extension = extension
+            @max_duration_per_lease_extension = max_duration_per_lease_extension
+            @use_legacy_flow_control = use_legacy_flow_control
+            @inventory = {}
+            @wait_cond = new_cond
+          end
+
+          def ack_ids
+            @inventory.keys
+          end
+
+          def add *rec_msgs
+            rec_msgs.flatten!
+            rec_msgs.compact!
+            return if rec_msgs.empty?
+
+            synchronize do
+              rec_msgs.each do |rec_msg|
+                @inventory[rec_msg.ack_id] = InventoryItem.from rec_msg
+              end
+              @wait_cond.broadcast
+            end
+          end
+
+          def remove *ack_ids
+            ack_ids.flatten!
+            ack_ids.compact!
+            return if ack_ids.empty?
+
+            synchronize do
+              @inventory.delete_if { |ack_id, _| ack_ids.include? ack_id }
+              @wait_cond.broadcast
+            end
+          end
+
+          def remove_expired!
+            synchronize do
+              extension_time = Time.new - extension
+              @inventory.delete_if { |_ack_id, item| item.pulled_at < extension_time }
+              @wait_cond.broadcast
+            end
+          end
+
+          def count
+            synchronize do
+              @inventory.count
+            end
+          end
+
+          def total_bytesize
+            synchronize do
+              @inventory.values.sum(&:bytesize)
+            end
+          end
+
+          def empty?
+            synchronize do
+              @inventory.empty?
+            end
+          end
+
+          def start
+            @background_thread ||= Thread.new { background_run }
+
+            self
+          end
+
+          def stop
+            synchronize do
+              @stopped = true
+              @wait_cond.broadcast
+            end
+
+            self
+          end
+
+          def stopped?
+            synchronize { @stopped }
+          end
+
+          def full?
+            synchronize do
+              @inventory.count >= limit || @inventory.values.sum(&:bytesize) >= bytesize
+            end
+          end
+
+          protected
+
+          def background_run
+            delay_target = nil
+
+            until stopped?
+              if empty?
+                delay_target = nil
+
+                synchronize { @wait_cond.wait } # wait until broadcast
+                next
+              end
+
+              delay_target ||= calc_target
+              delay_gap = delay_target - Time.now
+
+              unless delay_gap.positive?
+                delay_target = calc_target
+                stream.renew_lease!
+                next
+              end
+
+              synchronize { @wait_cond.wait delay_gap }
+            end
+          end
+
+          def calc_target
+            Time.now + calc_delay
+          end
+
+          def calc_delay
+            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
+    end
+
+    Pubsub = PubSub unless const_defined? :Pubsub
+  end
+end