appmap 0.77.4 → 0.80.0

data/lib/appmap/handler/rails/request_handler.rb

@@ -7,6 +7,7 @@ require 'appmap/util'
 module AppMap
   module Handler
     module Rails
+
       module RequestHandler
         class HTTPServerRequest < AppMap::Event::MethodEvent
           attr_accessor :normalized_path_info, :request_method, :path_info, :params, :headers
@@ -46,8 +47,7 @@ module AppMap
                     value: self.class.display_string(val),
                     object_id: val.__id__,
                   }.tap do |message|
-                    properties = object_properties(val)
-                    message[:properties] = properties if properties
+                    AppMap::Event::MethodEvent.add_schema message, val
                   end
                 end
               end
@@ -67,16 +67,16 @@ module AppMap
           end
         end
 
-        class HTTPServerResponse < AppMap::Event::MethodReturnIgnoreValue
+        class HTTPServerResponse < AppMap::Event::MethodReturn
           attr_accessor :status, :headers
 
-          def initialize(response, parent_id, elapsed)
-            super AppMap::Event.next_id_counter, :return, Thread.current.object_id
-
-            self.status = response.status
-            self.parent_id = parent_id
-            self.elapsed = elapsed
-            self.headers = response.headers.dup
+          class << self
+            def build_from_invocation(parent_id, return_value, elapsed, response, event: HTTPServerResponse.new)
+              event ||= HTTPServerResponse.new
+              event.status = response.status
+              event.headers = response.headers.dup
+              AppMap::Event::MethodReturn.build_from_invocation parent_id, return_value, nil, elapsed: elapsed, event: event, parameter_schema: true
+            end
           end
 
           def to_h
@@ -108,7 +108,9 @@ module AppMap
           end
 
           def after_hook(receiver, call_event, elapsed, *)
-            return_event = HTTPServerResponse.new receiver.response, call_event.id, elapsed
+            return_value = Thread.current[TEMPLATE_RENDER_VALUE]
+            Thread.current[TEMPLATE_RENDER_VALUE] = nil
+            return_event = HTTPServerResponse.build_from_invocation call_event.id, return_value, elapsed, receiver.response
             AppMap.tracing.record_event return_event
           end
         end

data/lib/appmap/handler/rails/sql_handler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'appmap/event'
+require 'appmap/hook/method'
 
 module AppMap
   module Handler
@@ -21,6 +22,7 @@ module AppMap
                 sql: payload[:sql],
                 database_type: payload[:database_type]
               }.tap do |sql_query|
+                sql_query[:query_plan] = payload[:query_plan] if payload[:query_plan]
                 %i[server_version].each do |attribute|
                   sql_query[attribute] = payload[attribute] if payload[attribute]
                 end
@@ -43,6 +45,36 @@ module AppMap
             def examine(payload, sql:)
               return unless (examiner = build_examiner)
 
+              in_transaction = examiner.in_transaction?
+
+              if AppMap.explain_queries? && examiner.database_type == :postgres
+                if sql =~ /\A(SELECT|INSERT|UPDATE|DELETE|WITH)/i
+                  savepoint_established = \
+                    begin
+                      tx_query = in_transaction ? 'SAVEPOINT appmap_sql_examiner' : 'BEGIN TRANSACTION'
+                      examiner.execute_query tx_query
+                      true
+                    rescue
+                      # Probably: Sequel::DatabaseError: PG::InFailedSqlTransaction
+                      warn $!
+                      false
+                    end
+
+                  if savepoint_established
+                    plan = nil
+                    begin
+                      plan = examiner.execute_query(%(EXPLAIN #{sql}))
+                      payload[:query_plan] = plan.map { |line| line[:'QUERY PLAN'] }.join("\n")
+                    rescue
+                      warn "(appmap) Error explaining query: #{$!}"
+                    ensure
+                      tx_query = in_transaction ? 'ROLLBACK TO SAVEPOINT appmap_sql_examiner' : 'ROLLBACK'
+                      examiner.execute_query tx_query
+                    end
+                  end
+                end
+              end
+
               payload[:server_version] = examiner.server_version
               payload[:database_type] = examiner.database_type.to_s
             end
@@ -67,6 +99,10 @@ module AppMap
               Sequel::Model.db.database_type.to_sym
             end
 
+            def in_transaction?
+              Sequel::Model.db.in_transaction?
+            end
+
             def execute_query(sql)
               Sequel::Model.db[sql].all
             end
@@ -93,8 +129,12 @@ module AppMap
               type
             end
 
+            def in_transaction?
+              ActiveRecord::Base.connection.open_transactions > 0
+            end
+
             def execute_query(sql)
-              ActiveRecord::Base.connection.execute(sql).inject([]) { |memo, r| memo << r; memo }
+              ActiveRecord::Base.connection.execute(sql).to_a
             end
           end
         end
@@ -102,6 +142,8 @@ module AppMap
         def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
           return if AppMap.tracing.empty?
 
+          return if Thread.current[AppMap::Hook::Method::HOOK_DISABLE_KEY] == true
+
           reentry_key = "#{self.class.name}#call"
           return if Thread.current[reentry_key] == true
 

data/lib/appmap/handler.rb

@@ -5,6 +5,9 @@ require 'active_support/inflector/methods'
 module AppMap
   # Specific hook handler classes and general related utilities.
   module Handler
+    TEMPLATE_RENDER_FORMAT = 'appmap.handler.template.return_value_format'
+    TEMPLATE_RENDER_VALUE = 'appmap.handler.template.return_value'
+
     # Try to find handler module with a given name.
     #
     # If the module is not loaded, tries to require the appropriate file

data/lib/appmap/hook/method.rb

@@ -24,7 +24,6 @@ module AppMap
       attr_reader :hook_package, :hook_class, :hook_method, :parameters, :arity
 
       HOOK_DISABLE_KEY = 'AppMap::Hook.disable'
-      private_constant :HOOK_DISABLE_KEY
 
       def initialize(hook_package, hook_class, hook_method)
         @hook_package = hook_package

data/lib/appmap/version.rb

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

data/spec/config_spec.rb

@@ -3,7 +3,7 @@
 require 'rails_spec_helper'
 require 'appmap/config'
 
-describe AppMap::Config, docker: false do
+describe AppMap::Config do
   it 'loads as expected' do
     config_data = {
       name: 'test',

data/spec/depends/api_spec.rb

@@ -33,7 +33,7 @@ module AppMap
       end
     end
   end
-end 
+end
 
 describe 'Depends API' do
   let(:api) { AppMap::Depends::API.new(ENV['DEBUG'] == 'true') }
@@ -112,12 +112,12 @@ describe 'Depends API' do
       around do |test|
         @minitest_test_command_method = AppMap.configuration.depends_config.minitest_test_command_method
         AppMap.configuration.depends_config.minitest_test_command_method = 'AppMap::Depends::APISpec.minitest_test_command'
-  
+
         test.call
       ensure
         AppMap.configuration.depends_config.minitest_test_command_method = @minitest_test_command
       end
-  
+
       it 'passes a smoke test' do
         run_tests
       end
@@ -175,10 +175,18 @@ describe 'Depends API' do
         # At this point, we would run tests to bring the AppMaps up to date
         # Then once the tests have finished, remove any AppMaps that weren't refreshed
         removed = api.remove_out_of_date_appmaps(since, appmap_dir: DEPENDS_TEST_DIR, base_dir: DEPENDS_BASE_DIR)
-        expect(removed).to eq([ appmap_path.split('.')[0] ])  
+        expect(removed).to eq([ appmap_path.split('.')[0] ])
       ensure
-        File.write(appmap_path, appmap)        
+        File.write(appmap_path, appmap)
       end
     end
   end
+
+  before do
+    Dir.glob("#{DEPENDS_TEST_DIR}/*.appmap.json").each { |fname| FileUtils.touch fname }
+    update_appmap_index
+
+    FileUtils.rm_rf 'spec/tmp'
+    FileUtils.mkdir_p 'spec/tmp'
+  end
 end

data/spec/depends/spec_helper.rb

@@ -16,12 +16,3 @@ def update_appmap_index
   system cmd.join(' ') or raise "Failed to update AppMap index in #{DEPENDS_TEST_DIR}"
 end
 
-RSpec.configure do |rspec|
-  rspec.before do
-    Dir.glob("#{DEPENDS_TEST_DIR}/*.appmap.json").each { |fname| FileUtils.touch fname }
-    update_appmap_index
-
-    FileUtils.rm_rf 'spec/tmp'
-    FileUtils.mkdir_p 'spec/tmp'
-  end
-end

data/spec/fixtures/database.yml

@@ -0,0 +1,11 @@
+default: &default
+  url: <%= ENV['DATABASE_URL'] %>
+  adapter: postgresql
+  database: <%= ENV['TEST_DATABASE'] || 'appland-rails6-test' %>
+
+development:
+  <<: *default
+test:
+  <<: *default
+production:
+  <<: *default

data/spec/fixtures/rails5_users_app/config/database.yml

@@ -0,0 +1 @@
+../../database.yml

data/spec/fixtures/rails6_users_app/Gemfile

@@ -11,32 +11,8 @@ gem 'sequel', '>= 5.43.0', require: false
 gem 'sequel-rails', require: false
 gem 'sequel_secure_password', require: false
 
-appmap_path = \
-  # Support debugging inside the container with volume-mounted source
-  if File.directory?('/src/appmap-ruby')
-    '/src/appmap-ruby'
-  elsif File.exist?('../../../appmap.gemspec')
-    '../../..'
-  end
-
-if appmap_path
-  # Set the branch parameter, so that 'bundle config local.appmap' will work
-  appmap_branch = Dir.chdir appmap_path do
-    `git rev-parse --abbrev-ref HEAD`.strip
-  end
-end
-
-appmap_options = \
-  if appmap_path && appmap_branch
-    { git: appmap_path, branch: appmap_branch }
-  elsif appmap_path
-    { path: appmap_path }
-  else
-    {}
-  end.merge(require: %w[appmap])
-
 group :development, :test do
-  gem 'appmap', appmap_options
+  gem 'appmap', path: '../../..'
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console

data/spec/fixtures/rails6_users_app/config/database.yml

@@ -0,0 +1 @@
+../../database.yml

data/spec/fixtures/rails7_users_app/Gemfile

@@ -69,31 +69,7 @@ group :test do
   gem "webdrivers"
 end
 
-appmap_path = \
-  # Support debugging inside the container with volume-mounted source
-  if File.directory?('/src/appmap-ruby')
-    '/src/appmap-ruby'
-  elsif File.exist?('../../../appmap.gemspec')
-    '../../..'
-  end
-
-if appmap_path
-  # Set the branch parameter, so that 'bundle config local.appmap' will work
-  appmap_branch = Dir.chdir appmap_path do
-    `git rev-parse --abbrev-ref HEAD`.strip
-  end
-end
-
-appmap_options = \
-  if appmap_path && appmap_branch
-    { git: appmap_path, branch: appmap_branch }
-  elsif appmap_path
-    { path: appmap_path }
-  else
-    {}
-  end.merge(require: %w[appmap])
-
 group :development, :test do
-  gem 'appmap', appmap_options
+  gem 'appmap', path: '../../..'
   gem 'pry-byebug', '>=0', '< 99'
 end

data/spec/fixtures/rails7_users_app/config/database.yml

@@ -0,0 +1 @@
+../../database.yml

data/spec/handler/eval_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# rubocop:disable Security/Eval, Style/EvalWithLocation
+
+require 'spec_helper'
+require 'appmap/config'
+
+describe 'AppMap::Handler::Eval' do
+  include_context 'collect events'
+  let!(:config) { AppMap::Config.new('hook_spec') }
+  before { AppMap.configuration = config }
+  after { AppMap.configuration = nil }
+
+  def record_block
+    AppMap::Hook.new(config).enable do
+      tracer = AppMap.tracing.trace
+      AppMap::Event.reset_id_counter
+      begin
+        yield
+      ensure
+        AppMap.tracing.delete(tracer)
+      end
+      tracer
+    end
+  end
+
+  it 'produces a simple result' do
+    tracer = record_block do
+      expect(eval('12')).to eq(12)
+    end
+    events = collect_events(tracer)
+    expect(events[0]).to match hash_including \
+      defined_class: 'Kernel',
+      method_id: 'eval',
+      parameters: [{ class: 'Array', kind: :rest, name: 'arg', size: 1, value: '[12]' }]
+  end
+
+  # a la Ruby 2.6.3 ruby-token.rb
+  # token_c = eval("class #{token_n} < #{super_token}; end; #{token_n}")
+  it 'can define a new class' do
+    num = (Random.random_number * 10_000).to_i
+    class_name = "Cls_#{num}"
+    m = ClassMaker
+    cls = nil
+    record_block do
+      cls = m.make_class class_name
+    end
+    expect(cls).to be_instance_of(Class)
+    # If execution context wasn't substituted, the class would be defined as
+    # eg. AppMap::Handler::Eval::Cls_7566
+    expect { AppMap::Handler::Eval.const_get(class_name) }.to raise_error(NameError)
+    # This would be the right behavior
+    expect(m.const_get(class_name)).to be_instance_of(Class)
+    expect(m.const_get(class_name)).to eq(cls)
+    new_cls = Class.new do
+      include m
+    end
+    expect(new_cls.const_get(class_name)).to eq(cls)
+  end
+end
+
+module ClassMaker
+  def self.make_class(class_name)
+    eval "class #{class_name}; end; #{class_name}"
+  end
+end

data/spec/hook_spec.rb

@@ -16,7 +16,7 @@ module ShowYamlNulls
 end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
-describe 'AppMap class Hooking', docker: false do
+describe 'AppMap class Hooking' do
   include_context 'collect events'
 
   def invoke_test_file(file, setup: nil, packages: nil)
@@ -491,6 +491,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Array
         :value: "[4, 5]"
         :kind: :rest
+        :size: 2
       - :name: :kw1
         :class: String
         :value: one
@@ -503,6 +504,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Hash
         :value: "{:kw3=>:three}"
         :kind: :keyrest
+        :size: 1
       :receiver:
         :class: InstanceMethod
         :value: Instance Method fixture
@@ -1139,6 +1141,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Array
         :value: "[foo]"
         :kind: :rest
+        :size: 1
       - :name: :kw1
         :class: String
         :value: kw1
@@ -1151,6 +1154,7 @@ describe 'AppMap class Hooking', docker: false do
         :class: Hash
         :value: "{}"
         :kind: :keyrest
+        :size: 0
       :receiver:
         :class: ReportParameters
         :value: ReportParameters
@@ -1160,6 +1164,7 @@ describe 'AppMap class Hooking', docker: false do
       :return_value:
         :class: Array
         :value: "[[:rest, :args], [:keyreq, :kw1], [:key, :kw2], [:keyrest, :kws]]"
+        :size: 4
     YAML
     parameters = [[:rest, :args], [:keyreq, :kw1], [:key, :kw2], [:keyrest, :kws]]
     test_hook_behavior 'spec/fixtures/hook/report_parameters.rb', events do

data/spec/rails_recording_spec.rb

@@ -15,14 +15,6 @@ describe 'Rails' do
       include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
       include_context 'rails integration test setup'
 
-      def run_spec(spec_name)
-        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
-
       describe 'an API route' do
         describe 'creating an object' do
           let(:appmap_json_file) do
@@ -62,7 +54,8 @@ describe 'Rails' do
                 'http_server_response' => hash_including(
                   'status_code' => 201,
                   'headers' => hash_including('Content-Type' => 'application/json; charset=utf-8'),
-                )
+                ),
+                'return_value' => hash_including('class' => 'Hash', 'object_id' => Integer, 'properties' => include({'name' => 'login', 'class' => 'String'})),
               )
             )
           end
@@ -80,6 +73,7 @@ describe 'Rails' do
                 'name' => 'params',
                 'class' => 'ActiveSupport::HashWithIndifferentAccess',
                 'object_id' => Integer,
+                'size' => 1,
                 'value' => '{login=>alice}',
                 'kind' => 'req'
               ),
@@ -123,7 +117,7 @@ describe 'Rails' do
                     )
                   )
                 )
-              )    
+              )
             end
           end
         end
@@ -201,7 +195,7 @@ describe 'Rails' do
                   'path_info' => '/users/alice',
                   'normalized_path_info' => '/users/{id}',
                   'headers' => {
-                    'Host' => 'test.host', 
+                    'Host' => 'test.host',
                     'User-Agent' => 'Rails Testing'
                   }
                 }
@@ -236,7 +230,7 @@ describe 'Rails' do
               'defined_class' => 'inline_template',
               'method_id' => 'render'
             )
-  
+
             expect(appmap['classMap']).to include hash_including(
               'name' => 'actionview',
               'children' => include(hash_including(
@@ -251,7 +245,7 @@ describe 'Rails' do
                 ))
               ))
             )
-          end  
+          end
         end
       end
     end
@@ -261,14 +255,6 @@ describe 'Rails' do
     include_context 'Rails app pg database', "spec/fixtures/rails6_users_app" unless use_existing_data?
     include_context 'rails integration test setup'
 
-    def run_spec(spec_name)
-      cmd = <<~CMD.gsub "\n", ' '
-        docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -e APPMAP_CONFIG_FILE=no/such/file
-        -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
-      CMD
-      run_cmd cmd, chdir: fixture_dir
-    end
-
     let(:appmap_json_file) do
       'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
     end