appmap 0.72.3 → 0.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d208fd0b861c7e7c3f75dfe12111441f450d8f65a75fb34cca032ff2272c43
-  data.tar.gz: 4ab7ee1e0b724a2dab5428836d6ff585bf9d06f90c5e6356d07f7b9d1c86cc4c
+  metadata.gz: df9ed913bb9ce4b945312ab2a50d8305b7c85c8f84a2004b9cf785362fcf2ad2
+  data.tar.gz: 2f2a844c20263b62a1291b05396d883c205cdebf2ae32062206e7bf42c23e757
 SHA512:
-  metadata.gz: e3fa641617f40905dfd821f0d47ea2f2459caf768390b9891a01e9bd3ea94a78c0d304cc2580fbaffda1d42d3518351a5cce9673b01369ccbff3af366bc77f03
-  data.tar.gz: b417bdef218555f14bf82e3aba7606b33479eeddade41288d2e7694f5990cbe3a99f2de4f7d467d56798ccdaf798254a262bff79efe8ab615b900cae4e713baa
+  metadata.gz: 330bcbec5db0a2b92662898432b3cc4eb4e8ca98729f6cfc0577d6490a0f19a1908e19b6c58c512c9b5db7e98a9f90804c5f0fe4362f52b31a69849760cde6db
+  data.tar.gz: 29544bb8ae0db136aad8a518511eb6723fe113e54bc4d585d9e06a857f9227f3e0fbf6daa2bcf1067df5092eef88b13034862d09b187e496cb6758eb8ec094eb

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [0.73.0](https://github.com/applandinc/appmap-ruby/compare/v0.72.5...v0.73.0) (2022-03-07)
+
+
+### Bug Fixes
+
+* Remove GC before test case execution, because it's slow ([d38695e](https://github.com/applandinc/appmap-ruby/commit/d38695ed9425a5363e48f2b7bdd5dc3853a827bf))
+
+
+### Features
+
+* Use bind_call when its available ([60d4fb5](https://github.com/applandinc/appmap-ruby/commit/60d4fb5919974d977722ee730b141ae398cbe927))
+
+## [0.72.5](https://github.com/applandinc/appmap-ruby/compare/v0.72.4...v0.72.5) (2022-02-17)
+
+
+### Bug Fixes
+
+* Override method accessors to provide the correct signature ([#223](https://github.com/applandinc/appmap-ruby/issues/223)) ([936bba4](https://github.com/applandinc/appmap-ruby/commit/936bba470c5360ee313e0b3e45a65d83acd0b53d))
+
+## [0.72.4](https://github.com/applandinc/appmap-ruby/compare/v0.72.3...v0.72.4) (2022-02-17)
+
+
+### Bug Fixes
+
+* Retain the proper signature on hooked methods ([31e2de2](https://github.com/applandinc/appmap-ruby/commit/31e2de219a37311df9ba0e5caa407dc80745ca09))
+
 ## [0.72.3](https://github.com/applandinc/appmap-ruby/compare/v0.72.2...v0.72.3) (2022-02-14)
 
 

data/LICENSE.txt

@@ -1,6 +1,18 @@
-The MIT License (MIT)
+The Software is provided to you by the Licensor under the License, as defined below, subject to the following condition.
 
-Copyright (c) 2018 Kevin Gilpin
+Without limiting other conditions in the License, the grant of rights under the License will not include,
+and the License does not grant to you, the right to Sell the Software.
+
+For purposes of the foregoing, “Sell” means practicing any or all of the rights granted to you under the License to provide to third parties,
+for a fee or other consideration (including without limitation fees for hosting or consulting/ support services related to the Software),
+a product or service whose value derives, entirely or substantially, from the functionality of the Software.
+Any license notice or attribution required by the License must also include this Commons Clause License Condition notice.
+
+Software: AppMap agent for Ruby
+
+License: MIT License
+
+Copyright 2022, AppLand Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/appmap/hook/method.rb

@@ -7,6 +7,23 @@ module AppMap
   end
 
   class Hook
+    SIGNATURES = {}
+
+    LOOKUP_SIGNATURE = lambda do |id|
+      method = super(id)
+    
+      signature = SIGNATURES[[ method.owner, method.name ]]
+      if signature
+        method.singleton_class.module_eval do
+          define_method(:parameters) do
+            signature
+          end
+        end
+      end
+    
+      method
+    end
+    
     class Method
       attr_reader :hook_package, :hook_class, :hook_method
 
@@ -53,8 +70,6 @@ module AppMap
         with_disabled_hook = self.method(:with_disabled_hook)
 
         hook_method_def = Proc.new do |*args, &block|
-          instance_method = hook_method.bind(self).to_proc
-
           is_array_containing_empty_hash = ->(obj) {
             obj.is_a?(Array) && obj.length == 1 && obj[0].is_a?(Hash) && obj[0].size == 0
           }
@@ -62,9 +77,17 @@ module AppMap
           call_instance_method = -> {
             # https://github.com/applandinc/appmap-ruby/issues/153
             if NEW_RUBY && is_array_containing_empty_hash.(args) && hook_method.arity == 1
-              instance_method.call({}, &block)
+              if NEW_RUBY
+                hook_method.bind_call(self, {}, &block)
+              else
+                hook_method.bind(self).call({}, &block)
+              end
             else
-              instance_method.call(*args, &block)
+              if NEW_RUBY
+                hook_method.bind_call(self, *args, &block)
+              else
+                hook_method.bind(self).call(*args, &block)
+              end
             end
           }
 
@@ -99,7 +122,12 @@ module AppMap
         end
         hook_method_def = hook_method_def.ruby2_keywords if hook_method_def.respond_to?(:ruby2_keywords)
 
-        hook_class.ancestors.first.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
+        hook_method_parameters = hook_method.parameters.dup.freeze
+        SIGNATURES[[ hook_class, hook_method.name ]] = hook_method_parameters
+
+        hook_class.ancestors.first.tap do |cls|
+          cls.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
+        end
       end
 
       protected
@@ -129,4 +157,27 @@ module AppMap
       end
     end
   end
+
+  module ObjectMethods
+    define_method(:method, AppMap::Hook::LOOKUP_SIGNATURE)
+    define_method(:public_method, AppMap::Hook::LOOKUP_SIGNATURE)
+    define_method(:singleton_method, AppMap::Hook::LOOKUP_SIGNATURE)
+  end
+
+  module ModuleMethods
+    define_method(:instance_method, AppMap::Hook::LOOKUP_SIGNATURE)
+    define_method(:public_instance_method, AppMap::Hook::LOOKUP_SIGNATURE)
+  end
+end
+
+unless ENV['APPMAP_NO_PATCH_OBJECT'] == 'true'
+  class Object
+    prepend AppMap::ObjectMethods
+  end
+end
+
+unless ENV['APPMAP_NO_PATCH_MODULE'] == 'true'
+  class Module
+    prepend AppMap::ModuleMethods
+  end
 end

data/lib/appmap/minitest.rb

@@ -142,7 +142,6 @@ if AppMap::Minitest.enabled?
     alias run_without_hook run
 
     def run
-      GC.start
       AppMap::Minitest.begin_test self, name
       begin
         run_without_hook

data/lib/appmap/rspec.rb

@@ -87,7 +87,6 @@ module AppMap
         end
 
         warn "Starting recording of example #{example}@#{source_location}" if AppMap::RSpec::LOG
-        GC.start
         @trace = AppMap.tracing.trace
         @webdriver_port = webdriver_port.()
       end

data/lib/appmap/version.rb

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

data/spec/fixtures/hook/report_parameters.rb

@@ -0,0 +1,8 @@
+
+class ReportParameters
+  def to_s; self.class.name; end
+
+  def report_parameters(*args, kw1:, kw2: 'kw2', **kws)
+    method(:report_parameters).parameters
+  end
+end

data/spec/fixtures/rails5_users_app/spec/rails_helper.rb

@@ -47,7 +47,6 @@ RSpec.configure do |config|
   
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
   end
 
   config.around :each do |example|

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -47,7 +47,6 @@ RSpec.configure do |config|
   
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
   end
 
   config.around :each do |example|

data/spec/hook_spec.rb

@@ -225,6 +225,12 @@ describe 'AppMap class Hooking', docker: false do
         :value: default
     YAML
     test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.instance_method(:say_default).parameters).to eq([])
+      expect(InstanceMethod.public_instance_method(:say_default).parameters).to eq([])
+      expect(InstanceMethod.new.method(:say_default).parameters).to eq([])
+      expect(InstanceMethod.new.public_method(:say_default).parameters).to eq([])
+      expect { InstanceMethod.new.singleton_method(:say_default) }.to raise_error(NameError)
+
       expect(InstanceMethod.new.say_default).to eq('default')
     end
   end
@@ -315,7 +321,22 @@ describe 'AppMap class Hooking', docker: false do
         :class: String
         :value: protected
     YAML
+    parameters = []
     test_hook_behavior 'spec/fixtures/hook/protected_method.rb', events_yaml do
+      expect(ProtectedMethod.singleton_method(:call_protected).parameters).to eq(parameters)
+      expect(ProtectedMethod.instance_method(:call_protected).parameters).to eq(parameters)
+      expect(ProtectedMethod.public_instance_method(:call_protected).parameters).to eq(parameters)
+      expect(ProtectedMethod.new.method(:call_protected).parameters).to eq(parameters)
+      expect(ProtectedMethod.new.public_method(:call_protected).parameters).to eq(parameters)
+      expect { ProtectedMethod.new.singleton_method(:call_protected) }.to raise_error(NameError)
+
+      expect(ProtectedMethod.singleton_method(:protected_method).parameters).to eq(parameters)
+      expect(ProtectedMethod.instance_method(:protected_method).parameters).to eq(parameters)
+      expect(ProtectedMethod.public_instance_method(:protected_method).parameters).to eq(parameters)
+      expect(ProtectedMethod.new.method(:protected_method).parameters).to eq(parameters)
+      expect(ProtectedMethod.new.public_method(:protected_method).parameters).to eq(parameters)
+      expect { ProtectedMethod.new.singleton_method(:protected_method) }.to raise_error(NameError)
+
       expect(ProtectedMethod.new.call_protected).to eq('protected')
     end
   end
@@ -358,6 +379,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: String
         :value: self.protected
     YAML
+    parameters = []
     test_hook_behavior 'spec/fixtures/hook/protected_method.rb', events_yaml do
       expect(ProtectedMethod.call_protected).to eq('self.protected')
     end
@@ -1100,6 +1122,51 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  it 'preserves the sighnature of hooked methods' do
+    parameters = []
+    events = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: ReportParameters
+      :method_id: report_parameters
+      :path: spec/fixtures/hook/report_parameters.rb
+      :lineno: 5
+      :static: false
+      :parameters:
+      - :name: :args
+        :class: Array
+        :value: '["foo"]'
+        :kind: :rest
+      - :name: :kw1
+        :class: String
+        :value: kw1
+        :kind: :keyreq
+      - :name: :kw2
+        :class: NilClass
+        :value: null
+        :kind: :key
+      - :name: :kws
+        :class: Hash
+        :value: "{}"
+        :kind: :keyrest
+      :receiver:
+        :class: ReportParameters
+        :value: ReportParameters
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: Array
+        :value: "[[:rest, :args], [:keyreq, :kw1], [:key, :kw2], [:keyrest, :kws]]"
+    YAML
+    parameters = [[:rest, :args], [:keyreq, :kw1], [:key, :kw2], [:keyrest, :kws]]
+    test_hook_behavior 'spec/fixtures/hook/report_parameters.rb', events do
+      expect(ReportParameters.instance_method(:report_parameters).parameters).to eq(parameters)
+      expect(ReportParameters.new.report_parameters('foo', kw1: 'kw1')).to eq(parameters)
+    end
+  end
+
   describe 'kwargs handling' do
     if ruby_2?
       # https://github.com/applandinc/appmap-ruby/issues/153

data/yarn.lock

@@ -320,12 +320,7 @@ ansi-escapes@^4.2.1:
   dependencies:
     type-fest "^0.21.3"
 
-ansi-regex@^5.0.0:
-  version "5.0.0"
-  resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.0.tgz#388539f55179bf39339c81af30a654d69f87cb75"
-  integrity sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==
-
-ansi-regex@^5.0.1:
+ansi-regex@^5.0.0, ansi-regex@^5.0.1:
   version "5.0.1"
   resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304"
   integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.72.3
+  version: 0.73.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -447,6 +447,7 @@ files:
 - spec/fixtures/hook/pkg_a/a.rb
 - spec/fixtures/hook/prepended_override.rb
 - spec/fixtures/hook/protected_method.rb
+- spec/fixtures/hook/report_parameters.rb
 - spec/fixtures/hook/revoke_api_key.appmap.json
 - spec/fixtures/hook/singleton_method.rb
 - spec/fixtures/hook/spec/api_spec.rb