appmap 0.37.2 → 0.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0211b21334945f6786d150fdf1a0dea8a062cbc2d59c4b347f72555232ec6480
-  data.tar.gz: ac2785471ed35210ba1c3801e8a7d186adb99d9b9369c24eb2c9f4d41a352e33
+  metadata.gz: 0255347aa61c6f39bfec0f43a78b3cc3060bd20e4f80f1e39e0ff3714a52dff3
+  data.tar.gz: 822bc2fe118426d6d9c9437c85ead8e603a446cabd6bd49d0053c2b1cfaf3789
 SHA512:
-  metadata.gz: d5049f8c464b5f6e6afd7567fcfe62d481c70b7db6d473f93a832763e4352c04b6d2cff3d3d03a452f82033f4220cb821f36152c003794c7adba89432a2b513a
-  data.tar.gz: 631f8ab86e132e45c1b95b667d7789b870eab393293d62c7e1f77daf3cf3f9a5c7174e913fa0bc20ec92a87f88f278bee69f41c6b2c14d166b1745df71321d0b
+  metadata.gz: 031534a5eb015fa99d6ad161665b131677cadbe41ed1bce20357cb1ded7ba19e5f0bcbe37cfef0c8ad35cc2904fe83e4cc9d2b12d04260b970d24cc9aea64ba3
+  data.tar.gz: e7996262f4da21936567c1238df624220987ed04bf5aebd9a525da4d3f181ca752c1060056a5bb41b52c9cdb29e958cf7335973ac7076113278c7e8583755477

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.38.1
+
+* Package configuration can be `shallow`, in case which only the initial entry into the package is recorded.
+
 # v0.37.2
 * Fix ParameterFilter deprecation warning.
 

data/README.md

@@ -93,6 +93,9 @@ Each entry in the `packages` list is a YAML object which has the following keys:
 * **gem** As an alternative to specifying the path, specify the name of a dependency gem. When using `gem`, don't specify `path`.
 * **exclude** A list of files and directories which will be ignored. By default, all modules, classes and public
   functions are inspected.
+* **shallow** When set to `true`, only the first function call entry into a package will be recorded. Subsequent function calls within 
+  the same package are not recorded unless code execution leaves the package and re-enters it. Default: `true` when using `gem`,
+  `false` when using `path`.
 
 # Running
 

data/lib/appmap/config.rb

@@ -2,15 +2,22 @@
 
 module AppMap
   class Config
-    Package = Struct.new(:path, :gem, :package_name, :exclude, :labels) do
+    Package = Struct.new(:path, :gem, :package_name, :exclude, :labels, :shallow) do
+      # Indicates that only the entry points to a package will be recorded.
+      # Once the code has entered a package, subsequent calls within the package will not be
+      # recorded unless the code leaves the package and re-enters it.
+      def shallow?
+        shallow
+      end
+
       class << self
-        def build_from_path(path, package_name: nil, exclude: [], labels: [])
-          Package.new(path, nil, package_name, exclude, labels)
+        def build_from_path(path, shallow: false, package_name: nil, exclude: [], labels: [])
+          Package.new(path, nil, package_name, exclude, labels, shallow)
         end
 
-        def build_from_gem(gem, package_name: nil, exclude: [], labels: [])
+        def build_from_gem(gem, shallow: true, package_name: nil, exclude: [], labels: [])
           gem_paths(gem).map do |gem_path|
-            Package.new(gem_path, gem, package_name, exclude, labels)
+            Package.new(gem_path, gem, package_name, exclude, labels, shallow)
           end
         end
 
@@ -36,7 +43,8 @@ module AppMap
           package_name: package_name,
           gem: gem,
           exclude: exclude.blank? ? nil : exclude,
-          labels: labels.blank? ? nil : labels
+          labels: labels.blank? ? nil : labels,
+          shallow: shallow
         }.compact
       end
     end
@@ -49,7 +57,8 @@ 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]))
+      '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]))
     }.freeze
 
     BUILTIN_METHODS = {
@@ -66,7 +75,7 @@ module AppMap
       '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]))
+      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json])),
     }.freeze
 
     attr_reader :name, :packages
@@ -91,9 +100,12 @@ module AppMap
           raise 'AppMap package configuration should specify gem or path, not both' if gem && path
 
           if gem
-            Package.build_from_gem(gem, exclude: package['exclude'] || [])
+            shallow = package['shallow']
+            # shallow is true by default for gems
+            shallow = true if shallow.nil?
+            Package.build_from_gem(gem, exclude: package['exclude'] || [], shallow: shallow)
           else
-            [ Package.build_from_path(path, exclude: package['exclude'] || []) ]
+            [ Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow']) ]
           end
         end.flatten
         Config.new config_data['name'], packages

data/lib/appmap/hook/method.rb

@@ -39,6 +39,7 @@ module AppMap
         end
 
         defined_class = @defined_class
+        hook_package = self.hook_package
         hook_method = self.hook_method
         before_hook = self.method(:before_hook)
         after_hook = self.method(:after_hook)
@@ -48,29 +49,34 @@ module AppMap
         hook_class.instance_eval do 
           hook_method_def = Proc.new do |*args, &block|
             instance_method = hook_method.bind(self).to_proc
+            call_instance_method = -> { instance_method.call(*args, &block) }
 
             # We may not have gotten the class for the method during
             # initialization (e.g. for a singleton method on an embedded
             # struct), so make sure we have it now.
-            defined_class,_ = Hook.qualify_method_name(hook_method) unless defined_class
+            defined_class, = Hook.qualify_method_name(hook_method) unless defined_class
 
-            hook_disabled = Thread.current[HOOK_DISABLE_KEY]
-            enabled = true if !hook_disabled && AppMap.tracing.enabled?
-            return instance_method.call(*args, &block) unless enabled
+            reentrant = Thread.current[HOOK_DISABLE_KEY]
+            disabled_by_shallow_flag = \
+              -> { hook_package&.shallow? && AppMap.tracing.last_package_for_current_thread == hook_package }
 
-            call_event, start_time = with_disabled_hook.() do
-              before_hook.(self, defined_class, args)
+            enabled = true if AppMap.tracing.enabled? && !reentrant && !disabled_by_shallow_flag.call
+
+            return call_instance_method.call unless enabled
+
+            call_event, start_time = with_disabled_hook.call do
+              before_hook.call(self, defined_class, args)
             end
             return_value = nil
             exception = nil
             begin
-              return_value = instance_method.(*args, &block)
+              return_value = call_instance_method.call
             rescue
               exception = $ERROR_INFO
               raise
             ensure
-              with_disabled_hook.() do
-                after_hook.(self, call_event, start_time, return_value, exception)
+              with_disabled_hook.call do
+                after_hook.call(self, call_event, start_time, return_value, exception)
               end
             end
           end
@@ -87,7 +93,7 @@ module AppMap
         [ call_event, TIME_NOW.call ]
       end
 
-      def after_hook(receiver, call_event, start_time, return_value, exception)
+      def after_hook(_receiver, call_event, start_time, return_value, exception)
         require 'appmap/event'
         elapsed = TIME_NOW.call - start_time
         return_event = \
@@ -95,12 +101,12 @@ module AppMap
         AppMap.tracing.record_event return_event
       end
 
-      def with_disabled_hook(&fn)
+      def with_disabled_hook(&function)
         # Don't record functions, such as to_s and inspect, that might be called
         # by the fn. Otherwise there can be a stack overflow.
         Thread.current[HOOK_DISABLE_KEY] = true
         begin
-          fn.call
+          function.call
         ensure
           Thread.current[HOOK_DISABLE_KEY] = false
         end

data/lib/appmap/trace.rb

@@ -15,34 +15,38 @@ module AppMap
 
     class Tracing
       def initialize
-        @tracing = []
+        @tracers = []
       end
 
       def empty?
-        @tracing.empty?
+        @tracers.empty?
       end
 
       def trace(enable: true)
         Tracer.new.tap do |tracer|
-          @tracing << tracer
+          @tracers << tracer
           tracer.enable if enable
         end
       end
 
       def enabled?
-        @tracing.any?(&:enabled?)
+        @tracers.any?(&:enabled?)
+      end
+
+      def last_package_for_current_thread
+        @tracers.first&.last_package_for_current_thread
       end
 
       def record_event(event, package: nil, defined_class: nil, method: nil)
-        @tracing.each do |tracer|
+        @tracers.each do |tracer|
           tracer.record_event(event, package: package, defined_class: defined_class, method: method)
         end
       end
 
       def delete(tracer)
-        return unless @tracing.member?(tracer)
+        return unless @tracers.member?(tracer)
 
-        @tracing.delete(tracer)
+        @tracers.delete(tracer)
         tracer.disable
       end
     end
@@ -52,6 +56,7 @@ module AppMap
     # Records the events which happen in a program.
     def initialize
       @events = []
+      @last_package_for_thread = {}
       @methods = Set.new
       @enabled = false
     end
@@ -75,11 +80,17 @@ module AppMap
     def record_event(event, package: nil, defined_class: nil, method: nil)
       return unless @enabled
 
+      @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event
       @methods << Trace::ScopedMethod.new(package, defined_class, method, event.static) \
         if package && defined_class && method && (event.event == :call)
     end
 
+    # Gets the last package which was observed on the current thread.
+    def last_package_for_current_thread
+      @last_package_for_thread[Thread.current.object_id]
+    end
+
     # Gets a unique list of the methods that were invoked by the program.
     def event_methods
       @methods.to_a

data/lib/appmap/version.rb

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

data/spec/abstract_controller_base_spec.rb

@@ -3,60 +3,65 @@ 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
-      around(:each) do |example|
-        FileUtils.rm_rf tmpdir
-        FileUtils.mkdir_p tmpdir
-        cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+      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}"
         run_cmd cmd, chdir: fixture_dir
+      end
 
-        example.run
+      before do
+        FileUtils.rm_rf tmpdir
+        FileUtils.mkdir_p tmpdir
+        run_spec spec_name
       end
 
       let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
-      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
       describe 'testing with rspec' do
-        it 'inventory file is printed' do
-          expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
-        end
+        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') }
 
-        it 'message fields are recorded in the appmap' do
-          expect(File).to exist(appmap_json)
-          appmap = JSON.parse(File.read(appmap_json)).to_yaml
+        describe 'creating a user' do
+          it 'inventory file is printed' do
+            expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
+          end
 
-          expect(appmap).to include(<<-MESSAGE.strip)
+          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
+            MESSAGE
 
-          expect(appmap).to include(<<-MESSAGE.strip)
+            expect(appmap).to include(<<-MESSAGE.strip)
   - name: password
     class: String
     value: "[FILTERED]"
     object_id:
-          MESSAGE
+            MESSAGE
 
-          expect(appmap).to include(<<-SERVER_REQUEST.strip)
+            expect(appmap).to include(<<-SERVER_REQUEST.strip)
   http_server_request:
     request_method: POST
     path_info: "/api/users"
-          SERVER_REQUEST
+            SERVER_REQUEST
 
-          expect(appmap).to include(<<-SERVER_RESPONSE.strip)
+            expect(appmap).to include(<<-SERVER_RESPONSE.strip)
   http_server_response:
     status: 201
     mime_type: application/json; charset=utf-8
-          SERVER_RESPONSE
-        end
+            SERVER_RESPONSE
+          end
 
-        it 'properly captures method parameters in the appmap' do
-          expect(File).to exist(appmap_json)
-          appmap = JSON.parse(File.read(appmap_json)).to_yaml
+          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)
+            expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
   thread_id: .*
   defined_class: Api::UsersController
@@ -71,19 +76,45 @@ describe 'AbstractControllerBase' do
     value: '{"login"=>"alice"}'
     kind: req
   receiver:
-          CREATE_CALL
+            CREATE_CALL
+          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])
+          end
         end
 
-        it 'returns a minimal event' do
-          expect(File).to exist(appmap_json)
-          appmap = JSON.parse(File.read(appmap_json))
-          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])
+        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
+
+            expect(appmap).to match(<<-VIEW_CALL.strip)
+  event: call
+  thread_id: .*
+  defined_class: ActionView::Renderer
+  method_id: render
+  path: .*
+  lineno: .*
+  static: false
+            VIEW_CALL
+
+            expect(appmap).to match(<<-VIEW_LABEL.strip)
+        labels:
+        - view
+            VIEW_LABEL
+          end
         end
       end
     end
   end
 
-  it_behaves_like 'rails version', '5'
-  it_behaves_like 'rails version', '6'
+  %w[5 6].each do |version|
+    it_behaves_like 'rails version', version
+  end
 end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-gem 'rails', '~> 6'
+gem 'rails', '~> 5'
 
 gem 'haml-rails'
 

data/spec/fixtures/rails5_users_app/appmap.yml

@@ -1,3 +1,4 @@
 name: rails5_users_app
 packages:
   - path: app
+  - gem: sequel

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_api_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       post :create, params: { login: 'alice' }
     end
     it 'lists the users' do
-      post :index, params: {}
+      get :index, params: {}
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,16 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe UsersController, type: :controller do
+  render_views
+
+  describe 'GET /users', feature: 'Show all users' do
+    before do
+      User.create login: 'alice'
+    end
+    it 'lists the users' do
+      get :index
+      expect(response).to be_ok
+    end
+  end
+end

data/spec/fixtures/rails6_users_app/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '~> 5.2.3'
+gem 'rails', '~> 6'
 
 gem 'haml-rails'
 

data/spec/fixtures/rails6_users_app/appmap.yml

@@ -1,3 +1,5 @@
 name: rails6_users_app
 packages:
   - path: app
+  - gem: sequel
+

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_api_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       post :create, params: { login: 'alice' }
     end
     it 'lists the users' do
-      post :index, params: {}
+      get :index, params: {}
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -0,0 +1,16 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe UsersController, type: :controller do
+  render_views
+
+  describe 'GET /users', feature: 'Show all users' do
+    before do
+      User.create login: 'alice'
+    end
+    it 'lists the users' do
+      get :index
+      expect(response).to be_ok
+    end
+  end
+end

data/spec/hook_spec.rb

@@ -52,9 +52,9 @@ describe 'AppMap class Hooking', docker: false do
 
     events = collect_events(tracer).to_yaml
 
-    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('') if events_yaml
 
-    [ config, tracer ]
+    [ config, tracer, events ]
   end
 
   after do
@@ -741,9 +741,33 @@ describe 'AppMap class Hooking', docker: false do
           :value: 'true'
       YAML
 
-      test_hook_behavior 'spec/fixtures/hook/compare.rb', events_yaml do
+      _, _, events = test_hook_behavior 'spec/fixtures/hook/compare.rb', nil do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
+      secure_compare_event = YAML.load(events).find { |evt| evt[:defined_class] == 'ActiveSupport::SecurityUtils' }
+      secure_compare_event.delete(:lineno)
+
+      expect(Diffy::Diff.new(<<~YAML, secure_compare_event.to_yaml).to_s).to eq('')
+      ---
+      :id: 2
+      :event: :call
+      :defined_class: ActiveSupport::SecurityUtils
+      :method_id: secure_compare
+      :path: lib/active_support/security_utils.rb
+      :static: true
+      :parameters:
+      - :name: :a
+        :class: String
+        :value: string
+        :kind: :req
+      - :name: :b
+        :class: String
+        :value: string
+        :kind: :req
+      :receiver:
+        :class: Module
+        :value: ActiveSupport::SecurityUtils
+      YAML
     end
 
     it 'gets labeled in the classmap' do
@@ -806,16 +830,14 @@ describe 'AppMap class Hooking', docker: false do
               - crypto
       YAML
 
-      config, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
+      _, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
       cm = AppMap::Util.sanitize_paths(AppMap::ClassMap.build_from_methods(tracer.event_methods))
       entry = cm[1][:children][0][:children][0][:children][0]
       # Sanity check, make sure we got the right one
       expect(entry[:name]).to eq('secure_compare')
-      spec = Gem::Specification.find_by_name('activesupport')
-      entry[:location].gsub!(spec.base_dir + '/', '')
-      expect(Diffy::Diff.new(classmap_yaml, cm.to_yaml).to_s).to eq('')
+      expect(entry[:labels]).to eq(%w[security crypto])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.37.2
+  version: 0.38.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -527,6 +527,7 @@ files:
 - spec/fixtures/rails5_users_app/log/.keep
 - spec/fixtures/rails5_users_app/public/robots.txt
 - spec/fixtures/rails5_users_app/spec/controllers/users_controller_api_spec.rb
+- spec/fixtures/rails5_users_app/spec/controllers/users_controller_spec.rb
 - spec/fixtures/rails5_users_app/spec/models/user_spec.rb
 - spec/fixtures/rails5_users_app/spec/rails_helper.rb
 - spec/fixtures/rails5_users_app/spec/spec_helper.rb
@@ -598,6 +599,7 @@ files:
 - spec/fixtures/rails6_users_app/log/.keep
 - spec/fixtures/rails6_users_app/public/robots.txt
 - spec/fixtures/rails6_users_app/spec/controllers/users_controller_api_spec.rb
+- spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb
 - spec/fixtures/rails6_users_app/spec/models/user_spec.rb
 - spec/fixtures/rails6_users_app/spec/rails_helper.rb
 - spec/fixtures/rails6_users_app/spec/spec_helper.rb