appmap 0.99.4 → 0.101.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eda0d23ff548aaa0e6e61eef0e7734a542660eeeb45e899f54a7287665baaf7e
-  data.tar.gz: 84dc9f162eeae76f58f0c6015ec47686509aabf9ac4cac727016957b69421daf
+  metadata.gz: e4d9d1069381257dbf69ca6becafb2bfbbc948039b89060aeb607f73b8992392
+  data.tar.gz: da3124df4bc13ca45b0ed5c67f57667cf5c9d2773afcd4f5f9bcee4b0bf8aa0a
 SHA512:
-  metadata.gz: af594c4d511623a7e9b37bc3bc45d5d2460de1410e9177f544e900c1d1cd5a555be04bef870c8c5e18a05f46fb242afd6dd9ce26646fc700f071c7a4d917da5a
-  data.tar.gz: 49a5e81dd6f504c1e5998f8dc2af53e1b657ddcef387005cd6f313f6c299eb46cc27b7a1c470356de8170435e459d3b1f5e06ef65a1d72f92cea5c0eed797607
+  metadata.gz: 854833429a403e7ae83cfd8eabe76228d273787713aa4d44a829746264044e2a1ab8b4b7620dbc1ba36043c6c6b5128f223d38231ff281d6c48dd1b900cde800
+  data.tar.gz: f907c847bb4a20a57b6ad0172e289d45ddb08162d526470ae3ee05c3d2f0988b7a820c47335d65c1f399b15cc2a611aeb30e0660a2b0c24ef8f2f880ecc13df2

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [0.101.0](https://github.com/getappmap/appmap-ruby/compare/v0.100.0...v0.101.0) (2023-07-17)
+
+
+### Bug Fixes
+
+* Auto-enable tracing on block recording ([59886b6](https://github.com/getappmap/appmap-ruby/commit/59886b6b4720240e9f961a8b76f3035eaf3be44e))
+
+
+### Features
+
+* Record RSwag ([a60d480](https://github.com/getappmap/appmap-ruby/commit/a60d4803feeab519ef4eae1702da00e3dc2dd4ea))
+
+# [0.100.0](https://github.com/getappmap/appmap-ruby/compare/v0.99.4...v0.100.0) (2023-07-11)
+
+
+### Features
+
+* Add `appmap-agent-config` command to bootstrap appmap.yml ([568acc3](https://github.com/getappmap/appmap-ruby/commit/568acc3948871f736ba72244a04fd54d8be67615))
+
 ## [0.99.4](https://github.com/getappmap/appmap-ruby/compare/v0.99.3...v0.99.4) (2023-05-15)
 
 

data/exe/appmap-agent-config

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'appmap'
+require 'appmap/command/agent_setup/config'
+
+@options = { config_file: AppMap::DEFAULT_CONFIG_FILE_PATH, force: false }
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: appmap-agent-config [options]'
+
+  description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
+  parser.on('-c', '--config=FILEPATH', description) do |filepath|
+    @options[:config_file] = filepath
+  end
+
+  parser.on('-f', '--force', 'Overwrite existing configuration file') do
+    @options[:force] = true
+  end
+end.parse!
+
+begin
+  AppMap::Command::AgentSetup::Config.new(@options[:config_file], @options[:force]).perform
+
+  puts "AppMap configuration file created at #{@options[:config_file]}"
+rescue AppMap::Command::AgentSetup::Config::FileExistsError
+  puts "AppMap configuration file already exists at #{@options[:config_file]}"
+  puts 'Use the --force option to overwrite.'
+  exit 1
+end

data/lib/appmap/agent.rb

@@ -73,6 +73,7 @@ module AppMap
     # and returns an AppMap as a Hash.
     def record
       tracer = tracing.trace
+      tracer.enable
       begin
         yield
       ensure

data/lib/appmap/command/agent_setup/config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'appmap/service/guesser'
+
+module AppMap
+  module Command
+    module AgentSetup
+      ConfigStruct = Struct.new(:config_file, :overwrite)
+
+      class Config < ConfigStruct
+        class FileExistsError < StandardError; end
+
+        def perform
+          raise FileExistsError unless overwrite || !File.exist?(config_file)
+
+          config = {
+            'name' => Service::Guesser.guess_name,
+            'packages' => Service::Guesser.guess_paths.map { |path| { 'path' => path } },
+            'language' => 'ruby',
+            'appmap_dir' => 'tmp/appmap'
+          }
+
+          File.write(config_file, YAML.dump(config))
+        end
+      end
+    end
+  end
+end

data/lib/appmap/rspec.rb

@@ -68,7 +68,7 @@ module AppMap
             example_group.parent_groups.first
           end
 
-        example_group_parent != example_group ? ScopeExampleGroup.new(example_group_parent) : nil
+        example_group_parent == example_group ? nil : ScopeExampleGroup.new(example_group_parent)
       end
     end
 
@@ -87,7 +87,7 @@ module AppMap
 
         warn "Starting recording of example #{example}@#{source_location}" if AppMap::RSpec::LOG
         @trace = AppMap.tracing.trace
-        @webdriver_port = webdriver_port.()
+        @webdriver_port = webdriver_port.call
       end
 
       def source_location
@@ -147,7 +147,7 @@ module AppMap
       end
     end
 
-    @recordings_by_example = {}
+    @recordings_by_example = {}.tap(&:compare_by_identity)
     @event_methods = Set.new
     @recording_count = 0
 
@@ -161,34 +161,36 @@ module AppMap
       end
 
       def begin_spec(example)
-        AppMap.info 'Configuring AppMap recorder for RSpec' if first_recording?
         @recording_count += 1
-
-        recording = if example.metadata[:appmap] != false
-          Recording.new(example)
-        else
-          :false
-        end
-
-        @recordings_by_example[example.object_id] = recording
+        # Disable RSpec recording for RSwag, because all the action happens in the before block.
+        # The example is empty except for assertions. So RSwag has its own recorder, and RSpec
+        # recording is disabled so it won't clobber the AppMap with empty data.
+        recording = if example.metadata[:appmap] == false || example.metadata[:rswag]
+                      :disabled
+                    else
+                      Recording.new(example)
+                    end
+
+        @recordings_by_example[example] = recording
       end
 
       def end_spec(example, exception:)
-        recording = @recordings_by_example.delete(example.object_id)
+        recording = @recordings_by_example.delete(example)
         return warn "No recording found for #{example}" unless recording
 
-        recording.finish example.execution_result.exception || exception, exception unless recording == :false
+        recording.finish example.execution_result.exception || exception, exception unless recording == :disabled
       end
 
       def config
-        @config or raise "AppMap is not configured"
+        @config or raise 'AppMap is not configured'
       end
 
       def add_event_methods(event_methods)
         @event_methods += event_methods
       end
 
-      def save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:)
+      def save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:, frameworks: [],
+               recorder: nil)
         metadata = AppMap::RSpec.metadata.tap do |m|
           m[:name] = name
           m[:source_location] = source_location
@@ -198,7 +200,8 @@ module AppMap
             name: 'rspec',
             version: Gem.loaded_specs['rspec-core']&.version&.to_s
           }
-          m[:recorder] = {
+          m[:frameworks] += frameworks
+          m[:recorder] = recorder || {
             name: 'rspec',
             type: 'tests'
           }

data/lib/appmap/rswag.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'appmap'
+
+module AppMap
+  module Rswag
+    def self.record(metadata, &block)
+      description = metadata[:full_description]
+      warn "Recording of RSwag test #{description}" if AppMap::RSpec::LOG
+      source_location = (metadata[:example_group] || {})[:location]
+
+      appmap = AppMap.record(&block)
+
+      events = appmap['events']
+      class_map = appmap['classMap']
+
+      exception = (events.last || {})[:exception]
+      failed = true if exception
+      warn "Finishing recording of #{failed ? 'failed ' : ''} RSwag test #{description}" if AppMap::RSpec::LOG
+      warn "Exception: #{exception}" if exception && AppMap::RSpec::LOG
+
+      if failed
+        warn "Failure exception: #{exception}" if AppMap::RSpec::LOG
+        test_failure = Util.extract_test_failure(exception)
+      end
+
+      AppMap::RSpec.save name: description,
+                         class_map: class_map,
+                         source_location: source_location,
+                         test_status: exception ? 'failed' : 'succeeded',
+                         test_failure: test_failure,
+                         exception: exception,
+                         events: events,
+                         frameworks: [
+                           { name: 'rswag',
+                             version: Gem.loaded_specs['rswag-specs']&.version&.to_s }
+                         ],
+                         recorder: {
+                           name: 'rswag',
+                           type: 'tests'
+                         }
+    end
+
+    class << self
+      def enabled?
+        RSpec.enabled? && defined?(Rswag)
+      end
+    end
+  end
+
+  if Rswag.enabled?
+    require 'rswag'
+    require 'rswag/specs'
+    require 'appmap/rspec'
+
+    module ::Rswag
+      module Specs
+        module ExampleHelpers
+          alias submit_request_without_appmap submit_request
+
+          def submit_request(metadata)
+            AppMap::Rswag.record(metadata) do
+              submit_request_without_appmap(metadata)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appmap/trace.rb

@@ -24,7 +24,7 @@ module AppMap
         return nil if source_location.nil? || source_location.first.start_with?('<')
 
         # Do not use method_source's comment method because it's slow
-        @comment ||= RubyMethod.last_comment *source_location
+        @comment ||= RubyMethod.last_comment(*source_location)
       rescue Errno::EINVAL, Errno::ENOENT
         nil
       end
@@ -41,8 +41,6 @@ module AppMap
         @package.labels
       end
 
-      private
-
       # Read file and get last comment before line.
       def self.last_comment(file, line_number)
         File.open(file) do |f|
@@ -114,19 +112,19 @@ module AppMap
     end
 
     def initialize
-      @@stacks ||= Hash.new
+      @@stacks ||= {}
     end
 
     def record(event)
       stack = caller.select { |line| !line.index('/lib/appmap/') }[0...StackPrinter.depth].join("\n  ")
       stack_hash = Digest::SHA256.hexdigest(stack)
-      unless @@stacks[stack_hash]
-        @@stacks[stack_hash] = stack
-        puts
-        puts 'Event: ' + event.to_h.map { |k, v| [ "#{k}: #{v}" ] }.join(", ")
-        puts '  ' + stack
-        puts
-      end
+      return if @@stacks[stack_hash]
+
+      @@stacks[stack_hash] = stack
+      puts
+      puts 'Event: ' + event.to_h.map { |k, v| [ "#{k}: #{v}" ] }.join(', ')
+      puts '  ' + stack
+      puts
     end
   end
 
@@ -163,7 +161,9 @@ module AppMap
     def record_event(event, package: nil, defined_class: nil, method: nil)
       return unless @enabled
 
-      raise "Expected event in thread #{@thread_id}, got #{event.thread_id}" if @thread_id && @thread_id != event.thread_id 
+      if @thread_id && @thread_id != event.thread_id
+        raise "Expected event in thread #{@thread_id}, got #{event.thread_id}"
+      end
 
       @stack_printer.record(event) if @stack_printer
       @last_package_for_thread[Thread.current.object_id] = package if package

data/lib/appmap/util.rb

@@ -25,9 +25,17 @@ module AppMap
         package_tokens = name.split('/')
 
         class_and_name = package_tokens.pop
-        class_name, function_name, static = class_and_name.include?('.') ? class_and_name.split('.', 2) + [ true ] : class_and_name.split('#', 2) + [ false ]
+        class_name, function_name, static = if class_and_name.include?('.')
+                                              class_and_name.split('.',
+                                                                   2) + [ true ]
+                                            else
+                                              class_and_name.split(
+                                                '#', 2
+                                              ) + [ false ]
+                                            end
 
         raise "Malformed fully-qualified function name #{name}" unless function_name
+
         [ package_tokens.empty? ? 'ruby' : package_tokens.join('/'), class_name, static, function_name ]
       end
 
@@ -70,20 +78,20 @@ module AppMap
       def sanitize_paths(h)
         require 'hashie'
         h.extend(Hashie::Extensions::DeepLocate)
-        keys = %i(path location)
-        h.deep_locate ->(k,v,o) {
+        keys = %i[path location]
+        h.deep_locate lambda { |k, _v, o|
           next unless keys.include?(k)
-          
-          fix = ->(v) {v.gsub(%r{#{Gem.dir}/gems/.*(?=lib)}, '')}
-          keys.each {|k| o[k] = fix.(o[k]) if o[k] }
+
+          fix = ->(v) { v.gsub(%r{#{Gem.dir}/gems/.*(?=lib)}, '') }
+          keys.each { |k| o[k] = fix.call(o[k]) if o[k] }
         }
 
         h
       end
-      
+
       # sanitize_event removes ephemeral values from an event, making
       # events easier to compare across runs.
-      def sanitize_event(event, &block)
+      def sanitize_event(event)
         event.delete(:thread_id)
         event.delete(:elapsed)
         event.delete(:elapsed_instrumentation)
@@ -114,8 +122,8 @@ module AppMap
           blank?(headers) ? nil : headers
         end
 
-        if !env['rack.version']
-          warn "Request headers does not contain rack.version. HTTP_ prefix is not expected."
+        unless env['rack.version']
+          warn 'Request headers does not contain rack.version. HTTP_ prefix is not expected.'
           return finalize_headers.call(env.dup)
         end
 
@@ -123,18 +131,18 @@ module AppMap
         # Apparently, it's following the CGI spec in doing so.
         # https://datatracker.ietf.org/doc/html/rfc3875#section-4.1.18
         matching_headers = env
-          .select { |k,v| k.to_s.start_with? 'HTTP_' }
-          .merge(
-            'CONTENT_TYPE' => env['CONTENT_TYPE'],
-            'CONTENT_LENGTH' => env['CONTENT_LENGTH'],
-            'AUTHORIZATION' => env['AUTHORIZATION']
-          )
-          .reject { |k,v| blank?(v) }
-          .each_with_object({}) do |kv, memo|
-            key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
-            value = kv[1]
-            memo[key] = value
-          end
+                           .select { |k, _v| k.to_s.start_with? 'HTTP_' }
+                           .merge(
+                             'CONTENT_TYPE' => env['CONTENT_TYPE'],
+                             'CONTENT_LENGTH' => env['CONTENT_LENGTH'],
+                             'AUTHORIZATION' => env['AUTHORIZATION']
+                           )
+                           .reject { |_k, v| blank?(v) }
+                           .each_with_object({}) do |kv, memo|
+          key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+          value = kv[1]
+          memo[key] = value
+        end
         finalize_headers.call(matching_headers)
       end
 
@@ -143,7 +151,7 @@ module AppMap
         is_bundled_path  = -> { path.index(Bundler.bundle_path.to_s) == 0 }
         is_vendored_path = -> { path.index(File.join(Dir.pwd, 'vendor/bundle')) == 0 }
 
-        if is_local_path.() && !is_bundled_path.() && !is_vendored_path.()
+        if is_local_path.call && !is_bundled_path.call && !is_vendored_path.call
           path[Dir.pwd.length + 1..-1]
         else
           path
@@ -153,7 +161,7 @@ module AppMap
       def format_exception(exception)
         {
           class: exception.class.name,
-          message: AppMap::Event::MethodEvent.display_string(exception.to_s),
+          message: AppMap::Event::MethodEvent.display_string(exception.to_s)
         }
       end
 
@@ -164,7 +172,10 @@ module AppMap
           first_location = exception.backtrace_locations&.find do |location|
             !Pathname.new(normalize_path(location.absolute_path || location.path)).absolute?
           end
-          test_failure[:location] = [ normalize_path(first_location.path), first_location.lineno ].join(':') if first_location
+          if first_location
+            test_failure[:location] =
+              [ normalize_path(first_location.path), first_location.lineno ].join(':')
+          end
         end
       end
 
@@ -175,7 +186,7 @@ module AppMap
         tokens = path.split('/')
         tokens.map do |token|
           # stop matching if an ending ) is found
-          token.gsub(/^:(.*[^\)])/, '{\1}')
+          token.gsub(/^:(.*[^)])/, '{\1}')
         end.join('/')
       end
 
@@ -196,22 +207,23 @@ module AppMap
 
       def color(text, color, bold: false)
         color = Util.const_get(color.to_s.upcase) if color.is_a?(Symbol)
-        bold  = bold ? BOLD : ""
+        bold  = bold ? BOLD : ''
         "#{bold}#{color}#{text}#{CLEAR}"
       end
 
       def classify(word)
-        word.split(/[\-_]/).map(&:capitalize).join
+        word.split(/[-_]/).map(&:capitalize).join
       end
 
       # https://api.rubyonrails.org/v6.1.3.2/classes/ActiveSupport/Inflector.html#method-i-underscore
       def underscore(camel_cased_word)
         return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
-        word = camel_cased_word.to_s.gsub("::", "/")
+
+        word = camel_cased_word.to_s.gsub('::', '/')
         # word.gsub!(inflections.acronyms_underscore_regex) { "#{$1 && '_' }#{$2.downcase}" }
         word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
         word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-        word.tr!("-", "_")
+        word.tr!('-', '_')
         word.downcase!
         word
       end
@@ -223,7 +235,7 @@ module AppMap
 
       def blank?(obj)
         return true if obj.nil?
-        
+
         return true if obj.is_a?(String) && obj == ''
 
         return true if obj.respond_to?(:length) && obj.length == 0

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.99.4'
+  VERSION = '0.101.0'
 
   APPMAP_FORMAT_VERSION = '1.12.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.99.4
+  version: 0.101.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -308,6 +308,7 @@ description:
 email:
 - kgilpin@gmail.com
 executables:
+- appmap-agent-config
 - appmap-agent-init
 - appmap-agent-status
 - appmap-agent-validate
@@ -347,6 +348,7 @@ files:
 - examples/mock_webapp/lib/mock_webapp/controller.rb
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
+- exe/appmap-agent-config
 - exe/appmap-agent-init
 - exe/appmap-agent-status
 - exe/appmap-agent-validate
@@ -365,6 +367,7 @@ files:
 - lib/appmap/builtin_hooks/psych.yml
 - lib/appmap/builtin_hooks/ruby.yml
 - lib/appmap/class_map.rb
+- lib/appmap/command/agent_setup/config.rb
 - lib/appmap/command/agent_setup/init.rb
 - lib/appmap/command/agent_setup/status.rb
 - lib/appmap/command/agent_setup/validate.rb
@@ -422,6 +425,7 @@ files:
 - lib/appmap/record.rb
 - lib/appmap/recording_methods.rb
 - lib/appmap/rspec.rb
+- lib/appmap/rswag.rb
 - lib/appmap/service/config_analyzer.rb
 - lib/appmap/service/guesser.rb
 - lib/appmap/service/integration_test_path_finder.rb