google-cloud-debugger 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51d29e7310e1ea9e0f409ee2e2198d52af61c163
-  data.tar.gz: 0e8474858473a49f70b06481f281c98b79e0bd70
+  metadata.gz: 652e6668d5e1d3e951c59d020e2d9469cc96bd8c
+  data.tar.gz: e9e11492a9245c6af29d709375d694c7d528946c
 SHA512:
-  metadata.gz: a1e9da07abc025976a843eee2a93d545a09beedac8b7bfc34345ffd77e676ad17a9827fcafd285be65a05ed2d0adfd5380f2f06a12bcaa63b8cf7a000ac88eed
-  data.tar.gz: b91cc538bbdc514d8105ae0220c482df52be13539c36ad3cb50bb4d0db071a54c146a687c5a34af40a36de04ddd012b283b26b2a309d0d30ef616450c27c33f9
+  metadata.gz: 0f18d03765b379d84dfd271ad0796b5aefc12f6e528e538d281b86cd76a1ba752f624a5a723cd8368930b2f57752113a71116bffb130c00522b274249f36766b
+  data.tar.gz: '00639952a36ba91f983bf974c26fedbfee09c3eaf0056323ae4a059857bfe860491515d29e6111369ee4aa091662f168a3dfdd63f8fd54730be58d43c804c8e6'

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

@@ -55,16 +55,26 @@ hash_get_keys(VALUE hash)
  *  Check the Tracer#breakpoints_cache if any breakpoints match the given
  *  tracepoint_path. Return 1 if found. Otherwise 0;
  */
-static VALUE
+static int
 match_breakpoints_files(VALUE self, VALUE tracepoint_path)
 {
     int i;
-    char *c_tracepoint_path = rb_string_value_cstr(&tracepoint_path);
+    char *c_tracepoint_path;
+    VALUE path_breakpoints_hash;
+    VALUE breakpoints_paths;
+    VALUE *c_breakpoints_paths;
+    int breakpoints_paths_len;
+
+    // Return 0 if the given path is Qnil
+    if(!RTEST(tracepoint_path)) {
+        return 0;
+    }
 
-    VALUE path_breakpoints_hash = rb_iv_get(self, "@breakpoints_cache");
-    VALUE breakpoints_paths = hash_get_keys(path_breakpoints_hash);
-    VALUE *c_breakpoints_paths = RARRAY_PTR(breakpoints_paths);
-    int breakpoints_paths_len = RARRAY_LEN(breakpoints_paths);
+    c_tracepoint_path = rb_string_value_cstr(&tracepoint_path);
+    path_breakpoints_hash = rb_iv_get(self, "@breakpoints_cache");
+    breakpoints_paths = hash_get_keys(path_breakpoints_hash);
+    c_breakpoints_paths = RARRAY_PTR(breakpoints_paths);
+    breakpoints_paths_len = RARRAY_LEN(breakpoints_paths);
 
     for (i = 0; i < breakpoints_paths_len; i++) {
         VALUE breakpoint_path = c_breakpoints_paths[i];
@@ -139,15 +149,28 @@ static void
 line_trace_callback(rb_event_flag_t event, VALUE data, VALUE obj, ID mid, VALUE klass)
 {
     VALUE self = data;
-    const char *c_trace_path = rb_sourcefile();
-    int c_trace_lineno = rb_sourceline();
+    VALUE trace_path;
+    int c_trace_lineno;
+    const char *c_trace_path;
     VALUE trace_binding;
     VALUE call_stack_bindings;
-
-    VALUE matching_result = match_breakpoints(self, c_trace_path, c_trace_lineno);
-
     ID callers_id;
     ID breakpoints_hit_id;
+    VALUE matching_result;
+
+    c_trace_path = rb_sourcefile();
+    // Ensure C_trace_path is absolute path
+    trace_path = rb_str_new_cstr(c_trace_path);
+    trace_path = rb_file_expand_path(trace_path, Qnil);
+
+    if(!RTEST(trace_path)) {
+        return;
+    }
+
+    c_trace_path = rb_string_value_cstr(&trace_path);
+
+    c_trace_lineno = rb_sourceline();
+    matching_result = match_breakpoints(self, c_trace_path, c_trace_lineno);
 
     CONST_ID(callers_id, "callers");
     CONST_ID(breakpoints_hit_id, "breakpoints_hit");
@@ -163,7 +186,6 @@ line_trace_callback(rb_event_flag_t event, VALUE data, VALUE obj, ID mid, VALUE
 
     trace_binding = rb_binding_new();
     call_stack_bindings = rb_funcall(trace_binding, callers_id, 0);
-    rb_ary_pop(call_stack_bindings);
 
     rb_funcall(self, breakpoints_hit_id, 2, matching_result, call_stack_bindings);
 
@@ -248,12 +270,13 @@ enable_line_trace_for_thread(VALUE self)
 static void
 return_trace_callback(void *data, rb_trace_arg_t *trace_arg)
 {
-    VALUE match_found;
+    int match_found;
     VALUE self = (VALUE) data;
     VALUE caller_locations;
     VALUE *c_caller_locations;
     VALUE caller_location;
     VALUE caller_path;
+    int c_caller_locations_len;
 
     ID caller_locations_id;
     ID absolute_path_id;
@@ -261,16 +284,26 @@ return_trace_callback(void *data, rb_trace_arg_t *trace_arg)
     CONST_ID(caller_locations_id, "caller_locations");
     CONST_ID(absolute_path_id, "absolute_path");
 
-    caller_locations = rb_funcall(rb_mKernel, caller_locations_id, 2, INT2NUM(0), INT2NUM(1));
+    caller_locations = rb_funcall(rb_mKernel, caller_locations_id, 2, INT2NUM(1), INT2NUM(1));
 
+
+    // Return if current execution stack is too shallow.
     if(!RTEST(caller_locations)) {
         return;
     }
 
     c_caller_locations = RARRAY_PTR(caller_locations);
+    c_caller_locations_len = RARRAY_LEN(caller_locations);
+
+    // Make sure caller locations has at least one entry.
+    if(c_caller_locations_len == 0) {
+        return;
+    }
+
     caller_location = c_caller_locations[0];
     caller_path = rb_funcall(caller_location, absolute_path_id, 0);
 
+    // Return if caller location doesn't have absolute path. (i.e. dynamically defined method)
     if(!RTEST(caller_path)) {
         return;
     }
@@ -367,11 +400,18 @@ file_tracepoint_callback(VALUE tracepoint, void *data)
     VALUE self = (VALUE) data;
     rb_trace_arg_t *tracepoint_arg = rb_tracearg_from_tracepoint(tracepoint);
     VALUE tracepoint_path = rb_tracearg_path(tracepoint_arg);
-    VALUE match_found;
+    int match_found;
 
     if (!RB_TYPE_P(tracepoint_path, T_STRING))
         return;
 
+    // Ensure tracepoint_path is absolute path
+    tracepoint_path = rb_file_expand_path(tracepoint_path, Qnil);
+
+    if (!RTEST(tracepoint_path)) {
+        return;
+    }
+
     match_found = match_breakpoints_files(self, tracepoint_path);
 
     if (match_found) {

data/lib/google-cloud-debugger.rb

@@ -31,8 +31,8 @@ module Google
     # For more information on connecting to Google Cloud see the [Authentication
     # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
     #
-    # @param [String] module_name Name for the debuggee application. Optional.
-    # @param [String] module_version Version identifier for the debuggee
+    # @param [String] service_name Name for the debuggee application. Optional.
+    # @param [String] service_version Version identifier for the debuggee
     #   application. Optional.
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
@@ -63,13 +63,14 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   debugger = gcloud.debugger scope: platform_scope
     #
-    def debugger module_name: nil, module_version: nil, scope: nil,
+    def debugger service_name: nil, service_version: nil, scope: nil,
                  timeout: nil, client_config: nil
-      Google::Cloud.debugger @project, @keyfile, module_name: module_name,
-                                                 module_version: module_version,
-                                                 scope: scope,
-                                                 timeout: (timeout || @timeout),
-                                                 client_config: client_config
+      Google::Cloud.debugger @project, @keyfile,
+                             service_name: service_name,
+                             service_version: service_version,
+                             scope: scope,
+                             timeout: (timeout || @timeout),
+                             client_config: client_config
     end
 
     ##
@@ -84,8 +85,8 @@ module Google
     #   service you are connecting to.
     # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
     #   file path the file must be readable.
-    # @param [String] module_name Name for the debuggee application. Optional.
-    # @param [String] module_version Version identifier for the debuggee
+    # @param [String] service_name Name for the debuggee application. Optional.
+    # @param [String] service_version Version identifier for the debuggee
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google
@@ -107,13 +108,13 @@ module Google
     #
     #   debugger.start
     #
-    def self.debugger project = nil, keyfile = nil, module_name: nil,
-                      module_version: nil, scope: nil, timeout: nil,
+    def self.debugger project = nil, keyfile = nil, service_name: nil,
+                      service_version: nil, scope: nil, timeout: nil,
                       client_config: nil
       require "google/cloud/debugger"
       Google::Cloud::Debugger.new project: project, keyfile: keyfile,
-                                  module_name: module_name,
-                                  module_version: module_version,
+                                  service_name: service_name,
+                                  service_version: service_version,
                                   scope: scope, timeout: timeout,
                                   client_config: client_config
     end

data/lib/google/cloud/debugger.rb

@@ -104,10 +104,10 @@ module Google
     # config.google_cloud.keyfile = "/path/to/keyfile.json"
     # # Google Cloud authentication json file for Stackdriver Debugger only
     # config.google_cloud.debugger.keyfile = "/path/to/debugger/keyfile.json"
-    # # Stackdriver Debugger Agent module name identifier
-    # config.google_cloud.debugger.module_name = "my-ruby-app"
-    # # Stackdriver Debugger Agent module version identifier
-    # config.google_cloud.debugger.module_version = "v1"
+    # # Stackdriver Debugger Agent service name identifier
+    # config.google_cloud.debugger.service_name = "my-ruby-app"
+    # # Stackdriver Debugger Agent service version identifier
+    # config.google_cloud.debugger.service_version = "v1"
     # ```
     #
     # See the {Google::Cloud::Debugger::Railtie} class for more information.
@@ -130,8 +130,8 @@ module Google
     # require "google/cloud/debugger"
     # use Google::Cloud::Debugger::Middleware project: "debugger-project-id",
     #                                         keyfile: "/path/to/keyfile.json",
-    #                                         module_name: "my-ruby-app",
-    #                                         module_version: "v1"
+    #                                         service_name: "my-ruby-app",
+    #                                         service_version: "v1"
     # ```
     #
     # ### Using instrumentation with other Rack-based frameworks
@@ -343,8 +343,9 @@ module Google
       #   service.
       # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud:
       #   either the JSON data or the path to a readable file.
-      # @param [String] module_name Name for the debuggee application. Optional.
-      # @param [String] module_version Version identifier for the debuggee
+      # @param [String] service_name Name for the debuggee application.
+      #   Optional.
+      # @param [String] service_version Version identifier for the debuggee
       #   application. Optional.
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
@@ -361,19 +362,19 @@ module Google
       #   debugger = Google::Cloud::Debugger.new
       #   debugger.start
       #
-      def self.new project: nil, keyfile: nil, module_name: nil,
-                   module_version: nil, scope: nil, timeout: nil,
+      def self.new project: nil, keyfile: nil, service_name: nil,
+                   service_version: nil, scope: nil, timeout: nil,
                    client_config: nil
         project ||= Debugger::Project.default_project
         project = project.to_s # Always cast to a string
-        module_name ||= Debugger::Project.default_module_name
-        module_name = module_name.to_s
-        module_version ||= Debugger::Project.default_module_version
-        module_version = module_version.to_s
+        service_name ||= Debugger::Project.default_service_name
+        service_name = service_name.to_s
+        service_version ||= Debugger::Project.default_service_version
+        service_version = service_version.to_s
 
         fail ArgumentError, "project is missing" if project.empty?
-        fail ArgumentError, "module_name is missing" if module_name.empty?
-        fail ArgumentError, "module_version is missing" if module_version.nil?
+        fail ArgumentError, "service_name is missing" if service_name.empty?
+        fail ArgumentError, "service_version is missing" if service_version.nil?
 
         credentials = Credentials.credentials_with_scope keyfile, scope
 
@@ -381,8 +382,8 @@ module Google
           Google::Cloud::Debugger::Service.new(
             project, credentials, timeout: timeout,
                                   client_config: client_config),
-          module_name: module_name,
-          module_version: module_version
+          service_name: service_name,
+          service_version: service_version
         )
       end
 

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

@@ -114,19 +114,19 @@ module Google
         #   object
         # @param [Google::Cloud::Logging::Logger] logger The logger used
         #   to write the results of Logpoints.
-        # @param [String] module_name Name for the debuggee application.
-        # @param [String] module_version Version identifier for the debuggee
+        # @param [String] service_name Name for the debuggee application.
+        # @param [String] service_version Version identifier for the debuggee
         #   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, service_name:, service_version:,
                        app_root: nil
           super()
 
           @service = service
-          @debuggee = Debuggee.new service, module_name: module_name,
-                                            module_version: module_version
+          @debuggee = Debuggee.new service, service_name: service_name,
+                                            service_version: service_version
           @tracer = Debugger::Tracer.new self
           @breakpoint_manager = BreakpointManager.new self, service
           @breakpoint_manager.on_breakpoints_change =
@@ -136,8 +136,7 @@ module Google
 
           @logger = logger || default_logger
 
-          @app_root = app_root
-          @app_root ||= Rack::Directory.new("").root if defined? Rack::Directory
+          init_app_root app_root
 
           # Agent actor thread needs to force exit immediately.
           set_cleanup_options timeout: 0
@@ -199,6 +198,16 @@ module Google
 
         private
 
+        ##
+        # @private Initialize `@app_root` instance variable.
+        def init_app_root app_root = nil
+          app_root ||= Google::Cloud::Debugger.configure.app_root
+          app_root ||= Rack::Directory.new("").root if defined? Rack::Directory
+          app_root ||= Dir.pwd
+
+          @app_root = app_root
+        end
+
         ##
         # @private Callback function for breakpoint manager when any updates
         # happens to the list of active breakpoints

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

@@ -271,7 +271,8 @@ module Google
         ##
         # Get the file path of this breakpoint
         # @example
-        #   breakpoint = Breakpoint.new nil, "path/to/file.rb"
+        #   breakpoint =
+        #     Google::Cloud::Debugger::Breakpoint.new nil, "path/to/file.rb"
         #   breakpoint.path #=> "path/to/file.rb"
         # @return [String] The file path for this breakpoint
         def path
@@ -281,7 +282,8 @@ module Google
         ##
         # Get the line number of this breakpoint
         # @example
-        #   breakpoint = Breakpoint.new nil, "path/to/file.rb", 11
+        #   breakpoint =
+        #     Google::Cloud::Debugger::Breakpoint.new nil, "path/to/file.rb", 11
         #   breakpoint.line #=> 11
         # @return [Integer] The line number for this breakpoint
         def line

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

@@ -107,6 +107,7 @@ module Google
             Complex,
             FalseClass,
             Float,
+            Integer,
             MatchData,
             NilClass,
             Numeric,
@@ -120,7 +121,7 @@ module Google
             Enumerable,
             Math
           ].concat(
-            RUBY_VERSION.to_f >= 2.4 ? [Integer] : [Bignum, Fixnum]
+            RUBY_VERSION.to_f >= 2.4 ? [] : [Bignum, Fixnum]
           ).freeze
 
           ##
@@ -934,7 +935,15 @@ module Google
             #   Otherwise raise Google::Cloud::Debugger::MutationError error.
             #
             def trace_func_callback receiver, mid
-              meth = receiver.method mid
+              meth = nil
+              begin
+                meth = receiver.method mid
+              rescue
+                raise Google::Cloud::Debugger::EvaluationError.new(
+                  PROHIBITED_OPERATION_MSG,
+                  Google::Cloud::Debugger::EvaluationError::META_PROGRAMMING)
+              end
+
               yarv_instructions = RubyVM::InstructionSequence.disasm meth
 
               return if immutable_yarv_instructions?(yarv_instructions,
@@ -998,9 +1007,10 @@ module Google
       # @private Custom error type used to identify evaluation error during
       # breakpoint expression evaluation.
       class EvaluationError < StandardError
-        UNKNOWN_CAUSE = Object.new.freeze
-        PROHIBITED_YARV = Object.new.freeze
-        PROHIBITED_C_FUNC = Object.new.freeze
+        UNKNOWN_CAUSE = :unknown_cause
+        PROHIBITED_YARV = :prohibited_yarv
+        PROHIBITED_C_FUNC = :prohibited_c_func
+        META_PROGRAMMING = :meta_programming
 
         attr_reader :mutation_cause
 

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

@@ -57,9 +57,10 @@ module Google
           end
 
           ##
-          # @private Check the file from given file path is a ".rb" file
+          # @private Check the file from given file path is a Ruby file
           def self.verify_file_type file_path
-            File.extname(file_path) == ".rb"
+            File.extname(file_path) == ".rb" ||
+              File.basename(file_path) == "config.ru"
           rescue
             false
           end

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

@@ -101,6 +101,10 @@ module Google
           # full.
           BUFFER_FULL_MSG = "Buffer full. Use an expression to see more data."
 
+          ##
+          # @private Error message when variable can't be converted.
+          FAIL_CONVERSION_MSG = "Error: Unable to inspect value"
+
           ##
           # @private Name of the variable, if any.
           # @return [String]
@@ -174,42 +178,46 @@ module Google
           #   conversions.
           #
           # @example Simple variable conversion
-          #   x = 3
-          #   var = Variable.from_rb_var x, name: "x"
+          #   x = 3.0
+          #   var = Google::Cloud::Debugger::Breakpoint::Variable.from_rb_var \
+          #           x, name: "x"
           #   var.name  #=> "x"
-          #   var.value #=> "3"
-          #   var.type  #=> "Integer"
+          #   var.value #=> "3.0"
+          #   var.type  #=> "Float"
           #
           # @example Hash conversion
-          #   hash = {a: 1, b: :two}
-          #   var = Variable.from_rb_var hash, name: "hash"
+          #   hash = {a: 1.0, b: :two}
+          #   var = Google::Cloud::Debugger::Breakpoint::Variable.from_rb_var \
+          #           hash, name: "hash"
           #   var.name  #=> "hash"
           #   var.type  #=> "Hash"
           #   var.members[0].name  #=> "a"
-          #   var.members[0].value #=> "1"
-          #   var.members[0].type  #=> "Integer"
+          #   var.members[0].value #=> "1.0"
+          #   var.members[0].type  #=> "Float"
           #   var.members[1].name  #=> "b"
-          #   var.members[1].value #=> "two"
+          #   var.members[1].value #=> ":two"
           #   var.members[1].type  #=> "Symbol"
           #
           # @example Custom compound variable conversion
-          #   foo = Foo.new(a: 1, b: []) #=> #<Foo:0x0000 @a: 1, @b: []>
-          #   var_table = VariableTable.new
-          #   var = Variable.from_rb_var foo, name: "foo"
+          #   foo = Foo.new(a: 1.0, b: [])
+          #   foo.inspect  #=> "#<Foo:0xXXXXXX @a=1.0, @b=[]>"
+          #   var = Google::Cloud::Debugger::Breakpoint::Variable.from_rb_var \
+          #           foo, name: "foo"
           #   var.name  #=> "foo"
           #   var.type  #=> "Foo"
           #   var.members[0].name  #=> "@a"
-          #   var.members[0].value #=> "1"
-          #   var.members[0].type  #=> "Integer"
+          #   var.members[0].value #=> "1.0"
+          #   var.members[0].type  #=> "Float"
           #   var.members[1].name  #=> "@b"
           #   var.members[1].value #=> "[]"
           #   var.members[1].type  #=> "Array"
           #
           # @example Use variable table for shared compound variables
-          #   hash = {a: 1}
+          #   hash = {a: 1.0}
           #   ary = [hash, hash]
-          #   var_table = VariableTable.new
-          #   var = Variable.from_rb_var ary, name: "ary", var_table: var_table
+          #   var_table = Google::Cloud::Debugger::Breakpoint::VariableTable.new
+          #   var = Google::Cloud::Debugger::Breakpoint::Variable.from_rb_var \
+          #           ary, name: "ary", var_table: var_table
           #   var.name            #=> "ary"
           #   var.var_table_index #=> 0
           #   var_table[0].type   #=> "Array"
@@ -219,8 +227,8 @@ module Google
           #   var_table[0].members[1].var_table_index #=> 1
           #   var_table[1].type #=> "Hash"
           #   var_table[1].members[0].name #=> "a"
-          #   var_table[1].members[0].type #=> "Integer"
-          #   var_table[1].members[0].value #=> "1"
+          #   var_table[1].members[0].type #=> "Float"
+          #   var_table[1].members[0].value #=> "1.0"
           #
           # @return [Google::Cloud::Debugger::Breakpoint::Variable] Converted
           #   variable.
@@ -239,14 +247,27 @@ module Google
               from_compound_var source, name: name, depth: depth,
                                         var_table: var_table, limit: limit
             else
-              new.tap do |var|
-                var.name = name.to_s if name
-                var.type = source.class.to_s
-                limit = deduct_limit limit,
-                                     var.name.to_s.bytesize + var.type.bytesize
-                var.value = truncate_value source.inspect, limit
-                var.source_var = source
-              end
+              from_primitive_var source, name: name, limit: limit
+            end
+          rescue
+            new.tap do |var|
+              var.name = name.to_s if name
+              var.set_error_state FAIL_CONVERSION_MSG
+              var.source_var = source
+            end
+          end
+
+          ##
+          # @private Helper method that converts primitive variables.
+          def self.from_primitive_var source, name: nil, limit: nil
+            new.tap do |var|
+              var.name = name.to_s if name
+              var.type = source.class.to_s
+              var.source_var = source
+              limit = deduct_limit limit,
+                                   var.name.to_s.bytesize + var.type.bytesize
+
+              var.value = truncate_value source.inspect, limit
             end
           end
 
@@ -344,8 +365,7 @@ module Google
                 var.members << Variable.new.tap do |last_var|
                   last_var.set_error_state \
                     "Only first #{i} items were captured. Use in " \
-                    "an expression to see all items.",
-                    refers_to: StatusMessage::VARIABLE_VALUE
+                    "an expression to see all items."
                 end
                 break
               else
@@ -368,8 +388,7 @@ module Google
                 var.var_table = var_table
                 var.var_table_index = 0
               else
-                var.set_error_state BUFFER_FULL_MSG,
-                                    refers_to: StatusMessage::VARIABLE_VALUE
+                var.set_error_state BUFFER_FULL_MSG
               end
             end
           end
@@ -382,7 +401,8 @@ module Google
 
           private_class_method :add_compound_members,
                                :add_shared_compound_var,
-                               :add_member_vars, :compound_var?,
+                               :add_member_vars,
+                               :compound_var?,
                                :deduct_limit
 
           ##
@@ -452,7 +472,7 @@ module Google
 
           ##
           # Set this variable to an error state by setting the status field
-          def set_error_state message, refers_to: StatusMessage::UNSPECIFIED
+          def set_error_state message, refers_to: StatusMessage::VARIABLE_VALUE
             @status = StatusMessage.new.tap do |s|
               s.is_error = true
               s.refers_to = refers_to

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

@@ -141,7 +141,8 @@ module Google
         # Evaluates a hit breakpoint, and submit the breakpoint to
         # Transmitter if this breakpoint is evaluated successfully.
         #
-        # See {Breakpoint#evaluate} for evaluation details.
+        # See {Snappoint#evaluate} and {Logpoint#evaluate} for evaluation
+        # details.
         #
         # @param [Google::Cloud::Debugger::Breakpoint] breakpoint The breakpoint
         #   to be evaluated

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

@@ -48,12 +48,12 @@ module Google
         ##
         # Name for the debuggee application
         # @return [String]
-        attr_reader :module_name
+        attr_reader :service_name
 
         ##
         # Version identifier for the debuggee application
         # @return [String]
-        attr_reader :module_version
+        attr_reader :service_version
 
         ##
         # Registered Debuggee ID. Set by Stackdriver Debugger service when
@@ -63,10 +63,10 @@ module Google
 
         ##
         # @private Construct a new instance of Debuggee
-        def initialize service, module_name:, module_version:
+        def initialize service, service_name:, service_version:
           @service = service
-          @module_name = module_name
-          @module_version = module_version
+          @service_name = service_name
+          @service_version = service_version
           @computed_uniquifier = nil
           @id = nil
         end
@@ -142,8 +142,8 @@ module Google
         def labels
           {
             "projectid" => String(project_id),
-            "module" => String(module_name),
-            "version" => String(module_version)
+            "module" => String(service_name),
+            "version" => String(service_version)
           }
         end
 
@@ -155,10 +155,10 @@ module Google
         # @return [String] A compact debuggee description.
         #
         def description
-          if module_version.nil? || module_version.empty?
-            module_name
+          if service_version.nil? || service_version.empty?
+            service_name
           else
-            "#{module_name} - #{module_version}"
+            "#{service_name} - #{service_version}"
           end
         end
 

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

@@ -29,7 +29,7 @@ module Google
         ##
         # Evaluate the breakpoint unless it's already marked as completed.
         # Store evaluted expressions and stack frame variables in
-        # @evaluated_expressions and @evaluated_log_message.
+        # `@evaluated_expressions` and `@evaluated_log_message`.
         #
         # @param [Array<Binding>] call_stack_bindings An array of Ruby Binding
         #   objects, from the call stack that leads to the triggering of the
@@ -69,8 +69,9 @@ module Google
         # @private Format log message by interpolate expressions.
         #
         # @example
-        #   Evaluator.format_log_message("Hello $0",
-        #                                ["World"]) #=> "Hello World"
+        #   log_point = Google::Cloud::Debugger::Logpoint.new
+        #   log_point.format_message(
+        #     "Hello $0", ["World"]) #=> "Hello \"World\""
         #
         # @param [String] message_format The message with with
         #   expression placeholders such as `$0`, `$1`, etc.

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

@@ -51,8 +51,8 @@ module Google
             @debugger =
               Debugger.new(project: configuration.project_id,
                            keyfile: configuration.keyfile,
-                           module_name: configuration.module_name,
-                           module_version: configuration.module_version)
+                           service_name: configuration.service_name,
+                           service_version: configuration.service_version)
 
             @debugger.agent.quota_manager =
               Google::Cloud::Debugger::RequestQuotaManager.new
@@ -104,10 +104,10 @@ module Google
           configuration.keyfile = kwargs[:keyfile] ||
                                   configuration.keyfile
 
-          configuration.module_name = kwargs[:module_name] ||
-                                      configuration.module_name
-          configuration.module_version = kwargs[:module_version] ||
-                                         configuration.module_version
+          configuration.service_name = kwargs[:service_name] ||
+                                       configuration.service_name
+          configuration.service_version = kwargs[:service_version] ||
+                                          configuration.service_version
 
           init_default_config
         end
@@ -119,9 +119,9 @@ module Google
                                        Debugger::Project.default_project
           configuration.keyfile ||= Cloud.configure.keyfile
 
-          configuration.module_name ||= Debugger::Project.default_module_name
-          configuration.module_version ||=
-            Debugger::Project.default_module_version
+          configuration.service_name ||= Debugger::Project.default_service_name
+          configuration.service_version ||=
+            Debugger::Project.default_service_version
         end
 
         ##

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

@@ -50,10 +50,10 @@ module Google
 
         ##
         # @private Creates a new Project instance.
-        def initialize service, module_name:, module_version:
+        def initialize service, service_name:, service_version:
           @service = service
-          @agent = Agent.new service, module_name: module_name,
-                                      module_version: module_version
+          @agent = Agent.new service, service_name: service_name,
+                                      service_version: service_version
         end
 
         ##
@@ -85,17 +85,17 @@ module Google
         end
 
         ##
-        # @private Default module name identifier.
-        def self.default_module_name
-          ENV["DEBUGGER_MODULE_NAME"] ||
+        # @private Default service name identifier.
+        def self.default_service_name
+          ENV["DEBUGGER_SERVICE_NAME"] ||
             Google::Cloud.env.app_engine_service_id ||
             "ruby-app"
         end
 
         ##
-        # @private Default module version identifier.
-        def self.default_module_version
-          ENV["DEBUGGER_MODULE_VERSION"] ||
+        # @private Default service version identifier.
+        def self.default_service_version
+          ENV["DEBUGGER_SERVICE_VERSION"] ||
             Google::Cloud.env.app_engine_service_version ||
             ""
         end

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

@@ -23,8 +23,9 @@ module Google
       # Google::Cloud::Debugger::Railtie automatically adds the
       # Google::Cloud::Debugger::Middleware to Rack in a Rails environment.
       #
-      # The Middleware is only added when certain conditions are met. See
-      # {Railtie.use_debugger?} for detail.
+      # The Middleware is only added when the
+      # `Google::Cloud.configure.use_debugger` setting is true or Rails is
+      # in the production environment.
       #
       # When loaded, the Google::Cloud::Debugger::Middleware will be inserted
       # after the Rack::ETag Middleware, which is top of the Rack stack, closest
@@ -62,7 +63,7 @@ module Google
         # configuration. Also consolidate the `use_debugger` setting by
         # verifying credentials and Rails environment. The `use_debugger`
         # setting will be true if credentials are valid, and the setting is
-        # manually set to true or Rails is in production environment.
+        # manually set to true or Rails is in the production environment.
         #
         # @param [Rails::Railtie::Configuration] config The
         #   Rails.application.config
@@ -85,7 +86,7 @@ module Google
           end
 
           # Otherwise set use_debugger to true if Rails is running in
-          # production
+          # the production environment
           Google::Cloud.configure.use_debugger ||= Rails.env.production?
         end
 
@@ -100,8 +101,8 @@ module Google
           Debugger.configure do |config|
             config.project_id ||= dbg_config.project_id || gcp_config.project_id
             config.keyfile ||= dbg_config.keyfile || gcp_config.keyfile
-            config.module_name ||= dbg_config.module_name
-            config.module_version ||= dbg_config.module_version
+            config.service_name ||= dbg_config.service_name
+            config.service_version ||= dbg_config.service_version
           end
         end
 
@@ -110,8 +111,8 @@ module Google
         def self.init_default_config
           config = Debugger.configure
           config.project_id ||= Debugger::Project.default_project
-          config.module_name ||= Debugger::Project.default_module_name
-          config.module_version ||= Debugger::Project.default_module_version
+          config.service_name ||= Debugger::Project.default_service_name
+          config.service_version ||= Debugger::Project.default_service_version
         end
 
         ##

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

@@ -100,7 +100,7 @@ module Google
         # rules. If the expressions do any write operations, the evaluations
         # abort and show an error message in place of the real result.
         #
-        # @param [Binding] binding The binding object from the context
+        # @param [Binding] bind The binding object from the context
         #
         def eval_expressions bind
           @evaluated_expressions = []

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.27.0"
+      VERSION = "0.28.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller