appmap 0.77.4 → 0.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3775abc9bff6d949fa377e2da5121414500735c37d9c5b9d6f03a7a2ae31a7
-  data.tar.gz: 7254e2e5c3f25f431cdb25e8d0512d55a155afd8b64647b255b3a8223b663f3f
+  metadata.gz: 8dce970e998105e2e322410b204af7a0ff48790cd177225468e9b49c75651fdb
+  data.tar.gz: d93b8f4f0690bf5ade69b2c08e4354d3043567fc4bf6018d6e68084eece08be9
 SHA512:
-  metadata.gz: cf54fd237e40750eff85fb4723651a747ba6e69214ea04acae1a95964a09e4a800ea1de31dbc4f7dec7d26c585ef7fb9167a3e97eb36e9b0c14003240696d6d6
-  data.tar.gz: 81f413c5e21379b145a99f9882db9faea3d27e75ef56df7a8a928ce0b74f141c26025300cf0449fbf00128eb4991d99c94316f4fb522c5bd25042fb6ad2cfff3
+  metadata.gz: bea7fecb6bbae7feb68fa649ecba6276b3d497312ff99054c527d2f74117b584dd7119fa8e4a346b0091089786e90a0a2f2f375f1bc94a0e5437dfa8cff99e20
+  data.tar.gz: 913ab70d04467c584ecf5edfe4c8d60807974cf3d01eb9f2107ceaaa8677c157dc3b0e4130b6e90dcdaba3ba055b4a5268b40e94d0054eb6c41d1146205b0eff

data/.rubocop.yml

@@ -19,6 +19,7 @@ Layout/LineLength:
 
 Metrics/BlockLength:
   ExcludedMethods:
+  - describe
   - it
   - context
 

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.78.0](https://github.com/applandinc/appmap-ruby/compare/v0.77.4...v0.78.0) (2022-04-04)
+
+
+### Features
+
+* Hook and label Kernel#eval ([e0c151d](https://github.com/applandinc/appmap-ruby/commit/e0c151d1371f5bed5597ffd0d3bfebb8bca247c2))
+
 ## [0.77.4](https://github.com/applandinc/appmap-ruby/compare/v0.77.3...v0.77.4) (2022-04-04)
 
 

data/ext/appmap/appmap.c

@@ -1,4 +1,5 @@
 #include <ruby.h>
+#include <ruby/debug.h>
 #include <ruby/intern.h>
 
 // Seems like CLASS_OR_MODULE_P should really be in a header file in
@@ -39,7 +40,7 @@ am_define_method_with_arity(VALUE mod, VALUE name, VALUE arity, VALUE proc)
 {
   VALUE arities_key = rb_intern(ARITIES_KEY);
   VALUE arities = rb_ivar_get(mod, arities_key);
-  
+
   if (arities == Qundef || NIL_P(arities)) {
     arities = rb_hash_new();
     rb_ivar_set(mod, arities_key, arities);
@@ -62,7 +63,7 @@ am_get_method_arity(VALUE method, VALUE orig_arity_method)
   }
   // Didn't find one, call the original method.
   if (NIL_P(arity)) {
-    VALUE bound_method = rb_funcall(orig_arity_method, rb_intern("bind"), 1, method);    
+    VALUE bound_method = rb_funcall(orig_arity_method, rb_intern("bind"), 1, method);
     arity = rb_funcall(bound_method, rb_intern("call"), 0);
   }
 
@@ -83,11 +84,29 @@ am_method_arity(VALUE method)
   return am_get_method_arity(method, orig_method_arity);
 }
 
+static VALUE
+bindings_callback(const rb_debug_inspector_t *dbg_context, void *level)
+{
+  const int i = NUM2INT((VALUE) level);
+  if (i >= RARRAY_LEN(rb_debug_inspector_backtrace_locations(dbg_context))) {
+    return Qnil;
+  } else {
+    return rb_debug_inspector_frame_binding_get(dbg_context, i);
+  }
+}
+
+static VALUE
+am_previous_bindings(VALUE self, VALUE level)
+{
+  return rb_debug_inspector_open(bindings_callback, (void *) level);
+}
+
 void Init_appmap() {
   VALUE appmap = rb_define_module("AppMap");
   am_AppMapHook = rb_define_class_under(appmap, "Hook", rb_cObject);
 
   rb_define_singleton_method(am_AppMapHook, "singleton_method_owner_name", singleton_method_owner_name, 1);
+  rb_define_module_function(appmap, "caller_binding", am_previous_bindings, 1);
 
   rb_define_method(rb_cModule, "define_method_with_arity", am_define_method_with_arity, 3);
   rb_define_method(rb_cUnboundMethod, "arity", am_unbound_method_arity, 0);

data/lib/appmap/builtin_hooks/ruby.yml

@@ -14,14 +14,17 @@
   - String#unpack1
   require_name: ruby
   label: string.unpack
-#- methods:
+- methods:
+  - Kernel#eval
+  require_name: ruby
+  label: lang.eval
+  handler_class: AppMap::Handler::Eval
 # 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 
+# 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

data/lib/appmap/handler/eval.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'appmap/handler/function'
+
+module AppMap
+  module Handler
+    # Handler class for Kernel#eval.
+    #
+    # Second argument to eval is a Binding, which despite the name (and
+    # the accessible methods) in addition to locals and receiver also
+    # encapsulates the entire execution context, in particular including
+    # the lexical scope. This is especially important for constant lookup
+    # and definition.
+    #
+    # If the binding is not provided, by default eval will run in the
+    # current frame. Since we call it here, this will mean the #do_call
+    # frame, which would make AppMap::Handler::Eval the lexical scope
+    # for constant lookup and definition; as a consequence
+    # eg. `eval "class Foo; end"` would define
+    # AppMap::Handler::Eval::Foo instead of defining it in
+    # the module where the original call was made.
+    #
+    # To avoid this, we explicitly substitute the correct execution
+    # context, up several stack frames.
+    class Eval < Function
+      # The depth of the frame we need to pluck out:
+      # 1. Hook::Method#do_call
+      # 2. Hook::Method#trace_call
+      # 3. Hook::Method#call
+      # 4. proc generated by Hook::Method#hook_method_def
+      # 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 do_call(receiver, src = nil, context = nil, *rest)
+        context ||= AppMap.caller_binding FRAME_DEPTH
+        hook_method.bind(receiver).call(src, context, *rest)
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

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

data/spec/handler/eval_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# rubocop:disable Security/Eval, Style/EvalWithLocation
+
+require 'spec_helper'
+require 'appmap/config'
+
+describe 'AppMap::Handler::Eval' do
+  include_context 'collect events'
+  let!(:config) { AppMap::Config.new('hook_spec') }
+  before { AppMap.configuration = config }
+  after { AppMap.configuration = nil }
+
+  def record_block
+    AppMap::Hook.new(config).enable do
+      tracer = AppMap.tracing.trace
+      AppMap::Event.reset_id_counter
+      begin
+        yield
+      ensure
+        AppMap.tracing.delete(tracer)
+      end
+      tracer
+    end
+  end
+
+  it 'produces a simple result' do
+    tracer = record_block do
+      expect(eval('12')).to eq(12)
+    end
+    events = collect_events(tracer)
+    expect(events[0]).to match hash_including \
+      defined_class: 'Kernel',
+      method_id: 'eval',
+      parameters: [{ class: 'Array', kind: :rest, name: 'arg', value: '[12]' }]
+  end
+
+  # a la Ruby 2.6.3 ruby-token.rb
+  # token_c = eval("class #{token_n} < #{super_token}; end; #{token_n}")
+  it 'can define a new class' do
+    num = (Random.random_number * 10_000).to_i
+    class_name = "Cls_#{num}"
+    m = ClassMaker
+    cls = nil
+    record_block do
+      cls = m.make_class class_name
+    end
+    expect(cls).to be_instance_of(Class)
+    # If execution context wasn't substituted, the class would be defined as
+    # eg. AppMap::Handler::Eval::Cls_7566
+    expect { AppMap::Handler::Eval.const_get(class_name) }.to raise_error(NameError)
+    # This would be the right behavior
+    expect(m.const_get(class_name)).to be_instance_of(Class)
+    expect(m.const_get(class_name)).to eq(cls)
+    new_cls = Class.new do
+      include m
+    end
+    expect(new_cls.const_get(class_name)).to eq(cls)
+  end
+end
+
+module ClassMaker
+  def self.make_class(class_name)
+    eval "class #{class_name}; end; #{class_name}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.77.4
+  version: 0.78.0
 platform: ruby
 authors:
 - Kevin Gilpin
@@ -376,6 +376,7 @@ files:
 - lib/appmap/gem_hooks/sidekiq.yml
 - lib/appmap/gem_hooks/sprockets.yml
 - lib/appmap/handler.rb
+- lib/appmap/handler/eval.rb
 - lib/appmap/handler/function.rb
 - lib/appmap/handler/net_http.rb
 - lib/appmap/handler/rails/request_handler.rb
@@ -703,6 +704,7 @@ files:
 - spec/fixtures/rails7_users_app/test/models/instructor_test.rb
 - spec/fixtures/rails7_users_app/test/system/.keep
 - spec/fixtures/rails7_users_app/test/test_helper.rb
+- spec/handler/eval_spec.rb
 - spec/hook_spec.rb
 - spec/open_spec.rb
 - spec/rails_recording_spec.rb