appmap 0.31.0 → 0.34.2

data/lib/appmap/rails/action_handler.rb

@@ -16,11 +16,11 @@ module AppMap
       class HTTPServerRequest
         include ContextKey
 
-        class Call < AppMap::Event::MethodEvent
+        class Call < AppMap::Event::MethodCall
           attr_accessor :payload
 
-          def initialize(path, lineno, payload)
-            super AppMap::Event.next_id_counter, :call, HTTPServerRequest, :call, path, lineno, Thread.current.object_id
+          def initialize(payload)
+            super AppMap::Event.next_id_counter, :call, Thread.current.object_id
 
             self.payload = payload
           end
@@ -47,7 +47,7 @@ module AppMap
         end
 
         def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
-          event = Call.new(__FILE__, __LINE__, payload)
+          event = Call.new(payload)
           Thread.current[context_key] = Context.new(event.id, Time.now)
           AppMap.tracing.record_event(event)
         end
@@ -59,8 +59,8 @@ module AppMap
         class Call < AppMap::Event::MethodReturnIgnoreValue
           attr_accessor :payload
 
-          def initialize(path, lineno, payload, parent_id, elapsed)
-            super AppMap::Event.next_id_counter, :return, HTTPServerResponse, :call, path, lineno, Thread.current.object_id
+          def initialize(payload, parent_id, elapsed)
+            super AppMap::Event.next_id_counter, :return, Thread.current.object_id
 
             self.payload = payload
             self.parent_id = parent_id
@@ -82,7 +82,7 @@ module AppMap
           context = Thread.current[context_key]
           Thread.current[context_key] = nil
 
-          event = Call.new(__FILE__, __LINE__, payload, context.id, Time.now - context.start_time)
+          event = Call.new(payload, context.id, Time.now - context.start_time)
           AppMap.tracing.record_event(event)
         end
       end

data/lib/appmap/rails/sql_handler.rb

@@ -5,11 +5,11 @@ require 'appmap/event'
 module AppMap
   module Rails
     class SQLHandler
-      class SQLCall < AppMap::Event::MethodEvent
+      class SQLCall < AppMap::Event::MethodCall
         attr_accessor :payload
 
-        def initialize(path, lineno, payload)
-          super AppMap::Event.next_id_counter, :call, SQLHandler, :call, path, lineno, Thread.current.object_id
+        def initialize(payload)
+          super AppMap::Event.next_id_counter, :call, Thread.current.object_id
 
           self.payload = payload
         end
@@ -20,7 +20,7 @@ module AppMap
               sql: payload[:sql],
               database_type: payload[:database_type]
             }.tap do |sql_query|
-              %i[server_version explain_sql].each do |attribute|
+              %i[server_version].each do |attribute|
                 sql_query[attribute] = payload[attribute] if payload[attribute]
               end
             end
@@ -29,8 +29,8 @@ module AppMap
       end
 
       class SQLReturn < AppMap::Event::MethodReturnIgnoreValue
-        def initialize(path, lineno, parent_id, elapsed)
-          super AppMap::Event.next_id_counter, :return, SQLHandler, :call, path, lineno, Thread.current.object_id
+        def initialize(parent_id, elapsed)
+          super AppMap::Event.next_id_counter, :return, Thread.current.object_id
 
           self.parent_id = parent_id
           self.elapsed = elapsed
@@ -76,6 +76,8 @@ module AppMap
             case database_type
             when :postgres
               ActiveRecord::Base.connection.postgresql_version
+            when :sqlite
+              ActiveRecord::Base.connection.database_version.to_s
             else
               warn "Unable to determine database version for #{database_type.inspect}"
             end
@@ -133,9 +135,9 @@ module AppMap
 
           SQLExaminer.examine payload, sql: sql
 
-          call = SQLCall.new(__FILE__, __LINE__, payload)
+          call = SQLCall.new(payload)
           AppMap.tracing.record_event(call)
-          AppMap.tracing.record_event(SQLReturn.new(__FILE__, __LINE__, call.id, finished - started))
+          AppMap.tracing.record_event(SQLReturn.new(call.id, finished - started))
         ensure
           Thread.current[reentry_key] = nil
         end

data/lib/appmap/rspec.rb

@@ -154,7 +154,7 @@ module AppMap
         end
 
         labels = labels.map(&:to_s).map(&:strip).reject(&:blank?).map(&:downcase).uniq
-        description.reject!(&:nil?).reject(&:blank?)
+        description.reject!(&:nil?).reject!(&:blank?)
         default_description = description.last
         description.reverse!
 

data/lib/appmap/trace.rb

@@ -14,34 +14,34 @@ module AppMap
 
     class Tracing
       def initialize
-        @Tracing = []
+        @tracing = []
       end
 
       def empty?
-        @Tracing.empty?
+        @tracing.empty?
       end
 
       def trace(enable: true)
         Tracer.new.tap do |tracer|
-          @Tracing << tracer
+          @tracing << tracer
           tracer.enable if enable
         end
       end
 
       def enabled?
-        @Tracing.any?(&:enabled?)
+        @tracing.any?(&:enabled?)
       end
 
       def record_event(event, defined_class: nil, method: nil)
-        @Tracing.each do |tracer|
+        @tracing.each do |tracer|
           tracer.record_event(event, defined_class: defined_class, method: method)
         end
       end
 
       def delete(tracer)
-        return unless @Tracing.member?(tracer)
+        return unless @tracing.member?(tracer)
 
-        @Tracing.delete(tracer)
+        @tracing.delete(tracer)
         tracer.disable
       end
     end

data/lib/appmap/util.rb

@@ -35,6 +35,25 @@ module AppMap
 
         [ fname, extension ].join
       end
+
+      # sanitize_event removes ephemeral values from an event, making
+      # events easier to compare across runs.
+      def sanitize_event(event, &block)
+        event.delete(:thread_id)
+        event.delete(:elapsed)
+        delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
+        delete_object_id.call(event[:receiver])
+        delete_object_id.call(event[:return_value])
+        (event[:parameters] || []).each(&delete_object_id)
+        (event[:exceptions] || []).each(&delete_object_id)
+
+        case event[:event]
+        when :call
+          event[:path] = event[:path].gsub(Gem.dir + '/', '')
+        end
+
+        event
+      end
     end
   end
 end

data/lib/appmap/version.rb

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

data/spec/abstract_controller4_base_spec.rb

@@ -48,11 +48,11 @@ describe 'AbstractControllerBase' do
 
       expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
+  thread_id: .*
   defined_class: Api::UsersController
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  thread_id: .*
   static: false
   parameters:
   - name: params

data/spec/abstract_controller_base_spec.rb

@@ -47,17 +47,17 @@ describe 'AbstractControllerBase' do
       SERVER_REQUEST
     end
 
-    it 'Properly captures method parameters in the appmap' do
+    it 'properly captures method parameters in the appmap' do
       expect(File).to exist(appmap_json)
       appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
       expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
+  thread_id: .*
   defined_class: Api::UsersController
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  thread_id: .*
   static: false
   parameters:
   - name: params
@@ -68,5 +68,12 @@ describe 'AbstractControllerBase' do
   receiver:
       CREATE_CALL
     end
+
+    it 'returns a minimal event' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json))
+      event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
+      expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+    end
   end
 end

data/spec/fixtures/hook/instance_method.rb

@@ -20,4 +20,8 @@ class InstanceMethod
   def say_block(&block)
     yield
   end
+
+  def say_the_time
+    Time.now.to_s
+  end
 end

data/spec/fixtures/hook/singleton_method.rb

@@ -15,6 +15,20 @@ class SingletonMethod
     'defined with self class scope'
   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
+  
   # 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.
@@ -32,23 +46,18 @@ class SingletonMethod
       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
+  STRUCT_TEST = Struct.new(:attr) do
+    class << self
+      def say_struct_singleton
+        'singleton for a struct'
       end
     end
   end
   
-  def _added_method
-    'defined by including a module'
+  def to_s
+    'Singleton Method fixture'
   end
 end
 
+

data/spec/hook_spec.rb

@@ -16,36 +16,18 @@ end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
 describe 'AppMap class Hooking', docker: false do
+  require 'appmap/util'
   def collect_events(tracer)
     [].tap do |events|
       while tracer.event?
         events << tracer.next_event.to_h
       end
-    end.map do |event|
-      event.delete(:thread_id)
-      event.delete(:elapsed)
-      delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
-      delete_object_id.call(event[:receiver])
-      delete_object_id.call(event[:return_value])
-      (event[:parameters] || []).each(&delete_object_id)
-      (event[:exceptions] || []).each(&delete_object_id)
-
-      case event[:event]
-      when :call
-        event[:path] = event[:path].gsub(Gem.dir + '/', '')
-      when :return
-        # These should be removed from the appmap spec
-        %i[defined_class method_id path lineno static].each do |obsolete_field|
-          event.delete(obsolete_field)
-        end
-      end
-      event
-    end.to_yaml
+    end.map(&AppMap::Util.method(:sanitize_event)).to_yaml
   end
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
-    package = AppMap::Package.new(file, [])
+    package = AppMap::Config::Package.new(file)
     config = AppMap::Config.new('hook_spec', [ package ])
     AppMap.configuration = config
     tracer = nil
@@ -69,7 +51,8 @@ describe 'AppMap class Hooking', docker: false do
     config, tracer = invoke_test_file(file, setup: setup, &block)
 
     events = collect_events(tracer)
-    expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
+
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
 
     [ config, tracer ]
   end
@@ -99,7 +82,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: String
         :value: default
     YAML
-    config, tracer = test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
       expect(InstanceMethod.new.say_default).to eq('default')
     end
   end
@@ -117,7 +100,7 @@ describe 'AppMap class Hooking', docker: false do
       InstanceMethod.new.say_default
     end
     class_map = AppMap.class_map(tracer.event_methods).to_yaml
-    expect(Diffy::Diff.new(class_map, <<~YAML).to_s).to eq('')
+    expect(Diffy::Diff.new(<<~YAML, class_map).to_s).to eq('')
     ---
     - :name: spec/fixtures/hook/instance_method.rb
       :type: package
@@ -359,7 +342,7 @@ describe 'AppMap class Hooking', docker: false do
       :defined_class: SingletonMethod
       :method_id: added_method
       :path: spec/fixtures/hook/singleton_method.rb
-      :lineno: 44
+      :lineno: 21
       :static: false
       :parameters: []
       :receiver:
@@ -367,10 +350,10 @@ describe 'AppMap class Hooking', docker: false do
         :value: Singleton Method fixture
     - :id: 2
       :event: :call
-      :defined_class: AddMethod
+      :defined_class: SingletonMethod::AddMethod
       :method_id: _added_method
       :path: spec/fixtures/hook/singleton_method.rb
-      :lineno: 50
+      :lineno: 27
       :static: false
       :parameters: []
       :receiver:
@@ -412,10 +395,44 @@ describe 'AppMap class Hooking', docker: false do
     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|
+      # Make sure we're testing the right thing
+      say_instance_defined = s.method(:say_instance_defined)
+      expect(say_instance_defined.owner.to_s).to start_with('#<Class:#<SingletonMethod:')
+
+      # Verify the native extension works as expected
+      expect(AppMap::Hook.singleton_method_owner_name(say_instance_defined)).to eq('SingletonMethod')
+      
       expect(s.say_instance_defined).to eq('defined for an instance')
     end
   end
 
+  it 'hooks a singleton method on an embedded struct' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: SingletonMethod::STRUCT_TEST
+      :method_id: say_struct_singleton
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 52
+      :static: true
+      :parameters: []
+      :receiver:
+        :class: Class
+        :value: SingletonMethod::STRUCT_TEST
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: singleton for a struct
+    YAML
+
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod::STRUCT_TEST.say_struct_singleton).to eq('singleton for a struct')
+    end
+  end
+  
   it 'Reports exceptions' do
     events_yaml = <<~YAML
     ---
@@ -456,20 +473,6 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
-  context 'OpenSSL::X509::Certificate.sign' do
-    # OpenSSL::X509 is not being hooked.
-    # This might be because the class is being loaded before AppMap, and so the TracePoint
-    # set by AppMap doesn't see it.
-    xit 'is hooked' do
-      events_yaml = <<~YAML
-      ---
-      YAML
-      test_hook_behavior 'spec/fixtures/hook/openssl_sign.rb', events_yaml do
-        expect(OpenSSLExample.example).to be_truthy
-      end
-    end
-  end
-
   context 'ActiveSupport::SecurityUtils.secure_compare' do
     it 'is hooked' do
       events_yaml = <<~YAML
@@ -513,12 +516,52 @@ describe 'AppMap class Hooking', docker: false do
           :class: Module
           :value: ActiveSupport::SecurityUtils
       - :id: 3
+        :event: :call
+        :defined_class: Digest::Instance
+        :method_id: digest
+        :path: Digest::Instance#digest
+        :static: false
+        :parameters:
+        - :name: arg
+          :class: String
+          :value: string
+          :kind: :rest
+        :receiver:
+          :class: Digest::SHA256
+          :value: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      - :id: 4
+        :event: :return
+        :parent_id: 3
+        :return_value:
+          :class: String
+          :value: "G2__)__qc____X____3_].\\x02y__.___/_"
+      - :id: 5
+        :event: :call
+        :defined_class: Digest::Instance
+        :method_id: digest
+        :path: Digest::Instance#digest
+        :static: false
+        :parameters:
+        - :name: arg
+          :class: String
+          :value: string
+          :kind: :rest
+        :receiver:
+          :class: Digest::SHA256
+          :value: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
+      - :id: 6
+        :event: :return
+        :parent_id: 5
+        :return_value:
+          :class: String
+          :value: "G2__)__qc____X____3_].\\x02y__.___/_"
+      - :id: 7
         :event: :return
         :parent_id: 2
         :return_value:
           :class: TrueClass
           :value: 'true'
-      - :id: 4
+      - :id: 8
         :event: :return
         :parent_id: 1
         :return_value:
@@ -559,8 +602,25 @@ describe 'AppMap class Hooking', docker: false do
               :static: true
               :labels:
               - security
+              - crypto
+      - :name: openssl
+        :type: package
+        :children:
+        - :name: Digest
+          :type: class
+          :children:
+          - :name: Instance
+            :type: class
+            :children:
+            - :name: digest
+              :type: function
+              :location: Digest::Instance#digest
+              :static: false
+              :labels:
+              - security
+              - crypto
       YAML
-      
+
       config, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
@@ -570,7 +630,43 @@ describe 'AppMap class Hooking', docker: false do
       expect(entry[:name]).to eq('secure_compare')
       spec = Gem::Specification.find_by_name('activesupport')
       entry[:location].gsub!(spec.base_dir + '/', '')
-      expect(Diffy::Diff.new(cm.to_yaml, classmap_yaml).to_s).to eq('')
+      expect(Diffy::Diff.new(classmap_yaml, cm.to_yaml).to_s).to eq('')
+    end
+  end
+
+  it "doesn't cause expectations on Time.now to fail" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_the_time
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 24
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: '2020-01-01 00:00:00 +0000'
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      require 'timecop'
+      begin
+        tz = ENV['TZ']
+        ENV['TZ'] = 'UTC'
+        Timecop.freeze(Time.utc('2020-01-01')) do
+          expect(Time).to receive(:now).exactly(3).times.and_call_original
+          expect(InstanceMethod.new.say_the_time).to be
+        end
+      ensure
+        ENV['TZ'] = tz
+      end
     end
   end
 end