appmap 0.83.5 → 0.85.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 324aa913dbeb7c955fb624faf0ac6294694c9ea11e066c741d7e69313b194d91
-  data.tar.gz: bbbc92d307315e5bb520dd769b2f90ab81d542e0243fc5d000172d2df2451dbb
+  metadata.gz: 002b026a3ee8b2e89a073906212e694f296dcc0666db8450c9051bab372550b2
+  data.tar.gz: 743adc87f3f3ae044c7da5d3040be48f79db21bf5d9861b60ec32f84ba39bc19
 SHA512:
-  metadata.gz: 80ab785186c5d48d1b34422728f73883c7a152022e67276c64076df636449ecd5711411e32ba8150a0b3a58bad0897111dc63b7036cbb329a1f4030a83d1e102
-  data.tar.gz: 54d432b3a78da40759e8b3bd43ae68fc718db7b2796c569898dc9181aabdde40546d582ebd756c76efab325ed275815ff06d15f2b2d745bffc6108f5586057a3
+  metadata.gz: 6af49c4b8155df95b38edf948217eedfa785151c7d3b6997cee8f0ba5971444c755a1e189a12fffdd640e1ec7e12316bd3a5e70d82e047d1dba4c2873040e5a1
+  data.tar.gz: e5af21dd5198c5291cdcd8da036b54c31c59178c17ccda863e4653aab7efb9a5392325226f90ef973f99107d8a44d24870dab3417d6b50c001ae4d325f50f30a

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [0.85.0](https://github.com/applandinc/appmap-ruby/compare/v0.84.0...v0.85.0) (2022-08-08)
+
+
+### Features
+
+* Tune method parameters ([4a7b575](https://github.com/applandinc/appmap-ruby/commit/4a7b575e6f9684adaac4b592adc1ad2c832e900d))
+
+# [0.84.0](https://github.com/applandinc/appmap-ruby/compare/v0.83.6...v0.84.0) (2022-08-04)
+
+
+### Bug Fixes
+
+* Address stack overflow error with tracing? ([f426210](https://github.com/applandinc/appmap-ruby/commit/f426210b8dfb48987f2b6c1b5e57e80e3a2c921d))
+* Handle nil class names ([263f2fc](https://github.com/applandinc/appmap-ruby/commit/263f2fc97b716f1a8205a3e85292c59ee19bc6bc))
+
+
+### Features
+
+* Label ActiveSupport::MessageEncryptor ([38a7aeb](https://github.com/applandinc/appmap-ruby/commit/38a7aeb446a2baa63f6724eea8dcf36276d336c9))
+* Label crypto function with algorithm name ([a7a9c61](https://github.com/applandinc/appmap-ruby/commit/a7a9c6145790fc5bc425e413d56984ef777f9fd1))
+* Label EncryptedKeyRotatingCookieJar.commit ([8e1d015](https://github.com/applandinc/appmap-ruby/commit/8e1d0158d25f2cc386c32ba899085fd21fadafcb))
+* Label OpenSSL::Random ([5c947a9](https://github.com/applandinc/appmap-ruby/commit/5c947a90037300639a94ab89d9e1a4dca26265bc))
+* Label Random ([7572803](https://github.com/applandinc/appmap-ruby/commit/7572803991693ad80f8526c44056133cca13d4b8))
+* Label the rest of OpenSSL::Cipher ([7863b7b](https://github.com/applandinc/appmap-ruby/commit/7863b7b3fcf2ecccda16b80e637e216c06a95108))
+* Make activesupport a runtime dependency ([140a674](https://github.com/applandinc/appmap-ruby/commit/140a6744be2abf47d01e880a98f1dd06c8a505b1))
+
+## [0.83.6](https://github.com/applandinc/appmap-ruby/compare/v0.83.5...v0.83.6) (2022-08-01)
+
+
+### Bug Fixes
+
+* Catch an uncaught EINVAL on Windows when attempting to parse source code ([9a152d8](https://github.com/applandinc/appmap-ruby/commit/9a152d8e48846b46572a3e7061bcdb35942b8993))
+
 ## [0.83.5](https://github.com/applandinc/appmap-ruby/compare/v0.83.4...v0.83.5) (2022-06-30)
 
 

data/appmap.gemspec

@@ -27,11 +27,12 @@ Gem::Specification.new do |spec|
   spec.extensions << "ext/appmap/extconf.rb"
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport'
   spec.add_dependency 'method_source'
   spec.add_dependency 'rack'
   spec.add_dependency 'reverse_markdown'
 
+  spec.add_runtime_dependency 'activesupport'
+
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'minitest', '~> 5.15'
   spec.add_development_dependency 'pry-byebug'

data/lib/appmap/agent.rb

@@ -57,6 +57,12 @@ module AppMap
       end
     end
 
+    def tracing_enabled?
+      return false unless @tracing
+
+      @tracing.enabled?
+    end
+
     # Used to start tracing, stop tracing, and record events.
     def tracing
       @tracing ||= Trace::Tracing.new

data/lib/appmap/{gem_hooks → builtin_hooks}/activesupport.yml

@@ -11,6 +11,14 @@
   require_name: active_support/security_utils
   force: true
 - method: ActiveSupport.run_load_hooks
-  label: deserialize.safe
+  labels:
+  - deserialize.safe
+  - lang.eval.safe
   require_name: active_support/lazy_load_hooks
   force: true
+- method: ActiveSupport::MessageEncryptor#encrypt_and_sign
+  require_name: active_support/message_encryptor
+  force: true
+- method: ActiveSupport::MessageEncryptor#decrypt_and_verifdy
+  require_name: active_support/message_encryptor
+  force: true

data/lib/appmap/builtin_hooks/net/http.yml

@@ -1,3 +1,3 @@
 - method: Net::HTTP#request
   label: protocol.http
-  handler_class: AppMap::Handler::NetHTTP
+  handler_class: AppMap::Handler::NetHTTPHandler

data/lib/appmap/builtin_hooks/openssl.yml

@@ -12,5 +12,39 @@
   label: crypto.pkcs5
 - method: OpenSSL::Cipher#encrypt
   label: crypto.encrypt
+  handler_class: AppMap::Handler::OpenSSLHandler
 - method: OpenSSL::Cipher#decrypt
   label: crypto.decrypt
+  handler_class: AppMap::Handler::OpenSSLHandler
+- method: OpenSSL::Cipher#auth_data=
+  label: crypto.set_auth_data
+- method: OpenSSL::Cipher#auth_tag=
+  label: crypto.set_auth_tag
+- method: OpenSSL::Cipher#auth_tag_len=
+  label: crypto.set_auth_tag_len
+- method: OpenSSL::Cipher#ccm_data_len=
+  label: crypto.set_ccm_data_len
+- method: OpenSSL::Cipher#iv=
+  label: crypto.set_iv
+- method: OpenSSL::Cipher#iv_len=
+  label: crypto.set_iv_len
+- method: OpenSSL::Cipher#key=
+  label: crypto.set_key
+- method: OpenSSL::Cipher#key_len=
+  label: crypto.set_key_len
+- method: OpenSSL::Cipher#padding=
+  label: crypto.set_padding
+- method: OpenSSL::Cipher#final
+  label: crypto.final
+- methods:
+  - OpenSSL::Cipher#random_iv
+  - OpenSSL::Cipher#random_key
+  - OpenSSL::Cipher#reset
+  - OpenSSL::Cipher#update
+- methods:
+  - OpenSSL::Random.random_bytes
+  label: random.secure
+- methods:
+  - OpenSSL::Random#add
+  - OpenSSL::Random#seed
+  label: pseudorandom.seed

data/lib/appmap/builtin_hooks/ruby.yml

@@ -2,6 +2,7 @@
   - Marshal#load
   - Marshal#restore
   require_name: ruby
+  handler_class: AppMap::Handler::MarshalLoadHandler
   label: deserialize.unsafe
 - method: Marshal#dump
   require_name: ruby
@@ -18,7 +19,7 @@
   - Kernel#eval
   require_name: ruby
   label: lang.eval
-  handler_class: AppMap::Handler::Eval
+  handler_class: AppMap::Handler::EvalHandler
 - methods:
   - IO#popen
   - Kernel#exec
@@ -29,3 +30,6 @@
   - Process#spawn
   require_name: ruby
   label: system.exec
+- methods:
+  - ERB#result
+  require_name: ruby

data/lib/appmap/config.rb

@@ -32,8 +32,8 @@ module AppMap
       attr_writer :handler_class
 
       def handler_class
-        require 'appmap/handler/function'
-        @handler_class || AppMap::Handler::Function
+        require 'appmap/handler/function_handler'
+        @handler_class || AppMap::Handler::FunctionHandler
       end
 
       # Indicates that only the entry points to a package will be recorded.
@@ -72,7 +72,7 @@ module AppMap
         # Builds a package for gem. Generally corresponds to a `gem:` entry in appmap.yml. Also used when mapping
         # a builtin.
         def build_from_gem(gem, shallow: true, require_name: nil, exclude: [], labels: [], optional: false, force: false)
-          if !force && %w[method_source activesupport].member?(gem)
+          if !force && %w[method_source].member?(gem)
             warn "WARNING: #{gem} cannot be AppMapped because it is a dependency of the appmap gem"
             return
           end

data/lib/appmap/event.rb

@@ -84,10 +84,10 @@ module AppMap
         # Heuristic for dynamically defined class whose name can be nil
         def best_class_name(value)
           value_cls = value.class
-          while value_cls.name.nil?
+          while value_cls && value_cls.name.nil?
             value_cls = value_cls.superclass
           end
-          value_cls.name
+          value_cls&.name || 'unknown'
         end
 
         def encode_display_string(value)
@@ -193,7 +193,7 @@ module AppMap
 
         public
 
-        def build_from_invocation(defined_class, method, receiver, arguments, event: MethodCall.new)
+        def build_from_invocation(defined_class, method, receiver, arguments, parameters: method.parameters, event: MethodCall.new)
           event ||= MethodCall.new
           defined_class ||= 'Class'
 
@@ -208,10 +208,10 @@ module AppMap
 
             # Check if the method has key parameters. If there are any they'll always be last.
             # If yes, then extract it from arguments.
-            has_key = [[:dummy], *method.parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
+            has_key = [[:dummy], *parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
             kwargs = has_key && arguments[-1].dup || {}
 
-            event.parameters = method.parameters.map.with_index do |method_param, idx|
+            event.parameters = parameters.map.with_index do |method_param, idx|
               param_type, param_name = method_param
               param_name ||= 'arg'
               value = case param_type

data/lib/appmap/gem_hooks/actionpack.yml

@@ -53,3 +53,5 @@
   labels:
   - deserialize.safe
   - lang.eval.safe
+- methods: ActionDispatch::Cookies::EncryptedKeyRotatingCookieJar.commit
+  require_name: action_dispatch

data/lib/appmap/gem_hooks/random.yml

@@ -0,0 +1,12 @@
+- methods:
+  - Random.new_seed
+  - Random.rand
+  - Random.raw_seed
+  - Random.srand
+  - Random#bytes
+  - Random#rand
+  labels:
+    - pseudorandom
+    - random.insecure
+- method: Random#seed
+  label: pseudorandom.seed

data/lib/appmap/handler/{eval.rb → eval_handler.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'appmap/handler/function'
+require 'appmap/handler/function_handler'
 
 module AppMap
   module Handler
@@ -14,15 +14,30 @@ module AppMap
     #
     # If the binding is not provided, by default eval will run in the
     # current frame. Since we call it here, this will mean the #do_call
-    # frame, which would make AppMap::Handler::Eval the lexical scope
+    # frame, which would make AppMap::Handler::EvalHandler the lexical scope
     # for constant lookup and definition; as a consequence
     # eg. `eval "class Foo; end"` would define
-    # AppMap::Handler::Eval::Foo instead of defining it in
+    # AppMap::Handler::EvalHandler::Foo instead of defining it in
     # the module where the original call was made.
     #
     # To avoid this, we explicitly substitute the correct execution
     # context, up several stack frames.
-    class Eval < Function
+    class EvalHandler < FunctionHandler
+      # Kernel#eval reports the method parameters as :rest, instead of what you might expect from
+      # the documented signature: eval(string [, binding [, filename [,lineno]]])
+      # In the C code, it's defined as rb_f_eval(int argc, const VALUE *argv, VALUE self),
+      # so maybe that's why the parameters are reported as :rest.
+      #
+      # In any case, reporting the parameters as :rest means that the code string, binding, etc
+      # are reported in the AppMap as members of an Array, without individual object ids or types.
+      #
+      # To make eval easier to analyze, fake the hook_method parameters to better match
+      # the documentation.
+      PARAMETERS= [
+        [ :req, :string ],
+        [ :rest ],
+      ]
+
       # The depth of the frame we need to pluck out:
       # 1. Hook::Method#do_call
       # 2. Hook::Method#trace_call
@@ -31,6 +46,10 @@ module AppMap
       # 5. the (intended) frame of the original eval that we hooked
       # Note it needs to be adjusted if this call sequence changes.
       FRAME_DEPTH = 5
+  
+      def handle_call(receiver, args)
+        AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args, parameters: PARAMETERS)
+      end
 
       def do_call(receiver, src = nil, context = nil, *rest)
         context ||= AppMap.caller_binding FRAME_DEPTH

data/lib/appmap/handler/{function.rb → function_handler.rb}

@@ -6,7 +6,7 @@ require 'appmap/hook/method'
 module AppMap
   module Handler
     # Base handler class, will emit method call and return events.
-    class Function < Hook::Method
+    class FunctionHandler < Hook::Method
       def handle_call(receiver, args)
         AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args)
       end

data/lib/appmap/handler/marshal_load_handler.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'appmap/handler/function_handler'
+
+module AppMap
+  module Handler
+    class MarshalLoadHandler < FunctionHandler
+      PARAMETERS= [
+        [ :req, :source ],
+        [ :rest ],
+      ]
+
+      def handle_call(receiver, args)
+        AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args, parameters: PARAMETERS)
+      end
+    end
+  end
+end

data/lib/appmap/handler/{net_http.rb → net_http_handler.rb}

@@ -29,7 +29,7 @@ module AppMap
 
         self.request_method = request.method
         self.url = url
-        self.headers = NetHTTP.copy_headers(request)
+        self.headers = NetHTTPHandler.copy_headers(request)
         self.params = Rack::Utils.parse_nested_query(query)
       end
 
@@ -64,7 +64,7 @@ module AppMap
 
         if response
           self.status = response.code.to_i
-          self.headers = NetHTTP.copy_headers(response)
+          self.headers = NetHTTPHandler.copy_headers(response)
         else
           self.headers = {}
         end
@@ -84,7 +84,7 @@ module AppMap
 
     # Handler class for HTTP requests.
     # Emits HTTP request events instead of method calls.
-    class NetHTTP < Hook::Method
+    class NetHTTPHandler < Hook::Method
       def self.copy_headers(obj)
         {}.tap do |headers|
           obj.each_header do |key, value|

data/lib/appmap/handler/open_ssl_handler.rb

@@ -0,0 +1,16 @@
+require 'appmap/handler/function_handler'
+
+module AppMap
+  module Handler
+    class OpenSSLHandler < FunctionHandler
+      def handle_call(receiver, args)
+        super.tap do |event|
+          algorithm = receiver.name
+          event.receiver[:labels] ||= []
+          label = [ 'crypto.algorithm', algorithm ].join('.')
+          event.receiver[:labels] << label unless event.receiver[:labels].include?(label)
+        end
+      end
+    end
+  end
+end

data/lib/appmap/handler/rails/render_handler.rb

@@ -1,9 +1,9 @@
-require 'appmap/handler/function'
+require 'appmap/handler/function_handler'
 
 module AppMap
   module Handler
     module Rails
-      class RenderHandler < AppMap::Handler::Function
+      class RenderHandler < AppMap::Handler::FunctionHandler
         def handle_call(receiver, args)
           options, _ = args
           # TODO: :file, :xml

data/lib/appmap/handler/rails/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'appmap/handler/function'
+require 'appmap/handler/function_handler'
 require 'appmap/event'
 
 module AppMap
@@ -110,7 +110,7 @@ module AppMap
         # Hooks the ActionView::Resolver methods +find_all+, +find_all_anywhere+. The resolver is used
         # during template rendering to lookup the template file path from parameters such as the
         # template name, prefix, and partial (boolean).
-        class ResolverHandler < AppMap::Handler::Function
+        class ResolverHandler < AppMap::Handler::FunctionHandler
           def handle_call(receiver, args)
             name, prefix, partial = args
             warn "Resolver: #{{ name: name, prefix: prefix, partial: partial }}" if LOG

data/lib/appmap/hook/method.rb

@@ -83,7 +83,7 @@ module AppMap
       end
 
       def trace?
-        return false unless AppMap.tracing.enabled?
+        return false unless AppMap.tracing_enabled?
         return false if Thread.current[HOOK_DISABLE_KEY]
         return false if hook_package&.shallow? && AppMap.tracing.last_package_for_current_thread == hook_package
 

data/lib/appmap/trace.rb

@@ -22,7 +22,7 @@ module AppMap
 
       def comment
         @method.comment
-      rescue MethodSource::SourceNotFoundError
+      rescue MethodSource::SourceNotFoundError, Errno::EINVAL
         nil
       end
 

data/lib/appmap/util.rb

@@ -193,6 +193,7 @@ module AppMap
       end
 
       def deep_dup(hash)
+        require 'active_support/core_ext'
         hash.deep_dup
       end
 

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.83.5'
+  VERSION = '0.85.0'
 
   APPMAP_FORMAT_VERSION = '1.7.0'
 

data/lib/appmap.rb

@@ -20,13 +20,6 @@
 # - appmap/swagger (Rake task)
 # - appmap/depends (Rake task)
 
-begin
-  require 'active_support'
-  require 'active_support/core_ext'
-rescue NameError
-  warn 'active_support is not available. AppMap execution will continue optimistically without it...'
-end
-
 require 'appmap/version'
 require 'appmap/agent'
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.83.5
+  version: 0.85.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: method_source
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: method_source
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reverse_markdown
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -353,6 +353,7 @@ files:
 - ext/appmap/extconf.rb
 - lib/appmap.rb
 - lib/appmap/agent.rb
+- lib/appmap/builtin_hooks/activesupport.yml
 - lib/appmap/builtin_hooks/json.yml
 - lib/appmap/builtin_hooks/logger.yml
 - lib/appmap/builtin_hooks/net/http.yml
@@ -383,19 +384,21 @@ files:
 - 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/devise.yml
 - lib/appmap/gem_hooks/pandoc-ruby.yml
 - lib/appmap/gem_hooks/rails.yml
 - lib/appmap/gem_hooks/railties.yml
+- lib/appmap/gem_hooks/random.yml
 - lib/appmap/gem_hooks/resque.yml
 - lib/appmap/gem_hooks/sidekiq.yml
 - lib/appmap/gem_hooks/sprockets.yml
 - lib/appmap/handler.rb
-- lib/appmap/handler/eval.rb
-- lib/appmap/handler/function.rb
-- lib/appmap/handler/net_http.rb
+- lib/appmap/handler/eval_handler.rb
+- lib/appmap/handler/function_handler.rb
+- lib/appmap/handler/marshal_load_handler.rb
+- lib/appmap/handler/net_http_handler.rb
+- lib/appmap/handler/open_ssl_handler.rb
 - lib/appmap/handler/rails/render_handler.rb
 - lib/appmap/handler/rails/request_handler.rb
 - lib/appmap/handler/rails/sql_handler.rb