appmap 0.42.1 → 0.46.0

data/lib/appmap/trace.rb

@@ -2,14 +2,36 @@
 
 module AppMap
   module Trace
-    class ScopedMethod < SimpleDelegator
-      attr_reader :package, :defined_class, :static
+    class RubyMethod
+      attr_reader :class_name, :static
 
-      def initialize(package, defined_class, method, static)
+      def initialize(package, class_name, method, static)
         @package = package
-        @defined_class = defined_class
+        @class_name = class_name
+        @method = method
         @static = static
-        super(method)
+      end
+
+      def source_location
+        @method.source_location
+      end
+
+      def comment
+        @method.comment
+      rescue MethodSource::SourceNotFoundError
+        nil
+      end
+
+      def package
+        @package.name
+      end
+
+      def name
+        @method.name
+      end
+
+      def labels
+        @package.labels
       end
     end
 
@@ -43,6 +65,12 @@ module AppMap
         end
       end
 
+      def record_method(method)
+        @tracers.each do |tracer|
+          tracer.record_method(method)
+        end
+      end
+
       def delete(tracer)
         return unless @tracers.member?(tracer)
 
@@ -82,10 +110,23 @@ 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::RubyMethod.new(package, defined_class, method, static) \
         if package && defined_class && method && (event.event == :call)
     end
 
+    # +method+ should be duck-typed to respond to the following:
+    # * package
+    # * defined_class
+    # * name
+    # * static
+    # * comment
+    # * labels
+    # * source_location
+    def record_method(method)
+      @methods << method
+    end
+
     # Gets the last package which was observed on the current thread.
     def last_package_for_current_thread
       @last_package_for_thread[Thread.current.object_id]

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,43 @@ 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
+
+      def normalize_path(path)
+        if path.index(Dir.pwd) == 0
+          path[Dir.pwd.length + 1..-1]
+        else
+          path
+        end
+      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.42.1'
+  VERSION = '0.46.0'
 
-  APPMAP_FORMAT_VERSION = '1.4'
+  APPMAP_FORMAT_VERSION = '1.5.0'
 end

data/package-lock.json

@@ -551,9 +551,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.19",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
-      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
     },
     "longest": {
       "version": "1.0.1",

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,89 @@ 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 'a UI route' do
+        describe 'rendering a page using a template file' do
+          let(:appmap_json_file) do
+            'UsersController_GET_users_lists_the_users.appmap.json'
+          end
+
+          it 'records the template file' do
+            expect(events).to include hash_including(
+              'event' => 'call',
+              'defined_class' => 'app_views_users_index_html_haml',
+              'method_id' => 'render',
+              'path' => 'app/views/users/index.html.haml'
+            )
+
+            expect(appmap['classMap']).to include hash_including(
+              'name' => 'app/views',
+              'children' => include(hash_including(
+                'name' => 'app_views_users_index_html_haml',
+                'children' => include(hash_including(
+                  'name' => 'render',
+                  'type' => 'function',
+                  'location' => 'app/views/users/index.html.haml',
+                  'static' => true,
+                  'labels' => [ 'mvc.template' ]
+                ))
+              ))
+            )
+            expect(appmap['classMap']).to include hash_including(
+              'name' => 'app/views',
+              'children' => include(hash_including(
+                'name' => 'app_views_layouts_application_html_haml',
+                'children' => include(hash_including(
+                  'name' => 'render',
+                  'type' => 'function',
+                  'location' => 'app/views/layouts/application.html.haml',
+                  'static' => true,
+                  'labels' => [ 'mvc.template' ]
+                ))
+              ))
+            )
+          end
         end
 
-        describe 'showing a user' do
-          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:22' }
+        describe 'rendering a page using a text template' do
           let(:appmap_json_file) do
             'UsersController_GET_users_login_shows_the_user.appmap.json'
           end
@@ -107,30 +197,46 @@ 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 'ignores the text template' do
+            expect(events).to_not include hash_including(
+              'event' => 'call',
+              'method_id' => 'render',
+              'render_template' => anything
+            )
+
+            expect(appmap['classMap']).to_not include hash_including(
+              'name' => 'views',
+              'children' => include(hash_including(
+                'name' => 'ViewTemplate',
+                'children' => include(hash_including(
+                  'name' => 'render',
+                  'type' => 'function',
+                  'location' => 'text template'
+                ))
+              ))
+            )
+          end
 
           it 'records and labels view rendering' do
             expect(events).to include hash_including(
               'event' => 'call',
               'thread_id' => Numeric,
-              'defined_class' => 'ActionView::Renderer',
-              'method_id' => 'render',
-              'path' => String,
-              'lineno' => Integer,
-              'static' => false
+              'defined_class' => 'inline_template',
+              'method_id' => 'render'
             )
-
+  
             expect(appmap['classMap']).to include hash_including(
-              'name' => 'action_view',
+              'name' => 'actionview',
               'children' => include(hash_including(
                 'name' => 'ActionView',
                 'children' => include(hash_including(
@@ -142,7 +248,7 @@ describe 'AbstractControllerBase' do
                 ))
               ))
             )
-          end
+          end  
         end
       end
     end

data/spec/class_map_spec.rb

@@ -4,18 +4,10 @@ require 'spec_helper'
 
 describe 'AppMap::ClassMap' do
   describe '.build_from_methods' do
-    it 'includes source code if available' do
-      map = AppMap.class_map([scoped_method(method(:test_method))])
+    it 'includes method comment' do
+      map = AppMap.class_map([ruby_method((method :test_method))])
       function = dig_map(map, 5)[0]
-      expect(function[:source]).to include 'test method body'
-      expect(function[:comment]).to include 'test method comment'
-    end
-
-    it 'can omit source code even if available' do
-      map = AppMap.class_map([scoped_method((method :test_method))], include_source: false)
-      function = dig_map(map, 5)[0]
-      expect(function).to_not include(:source)
-      expect(function).to_not include(:comment)
+      expect(function).to include(:comment)
     end
 
     # test method comment
@@ -23,8 +15,8 @@ describe 'AppMap::ClassMap' do
       'test method body'
     end
 
-    def scoped_method(method)
-      AppMap::Trace::ScopedMethod.new AppMap::Config::Package.new, method.receiver.class.name, method, false
+    def ruby_method(method)
+      AppMap::Trace::RubyMethod.new AppMap::Config::Package.new, method.receiver.class.name, method, false
     end
 
     def dig_map(map, depth)