appmap 0.86.0 → 0.89.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaf2ec3e35b79244511d47a45f8d3f8f85dc5b666b022cbffe07e6224250f4fd
-  data.tar.gz: 0eada13772cc55470113fc06c47c5fddac339914a6012eafefc75d350bbb5c81
+  metadata.gz: 9d046b1cedf455ae967a663b200c05751c4c0659defa5e7dce0a7f760ba865b6
+  data.tar.gz: 790f5a9705b0d32b60467ecb8e51dc75e8fdbb2ac3af2022ee1c8a1a7c8cc8ca
 SHA512:
-  metadata.gz: 243680c3c2dcf1fe285bf2c2baf4dfe0913b4627bfdcb9654353d4855be3ed3def55973d331ad04ae13a307f710d6eba284313c338f70b8cf5e24025f0e6befe
-  data.tar.gz: c5715cb83a9d5463208392918cb040505b3a52be12e13cb40936146e2b468efc9932bd3b1233df7f0a05fece28387282009e6abe71a940858735e31ee18885e9
+  metadata.gz: 7c999d39cb9385f3758746cf93d50f291a4a6f9ae1c8b33266897975bdd9aabf4c8a3f666a3b3650ee70a24978d574a5db0bfefe2539240b582f1a430eabe399
+  data.tar.gz: 731810f9c4afe0c0c9130ab81d71e0c20f85860bf57fef5d5736845aba4c4d240dff101bc5a46aef4c6ca9e08f5adfe90ac749bb059fc7ecacd08aec77926f4e

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+# [0.89.0](https://github.com/applandinc/appmap-ruby/compare/v0.88.0...v0.89.0) (2022-09-07)
+
+
+### Bug Fixes
+
+* Make Rack a runtime dependency ([3f2924d](https://github.com/applandinc/appmap-ruby/commit/3f2924d41af291bfe771829c2ea7978332ff1d44))
+
+
+### Features
+
+* Add builtin labels for JWT ([3569333](https://github.com/applandinc/appmap-ruby/commit/3569333e99f82e03fff892001f2b65eb9e8aa52a))
+* Write an AppMap for each observed HTTP request ([2e89eaf](https://github.com/applandinc/appmap-ruby/commit/2e89eaf1b1f327771d1f4f0642fa6c202e0f3afb))
+
+# [0.88.0](https://github.com/applandinc/appmap-ruby/compare/v0.87.0...v0.88.0) (2022-08-31)
+
+
+### Bug Fixes
+
+* Allow recording of error responses ([e538556](https://github.com/applandinc/appmap-ruby/commit/e5385560cbbab2d27ce6c0a1620d5c7539e0d985))
+
+
+### Features
+
+* Add HTTP server request support for Rails 7 ([bd7f6c9](https://github.com/applandinc/appmap-ruby/commit/bd7f6c9109ee6c850250016276c8fbb6a8a66a2e))
+
+# [0.87.0](https://github.com/applandinc/appmap-ruby/compare/v0.86.0...v0.87.0) (2022-08-19)
+
+
+### Features
+
+* Improve performance of initial hooking ([901e262](https://github.com/applandinc/appmap-ruby/commit/901e26237027920ede6b0f9d4bc3d175c861b23a))
+
 # [0.86.0](https://github.com/applandinc/appmap-ruby/compare/v0.85.0...v0.86.0) (2022-08-10)
 
 

data/Gemfile

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
+
+gem 'rack', '~> 2'

data/README.md

@@ -92,9 +92,7 @@ You can launch a database like this:
 ```
 ➜ docker-compose -p appmap-ruby up -d
 ... stuff
-➜ docker-compose ps pg  
-      Name                    Command                 State                Ports         
------------------------------------------------------------------------------------------
-appmap-ruby_pg_1   docker-entrypoint.sh postgres   Up (healthy)   0.0.0.0:59134->5432/tcp
-➜ export DATABASE_URL=postgres://postgres@localhost:59134
+➜ docker-compose port pg 5432
+0.0.0.0:64479
+➜ export DATABASE_URL=postgres://postgres@localhost:64479
 ```

data/appmap.gemspec

@@ -28,10 +28,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'method_source'
-  spec.add_dependency 'rack'
   spec.add_dependency 'reverse_markdown'
 
   spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'minitest', '~> 5.15'
@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rdoc'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency 'rake-compiler'
 
   # Testing
   spec.add_development_dependency 'climate_control'

data/lib/appmap/gem_hooks/jwt.yml

@@ -0,0 +1,8 @@
+- method: JWT#decode
+  label: jwt.decode
+
+- method: JWT#encode
+  label: jwt.encode
+
+- method: JWT::Signature#verify
+  label: jwt.signature.verify

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

@@ -73,8 +73,8 @@ module AppMap
           class << self
             def build_from_invocation(parent_id, return_value, elapsed, response, event: HTTPServerResponse.new)
               event ||= HTTPServerResponse.new
-              event.status = response.status
-              event.headers = response.headers.dup
+              event.status = response[:status] || response.status
+              event.headers = (response[:headers] || response.headers).dup
               AppMap::Event::MethodReturn.build_from_invocation parent_id, return_value, nil, elapsed: elapsed, event: event, parameter_schema: true
             end
           end
@@ -114,6 +114,46 @@ module AppMap
             AppMap.tracing.record_event return_event
           end
         end
+
+        # RequestListener listens to the 'start_processing.action_controller' notification as a
+        # source of HTTP server request events. A strategy other than HookMethod is required for
+        # Rails >= 7 due to the hooked methods visibility dropping to private.
+        class RequestListener
+          def self.begin_request(_name, _started, _finished, _unique_id, payload)
+            RequestListener.new(payload)
+          end
+
+          protected
+
+          def initialize(payload)
+            @request_id = payload[:request].request_id
+            @subscriber = self.class.instance_method(:after_hook).bind(self)
+
+            ActiveSupport::Notifications.subscribe 'process_action.action_controller', @subscriber
+            before_hook payload
+          end
+
+          def before_hook(payload)
+            @call_event = HTTPServerRequest.new payload[:request]
+            AppMap.tracing.record_event @call_event
+          end
+
+          def after_hook(_name, started, finished, _unique_id, payload)
+            return unless @request_id == payload[:request].request_id
+
+            return_value = Thread.current[TEMPLATE_RENDER_VALUE]
+            Thread.current[TEMPLATE_RENDER_VALUE] = nil
+            return_event = HTTPServerResponse.build_from_invocation(
+              @call_event.id,
+              return_value,
+              finished - started,
+              payload[:response] || payload
+            )
+
+            AppMap.tracing.record_event return_event
+            ActiveSupport::Notifications.unsubscribe(@subscriber)
+          end
+        end
       end
     end
   end

data/lib/appmap/hook.rb

@@ -183,12 +183,6 @@ module AppMap
 
       hook = lambda do |hook_cls|
         lambda do |method_id|
-          # Don't try and trace the AppMap methods or there will be
-          # a stack overflow in the defined hook method.
-          next if %w[Marshal AppMap ActiveSupport].member?((hook_cls&.name || '').split('::')[0])
-
-          next if method_id == :call
-
           method = \
             begin
               hook_cls.instance_method(method_id)
@@ -197,6 +191,16 @@ module AppMap
               next
             end
 
+          package = config.lookup_package(hook_cls, method)
+          # doing this check first returned early in 98.7% of cases in sample_app_6th_ed
+          next unless package
+
+          # Don't try and trace the AppMap methods or there will be
+          # a stack overflow in the defined hook method.
+          next if %w[Marshal AppMap ActiveSupport].member?((hook_cls&.name || '').split('::')[0])
+
+          next if method_id == :call
+
           next if self.class.already_hooked?(method)
 
           warn "AppMap: Examining #{hook_cls} #{method.name}" if LOG
@@ -206,9 +210,6 @@ module AppMap
           # TODO: Figure out how to tell the difference?
           next unless disasm
 
-          package = config.lookup_package(hook_cls, method)
-          next unless package
-
           package.handler_class.new(package, hook_cls, method).activate
         end
       end

data/lib/appmap/middleware/remote_recording.rb

@@ -2,7 +2,8 @@
 
 module AppMap
   module Middleware
-    # RemoteRecording adds `/_appmap/record` routes to control recordings via HTTP requests
+    # RemoteRecording adds `/_appmap/record` routes to control recordings via HTTP requests.
+    # It can also be enabled to emit an AppMap for each request.
     class RemoteRecording
       def initialize(app)
         require 'json'
@@ -21,7 +22,7 @@ module AppMap
         end
       end
 
-      def start_recording
+      def ws_start_recording
         return [ 409, 'Recording is already in progress' ] if @tracer
 
         @events = []
@@ -32,7 +33,7 @@ module AppMap
         [ 200 ]
       end
 
-      def stop_recording(req)
+      def ws_stop_recording(req)
         return [ 404, 'No recording is in progress' ] unless @tracer
 
         tracer = @tracer
@@ -75,10 +76,50 @@ module AppMap
       end
 
       def call(env)
+        # Note: Puma config is avaliable here. For example:
+        # $ env['puma.config'].final_options[:workers]
+        # 0
+
         req = Rack::Request.new(env)
         return handle_record_request(req) if req.path == '/_appmap/record'
 
-        @app.call(env)
+        start_time = Time.now
+        # Support multi-threaded web server such as Puma by recording each thread
+        # into a separate Tracer.
+        tracer = AppMap.tracing.trace(thread: Thread.current) if record_all_requests?
+
+        @app.call(env).tap do |status, headers|
+          if tracer
+            AppMap.tracing.delete(tracer)
+
+            events = tracer.events.map(&:to_h)
+
+            appmap_name = "#{req.request_method} #{req.path} (#{status}) - #{start_time.strftime('%T.%L')}"
+            appmap_file_name = AppMap::Util.scenario_filename([ start_time.to_f, req.url ].join('_'))
+            output_dir = File.join(AppMap::DEFAULT_APPMAP_DIR, 'requests')
+            appmap_file_path = File.join(output_dir, appmap_file_name)
+
+            metadata = AppMap.detect_metadata
+            metadata[:name] = appmap_name
+            metadata[:timestamp] = start_time.to_f
+            metadata[:recorder] = {
+              name: 'record_requests'
+            }
+    
+            appmap = {
+              version: AppMap::APPMAP_FORMAT_VERSION,
+              classMap: AppMap.class_map(tracer.event_methods),
+              metadata: metadata,
+              events: events
+            }
+
+            FileUtils.mkdir_p(output_dir)
+            File.write(appmap_file_path, JSON.generate(appmap))
+
+            headers['AppMap-Name'] = File.expand_path(appmap_name)
+            headers['AppMap-File-Name'] = File.expand_path(appmap_file_path)
+          end
+        end
       end
 
       def recording_state
@@ -92,9 +133,9 @@ module AppMap
           if method.eql?('GET')
             recording_state
           elsif method.eql?('POST')
-            start_recording
+            ws_start_recording
           elsif method.eql?('DELETE')
-            stop_recording(req)
+            ws_stop_recording(req)
           else
             [ 404, '' ]
           end
@@ -106,6 +147,10 @@ module AppMap
         headers['Content-Type'] && headers['Content-Type'] =~ /html/
       end
 
+      def record_all_requests?
+        ENV['APPMAP_RECORD_REQUESTS'] == 'true'
+      end
+
       def recording?
         !@event_thread.nil?
       end

data/lib/appmap/railtie.rb

@@ -18,7 +18,15 @@ module AppMap
       ActiveSupport::Notifications.subscribe 'sql.sequel', AppMap::Handler::Rails::SQLHandler.new
       ActiveSupport::Notifications.subscribe 'sql.active_record', AppMap::Handler::Rails::SQLHandler.new
 
-      AppMap::Handler::Rails::RequestHandler::HookMethod.new.activate
+      http_hook_available = ActionController::Instrumentation.public_instance_methods.include?(:process_action)
+      if http_hook_available
+        AppMap::Handler::Rails::RequestHandler::HookMethod.new.activate
+      else
+        ActiveSupport::Notifications.subscribe(
+          'start_processing.action_controller',
+          AppMap::Handler::Rails::RequestHandler::RequestListener.method(:begin_request)
+        )
+      end
     end
   end
 end if ENV['APPMAP'] == 'true'

data/lib/appmap/trace.rb

@@ -48,8 +48,8 @@ module AppMap
         @tracers.empty?
       end
 
-      def trace(enable: true)
-        Tracer.new.tap do |tracer|
+      def trace(enable: true, thread: nil)
+        Tracer.new(thread_id: thread&.object_id).tap do |tracer|
           @tracers << tracer
           tracer.enable if enable
         end
@@ -64,7 +64,7 @@ module AppMap
       end
 
       def record_event(event, package: nil, defined_class: nil, method: nil)
-        @tracers.each do |tracer|
+        @tracers.select { |tracer| tracer.thread_id.nil? || tracer.thread_id === event.thread_id }.each do |tracer|
           tracer.record_event(event, package: package, defined_class: defined_class, method: method)
         end
       end
@@ -114,14 +114,16 @@ module AppMap
 
   class Tracer
     attr_accessor :stacks
+    attr_reader   :thread_id, :events
 
     # Records the events which happen in a program.
-    def initialize
+    def initialize(thread_id: nil)
       @events = []
       @last_package_for_thread = {}
       @methods = Set.new
       @stack_printer = StackPrinter.new if StackPrinter.enabled?
       @enabled = false
+      @thread_id = thread_id
     end
 
     def enable
@@ -143,6 +145,8 @@ module AppMap
     def record_event(event, package: nil, defined_class: nil, method: nil)
       return unless @enabled
 
+      raise "Expected event in thread #{@thread_id}, got #{event.thread_id}" if @thread_id && @thread_id != event.thread_id 
+
       @stack_printer.record(event) if @stack_printer
       @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event

data/lib/appmap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.86.0
+  version: 0.89.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-10 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reverse_markdown
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -386,6 +386,7 @@ files:
 - lib/appmap/gem_hooks/activerecord.yml
 - lib/appmap/gem_hooks/cancancan.yml
 - lib/appmap/gem_hooks/devise.yml
+- lib/appmap/gem_hooks/jwt.yml
 - lib/appmap/gem_hooks/pandoc-ruby.yml
 - lib/appmap/gem_hooks/rails.yml
 - lib/appmap/gem_hooks/railties.yml