appmap 0.79.0 → 0.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5c6a40273c5606504492f151b2feeb1addc83d92f6bec7a80ca51d3034cd79f
-  data.tar.gz: b10a582926396930d2a980cd4323bd83f7c3444aa0b77bf2dd2dfa632203f65d
+  metadata.gz: eb003b96b494282db035877377124bc3736d78320a64e479b7caa0b8df49063a
+  data.tar.gz: 3aab36a97c90485e1c7f77bed373c4c572b46a5c8c93ac4aa012db3becf201f4
 SHA512:
-  metadata.gz: f56a49c05561a74ae2ee7512fbad2beadc1a0aa719e27b455ea330777c58e97b7c028f7eaaee13d52f20c8ace6bf9284ff8c717e17d922a45f2dca703781a737
-  data.tar.gz: d35ac177b2b12ddd4f4e0517ed4101043c8e9d29f89f53721969d45e3e2be293ae7ad0b8466a2fae63329bb7a13e27d699b30a2464a663014d04a71a8d464293
+  metadata.gz: 8637610caacf145c5badb4de3eb399858a231d3de9a794f86e8fcb3d14801d3b5309453da7e9b799d47ddb9c4eed55bbd97bf2f77eabe7e605e95089b560c5bf
+  data.tar.gz: bba8d4f2f8ffa5b0e5d8b113657324561dfa71e7b7128273631d62d426c8e12339e305d9fb0fe0d05244685a1ddc1b4be4bfbe5a4b44607a2df96e5d60749557

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [0.80.0](https://github.com/applandinc/appmap-ruby/compare/v0.79.0...v0.80.0) (2022-04-08)
+
+
+### Bug Fixes
+
+* Don't record SQL within an existing event ([ff37a69](https://github.com/applandinc/appmap-ruby/commit/ff37a69af1af02263df216e49aea0d0954b93925))
+
+
+### Features
+
+* Env var to EXPLAIN queries ([740be75](https://github.com/applandinc/appmap-ruby/commit/740be75c2bc59e343d67ecf86b7715e61cddadba))
+* Optionally record parameter schema ([b7f41b1](https://github.com/applandinc/appmap-ruby/commit/b7f41b15a4556a0ce78650a6a77301d365632bb8))
+* query_plan is available whether a current transaction exists or not ([6edf774](https://github.com/applandinc/appmap-ruby/commit/6edf774fea858d825c4b971be2c4c15db1652446))
+* Record parameter and return value size ([6e69754](https://github.com/applandinc/appmap-ruby/commit/6e697543cb421378832492e286f972dc4cb1e1aa))
+* Save render return value to a thread-local ([f9d1e3f](https://github.com/applandinc/appmap-ruby/commit/f9d1e3f0aa9972482ff77233d38220104515b1d6))
+
 # [0.79.0](https://github.com/applandinc/appmap-ruby/compare/v0.78.0...v0.79.0) (2022-04-06)
 
 

data/lib/appmap/agent.rb

@@ -100,5 +100,13 @@ module AppMap
       @metadata ||= Metadata.detect.freeze
       Util.deep_dup(@metadata)
     end
+
+    def parameter_schema?
+      ENV['APPMAP_PARAMETER_SCHEMA'] == 'true'
+    end
+
+    def explain_queries?
+      ENV['APPMAP_EXPLAIN_QUERIES'] == 'true'
+    end
   end
 end

data/lib/appmap/event.rb

@@ -60,16 +60,18 @@ module AppMap
           final ? value_string : encode_display_string(value_string)
         end
 
-        def object_properties(hash_like)
-          hash = hash_like.to_h
-          hash.keys.map do |key|
-            {
-              name: key,
-              class: hash[key].class.name,
-            }
+        def add_schema(param, value)
+          begin
+            if value.respond_to?(:keys)
+              param[:properties] = value.keys.map { |key| { name: key, class: best_class_name(value[key]) } }
+            elsif value.respond_to?(:first) && value.first
+              if value.first != value
+                add_schema param, value.first
+              end
+            end
+          rescue
+            warn "Error in add_schema(#{value.class})", $!
           end
-        rescue
-          nil
         end
 
         # Heuristic for dynamically defined class whose name can be nil
@@ -221,7 +223,9 @@ module AppMap
                 object_id: value.__id__,
                 value: display_string(value),
                 kind: param_type
-              }
+              }.tap do |param|
+                param[:size] = value.size if value.respond_to?(:size) && value.is_a?(Enumerable)
+              end
             end
             event.receiver = {
               class: best_class_name(receiver),
@@ -276,7 +280,7 @@ module AppMap
       attr_accessor :return_value, :exceptions
 
       class << self
-        def build_from_invocation(parent_id, return_value, exception, elapsed: nil, event: MethodReturn.new)
+        def build_from_invocation(parent_id, return_value, exception, elapsed: nil, event: MethodReturn.new, parameter_schema: false)
           event ||= MethodReturn.new
           event.tap do |_|
             if return_value
@@ -284,7 +288,10 @@ module AppMap
                 class: best_class_name(return_value),
                 value: display_string(return_value),
                 object_id: return_value.__id__
-              }
+              }.tap do |param|
+                param[:size] = return_value.size if return_value.respond_to?(:size) && return_value.is_a?(Enumerable)
+                add_schema param, return_value if parameter_schema && !exception
+              end
             end
             if exception
               next_exception = exception

data/lib/appmap/gem_hooks/actionpack.yml

@@ -43,3 +43,9 @@
   - ActionController::Instrumentation#redirect_to
   label: mvc.controller
   require_name: action_controller
+- methods:
+  - AbstractController::Rendering#render_to_body
+  - ActionController::Renderers#render_to_body
+  label: mvc.render
+  handler_class: AppMap::Handler::Rails::RenderHandler
+  require_name: action_controller

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

@@ -0,0 +1,29 @@
+require 'appmap/handler/function'
+
+module AppMap
+  module Handler
+    module Rails
+      class RenderHandler < AppMap::Handler::Function
+        def handle_call(receiver, args)
+          options, _ = args
+          # TODO: :file, :xml
+          # https://guides.rubyonrails.org/v5.1/layouts_and_rendering.html
+          if options[:json]
+            Thread.current[TEMPLATE_RENDER_FORMAT] = :json
+          end
+
+          super
+        end
+
+        def handle_return(call_event_id, elapsed, return_value, exception)
+          if Thread.current[TEMPLATE_RENDER_FORMAT] == :json
+            Thread.current[TEMPLATE_RENDER_VALUE] = JSON.parse(return_value) rescue nil
+          end
+          Thread.current[TEMPLATE_RENDER_FORMAT] = nil
+
+          super
+        end
+      end
+    end
+  end
+end

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.79.0'
+  VERSION = '0.80.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/spec/handler/eval_spec.rb

@@ -32,7 +32,7 @@ describe 'AppMap::Handler::Eval' do
     expect(events[0]).to match hash_including \
       defined_class: 'Kernel',
       method_id: 'eval',
-      parameters: [{ class: 'Array', kind: :rest, name: 'arg', value: '[12]' }]
+      parameters: [{ class: 'Array', kind: :rest, name: 'arg', size: 1, value: '[12]' }]
   end
 
   # a la Ruby 2.6.3 ruby-token.rb

data/spec/hook_spec.rb

@@ -491,6 +491,7 @@ describe 'AppMap class Hooking' do
         :class: Array
         :value: "[4, 5]"
         :kind: :rest
+        :size: 2
       - :name: :kw1
         :class: String
         :value: one
@@ -503,6 +504,7 @@ describe 'AppMap class Hooking' 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' do
         :class: Array
         :value: "[foo]"
         :kind: :rest
+        :size: 1
       - :name: :kw1
         :class: String
         :value: kw1
@@ -1151,6 +1154,7 @@ describe 'AppMap class Hooking' do
         :class: Hash
         :value: "{}"
         :kind: :keyrest
+        :size: 0
       :receiver:
         :class: ReportParameters
         :value: ReportParameters
@@ -1160,6 +1164,7 @@ describe 'AppMap class Hooking' 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

@@ -54,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
@@ -72,6 +73,7 @@ describe 'Rails' do
                 'name' => 'params',
                 'class' => 'ActiveSupport::HashWithIndifferentAccess',
                 'object_id' => Integer,
+                'size' => 1,
                 'value' => '{login=>alice}',
                 'kind' => 'req'
               ),

data/test/expectations/openssl_test_key_sign2-3.1.json

@@ -26,7 +26,8 @@
         "name": "arg",
         "class": "Array",
         "value": "[e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855, the document]",
-        "kind": "rest"
+        "kind": "rest",
+        "size": 2
       }
     ],
     "receiver": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.79.0
+  version: 0.80.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -394,6 +394,7 @@ files:
 - lib/appmap/handler/eval.rb
 - lib/appmap/handler/function.rb
 - lib/appmap/handler/net_http.rb
+- lib/appmap/handler/rails/render_handler.rb
 - lib/appmap/handler/rails/request_handler.rb
 - lib/appmap/handler/rails/sql_handler.rb
 - lib/appmap/handler/rails/template.rb