appmap 0.99.1 → 0.99.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff070f04eeeb2d79a08d4f93462a84e277dfad345bffd1d6b87bd063a63b8f00
-  data.tar.gz: 27e47f4e5a85fce938cbd259bf76cce952490851cfee98315fddf6d6b1c798d3
+  metadata.gz: eda0d23ff548aaa0e6e61eef0e7734a542660eeeb45e899f54a7287665baaf7e
+  data.tar.gz: 84dc9f162eeae76f58f0c6015ec47686509aabf9ac4cac727016957b69421daf
 SHA512:
-  metadata.gz: 97db1ff69373241c3e2ca4633fcca4c800d72b60734bde3b32aae2d3765e86f484e490a4148b98c9e90c40b3fa68cc9b734e56ce9175d1e26ec9bfc767b9707e
-  data.tar.gz: 074b036daecfc348fbe13510ab7c6cca46fe8d2d630bd81e28808ef4f05e15b47dedda31e9d3a2e423f426ba0980ea04e50439b3533b8b7690c9047be199a1a9
+  metadata.gz: af594c4d511623a7e9b37bc3bc45d5d2460de1410e9177f544e900c1d1cd5a555be04bef870c8c5e18a05f46fb242afd6dd9ce26646fc700f071c7a4d917da5a
+  data.tar.gz: 49a5e81dd6f504c1e5998f8dc2af53e1b657ddcef387005cd6f313f6c299eb46cc27b7a1c470356de8170435e459d3b1f5e06ef65a1d72f92cea5c0eed797607

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [0.99.4](https://github.com/getappmap/appmap-ruby/compare/v0.99.3...v0.99.4) (2023-05-15)
+
+
+### Bug Fixes
+
+* More robust extraction of test failures ([3851f7c](https://github.com/getappmap/appmap-ruby/commit/3851f7cdf3daf27767f3eb161c69126b607b8a51))
+* Use a copy of rack environment to probe the route ([7ec89a8](https://github.com/getappmap/appmap-ruby/commit/7ec89a8412dc8b9209322ebe9e246f22531b68ab)), closes [#329](https://github.com/getappmap/appmap-ruby/issues/329)
+
+## [0.99.3](https://github.com/getappmap/appmap-ruby/compare/v0.99.2...v0.99.3) (2023-05-10)
+
+
+### Bug Fixes
+
+* Capture HTTP requests in Rails on Rack level if possible ([e50a280](https://github.com/getappmap/appmap-ruby/commit/e50a280829cd102b8eecbb83a4e2a76247ee6270)), closes [#323](https://github.com/getappmap/appmap-ruby/issues/323)
+
+## [0.99.2](https://github.com/getappmap/appmap-ruby/compare/v0.99.1...v0.99.2) (2023-05-10)
+
+
+### Bug Fixes
+
+* Ensure that signature hash key consists of strings ([acb5db9](https://github.com/getappmap/appmap-ruby/commit/acb5db9ecb0a6cdf40de83bf506f45f5283f641b))
+
 ## [0.99.1](https://github.com/getappmap/appmap-ruby/compare/v0.99.0...v0.99.1) (2023-04-24)
 
 

data/lib/appmap/config.rb

@@ -499,6 +499,11 @@ module AppMap
     end
 
     def never_hook?(cls, method)
+      unless method
+        HookLog.log "method is nil" if HookLog.enabled?
+        return true
+      end
+
       _, separator, = ::AppMap::Hook.qualify_method_name(method)
       if exclude.member?(cls.name) || exclude.member?([ cls.name, separator, method.name ].join)
         HookLog.log "Hooking of #{method} disabled by configuration" if HookLog.enabled?

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'appmap/handler'
+
+module AppMap
+  module Handler
+    module Rails
+      # Context of a rails request tracking.
+      # Mostly a utility class to clean up and deduplicate request handler code.
+      class Context
+        def initialize(environment = nil)
+          environment[REQUEST_CONTEXT] = self if environment
+          @thread = Thread.current
+        end
+
+        def self.from(environment)
+          environment[REQUEST_CONTEXT]
+        end
+
+        def self.create(environment)
+          return if from environment
+
+          new environment
+        end
+
+        def self.remove(env)
+          env[REQUEST_CONTEXT] = nil
+        end
+
+        def find_template_render_value
+          @thread[TEMPLATE_RENDER_VALUE].tap do
+            @thread[TEMPLATE_RENDER_VALUE] = nil
+          end
+        end
+
+        # context is set on the rack environment to make sure a single request is only recorded once
+        # even if ActionDispatch::Executor is entered more than once (as can happen with engines)
+        REQUEST_CONTEXT = 'appmap.handler.request.context'
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 require 'appmap/event'
 require 'appmap/hook'
 require 'appmap/util'
+require 'appmap/handler/rails/context'
 
 module AppMap
   module Handler
@@ -57,6 +58,8 @@ module AppMap
           private
 
           def normalized_path(request, router = ::Rails.application.routes.router)
+            # use a cloned environment because the router can modify it
+            request = ActionDispatch::Request.new request.env.clone
             router.recognize request do |route, _|
               app = route.app
               next unless app.matches? request
@@ -101,8 +104,11 @@ module AppMap
           protected
 
           def before_hook(receiver, *)
+            req = receiver.request
+            return unless Context.create req.env
+
             before_hook_start_time = AppMap::Util.gettime()
-            call_event = HTTPServerRequest.new(receiver.request)
+            call_event = HTTPServerRequest.new(req)
             call_event.call_elapsed_instrumentation = (AppMap::Util.gettime() - before_hook_start_time)
             # http_server_request events are i/o and do not require a package name.
             AppMap.tracing.record_event call_event, defined_class: defined_class, method: hook_method
@@ -111,13 +117,56 @@ module AppMap
 
           def after_hook(receiver, call_event, elapsed, *)
             after_hook_start_time = AppMap::Util.gettime()
-            return_value = Thread.current[TEMPLATE_RENDER_VALUE]
-            Thread.current[TEMPLATE_RENDER_VALUE] = nil
-            return_event = HTTPServerResponse.build_from_invocation call_event.id, return_value, elapsed, receiver.response
+            return_event = HTTPServerResponse.build_from_invocation \
+              call_event.id, Context.new.find_template_render_value, elapsed, receiver.response
             return_event.elapsed_instrumentation = (AppMap::Util.gettime() - after_hook_start_time) + call_event.call_elapsed_instrumentation
             call_event.call_elapsed_instrumentation = nil # to stay consistent with elapsed_instrumentation only being stored in return
             AppMap.tracing.record_event return_event
+            Context.remove receiver.request.env
+          end
+        end
+
+        # Additional hook for the Rack stack in Rails applications.
+        #
+        # Hooking just in ActionController can be inaccurate if there's a middleware that
+        # intercepts the response and modifies it, or catches an exception
+        # or an object and does some other processing.
+        # For example, Devise catches a throw from warden on authentication error, then runs
+        # ActionController stack AGAIN to render a login page, which it then modifies to change
+        # the HTTP status code.
+        # ActionDispatch::Executor seems a good place to hook as the central entry point
+        # in a Rails application; there are a couple middleware that sometimes sit on top of it
+        # but they're usually inconsequential. One issue is that the executor can be entered several
+        # times in the stack (especially if Rails engines are used). To handle that, we set
+        # a context in the request environment the first time we enter it.
+        class RackHook < AppMap::Hook::Method
+          def initialize
+            super(nil, ActionDispatch::Executor, ActionDispatch::Executor.instance_method(:call))
+          end
+
+          protected
+
+          def before_hook(_receiver, env)
+            return unless Context.create env
+
+            before_hook_start_time = AppMap::Util.gettime
+            call_event = HTTPServerRequest.new ActionDispatch::Request.new(env)
+            # http_server_request events are i/o and do not require a package name.
+            AppMap.tracing.record_event call_event, defined_class: defined_class, method: hook_method
+            [call_event, (AppMap::Util.gettime - before_hook_start_time)]
+          end
+
+          # NOTE: this method smells of :reek:LongParameterList and :reek:UtilityFunction
+          # because of the interface it implements.
+          # rubocop:disable Metrics/ParameterLists
+          def after_hook(_receiver, call_event, elapsed_before, elapsed, after_hook_start_time, rack_return, _exception)
+            # TODO: handle exceptions
+            return_event = HTTPServerResponse.build_from_invocation \
+              call_event.id, Context.new.find_template_render_value, elapsed, ActionDispatch::Response.new(*rack_return)
+            return_event.elapsed_instrumentation = (AppMap::Util.gettime - after_hook_start_time) + elapsed_before
+            AppMap.tracing.record_event return_event
           end
+          # rubocop:enable Metrics/ParameterLists
         end
 
         # RequestListener listens to the 'start_processing.action_controller' notification as a
@@ -125,6 +174,8 @@ module AppMap
         # Rails >= 7 due to the hooked methods visibility dropping to private.
         class RequestListener
           def self.begin_request(_name, _started, _finished, _unique_id, payload)
+            return unless Context.create payload[:request].env
+
             RequestListener.new(payload)
           end
 
@@ -149,17 +200,16 @@ module AppMap
             return unless @request_id == payload[:request].request_id
 
             after_hook_start_time = AppMap::Util.gettime()
-            return_value = Thread.current[TEMPLATE_RENDER_VALUE]
-            Thread.current[TEMPLATE_RENDER_VALUE] = nil
             return_event = HTTPServerResponse.build_from_invocation(
               @call_event.id,
-              return_value,
+              Context.new.find_template_render_value,
               finished - started,
               payload[:response] || payload
             )
             return_event.elapsed_instrumentation = (AppMap::Util.gettime() - after_hook_start_time) + @call_event.call_elapsed_instrumentation
 
             AppMap.tracing.record_event return_event
+            Context.remove payload[:request].env
             ActiveSupport::Notifications.unsubscribe(@subscriber)
           end
         end

data/lib/appmap/hook/method.rb

@@ -4,11 +4,23 @@ require 'appmap/util'
 
 module AppMap
   class Hook
+    class << self
+      def method_hash_key(cls, method)
+        [ cls, method.name ].hash
+      rescue TypeError => e
+        warn "Error building hash key for #{cls}, #{method}: #{e}"
+      end
+    end
+    
+
     SIGNATURES = {}
     LOOKUP_SIGNATURE = lambda do |id|
       method = super(id)
 
-      signature = SIGNATURES[[ method.owner, method.name ]]
+      hash_key = Hook.method_hash_key(method.owner, method)
+      return method unless hash_key
+
+      signature = SIGNATURES[hash_key]
       if signature
         method.singleton_class.module_eval do
           define_method(:parameters) do
@@ -48,7 +60,8 @@ module AppMap
         end
 
         hook_method_parameters = hook_method.parameters.dup.freeze
-        SIGNATURES[[ hook_class, hook_method.name ]] = hook_method_parameters
+        hash_key = Hook.method_hash_key(hook_class, hook_method)
+        SIGNATURES[hash_key] = hook_method_parameters if hash_key
 
         # irb(main):001:0> Kernel.public_instance_method(:system)
         # (irb):1:in `public_instance_method': method `system' for module `Kernel' is  private (NameError)

data/lib/appmap/railtie.rb

@@ -32,6 +32,8 @@ module AppMap
           AppMap::Handler::Rails::RequestHandler::RequestListener.method(:begin_request)
         )
       end
+
+      AppMap::Handler::Rails::RequestHandler::RackHook.new.activate
     end
   end
 end if AppMap.recording_enabled?

data/lib/appmap/util.rb

@@ -161,7 +161,9 @@ module AppMap
         return unless exception
 
         { message: exception.message }.tap do |test_failure|
-          first_location = exception.backtrace_locations&.find { |location| !Pathname.new(normalize_path(location.absolute_path)).absolute? }
+          first_location = exception.backtrace_locations&.find do |location|
+            !Pathname.new(normalize_path(location.absolute_path || location.path)).absolute?
+          end
           test_failure[:location] = [ normalize_path(first_location.path), first_location.lineno ].join(':') if first_location
         end
       end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.99.1'
+  VERSION = '0.99.4'
 
   APPMAP_FORMAT_VERSION = '1.12.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.99.1
+  version: 0.99.4
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -403,6 +403,7 @@ files:
 - 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/context.rb
 - lib/appmap/handler/rails/render_handler.rb
 - lib/appmap/handler/rails/request_handler.rb
 - lib/appmap/handler/rails/sql_handler.rb