google-cloud-debugger 0.36.1 → 0.42.0

data/lib/google/cloud/debugger.rb

@@ -67,8 +67,6 @@ module Google
       #   * `https://www.googleapis.com/auth/logging.admin`
       #
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] project Project identifier for the Stackdriver Debugger
@@ -84,15 +82,20 @@ module Google
       #   debugger = Google::Cloud::Debugger.new
       #   debugger.start
       #
-      def self.new project_id: nil, credentials: nil, service_name: nil,
-                   service_version: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, project: nil, keyfile: nil
+      def self.new project_id: nil,
+                   credentials: nil,
+                   service_name: nil,
+                   service_version: nil,
+                   scope: nil,
+                   timeout: nil,
+                   endpoint: nil,
+                   project: nil,
+                   keyfile: nil
         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
         endpoint        ||= configure.endpoint
 
         service_name = service_name.to_s
@@ -114,14 +117,8 @@ module Google
         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,
-            host: endpoint, timeout: timeout, client_config: client_config
-          ),
-          service_name: service_name,
-          service_version: service_version
-        )
+        service = Debugger::Service.new project_id, credentials, host: endpoint, timeout: timeout
+        Debugger::Project.new service, service_name: service_name, service_version: service_version
       end
 
       # rubocop:enable all
@@ -147,8 +144,6 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `allow_mutating_methods` - (boolean) Whether expressions and
@@ -254,4 +249,11 @@ module Google
       end
     end
   end
+
+  # Aliases for compatibility with older spellings.
+  # @private
+  module Devtools
+    # @private
+    Clouddebugger = ::Google::Cloud::Debugger unless const_defined? :Clouddebugger
+  end
 end

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

@@ -120,7 +120,10 @@ module Google
         # @param [String] app_root Absolute path to the root directory of
         #   the debuggee application. Default to Rack root.
         #
-        def initialize service, logger: nil, service_name:, service_version:,
+        def initialize service,
+                       service_name:,
+                       service_version:,
+                       logger: nil,
                        app_root: nil
           super()
 

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

@@ -30,7 +30,7 @@ module Google
       #
       # 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}.
+      # {Google::Cloud::Debugger::V2::Breakpoint}.
       #
       class Breakpoint
         include MonitorMixin
@@ -174,7 +174,7 @@ module Google
 
         ##
         # @private New Google::Cloud::Debugger::Breakpoint
-        # from a Google::Devtools::Clouddebugger::V2::Breakpoint object.
+        # from a Google::Cloud::Debugger::V2::Breakpoint object.
         def self.from_grpc grpc
           return new if grpc.nil?
 
@@ -265,7 +265,7 @@ module Google
         def valid?
           Validator.validate self unless complete?
 
-          status && status.is_error ? false : true
+          status&.is_error ? false : true
         end
 
         ##
@@ -337,9 +337,9 @@ module Google
 
         ##
         # @private Exports the Breakpoint to a
-        # Google::Devtools::Clouddebugger::V2::Breakpoint object.
+        # Google::Cloud::Debugger::V2::Breakpoint object.
         def to_grpc
-          Google::Devtools::Clouddebugger::V2::Breakpoint.new(
+          Google::Cloud::Debugger::V2::Breakpoint.new(
             id: id.to_s,
             location: location.to_grpc,
             condition: condition.to_s,
@@ -398,7 +398,7 @@ module Google
 
         ##
         # @private Formats the labels so they can be saved to a
-        # Google::Devtools::Clouddebugger::V2::Breakpoint object.
+        # Google::Cloud::Debugger::V2::Breakpoint object.
         def labels_to_grpc
           # Coerce symbols to strings
           Hash[labels.map do |k, v|
@@ -408,21 +408,21 @@ module Google
 
         ##
         # @private Exports the Breakpoint stack_frames to an array of
-        # Google::Devtools::Clouddebugger::V2::StackFrame objects.
+        # Google::Cloud::Debugger::V2::StackFrame objects.
         def stack_frames_to_grpc
           stack_frames.nil? ? [] : stack_frames.map(&:to_grpc)
         end
 
         ##
         # @private Exports the Breakpoint stack_frames to an array of
-        # Google::Devtools::Clouddebugger::V2::Variable objects.
+        # Google::Cloud::Debugger::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
+        # Google::Cloud::Debugger::V2::StatusMessage object
         def status_to_grpc
           status.nil? ? nil : status.to_grpc
         end

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

@@ -89,7 +89,7 @@ module Google
           ##
           # @private Predefined regex. Saves time during runtime.
           FUNC_CALL_FLAG_BLACKLIST_REGEX =
-            /<callinfo!.+#{FUNC_CALL_FLAG_BLACKLIST.join '|'}/.freeze
+            /<call(info|data)!.+#{FUNC_CALL_FLAG_BLACKLIST.join '|'}/.freeze
 
           ##
           # @private Predefined regex. Saves time during runtime.
@@ -849,20 +849,18 @@ module Google
             # do evaluation in a new thread, where function calls can be
             # traced.
             thr = Thread.new do
-              begin
-                Thread.current.thread_variable_set EVALUATOR_REFERENCE, self
-                binding.eval wrap_expression(expression)
-              rescue StandardError, EvaluationError => e
-                # Treat all StandardError as mutation and set @mutation_cause
-                unless e.instance_variable_get :@mutation_cause
-                  e.instance_variable_set(
-                    :@mutation_cause,
-                    Google::Cloud::Debugger::EvaluationError::UNKNOWN_CAUSE
-                  )
-                end
-
-                e
+              Thread.current.thread_variable_set EVALUATOR_REFERENCE, self
+              binding.eval wrap_expression(expression)
+            rescue StandardError, EvaluationError => e
+              # Treat all StandardError as mutation and set @mutation_cause
+              unless e.instance_variable_get :@mutation_cause
+                e.instance_variable_set(
+                  :@mutation_cause,
+                  Google::Cloud::Debugger::EvaluationError::UNKNOWN_CAUSE
+                )
               end
+
+              e
             end
 
             thr.join @time_limit
@@ -942,7 +940,7 @@ module Google
           ##
           # @private Wraps expression with tracing code
           def wrap_expression expression
-            """
+            <<~CODE
               begin
                 ::Google::Cloud::Debugger::Breakpoint::Evaluator.send(
                   :enable_method_trace_for_thread)
@@ -951,11 +949,9 @@ module Google
                 ::Google::Cloud::Debugger::Breakpoint::Evaluator.send(
                   :disable_method_trace_for_thread)
               end
-            """
+            CODE
           end
 
-          # rubocop:disable Layout/RescueEnsureAlignment
-
           ##
           # @private Evaluation tracing callback function. This is called
           # everytime a Ruby function is called during evaluation of
@@ -994,8 +990,6 @@ module Google
             )
           end
 
-          # rubocop:enable Layout/RescueEnsureAlignment
-
           ##
           # @private Evaluation tracing callback function. This is called
           # everytime a C function is called during evaluation of
@@ -1011,12 +1005,12 @@ module Google
           #
           def trace_c_func_callback receiver, defined_class, mid
             return if @allow_mutating_methods
-            if receiver.is_a?(Class) || receiver.is_a?(Module)
-              invalid_op =
+            invalid_op =
+              if receiver.is_a?(Class) || receiver.is_a?(Module)
                 !validate_c_class_method(defined_class, receiver, mid)
-            else
-              invalid_op = !validate_c_instance_method(defined_class, mid)
-            end
+              else
+                !validate_c_instance_method(defined_class, mid)
+              end
 
             return unless invalid_op
 

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

@@ -37,11 +37,12 @@ module Google
 
           ##
           # @private Create an empty SourceLocation object.
-          def initialize; end
+          def initialize
+          end
 
           ##
           # @private New Google::Cloud::Debugger::Breakpoint::SourceLocation
-          # from a Google::Devtools::Clouddebugger::V2::SourceLocation object.
+          # from a Google::Cloud::Debugger::V2::SourceLocation object.
           def self.from_grpc grpc
             return new if grpc.nil?
             new.tap do |o|
@@ -53,16 +54,15 @@ module Google
           ##
           # @private Determines if the SourceLocation has any data.
           def empty?
-            path.nil? &&
-              line.nil?
+            path.nil? && line.nil?
           end
 
           ##
           # @private Exports the SourceLocation to a
-          # Google::Devtools::Clouddebugger::V2::SourceLocation object.
+          # Google::Cloud::Debugger::V2::SourceLocation object.
           def to_grpc
             return nil if empty?
-            Google::Devtools::Clouddebugger::V2::SourceLocation.new(
+            Google::Cloud::Debugger::V2::SourceLocation.new(
               path: path.to_s,
               line: line
             )

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

@@ -55,7 +55,7 @@ module Google
 
           ##
           # @private New Google::Cloud::Debugger::Breakpoint::SourceLocation
-          # from a Google::Devtools::Clouddebugger::V2::SourceLocation object.
+          # from a Google::Cloud::Debugger::V2::SourceLocation object.
           def self.from_grpc grpc
             new.tap do |o|
               o.function = grpc.function
@@ -76,10 +76,10 @@ module Google
 
           ##
           # @private Exports the StackFrame to a
-          # Google::Devtools::Clouddebugger::V2::StackFrame object.
+          # Google::Cloud::Debugger::V2::StackFrame object.
           def to_grpc
             return nil if empty?
-            Google::Devtools::Clouddebugger::V2::StackFrame.new(
+            Google::Cloud::Debugger::V2::StackFrame.new(
               function: function.to_s,
               location: location.to_grpc,
               arguments: arguments_to_grpc,
@@ -91,14 +91,14 @@ module Google
 
           ##
           # @private Exports the StackFrame arguments to an array of
-          # Google::Devtools::Clouddebugger::V2::Variable objects.
+          # Google::Cloud::Debugger::V2::Variable objects.
           def arguments_to_grpc
             arguments.nil? ? [] : arguments.map(&:to_grpc)
           end
 
           ##
           # @private Exports the StackFrame locals to an array of
-          # Google::Devtools::Clouddebugger::V2::Variable objects.
+          # Google::Cloud::Debugger::V2::Variable objects.
           def locals_to_grpc
             locals.nil? ? [] : locals.map(&:to_grpc)
           end

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

@@ -50,7 +50,7 @@ module Google
 
           ##
           # New Google::Cloud::Debugger::Breakpoint::StatusMessage
-          # from a Google::Devtools::Clouddebugger::V2::StatusMessage object.
+          # from a Google::Cloud::Debugger::V2::StatusMessage object.
           def self.from_grpc grpc
             return nil if grpc.nil?
             new.tap do |s|
@@ -76,14 +76,12 @@ module Google
 
           ##
           # Exports the StatusMessage to a
-          # Google::Devtools::Clouddebugger::V2::StatusMessage object.
+          # Google::Cloud::Debugger::V2::StatusMessage object.
           def to_grpc
             return nil if empty?
-            description_grpc =
-              Google::Devtools::Clouddebugger::V2::FormatMessage.new \
-                format: description.to_s
+            description_grpc = Google::Cloud::Debugger::V2::FormatMessage.new format: description.to_s
 
-            Google::Devtools::Clouddebugger::V2::StatusMessage.new \
+            Google::Cloud::Debugger::V2::StatusMessage.new \
               is_error: true,
               refers_to: refers_to,
               description: description_grpc

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

@@ -244,7 +244,7 @@ module Google
 
             # If source is a non-empty Array or Hash, or source has instance
             # variables, evaluate source as a compound variable.
-            if compound_var?(source) && depth > 0
+            if compound_var?(source) && depth.positive?
               from_compound_var source, name: name, depth: depth,
                                         var_table: var_table, limit: limit
             else
@@ -358,9 +358,7 @@ module Google
 
               limit = deduct_limit limit, member_var.total_size
 
-              buffer_full = (limit && limit < 0) ||
-                            i >= MAX_MEMBERS ||
-                            member_var.buffer_full_variable?
+              buffer_full = limit&.negative? || i >= MAX_MEMBERS || member_var.buffer_full_variable?
 
               if buffer_full
                 var.members << Variable.new.tap do |last_var|
@@ -384,8 +382,7 @@ module Google
             new.tap do |var|
               var.name = name if name
 
-              if var_table && var_table.first &&
-                 var_table.first.buffer_full_variable?
+              if var_table&.first&.buffer_full_variable?
                 var.var_table = var_table
                 var.var_table_index = 0
               else
@@ -408,7 +405,7 @@ module Google
 
           ##
           # @private New Google::Cloud::Debugger::Breakpoint::Variable
-          # from a Google::Devtools::Clouddebugger::V2::Variable object.
+          # from a Google::Cloud::Debugger::V2::Variable object.
           def self.from_grpc grpc
             return new if grpc.nil?
             new.tap do |o|
@@ -423,7 +420,7 @@ module Google
 
           ##
           # @private New array of Google::Cloud::Debugger::Breakpoint::Variable
-          # from an array of Google::Devtools::Clouddebugger::V2::Variable
+          # from an array of Google::Cloud::Debugger::V2::Variable
           # objects.
           def self.from_grpc_list grpc_list
             return [] if grpc_list.nil?
@@ -458,10 +455,10 @@ module Google
 
           ##
           # Exports the Variable to a
-          # Google::Devtools::Clouddebugger::V2::Variable object.
+          # Google::Cloud::Debugger::V2::Variable object.
           def to_grpc
             return nil if empty?
-            Google::Devtools::Clouddebugger::V2::Variable.new(
+            Google::Cloud::Debugger::V2::Variable.new(
               name: name.to_s,
               value: value.to_s,
               type: type.to_s,
@@ -584,7 +581,7 @@ module Google
 
           ##
           # @private Exports the Variable members to an array of
-          # Google::Devtools::Clouddebugger::V2::Variable objects.
+          # Google::Cloud::Debugger::V2::Variable objects.
           def members_to_grpc
             members.nil? ? nil : members.map(&:to_grpc)
           end

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

@@ -68,7 +68,7 @@ module Google
           # object_id, return the array index if found.
           def rb_var_index rb_var
             variables.each_with_index do |var, i|
-              return i if var.source_var.object_id == rb_var.object_id
+              return i if var.source_var.equal? rb_var
             end
 
             nil

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

@@ -12,9 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
-require "google/cloud/debugger/v2/credentials"
-require "google/cloud/logging/credentials"
+require "google/cloud/debugger/v2/debugger/credentials"
 
 module Google
   module Cloud
@@ -38,9 +36,14 @@ module Google
       #
       #   debugger.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Debugger::V2::Credentials
-        SCOPE = (Google::Cloud::Debugger::V2::Credentials::SCOPE +
-                 Google::Cloud::Logging::Credentials::SCOPE).uniq.freeze
+      class Credentials < Google::Cloud::Debugger::V2::Debugger::Credentials
+        self.scope = [
+          "https://www.googleapis.com/auth/cloud-platform",
+          "https://www.googleapis.com/auth/cloud_debugger",
+          "https://www.googleapis.com/auth/logging.admin",
+          "https://www.googleapis.com/auth/logging.read",
+          "https://www.googleapis.com/auth/logging.write"
+        ]
       end
     end
   end