appmap 0.83.4 → 0.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc72653227c79221b4461962b65a221a454c63b564dc713b97ae6c9bb7724e94
-  data.tar.gz: df9594b7e3043183d9ddec1ad9c7e767aa72b8b60a4c7923a030f51dffb2a7ab
+  metadata.gz: bc5d48a877bd0953d1d374fcabfa23bf584ac81bd4f303d4f759fb531a778b22
+  data.tar.gz: 6fe7282152760a910275176ea36987747671e4d06d3983b41ac04edfc217d22c
 SHA512:
-  metadata.gz: ac66c69ecb0564856a2ea6eebc0c9d81e7e78c583cb7cb33a271d51969c15985b1335eb5e2d7ae4c348f0dfada0ff7ae3e7f7df45fa53eae8e99b945e0e32a3b
-  data.tar.gz: 2173330d318f11cc5577c997516414809cd4fa27c0121592f9b6041d7b2eb27b12bc1e7aa3ab19dadf6a26afff255c484ad019bb61502f40813a14553e805dfd
+  metadata.gz: 3385416af1ca8318f5e08fe8edc242be03e7e40b8c15a5a68e6ec0678915cd3ca37a3948bf2651db20f2d56dc3b9ba93dda777a5d21ebcd134de252c78d5af91
+  data.tar.gz: 67ee12c6708a5e29e86462d086b0509db2d4c0b05643182b9ea5209d4acfe792d52532bb3314a48911c07e7d1891a2a32868a55feb13455172e7571c1b7a3570

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Add new issues to project tracker
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@main
+        with:
+          project-url: https://github.com/orgs/applandinc/projects/15
+          github-token: ${{ secrets.ADD_TO_PROJECT_BOARD_PAT }}

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [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)
+
+
+### Bug Fixes
+
+* Remove spec and test from the gem ([ab2f6cb](https://github.com/applandinc/appmap-ruby/commit/ab2f6cbd99b2380cd3bc6fcea6a128c080bbcde0))
+
 ## [0.83.4](https://github.com/applandinc/appmap-ruby/compare/v0.83.3...v0.83.4) (2022-06-22)
 
 

data/appmap.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = `git ls-files --no-deleted`.split("
-").grep_v(/appmap\.json$/)
+").grep_v(/appmap\.json$/).grep_v(/^spec\//).grep_v(/^test\//)
 
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -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

@@ -14,3 +14,9 @@
   label: deserialize.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

@@ -18,7 +18,7 @@
   - Kernel#eval
   require_name: ruby
   label: lang.eval
-  handler_class: AppMap::Handler::Eval
+  handler_class: AppMap::Handler::EvalHandler
 - methods:
   - IO#popen
   - Kernel#exec

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)

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,15 @@ 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
       # The depth of the frame we need to pluck out:
       # 1. Hook::Method#do_call
       # 2. Hook::Method#trace_call

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/{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.4'
+  VERSION = '0.84.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'