appmap 0.71.0 → 0.72.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cac567f064d0d5059d29abbeb91341fcbfc7ede0ae449ef6731272bd4f36e313
-  data.tar.gz: df9ce73e1770a9d6f171df8f8796cecd9dde98409167900fa575d26ef93ea6f4
+  metadata.gz: c7d208fd0b861c7e7c3f75dfe12111441f450d8f65a75fb34cca032ff2272c43
+  data.tar.gz: 4ab7ee1e0b724a2dab5428836d6ff585bf9d06f90c5e6356d07f7b9d1c86cc4c
 SHA512:
-  metadata.gz: 84e300cd56db7c9853d393d27efd9184bd35aa4933d939d1693782f2ab81d22f25049a350ca929067f688f60a63175e963932769978bbc142d64427d17a3ccbb
-  data.tar.gz: bfd31a6d1998660bf04ef2346fa678518ad39ffd3f4b509627e0b739616e0c59a6d5e98ea4d2be9115f448b138d95af4760b2178592891a75b3d40cf6baa0136
+  metadata.gz: e3fa641617f40905dfd821f0d47ea2f2459caf768390b9891a01e9bd3ea94a78c0d304cc2580fbaffda1d42d3518351a5cce9673b01369ccbff3af366bc77f03
+  data.tar.gz: b417bdef218555f14bf82e3aba7606b33479eeddade41288d2e7694f5990cbe3a99f2de4f7d467d56798ccdaf798254a262bff79efe8ab615b900cae4e713baa

data/.travis.yml

@@ -36,7 +36,6 @@ jobs:
     env:
       # GEM_ALTERNATIVE_NAME only needed for deployment 
       - GEM_ALTERNATIVE_NAME=''
-    script: bundle exec rake
 
 before_deploy:
   - |
@@ -51,4 +50,4 @@ deploy:
     script: ./release.sh
     on:
       branch: master
-      condition: "$TRAVIS_RUBY_VERSION = 2.7"
+      condition: "$TRAVIS_RUBY_VERSION = 3.0"

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## [0.72.3](https://github.com/applandinc/appmap-ruby/compare/v0.72.2...v0.72.3) (2022-02-14)
+
+
+### Bug Fixes
+
+* No longer bundle @appland/appmap with this gem ([7bbad49](https://github.com/applandinc/appmap-ruby/commit/7bbad49c04df5a6d6e1fcfc4812f5e0d0cd84899))
+
+## [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)
 
 

data/Rakefile

@@ -13,21 +13,6 @@ Rake::ExtensionTask.new("appmap") do |ext|
   ext.lib_dir = "lib/appmap"
 end
 
-namespace 'gem' do
-  require 'bundler/gem_tasks'
-  
-  module Bundler
-    class GemHelper
-      # A handy tip - find the location of any Rake task using `rake -W`.
-      # rake -W build
-      # ~/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/bundler-2.1.4/lib/bundler/gem_helper.rb:39:in `install'
-      def build_gem
-        raise "Don't use 'rake gem:build' - use 'yarn install --prod && gem build <gemspec>', because that's what ./release.sh does"
-      end
-    end
-  end
-end
-
 RUBY_VERSIONS=%w[2.6 2.7 3.0].select do |version|
   travis_ruby_version = ENV['TRAVIS_RUBY_VERSION']
   next true unless travis_ruby_version
@@ -72,6 +57,11 @@ def build_app_image(app, ruby_version)
   end
 end
 
+desc 'Install non-Ruby dependencies'
+task :install do
+  system 'yarn install' or raise 'yarn install failed'
+end
+
 namespace :build do
   namespace :base do
     RUBY_VERSIONS.each do |ruby_version|
@@ -80,7 +70,6 @@ namespace :build do
         run_system = ->(cmd) { system(cmd) or raise "Command failed: #{cmd}" }
 
         run_system.call 'mkdir -p pkg'
-        run_system.call 'yarn install --prod'
         run_system.call "gem build appmap.gemspec --output pkg/appmap-#{GEM_VERSION}.gem"
         build_base_image(ruby_version)
       end.tap do |t|
@@ -139,7 +128,7 @@ end
 namespace :spec do
   RUBY_VERSIONS.each do |ruby_version|
     desc ruby_version
-    task ruby_version, [:specs] => ["compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
+    task ruby_version, [:specs] => ["install", "compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
       run_specs(ruby_version, task_args)
     end.tap do |t|
       desc "Run all specs"

data/appmap.gemspec

@@ -23,12 +23,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
-  strip_dir = ->(file) { file.index(Dir.pwd) == 0 ? file[Dir.pwd.length+1...file.length] : file }
-  Dir.glob(File.join(__dir__, 'node_modules/**/*')).map(&strip_dir).each do |filename|
-    next if File.directory?(filename) || filename.length > 100
-    spec.files << filename
-  end
-
   spec.extensions << "ext/appmap/extconf.rb"
   spec.require_paths = ['lib']
 

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/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/command/index.rb

@@ -16,7 +16,7 @@ module AppMap
 
         arguments.unshift 'index'
         arguments.unshift APPMAP_JS
-        arguments.unshift 'node'
+        arguments.unshift 'npx'
 
         exec(*arguments)
       end

data/lib/appmap/command/inspect.rb

@@ -16,7 +16,7 @@ module AppMap
 
         arguments.unshift 'inspect'
         arguments.unshift APPMAP_JS
-        arguments.unshift 'node'
+        arguments.unshift 'npx'
 
         exec(*arguments)
       end

data/lib/appmap/gem_hooks/activerecord.yml

@@ -1,2 +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/node_cli.rb

@@ -6,7 +6,7 @@ require 'appmap/command_error'
 module AppMap
   # Utilities for invoking the +@appland/appmap+ CLI.
   class NodeCLI
-    APPMAP_JS = Pathname.new(__dir__).join('../../node_modules/@appland/appmap/src/cli.js').expand_path.to_s
+    APPMAP_JS = '@appland/appmap'
 
     attr_reader :verbose
     # Directory to scan for AppMaps.
@@ -32,7 +32,7 @@ module AppMap
     def command(command, options = {})
       command.unshift << '--verbose' if verbose
       command.unshift APPMAP_JS
-      command.unshift 'node'
+      command.unshift 'npx'
 
       warn command.join(' ') if verbose
       stdout, stderr, status = Open3.capture3({ 'NODE_OPTIONS' => '--trace-warnings' }, *command.map(&:shellescape), options)

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.71.0'
+  VERSION = '0.72.3'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/package.json

@@ -17,6 +17,6 @@
   },
   "homepage": "https://github.com/applandinc/appmap-ruby#readme",
   "dependencies": {
-    "@appland/appmap": "^3.0.0"
+    "@appland/appmap": "^3.18.3"
   }
 }

data/release.sh

@@ -13,5 +13,4 @@ else
 fi
 
 set -ex
-yarn install --prod
 exec semantic-release $RELEASE_FLAGS

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