appmap 0.65.1 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c93c7dbd38cd355d2512f43d177243bba4c184e81c588bf2f99e3b7d2426f4
-  data.tar.gz: 3dd70314c48d4df781dcda082fb293260d04725228e66c4c3323ebdcb09ea35a
+  metadata.gz: 1eecc28364d2832ecd593baed1c12a82d11bcd7f48945bebb59acd1d1830c254
+  data.tar.gz: ae096b7623cf2c59d9978b7d72676b797e2f7276adf2296d864434bea2a33605
 SHA512:
-  metadata.gz: bea8dc7d3e1f05cca6ae264b7b0cf8ab6cdddfd366c59f09131c9c98cd12989e2878f276fc01360166ccee6c16b040b6ecd3aa8c6e913407bbd93d4bb1928862
-  data.tar.gz: 5a798b37f59f39f70e69398e0d64353f66baf4b55000b45dc951be27830b04f36d17c2fe58bc4f5e86fdab368c056b90834c15a21f438535f8403ec437758d8d
+  metadata.gz: 29f8d31824e2faf890cb35e895d5d165d5f083238f3a89aac00c95b8ac00289ca9647eaa4dc01a5b197f68f511f270a0d8f4f3fd6b4470be1d63df4cbda9274e
+  data.tar.gz: b59fc7043f6eb31af9680cccb104fb1dfe7f6370275b28f3ee4e7edc1070e85fd9828c2d681458b6812bc2feba323bb18508628ecdaea175d2e9947f06f48cba

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [0.66.0](https://github.com/applandinc/appmap-ruby/compare/v0.65.1...v0.66.0) (2021-09-28)
+
+
+### Features
+
+* Add option for explicit 'require' in function config ([1cf6c2a](https://github.com/applandinc/appmap-ruby/commit/1cf6c2aed8ee2d89c900f2959484b88b6fd3eb93))
+* Builtin code such as Ruby Logger can be hooked via appmap.yml ([779c9e5](https://github.com/applandinc/appmap-ruby/commit/779c9e5e4177d58ea7b63e663e7c5a0810a78c60))
+
 ## [0.65.1](https://github.com/applandinc/appmap-ruby/compare/v0.65.0...v0.65.1) (2021-09-16)
 
 

data/lib/appmap/config.rb

@@ -117,13 +117,15 @@ module AppMap
     # entry in appmap.yml. When the Config is initialized, each Function is converted into
     # a Package and TargetMethods. It's called a Function rather than a Method, because Function
     # is the AppMap terminology.
-    Function = Struct.new(:package, :cls, :labels, :function_names) do # :nodoc:
+    Function = Struct.new(:package, :cls, :labels, :function_names, :builtin, :package_name) do # :nodoc:
       def to_h
         {
           package: package,
+          package_name: package_name,
           class: cls,
           labels: labels,
-          functions: function_names.map(&:to_sym)
+          functions: function_names.map(&:to_sym),
+          builtin: builtin
         }.compact
       end
     end
@@ -244,7 +246,7 @@ module AppMap
       @depends_config = depends_config
       @hook_paths = Set.new(packages.map(&:path))
       @exclude = exclude
-      @builtin_hooks = BUILTIN_HOOKS
+      @builtin_hooks = BUILTIN_HOOKS.dup
       @functions = functions
 
       @hooked_methods = METHOD_HOOKS.each_with_object(Hash.new { |h,k| h[k] = [] }) do |cls_target_methods, hooked_methods|
@@ -254,7 +256,15 @@ module AppMap
       functions.each do |func|
         package_options = {}
         package_options[:labels] = func.labels if func.labels
-        @hooked_methods[func.cls] << TargetMethods.new(func.function_names, Package.build_from_path(func.package, **package_options))
+        package_options[:package_name] = func.package_name
+        package_options[:package_name] ||= func.package if func.builtin
+        hook = TargetMethods.new(func.function_names, Package.build_from_path(func.package, **package_options))
+        if func.builtin
+          @builtin_hooks[func.cls] ||= []
+          @builtin_hooks[func.cls] << hook
+        else
+          @hooked_methods[func.cls] << hook
+        end
       end
 
       @hooked_methods.each_value do |hooks|
@@ -300,6 +310,7 @@ module AppMap
           MISSING_FILE_MSG
           {}
         end
+
         load(config_data).tap do |config|
           config_yaml = {
             'name' => config.name,
@@ -324,15 +335,22 @@ module AppMap
 
         if config_data['functions']
           config_params[:functions] = config_data['functions'].map do |function_data|
-            package = function_data['package']
-            cls = function_data['class']
-            functions = function_data['function'] || function_data['functions']
-            raise %q(AppMap config 'function' element should specify 'package', 'class' and 'function' or 'functions') unless package && cls && functions
+            function_name = function_data['name']
+            package, cls, functions = []
+            if function_name
+              package, cls, _, function = Util.parse_function_name(function_name)
+              functions = Array(function)
+            else
+              package = function_data['package']
+              cls = function_data['class']
+              functions = function_data['function'] || function_data['functions']
+              raise %q(AppMap config 'function' element should specify 'package', 'class' and 'function' or 'functions') unless package && cls && functions
+            end
 
             functions = Array(functions).map(&:to_sym)
             labels = function_data['label'] || function_data['labels']
             labels = Array(labels).map(&:to_s) if labels
-            Function.new(package, cls, labels, functions)
+            Function.new(package, cls, labels, functions, function_data['builtin'], function_data['require'])
           end
         end
 

data/lib/appmap/hook.rb

@@ -89,7 +89,7 @@ module AppMap
 
       config.builtin_hooks.each do |class_name, hooks|
         Array(hooks).each do |hook|
-          require hook.package.package_name if hook.package.package_name
+          require hook.package.package_name if hook.package.package_name && hook.package.package_name != 'ruby'
           Array(hook.method_names).each do |method_name|
             method_name = method_name.to_sym
             base_cls = class_from_string.(class_name)

data/lib/appmap/util.rb

@@ -21,6 +21,16 @@ module AppMap
     WHITE   = "\e[37m"
 
     class << self
+      def parse_function_name(name)
+        package_tokens = name.split('/')
+
+        class_and_name = package_tokens.pop
+        class_name, function_name, static = class_and_name.include?('.') ? class_and_name.split('.', 2) + [ true ] : class_and_name.split('#', 2) + [ false ]
+
+        raise "Malformed fully-qualified function name #{name}" unless function_name
+        [ package_tokens.empty? ? 'ruby' : package_tokens.join('/'), class_name, static, function_name ]
+      end
+
       # scenario_filename builds a suitable file name from a scenario name.
       # Special characters are removed, and the file name is truncated to fit within
       # shell limitations.

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.65.1'
+  VERSION = '0.66.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/spec/config_spec.rb

@@ -55,6 +55,34 @@ describe AppMap::Config, docker: false do
     expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
 
+  it 'interprets a function in canonical name format' do
+    config_data = {
+      name: 'test',
+      packages: [],
+      functions: [
+        {
+          name: 'pkg/cls#fn',
+        }
+      ]
+    }.deep_stringify_keys!
+    config = AppMap::Config.load(config_data)
+
+    config_expectation = {
+      exclude: [],
+      name: 'test',
+      packages: [],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          functions: [ :fn ],
+        }
+      ]
+    }.deep_stringify_keys!
+
+    expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
+  end
+
   context do
     let(:warnings) { @warnings ||= [] }
     let(:warning) { warnings.join }

data/spec/fixtures/rails5_users_app/appmap.yml

@@ -5,3 +5,7 @@ packages:
   - path: app/controllers
     labels: [ mvc.controller ]
   - gem: sequel
+functions:
+  - name: logger/Logger::LogDevice#write
+    builtin: true
+    label: log

data/spec/fixtures/rails6_users_app/appmap.yml

@@ -5,6 +5,10 @@ packages:
   - path: app/controllers
     labels: [ mvc.controller ]
   - gem: sequel
+functions:
+  - name: logger/Logger::LogDevice#write
+    builtin: true
+    label: log
 swagger:
   project_version: 1.1.0
   output_dir: tmp/swagger

data/spec/rails_recording_spec.rb

@@ -1,7 +1,11 @@
 require 'rails_spec_helper'
 
+def default_rails_versions
+  ruby_2? ? [ 5, 6 ] : [ 6 ]
+end
+
 # Rails5 doesn't work with Ruby 3.x
-RailsVersions = ruby_2? ? [ 5, 6 ] : [ 6 ]
+RailsVersions = ENV['RAILS_VERSIONS'] || default_rails_versions
 
 describe 'Rails' do
   RailsVersions.each do |rails_major_version| # rubocop:disable Metrics/BlockLength
@@ -91,6 +95,15 @@ describe 'Rails' do
             )
           end
 
+          it 'captures log events' do
+            expect(events).to include hash_including(
+              'event' => 'call',
+              'defined_class' => 'Logger::LogDevice',
+              'method_id' => 'write',
+              'static' => false
+            )
+          end
+
           context 'with an object-style message' do
             let(:appmap_json_file) { 'Api_UsersController_POST_api_users_with_required_parameters_with_object-style_parameters_creates_a_user.appmap.json' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.65.1
+  version: 0.66.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport