google-cloud-debugger 0.25.0 → 0.26.1

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

@@ -878,6 +878,33 @@ module Google
               result
             end
 
+            ##
+            # Format log message by interpolate expressions.
+            #
+            # @example
+            #   Evaluator.format_log_message("Hello $0",
+            #                                ["World"]) #=> "Hello World"
+            #
+            # @param [String] message_format The message with with
+            #   expression placeholders such as `$0`, `$1`, etc.
+            # @param [Array<Google::Cloud::Debugger::Breakpoint::Variable>]
+            #   expressions An array of evaluated expression variables to be
+            #   placed into message_format's placeholders. The variables need
+            #   to have type equal String.
+            #
+            # @return [String] The formatted message string
+            #
+            def format_message message_format, expressions
+              # Substitute placeholders with expressions
+              message = message_format.gsub(/(?<!\$)\$\d+/) do |placeholder|
+                index = placeholder.match(/\$(\d+)/)[1].to_i
+                index < expressions.size ? expressions[index].inspect : ""
+              end
+
+              # Unescape "$" charactors
+              message.gsub(/\$\$/, "$")
+            end
+
             private
 
             ##

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

@@ -32,6 +32,11 @@ module Google
       class BreakpointManager
         include MonitorMixin
 
+        ##
+        # The debugger agent this tracer belongs to
+        # @return [Google::Cloud::Debugger::Agent]
+        attr_reader :agent
+
         ##
         # @private The gRPC Service object.
         attr_reader :service
@@ -53,9 +58,10 @@ module Google
 
         ##
         # @private Construct new instance of BreakpointManager
-        def initialize service
+        def initialize agent, service
           super()
 
+          @agent = agent
           @service = service
 
           @completed_breakpoints = []
@@ -133,6 +139,58 @@ module Google
           end
         end
 
+        ##
+        # Evaluates a hit breakpoint, and submit the breakpoint to
+        # Transmitter if this breakpoint is evaluated successfully.
+        #
+        # See {Breakpoint#evaluate} for evaluation details.
+        #
+        # @param [Google::Cloud::Debugger::Breakpoint] breakpoint The breakpoint
+        #   to be evaluated
+        # @param [Array<Binding>] call_stack_bindings An array of Ruby Binding
+        #   objects, from the each frame of the call stack that leads to the
+        #   triggering of the breakpoints.
+        #
+        def breakpoint_hit breakpoint, call_stack_bindings
+          breakpoint.evaluate call_stack_bindings
+
+          case breakpoint.action
+          when :CAPTURE
+            # Take this completed breakpoint off manager's active breakpoints
+            # list, submit the breakpoint snapshot, and update Tracer's
+            # breakpoints_cache.
+            return unless breakpoint.complete?
+
+            # Remove this breakpoint from active list
+            mark_off breakpoint
+            # Signal transmitter to submit this breakpoint
+            agent.transmitter.submit breakpoint
+          when :LOG
+            log_logpoint breakpoint
+          end
+        end
+
+        ##
+        # Assume the given logpoint is successfully evaluated, log the
+        # evaluated log message via logger
+        #
+        # @param [Google::Cloud::Debugger::Breakpoint] logpoint The evaluated
+        #   logpoint.
+        def log_logpoint logpoint
+          return unless agent.logger && logpoint.evaluated_log_message
+
+          message = "LOGPOINT: #{logpoint.evaluated_log_message}"
+
+          case logpoint.log_level
+          when :INFO
+            agent.logger.info message
+          when :WARNING
+            agent.logger.warn message
+          when :ERROR
+            agent.logger.error message
+          end
+        end
+
         ##
         # Mark a given active breakpoint as completed. Meaning moving it from
         # list of active breakpoints to completed breakpoints.

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

@@ -13,6 +13,8 @@
 # limitations under the License.
 
 
+require "google/cloud/logging/logger"
+
 module Google
   module Cloud
     module Debugger
@@ -47,6 +49,7 @@ module Google
                                    keyfile: configuration.keyfile,
                                    module_name: configuration.module_name,
                                    module_version: configuration.module_version)
+
           # Immediately start the debugger agent
           @debugger.start
         end
@@ -65,6 +68,11 @@ module Google
           # Enable/resume breakpoints tracing
           @debugger.agent.tracer.start
 
+          # Use Stackdriver Logger for debugger if available
+          if env["rack.logger"].is_a? Google::Cloud::Logging::Logger
+            @debugger.agent.logger = env["rack.logger"]
+          end
+
           @app.call env
         ensure
           # Stop breakpoints tracing beyond this point

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

@@ -103,31 +103,14 @@ module Google
         end
 
         ##
-        # Evaluates a hit breakpoint, and signal BreakpointManager and
-        # Transmitter if this breakpoint is evaluated successfully.
+        # Callback function when a breakpoint is hit. Handover the hit
+        # breakpoint to breakpoint_manager to be evaluated.
         #
-        # See {Breakpoint#eval_call_stack} for evaluation details.
-        #
-        # @param [Google::Cloud::Debugger::Breakpoint] breakpoint The breakpoint
-        #   to be evaluated
-        # @param [Array<Binding>] call_stack_bindings An array of Ruby Binding
-        #   objects, from the each frame of the call stack that leads to the
-        #   triggering of the breakpoints.
-        #
-        def eval_breakpoint breakpoint, call_stack_bindings
+        def breakpoint_hit breakpoint, call_stack_bindings
           return if breakpoint.nil? || breakpoint.complete?
 
-          breakpoint.eval_call_stack call_stack_bindings
-
-          # Take this completed breakpoint off manager's active breakpoints
-          # list, submit the breakpoint snapshot, and update Tracer's
-          # breakpoints_cache.
-          return unless breakpoint.complete?
-
-          # Signal breakpoint_manager that this breakpoint is evaluated
-          agent.breakpoint_manager.mark_off breakpoint
-          # Signal transmitter to submit this breakpoint
-          agent.transmitter.submit breakpoint
+          agent.breakpoint_manager.breakpoint_hit breakpoint,
+                                                  call_stack_bindings
 
           update_breakpoints_cache
 

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/debugger/async_actor"
+require "stackdriver/core/async_actor"
 
 module Google
   module Cloud
@@ -32,7 +32,7 @@ module Google
       # interaction with the rest debugger agent components
       #
       class Transmitter
-        include AsyncActor
+        include Stackdriver::Core::AsyncActor
 
         ##
         # @private Default maximum backlog size for the job queue
@@ -53,12 +53,13 @@ module Google
 
         ##
         # @private Construct a new instance of Tramsnitter
-        def initialize service, agent, max_queue_size = DEFAULT_MAX_QUEUE_SIZE
+        def initialize agent, service, max_queue_size = DEFAULT_MAX_QUEUE_SIZE
           super()
           @service = service
           @agent = agent
           @max_queue_size = max_queue_size
-          @queue = Thread::Queue.new
+          @queue = []
+          @queue_resource = new_cond
         end
 
         ##
@@ -82,7 +83,7 @@ module Google
         def submit breakpoint
           synchronize do
             @queue.push breakpoint
-            @lock_cond.broadcast
+            @queue_resource.broadcast
             # Discard old entries if queue gets too large
             @queue.pop while @queue.size > @max_queue_size
           end
@@ -101,6 +102,14 @@ module Google
           end
         end
 
+        ##
+        # @private Callback function when the async actor thread state changes
+        def on_async_state_change
+          synchronize do
+            @queue_resource.broadcast
+          end
+        end
+
         private
 
         ##
@@ -109,18 +118,20 @@ module Google
         # enqueued
         def wait_next_item
           synchronize do
-            @lock_cond.wait_while do
-              async_state == :suspended ||
-                (async_state == :running && @queue.empty?)
-            end
-            queue_item = nil
-            if @queue.empty?
-              @async_state = :stopped
-            else
-              queue_item = @queue.pop
+            @queue_resource.wait_while do
+              async_suspended? || (async_running? && @queue.empty?)
             end
-            @lock_cond.broadcast
-            queue_item
+            @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
         end
       end

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

@@ -11,5 +11,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "google/cloud/debugger/v2/controller2_client"
 require "google/cloud/debugger/v2/debugger2_client"
+require "google/cloud/debugger/v2/controller2_client"

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

@@ -82,6 +82,12 @@ module Google
           #   A Channel object through which to make calls.
           # @param chan_creds [Grpc::ChannelCredentials]
           #   A ChannelCredentials for the setting up the RPC client.
+          # @param updater_proc [Proc]
+          #   A function that transforms the metadata for requests, e.g., to give
+          #   OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
           # @param client_config[Hash]
           #   A Hash for call options for each method. See
           #   Google::Gax#construct_settings for the structure of
@@ -94,6 +100,7 @@ module Google
               port: DEFAULT_SERVICE_PORT,
               channel: nil,
               chan_creds: nil,
+              updater_proc: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
@@ -138,6 +145,7 @@ module Google
               port,
               chan_creds: chan_creds,
               channel: channel,
+              updater_proc: updater_proc,
               scopes: scopes,
               &Google::Devtools::Clouddebugger::V2::Controller2::Stub.method(:new)
             )
@@ -179,7 +187,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::RegisterDebuggeeResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/controller2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
           #   Debuggee = Google::Devtools::Clouddebugger::V2::Debuggee
@@ -230,7 +238,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::ListActiveBreakpointsResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/controller2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Controller2Client = Google::Cloud::Debugger::V2::Controller2Client
           #
@@ -272,7 +280,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::UpdateActiveBreakpointResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/controller2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
           #   Controller2Client = Google::Cloud::Debugger::V2::Controller2Client

data/lib/google/cloud/debugger/v2/controller2_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

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

@@ -74,6 +74,12 @@ module Google
           #   A Channel object through which to make calls.
           # @param chan_creds [Grpc::ChannelCredentials]
           #   A ChannelCredentials for the setting up the RPC client.
+          # @param updater_proc [Proc]
+          #   A function that transforms the metadata for requests, e.g., to give
+          #   OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
           # @param client_config[Hash]
           #   A Hash for call options for each method. See
           #   Google::Gax#construct_settings for the structure of
@@ -86,6 +92,7 @@ module Google
               port: DEFAULT_SERVICE_PORT,
               channel: nil,
               chan_creds: nil,
+              updater_proc: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
@@ -130,6 +137,7 @@ module Google
               port,
               chan_creds: chan_creds,
               channel: channel,
+              updater_proc: updater_proc,
               scopes: scopes,
               &Google::Devtools::Clouddebugger::V2::Debugger2::Stub.method(:new)
             )
@@ -174,7 +182,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::SetBreakpointResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/debugger2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Breakpoint = Google::Devtools::Clouddebugger::V2::Breakpoint
           #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
@@ -213,7 +221,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::GetBreakpointResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/debugger2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
           #
@@ -250,7 +258,7 @@ module Google
           #   retries, etc.
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/debugger2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
           #
@@ -304,7 +312,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::ListBreakpointsResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/debugger2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
           #
@@ -350,7 +358,7 @@ module Google
           # @return [Google::Devtools::Clouddebugger::V2::ListDebuggeesResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/debugger/v2/debugger2_client"
+          #   require "google/cloud/debugger/v2"
           #
           #   Debugger2Client = Google::Cloud::Debugger::V2::Debugger2Client
           #

data/lib/google/cloud/debugger/v2/debugger2_client_config.json

@@ -6,9 +6,7 @@
           "DEADLINE_EXCEEDED",
           "UNAVAILABLE"
         ],
-        "non_idempotent": [
-          "UNAVAILABLE"
-        ]
+        "non_idempotent": []
       },
       "retry_params": {
         "default": {

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.25.0"
+      VERSION = "0.26.1"
     end
   end
 end

data/lib/google/devtools/clouddebugger/v2/data_pb.rb

@@ -22,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :BREAKPOINT_SOURCE_LOCATION, 3
     value :BREAKPOINT_CONDITION, 4
     value :BREAKPOINT_EXPRESSION, 7
+    value :BREAKPOINT_AGE, 8
     value :VARIABLE_NAME, 5
     value :VARIABLE_VALUE, 6
   end