appmap 0.34.0 → 0.35.0

data/spec/hook_spec.rb

@@ -22,7 +22,7 @@ describe 'AppMap class Hooking', docker: false do
       while tracer.event?
         events << tracer.next_event.to_h
       end
-    end.map(&AppMap::Util.method(:sanitize_event)).to_yaml
+    end.map(&AppMap::Util.method(:sanitize_event))
   end
 
   def invoke_test_file(file, setup: nil, &block)
@@ -50,7 +50,7 @@ describe 'AppMap class Hooking', docker: false do
   def test_hook_behavior(file, events_yaml, setup: nil, &block)
     config, tracer = invoke_test_file(file, setup: setup, &block)
 
-    events = collect_events(tracer)
+    events = collect_events(tracer).to_yaml
 
     expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
 
@@ -342,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:
@@ -350,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:
@@ -395,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
     ---
@@ -466,7 +500,7 @@ describe 'AppMap class Hooking', docker: false do
         :event: :call
         :defined_class: ActiveSupport::SecurityUtils
         :method_id: secure_compare
-        :path: gems/activesupport-6.0.3.2/lib/active_support/security_utils.rb
+        :path: lib/active_support/security_utils.rb
         :lineno: 26
         :static: true
         :parameters:
@@ -564,7 +598,7 @@ describe 'AppMap class Hooking', docker: false do
             :children:
             - :name: secure_compare
               :type: function
-              :location: gems/activesupport-6.0.3.2/lib/active_support/security_utils.rb:26
+              :location: lib/active_support/security_utils.rb:26
               :static: true
               :labels:
               - security
@@ -590,7 +624,7 @@ describe 'AppMap class Hooking', docker: false do
       config, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
-      cm = AppMap::ClassMap.build_from_methods(config, tracer.event_methods)
+      cm = AppMap::Util.sanitize_paths(AppMap::ClassMap.build_from_methods(tracer.event_methods))
       entry = cm[1][:children][0][:children][0][:children][0]
       # Sanity check, make sure we got the right one
       expect(entry[:name]).to eq('secure_compare')
@@ -599,4 +633,47 @@ describe 'AppMap class Hooking', docker: false do
       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
+
+  it "preserves the arity of hooked methods" do
+    invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
+      expect(InstanceMethod.instance_method(:say_echo).arity).to be(1)
+      expect(InstanceMethod.new.method(:say_echo).arity).to be(1)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.35.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -248,16 +262,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - kgilpin@gmail.com
 executables:
 - appmap
-extensions: []
+extensions:
+- ext/appmap/extconf.rb
 extra_rdoc_files: []
 files:
 - ".dockerignore"
 - ".gitignore"
+- ".rbenv-gemsets"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
@@ -277,6 +321,8 @@ files:
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
 - exe/appmap
+- ext/appmap/appmap.c
+- ext/appmap/extconf.rb
 - lib/appmap.rb
 - lib/appmap/algorithm/prune_class_map.rb
 - lib/appmap/algorithm/stats.rb
@@ -292,7 +338,7 @@ files:
 - lib/appmap/middleware/remote_recording.rb
 - lib/appmap/minitest.rb
 - lib/appmap/open.rb
-- lib/appmap/rails/action_handler.rb
+- lib/appmap/rails/request_handler.rb
 - lib/appmap/rails/sql_handler.rb
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb

data/lib/appmap/rails/action_handler.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'appmap/event'
-
-module AppMap
-  module Rails
-    module ActionHandler
-      Context = Struct.new(:id, :start_time)
-
-      module ContextKey
-        def context_key
-          "#{HTTPServerRequest.name}#call"
-        end
-      end
-
-      class HTTPServerRequest
-        include ContextKey
-
-        class Call < AppMap::Event::MethodCall
-          attr_accessor :payload
-
-          def initialize(payload)
-            super AppMap::Event.next_id_counter, :call, Thread.current.object_id
-
-            self.payload = payload
-          end
-
-          def to_h
-            super.tap do |h|
-              h[:http_server_request] = {
-                request_method: payload[:method],
-                path_info: payload[:path]
-              }
-
-              params = payload[:params]
-              h[:message] = params.keys.map do |key|
-                val = params[key]
-                {
-                  name: key,
-                  class: val.class.name,
-                  value: self.class.display_string(val),
-                  object_id: val.__id__
-                }
-              end
-            end
-          end
-        end
-
-        def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
-          event = Call.new(payload)
-          Thread.current[context_key] = Context.new(event.id, Time.now)
-          AppMap.tracing.record_event(event)
-        end
-      end
-
-      class HTTPServerResponse
-        include ContextKey
-
-        class Call < AppMap::Event::MethodReturnIgnoreValue
-          attr_accessor :payload
-
-          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
-            self.elapsed = elapsed
-          end
-
-          def to_h
-            super.tap do |h|
-              h[:http_server_response] = {
-                status: payload[:status]
-              }
-            end
-          end
-        end
-
-        def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
-          return unless Thread.current[context_key]
-
-          context = Thread.current[context_key]
-          Thread.current[context_key] = nil
-
-          event = Call.new(payload, context.id, Time.now - context.start_time)
-          AppMap.tracing.record_event(event)
-        end
-      end
-    end
-  end
-end