google-cloud-debugger 0.32.6 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc1df72a8c1dac4cc22461e3585b5b0f15dd2548897eedf015e161d76356eb7
-  data.tar.gz: 4c39329e42f2c950ce17c19b68fe1910fe854e39b9460e97b06a20be075a23f2
+  metadata.gz: 00c6b1ccddbe80cd2b51abc2a65379ae322fc7be4a8e9cfceea63a9a512872c2
+  data.tar.gz: 4a04fae51a1926559250ae1a59c3f799d947a475d528ebdce174d31f6d37a62f
 SHA512:
-  metadata.gz: f240803624c03f699e641992685374927788dbc581c462b5cbf632ab31e7baf5a4581acb0acdd2e5311967f1ff47f8224999ef48e7bf89f23a12085b846b1634
-  data.tar.gz: d98a99abd03266bdbb4fad60cb41ff488f3635167d42a87cd8dd694ca7342e56436bc54848cc01b3e9e62ea2a61a38b736afe0268938733ada789b8ed002e7c4
+  metadata.gz: '05281486dd7ffeae6f63eaeaffb7b022c4493eef166bc36de1afa44e9e75402eddd2dcf3ebeca385898ba5745cf434a64215da679b13e0094a20c988c61d4238'
+  data.tar.gz: 19f169d36ac921d24c20488358f5c872d9abacf8e3668df261e1f62b29e996846faeadd96a8c375a1ce077588d8a604bf1dcb884119bf16b7d75183d61ff127d

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release History
 
+### 0.33.0 / 2019-02-01
+
+* Add Debugger on_error configuration.
+* Update Transmitter
+  * Add dependency on current-ruby.
+  * Add Transmitter#on_error method.
+  * Update Transmitter documentation.
+* Make use of Credentials#project_id
+  * Use Credentials#project_id
+    If a project_id is not provided, use the value on the Credentials object.
+    This value was added in googleauth 0.7.0.
+  * Loosen googleauth dependency
+    Allow for new releases up to 0.10.
+    The googleauth devs have committed to maintanining the current API
+    and will not make backwards compatible changes before 0.10.
+
 ### 0.32.6 / 2018-11-15
 
 * Update network configuration.

data/lib/google-cloud-debugger.rb

@@ -178,4 +178,5 @@ Google::Cloud.configure.add_config! :debugger do |config|
   config.add_field! :client_config, nil, match: Hash
   config.add_field! :allow_mutating_methods, false
   config.add_field! :evaluation_time_limit, 0.05, match: Numeric
+  config.add_field! :on_error, nil, match: Proc
 end

data/lib/google/cloud/debugger.rb

@@ -85,30 +85,32 @@ module Google
       def self.new project_id: nil, credentials: nil, service_name: nil,
                    service_version: nil, scope: nil, timeout: nil,
                    client_config: nil, project: nil, keyfile: nil
-        project_id ||= (project || default_project_id)
-        project_id = project_id.to_s # Always cast to a string
+        project_id      ||= (project || default_project_id)
+        service_name    ||= default_service_name
+        service_version ||= default_service_version
+        scope           ||= configure.scope
+        timeout         ||= configure.timeout
+        client_config   ||= configure.client_config
 
-        service_name ||= default_service_name
         service_name = service_name.to_s
+        raise ArgumentError, "service_name is missing" if service_name.empty?
 
-        service_version ||= default_service_version
         service_version = service_version.to_s
-
-        raise ArgumentError, "project_id is missing" if project_id.empty?
-        raise ArgumentError, "service_name is missing" if service_name.empty?
         if service_version.nil?
           raise ArgumentError, "service_version is missing"
         end
 
-        scope ||= configure.scope
-        timeout ||= configure.timeout
-        client_config ||= configure.client_config
-
         credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Debugger::Credentials.new credentials, scope: scope
         end
 
+        if credentials.respond_to? :project_id
+          project_id ||= credentials.project_id
+        end
+        project_id = project_id.to_s # Always cast to a string
+        raise ArgumentError, "project_id is missing" if project_id.empty?
+
         Debugger::Project.new(
           Debugger::Service.new(project_id, credentials,
                                 timeout: timeout, client_config: client_config),
@@ -147,6 +149,9 @@ module Google
       #   state. Defaults to false.
       # * `evaluation_time_limit` - (Numeric) Time limit in seconds for
       #   expression evaluation. Defaults to 0.05.
+      # * `on_error` - (Proc) A Proc to be run when an error is encountered
+      #   on a background thread. The Proc must take the error object as the
+      #   single argument.
       #
       # See the [Configuration
       # Guide](https://googleapis.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)

data/lib/google/cloud/debugger/breakpoint.rb

@@ -347,7 +347,7 @@ module Google
             is_final_state: is_final_state,
             create_time: timestamp_to_grpc(create_time),
             final_time: timestamp_to_grpc(final_time),
-            user_email: user_email,
+            user_email: user_email.to_s,
             stack_frames: stack_frames_to_grpc,
             evaluated_expressions: evaluated_expressions_to_grpc,
             status: status_to_grpc,

data/lib/google/cloud/debugger/breakpoint/evaluator.rb

@@ -77,23 +77,26 @@ module Google
 
           ##
           # @private Predefined regex. Saves time during runtime.
-          BYTE_CODE_BLACKLIST_REGEX = /^\d+ #{BYTE_CODE_BLACKLIST.join '|'}/
+          BYTE_CODE_BLACKLIST_REGEX =
+            /^\d+ #{BYTE_CODE_BLACKLIST.join '|'}/.freeze
 
           ##
           # @private Predefined regex. Saves time during runtime.
           FULL_BYTE_CODE_BLACKLIST_REGEX = /^\d+ #{
             [*BYTE_CODE_BLACKLIST, *LOCAL_BYTE_CODE_BLACKLIST].join '|'
-          }/
+          }/.freeze
 
           ##
           # @private Predefined regex. Saves time during runtime.
           FUNC_CALL_FLAG_BLACKLIST_REGEX =
-            /<callinfo!.+#{FUNC_CALL_FLAG_BLACKLIST.join '|'}/
+            /<callinfo!.+#{FUNC_CALL_FLAG_BLACKLIST.join '|'}/.freeze
 
           ##
           # @private Predefined regex. Saves time during runtime.
           CATCH_TABLE_BLACKLIST_REGEX =
-            /catch table.*catch type: #{CATCH_TABLE_TYPE_BLACKLIST.join '|'}/m
+            /catch table.*catch type: #{
+              CATCH_TABLE_TYPE_BLACKLIST.join '|'
+            }/m.freeze
 
           private_constant :BYTE_CODE_BLACKLIST_REGEX,
                            :FULL_BYTE_CODE_BLACKLIST_REGEX,

data/lib/google/cloud/debugger/transmitter.rb

@@ -13,34 +13,46 @@
 # limitations under the License.
 
 
-require "stackdriver/core/async_actor"
+require "concurrent"
+require "google/cloud/errors"
 
 module Google
   module Cloud
     module Debugger
+      ##
+      # # TransmitterError
+      #
+      # Used to indicate a problem submitting breakpoints. This can occur when
+      # there are not enough resources allocated for the amount of usage, or
+      # when the calling the API returns an error.
+      #
+      class TransmitterError < Google::Cloud::Error
+        # @!attribute [r] breakpoint
+        #   @return [Array<Google::Cloud::Debugger::Breakpoint>] The
+        #   individual error event that was not submitted to Stackdriver
+        #   Debugger service.
+        attr_reader :breakpoint
+
+        def initialize message, breakpoint = nil
+          super(message)
+          @breakpoint = breakpoint
+        end
+      end
+
       ##
       # # Transmitter
       #
       # Responsible for submit evaluated breakpoints back to Stackdriver
-      # Debugger service asynchronously. It has it's own dedicated child thread,
-      # so it doesn't interfere with main Ruby application threads or the
-      # debugger agent's thread.
+      # Debugger service asynchronously. It maintains a thread pool.
       #
       # The transmitter is controlled by the debugger agent it belongs to.
-      # Debugger agent submits evaluated breakpoint into a thread safe queue,
-      # and the transmitter operates directly on the queue along with minimal
-      # interaction with the rest debugger agent components
+      # Debugger agent submits evaluated breakpoint asynchronously, and the
+      # transmitter submits the breakpoints to Stackdriver Debugger service.
       #
       class Transmitter
-        include Stackdriver::Core::AsyncActor
-
-        ##
-        # @private Default maximum backlog size for the job queue
-        DEFAULT_MAX_QUEUE_SIZE = 1000
-
         ##
-        # @private The gRPC Service object.
-        attr_accessor :service
+        # @private The gRPC Service object and thread pool.
+        attr_reader :service, :thread_pool
 
         ##
         # The debugger agent this transmiter belongs to
@@ -48,92 +60,138 @@ module Google
         attr_accessor :agent
 
         ##
-        # Maxium backlog size for this transmitter's queue
-        attr_accessor :max_queue_size
+        # Maximum backlog size for this transmitter's queue
+        attr_accessor :max_queue
+        alias max_queue_size  max_queue
+        alias max_queue_size= max_queue=
+
+        ##
+        # Maximum threads used in the thread pool
+        attr_accessor :threads
 
         ##
-        # @private Construct a new instance of Tramsnitter
-        def initialize agent, service, max_queue_size = DEFAULT_MAX_QUEUE_SIZE
-          super()
+        # @private Creates a new Transmitter instance.
+        def initialize agent, service, max_queue: 1000, threads: 10
+          @agent   = agent
           @service = service
-          @agent = agent
-          @max_queue_size = max_queue_size
-          @queue = []
-          @queue_resource = new_cond
+
+          @max_queue = max_queue
+          @threads   = threads
+
+          @thread_pool = Concurrent::CachedThreadPool.new max_threads: @threads,
+                                                          max_queue: @max_queue
+
+          @error_callbacks = []
+
+          # Make sure all queued calls are completed when process exits.
+          at_exit { stop }
+        end
+
+        ##
+        # Enqueue an evaluated breakpoint to be submitted by the transmitter.
+        #
+        # @raise [TransmitterError] if there are no resources available to make
+        #   queue the API call on the thread pool.
+        def submit breakpoint
+          Concurrent::Promises.future_on(@thread_pool, breakpoint) do |bp|
+            submit_sync bp
+          end
+        rescue Concurrent::RejectedExecutionError => e
+          raise TransmitterError.new(
+            "Error asynchronously submitting breakpoint: #{e.message}",
+            breakpoint
+          )
         end
 
         ##
-        # Starts the transmitter and its worker thread
+        # Starts the transmitter and its thread pool.
+        #
+        # @return [Transmitter] returns self so calls can be chained.
         def start
-          async_start
+          # no-op
+          self
         end
 
         ##
-        # Stops the transmitter and its worker thread. Once stopped, cannot be
+        # Stops the transmitter and its thread pool. Once stopped, cannot be
         # started again.
-        def stop
-          async_stop
+        #
+        # @return [Transmitter] returns self so calls can be chained.
+        def stop timeout = nil
+          if @thread_pool
+            @thread_pool.shutdown
+            @thread_pool.wait_for_termination timeout
+          end
+
+          self
         end
 
         ##
-        # Enqueue an evaluated breakpoints to be submitted by the transmitter.
+        # Whether the transmitter has been started.
         #
-        # @param [Google::Cloud::Debugger::Breakpoint] breakpoint The evaluated
-        #   breakpoint to be submitted
-        def submit breakpoint
-          synchronize do
-            @queue.push breakpoint
-            @queue_resource.broadcast
-            # Discard old entries if queue gets too large
-            @queue.pop while @queue.size > @max_queue_size
-          end
+        # @return [boolean] `true` when started, `false` otherwise.
+        #
+        def started?
+          @thread_pool.running? if @thread_pool
         end
 
         ##
-        # @private Callback fucntion for AsyncActor module to run the async
-        # job in a loop
-        def run_backgrounder
-          breakpoint = wait_next_item
-          return if breakpoint.nil?
-          begin
-            service.update_active_breakpoint agent.debuggee.id, breakpoint
-          rescue StandardError => e
-            warn ["#{e.class}: #{e.message}", e.backtrace].join("\n\t")
-            @last_exception = e
-          end
+        # Whether the transmitter has been stopped.
+        #
+        # @return [boolean] `true` when stopped, `false` otherwise.
+        #
+        def stopped?
+          !started?
         end
 
         ##
-        # @private Callback function when the async actor thread state changes
-        def on_async_state_change
-          synchronize do
-            @queue_resource.broadcast
-          end
+        # Register to be notified of errors when raised.
+        #
+        # If an unhandled error has occurred the transmitter will attempt to
+        # recover from the error and resume submitting breakpoints.
+        #
+        # Multiple error handlers can be added.
+        #
+        # @yield [callback] The block to be called when an error is raised.
+        # @yieldparam [Exception] error The error raised.
+        #
+        def on_error &block
+          @error_callbacks << block
         end
 
-        private
+        protected
 
-        ##
-        # @private The the next item from the transmitter queue. If there are
-        # no more item, it blocks the transmitter thread until an item is
-        # enqueued
-        def wait_next_item
-          synchronize do
-            @queue_resource.wait_while do
-              async_suspended? || (async_running? && @queue.empty?)
+        # Calls all error callbacks.
+        def error! error
+          error_callbacks = @error_callbacks
+          error_callbacks = default_error_callbacks if error_callbacks.empty?
+          error_callbacks.each { |error_callback| error_callback.call error }
+        end
+
+        def default_error_callbacks
+          # This is memoized to reduce calls to the configuration.
+          @default_error_callbacks ||= begin
+            error_cb = Google::Cloud::Debugger.configuration.on_error
+            error_cb ||= Google::Cloud.configure.on_error
+            if error_cb
+              [error_cb]
+            else
+              []
             end
-            @queue.pop
           end
         end
 
-        ##
-        # @private Override the #backgrounder_stoppable? method from AsyncActor
-        # module. The actor can be gracefully stopped when queue is
-        # empty.
-        def backgrounder_stoppable?
-          synchronize do
-            @queue.empty?
-          end
+        def submit_sync breakpoint
+          service.update_active_breakpoint agent.debuggee.id, breakpoint
+        rescue StandardError => e
+          sync_error = TransmitterError.new(
+            "Error asynchronously transmitting breakpoint: #{e.message}",
+            breakpoint
+          )
+          # Manually set backtrace so we don't have to raise
+          sync_error.set_backtrace caller
+
+          error! sync_error
         end
       end
     end

data/lib/google/cloud/debugger/v2.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/controller2_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/credentials.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/debugger2_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/controller.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/data.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/doc/google/devtools/clouddebugger/v2/debugger.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/doc/google/devtools/source/v1/source_context.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/doc/google/protobuf/empty.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/debugger/v2/doc/google/protobuf/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.32.6".freeze
+      VERSION = "0.33.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.32.6
+  version: 0.33.0
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.61.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -351,7 +365,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client and instrumentation library for Stackdriver Debugger