appmap 0.41.2 → 0.45.0

data/lib/appmap/record.rb

@@ -23,5 +23,5 @@ at_exit do
     'classMap' => AppMap.class_map(tracer.event_methods),
     'events' => events
   }
-  File.write 'appmap.json', JSON.generate(appmap)
+  AppMap::Util.write_appmap('appmap.json', JSON.generate(appmap))
 end

data/lib/appmap/rspec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'appmap/util'
+require 'set'
 
 module AppMap
   # Integration of AppMap with RSpec. When enabled with APPMAP=true, the AppMap tracer will
@@ -13,58 +14,9 @@ module AppMap
       AppMap.detect_metadata
     end
 
-    module FeatureAnnotations
-      def feature
-        return nil unless annotations
-
-        annotations[:feature]
-      end
-
-      def labels
-        labels = metadata[:appmap]
-        if labels.is_a?(Array)
-          labels
-        elsif labels.is_a?(String) || labels.is_a?(Symbol)
-          [ labels ]
-        else
-          []
-        end
-      end
-
-      def feature_group
-        return nil unless annotations
-
-        annotations[:feature_group]
-      end
-
-      def annotations
-        metadata.tap do |md|
-          description_args_hashes.each do |h|
-            md.merge! h
-          end
-        end
-      end
-
-      protected
-
-      def metadata
-        return {} unless example_obj.respond_to?(:metadata)
-
-        example_obj.metadata
-      end
-
-      def description_args_hashes
-        return [] unless example_obj.respond_to?(:metadata)
-
-        (example_obj.metadata[:description_args] || []).select { |arg| arg.is_a?(Hash) }
-      end
-    end
-
     # ScopeExample and ScopeExampleGroup is a way to handle the weird way that RSpec
     # stores the nested example names.
     ScopeExample = Struct.new(:example) do
-      include FeatureAnnotations
-
       alias_method :example_obj, :example
 
       def description?
@@ -83,8 +35,6 @@ module AppMap
     # As you can see here, the way that RSpec stores the example description and
     # represents the example group hierarchy is pretty weird.
     ScopeExampleGroup = Struct.new(:example_group) do
-      include FeatureAnnotations
-
       alias_method :example_obj, :example_group
 
       def description_args
@@ -133,13 +83,20 @@ module AppMap
           page.driver.options[:http_client].instance_variable_get('@server_url').port
         end
 
-        warn "Starting recording of example #{example}" if AppMap::RSpec::LOG
+        warn "Starting recording of example #{example}@#{source_location}" if AppMap::RSpec::LOG
         @trace = AppMap.tracing.trace
         @webdriver_port = webdriver_port.()
       end
 
-      def finish
+      def source_location
+        result = example.location_rerun_argument.split(':')[0]
+        result = result[2..-1] if result.index('./') == 0
+        result
+      end
+
+      def finish(exception)
         warn "Finishing recording of example #{example}" if AppMap::RSpec::LOG
+        warn "Exception: #{exception}" if exception && AppMap::RSpec::LOG
 
         events = []
         AppMap.tracing.delete @trace
@@ -148,22 +105,16 @@ module AppMap
 
         AppMap::RSpec.add_event_methods @trace.event_methods
 
-        class_map = AppMap.class_map(@trace.event_methods, include_source: false)
+        class_map = AppMap.class_map(@trace.event_methods)
 
         description = []
         scope = ScopeExample.new(example)
-        feature_group = feature = nil
 
-        labels = []
         while scope
-          labels += scope.labels
           description << scope.description
-          feature ||= scope.feature
-          feature_group ||= scope.feature_group
           scope = scope.parent
         end
 
-        labels = labels.map(&:to_s).map(&:strip).reject(&:blank?).map(&:downcase).uniq
         description.reject!(&:nil?).reject!(&:blank?)
         default_description = description.last
         description.reverse!
@@ -177,24 +128,12 @@ module AppMap
 
         full_description = normalize.call(description.join(' '))
 
-        compute_feature_name = lambda do
-          return 'unknown' if description.empty?
-
-          feature_description = description.dup
-          num_tokens = [2, feature_description.length - 1].min
-          feature_description[0...num_tokens].map(&:strip).join(' ')
-        end
-
-        feature_group ||= normalize.call(default_description).underscore.gsub('/', '_').humanize
-        feature_name = feature || compute_feature_name.call if feature_group
-        feature_name = normalize.call(feature_name) if feature_name
-
-        AppMap::RSpec.save full_description,
-                           class_map,
-                           events: events,
-                           feature_name: feature_name,
-                           feature_group_name: feature_group,
-                           labels: labels.blank? ? nil : labels
+        AppMap::RSpec.save name: full_description,
+                           class_map: class_map,
+                           source_location: source_location,
+                           test_status: exception ? 'failed' : 'succeeded',
+                           exception: exception,
+                           events: events
       end
     end
 
@@ -212,11 +151,11 @@ module AppMap
         @recordings_by_example[example.object_id] = Recording.new(example)
       end
 
-      def end_spec(example)
+      def end_spec(example, exception:)
         recording = @recordings_by_example.delete(example.object_id)
         return warn "No recording found for #{example}" unless recording
 
-        recording.finish
+        recording.finish exception
       end
 
       def config
@@ -227,13 +166,11 @@ module AppMap
         @event_methods += event_methods
       end
 
-      def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
+      def save(name:, class_map:, source_location:, test_status:, exception:, events:)
         metadata = AppMap::RSpec.metadata.tap do |m|
-          m[:name] = example_name
+          m[:name] = name
+          m[:source_location] = source_location
           m[:app] = AppMap.configuration.name
-          m[:feature] = feature_name if feature_name
-          m[:feature_group] = feature_group_name if feature_group_name
-          m[:labels] = labels if labels
           m[:frameworks] ||= []
           m[:frameworks] << {
             name: 'rspec',
@@ -242,6 +179,13 @@ module AppMap
           m[:recorder] = {
             name: 'rspec'
           }
+          m[:test_status] = test_status
+          if exception
+            m[:exception] = {
+              class: exception.class.name,
+              message: exception.to_s
+            }
+          end
         end
 
         appmap = {
@@ -250,14 +194,9 @@ module AppMap
           classMap: class_map,
           events: events
         }.compact
-        fname = AppMap::Util.scenario_filename(example_name)
-
-        File.write(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
-      end
+        fname = AppMap::Util.scenario_filename(name)
 
-      def print_inventory
-        class_map = AppMap.class_map(@event_methods)
-        save 'Inventory', class_map, labels: %w[inventory]
+        AppMap::Util.write_appmap(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
       end
 
       def enabled?
@@ -266,9 +205,6 @@ module AppMap
 
       def run
         init
-        at_exit do
-          print_inventory
-        end
       end
     end
   end
@@ -290,7 +226,7 @@ if AppMap::RSpec.enabled?
               begin
                 instance_exec(&fn)
               ensure
-                AppMap::RSpec.end_spec example
+                AppMap::RSpec.end_spec example, exception: $!
               end
             end
           end

data/lib/appmap/trace.rb

@@ -82,7 +82,8 @@ module AppMap
 
       @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event
-      @methods << Trace::ScopedMethod.new(package, defined_class, method, event.static) \
+      static = event.static if event.respond_to?(:static)
+      @methods << Trace::ScopedMethod.new(package, defined_class, method, static) \
         if package && defined_class && method && (event.event == :call)
     end
 

data/lib/appmap/util.rb

@@ -61,8 +61,16 @@ module AppMap
         delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
         delete_object_id.call(event[:receiver])
         delete_object_id.call(event[:return_value])
-        (event[:parameters] || []).each(&delete_object_id)
-        (event[:exceptions] || []).each(&delete_object_id)
+        %i[parameters exceptions message].each do |field|
+          (event[field] || []).each(&delete_object_id)
+        end
+        %i[http_client_request http_client_response http_server_request http_server_response].each do |field|
+          headers = event.dig(field, :headers)
+          next unless headers
+
+          headers['Date'] = '<instanceof date>' if headers['Date']
+          headers['Server'] = headers['Server'].match(/^(\w+)/)[0] if headers['Server']
+        end
 
         case event[:event]
         when :call
@@ -71,6 +79,35 @@ module AppMap
 
         event
       end
+
+      def select_headers(env)
+        # Rack prepends HTTP_ to all client-sent headers.
+        matching_headers = env
+          .select { |k,v| k.start_with? 'HTTP_'}
+          .reject { |k,v| v.blank? }
+          .each_with_object({}) do |kv, memo|
+            key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+            value = kv[1]
+            memo[key] = value
+          end
+        matching_headers.blank? ? nil : matching_headers
+      end
+
+      # Atomically writes AppMap data to +filename+.
+      def write_appmap(filename, appmap)
+        require 'fileutils'
+        require 'tmpdir'
+
+        # This is what Ruby Tempfile does; but we don't want the file to be unlinked.
+        mode = File::RDWR | File::CREAT | File::EXCL
+        ::Dir::Tmpname.create([ 'appmap_', '.json' ]) do |tmpname|
+          tempfile = File.open(tmpname, mode)
+          tempfile.write(appmap)
+          tempfile.close
+          # Atomically move the tempfile into place.
+          FileUtils.mv tempfile.path, filename
+        end
+      end
     end
   end
 end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.41.2'
+  VERSION = '0.45.0'
 
-  APPMAP_FORMAT_VERSION = '1.4'
+  APPMAP_FORMAT_VERSION = '1.5.0'
 end

data/release.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# using bash wrapper as Rake blows up in `require/extentiontask` (line 10)
+
+RELEASE_FLAGS=""
+if [ ! -z "$TRAVIS_REPO_SLUG" ]; then
+    RELEASE_FLAGS="-r git+https://github.com/${TRAVIS_REPO_SLUG}.git"
+fi 
+
+if [ ! -z "$GEM_ALTERNATIVE_NAME" ]; then
+    echo "Release: GEM_ALTERNATIVE_NAME=$GEM_ALTERNATIVE_NAME"
+else
+    echo "No GEM_ALTERNATIVE_NAME is provided, releasing gem with default name ('appmap')"
+fi
+
+set -x
+exec semantic-release $RELEASE_FLAGS
+

data/spec/abstract_controller_base_spec.rb

@@ -1,12 +1,11 @@
 require 'rails_spec_helper'
 
-describe 'AbstractControllerBase' do
+describe 'Rails' do
   %w[5 6].each do |rails_major_version| # rubocop:disable Metrics/BlockLength
-    context "in Rails #{rails_major_version}" do
-      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app"
+    context "#{rails_major_version}" do
+      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
+
       def run_spec(spec_name)
-        FileUtils.rm_rf tmpdir
-        FileUtils.mkdir_p tmpdir
         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}
@@ -18,25 +17,32 @@ describe 'AbstractControllerBase' do
         'tmp/spec/AbstractControllerBase'
       end
 
+      unless use_existing_data?
+        before(:all) do
+          FileUtils.rm_rf tmpdir
+          FileUtils.mkdir_p tmpdir
+          run_spec 'spec/controllers/users_controller_spec.rb'
+          run_spec 'spec/controllers/users_controller_api_spec.rb'
+        end
+      end
+
       let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
+      let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
+      let(:appmap) { JSON.parse File.read(appmap_json_path) }
       let(:events) { appmap['events'] }
 
-      describe 'testing with rspec' do
-        describe 'creating a user' do
-          before(:all) { run_spec 'spec/controllers/users_controller_api_spec.rb:8' }
+      describe 'an API route' do
+        describe 'creating an object' do
           let(:appmap_json_file) do
             'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
           end
 
-          it 'inventory file is printed' do
-            expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
-          end
-
-          it 'message fields are recorded in the appmap' do
+          it 'http_server_request is recorded in the appmap' do
             expect(events).to include(
               hash_including(
                 'http_server_request' => hash_including(
                   'request_method' => 'POST',
+                  'normalized_path_info' => '/api/users(.:format)',
                   'path_info' => '/api/users'
                 ),
                 'message' => include(
@@ -53,12 +59,17 @@ describe 'AbstractControllerBase' do
                     'object_id' => Integer
                   )
                 )
-              ),
+              )
+            )
+          end
+
+          it 'http_server_response is recorded in the appmap' do
+            expect(events).to include(
               hash_including(
-                'http_server_response' => {
-                  'status' => 201,
-                  'mime_type' => 'application/json; charset=utf-8'
-                }
+                'http_server_response' => hash_including(
+                  'status_code' => 201,
+                  'mime_type' => 'application/json; charset=utf-8',
+                )
               )
             )
           end
@@ -70,7 +81,7 @@ describe 'AbstractControllerBase' do
               'defined_class' => 'Api::UsersController',
               'method_id' => 'build_user',
               'path' => 'app/controllers/api/users_controller.rb',
-              'lineno' => 23,
+              'lineno' => Integer,
               'static' => false,
               'parameters' => include(
                 'name' => 'params',
@@ -93,10 +104,47 @@ describe 'AbstractControllerBase' do
               'elapsed' => Numeric
             )
           end
+
+          context 'with an object-style message' do
+            let(:appmap_json_file) { 'Api_UsersController_POST_api_users_with_required_parameters_with_object-style_parameters_creates_a_user.appmap.json' }
+
+            it 'message properties are recorded in the appmap' do
+              expect(events).to include(
+                hash_including(
+                  'message' => include(
+                    hash_including(
+                      'name' => 'user',
+                      'properties' => [
+                        { 'name' => 'login', 'class' => 'String' },
+                        { 'name' => 'password', 'class' => 'String' }
+                      ]
+                    )
+                  )
+                )
+              )    
+            end
+          end
+        end
+
+        describe 'listing objects' do
+          context 'with a custom header' do
+            let(:appmap_json_file) { 'Api_UsersController_GET_api_users_with_a_custom_header_lists_the_users.appmap.json' }
+
+            it 'custom header is recorded in the appmap' do
+              expect(events).to include(
+                hash_including(
+                  'http_server_request' => hash_including(
+                    'headers' => hash_including('X-Sandwich' => 'turkey')
+                  )
+                )
+              )
+            end
+          end
         end
+      end
 
-        describe 'showing a user' do
-          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:22' }
+      describe 'a UI route' do
+        describe 'rendering a page' do
           let(:appmap_json_file) do
             'UsersController_GET_users_login_shows_the_user.appmap.json'
           end
@@ -107,16 +155,15 @@ describe 'AbstractControllerBase' do
                 'http_server_request' => {
                   'request_method' => 'GET',
                   'path_info' => '/users/alice',
-                  'normalized_path_info' => '/users/:id(.:format)'
+                  'normalized_path_info' => '/users/:id(.:format)',
+                  'headers' => {
+                    'Host' => 'test.host', 
+                    'User-Agent' => 'Rails Testing'
+                  }
                 }
               )
             )
           end
-        end
-
-        describe 'listing users' do
-          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:11' }
-          let(:appmap_json_file) { 'UsersController_GET_users_lists_the_users.appmap.json' }
 
           it 'records and labels view rendering' do
             expect(events).to include hash_including(
@@ -128,7 +175,7 @@ describe 'AbstractControllerBase' do
               'lineno' => Integer,
               'static' => false
             )
-
+  
             expect(appmap['classMap']).to include hash_including(
               'name' => 'action_view',
               'children' => include(hash_including(
@@ -142,7 +189,7 @@ describe 'AbstractControllerBase' do
                 ))
               ))
             )
-          end
+          end  
         end
       end
     end