appmap 0.28.0 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d94a20303fe329af9dfa6f4a0d4b14666a7eb25cba58d0ea6ede64b5991e85f9
-  data.tar.gz: c441d6ee26453338fa449fed7762a0768155eaa934168c2245c47a5deb78cb38
+  metadata.gz: 8619a5924ba51ee48d76ebfe5c72030629c5338217b4fe659cd0a580eaa6ddb9
+  data.tar.gz: 0d8b1e8fcd41e0785b362350a53c95c5bc0ba5c628371b7b6216315b7ddcd85e
 SHA512:
-  metadata.gz: a66524169eeb5e8d78974a8ac37122f52d5e2285cb4ff6f88f58947e8016d2b4ac458430df07a5b4e9c5ab37fdc7122bb887c694e375a7013bc8f34bf1b6b6b2
-  data.tar.gz: 665354eca628d2d0f68706cf297667b9b3392a43e6dc364923f1f45f5316a6d3db54dea2d1e75ae83cd53c3ed9cb40ecc3794c10c9d6ee1c310aeed6710bb931
+  metadata.gz: c4da2cadb6a852b1213d1938b035ca147a939e7dc1378ef435d1e8b4d42d6f5b98e19191ecd2e1d1e48493817117123e0b9167080308dcc9ea5527bb676f436b
+  data.tar.gz: 04c2a36c913a3eec42dcd8aa61e789b9b91fed1e43b4bfe84729c6a7b4451fb1064c6efdba39e3818674df8f9560caa486e1d4c8170f04682938775fbb2c4d7e

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.28.1
+* Fix the `defined_class` recorded in an appmap for an instance method included in a class
+  at runtime.
+
+* Only include the `static` attribute on `call` events in an appmap. Determine its value
+  based on the receiver of the method call.
+
 # v0.28.0
 
 * Change behavior of **AppMap.record** to return a complete AppMap as a Hash.

data/lib/appmap/algorithm/stats.rb

@@ -74,10 +74,11 @@ module AppMap
 
         class_name_func = ->(event) { event['defined_class'] }
         full_name_func = lambda do |event|
+          call = event['event'] == 'call'
           class_name = event['defined_class']
           static = event['static']
           function_name = event['method_id']
-          [ class_name, static ? '.' : '#', function_name ].join if class_name && !static.nil? && function_name
+          [ class_name, static ? '.' : '#', function_name ].join if call && class_name && !static.nil? && function_name
         end
 
         class_frequency = frequency_calc.call(class_name_func)

data/lib/appmap/class_map.rb

@@ -95,7 +95,7 @@ module AppMap
         location_file, lineno = location
         location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
 
-        static = method.method.owner.singleton_class?
+        static = method.static
 
         object_infos = [
           {

data/lib/appmap/event.rb

@@ -15,15 +15,13 @@ module AppMap
       end
     end
 
-    MethodEventStruct = Struct.new(:id, :event, :defined_class, :method_id, :path, :lineno, :static, :thread_id)
+    MethodEventStruct = Struct.new(:id, :event, :defined_class, :method_id, :path, :lineno, :thread_id)
 
     class MethodEvent < MethodEventStruct
       LIMIT = 100
 
       class << self
         def build_from_invocation(me, event_type, defined_class, method)
-          singleton = method.owner.singleton_class?
-
           me.id = AppMap::Event.next_id_counter
           me.event = event_type
           me.defined_class = defined_class
@@ -32,7 +30,6 @@ module AppMap
           path = path[Dir.pwd.length + 1..-1] if path.index(Dir.pwd) == 0
           me.path = path
           me.lineno = method.source_location[1]
-          me.static = singleton
           me.thread_id = Thread.current.object_id
         end
 
@@ -62,11 +59,10 @@ module AppMap
         end
       end
 
-      alias static? static
     end
 
     class MethodCall < MethodEvent
-      attr_accessor :parameters, :receiver
+      attr_accessor :parameters, :receiver, :static
 
       class << self
         def build_from_invocation(mc = MethodCall.new, defined_class, method, receiver, arguments)
@@ -88,6 +84,7 @@ module AppMap
               object_id: receiver.__id__,
               value: display_string(receiver)
             }
+            mc.static = receiver.is_a?(Module)
             MethodEvent.build_from_invocation(mc, :call, defined_class, method)
           end
         end
@@ -95,10 +92,13 @@ module AppMap
 
       def to_h
         super.tap do |h|
+          h[:static] = static
           h[:parameters] = parameters
           h[:receiver] = receiver
         end
       end
+
+      alias static? static
     end
 
     class MethodReturnIgnoreValue < MethodEvent

data/lib/appmap/hook.rb

@@ -106,15 +106,24 @@ module AppMap
               # Skip methods that have no instruction sequence, as they are obviously trivial.
               next unless disasm
 
-              defined_class, method_symbol = \
-                if method.owner.singleton_class?
-                  # Singleton class name is like: #<Class:<(.*)>>
-                  class_name = method.owner.to_s['#<Class:<'.length-1..-2]
-                  [ class_name, '.' ]
-                else
-                  [ method.owner.name, '#' ]
-                end
-
+              defined_class, method_symbol = if method.owner.singleton_class?
+                # Singleton class names can take two forms:
+                # #<Class:Foo> or
+                # #<Class:#<Bar:0x0123ABC>>. Retrieve the name of
+                # the class from the string.
+                # 
+                # (There really isn't a better way to do this. The
+                # singleton's reference to the class it was created
+                # from is stored in an instance variable named
+                # '__attached__'. It doesn't have the '@' prefix, so
+                # it's internal only, and not accessible from user
+                # code.)
+                class_name = /#<Class:((#<(?<cls>.*?):)|((?<cls>.*?)>))/.match(method.owner.to_s)['cls']
+                [ class_name, '.' ]
+              else
+                [ method.owner.name, '#' ]
+              end
+              
               method_display_name = "#{defined_class}#{method_symbol}#{method.name}"
               # Don't try and trace the tracing method or there will be a stack overflow
               # in the defined hook method.
@@ -146,11 +155,11 @@ module AppMap
                 end
               end
             end
-          end
-
-          instance_methods.each(&hook_method.call(cls))
-          class_methods.each(&hook_method.call(cls.singleton_class))
         end
+
+        instance_methods.each(&hook_method.call(cls))
+        class_methods.each(&hook_method.call(cls.singleton_class))
+      end
       end
     end
   end

data/lib/appmap/rails/action_handler.rb

@@ -20,7 +20,7 @@ module AppMap
           attr_accessor :payload
 
           def initialize(path, lineno, payload)
-            super AppMap::Event.next_id_counter, :call, HTTPServerRequest, :call, path, lineno, false, Thread.current.object_id
+            super AppMap::Event.next_id_counter, :call, HTTPServerRequest, :call, path, lineno, Thread.current.object_id
 
             self.payload = payload
           end
@@ -60,7 +60,7 @@ module AppMap
           attr_accessor :payload
 
           def initialize(path, lineno, payload, parent_id, elapsed)
-            super AppMap::Event.next_id_counter, :return, HTTPServerResponse, :call, path, lineno, false, Thread.current.object_id
+            super AppMap::Event.next_id_counter, :return, HTTPServerResponse, :call, path, lineno, Thread.current.object_id
 
             self.payload = payload
             self.parent_id = parent_id

data/lib/appmap/rails/sql_handler.rb

@@ -9,7 +9,7 @@ module AppMap
         attr_accessor :payload
 
         def initialize(path, lineno, payload)
-          super AppMap::Event.next_id_counter, :call, SQLHandler, :call, path, lineno, false, Thread.current.object_id
+          super AppMap::Event.next_id_counter, :call, SQLHandler, :call, path, lineno, Thread.current.object_id
 
           self.payload = payload
         end
@@ -30,7 +30,7 @@ module AppMap
 
       class SQLReturn < AppMap::Event::MethodReturnIgnoreValue
         def initialize(path, lineno, parent_id, elapsed)
-          super AppMap::Event.next_id_counter, :return, SQLHandler, :call, path, lineno, false, Thread.current.object_id
+          super AppMap::Event.next_id_counter, :return, SQLHandler, :call, path, lineno, Thread.current.object_id
 
           self.parent_id = parent_id
           self.elapsed = elapsed

data/lib/appmap/trace.rb

@@ -2,7 +2,7 @@
 
 module AppMap
   module Trace
-    ScopedMethod = Struct.new(:defined_class, :method)
+    ScopedMethod = Struct.new(:defined_class, :method, :static)
 
     class Tracing
       def initialize
@@ -67,7 +67,7 @@ module AppMap
       return unless @enabled
 
       @events << event
-      @methods << Trace::ScopedMethod.new(defined_class, method) if defined_class && method
+      @methods << Trace::ScopedMethod.new(defined_class, method, event.static) if (defined_class && method && event.event == :call)
     end
 
     # Gets a unique list of the methods that were invoked by the program.

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.28.0'
+  VERSION = '0.28.1'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/package-lock.json

@@ -551,9 +551,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
     },
     "longest": {
       "version": "1.0.1",

data/spec/abstract_controller4_base_spec.rb

@@ -52,8 +52,8 @@ describe 'AbstractControllerBase' do
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  static: false
   thread_id: .*
+  static: false
   parameters:
   - name: params
     class: Hash

data/spec/abstract_controller_base_spec.rb

@@ -57,8 +57,8 @@ describe 'AbstractControllerBase' do
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  static: false
   thread_id: .*
+  static: false
   parameters:
   - name: params
     class: ActiveSupport::HashWithIndifferentAccess

data/spec/fixtures/hook/singleton_method.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class SingletonMethod
+  class << self
+    def say_default
+      'default'
+    end
+  end
+
+  def SingletonMethod.say_class_defined
+    'defined with explicit class scope'
+  end
+
+  def self.say_self_defined
+    'defined with self class scope'
+  end
+
+  # When called, do_include calls +include+ to bring in the module
+  # AddMethod. AddMethod defines a new instance method, which gets
+  # added to the singleton class of SingletonMethod.
+  def do_include
+    class << self
+      SingletonMethod.include(AddMethod)
+    end
+    self
+  end
+  
+  def self.new_with_instance_method
+    SingletonMethod.new.tap do |m|
+      def m.say_instance_defined
+        'defined for an instance'
+      end
+    end
+  end
+  
+  def to_s
+    'Singleton Method fixture'
+  end
+end
+
+module AddMethod
+  def self.included(base)
+    base.module_eval do
+      define_method "added_method" do
+        _added_method
+      end
+    end
+  end
+  
+  def _added_method
+    'defined by including a module'
+  end
+end
+

data/spec/hook_spec.rb

@@ -5,6 +5,16 @@ require 'appmap/hook'
 require 'appmap/event'
 require 'diffy'
 
+# Show nulls as the literal +null+, rather than just leaving the field
+# empty. This make some of the expected YAML below easier to
+# understand.
+module ShowYamlNulls
+  def visit_NilClass(o)
+    @emitter.scalar('null', nil, 'tag:yaml.org,2002:null', true, false, Psych::Nodes::Scalar::ANY)
+  end
+end
+Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
+
 describe 'AppMap class Hooking' do
   def collect_events(tracer)
     [].tap do |events|
@@ -30,26 +40,28 @@ describe 'AppMap class Hooking' do
     end.to_yaml
   end
 
-  def invoke_test_file(file, &block)
+  def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
     package = AppMap::Hook::Package.new(file, [])
     config = AppMap::Hook::Config.new('hook_spec', [ package ])
     AppMap.configuration = config
     AppMap::Hook.hook(config)
+    
+    setup_result = setup.call if setup
 
     tracer = AppMap.tracing.trace
     AppMap::Event.reset_id_counter
     begin
       load file
-      yield
+      yield setup_result
     ensure
       AppMap.tracing.delete(tracer)
     end
     [ config, tracer ]
   end
 
-  def test_hook_behavior(file, events_yaml, &block)
-    config, tracer = invoke_test_file(file, &block)
+  def test_hook_behavior(file, events_yaml, setup: nil, &block)
+    config, tracer = invoke_test_file(file, setup: setup, &block)
 
     events = collect_events(tracer)
     expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
@@ -208,7 +220,7 @@ describe 'AppMap class Hooking' do
       :parameters:
       - :name: :kw
         :class: NilClass
-        :value: 
+        :value: null
         :kind: :key
       :receiver:
         :class: InstanceMethod
@@ -238,7 +250,7 @@ describe 'AppMap class Hooking' do
       :parameters:
       - :name: :block
         :class: NilClass
-        :value: 
+        :value: null
         :kind: :block
       :receiver:
         :class: InstanceMethod
@@ -260,15 +272,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_default
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 5
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -276,8 +288,8 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: default
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_default).to eq('default')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_default).to eq('default')
     end
   end
 
@@ -286,15 +298,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_class_defined
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 10
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -302,8 +314,8 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: defined with explicit class scope
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_class_defined).to eq('defined with explicit class scope')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_class_defined).to eq('defined with explicit class scope')
     end
   end
 
@@ -312,15 +324,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_self_defined
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 14
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -328,11 +340,77 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: defined with self class scope
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_self_defined).to eq('defined with self class scope')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_self_defined).to eq('defined with self class scope')
     end
   end
 
+
+  it 'hooks an included method' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: SingletonMethod
+      :method_id: added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 44
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 2
+      :event: :call
+      :defined_class: AddMethod
+      :method_id: _added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 50
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 3
+      :event: :return
+      :parent_id: 2
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    - :id: 4
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    YAML
+
+    load 'spec/fixtures/hook/singleton_method.rb'
+    setup = -> { SingletonMethod.new.do_include }
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
+      expect(s.added_method).to eq('defined by including a module')
+    end
+  end
+
+  it "doesn't hook a singleton method defined for an instance" do
+    # Ideally, Ruby would fire a TracePoint event when a singleton
+    # class gets created by defining a method on an instance. It
+    # currently doesn't, though, so there's no way for us to hook such
+    # a method.
+    #
+    # This example will fail if Ruby's behavior changes at some point
+    # in the future.
+    events_yaml = <<~YAML
+    --- []
+    YAML
+    
+    load 'spec/fixtures/hook/singleton_method.rb'
+    setup = -> { SingletonMethod.new_with_instance_method }
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
+      expect(s.say_instance_defined).to eq('defined for an instance')
+    end
+  end
+  
   it 'Reports exceptions' do
     events_yaml = <<~YAML
     ---

data/test/cli_test.rb

@@ -59,7 +59,7 @@ class CLITest < Minitest::Test
 
     Method frequency:
     ----------------
-    2	Main.say_hello
+    1	Main.say_hello
     OUTPUT
   end
 
@@ -85,7 +85,7 @@ class CLITest < Minitest::Test
       "method_frequency": [
         {
           "name": "Main.say_hello",
-          "count": 2
+          "count": 1
         }
       ]
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.28.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -304,10 +304,10 @@ files:
 - spec/abstract_controller_base_spec.rb
 - spec/config_spec.rb
 - spec/fixtures/hook/attr_accessor.rb
-- spec/fixtures/hook/class_method.rb
 - spec/fixtures/hook/constructor.rb
 - spec/fixtures/hook/exception_method.rb
 - spec/fixtures/hook/instance_method.rb
+- spec/fixtures/hook/singleton_method.rb
 - spec/fixtures/rack_users_app/.dockerignore
 - spec/fixtures/rack_users_app/.gitignore
 - spec/fixtures/rack_users_app/Dockerfile
@@ -471,7 +471,6 @@ files:
 - test/fixtures/cucumber4_recorder/features/support/hooks.rb
 - test/fixtures/cucumber4_recorder/features/support/steps.rb
 - test/fixtures/cucumber4_recorder/lib/hello.rb
-- test/fixtures/cucumber_recorder/.bundle/config
 - test/fixtures/cucumber_recorder/Gemfile
 - test/fixtures/cucumber_recorder/appmap.yml
 - test/fixtures/cucumber_recorder/features/say_hello.feature

data/spec/fixtures/hook/class_method.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-class ClassMethod
-  class << self
-    def say_default
-      'default'
-    end
-  end
-
-  def ClassMethod.say_class_defined
-    'defined with explicit class scope'
-  end
-
-  def self.say_self_defined
-    'defined with self class scope'
-  end
-end