appmap 0.70.2 → 0.72.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d65574736497b9626d5d45bedee98bf5b4e810dada23199cb3b6857928c609a7
-  data.tar.gz: d90ebdbb5978d36a9fa78aab06df63578645d600dc26e8a3c3e78e5a9c3f198d
+  metadata.gz: 87322a2d5ba58dfc1fb69259af06c59077d3897f1e37e91e5a94dd2cbba1478b
+  data.tar.gz: ace21bbbd53fa487b27339e2af8fb16f4f8ec7b3ca7bbe218ba205b8ff7fc94b
 SHA512:
-  metadata.gz: e6645bda09b9fb033825c4230518322b537b013d96ec5c76de25736729a10d2338fd3361481901c804472c23f68552f5f6822d487dbd935ab8c45b67810b4a7a
-  data.tar.gz: a831e8748e982cf7ebb65f0a3bc0a9209a7e8b1991b85716d4fc43898685749304eeb5450b5e84a4657187b95f38b05c936a49b35ad18e30e8070110ddccf7ee
+  metadata.gz: 9eaebd3dbb1bf74880eeafc2379a78e73d747f4a41a507152c0d3840eefff1b4f8ae3c6cdecfb15bb08e44b5f3d19779b1c265746148ddb569715ace6c17a834
+  data.tar.gz: 4569886b26db0d49d06fd0bb649997fc29d9fea665c59495448e0b1669581757003f3034536392bf8e4e5cb16955ce12b4ca3e2ffd90cb8af8057a8edb4f093a

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## [0.72.2](https://github.com/applandinc/appmap-ruby/compare/v0.72.1...v0.72.2) (2022-02-11)
+
+
+### Bug Fixes
+
+* Ensure request headers includes all relevant fields ([e866f68](https://github.com/applandinc/appmap-ruby/commit/e866f686be974dfe29f706564217e4ee302bb55a))
+
+## [0.72.1](https://github.com/applandinc/appmap-ruby/compare/v0.72.0...v0.72.1) (2022-01-31)
+
+
+### Bug Fixes
+
+* Check that Procs respond to #ruby2_keywords ([12863dc](https://github.com/applandinc/appmap-ruby/commit/12863dc229f91fd813430db716856f111007f1c2)), closes [#ruby2](https://github.com/applandinc/appmap-ruby/issues/ruby2) [#ruby2](https://github.com/applandinc/appmap-ruby/issues/ruby2)
+* Don't stomp on $CFLAGS ([c0b44df](https://github.com/applandinc/appmap-ruby/commit/c0b44df2d85d97b7b379d6f030df54a77a88291b))
+* Update labels for deserialization ([4f51825](https://github.com/applandinc/appmap-ruby/commit/4f5182526d74fb3491c700bca16e203a010bb111))
+
+# [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)
+
+
+### Features
+
+* Add labels for http.session.clear, dao.materialize, log ([8e6784b](https://github.com/applandinc/appmap-ruby/commit/8e6784b82959eb5924d4675b43f6b98c7bd1b779))
+
 ## [0.70.2](https://github.com/applandinc/appmap-ruby/compare/v0.70.1...v0.70.2) (2022-01-12)
 
 

data/ext/appmap/extconf.rb

@@ -1,7 +1,7 @@
 require "mkmf"
 
 
-$CFLAGS='-Werror'
+$CFLAGS='-Werror ' + $CFLAGS
 
 # Per https://bugs.ruby-lang.org/issues/17865,
 # compound-token-split-by-macro was added in clang 12 and broke

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.safe
 - method: JSON::Ext::Generator::State#generate
-  label: format.json.generate
+  labels:
+    - format.json.generate
+    - serialize

data/lib/appmap/builtin_hooks/logger.yml

@@ -0,0 +1,3 @@
+- method: Logger::LogDevice#write
+  require_name: logger
+  label: log

data/lib/appmap/builtin_hooks/marshal.yml

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

data/lib/appmap/builtin_hooks/{yaml.yml → psych.yml}

@@ -1,10 +1,16 @@
 - methods:
-  - Psych#load
-  - Psych#load_stream
   - Psych#parse
   - Psych#parse_stream
   label: format.yaml.parse
+- methods:
+  - Psych#load
+  - Psych#load_stream
+  label: deserialize.unsafe
+- method: Psych#safe_load
+  label: deserialize.safe
 - methods:
   - Psych#dump
   - Psych#dump_stream
-  label: format.yaml.generate
+  labels:
+    - format.yaml.generate
+    - serialize

data/lib/appmap/gem_hooks/actionpack.yml

@@ -10,17 +10,22 @@
 - methods:
   - ActionDispatch::Request::Session#destroy
   - ActionDispatch::Request::Session#[]=
-  - ActionDispatch::Request::Session#clear
   - ActionDispatch::Request::Session#update
   - ActionDispatch::Request::Session#delete
   - ActionDispatch::Request::Session#merge
   - ActionDispatch::Cookies::CookieJar#[]=
-  - ActionDispatch::Cookies::CookieJar#clear
   - ActionDispatch::Cookies::CookieJar#update
   - ActionDispatch::Cookies::CookieJar#delete
   - ActionDispatch::Cookies::CookieJar#recycle!
   label: http.session.write
   require_name: action_dispatch
+- methods:
+  - ActionDispatch::Request::Session#clear
+  - ActionDispatch::Cookies::CookieJar#clear
+  labels:
+    - http.session.write
+    - http.session.clear
+  require_name: action_dispatch
 - methods:
   - ActionDispatch::Cookies::EncryptedCookieJar#[]=
   - ActionDispatch::Cookies::EncryptedCookieJar#clear

data/lib/appmap/gem_hooks/activerecord.yml

@@ -0,0 +1,4 @@
+- method: ActiveRecord::Relation#records
+  label: dao.materialize
+- method: ActiveRecord::FixtureSet::File#raw_rows
+#  label: deserialize.safe

data/lib/appmap/gem_hooks/rails.yml

@@ -0,0 +1,2 @@
+- method: Rails::Application#config_for
+#  label: deserialize.safe

data/lib/appmap/gem_hooks/railties.yml

@@ -0,0 +1,2 @@
+- method: Rails::Application::Configuration#database_configuration
+#  label: deserialize.safe

data/lib/appmap/gem_hooks/sprockets.yml

@@ -0,0 +1,2 @@
+- method: Sprockets::EncodingUtils#unmarshaled_deflated
+  label: deserialize.safe

data/lib/appmap/hook/method.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module AppMap
+  NEW_RUBY = Util.ruby_minor_version >= 2.7
+  if NEW_RUBY && !Proc.instance_methods.include?(:ruby2_keywords)
+    warn "Ruby is #{RUBY_VERSION}, but Procs don't respond to #ruby2_keywords"
+  end
+
   class Hook
     class Method
       attr_reader :hook_package, :hook_class, :hook_method
@@ -56,7 +61,7 @@ module AppMap
 
           call_instance_method = -> {
             # https://github.com/applandinc/appmap-ruby/issues/153
-            if Util.ruby_minor_version >= 2.7 && is_array_containing_empty_hash.(args) && hook_method.arity == 1
+            if NEW_RUBY && is_array_containing_empty_hash.(args) && hook_method.arity == 1
               instance_method.call({}, &block)
             else
               instance_method.call(*args, &block)
@@ -94,7 +99,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/util.rb

@@ -121,15 +121,21 @@ module AppMap
           blank?(headers) ? nil : headers
         end
 
-        # Rack prepends HTTP_ to all client-sent headers.
-
         if !env['rack.version']
           warn "Request headers does not contain rack.version. HTTP_ prefix is not expected."
           return finalize_headers.call(env.dup)
         end
 
+        # Rack prepends HTTP_ to all client-sent headers (except Content-Type and Content-Length?).
+        # Apparently, it's following the CGI spec in doing so.
+        # https://datatracker.ietf.org/doc/html/rfc3875#section-4.1.18
         matching_headers = env
-          .select { |k,v| k.start_with? 'HTTP_'}
+          .select { |k,v| k.start_with? 'HTTP_' }
+          .merge(
+            'CONTENT_TYPE' => env['CONTENT_TYPE'],
+            'CONTENT_LENGTH' => env['CONTENT_LENGTH'],
+            'AUTHORIZATION' => env['AUTHORIZATION']
+          )
           .reject { |k,v| blank?(v) }
           .each_with_object({}) do |kv, memo|
             key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')

data/lib/appmap/version.rb

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

data/spec/config_spec.rb

@@ -20,227 +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"
-            ]
-          }
-        ],
-        "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

data/spec/rails_recording_spec.rb

@@ -33,7 +33,8 @@ describe 'Rails' do
                 'http_server_request' => hash_including(
                   'request_method' => 'POST',
                   'normalized_path_info' => '/api/users',
-                  'path_info' => '/api/users'
+                  'path_info' => '/api/users',
+                  'headers' => hash_including('Content-Type' => 'application/x-www-form-urlencoded'),
                 ),
                 'message' => include(
                   hash_including(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.70.2
+  version: 0.72.2
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -3406,9 +3406,11 @@ files:
 - lib/appmap.rb
 - 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
+- lib/appmap/builtin_hooks/psych.yml
 - lib/appmap/class_map.rb
 - lib/appmap/command/agent_setup/init.rb
 - lib/appmap/command/agent_setup/status.rb
@@ -3431,10 +3433,14 @@ files:
 - lib/appmap/gem_hooks/actionview.yml
 - lib/appmap/gem_hooks/activejob-cancel.yml
 - lib/appmap/gem_hooks/activejob.yml
+- lib/appmap/gem_hooks/activerecord.yml
 - lib/appmap/gem_hooks/activesupport.yml
 - lib/appmap/gem_hooks/cancancan.yml
+- lib/appmap/gem_hooks/rails.yml
+- lib/appmap/gem_hooks/railties.yml
 - lib/appmap/gem_hooks/resque.yml
 - lib/appmap/gem_hooks/sidekiq.yml
+- lib/appmap/gem_hooks/sprockets.yml
 - lib/appmap/handler/function.rb
 - lib/appmap/handler/net_http.rb
 - lib/appmap/handler/rails/request_handler.rb
@@ -3507,6 +3513,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