appmap 0.45.1 → 0.48.1

data/spec/railtie_spec.rb

@@ -4,7 +4,7 @@ describe 'AppMap tracer via Railtie' do
   include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do 
     let(:env) { {} }
 
-    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
+    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV=development -e APPMAP app ./bin/rails r "puts AppMap.instance_variable_get('@configuration').nil?") }
     let(:command_capture2) do
       require 'open3'
       Open3.capture3(env, cmd, chdir: fixture_dir).tap do |result|
@@ -23,20 +23,16 @@ describe 'AppMap tracer via Railtie' do
     let(:command_output) { command_capture2[0].strip }
     let(:command_result) { command_capture2[2] }
 
-    it 'is disabled by default' do
-      expect(command_output).to eq('nil')
+    describe 'with APPMAP=false' do
+      let(:env) { { 'APPMAP' => 'false' } }
+      it 'is disabled' do
+        expect(command_output).to eq('true')
+      end
     end
-
     describe 'with APPMAP=true' do
       let(:env) { { 'APPMAP' => 'true' } }
       it 'is enabled' do
-        expect(command_output.split("\n")).to include('true')
-      end
-      context 'and RAILS_ENV=test' do
-        let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }
-        it 'is disabled' do
-          expect(command_output).to eq('nil')
-        end
+        expect(command_output).to eq('false')
       end
     end
   end

data/spec/util_spec.rb

@@ -4,8 +4,8 @@ require 'spec_helper'
 require 'appmap/util'
 
 describe AppMap::Util, docker: false do
-  let(:subject) { AppMap::Util.method(:scenario_filename) }
   describe 'scenario_filename' do
+    let(:subject) { AppMap::Util.method(:scenario_filename) }
     it 'leaves short names alone' do
       expect(subject.call('foobar')).to eq('foobar.appmap.json')
     end
@@ -18,4 +18,21 @@ describe AppMap::Util, docker: false do
       expect(subject.call(fname, max_length: 50)).to eq('abcdefghijklmno-RAd_SFbH1sUZ_OXfwPsfzw.appmap.json')
     end
   end
+  describe 'swaggerize path' do
+    it 'replaces rails-style parameters' do
+      expect(AppMap::Util.swaggerize_path('/org/:org_id(.:format)')).to eq('/org/{org_id}')
+    end
+
+    it 'strips the format specifier' do
+      expect(AppMap::Util.swaggerize_path('/org(.:format)')).to eq('/org')
+    end
+
+    it 'ignores malformed parameter specs' do
+      expect(AppMap::Util.swaggerize_path('/org/o:rg_id')).to eq('/org/o:rg_id')
+    end
+
+    it 'ignores already swaggerized paths' do
+      expect(AppMap::Util.swaggerize_path('/org/{org_id}')).to eq('/org/{org_id}')
+    end
+  end
 end

data/test/bundle_vendor_test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class BundleVendorTest < Minitest::Test
+  def perform_bundle_vendor_app(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/bundle_vendor_app' do
+        FileUtils.rm_rf 'tmp'
+        FileUtils.mkdir_p 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system(%(bundle exec ruby -Ilib -Itest cli.rb add foobar))
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest cli.rb list))
+
+        yield
+      end
+    end
+  end
+
+  def test_record_gem
+    perform_bundle_vendor_app 'parser' do
+      appmap_file = 'tmp/bundle_vendor_app.appmap.json'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert appmap['classMap'].find { |co| co['name'] == 'gli' }
+      assert appmap['events'].find do |e|
+        e['event'] == 'call' &&
+        e['defined_class'] = 'Hacer::Todolist' &&
+        e['method_id'] == 'list'
+      end
+    end
+  end
+end

data/test/fixtures/bundle_vendor_app/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'gli'
+gem 'hacer'
+
+appmap_gem_opts = {}
+appmap_gem_opts[:path] = '../../..' if File.exist?('../../../appmap.gemspec')
+gem 'appmap', appmap_gem_opts

data/test/fixtures/bundle_vendor_app/appmap.yml

@@ -0,0 +1,4 @@
+name: bundle_vendor_app
+packages:
+  - gem: gli
+  - gem: hacer

data/test/fixtures/bundle_vendor_app/cli.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'appmap'
+require 'gli'
+require 'hacer'
+
+class App
+  extend GLI::App
+
+  program_desc 'A simple todo list'
+
+  flag [:t,:tasklist], :default_value => File.join(ENV['HOME'],'.todolist')
+
+  pre do |global_options,command,options,args|
+    $todo_list = Hacer::Todolist.new(global_options[:tasklist])
+  end
+
+  command :add do |c|
+    c.action do |global_options,options,args|
+      $todo_list.create(args)
+    end
+  end
+
+  command :list do |c|
+    c.action do 
+      $todo_list.list.each do |todo|
+        printf("%5d - %s\n",todo.todo_id,todo.text)
+      end
+    end
+  end
+
+  command :done do |c|
+    c.action do |global_options,options,args|
+      id = args.shift.to_i
+      $todo_list.list.each do |todo|
+        $todo_list.complete(todo) if todo.todo_id == id
+      end
+    end
+  end
+end
+
+exit_status = nil
+invoke = -> { exit_status = App.run(ARGV) }
+do_appmap = -> { ENV['APPMAP'] == 'true' }
+
+if do_appmap.()
+  appmap = AppMap.record do
+    invoke.()
+  end
+  File.write('tmp/bundle_vendor_app.appmap.json', JSON.pretty_generate(appmap))
+else
+  invoke.()
+end
+exit exit_status
+

data/test/gem_test.rb

@@ -4,7 +4,7 @@
 require 'test_helper'
 require 'English'
 
-class MinitestTest < Minitest::Test
+class GemTest < Minitest::Test
   def perform_gem_test(test_name)
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/gem_test' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.45.1
+  version: 0.48.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -348,14 +348,15 @@ files:
 - lib/appmap/event.rb
 - lib/appmap/handler/function.rb
 - lib/appmap/handler/net_http.rb
+- lib/appmap/handler/rails/request_handler.rb
+- lib/appmap/handler/rails/sql_handler.rb
+- lib/appmap/handler/rails/template.rb
 - lib/appmap/hook.rb
 - lib/appmap/hook/method.rb
 - lib/appmap/metadata.rb
 - lib/appmap/middleware/remote_recording.rb
 - lib/appmap/minitest.rb
 - lib/appmap/open.rb
-- lib/appmap/rails/request_handler.rb
-- lib/appmap/rails/sql_handler.rb
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
 - lib/appmap/rspec.rb
@@ -556,9 +557,13 @@ files:
 - spec/remote_recording_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
+- test/bundle_vendor_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json
 - test/expectations/openssl_test_key_sign2.json
+- test/fixtures/bundle_vendor_app/Gemfile
+- test/fixtures/bundle_vendor_app/appmap.yml
+- test/fixtures/bundle_vendor_app/cli.rb
 - test/fixtures/cli_record_test/appmap.yml
 - test/fixtures/cli_record_test/lib/cli_record_test/main.rb
 - test/fixtures/cucumber4_recorder/Gemfile

data/lib/appmap/rails/request_handler.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-require 'appmap/event'
-require 'appmap/hook'
-
-module AppMap
-  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

data/lib/appmap/rails/sql_handler.rb

@@ -1,150 +0,0 @@
-# frozen_string_literal: true
-
-require 'appmap/event'
-
-module AppMap
-  module Rails
-    class SQLHandler
-      class SQLCall < AppMap::Event::MethodCall
-        attr_accessor :payload
-
-        def initialize(payload)
-          super AppMap::Event.next_id_counter, :call, Thread.current.object_id
-
-          self.payload = payload
-        end
-
-        def to_h
-          super.tap do |h|
-            h[:sql_query] = {
-              sql: payload[:sql],
-              database_type: payload[:database_type]
-            }.tap do |sql_query|
-              %i[server_version].each do |attribute|
-                sql_query[attribute] = payload[attribute] if payload[attribute]
-              end
-            end
-          end
-        end
-      end
-
-      class SQLReturn < AppMap::Event::MethodReturnIgnoreValue
-        def initialize(parent_id, elapsed)
-          super AppMap::Event.next_id_counter, :return, Thread.current.object_id
-
-          self.parent_id = parent_id
-          self.elapsed = elapsed
-        end
-      end
-
-      module SQLExaminer
-        class << self
-          def examine(payload, sql:)
-            return unless (examiner = build_examiner)
-
-            payload[:server_version] = examiner.server_version
-            payload[:database_type] = examiner.database_type.to_s
-          end
-
-          protected
-
-          def build_examiner
-            if defined?(Sequel)
-              SequelExaminer.new
-            elsif defined?(ActiveRecord)
-              ActiveRecordExaminer.new
-            end
-          end
-        end
-
-        class SequelExaminer
-          def server_version
-            Sequel::Model.db.server_version
-          end
-
-          def database_type
-            Sequel::Model.db.database_type.to_sym
-          end
-
-          def execute_query(sql)
-            Sequel::Model.db[sql].all
-          end
-        end
-
-        class ActiveRecordExaminer
-          @@db_version_warning_issued = {}
-          
-          def issue_warning
-            db_type = database_type
-            return if @@db_version_warning_issued[db_type]
-            warn("AppMap: Unable to determine database version for #{db_type.inspect}") 
-            @@db_version_warning_issued[db_type] = true
-          end
-          
-          def server_version
-            ActiveRecord::Base.connection.try(:database_version) || issue_warning
-          end
-
-          def database_type
-            type = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
-            type = :postgres if type == :postgresql
-
-            type
-          end
-
-          def execute_query(sql)
-            ActiveRecord::Base.connection.execute(sql).inject([]) { |memo, r| memo << r; memo }
-          end
-        end
-      end
-
-      def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
-        return if AppMap.tracing.empty?
-
-        reentry_key = "#{self.class.name}#call"
-        return if Thread.current[reentry_key] == true
-
-        Thread.current[reentry_key] = true
-        begin
-          sql = payload[:sql].strip
-
-          # Detect whether a function call within a specified filename is present in the call stack.
-          find_in_backtrace = lambda do |file_name, function_name = nil|
-            Thread.current.backtrace.find do |line|
-              tokens = line.split(':')
-              matches_file = tokens.find { |t| t.rindex(file_name) == (t.length - file_name.length) }
-              matches_function = function_name.nil? || tokens.find { |t| t == "in `#{function_name}'" }
-              matches_file && matches_function
-            end
-          end
-
-          # Ignore SQL calls which are made while establishing a new connection.
-          #
-          # Example:
-          # /path/to/ruby/2.6.0/gems/sequel-5.20.0/lib/sequel/connection_pool.rb:122:in `make_new'
-          return if find_in_backtrace.call('lib/sequel/connection_pool.rb', 'make_new')
-          # lib/active_record/connection_adapters/abstract/connection_pool.rb:811:in `new_connection'
-          return if find_in_backtrace.call('lib/active_record/connection_adapters/abstract/connection_pool.rb', 'new_connection')
-
-          # Ignore SQL calls which are made while inspecting the DB schema.
-          #
-          # Example:
-          # /path/to/ruby/2.6.0/gems/sequel-5.20.0/lib/sequel/model/base.rb:812:in `get_db_schema'
-          return if find_in_backtrace.call('lib/sequel/model/base.rb', 'get_db_schema')
-          # /usr/local/bundle/gems/activerecord-5.2.3/lib/active_record/model_schema.rb:466:in `load_schema!'
-          return if find_in_backtrace.call('lib/active_record/model_schema.rb', 'load_schema!')
-          return if find_in_backtrace.call('lib/active_model/attribute_methods.rb', 'define_attribute_methods')
-          return if find_in_backtrace.call('lib/active_record/connection_adapters/schema_cache.rb')
-
-          SQLExaminer.examine payload, sql: sql
-
-          call = SQLCall.new(payload)
-          AppMap.tracing.record_event(call)
-          AppMap.tracing.record_event(SQLReturn.new(call.id, finished - started))
-        ensure
-          Thread.current[reentry_key] = nil
-        end
-      end
-    end
-  end
-end