appmap 0.38.1 → 0.41.1

data/lib/appmap/config.rb

@@ -16,6 +16,10 @@ module AppMap
         end
 
         def build_from_gem(gem, shallow: true, package_name: nil, exclude: [], labels: [])
+          if %w[method_source activesupport].member?(gem)
+            warn "WARNING: #{gem} cannot be AppMapped because it is a dependency of the appmap gem"
+            return
+          end
           gem_paths(gem).map do |gem_path|
             Package.new(gem_path, gem, package_name, exclude, labels, shallow)
           end
@@ -57,32 +61,32 @@ module AppMap
     # Methods that should always be hooked, with their containing
     # package and labels that should be applied to them.
     HOOKED_METHODS = {
-      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.build_from_path('active_support', package_name: 'active_support', labels: %w[security crypto])),
-      'ActionView::Renderer' => Hook.new(:render, Package.build_from_path('action_view', package_name: 'action_view', labels: %w[view]))
+      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.build_from_path('active_support', package_name: 'active_support', labels: %w[provider.secure_compare])),
+      'ActionView::Renderer' => Hook.new(:render, Package.build_from_path('action_view', package_name: 'action_view', labels: %w[mvc.view]))
     }.freeze
 
     BUILTIN_METHODS = {
       'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGES),
-      'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGES),
       'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGES),
       'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGES),
       'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGES),
       'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGES),
-      'Net::HTTP' => Hook.new(:request, Package.build_from_path('net/http', package_name: 'net/http', labels: %w[http io])),
-      'Net::SMTP' => Hook.new(:send, Package.build_from_path('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])),
-      'Net::POP3' => Hook.new(:mails, Package.build_from_path('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])),
-      'Net::IMAP' => Hook.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[imap email io])),
-      'Marshal' => Hook.new(%i[dump load], Package.build_from_path('marshal', labels: %w[serialization marshal])),
-      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[serialization yaml])),
-      'JSON::Ext::Parser' => Hook.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json])),
-      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json])),
+      'Net::HTTP' => Hook.new(:request, Package.build_from_path('net/http', package_name: 'net/http', labels: %w[protocol.http io])),
+      'Net::SMTP' => Hook.new(:send, Package.build_from_path('net/smtp', package_name: 'net/smtp', labels: %w[protocol.smtp protocol.email io])),
+      'Net::POP3' => Hook.new(:mails, Package.build_from_path('net/pop3', package_name: 'net/pop', labels: %w[protocol.pop protocol.email io])),
+      'Net::IMAP' => Hook.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[protocol.imap protocol.email io])),
+      'Marshal' => Hook.new(%i[dump load], Package.build_from_path('marshal', labels: %w[format.marshal provider.serialization marshal])),
+      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml provider.serialization])),
+      'JSON::Ext::Parser' => Hook.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[format.json provider.serialization])),
+      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json provider.serialization])),
     }.freeze
 
-    attr_reader :name, :packages
+    attr_reader :name, :packages, :exclude
 
-    def initialize(name, packages = [])
+    def initialize(name, packages = [], exclude = [])
       @name = name
       @packages = packages
+      @exclude = exclude
     end
 
     class << self
@@ -107,42 +111,58 @@ module AppMap
           else
             [ Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow']) ]
           end
-        end.flatten
-        Config.new config_data['name'], packages
+        end.flatten.compact
+        Config.new config_data['name'], packages, config_data['exclude'] || []
       end
     end
 
     def to_h
       {
         name: name,
-        packages: packages.map(&:to_h)
+        packages: packages.map(&:to_h),
+        exclude: exclude
       }
     end
 
+    # package_for_method finds the Package, if any, which configures the hook
+    # for a method.
     def package_for_method(method)
+      package_hooked_by_class(method) || package_hooked_by_source_location(method)
+    end
+
+    def package_hooked_by_class(method)
       defined_class, _, method_name = ::AppMap::Hook.qualify_method_name(method)
-      package = find_package(defined_class, method_name)
-      return package if package
+      return find_package(defined_class, method_name)
+    end
 
+    def package_hooked_by_source_location(method)
       location = method.source_location
       location_file, = location
       return unless location_file
 
       location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
-      packages.find do |pkg|
+      packages.select { |pkg| pkg.path }.find do |pkg|
         (location_file.index(pkg.path) == 0) &&
           !pkg.exclude.find { |p| location_file.index(p) }
       end
     end
 
-    def included_by_location?(method)
-      !!package_for_method(method)
+    def never_hook?(method)
+      defined_class, separator, method_name = ::AppMap::Hook.qualify_method_name(method)
+      return true if exclude.member?(defined_class) || exclude.member?([ defined_class, separator, method_name ].join)
     end
 
+    # always_hook? indicates a method that should always be hooked.
     def always_hook?(defined_class, method_name)
       !!find_package(defined_class, method_name)
     end
 
+    # included_by_location? indicates a method whose source location matches a method definition that has been
+    # configured for inclusion.
+    def included_by_location?(method)
+      !!package_for_method(method)
+    end
+
     def find_package(defined_class, method_name)
       hook = find_hook(defined_class)
       return nil unless hook

data/lib/appmap/event.rb

@@ -38,6 +38,15 @@ module AppMap
 
         protected
 
+        # Heuristic for dynamically defined class whose name can be nil
+        def best_class_name(value)
+          value_cls = value.class
+          while value_cls.name.nil?
+            value_cls = value_cls.superclass
+          end
+          value_cls.name
+        end
+
         def custom_display_string(value)
           case value
           when File
@@ -77,6 +86,7 @@ module AppMap
 
       class << self
         def build_from_invocation(mc = MethodCall.new, defined_class, method, receiver, arguments)
+          defined_class ||= 'Class'
           mc.tap do
             static = receiver.is_a?(Module)
             mc.defined_class = defined_class
@@ -110,14 +120,14 @@ module AppMap
                 end
               {
                 name: param_name,
-                class: value.class.name,
+                class: best_class_name(value),
                 object_id: value.__id__,
                 value: display_string(value),
                 kind: param_type
               }
             end
             mc.receiver = {
-              class: receiver.class.name,
+              class: best_class_name(receiver),
               object_id: receiver.__id__,
               value: display_string(receiver)
             }
@@ -172,7 +182,7 @@ module AppMap
           mr.tap do |_|
             if return_value
               mr.return_value = {
-                class: return_value.class.name,
+                class: best_class_name(return_value),
                 value: display_string(return_value),
                 object_id: return_value.__id__
               }
@@ -183,7 +193,7 @@ module AppMap
               while next_exception
                 exception_backtrace = next_exception.backtrace_locations.try(:[], 0)
                 exceptions << {
-                  class: next_exception.class.name,
+                  class: best_class_name(next_exception),
                   message: next_exception.message,
                   object_id: next_exception.__id__,
                   path: exception_backtrace&.path,

data/lib/appmap/hook.rb

@@ -6,6 +6,9 @@ module AppMap
   class Hook
     LOG = (ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true')
 
+    OBJECT_INSTANCE_METHODS = %i[! != !~ <=> == === =~ __id__ __send__ class clone define_singleton_method display dup enum_for eql? equal? extend freeze frozen? hash inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method methods nil? object_id private_methods protected_methods public_method public_methods public_send remove_instance_variable respond_to? send singleton_class singleton_method singleton_methods taint tainted? tap then to_enum to_s to_h to_a trust untaint untrust untrusted? yield_self].freeze
+    OBJECT_STATIC_METHODS = %i[! != !~ < <= <=> == === =~ > >= __id__ __send__ alias_method allocate ancestors attr attr_accessor attr_reader attr_writer autoload autoload? class class_eval class_exec class_variable_defined? class_variable_get class_variable_set class_variables clone const_defined? const_get const_missing const_set constants define_method define_singleton_method deprecate_constant display dup enum_for eql? equal? extend freeze frozen? hash include include? included_modules inspect instance_eval instance_exec instance_method instance_methods instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method method_defined? methods module_eval module_exec name new nil? object_id prepend private_class_method private_constant private_instance_methods private_method_defined? private_methods protected_instance_methods protected_method_defined? protected_methods public_class_method public_constant public_instance_method public_instance_methods public_method public_method_defined? public_methods public_send remove_class_variable remove_instance_variable remove_method respond_to? send singleton_class singleton_class? singleton_method singleton_methods superclass taint tainted? tap then to_enum to_s trust undef_method untaint untrust untrusted? yield_self].freeze
+
     @unbound_method_arity = ::UnboundMethod.instance_method(:arity)
     @method_arity = ::Method.instance_method(:arity)
 
@@ -42,12 +45,17 @@ module AppMap
       tp = TracePoint.new(:end) do |trace_point|
         cls = trace_point.self
 
-        instance_methods = cls.public_instance_methods(false)
-        class_methods = cls.singleton_class.public_instance_methods(false) - instance_methods
+        instance_methods = cls.public_instance_methods(false) - OBJECT_INSTANCE_METHODS
+        class_methods = cls.singleton_class.public_instance_methods(false) - instance_methods - OBJECT_STATIC_METHODS
 
         hook = lambda do |hook_cls|
           lambda do |method_id|
-            method = hook_cls.public_instance_method(method_id)
+            method = begin
+              hook_cls.public_instance_method(method_id)
+            rescue NameError
+              warn "AppMap: Method #{hook_cls} #{method.name} is not accessible" if LOG
+              return
+            end
 
             warn "AppMap: Examining #{hook_cls} #{method.name}" if LOG
 
@@ -55,6 +63,8 @@ module AppMap
             # Skip methods that have no instruction sequence, as they are obviously trivial.
             next unless disasm
 
+            next if config.never_hook?(method)
+
             next unless \
               config.always_hook?(hook_cls, method.name) ||
               config.included_by_location?(method)
@@ -76,6 +86,8 @@ module AppMap
       tp.enable(&block)
     end
 
+    # hook_builtins builds hooks for code that is built in to the Ruby standard library.
+    # No TracePoint events are emitted for builtins, so a separate hooking mechanism is needed. 
     def hook_builtins
       return unless self.class.lock_builtins
 
@@ -89,6 +101,7 @@ module AppMap
         require hook.package.package_name if hook.package.package_name
         Array(hook.method_names).each do |method_name|
           method_name = method_name.to_sym
+
           cls = class_from_string.(class_name)
           method = \
             begin
@@ -97,6 +110,8 @@ module AppMap
               cls.method(method_name) rescue nil
             end
 
+          next if config.never_hook?(method)
+
           if method
             Hook::Method.new(hook.package, cls, method).activate
           else

data/lib/appmap/rails/request_handler.rb

@@ -7,12 +7,13 @@ module AppMap
   module Rails
     module RequestHandler
       class HTTPServerRequest < AppMap::Event::MethodEvent
-        attr_accessor :request_method, :path_info, :params
+        attr_accessor :normalized_path_info, :request_method, :path_info, :params
 
         def initialize(request)
           super AppMap::Event.next_id_counter, :call, Thread.current.object_id
 
           @request_method = request.request_method
+          @normalized_path_info = normalized_path request
           @path_info = request.path_info.split('?')[0]
           # ActionDispatch::Http::ParameterFilter is deprecated
           parameter_filter_cls = \
@@ -28,8 +29,9 @@ module AppMap
           super.tap do |h|
             h[:http_server_request] = {
               request_method: request_method,
-              path_info: path_info
-            }
+              path_info: path_info,
+              normalized_path_info: normalized_path_info
+            }.compact
 
             h[:message] = params.keys.map do |key|
               val = params[key]
@@ -42,6 +44,18 @@ module AppMap
             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

data/lib/appmap/railtie.rb

@@ -5,13 +5,9 @@ module AppMap
   class Railtie < ::Rails::Railtie
     config.appmap = ActiveSupport::OrderedOptions.new
 
-    initializer 'appmap.init' do |_| # params: app
-      require 'appmap'
-    end
-
     # appmap.subscribe subscribes to ActiveSupport Notifications so that they can be recorded as
     # AppMap events.
-    initializer 'appmap.subscribe', after: 'appmap.init' do |_| # params: app
+    initializer 'appmap.subscribe' do |_| # params: app
       require 'appmap/rails/sql_handler'
       require 'appmap/rails/request_handler'
       ActiveSupport::Notifications.subscribe 'sql.sequel', AppMap::Rails::SQLHandler.new

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.38.1'
+  VERSION = '0.41.1'
 
-  APPMAP_FORMAT_VERSION = '1.3'
+  APPMAP_FORMAT_VERSION = '1.4'
 end

data/spec/abstract_controller_base_spec.rb

@@ -1,120 +1,150 @@
 require 'rails_spec_helper'
 
 describe 'AbstractControllerBase' do
-  shared_examples 'rails version' do |rails_major_version|
-    include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" do
+  %w[5 6].each do |rails_major_version| # rubocop:disable Metrics/BlockLength
+    context "in Rails #{rails_major_version}" do
+      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app"
       def run_spec(spec_name)
-        cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}"
+        FileUtils.rm_rf tmpdir
+        FileUtils.mkdir_p tmpdir
+        cmd = <<~CMD.gsub "\n", ' '
+          docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true
+          -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
+        CMD
         run_cmd cmd, chdir: fixture_dir
       end
 
-      before do
-        FileUtils.rm_rf tmpdir
-        FileUtils.mkdir_p tmpdir
-        run_spec spec_name
+      def tmpdir
+        'tmp/spec/AbstractControllerBase'
       end
 
-      let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+      let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
+      let(:events) { appmap['events'] }
 
       describe 'testing with rspec' do
-        let(:spec_name) { 'spec/controllers/users_controller_api_spec.rb:8' }
-        let(:appmap_json_file) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
-
         describe 'creating a user' do
+          before(:all) { run_spec 'spec/controllers/users_controller_api_spec.rb:8' }
+          let(:appmap_json_file) do
+            'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
+          end
+
           it 'inventory file is printed' do
             expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
           end
 
           it 'message fields are recorded in the appmap' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file)).to_yaml
-
-            expect(appmap).to include(<<-MESSAGE.strip)
-  message:
-  - name: login
-    class: String
-    value: alice
-    object_id:
-            MESSAGE
-
-            expect(appmap).to include(<<-MESSAGE.strip)
-  - name: password
-    class: String
-    value: "[FILTERED]"
-    object_id:
-            MESSAGE
-
-            expect(appmap).to include(<<-SERVER_REQUEST.strip)
-  http_server_request:
-    request_method: POST
-    path_info: "/api/users"
-            SERVER_REQUEST
-
-            expect(appmap).to include(<<-SERVER_RESPONSE.strip)
-  http_server_response:
-    status: 201
-    mime_type: application/json; charset=utf-8
-            SERVER_RESPONSE
+            expect(events).to include(
+              hash_including(
+                'http_server_request' => hash_including(
+                  'request_method' => 'POST',
+                  'path_info' => '/api/users'
+                ),
+                'message' => include(
+                  hash_including(
+                    'name' => 'login',
+                    'class' => 'String',
+                    'value' => 'alice',
+                    'object_id' => Integer
+                  ),
+                  hash_including(
+                    'name' => 'password',
+                    'class' => 'String',
+                    'value' => '[FILTERED]',
+                    'object_id' => Integer
+                  )
+                )
+              ),
+              hash_including(
+                'http_server_response' => {
+                  'status' => 201,
+                  'mime_type' => 'application/json; charset=utf-8'
+                }
+              )
+            )
           end
 
           it 'properly captures method parameters in the appmap' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file)).to_yaml
-
-            expect(appmap).to match(<<-CREATE_CALL.strip)
-  event: call
-  thread_id: .*
-  defined_class: Api::UsersController
-  method_id: build_user
-  path: app/controllers/api/users_controller.rb
-  lineno: 23
-  static: false
-  parameters:
-  - name: params
-    class: ActiveSupport::HashWithIndifferentAccess
-    object_id: .*
-    value: '{"login"=>"alice"}'
-    kind: req
-  receiver:
-            CREATE_CALL
+            expect(events).to include hash_including(
+              'event' => 'call',
+              'thread_id' => Integer,
+              'defined_class' => 'Api::UsersController',
+              'method_id' => 'build_user',
+              'path' => 'app/controllers/api/users_controller.rb',
+              'lineno' => 23,
+              'static' => false,
+              'parameters' => include(
+                'name' => 'params',
+                'class' => 'ActiveSupport::HashWithIndifferentAccess',
+                'object_id' => Integer,
+                'value' => '{"login"=>"alice"}',
+                'kind' => 'req'
+              ),
+              'receiver' => anything
+            )
           end
 
           it 'returns a minimal event' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file))
-            event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
-            expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+            expect(events).to include hash_including(
+              'event' => 'return',
+              'return_value' => Hash,
+              'id' => Integer,
+              'thread_id' => Integer,
+              'parent_id' => Integer,
+              'elapsed' => Numeric
+            )
           end
         end
 
-        describe 'listing users' do
-          let(:spec_name) { 'spec/controllers/users_controller_spec.rb:11' }
-          let(:appmap_json_file) { File.join(tmpdir, 'appmap/rspec/UsersController_GET_users_lists_the_users.appmap.json') }
-          it 'records and labels view rendering' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file)).to_yaml
+        describe 'showing a user' do
+          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:22' }
+          let(:appmap_json_file) do
+            'UsersController_GET_users_login_shows_the_user.appmap.json'
+          end
 
-            expect(appmap).to match(<<-VIEW_CALL.strip)
-  event: call
-  thread_id: .*
-  defined_class: ActionView::Renderer
-  method_id: render
-  path: .*
-  lineno: .*
-  static: false
-            VIEW_CALL
+          it 'records the normalized path info' do
+            expect(events).to include(
+              hash_including(
+                'http_server_request' => {
+                  'request_method' => 'GET',
+                  'path_info' => '/users/alice',
+                  'normalized_path_info' => '/users/:id(.:format)'
+                }
+              )
+            )
+          end
+        end
 
-            expect(appmap).to match(<<-VIEW_LABEL.strip)
-        labels:
-        - view
-            VIEW_LABEL
+        describe 'listing users' do
+          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:11' }
+          let(:appmap_json_file) { 'UsersController_GET_users_lists_the_users.appmap.json' }
+
+          it 'records and labels view rendering' do
+            expect(events).to include hash_including(
+              'event' => 'call',
+              'thread_id' => Numeric,
+              'defined_class' => 'ActionView::Renderer',
+              'method_id' => 'render',
+              'path' => String,
+              'lineno' => Integer,
+              'static' => false
+            )
+
+            expect(appmap['classMap']).to include hash_including(
+              'name' => 'action_view',
+              'children' => include(hash_including(
+                'name' => 'ActionView',
+                'children' => include(hash_including(
+                  'name' => 'Renderer',
+                  'children' => include(hash_including(
+                    'name' => 'render',
+                    'labels' => ['mvc.view']
+                  ))
+                ))
+              ))
+            )
           end
         end
       end
     end
   end
-
-  %w[5 6].each do |version|
-    it_behaves_like 'rails version', version
-  end
 end