appmap 0.45.1 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91b79723565f45d9d59ce341a9944a3a4e1c853bc77c1b176dc7b26ede9df22
-  data.tar.gz: f9be88ae7e83b801f66ada4087a06923ad9fa4d10e498f1c8b07fe0e301552d7
+  metadata.gz: b563a80bb77c42dd44d9fd299ed9b1a273abaf9d43256e23a0856fc06849f74c
+  data.tar.gz: 25dead3dd3c057ee4585c8af0e85e8d495e689a18f3aa02d850bdf470c98d5ff
 SHA512:
-  metadata.gz: e7eda447c67a44ad10226f5b6e9eb51c82995a4b2df970af27b0e2b5304101d419a6b3843ef6f0a983a3f952da2e3ed55f0de327b2856fcf970961c410c19b79
-  data.tar.gz: 839df6608d503e74f663d42673d9cf91866592a1715cee1c828c3de23ae472fdff6025ea9ee767a33e384b2ed51f46a999001d354f3e763deba46a5253eb5661
+  metadata.gz: 6bc94e6ee51daf178d9db411f2393538e91e4cc6a985c9b1d28ccc08feda7b6b59708d9f5f0f2cbd2184b058ff39d245c2c84e4cb25a64d5e6ddac96587c2a76
+  data.tar.gz: 252d3955b6daedfb687091c8fb735c3f61d4cca3d7fa6ac44182c9c87f2185f53e886fa4e96f3896c35a7b5bb67e3302120dfa4e978324783b72d446f531b630

data/.travis.yml

@@ -17,6 +17,16 @@ before_script:
 cache:
   bundler: true
 
+before_install:
+  # see https://blog.travis-ci.com/docker-rate-limits 
+  # and also https://www.docker.com/blog/what-you-need-to-know-about-upcoming-docker-hub-rate-limiting/
+  # if we do not use authorized account, 
+  # the pulls-per-IP quota is shared with other Travis users
+  - >
+    if [ ! -z "$DOCKERHUB_PASSWORD" ] && [ ! -z "$DOCKERHUB_USERNAME" ]; then
+      echo "$DOCKERHUB_PASSWORD" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin  ;
+    fi
+
  
 # GEM_ALTERNATIVE_NAME only needed for deployment 
 jobs:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.46.0](https://github.com/applandinc/appmap-ruby/compare/v0.45.1...v0.46.0) (2021-05-12)
+
+
+### Features
+
+* Record view template rendering events and template paths ([973b258](https://github.com/applandinc/appmap-ruby/commit/973b2581b6e2d4e15a1b93331e4e95a88678faae))
+
 ## [0.45.1](https://github.com/applandinc/appmap-ruby/compare/v0.45.0...v0.45.1) (2021-05-04)
 
 

data/README.md

@@ -9,7 +9,6 @@
   - [Minitest](#minitest)
   - [Cucumber](#cucumber)
   - [Remote recording](#remote-recording)
-  - [Server process recording](#server-process-recording)
 - [AppMap for VSCode](#appmap-for-vscode)
 - [AppMap Swagger](#appmap-swagger)
 - [Uploading AppMaps](#uploading-appmaps)
@@ -326,25 +325,25 @@ if defined?(AppMap)
 end
 ```
 
-2. Download and unpack the [AppLand browser extension](https://github.com/applandinc/appland-browser-extension). Install into Chrome using `chrome://extensions/`. Turn on "Developer Mode" and then load the extension using the "Load unpacked" button.
+2. (optional) Download and unpack the [AppLand browser extension](https://github.com/applandinc/appland-browser-extension). Install into Chrome using `chrome://extensions/`. Turn on "Developer Mode" and then load the extension using the "Load unpacked" button.
 
-3. Start your Rails application server. For example:
+3. Start your Rails application server, with `APPMAP_RECORD=true`. For example:
 
 ```sh-session
-$ bundle exec rails server
+$ APPMAP_RECORD=true bundle exec rails server
 ```
 
-4. Open the AppLand browser extension and push `Start`.
+4. Start the recording
 
-5. Use your app. For example, perform a login flow, or run through a manual UI test.
-
-6. Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
+Option 1: Open the AppLand browser extension and push `Start`.
+Option 2: `curl -XPOST localhost:3000/_appmap/record` (be sure and get the port number right)
 
-## Server process recording
+5. Use your app. For example, perform a login flow, or run through a manual UI test.
 
-Run your Rails server with `APPMAP_RECORD=true`. When the server exits, an *appmap.json* file will be written to the project directory. This is a great way to start the server, interact with your app as a user (or through it's API), and then view an AppMap of everything that happened.
+6. Finish the recording.
 
-Be sure and set `WEB_CONCURRENCY=1`, if you are using a webserver that can run multiple processes. You only want there to be one process while you are recording, otherwise they will both try and write *appmap.json* and one of them will clobber the other.
+Option 1: Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
+Option 2: `curl -XDELETE localhost:3000/_appmap/record > recording.appmap.json` - Saves the recording as a local file.
 
 
 # AppMap for VSCode

data/lib/appmap.rb

@@ -9,7 +9,6 @@ end
 
 require 'appmap/version'
 require 'appmap/hook'
-require 'appmap/handler/net_http'
 require 'appmap/config'
 require 'appmap/trace'
 require 'appmap/class_map'

data/lib/appmap/class_map.rb

@@ -82,16 +82,13 @@ module AppMap
       protected
 
       def add_function(root, method)
-        package = method.package
-        static = method.static
-
         object_infos = [
           {
-            name: package.name,
+            name: method.package,
             type: 'package'
           }
         ]
-        object_infos += method.defined_class.split('::').map do |name|
+        object_infos += method.class_name.split('::').map do |name|
           {
             name: name,
             type: 'class'
@@ -100,7 +97,7 @@ module AppMap
         function_info = {
           name: method.name,
           type: 'function',
-          static: static
+          static: method.static
         }
         location = method.source_location
 
@@ -108,20 +105,15 @@ module AppMap
           if location
             location_file, lineno = location
             location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
-            [ location_file, lineno ].join(':')
+            [ location_file, lineno ].compact.join(':')
           else
-            [ method.defined_class, static ? '.' : '#', method.name ].join
+            [ method.class_name, method.static ? '.' : '#', method.name ].join
           end
 
-        comment = begin
-          method.comment
-        rescue MethodSource::SourceNotFoundError
-          nil
-        end
-
+        comment = method.comment
         function_info[:comment] = comment unless comment.blank?
 
-        function_info[:labels] = parse_labels(comment) + (package.labels || [])
+        function_info[:labels] = parse_labels(comment) + (method.labels || [])
         object_infos << function_info
 
         parent = root

data/lib/appmap/config.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'appmap/handler/net_http'
+require 'appmap/handler/rails/template'
+
 module AppMap
   class Config
     # Specifies a code +path+ to be mapped.
@@ -120,15 +123,19 @@ module AppMap
     # Methods that should always be hooked, with their containing
     # package and labels that should be applied to them.
     HOOKED_METHODS = {
-      'ActionView::Renderer' => TargetMethods.new(:render, Package.build_from_gem('actionview', package_name: 'action_view', labels: %w[mvc.view], optional: true)),
-      'ActionDispatch::Request::Session' => TargetMethods.new(%i[destroy [] dig values []= clear update delete fetch merge], Package.build_from_gem('actionpack', package_name: 'action_dispatch', labels: %w[http.session], optional: true)),
-      'ActionDispatch::Cookies::CookieJar' => TargetMethods.new(%i[[]= clear update delete recycle], Package.build_from_gem('actionpack', package_name: 'action_dispatch', labels: %w[http.cookie], optional: true)),
-      'ActionDispatch::Cookies::EncryptedCookieJar' => TargetMethods.new(%i[[]=], Package.build_from_gem('actionpack', package_name: 'action_dispatch', labels: %w[http.cookie crypto.encrypt], optional: true)),
-      'CanCan::ControllerAdditions' => TargetMethods.new(%i[authorize! can? cannot?], Package.build_from_gem('cancancan', labels: %w[security.authorization], optional: true)),
-      'CanCan::Ability' => TargetMethods.new(%i[authorize!], Package.build_from_gem('cancancan', labels: %w[security.authorization], optional: true)),
+      'ActionView::Renderer' => TargetMethods.new(:render, Package.build_from_gem('actionview', shallow: false, package_name: 'action_view', labels: %w[mvc.view], optional: true).tap do |package|
+        package.handler_class = AppMap::Handler::Rails::Template::RenderHandler if package
+      end),
+      'ActionView::Resolver' => TargetMethods.new(%i[find_all find_all_anywhere], Package.build_from_gem('actionview', shallow: false, package_name: 'action_view', labels: %w[mvc.template.resolver], optional: true).tap do |package|
+        package.handler_class = AppMap::Handler::Rails::Template::ResolverHandler if package
+      end),
+      'ActionDispatch::Request::Session' => TargetMethods.new(%i[destroy [] dig values []= clear update delete fetch merge], Package.build_from_gem('actionpack', shallow: false, package_name: 'action_dispatch', labels: %w[http.session], optional: true)),
+      'ActionDispatch::Cookies::CookieJar' => TargetMethods.new(%i[[]= clear update delete recycle], Package.build_from_gem('actionpack', shallow: false, package_name: 'action_dispatch', labels: %w[http.cookie], optional: true)),
+      'ActionDispatch::Cookies::EncryptedCookieJar' => TargetMethods.new(%i[[]=], Package.build_from_gem('actionpack', shallow: false, package_name: 'action_dispatch', labels: %w[http.cookie crypto.encrypt], optional: true)),
+      'CanCan::ControllerAdditions' => TargetMethods.new(%i[authorize! can? cannot?], Package.build_from_gem('cancancan', shallow: false, labels: %w[security.authorization], optional: true)),
+      'CanCan::Ability' => TargetMethods.new(%i[authorize!], Package.build_from_gem('cancancan', shallow: false, labels: %w[security.authorization], optional: true)),
       'ActionController::Instrumentation' => [
-        TargetMethods.new(%i[process_action send_file send_data redirect_to], Package.build_from_gem('actionpack', package_name: 'action_controller', labels: %w[mvc.controller], optional: true)),
-        TargetMethods.new(%i[render], Package.build_from_gem('actionpack', package_name: 'action_controller', labels: %w[mvc.view], optional: true)),
+        TargetMethods.new(%i[process_action send_file send_data redirect_to], Package.build_from_gem('actionpack', shallow: false, package_name: 'action_controller', labels: %w[mvc.controller], optional: true))
       ]
     }.freeze
 

data/lib/appmap/event.rb

@@ -21,10 +21,10 @@ module AppMap
       LIMIT = 100
 
       class << self
-        def build_from_invocation(me, event_type)
-          me.id = AppMap::Event.next_id_counter
-          me.event = event_type
-          me.thread_id = Thread.current.object_id
+        def build_from_invocation(event_type, event:)
+          event.id = AppMap::Event.next_id_counter
+          event.event = event_type
+          event.thread_id = Thread.current.object_id
         end
 
         # Gets a display string for a value. This is not meant to be a machine deserializable value.
@@ -48,8 +48,6 @@ module AppMap
           nil
         end
 
-        protected
-
         # Heuristic for dynamically defined class whose name can be nil
         def best_class_name(value)
           value_cls = value.class
@@ -103,19 +101,20 @@ module AppMap
       attr_accessor :defined_class, :method_id, :path, :lineno, :parameters, :receiver, :static
 
       class << self
-        def build_from_invocation(mc = MethodCall.new, defined_class, method, receiver, arguments)
+        def build_from_invocation(defined_class, method, receiver, arguments, event: MethodCall.new)
+          event ||= MethodCall.new
           defined_class ||= 'Class'
-          mc.tap do
+          event.tap do
             static = receiver.is_a?(Module)
-            mc.defined_class = defined_class
-            mc.method_id = method.name.to_s
+            event.defined_class = defined_class
+            event.method_id = method.name.to_s
             if method.source_location
               path = method.source_location[0]
               path = path[Dir.pwd.length + 1..-1] if path.index(Dir.pwd) == 0
-              mc.path = path
-              mc.lineno = method.source_location[1]
+              event.path = path
+              event.lineno = method.source_location[1]
             else
-              mc.path = [ defined_class, static ? '.' : '#', method.name ].join
+              event.path = [ defined_class, static ? '.' : '#', method.name ].join
             end
 
             # Check if the method has key parameters. If there are any they'll always be last.
@@ -123,7 +122,7 @@ module AppMap
             has_key = [[:dummy], *method.parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
             kwargs = has_key && arguments[-1].dup || {}
 
-            mc.parameters = method.parameters.map.with_index do |method_param, idx|
+            event.parameters = method.parameters.map.with_index do |method_param, idx|
               param_type, param_name = method_param
               param_name ||= 'arg'
               value = case param_type
@@ -144,13 +143,13 @@ module AppMap
                 kind: param_type
               }
             end
-            mc.receiver = {
+            event.receiver = {
               class: best_class_name(receiver),
               object_id: receiver.__id__,
               value: display_string(receiver)
             }
-            mc.static = static
-            MethodEvent.build_from_invocation(mc, :call)
+            event.static = static
+            MethodEvent.build_from_invocation(:call, event: event)
           end
         end
       end
@@ -175,11 +174,12 @@ module AppMap
       attr_accessor :parent_id, :elapsed
 
       class << self
-        def build_from_invocation(mr = MethodReturnIgnoreValue.new, parent_id, elapsed)
-          mr.tap do |_|
-            mr.parent_id = parent_id
-            mr.elapsed = elapsed
-            MethodEvent.build_from_invocation(mr, :return)
+        def build_from_invocation(parent_id, elapsed: nil, event: MethodReturnIgnoreValue.new)
+          event ||= MethodReturnIgnoreValue.new
+          event.tap do |_|
+            event.parent_id = parent_id
+            event.elapsed = elapsed
+            MethodEvent.build_from_invocation(:return, event: event)
           end
         end
       end
@@ -187,7 +187,7 @@ module AppMap
       def to_h
         super.tap do |h|
           h[:parent_id] = parent_id
-          h[:elapsed] = elapsed
+          h[:elapsed] = elapsed if elapsed
         end
       end
     end
@@ -196,10 +196,11 @@ module AppMap
       attr_accessor :return_value, :exceptions
 
       class << self
-        def build_from_invocation(mr = MethodReturn.new, parent_id, elapsed, return_value, exception)
-          mr.tap do |_|
+        def build_from_invocation(parent_id, return_value, exception, elapsed: nil, event: MethodReturn.new)
+          event ||= MethodReturn.new
+          event.tap do |_|
             if return_value
-              mr.return_value = {
+              event.return_value = {
                 class: best_class_name(return_value),
                 value: display_string(return_value),
                 object_id: return_value.__id__
@@ -220,9 +221,9 @@ module AppMap
                 next_exception = next_exception.cause
               end
 
-              mr.exceptions = exceptions
+              event.exceptions = exceptions
             end
-            MethodReturnIgnoreValue.build_from_invocation(mr, parent_id, elapsed)
+            MethodReturnIgnoreValue.build_from_invocation(parent_id, elapsed: elapsed, event: event)
           end
         end
       end

data/lib/appmap/handler/function.rb

@@ -11,7 +11,7 @@ module AppMap
         end
 
         def handle_return(call_event_id, elapsed, return_value, exception)
-          AppMap::Event::MethodReturn.build_from_invocation(call_event_id, elapsed, return_value, exception)
+          AppMap::Event::MethodReturn.build_from_invocation(call_event_id, return_value, exception, elapsed: elapsed)
         end
       end
     end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'appmap/event'
+require 'appmap/hook'
+
+module AppMap
+  module Handler
+    module Rails
+      module RequestHandler
+        class HTTPServerRequest < AppMap::Event::MethodEvent
+          attr_accessor :normalized_path_info, :request_method, :path_info, :params, :mime_type, :headers, :authorization
+
+          def initialize(request)
+            super AppMap::Event.next_id_counter, :call, Thread.current.object_id
+
+            self.request_method = request.request_method
+            self.normalized_path_info = normalized_path(request)
+            self.mime_type = request.headers['Content-Type']
+            self.headers = AppMap::Util.select_headers(request.env)
+            self.authorization = request.headers['Authorization']
+            self.path_info = request.path_info.split('?')[0]
+            # ActionDispatch::Http::ParameterFilter is deprecated
+            parameter_filter_cls = \
+              if defined?(ActiveSupport::ParameterFilter)
+                ActiveSupport::ParameterFilter
+              else
+                ActionDispatch::Http::ParameterFilter
+              end
+            self.params = parameter_filter_cls.new(::Rails.application.config.filter_parameters).filter(request.params)
+          end
+
+          def to_h
+            super.tap do |h|
+              h[:http_server_request] = {
+                request_method: request_method,
+                path_info: path_info,
+                mime_type: mime_type,
+                normalized_path_info: normalized_path_info,
+                authorization: authorization,
+                headers: headers,
+              }.compact
+
+              unless params.blank?
+                h[:message] = params.keys.map do |key|
+                  val = params[key]
+                  {
+                    name: key,
+                    class: val.class.name,
+                    value: self.class.display_string(val),
+                    object_id: val.__id__,
+                  }.tap do |message|
+                    properties = object_properties(val)
+                    message[:properties] = properties if properties
+                  end
+                end
+              end
+            end
+          end
+
+          private
+
+          def normalized_path(request, router = ::Rails.application.routes.router)
+            router.recognize request do |route, _|
+              app = route.app
+              next unless app.matches? request
+              return normalized_path request, app.rack_app.routes.router if app.engine?
+
+              return route.path.spec.to_s
+            end
+          end
+        end
+
+        class HTTPServerResponse < AppMap::Event::MethodReturnIgnoreValue
+          attr_accessor :status, :mime_type, :headers
+
+          def initialize(response, parent_id, elapsed)
+            super AppMap::Event.next_id_counter, :return, Thread.current.object_id
+
+            self.status = response.status
+            self.mime_type = response.headers['Content-Type']
+            self.parent_id = parent_id
+            self.elapsed = elapsed
+            self.headers = AppMap::Util.select_headers(response.headers)
+          end
+
+          def to_h
+            super.tap do |h|
+              h[:http_server_response] = {
+                status_code: status,
+                mime_type: mime_type,
+                headers: headers
+              }.compact
+            end
+          end
+        end
+
+        class HookMethod < AppMap::Hook::Method
+          def initialize
+            # ActionController::Instrumentation has issued start_processing.action_controller and
+            # process_action.action_controller since Rails 3. Therefore it's a stable place to hook
+            # the request. Rails controller notifications can't be used directly because they don't
+            # provide response headers, and we want the Content-Type.
+            super(nil, ActionController::Instrumentation, ActionController::Instrumentation.instance_method(:process_action))
+          end
+
+          protected
+
+          def before_hook(receiver, defined_class, _) # args
+            call_event = HTTPServerRequest.new(receiver.request)
+            # 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, TIME_NOW.call ]
+          end
+
+          def after_hook(receiver, call_event, start_time, _, _) # return_value, exception
+            elapsed = TIME_NOW.call - start_time
+            return_event = HTTPServerResponse.new receiver.response, call_event.id, elapsed
+            AppMap.tracing.record_event return_event
+          end
+        end
+      end
+    end
+  end
+end