appmap 0.71.0 → 0.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cac567f064d0d5059d29abbeb91341fcbfc7ede0ae449ef6731272bd4f36e313
-  data.tar.gz: df9ce73e1770a9d6f171df8f8796cecd9dde98409167900fa575d26ef93ea6f4
+  metadata.gz: 3dffdfecec5017edcd8c551226e5915348ef7db45a3ab82e1ccc1ace4879d712
+  data.tar.gz: 462c0d8e46b2a7c278e95e526ff8b1de7fa4d966e38c481cf69c5e3d1d97817e
 SHA512:
-  metadata.gz: 84e300cd56db7c9853d393d27efd9184bd35aa4933d939d1693782f2ab81d22f25049a350ca929067f688f60a63175e963932769978bbc142d64427d17a3ccbb
-  data.tar.gz: bfd31a6d1998660bf04ef2346fa678518ad39ffd3f4b509627e0b739616e0c59a6d5e98ea4d2be9115f448b138d95af4760b2178592891a75b3d40cf6baa0136
+  metadata.gz: fc3e0a0c0488be776f924a457e04afd1ea9048ee43fd9bbcd557f79fd45212e2036ac38e2df021dcfa3c4a7c47f5401ae8e983dae236bd6de13481df103f552f
+  data.tar.gz: e369f73989da51222f65a50697c2fdcae367db5a0742d5b9e9a77dab321bfe2b74e09d49eb1d56359cc6b6ac64817e73ef55f0dfdfae63ff2c7e5dbf9c6f9a87

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [0.72.0](https://github.com/applandinc/appmap-ruby/compare/v0.71.0...v0.72.0) (2022-01-24)
+
+
+### Bug Fixes
+
+* Fix a stack overflow when an override is prepended ([540907b](https://github.com/applandinc/appmap-ruby/commit/540907b1a9fa063d25ddbaf406674f2e16b11bfe))
+* Hook the first class or module in the ancestor chain ([8143f14](https://github.com/applandinc/appmap-ruby/commit/8143f145691a98e6e83563635db783ba8d393d9c))
+
+
+### Features
+
+* Label JSON, Marshal and YAML with (de)serialize ([318d294](https://github.com/applandinc/appmap-ruby/commit/318d294c1d921dacb18f1d3e1776282d9f208215))
+
 # [0.71.0](https://github.com/applandinc/appmap-ruby/compare/v0.70.2...v0.71.0) (2022-01-19)
 
 

data/lib/appmap/builtin_hooks/json.yml

@@ -1,4 +1,8 @@
 - method: JSON::Ext::Parser#parse
-  label: format.json.parse
+  labels:
+    - format.json.parse
+    - deserialize
 - method: JSON::Ext::Generator::State#generate
-  label: format.json.generate
+  label:
+    - format.json.generate
+    - serialize

data/lib/appmap/builtin_hooks/marshal.yml

@@ -0,0 +1,12 @@
+- methods:
+  - Marshal#load
+  - Marshal#restore
+  require_name: ruby
+  label:
+    - deserialize
+    - deserialize.unsafe
+- methods:
+  - Marshal#dump
+  require_name: ruby
+  label:
+    - deserialize

data/lib/appmap/builtin_hooks/yaml.yml

@@ -1,10 +1,23 @@
 - methods:
   - Psych#load
+  - Psych#unsafe_load
+  - Psych#load_file
+  - Psych#unsafe_load_file
   - Psych#load_stream
   - Psych#parse
   - Psych#parse_stream
-  label: format.yaml.parse
+  label:
+    - format.yaml.parse
+    - deserialize
+    - deserialize.unsafe
+- methods:
+  - Psych#safe_load
+  label:
+    - format.yaml.parse
+    - deserialize
 - methods:
   - Psych#dump
   - Psych#dump_stream
-  label: format.yaml.generate
+  label:
+    - format.yaml.generate
+    - serialize

data/lib/appmap/hook/method.rb

@@ -94,7 +94,7 @@ module AppMap
         end
         hook_method_def = hook_method_def.ruby2_keywords if hook_method_def.respond_to?(:ruby2_keywords)
 
-        hook_class.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
+        hook_class.ancestors.first.define_method_with_arity(hook_method.name, hook_method.arity, hook_method_def)
       end
 
       protected

data/lib/appmap/version.rb

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

data/spec/config_spec.rb

@@ -20,235 +20,100 @@ describe AppMap::Config, docker: false do
     }.deep_stringify_keys!
     config = AppMap::Config.load(config_data)
 
-    expect(JSON.parse(JSON.generate(config.as_json))).to eq(JSON.parse(<<~FIXTURE))
-    {
-      "name": "test",
-      "appmap_dir": "tmp/appmap",
-      "packages": [
+    expect(config.as_json.keys.sort).to eq(["appmap_dir", "builtin_hooks", "depends_config", "exclude", "functions", "gem_hooks", "hook_paths", "name", "packages", "swagger_config"])
+    expect(config.as_json['appmap_dir']).to eq('tmp/appmap')
+    expect(config.as_json['name']).to eq('test')
+    expect(config.as_json['packages']).to eq([])
+    expect(config.as_json['depends_config']).to eq({
+      "base_dir" => nil,
+      "base_branches" => [
+        "remotes/origin/main",
+        "remotes/origin/master"
       ],
-      "swagger_config": {
-        "project_name": null,
-        "project_version": "1.0",
-        "output_dir": "swagger",
-        "description": "Generate Swagger from AppMaps"
-      },
-      "depends_config": {
-        "base_dir": null,
-        "base_branches": [
-          "remotes/origin/main",
-          "remotes/origin/master"
-        ],
-        "test_file_patterns": [
-          "spec/**/*_spec.rb",
-          "test/**/*_test.rb"
-        ],
-        "dependent_tasks": [
-          "swagger"
-        ],
-        "description": "Bring AppMaps up to date with local file modifications, and updated derived data such as Swagger files",
-        "rspec_environment_method": "AppMap::Depends.test_env",
-        "minitest_environment_method": "AppMap::Depends.test_env",
-        "rspec_select_tests_method": "AppMap::Depends.select_rspec_tests",
-        "minitest_select_tests_method": "AppMap::Depends.select_minitest_tests",
-        "rspec_test_command_method": "AppMap::Depends.rspec_test_command",
-        "minitest_test_command_method": "AppMap::Depends.minitest_test_command"
-      },
-      "hook_paths": [
-        "pkg",
-        "#{Gem.loaded_specs['activesupport'].gem_dir}"
+      "test_file_patterns" => [
+        "spec/**/*_spec.rb",
+        "test/**/*_test.rb"
       ],
-      "exclude": [
+      "dependent_tasks" => [
+        "swagger"
       ],
-      "functions": [
-        {
-          "cls": "cls",
-          "target_methods": {
-            "package": "pkg",
-            "method_names": [
-              "fn"
-            ]
-          }
-        },
-        {
-          "cls": "cls",
-          "target_methods": {
-            "package": "pkg",
-            "method_names": [
-              "new_fn"
-            ]
-          }
+      "description" => "Bring AppMaps up to date with local file modifications, and updated derived data such as Swagger files",
+      "rspec_environment_method" => "AppMap::Depends.test_env",
+      "minitest_environment_method" => "AppMap::Depends.test_env",
+      "rspec_select_tests_method" => "AppMap::Depends.select_rspec_tests",
+      "minitest_select_tests_method" => "AppMap::Depends.select_minitest_tests",
+      "rspec_test_command_method" => "AppMap::Depends.rspec_test_command",
+      "minitest_test_command_method" => "AppMap::Depends.minitest_test_command"
+    })
+    expect(config.as_json['swagger_config']).to eq({
+      "project_name" => nil,
+      "project_version" => "1.0",
+      "output_dir" => "swagger",
+      "description" => "Generate Swagger from AppMaps"
+    })
+    expect(config.as_json['hook_paths']).to eq([
+      "pkg",
+      "#{Gem.loaded_specs['activesupport'].gem_dir}"
+    ])
+    expect(config.as_json['exclude']).to eq([])
+    expect(config.as_json['functions'].map(&:deep_stringify_keys)).to eq([
+      {
+        "cls" => "cls",
+        "target_methods" => {
+          "package" => "pkg",
+          "method_names" => [
+            :fn
+          ]
         }
-      ],
-      "builtin_hooks": {
-        "JSON::Ext::Parser": [
-          {
-            "package": "json",
-            "method_names": [
-              "parse"
-            ]
-          }
-        ],
-        "JSON::Ext::Generator::State": [
-          {
-            "package": "json",
-            "method_names": [
-              "generate"
-            ]
-          }
-        ],
-        "Logger::LogDevice": [
-          {
-            "package": "logger",
-            "method_names": [
-              "write"
-            ]
-          }
-        ], 
-        "Net::HTTP": [
-          {
-            "package": "net/http",
-            "method_names": [
-              "request"
-            ]
-          }
-        ],
-        "OpenSSL::PKey::PKey": [
-          {
-            "package": "openssl",
-            "method_names": [
-              "sign"
-            ]
-          }
-        ],
-        "OpenSSL::X509::Request": [
-          {
-            "package": "openssl",
-            "method_names": [
-              "sign"
-            ]
-          },
-          {
-            "package": "openssl",
-            "method_names": [
-              "verify"
-            ]
-          }
-        ],
-        "OpenSSL::X509::Certificate": [
-          {
-            "package": "openssl",
-            "method_names": [
-              "sign"
-            ]
-          }
-        ],
-        "OpenSSL::PKCS5": [
-          {
-            "package": "openssl",
-            "method_names": [
-              "pbkdf2_hmac"
-            ]
-          },
-          {
-            "package": "openssl",
-            "method_names": [
-              "pbkdf2_hmac_sha1"
-            ]
-          }
-        ],
-        "OpenSSL::Cipher": [
-          {
-            "package": "openssl",
-            "method_names": [
-              "encrypt"
-            ]
-          },
-          {
-            "package": "openssl",
-            "method_names": [
-              "decrypt"
-            ]
-          }
-        ],
-        "Psych": [
-          {
-            "package": "yaml",
-            "method_names": [
-              "load"
-            ]
-          },
-          {
-            "package": "yaml",
-            "method_names": [
-              "load_stream"
-            ]
-          },
-          {
-            "package": "yaml",
-            "method_names": [
-              "parse"
-            ]
-          },
-          {
-            "package": "yaml",
-            "method_names": [
-              "parse_stream"
-            ]
-          },
-          {
-            "package": "yaml",
-            "method_names": [
-              "dump"
-            ]
-          },
-          {
-            "package": "yaml",
-            "method_names": [
-              "dump_stream"
-            ]
-          }
+      },
+      {
+        "cls" => "cls",
+        "target_methods" => {
+          "package" => "pkg",
+          "method_names" => [
+            :new_fn
+          ]
+        }
+      }
+    ])
+    expect(config.as_json['builtin_hooks']).to have_key('JSON::Ext::Parser')
+    expect(config.as_json['builtin_hooks']['JSON::Ext::Parser'].map(&:deep_stringify_keys)).to eq([{
+        "package" => "json",
+        "method_names" => [
+          :parse
+        ]
+      }
+    ])
+    expect(config.as_json['gem_hooks']).to have_key('cls')
+    expect(config.as_json['gem_hooks']['cls'].map(&:deep_stringify_keys)).to eq([
+      {
+        "package" => "pkg",
+        "method_names" => [
+          :fn
+        ]
+      },
+      {
+        "package" => "pkg",
+        "method_names" => [
+          :new_fn
+        ]
+      }
+    ])
+    expect(config.as_json['gem_hooks']).to have_key('ActiveSupport::Callbacks::CallbackSequence')
+    expect(config.as_json['gem_hooks']['ActiveSupport::Callbacks::CallbackSequence'].map(&:deep_stringify_keys)).to eq([
+      {
+        "package" => "activesupport",
+        "method_names" => [
+          :invoke_before
         ]
       },
-      "gem_hooks": {
-        "cls": [
-          {
-            "package": "pkg",
-            "method_names": [
-              "fn"
-            ]
-          },
-          {
-            "package": "pkg",
-            "method_names": [
-              "new_fn"
-            ]
-          }
-        ],
-        "ActiveSupport::Callbacks::CallbackSequence": [
-          {
-            "package": "activesupport",
-            "method_names": [
-              "invoke_before"
-            ]
-          },
-          {
-            "package": "activesupport",
-            "method_names": [
-              "invoke_after"
-            ]
-          }
-        ],
-        "ActiveSupport::SecurityUtils": [
-          {
-            "package": "activesupport",
-            "method_names": [
-              "secure_compare"
-            ]
-          }
+      {
+        "package" => "activesupport",
+        "method_names" => [
+          :invoke_after
         ]
       }
-    }
-    FIXTURE
+    ])
   end
 
   describe AppMap::Config::Package do

data/spec/fixtures/hook/prepended_override.rb

@@ -0,0 +1,14 @@
+
+module PrependedModule
+  def say_hello
+    'please allow me to ' + super
+  end
+end
+
+class PrependedClass
+  prepend PrependedModule
+
+  def say_hello
+    'introduce myself'
+  end
+end

data/spec/hook_spec.rb

@@ -1110,4 +1110,30 @@ describe 'AppMap class Hooking', docker: false do
       end
     end
   end
+
+  describe 'prepended override' do
+    it 'does not cause stack overflow error' do
+      # For the purposes of this test, the code must be statically required, then hooked,
+      # then executed.
+
+      require_relative './fixtures/hook/prepended_override'
+      require 'appmap/hook/method'
+
+      pkg = AppMap::Config::Package.new('fixtures/hook/prependend_override')
+      AppMap::Hook::Method.new(pkg, PrependedClass, PrependedClass.public_instance_method(:say_hello)).activate
+
+      tracer = AppMap.tracing.trace
+      AppMap::Event.reset_id_counter
+      begin
+        expect(PrependedClass.new.say_hello).to eq('please allow me to introduce myself')
+      ensure
+        AppMap.tracing.delete(tracer)
+      end
+
+      events = collect_events(tracer)
+      expect(events.length).to eq(2)
+      expect(events.first[:method_id]).to eq('say_hello')
+      expect(events.second[:return_value][:value]).to eq('please allow me to introduce myself')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.71.0
+  version: 0.72.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -3407,6 +3407,7 @@ files:
 - lib/appmap/agent.rb
 - lib/appmap/builtin_hooks/json.yml
 - lib/appmap/builtin_hooks/logger.yml
+- lib/appmap/builtin_hooks/marshal.yml
 - lib/appmap/builtin_hooks/net/http.yml
 - lib/appmap/builtin_hooks/openssl.yml
 - lib/appmap/builtin_hooks/yaml.yml
@@ -3509,6 +3510,7 @@ files:
 - spec/fixtures/hook/labels.rb
 - spec/fixtures/hook/method_named_call.rb
 - spec/fixtures/hook/pkg_a/a.rb
+- spec/fixtures/hook/prepended_override.rb
 - spec/fixtures/hook/protected_method.rb
 - spec/fixtures/hook/revoke_api_key.appmap.json
 - spec/fixtures/hook/singleton_method.rb