appmap 0.42.1 → 0.46.0

data/spec/config_spec.rb

@@ -17,10 +17,42 @@ describe AppMap::Config, docker: false do
           path: 'path-2',
           exclude: [ 'exclude-1' ]
         }
+      ],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          function: 'fn',
+          label: 'lbl'
+        }
       ]
     }.deep_stringify_keys!
     config = AppMap::Config.load(config_data)
 
-    expect(config.to_h.deep_stringify_keys!).to eq(config_data)
+    config_expectation = {
+      exclude: [],
+      name: 'test',
+      packages: [
+        {
+          path: 'path-1',
+          handler_class: 'AppMap::Handler::Function'
+        },
+        {
+          path: 'path-2',
+          handler_class: 'AppMap::Handler::Function',
+          exclude: [ 'exclude-1' ]
+        }
+      ],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          functions: [ :fn ],
+          labels: ['lbl']
+        }
+      ]
+    }.deep_stringify_keys!
+
+    expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
 end

data/spec/fixtures/hook/custom_instance_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CustomInstanceMethod
+  def to_s
+    'CustomInstance Method fixture'
+  end
+
+  def say_default
+    'default'
+  end
+end

data/spec/fixtures/hook/method_named_call.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class MethodNamedCall
+  def to_s
+    'MethodNamedCall'
+  end
+
+  def call(a, b, c, d, e)
+    [ a, b, c, d, e ].join(' ')
+  end
+end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -39,12 +39,16 @@ group :development, :test do
   gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
-  # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
-  # isn't activated.
-  gem 'database_cleaner'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'pry-byebug'
 end
 
+group :test do
+  # Require only one of these.
+  # 'database_cleaner' requries 'database_cleaner-active_record', so don't require it.
+  gem 'database_cleaner-active_record', require: false
+  gem 'database_cleaner-sequel', require: false
+end
+
 group :development do
 end

data/spec/fixtures/rails5_users_app/app/controllers/api/users_controller.rb

@@ -6,6 +6,8 @@ module Api
     end
 
     def create
+      params = self.params.key?(:user) ? self.params[:user] : self.params
+      
       @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {

data/spec/fixtures/rails5_users_app/app/controllers/users_controller.rb

@@ -4,7 +4,15 @@ class UsersController < ApplicationController
   end
 
   def show
-    if (@user = User[login: params[:id]])
+    find_user = lambda do |id|
+      if User.respond_to?(:[])
+        User[login: id]
+      else
+        User.find_by_login!(id)
+      end
+    end
+
+    if (@user = find_user.(params[:id]))
       render plain: @user
     else
       render plain: 'Not found', status: 404

data/spec/fixtures/rails5_users_app/config/application.rb

@@ -15,8 +15,10 @@ case orm_module
 when 'sequel'
   require 'sequel-rails'
   require 'sequel_secure_password'
+  require 'database_cleaner-sequel' if Rails.env.test?
 when 'activerecord'
   require 'active_record/railtie'
+  require 'database_cleaner-active_record' if Rails.env.test?
 end
 
 require 'appmap/railtie' if defined?(AppMap)

data/spec/fixtures/rails5_users_app/create_app

@@ -16,11 +16,17 @@ if [[ $? != 0 ]]; then
    exit 1
 fi
 
-psql -h pg -U postgres -c "create database app_development"
-psql -h pg -U postgres -c "create database app_test"
+# Required for migrations
+export ORM_MODULE=sequel
 
+set +e
+psql -h pg -U postgres -c "drop database if exists app_development"
+psql -h pg -U postgres -c "drop database if exists app_test"
 set -e
 
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
 RAILS_ENV=development ./bin/rake db:migrate
 RAILS_ENV=test ./bin/rake db:migrate
 

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

@@ -8,6 +8,12 @@ RSpec.describe Api::UsersController, type: :controller do
         post :create, params: { login: 'alice', password: 'foobar' }
         expect(response.status).to eq(201)
       end
+      describe 'with object-style parameters' do
+        it 'creates a user' do
+          post :create, params: { user: { login: 'alice', password: 'foobar' } }
+          expect(response.status).to eq(201)
+        end
+      end
     end
     describe 'with a missing parameter' do
       it 'reports error 422' do
@@ -25,5 +31,12 @@ RSpec.describe Api::UsersController, type: :controller do
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end
+    describe 'with a custom header' do
+      it 'lists the users' do
+        request.headers['X-Sandwich'] = 'turkey'
+        get :index, params: {}
+        expect(response.status).to eq(200)
+      end
+    end
   end
 end

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

@@ -4,7 +4,7 @@ require 'rack/test'
 RSpec.describe UsersController, type: :controller do
   render_views
 
-  describe 'GET /users', feature: 'Show all users' do
+  describe 'GET /users' do
     before do
       User.create login: 'alice'
     end
@@ -14,7 +14,7 @@ RSpec.describe UsersController, type: :controller do
     end
   end
 
-  describe 'GET /users/:login', feature: 'Show a user' do
+  describe 'GET /users/:login' do
     before do
       User.create login: 'alice'
     end

data/spec/fixtures/rails5_users_app/spec/rails_helper.rb

@@ -45,7 +45,6 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 
-
   DatabaseCleaner.allow_remote_database_url = true
   
   config.before(:suite) do
@@ -54,13 +53,8 @@ RSpec.configure do |config|
   end
 
   config.around :each do |example|
-    # Enable the use of 'return' from a guard
-    -> {
-      return example.run unless %i[model controller].member?(example.metadata[:type])
-
-      DatabaseCleaner.cleaning do
-        example.run
-      end
-    }.call
+    DatabaseCleaner.cleaning do
+      example.run
+    end
   end
 end

data/spec/fixtures/rails6_users_app/Gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6'
 
 gem 'haml-rails'
@@ -40,12 +39,14 @@ group :development, :test do
   gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
-  # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
-  # isn't activated.
-  gem 'database_cleaner'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'pry-byebug'
 end
 
+group :test do
+  gem 'database_cleaner-active_record', require: false
+  gem 'database_cleaner-sequel', require: false
+end
+
 group :development do
 end

data/spec/fixtures/rails6_users_app/app/controllers/api/users_controller.rb

@@ -6,6 +6,7 @@ module Api
     end
 
     def create
+      params = self.params.key?(:user) ? self.params[:user] : self.params
       @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {

data/spec/fixtures/rails6_users_app/app/controllers/users_controller.rb

@@ -4,7 +4,15 @@ class UsersController < ApplicationController
   end
 
   def show
-    if (@user = User[login: params[:id]])
+    find_user = lambda do |id|
+      if User.respond_to?(:[])
+        User[login: id]
+      else
+        User.find_by_login!(id)
+      end
+    end
+
+    if (@user = find_user.(params[:id]))
       render plain: @user
     else
       render plain: 'Not found', status: 404

data/spec/fixtures/rails6_users_app/config/application.rb

@@ -15,8 +15,10 @@ case orm_module
 when 'sequel'
   require 'sequel-rails'
   require 'sequel_secure_password'
+  require 'database_cleaner-sequel' if Rails.env.test?
 when 'activerecord'
   require 'active_record/railtie'
+  require 'database_cleaner-active_record' if Rails.env.test?
 end
 
 require 'appmap/railtie' if defined?(AppMap)

data/spec/fixtures/rails6_users_app/create_app

@@ -16,11 +16,17 @@ if [[ $? != 0 ]]; then
    exit 1
 fi
 
-psql -h pg -U postgres -c "create database app_development"
-psql -h pg -U postgres -c "create database app_test"
+# Required for migrations
+export ORM_MODULE=sequel
 
+set +e
+psql -h pg -U postgres -c "drop database if exists app_development"
+psql -h pg -U postgres -c "drop database if exists app_test"
 set -e
 
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
 RAILS_ENV=development ./bin/rake db:migrate
 RAILS_ENV=test ./bin/rake db:migrate
 

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

@@ -8,6 +8,12 @@ RSpec.describe Api::UsersController, type: :controller do
         post :create, params: { login: 'alice', password: 'foobar' }
         expect(response.status).to eq(201)
       end
+      describe 'with object-style parameters' do
+        it 'creates a user' do
+          post :create, params: { user: { login: 'alice', password: 'foobar' } }
+          expect(response.status).to eq(201)
+        end
+      end
     end
     describe 'with a missing parameter' do
       it 'reports error 422' do
@@ -25,5 +31,12 @@ RSpec.describe Api::UsersController, type: :controller do
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end
+    describe 'with a custom header' do
+      it 'lists the users' do
+        request.headers['X-Sandwich'] = 'turkey'
+        get :index, params: {}
+        expect(response.status).to eq(200)
+      end
+    end
   end
 end

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

@@ -4,7 +4,7 @@ require 'rack/test'
 RSpec.describe UsersController, type: :controller do
   render_views
 
-  describe 'GET /users', feature: 'Show all users' do
+  describe 'GET /users' do
     before do
       User.create login: 'alice'
     end
@@ -14,7 +14,7 @@ RSpec.describe UsersController, type: :controller do
     end
   end
 
-  describe 'GET /users/:login', feature: 'Show a user' do
+  describe 'GET /users/:login' do
     before do
       User.create login: 'alice'
     end

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -45,7 +45,6 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 
-
   DatabaseCleaner.allow_remote_database_url = true
   
   config.before(:suite) do
@@ -54,13 +53,8 @@ RSpec.configure do |config|
   end
 
   config.around :each do |example|
-    # Enable the use of 'return' from a guard
-    -> {
-      return example.run unless %i[model controller].member?(example.metadata[:type])
-
-      DatabaseCleaner.cleaning do
-        example.run
-      end
-    }.call
+    DatabaseCleaner.cleaning do
+      example.run
+    end
   end
 end

data/spec/hook_spec.rb

@@ -16,14 +16,7 @@ end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
 describe 'AppMap class Hooking', docker: false do
-  require 'appmap/util'
-  def collect_events(tracer)
-    [].tap do |events|
-      while tracer.event?
-        events << tracer.next_event.to_h
-      end
-    end.map(&AppMap::Util.method(:sanitize_event))
-  end
+  include_context 'collect events'
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
@@ -64,11 +57,144 @@ describe 'AppMap class Hooking', docker: false do
   it 'excludes named classes and methods' do
     load 'spec/fixtures/hook/exclude.rb'
     package = AppMap::Config::Package.build_from_path('spec/fixtures/hook/exclude.rb')
-    config = AppMap::Config.new('hook_spec', [ package ], %w[ExcludeTest])
+    config = AppMap::Config.new('hook_spec', [ package ], exclude: %w[ExcludeTest])
     AppMap.configuration = config
 
-    expect(config.never_hook?(ExcludeTest.new.method(:instance_method))).to be_truthy
-    expect(config.never_hook?(ExcludeTest.method(:cls_method))).to be_truthy
+    expect(config.never_hook?(ExcludeTest, ExcludeTest.new.method(:instance_method))).to be_truthy
+    expect(config.never_hook?(ExcludeTest, ExcludeTest.method(:cls_method))).to be_truthy
+  end
+
+  it "handles an instance method named 'call' without issues" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: MethodNamedCall
+      :method_id: call
+      :path: spec/fixtures/hook/method_named_call.rb
+      :lineno: 8
+      :static: false
+      :parameters:
+      - :name: :a
+        :class: Integer
+        :value: '1'
+        :kind: :req
+      - :name: :b
+        :class: Integer
+        :value: '2'
+        :kind: :req
+      - :name: :c
+        :class: Integer
+        :value: '3'
+        :kind: :req
+      - :name: :d
+        :class: Integer
+        :value: '4'
+        :kind: :req
+      - :name: :e
+        :class: Integer
+        :value: '5'
+        :kind: :req
+      :receiver:
+        :class: MethodNamedCall
+        :value: MethodNamedCall
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: 1 2 3 4 5
+    YAML
+
+    _, tracer = test_hook_behavior 'spec/fixtures/hook/method_named_call.rb', events_yaml do
+      expect(MethodNamedCall.new.call(1, 2, 3, 4, 5)).to eq('1 2 3 4 5')
+    end
+    class_map = AppMap.class_map(tracer.event_methods)
+    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
+    ---
+    - :name: spec/fixtures/hook/method_named_call.rb
+      :type: package
+      :children:
+      - :name: MethodNamedCall
+        :type: class
+        :children:
+        - :name: call
+          :type: function
+          :location: spec/fixtures/hook/method_named_call.rb:8
+          :static: false
+    CLASSMAP
+  end
+
+  it 'can custom hook and label a function' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: CustomInstanceMethod
+      :method_id: say_default
+      :path: spec/fixtures/hook/custom_instance_method.rb
+      :lineno: 8
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: CustomInstanceMethod
+        :value: CustomInstance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: default
+    YAML
+
+    config = AppMap::Config.load({
+      functions: [
+        {
+          package: 'hook_spec',
+          class: 'CustomInstanceMethod',
+          functions: [ :say_default ],
+          labels: ['cowsay']
+        }
+      ]
+    }.deep_stringify_keys)
+
+    load 'spec/fixtures/hook/custom_instance_method.rb'
+    hook_cls = CustomInstanceMethod
+    method = hook_cls.instance_method(:say_default)
+
+    require 'appmap/hook/method'
+    package = config.lookup_package(hook_cls, method)
+    expect(package).to be
+    hook_method = AppMap::Hook::Method.new(package, hook_cls, method)
+    hook_method.activate
+
+    tracer = AppMap.tracing.trace
+    AppMap::Event.reset_id_counter
+    begin
+      expect(CustomInstanceMethod.new.say_default).to eq('default')
+    ensure
+      AppMap.tracing.delete(tracer)
+    end
+
+    events = collect_events(tracer).to_yaml
+
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
+    class_map = AppMap.class_map(tracer.event_methods)
+    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
+    ---
+    - :name: hook_spec
+      :type: package
+      :children:
+      - :name: CustomInstanceMethod
+        :type: class
+        :children:
+        - :name: say_default
+          :type: function
+          :location: spec/fixtures/hook/custom_instance_method.rb:8
+          :static: false
+          :labels:
+          - cowsay
+    CLASSMAP
   end
 
   it 'parses labels from comments' do
@@ -91,9 +217,6 @@ describe 'AppMap class Hooking', docker: false do
           :labels:
           - has-fn-label
           :comment: "# @label has-fn-label\\n"
-          :source: |2
-              def fn_with_label
-              end
       YAML
   end
 
@@ -127,8 +250,8 @@ describe 'AppMap class Hooking', docker: false do
     _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
       InstanceMethod.new.say_default
     end
-    expect(tracer.event_methods.to_a.map(&:defined_class)).to eq([ 'InstanceMethod' ])
-    expect(tracer.event_methods.to_a.map(&:to_s)).to eq([ InstanceMethod.public_instance_method(:say_default).to_s ])
+    expect(tracer.event_methods.to_a.map(&:class_name)).to eq([ 'InstanceMethod' ])
+    expect(tracer.event_methods.to_a.map(&:name)).to eq([ InstanceMethod.public_instance_method(:say_default).name ])
   end
 
   it 'builds a class map of invoked methods' do
@@ -148,10 +271,6 @@ describe 'AppMap class Hooking', docker: false do
           :type: function
           :location: spec/fixtures/hook/instance_method.rb:8
           :static: false
-          :source: |2
-              def say_default
-                'default'
-              end
     YAML
   end
 
@@ -744,8 +863,11 @@ describe 'AppMap class Hooking', docker: false 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' }
+      expect(secure_compare_event).to be_truthy
       secure_compare_event.delete(:lineno)
+      secure_compare_event.delete(:path)
 
       expect(Diffy::Diff.new(<<~YAML, secure_compare_event.to_yaml).to_s).to eq('')
       ---
@@ -753,7 +875,6 @@ describe 'AppMap class Hooking', docker: false do
       :event: :call
       :defined_class: ActiveSupport::SecurityUtils
       :method_id: secure_compare
-      :path: lib/active_support/security_utils.rb
       :static: true
       :parameters:
       - :name: :a
@@ -837,7 +958,7 @@ describe 'AppMap class Hooking', docker: false do
       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')
-      expect(entry[:labels]).to eq(%w[provider.secure_compare])
+      expect(entry[:labels]).to eq(%w[crypto.secure_compare])
     end
   end