appmap 0.73.0 → 0.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df9ed913bb9ce4b945312ab2a50d8305b7c85c8f84a2004b9cf785362fcf2ad2
-  data.tar.gz: 2f2a844c20263b62a1291b05396d883c205cdebf2ae32062206e7bf42c23e757
+  metadata.gz: eb314cb1f41f3735c773670cd8082bbc8cedb98d9b01c6c71a0c6a2d2b094da5
+  data.tar.gz: fb4f94b03bb6c50465d22db22f5cc1d25bfb95e3638543986306ca63ce5603e7
 SHA512:
-  metadata.gz: 330bcbec5db0a2b92662898432b3cc4eb4e8ca98729f6cfc0577d6490a0f19a1908e19b6c58c512c9b5db7e98a9f90804c5f0fe4362f52b31a69849760cde6db
-  data.tar.gz: 29544bb8ae0db136aad8a518511eb6723fe113e54bc4d585d9e06a857f9227f3e0fbf6daa2bcf1067df5092eef88b13034862d09b187e496cb6758eb8ec094eb
+  metadata.gz: 2da7b411bf29e42b6c81dad1c897021e67e85b4770037543508ea2562a6132d3e8c7d2fe8574971231c06f3ebaaa328264d9db461363f3f59166922d8327060f
+  data.tar.gz: 248770c6d301895621c72d6f46c6e6e1c18abaa368356c7c9deebd480e91ce8bb456374c04bd4547ae7423976d8911f1e627c137d2cffdb6801db50bef55a229

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [0.74.0](https://github.com/applandinc/appmap-ruby/compare/v0.73.0...v0.74.0) (2022-03-14)
+
+
+### Bug Fixes
+
+* Apply special case hook handling to Kernel and instance_eval ([25823ff](https://github.com/applandinc/appmap-ruby/commit/25823ff0fb86beff3edc64da251a125ee198ef40))
+* Only apply a method hook to a class that defines the method ([ede2236](https://github.com/applandinc/appmap-ruby/commit/ede22364bfcbf324e8db3aa6d64d5b032f36ace2))
+* Optimize/improve string-ification of values ([c9b6cdb](https://github.com/applandinc/appmap-ruby/commit/c9b6cdb72dfc55cc3a166eda470eba19093e9090))
+
+
+### Features
+
+* Improve hook performance by using bind_call ([e09fce9](https://github.com/applandinc/appmap-ruby/commit/e09fce9f5b3c0b18bc3b81083c1523df6a6932db))
+* Label system.exec, string.pack, string.html_safe ([963c6dd](https://github.com/applandinc/appmap-ruby/commit/963c6ddfa0f607ad219ae8829cfb383b0d5988d0))
+* Log initiation of each builtin hook ([902a736](https://github.com/applandinc/appmap-ruby/commit/902a7360d17c6b49de97f34643c733e8c47c294d))
+
 # [0.73.0](https://github.com/applandinc/appmap-ruby/compare/v0.72.5...v0.73.0) (2022-03-07)
 
 

data/lib/appmap/builtin_hooks/open3.yml

@@ -0,0 +1,13 @@
+- methods:
+  - Open3#capture2
+  - Open3#capture2e
+  - Open3#capture3
+  - Open3#pipeline
+  - Open3#pipeline_r
+  - Open3#pipeline_rw
+  - Open3#pipeline_start
+  - Open3#pipeline_w
+  - Open3#popen2
+  - Open3#popen2e
+  - Open3#popen3
+  label: system.exec

data/lib/appmap/builtin_hooks/ruby.yml

@@ -0,0 +1,39 @@
+- methods:
+  - Marshal#load
+  - Marshal#restore
+  require_name: ruby
+  label: deserialize.unsafe
+- method: Marshal#dump
+  require_name: ruby
+  label: serialize
+- method: String#pack
+  require_name: ruby
+  label: string.pack
+- methods:
+  - String#unpack
+  - String#unpack1
+  require_name: ruby
+  label: string.unpack
+#- methods:
+# TODO: eval does not happen in the right context, and therefore any new constants
+# which are defined are placed on the wrong module/class.
+#  - Kernel#eval
+#  - Binding#eval
+#  - BasicObject#instance_eval
+# These methods cannot be hooked as far as I can tell.
+# Why? When calling one of these functions, the context at the point of 
+# definition is used. It's not possible to bind class_eval to a new context.
+#  - Module#class_eval
+#  - Module#module_eval
+#  require_name: ruby
+#  label: lang.eval
+- methods:
+  - IO#popen
+  - Kernel#exec
+  - Kernel#spawn
+  - Kernel#syscall
+  - Kernel#system
+  - Process#exec
+  - Process#spawn
+  require_name: ruby
+  label: system.exec

data/lib/appmap/cucumber.rb

@@ -51,7 +51,7 @@ module AppMap
         appmap['metadata'] = update_metadata(scenario, appmap['metadata'])
         scenario_filename = AppMap::Util.scenario_filename(appmap['metadata']['name'])
 
-        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, scenario_filename), JSON.generate(appmap))
+        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, scenario_filename), appmap)
       end
 
       def enabled?

data/lib/appmap/event.rb

@@ -20,7 +20,9 @@ module AppMap
     MethodEventStruct = Struct.new(:id, :event, :thread_id)
 
     class MethodEvent < MethodEventStruct
-      LIMIT = 100
+      MAX_ARRAY_ENUMERATION = 10
+      MAX_HASH_ENUMERATION = 10
+      MAX_STRING_LENGTH = 100
 
       class << self
         def build_from_invocation(event_type, event:)
@@ -48,14 +50,14 @@ module AppMap
           end
 
           start = Time.now
-          value_string = custom_display_string(value) || default_display_string(value)
+          value_string, final = custom_display_string(value) || default_display_string(value)
 
           if @times
             elapsed = Time.now - start
             @times[best_class_name(value)] += elapsed
           end
 
-          encode_display_string(value_string)
+          final ? value_string : encode_display_string(value_string)
         end
 
         def object_properties(hash_like)
@@ -80,21 +82,33 @@ module AppMap
         end
 
         def encode_display_string(value)
-          (value||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+          (value||'')[0...MAX_STRING_LENGTH].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
         end
 
         def custom_display_string(value)
           case value
           when NilClass, TrueClass, FalseClass, Numeric, Time, Date
-            value.to_s
+            [ value.to_s, true ]
+          when Symbol
+            [ ":#{value}", true ]
           when String
-            value[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+            result = value[0...MAX_STRING_LENGTH].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+            result << " (...#{value.length - MAX_STRING_LENGTH} more characters)" if value.length > MAX_STRING_LENGTH
+            [ result, true ]
+          when Array
+            result = value[0...MAX_ARRAY_ENUMERATION].map{|v| display_string(v)}.join(', ')
+            result << " (...#{value.length - MAX_ARRAY_ENUMERATION} more items)" if value.length > MAX_ARRAY_ENUMERATION
+            [ [ '[', result, ']' ].join, true ]
+          when Hash
+            result = value.keys[0...MAX_HASH_ENUMERATION].map{|key| "#{display_string(key)}=>#{display_string(value[key])}"}.join(', ')
+            result << " (...#{value.size - MAX_HASH_ENUMERATION} more entries)" if value.size > MAX_HASH_ENUMERATION
+            [ [ '{', result, '}' ].join, true ]
           when File
-            "#{value.class}[path=#{value.path}]"
+            [ "#{value.class}[path=#{value.path}]", true ]
           when Net::HTTP
-            "#{value.class}[#{value.address}:#{value.port}]"
+            [ "#{value.class}[#{value.address}:#{value.port}]", true ]
           when Net::HTTPGenericRequest
-            "#{value.class}[#{value.method} #{value.path}]"
+            [ "#{value.class}[#{value.method} #{value.path}]", true ]
           end
         rescue StandardError
           nil

data/lib/appmap/gem_hooks/actionview.yml

@@ -11,3 +11,7 @@
   label: mvc.template.resolver
   handler_class: AppMap::Handler::Rails::Template::ResolverHandler
   require_name: action_view
+- methods:
+  - ActionView::Helpers::SanitizeHelper#sanitize
+  label: string.html_safe
+  require_name: action_view

data/lib/appmap/hook/method.rb

@@ -69,28 +69,24 @@ module AppMap
         after_hook = self.method(:after_hook)
         with_disabled_hook = self.method(:with_disabled_hook)
 
-        hook_method_def = Proc.new do |*args, &block|
-          is_array_containing_empty_hash = ->(obj) {
-            obj.is_a?(Array) && obj.length == 1 && obj[0].is_a?(Hash) && obj[0].size == 0
-          }
-
-          call_instance_method = -> {
-            # https://github.com/applandinc/appmap-ruby/issues/153
-            if NEW_RUBY && is_array_containing_empty_hash.(args) && hook_method.arity == 1
-              if NEW_RUBY
-                hook_method.bind_call(self, {}, &block)
-              else
-                hook_method.bind(self).call({}, &block)
-              end
+        is_array_containing_empty_hash = ->(obj) {
+          obj.is_a?(Array) && obj.length == 1 && obj[0].is_a?(Hash) && obj[0].size == 0
+        }
+
+        call_instance_method = lambda do |receiver, args, &block|
+          # https://github.com/applandinc/appmap-ruby/issues/153
+          if NEW_RUBY && is_array_containing_empty_hash.(args) && hook_method.arity == 1
+            hook_method.bind_call(receiver, {}, &block)
+          else
+            if NEW_RUBY
+              hook_method.bind_call(receiver, *args, &block)
             else
-              if NEW_RUBY
-                hook_method.bind_call(self, *args, &block)
-              else
-                hook_method.bind(self).call(*args, &block)
-              end
+              hook_method.bind(receiver).call(*args, &block)
             end
-          }
+          end
+        end
 
+        hook_method_def = Proc.new do |*args, &block|
           # We may not have gotten the class for the method during
           # initialization (e.g. for a singleton method on an embedded
           # struct), so make sure we have it now.
@@ -102,7 +98,9 @@ module AppMap
 
           enabled = true if AppMap.tracing.enabled? && !reentrant && !disabled_by_shallow_flag.call
 
-          return call_instance_method.call unless enabled
+          enabled = false if %i[instance_eval instance_exec].member?(hook_method.name) && args.empty?
+
+          return call_instance_method.call(self, args, &block) unless enabled
 
           call_event, start_time = with_disabled_hook.call do
             before_hook.call(self, defined_class, args)
@@ -110,7 +108,7 @@ module AppMap
           return_value = nil
           exception = nil
           begin
-            return_value = call_instance_method.call
+            return_value = call_instance_method.call(self, args, &block)
           rescue
             exception = $ERROR_INFO
             raise
@@ -125,8 +123,18 @@ module AppMap
         hook_method_parameters = hook_method.parameters.dup.freeze
         SIGNATURES[[ hook_class, hook_method.name ]] = hook_method_parameters
 
-        hook_class.ancestors.first.tap do |cls|
-          cls.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
+        # irb(main):001:0> Kernel.public_instance_method(:system)
+        # (irb):1:in `public_instance_method': method `system' for module `Kernel' is  private (NameError)
+        if hook_class == Kernel
+          hook_class.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
+        else
+          hook_class.ancestors.find { |cls| cls.method_defined?(hook_method.name, false) }.tap do |cls|
+            if cls
+              cls.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
+            else
+              warn "#{hook_method.name} not found on #{hook_class}"
+            end
+          end
         end
       end
 

data/lib/appmap/hook.rb

@@ -105,6 +105,9 @@ module AppMap
 
             Array(hook.method_names).each do |method_name|
               method_name = method_name.to_sym
+
+              warn "AppMap: Initiating hook for builtin #{class_name} #{method_name}" if LOG
+
               base_cls = Util.class_from_string(class_name, must: false)
               next unless base_cls
 
@@ -116,6 +119,11 @@ module AppMap
               end
 
               methods = []
+              # irb(main):001:0> Kernel.public_instance_method(:system)
+              # (irb):1:in `public_instance_method': method `system' for module `Kernel' is  private (NameError)
+              if base_cls == Kernel
+                methods << [ base_cls, base_cls.instance_method(method_name) ] rescue nil
+              end
               methods << [ base_cls, base_cls.public_instance_method(method_name) ] rescue nil
               methods << [ base_cls, base_cls.protected_instance_method(method_name) ] rescue nil
               if base_cls.respond_to?(:singleton_class)

data/lib/appmap/minitest.rb

@@ -120,7 +120,7 @@ module AppMap
         }.compact
         fname = AppMap::Util.scenario_filename(name)
 
-        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
+        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, fname), appmap)
       end
 
       def enabled?

data/lib/appmap/record.rb

@@ -23,5 +23,5 @@ at_exit do
     'classMap' => AppMap.class_map(tracer.event_methods),
     'events' => events
   }
-  AppMap::Util.write_appmap('appmap.json', JSON.generate(appmap))
+  AppMap::Util.write_appmap('appmap.json', appmap)
 end

data/lib/appmap/rspec.rb

@@ -205,7 +205,7 @@ module AppMap
         }.compact
         fname = AppMap::Util.scenario_filename(name)
 
-        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
+        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, fname), appmap)
       end
 
       def enabled?

data/lib/appmap/util.rb

@@ -171,7 +171,7 @@ module AppMap
         mode = File::RDWR | File::CREAT | File::EXCL
         ::Dir::Tmpname.create([ 'appmap_', '.json' ]) do |tmpname|
           tempfile = File.open(tmpname, mode)
-          tempfile.write(appmap)
+          tempfile.write(JSON.generate(appmap))
           tempfile.close
           # Atomically move the tempfile into place.
           FileUtils.mv tempfile.path, filename

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.73.0'
+  VERSION = '0.74.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/spec/display_string_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'appmap/event'
+
+include AppMap
+
+describe 'display_string' do
+  def display_string(value)
+    Event::MethodEvent.display_string value
+  end
+
+  def compare_display_string(value, expected)
+    expect(display_string(value)).to eq(expected)
+  end
+
+  context 'for a' do
+    it 'String' do
+      compare_display_string 'foo', 'foo'
+    end
+    it 'long String' do
+      compare_display_string 'foo' * 100, 'foo' * 33 + 'f (...200 more characters)'
+    end
+    it 'Array' do
+      compare_display_string([ 1, 'my', :bar, [ 2, 3 ], { 4 => 5 } ], '[1, my, :bar, [2, 3], {4=>5}]')
+    end
+    it 'large Array' do
+      compare_display_string 50.times.map { |i| i }, '[0, 1, 2, 3, 4, 5, 6, 7, 8, 9 (...40 more items)]'
+    end
+    it 'large Hash' do
+      compare_display_string(50.times.map { |i| [ i*2, i*2+1] }.to_h, '{0=>1, 2=>3, 4=>5, 6=>7, 8=>9, 10=>11, 12=>13, 14=>15, 16=>17, 18=>19 (...40 more entries)}')
+    end
+    it 'Hash' do
+      compare_display_string({ 1 => 2, 'my' => 'neighbor', bar: :baz, ary: [ 1, 2 ]}, '{1=>2, my=>neighbor, :bar=>:baz, :ary=>[1, 2]}')
+    end
+    it 'big Hash' do
+      compare_display_string(50.times.map { |i| [ i*2, i*2+1] }.to_h, '{0=>1, 2=>3, 4=>5, 6=>7, 8=>9, 10=>11, 12=>13, 14=>15, 16=>17, 18=>19 (...40 more entries)}')
+    end
+  end
+end

data/spec/hook_spec.rb

@@ -1136,7 +1136,7 @@ describe 'AppMap class Hooking', docker: false do
       :parameters:
       - :name: :args
         :class: Array
-        :value: '["foo"]'
+        :value: "[foo]"
         :kind: :rest
       - :name: :kw1
         :class: String

data/spec/rails_recording_spec.rb

@@ -78,7 +78,7 @@ describe 'Rails' do
                 'name' => 'params',
                 'class' => 'ActiveSupport::HashWithIndifferentAccess',
                 'object_id' => Integer,
-                'value' => '{"login"=>"alice"}',
+                'value' => '{login=>alice}',
                 'kind' => 'req'
               ),
               'receiver' => anything

data/spec/record_net_http_spec.rb

@@ -127,7 +127,7 @@ describe 'Net::HTTP handler' do
         :message:
         - :name: ary
           :class: Array
-          :value: '["1", "2"]'
+          :value: "[1, 2]"
         EVENT
       end
 

data/test/gem_test.rb

@@ -24,7 +24,7 @@ class GemTest < Minitest::Test
       appmap_file = 'tmp/appmap/minitest/Parser_parser.appmap.json'
       appmap = JSON.parse(File.read(appmap_file))
       events = appmap['events']
-      assert_equal 2, events.size
+      assert_equal 6, events.size
       assert_equal 'call', events.first['event']
       assert_equal 'default_parser', events.first['method_id']
       assert_match /\lib\/parser\/base\.rb$/, events.first['path']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.73.0
+  version: 0.74.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -339,10 +339,11 @@ files:
 - lib/appmap/agent.rb
 - lib/appmap/builtin_hooks/json.yml
 - lib/appmap/builtin_hooks/logger.yml
-- lib/appmap/builtin_hooks/marshal.yml
 - lib/appmap/builtin_hooks/net/http.yml
+- lib/appmap/builtin_hooks/open3.yml
 - lib/appmap/builtin_hooks/openssl.yml
 - lib/appmap/builtin_hooks/psych.yml
+- lib/appmap/builtin_hooks/ruby.yml
 - lib/appmap/class_map.rb
 - lib/appmap/command/agent_setup/init.rb
 - lib/appmap/command/agent_setup/status.rb
@@ -409,6 +410,7 @@ files:
 - spec/config_spec.rb
 - spec/depends/api_spec.rb
 - spec/depends/spec_helper.rb
+- spec/display_string_spec.rb
 - spec/fixtures/config/incomplete_config.yml
 - spec/fixtures/config/invalid_config.yml
 - spec/fixtures/config/invalid_yaml_config.yml

data/lib/appmap/builtin_hooks/marshal.yml

@@ -1,8 +0,0 @@
-- methods:
-  - Marshal#load
-  - Marshal#restore
-  require_name: ruby
-  label: deserialize.unsafe
-- method: Marshal#dump
-  require_name: ruby
-  label: serialize