google-cloud-debugger 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a8f4cd45e74a4f18bf53c08fb05284529937c6b
-  data.tar.gz: '0718436023043859a8c9b958dc43bb623fb7ec79'
+  metadata.gz: 51d29e7310e1ea9e0f409ee2e2198d52af61c163
+  data.tar.gz: 0e8474858473a49f70b06481f281c98b79e0bd70
 SHA512:
-  metadata.gz: 323fde821b65e2167e7ea0b56f2ff988203d62d5391032890be39636bec869750e4bf701a7756b50b59b7b9eb11c71819a8a0df3830574304b7b3d38e1cfa595
-  data.tar.gz: e68aa3d18c0aaf72db470b4dba4e1ecf439da21b43aeb081a552a49d8da093121795ffd32beec52fda075b68a90564cc70a88b579fca4008b1f2b6386032920c
+  metadata.gz: a1e9da07abc025976a843eee2a93d545a09beedac8b7bfc34345ffd77e676ad17a9827fcafd285be65a05ed2d0adfd5380f2f06a12bcaa63b8cf7a000ac88eed
+  data.tar.gz: b91cc538bbdc514d8105ae0220c482df52be13539c36ad3cb50bb4d0db071a54c146a687c5a34af40a36de04ddd012b283b26b2a309d0d30ef616450c27c33f9

data/ext/google/cloud/debugger/debugger_c/evaluator.c

@@ -23,19 +23,24 @@ eval_trace_callback(void *data, rb_trace_arg_t *trace_arg)
 {
     rb_event_flag_t event = rb_tracearg_event_flag(trace_arg);
     VALUE evaluator = (VALUE)data;
-    VALUE klass = rb_tracearg_defined_class(trace_arg);
-    VALUE obj = rb_tracearg_self(trace_arg);
-    VALUE method_id = rb_tracearg_method_id(trace_arg);
+    VALUE klass;
+    VALUE obj;
+    VALUE method_id;
     ID trace_func_cb_id;
     ID trace_c_func_cb_id;
 
     CONST_ID(trace_func_cb_id, "trace_func_callback");
     CONST_ID(trace_c_func_cb_id, "trace_c_func_callback");
 
+    obj = rb_tracearg_self(trace_arg);
+    method_id = rb_tracearg_method_id(trace_arg);
+
     if (event & RUBY_EVENT_CALL) {
         rb_funcall(evaluator, trace_func_cb_id, 2, obj, method_id);
     }
     if (event & RUBY_EVENT_C_CALL) {
+        klass = rb_tracearg_defined_class(trace_arg);
+
         rb_funcall(evaluator, trace_c_func_cb_id, 3, obj, klass, method_id);
     }
 

data/ext/google/cloud/debugger/debugger_c/tracer.c

@@ -144,17 +144,13 @@ line_trace_callback(rb_event_flag_t event, VALUE data, VALUE obj, ID mid, VALUE
     VALUE trace_binding;
     VALUE call_stack_bindings;
 
-    int i;
     VALUE matching_result = match_breakpoints(self, c_trace_path, c_trace_lineno);
-    VALUE *c_matching_breakpoints;
-    VALUE matching_breakpoint;
-    int matching_breakpoints_len;
 
     ID callers_id;
-    ID breakpoint_hit_id;
+    ID breakpoints_hit_id;
 
     CONST_ID(callers_id, "callers");
-    CONST_ID(breakpoint_hit_id, "breakpoint_hit");
+    CONST_ID(breakpoints_hit_id, "breakpoints_hit");
 
     // If matching result isn't an array, it means we're in completely wrong file,
     // or not on the right line. Turn line tracing off if we're in wrong file.
@@ -165,17 +161,11 @@ line_trace_callback(rb_event_flag_t event, VALUE data, VALUE obj, ID mid, VALUE
         return;
     }
 
-    c_matching_breakpoints = RARRAY_PTR(matching_result);
-    matching_breakpoints_len = RARRAY_LEN(matching_result);
     trace_binding = rb_binding_new();
     call_stack_bindings = rb_funcall(trace_binding, callers_id, 0);
     rb_ary_pop(call_stack_bindings);
 
-    // Evaluate each of the matching breakpoint
-    for (i = 0; i < matching_breakpoints_len; i++) {
-        matching_breakpoint = c_matching_breakpoints[i];
-        rb_funcall(self, breakpoint_hit_id, 2, matching_breakpoint, call_stack_bindings);
-    }
+    rb_funcall(self, breakpoints_hit_id, 2, matching_result, call_stack_bindings);
 
     return;
 }

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

@@ -90,6 +90,19 @@ module Google
         # The logger used to write the results of Logpoints.
         attr_accessor :logger
 
+        ##
+        # A quota tracking object helps tracking resource consumption during
+        # evaluations.
+        attr_accessor :quota_manager
+
+        ##
+        # Absolute path to the debuggee Ruby application root directory. The
+        # Stackdriver Debugger service creates canonical breakpoints with only
+        # relative path. So the debugger agent combines the relative path to
+        # the application directory to trace and evaluate breakpoints.
+        # @return [String]
+        attr_accessor :app_root
+
         ##
         # @private The last exception captured in the agent child thread
         attr_reader :last_exception
@@ -102,11 +115,13 @@ module Google
         # @param [Google::Cloud::Logging::Logger] logger The logger used
         #   to write the results of Logpoints.
         # @param [String] module_name Name for the debuggee application.
-        #   Optional.
         # @param [String] module_version Version identifier for the debuggee
-        #   application. Optional.
+        #   application.
+        # @param [String] app_root Absolute path to the root directory of
+        #   the debuggee application. Default to Rack root.
         #
-        def initialize service, logger: nil, module_name:, module_version:
+        def initialize service, logger: nil, module_name:, module_version:,
+                       app_root: nil
           super()
 
           @service = service
@@ -121,6 +136,9 @@ module Google
 
           @logger = logger || default_logger
 
+          @app_root = app_root
+          @app_root ||= Rack::Directory.new("").root if defined? Rack::Directory
+
           # Agent actor thread needs to force exit immediately.
           set_cleanup_options timeout: 0
         end

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

@@ -17,11 +17,21 @@ require "time"
 require "google/cloud/debugger/breakpoint/evaluator"
 require "google/cloud/debugger/breakpoint/source_location"
 require "google/cloud/debugger/breakpoint/stack_frame"
+require "google/cloud/debugger/breakpoint/status_message"
+require "google/cloud/debugger/breakpoint/validator"
 require "google/cloud/debugger/breakpoint/variable"
+require "google/cloud/debugger/breakpoint/variable_table"
 
 module Google
   module Cloud
     module Debugger
+      ##
+      # # Breakpoint
+      #
+      # Abstract class that represents a breakpoint, which can be set and
+      # triggered in a debuggee application. Maps to gRPC struct
+      # {Google::Devtools::Clouddebugger::V2::Breakpoint}.
+      #
       class Breakpoint
         include MonitorMixin
 
@@ -34,6 +44,11 @@ module Google
         # @return [Symbol]
         attr_accessor :action
 
+        ##
+        # Absolute path to the debuggee Ruby application root directory.
+        # @return [String]
+        attr_accessor :app_root
+
         ##
         # Only relevant when action is LOG. Defines the message to log when the
         # breakpoint hits. The message may include parameter placeholders $0,
@@ -124,8 +139,7 @@ module Google
         # field. The stored objects are nameless and get their name from the
         # referencing variable. The effective variable is a merge of the
         # referencing variable and the referenced variable.
-        # TODO: Implement variable table
-        # attr_accessor :variable_table
+        attr_accessor :variable_table
 
         ##
         # A set of custom breakpoint properties, populated by the agent, to be
@@ -145,6 +159,8 @@ module Google
 
           @id = id
           @action = :CAPTURE
+          # Use relative path for SourceLocation, because that's how the server
+          # side canonical breakpoints are defined.
           @location = SourceLocation.new.tap do |sl|
             sl.path = path
             sl.line = line.to_i
@@ -153,6 +169,7 @@ module Google
           @evaluated_expressions = []
           @stack_frames = []
           @labels = {}
+          @variable_table = VariableTable.new
         end
 
         ##
@@ -160,26 +177,39 @@ module Google
         # from a Google::Devtools::Clouddebugger::V2::Breakpoint object.
         def self.from_grpc grpc
           return new if grpc.nil?
-          new.tap do |b|
+
+          breakpoint = grpc.action == :LOG ? Logpoint.new : Snappoint.new
+          breakpoint.tap do |b|
             b.id = grpc.id
             b.action = grpc.action
             b.condition = grpc.condition
-            b.create_time = timestamp_from_grpc grpc.create_time
-            b.evaluated_expressions =
-              Breakpoint::Variable.from_grpc_list grpc.evaluated_expressions
             b.expressions = grpc.expressions.to_a
-            b.final_time = timestamp_from_grpc grpc.final_time
             b.labels = hashify_labels grpc.labels
             b.log_message_format = grpc.log_message_format
             b.log_level = grpc.log_level
-            b.location = Breakpoint::SourceLocation.from_grpc grpc.location
             b.is_final_state = grpc.is_final_state
-            b.status = grpc.status
-            b.stack_frames = stack_frames_from_grpc grpc
             b.user_email = grpc.user_email
+
+            assign_complex_grpc_fields grpc, b
           end
         end
 
+        ##
+        # @private Helper method that helps extracting complex fields from
+        # grpc struct into a breakpoint.
+        def self.assign_complex_grpc_fields grpc, breakpoint
+          breakpoint.create_time = timestamp_from_grpc grpc.create_time
+          breakpoint.evaluated_expressions =
+            Breakpoint::Variable.from_grpc_list grpc.evaluated_expressions
+          breakpoint.final_time = timestamp_from_grpc grpc.final_time
+          breakpoint.location =
+            Breakpoint::SourceLocation.from_grpc grpc.location
+          breakpoint.stack_frames = stack_frames_from_grpc grpc
+          breakpoint.status = Breakpoint::StatusMessage.from_grpc grpc.status
+          breakpoint.variable_table =
+            Breakpoint::VariableTable.from_grpc grpc.variable_table
+        end
+
         ##
         # @private Extract array of stack_frame from grpc
         def self.stack_frames_from_grpc grpc
@@ -205,8 +235,10 @@ module Google
           end
         end
 
-        private_class_method :stack_frames_from_grpc, :timestamp_from_grpc,
-                             :hashify_labels
+        private_class_method :stack_frames_from_grpc,
+                             :timestamp_from_grpc,
+                             :hashify_labels,
+                             :assign_complex_grpc_fields
 
         ##
         # Marks a breakpoint as complete if this breakpoint isn't completed
@@ -220,7 +252,21 @@ module Google
           end
         end
 
-        alias_method :complete?, :is_final_state
+        ##
+        # Check if the breakpoint has been evaluated or set to a final error
+        # state.
+        def complete?
+          is_final_state ? true : false
+        end
+
+        ##
+        # Check if the breakpoint is valid or not. Invoke validation function
+        # if breakpoint hasn't been finallized yet.
+        def valid?
+          Validator.validate self unless complete?
+
+          status && status.is_error ? false : true
+        end
 
         ##
         # Get the file path of this breakpoint
@@ -244,44 +290,33 @@ module Google
 
         ##
         # Evaluate the breakpoint's condition expression against a given binding
-        # object. Returns true if the condition expression evalutes to true;
-        # false if error happens or the expression evaluates to false.
+        # object. Returns true if the condition expression evalutes to true or
+        # there isn't a condition; otherwise false. Set breakpoint to error
+        # state if exception happens.
         #
         # @param [Binding] binding A Ruby Binding object
-        # @return [Boolean] True if condition evalutes to true, false if
-        #   condition evaluates to false or error raised during evaluation.
-        #
+        # @return [Boolean] True if condition evalutes to true or there isn't a
+        #   condition. False if condition evaluates to false or error raised
+        #   during evaluation.
         def check_condition binding
           return true if condition.nil? || condition.empty?
-          begin
-            Evaluator.eval_condition binding, condition
-          rescue
-            set_error_state "Unable to evaluate condition",
-                            refers_to: :BREAKPOINT_CONDITION
-            false
-          end
-        end
+          condition_result =
+            Evaluator.readonly_eval_expression binding, condition
 
-        ##
-        # Evaluate the breakpoint unless it's already marked as completed.
-        # Store evaluted results in @evaluated_expressions, @stack_frames, and
-        # @evaluated_log_message, depends on the action of breakpoint. Mark
-        # breakpoint complete if successfully evaluated a breakpoint with
-        # :CAPTURE action.
-        #
-        # @param [Array<Binding>] call_stack_bindings An array of Ruby Binding
-        #   objects, from the call stack that leads to the triggering of the
-        #   breakpoints.
-        #
-        # @return [Boolean] True if evaluated successfully; false otherwise.
-        #
-        def evaluate call_stack_bindings
-          case action
-          when :CAPTURE
-            evaluate_snapshot_point call_stack_bindings
-          when :LOG
-            evaluate_logpoint call_stack_bindings[0]
+          if condition_result.is_a?(Exception) &&
+             condition_result.instance_variable_get(:@mutation_cause)
+            set_error_state "Error: #{condition_result.message}",
+                            refers_to: StatusMessage::BREAKPOINT_CONDITION
+
+            return false
           end
+
+
+          condition_result ? true : false
+        rescue => e
+          set_error_state "Error: #{e.message}",
+                          refers_to: StatusMessage::BREAKPOINT_CONDITION
+          false
         end
 
         ##
@@ -313,8 +348,9 @@ module Google
             user_email: user_email,
             stack_frames: stack_frames_to_grpc,
             evaluated_expressions: evaluated_expressions_to_grpc,
-            status: status,
-            labels: labels_to_grpc
+            status: status_to_grpc,
+            labels: labels_to_grpc,
+            variable_table: variable_table.to_grpc
           )
         end
 
@@ -324,79 +360,39 @@ module Google
         # completed if is_final is true.
         #
         # @param [String] message The error message
-        # @param [Google::Devtools::Clouddebugger::V2::StatusMessage::Reference]
-        #   refers_to Enum that specifies what the error refers to. Defaults
-        #   :UNSPECIFIED.
+        # @param [Symbol] refers_to Enum that specifies what the error refers
+        #   to. Defaults :UNSPECIFIED. See {Breakpoint::StatusMessage} class for
+        #   list of possible values
         # @param [Boolean] is_final Marks the breakpoint as final if true.
         #   Defaults true.
         #
-        # @return [Google::Devtools::Clouddebugger::V2::StatusMessage] The grpc
+        # @return [Google::Cloud::Debugger::Breakpoint::StatusMessage] The grpc
         #   StatusMessage object, which describes the breakpoint's error state.
-        def set_error_state message, refers_to: :UNSPECIFIED, is_final: true
-          description = Google::Devtools::Clouddebugger::V2::FormatMessage.new(
-            format: message
-          )
-          @status = Google::Devtools::Clouddebugger::V2::StatusMessage.new(
-            is_error: true,
-            refers_to: refers_to,
-            description: description
-          )
+        def set_error_state message, refers_to: StatusMessage::UNSPECIFIED,
+                            is_final: true
+          @status = StatusMessage.new.tap do |s|
+            s.is_error = true
+            s.refers_to = refers_to
+            s.description = message
+          end
 
           complete if is_final
 
           @status
         end
 
-        private
-
         ##
-        # @private Evaluate snapshot point
-        def evaluate_snapshot_point call_stack_bindings
-          synchronize do
-            top_binding = call_stack_bindings[0]
-
-            return false if complete? || !check_condition(top_binding)
-
-            begin
-              unless expressions.empty?
-                @evaluated_expressions =
-                  Evaluator.eval_expressions top_binding, @expressions
-              end
-
-              @stack_frames = Evaluator.eval_call_stack call_stack_bindings
-
-              complete
-            rescue
-              return false
-            end
-          end
-
-          true
-        end
-
-        ##
-        # @private Evaluate logpoint
-        def evaluate_logpoint binding
-          synchronize do
-            return false if complete? || !check_condition(binding)
-
-            begin
-              unless expressions.empty?
-                @evaluated_expressions = expressions.map do |expression|
-                  Evaluator.readonly_eval_expression binding, expression
-                end
-              end
-              @evaluated_log_message =
-                Evaluator.format_message log_message_format,
-                                         evaluated_expressions
-            rescue
-              return false
-            end
+        # Get full absolute file path by combining the relative file path
+        # with application root directory path.
+        def full_path
+          if app_root.nil? || app_root.empty?
+            path
+          else
+            File.join app_root, path
           end
-
-          true
         end
 
+        private
 
         ##
         # @private Formats the labels so they can be saved to a
@@ -417,11 +413,18 @@ module Google
 
         ##
         # @private Exports the Breakpoint stack_frames to an array of
-        # Google::Devtools::Clouddebugger::V2::StackFrame objects.
+        # Google::Devtools::Clouddebugger::V2::Variable objects.
         def evaluated_expressions_to_grpc
           evaluated_expressions.nil? ? [] : evaluated_expressions.map(&:to_grpc)
         end
 
+        ##
+        # @private Exports Breakpoint status to
+        # Google::Devtools::Clouddebugger::V2::StatusMessage object
+        def status_to_grpc
+          status.nil? ? nil: status.to_grpc
+        end
+
         ##
         # @private Formats the timestamp as a Google::Protobuf::Timestamp
         # object.