appmap 0.99.2 → 0.100.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d8aa81209b5f8d33fc480c3ff3b7f6cd61027dc51fad74c9ad4f19ba6c7faf
-  data.tar.gz: 5d8ac162d8cf5eacfc045ff81a16c2b473df79ae0619ddaface5b4bab8d422cb
+  metadata.gz: 5f52fa6b2d5e7414553f16fbcf018b4d32214bdfcda4afd2567d9bef11203979
+  data.tar.gz: 0d456c7e95dc01ae731bbe9def89ba1585651412d6d8a35eaa2f9c4f83580d2f
 SHA512:
-  metadata.gz: 34c7b6b0fd6e45c33158776e3c3f1a8725031913ad49856f24aa5af50cbc41efd2e047face5c3c1f02a9c20670af08be43492e5bd665a17323578c735b07900b
-  data.tar.gz: 0ea3f5be3436ea8eec1d8e14cd959b67e6e4547d03de6401c6e21250b3ba91b521b57f665298e1e4ec3be9616a1fbcf0a2f11b8ff09a5c53cd0d60c2d4a358f6
+  metadata.gz: a07b7341627a96c8ef21930d21a095e9cf849cf06b882d980ec670ce07003dc28e68d2a30e930fb203bf4315ca7aba1f60d43e5d7053d2e56e598ed7d6709302
+  data.tar.gz: 691c992e647a2760de0ae0ec75c00efb6824b008abd85f6506c31d34175e52d178d5e3297ab3414eb918fc3e083bba208b0b04c9c74f763330bc4333eb078ce1

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# [0.100.0](https://github.com/getappmap/appmap-ruby/compare/v0.99.4...v0.100.0) (2023-07-11)
+
+
+### Features
+
+* Add `appmap-agent-config` command to bootstrap appmap.yml ([568acc3](https://github.com/getappmap/appmap-ruby/commit/568acc3948871f736ba72244a04fd54d8be67615))
+
+## [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)
 
 

data/exe/appmap-agent-config

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'appmap'
+require 'appmap/command/agent_setup/config'
+
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH, force: false }
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: appmap-agent-config [options]'
+
+  description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
+  parser.on('-c', '--config=FILEPATH', description) do |filepath|
+    @options[:config_file] = filepath
+  end
+
+  parser.on('-f', '--force', 'Overwrite existing configuration file') do
+    @options[:force] = true
+  end
+end.parse!
+
+begin
+  AppMap::Command::AgentSetup::Config.new(@options[:config_file], @options[:force]).perform
+
+  puts "AppMap configuration file created at #{@options[:config_file]}"
+rescue AppMap::Command::AgentSetup::Config::FileExistsError
+  puts "AppMap configuration file already exists at #{@options[:config_file]}"
+  puts 'Use the --force option to overwrite.'
+  exit 1
+end

data/lib/appmap/command/agent_setup/config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'appmap/service/guesser'
+
+module AppMap
+  module Command
+    module AgentSetup
+      ConfigStruct = Struct.new(:config_file, :overwrite)
+
+      class Config < ConfigStruct
+        class FileExistsError < StandardError; end
+
+        def perform
+          raise FileExistsError unless overwrite || !File.exist?(config_file)
+
+          config = {
+            'name' => Service::Guesser.guess_name,
+            'packages' => Service::Guesser.guess_paths.map { |path| { 'path' => path } },
+            'language' => 'ruby',
+            'appmap_dir' => 'tmp/appmap'
+          }
+
+          File.write(config_file, YAML.dump(config))
+        end
+      end
+    end
+  end
+end

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/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.2'
+  VERSION = '0.100.0'
 
   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.2
+  version: 0.100.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -308,6 +308,7 @@ description:
 email:
 - kgilpin@gmail.com
 executables:
+- appmap-agent-config
 - appmap-agent-init
 - appmap-agent-status
 - appmap-agent-validate
@@ -347,6 +348,7 @@ files:
 - examples/mock_webapp/lib/mock_webapp/controller.rb
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
+- exe/appmap-agent-config
 - exe/appmap-agent-init
 - exe/appmap-agent-status
 - exe/appmap-agent-validate
@@ -365,6 +367,7 @@ files:
 - lib/appmap/builtin_hooks/psych.yml
 - lib/appmap/builtin_hooks/ruby.yml
 - lib/appmap/class_map.rb
+- lib/appmap/command/agent_setup/config.rb
 - lib/appmap/command/agent_setup/init.rb
 - lib/appmap/command/agent_setup/status.rb
 - lib/appmap/command/agent_setup/validate.rb
@@ -403,6 +406,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