appmap 0.84.0 → 0.85.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc5d48a877bd0953d1d374fcabfa23bf584ac81bd4f303d4f759fb531a778b22
-  data.tar.gz: 6fe7282152760a910275176ea36987747671e4d06d3983b41ac04edfc217d22c
+  metadata.gz: 002b026a3ee8b2e89a073906212e694f296dcc0666db8450c9051bab372550b2
+  data.tar.gz: 743adc87f3f3ae044c7da5d3040be48f79db21bf5d9861b60ec32f84ba39bc19
 SHA512:
-  metadata.gz: 3385416af1ca8318f5e08fe8edc242be03e7e40b8c15a5a68e6ec0678915cd3ca37a3948bf2651db20f2d56dc3b9ba93dda777a5d21ebcd134de252c78d5af91
-  data.tar.gz: 67ee12c6708a5e29e86462d086b0509db2d4c0b05643182b9ea5209d4acfe792d52532bb3314a48911c07e7d1891a2a32868a55feb13455172e7571c1b7a3570
+  metadata.gz: 6af49c4b8155df95b38edf948217eedfa785151c7d3b6997cee8f0ba5971444c755a1e189a12fffdd640e1ec7e12316bd3a5e70d82e047d1dba4c2873040e5a1
+  data.tar.gz: e5af21dd5198c5291cdcd8da036b54c31c59178c17ccda863e4653aab7efb9a5392325226f90ef973f99107d8a44d24870dab3417d6b50c001ae4d325f50f30a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.85.0](https://github.com/applandinc/appmap-ruby/compare/v0.84.0...v0.85.0) (2022-08-08)
+
+
+### Features
+
+* Tune method parameters ([4a7b575](https://github.com/applandinc/appmap-ruby/commit/4a7b575e6f9684adaac4b592adc1ad2c832e900d))
+
 # [0.84.0](https://github.com/applandinc/appmap-ruby/compare/v0.83.6...v0.84.0) (2022-08-04)
 
 

data/lib/appmap/builtin_hooks/activesupport.yml

@@ -11,7 +11,9 @@
   require_name: active_support/security_utils
   force: true
 - method: ActiveSupport.run_load_hooks
-  label: deserialize.safe
+  labels:
+  - deserialize.safe
+  - lang.eval.safe
   require_name: active_support/lazy_load_hooks
   force: true
 - method: ActiveSupport::MessageEncryptor#encrypt_and_sign

data/lib/appmap/builtin_hooks/ruby.yml

@@ -2,6 +2,7 @@
   - Marshal#load
   - Marshal#restore
   require_name: ruby
+  handler_class: AppMap::Handler::MarshalLoadHandler
   label: deserialize.unsafe
 - method: Marshal#dump
   require_name: ruby
@@ -29,3 +30,6 @@
   - Process#spawn
   require_name: ruby
   label: system.exec
+- methods:
+  - ERB#result
+  require_name: ruby

data/lib/appmap/event.rb

@@ -193,7 +193,7 @@ module AppMap
 
         public
 
-        def build_from_invocation(defined_class, method, receiver, arguments, event: MethodCall.new)
+        def build_from_invocation(defined_class, method, receiver, arguments, parameters: method.parameters, event: MethodCall.new)
           event ||= MethodCall.new
           defined_class ||= 'Class'
 
@@ -208,10 +208,10 @@ module AppMap
 
             # Check if the method has key parameters. If there are any they'll always be last.
             # If yes, then extract it from arguments.
-            has_key = [[:dummy], *method.parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
+            has_key = [[:dummy], *parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
             kwargs = has_key && arguments[-1].dup || {}
 
-            event.parameters = method.parameters.map.with_index do |method_param, idx|
+            event.parameters = parameters.map.with_index do |method_param, idx|
               param_type, param_name = method_param
               param_name ||= 'arg'
               value = case param_type

data/lib/appmap/handler/eval_handler.rb

@@ -23,6 +23,21 @@ module AppMap
     # To avoid this, we explicitly substitute the correct execution
     # context, up several stack frames.
     class EvalHandler < FunctionHandler
+      # Kernel#eval reports the method parameters as :rest, instead of what you might expect from
+      # the documented signature: eval(string [, binding [, filename [,lineno]]])
+      # In the C code, it's defined as rb_f_eval(int argc, const VALUE *argv, VALUE self),
+      # so maybe that's why the parameters are reported as :rest.
+      #
+      # In any case, reporting the parameters as :rest means that the code string, binding, etc
+      # are reported in the AppMap as members of an Array, without individual object ids or types.
+      #
+      # To make eval easier to analyze, fake the hook_method parameters to better match
+      # the documentation.
+      PARAMETERS= [
+        [ :req, :string ],
+        [ :rest ],
+      ]
+
       # The depth of the frame we need to pluck out:
       # 1. Hook::Method#do_call
       # 2. Hook::Method#trace_call
@@ -31,6 +46,10 @@ module AppMap
       # 5. the (intended) frame of the original eval that we hooked
       # Note it needs to be adjusted if this call sequence changes.
       FRAME_DEPTH = 5
+  
+      def handle_call(receiver, args)
+        AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args, parameters: PARAMETERS)
+      end
 
       def do_call(receiver, src = nil, context = nil, *rest)
         context ||= AppMap.caller_binding FRAME_DEPTH

data/lib/appmap/handler/marshal_load_handler.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'appmap/handler/function_handler'
+
+module AppMap
+  module Handler
+    class MarshalLoadHandler < FunctionHandler
+      PARAMETERS= [
+        [ :req, :source ],
+        [ :rest ],
+      ]
+
+      def handle_call(receiver, args)
+        AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args, parameters: PARAMETERS)
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.84.0'
+  VERSION = '0.85.0'
 
   APPMAP_FORMAT_VERSION = '1.7.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.84.0
+  version: 0.85.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -396,6 +396,7 @@ files:
 - lib/appmap/handler.rb
 - lib/appmap/handler/eval_handler.rb
 - lib/appmap/handler/function_handler.rb
+- lib/appmap/handler/marshal_load_handler.rb
 - lib/appmap/handler/net_http_handler.rb
 - lib/appmap/handler/open_ssl_handler.rb
 - lib/appmap/handler/rails/render_handler.rb