appmap 0.44.0 → 0.47.1

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
@@ -72,6 +80,37 @@ 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
+
+      # Convert a Rails-style path from /org/:org_id(.:format)
+      # to Swagger-style paths like /org/{org_id}
+      def swaggerize_path(path)
+        path = path.split('(.')[0]
+        tokens = path.split('/')
+        tokens.map do |token|
+          token.gsub /^:(.*)/, '{\1}'
+        end.join('/')
+      end
+
       # Atomically writes AppMap data to +filename+.
       def write_appmap(filename, appmap)
         require 'fileutils'

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.44.0'
+  VERSION = '0.47.1'
 
-  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

@@ -42,7 +42,7 @@ describe 'Rails' do
               hash_including(
                 'http_server_request' => hash_including(
                   'request_method' => 'POST',
-                  'normalized_path_info' => '/api/users(.:format)',
+                  'normalized_path_info' => '/api/users',
                   'path_info' => '/api/users'
                 ),
                 'message' => include(
@@ -67,8 +67,8 @@ describe 'Rails' do
             expect(events).to include(
               hash_including(
                 'http_server_response' => hash_including(
-                  'status' => 201,
-                  'mime_type' => 'application/json; charset=utf-8'
+                  'status_code' => 201,
+                  'mime_type' => 'application/json; charset=utf-8',
                 )
               )
             )
@@ -144,7 +144,49 @@ describe 'Rails' do
       end
 
       describe 'a UI route' do
-        describe 'rendering a page' 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 'rendering a page using a text template' do
           let(:appmap_json_file) do
             'UsersController_GET_users_login_shows_the_user.appmap.json'
           end
@@ -155,25 +197,46 @@ describe 'Rails' do
                 'http_server_request' => {
                   'request_method' => 'GET',
                   'path_info' => '/users/alice',
-                  'normalized_path_info' => '/users/:id(.:format)'
+                  'normalized_path_info' => '/users/{id}',
+                  'headers' => {
+                    'Host' => 'test.host', 
+                    'User-Agent' => 'Rails Testing'
+                  }
                 }
               )
             )
           end
 
+          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(

data/spec/class_map_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe 'AppMap::ClassMap' do
   describe '.build_from_methods' do
     it 'includes method comment' do
-      map = AppMap.class_map([scoped_method((method :test_method))])
+      map = AppMap.class_map([ruby_method((method :test_method))])
       function = dig_map(map, 5)[0]
       expect(function).to include(:comment)
     end
@@ -15,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)

data/spec/config_spec.rb

@@ -34,10 +34,12 @@ describe AppMap::Config, docker: false do
       name: 'test',
       packages: [
         {
-          path: 'path-1'
+          path: 'path-1',
+          handler_class: 'AppMap::Handler::Function'
         },
         {
           path: 'path-2',
+          handler_class: 'AppMap::Handler::Function',
           exclude: [ 'exclude-1' ]
         }
       ],

data/spec/hook_spec.rb

@@ -16,14 +16,7 @@ end
 Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
 
 describe 'AppMap class Hooking', docker: false do
-  require 'appmap/util'
-  def collect_events(tracer)
-    [].tap do |events|
-      while tracer.event?
-        events << tracer.next_event.to_h
-      end
-    end.map(&AppMap::Util.method(:sanitize_event))
-  end
+  include_context 'collect events'
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
@@ -67,69 +60,18 @@ describe 'AppMap class Hooking', docker: false do
     config = AppMap::Config.new('hook_spec', [ package ], exclude: %w[ExcludeTest])
     AppMap.configuration = config
 
-    expect(config.never_hook?(ExcludeTest.new.method(:instance_method))).to be_truthy
-    expect(config.never_hook?(ExcludeTest.method(:cls_method))).to be_truthy
+    expect(config.never_hook?(ExcludeTest, ExcludeTest.new.method(:instance_method))).to be_truthy
+    expect(config.never_hook?(ExcludeTest, ExcludeTest.method(:cls_method))).to be_truthy
   end
 
-  it "handles an instance method named 'call' without issues" do
+  it "an instance method named 'call' will be ignored" do
     events_yaml = <<~YAML
-    ---
-    - :id: 1
-      :event: :call
-      :defined_class: MethodNamedCall
-      :method_id: call
-      :path: spec/fixtures/hook/method_named_call.rb
-      :lineno: 8
-      :static: false
-      :parameters:
-      - :name: :a
-        :class: Integer
-        :value: '1'
-        :kind: :req
-      - :name: :b
-        :class: Integer
-        :value: '2'
-        :kind: :req
-      - :name: :c
-        :class: Integer
-        :value: '3'
-        :kind: :req
-      - :name: :d
-        :class: Integer
-        :value: '4'
-        :kind: :req
-      - :name: :e
-        :class: Integer
-        :value: '5'
-        :kind: :req
-      :receiver:
-        :class: MethodNamedCall
-        :value: MethodNamedCall
-    - :id: 2
-      :event: :return
-      :parent_id: 1
-      :return_value:
-        :class: String
-        :value: 1 2 3 4 5
+    --- []
     YAML
 
     _, tracer = test_hook_behavior 'spec/fixtures/hook/method_named_call.rb', events_yaml do
       expect(MethodNamedCall.new.call(1, 2, 3, 4, 5)).to eq('1 2 3 4 5')
     end
-    class_map = AppMap.class_map(tracer.event_methods)
-    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
-    ---
-    - :name: spec/fixtures/hook/method_named_call.rb
-      :type: package
-      :children:
-      - :name: MethodNamedCall
-        :type: class
-        :children:
-        - :name: call
-          :type: function
-          :location: spec/fixtures/hook/method_named_call.rb:8
-          :static: false
-    CLASSMAP
   end
 
   it 'can custom hook and label a function' do
@@ -170,7 +112,9 @@ describe 'AppMap class Hooking', docker: false do
     method = hook_cls.instance_method(:say_default)
 
     require 'appmap/hook/method'
-    hook_method = AppMap::Hook::Method.new(config.package_for_method(method), hook_cls, method)
+    package = config.lookup_package(hook_cls, method)
+    expect(package).to be
+    hook_method = AppMap::Hook::Method.new(package, hook_cls, method)
     hook_method.activate
 
     tracer = AppMap.tracing.trace
@@ -255,8 +199,8 @@ describe 'AppMap class Hooking', docker: false do
     _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
       InstanceMethod.new.say_default
     end
-    expect(tracer.event_methods.to_a.map(&:defined_class)).to eq([ 'InstanceMethod' ])
-    expect(tracer.event_methods.to_a.map(&:to_s)).to eq([ InstanceMethod.public_instance_method(:say_default).to_s ])
+    expect(tracer.event_methods.to_a.map(&:class_name)).to eq([ 'InstanceMethod' ])
+    expect(tracer.event_methods.to_a.map(&:name)).to eq([ InstanceMethod.public_instance_method(:say_default).name ])
   end
 
   it 'builds a class map of invoked methods' do
@@ -868,7 +812,9 @@ describe 'AppMap class Hooking', docker: false do
       _, _, events = test_hook_behavior 'spec/fixtures/hook/compare.rb', nil do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
+
       secure_compare_event = YAML.load(events).find { |evt| evt[:defined_class] == 'ActiveSupport::SecurityUtils' }
+      expect(secure_compare_event).to be_truthy
       secure_compare_event.delete(:lineno)
       secure_compare_event.delete(:path)
 

data/spec/record_net_http_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'diffy'
+require 'rack'
+require 'rack/handler/webrick'
+
+class HelloWorldApp
+  def call(env)
+    req = Rack::Request.new(env)
+    case req.path_info
+    when /hello/
+      [200, {"Content-Type" => "text/html"}, ["Hello World!"]]
+    when /goodbye/  
+      [500, {"Content-Type" => "text/html"}, ["Goodbye Cruel World!"]]
+    else
+      [404, {"Content-Type" => "text/html"}, ["I'm Lost!"]]
+    end
+  end
+end
+
+describe 'Net::HTTP handler' do
+  include_context 'collect events'
+
+  def get_hello(params: nil)
+    http = Net::HTTP.new('localhost', 19292)
+    http.get [ '/hello', params ].compact.join('?')
+  end
+  
+  before(:all) do
+    @rack_thread = Thread.new do
+      Rack::Handler::WEBrick.run HelloWorldApp.new, Port: 19292
+    end
+    10.times do
+      sleep 0.1
+      break if get_hello.code.to_i == 200
+    end
+    raise "Web server didn't start" unless get_hello.code.to_i == 200
+  end
+
+  after(:all) do
+    @rack_thread.kill
+  end
+
+  def start_recording
+    AppMap.configuration = configuration
+    AppMap::Hook.new(configuration).enable
+
+    @tracer = AppMap.tracing.trace
+    AppMap::Event.reset_id_counter
+  end
+
+  def record(&block)
+    start_recording
+    begin
+      yield
+    ensure
+      stop_recording
+    end
+  end
+
+  def stop_recording
+    AppMap.tracing.delete(@tracer)
+  end
+
+  context 'with trace enabled' do
+    let(:configuration) { AppMap::Config.new('record_net_http_spec', []) }
+
+    after do
+      AppMap.configuration = nil
+    end
+    
+    describe 'GET request' do
+      it 'with a single query parameter' do
+        record do
+          get_hello(params: 'msg=hi')
+        end
+
+        events = collect_events(@tracer).to_yaml
+        expect(Diffy::Diff.new(<<~EVENTS, events).to_s).to eq('')
+        ---
+        - :id: 1
+          :event: :call
+          :http_client_request:
+            :request_method: GET
+            :url: http://localhost:19292/hello
+            :headers:
+              Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+              Accept: "*/*"
+              User-Agent: Ruby
+              Connection: close
+          :message:
+          - :name: msg
+            :class: String
+            :value: hi
+        - :id: 2
+          :event: :return
+          :parent_id: 1
+          :http_client_response:
+            :status_code: 200
+            :headers:
+              Content-Type: text/html
+              Server: WEBrick
+              Date: "<instanceof date>"
+              Content-Length: '12'
+              Connection: close
+        EVENTS
+      end
+
+      it 'with a multi-valued query parameter' do
+        record do
+          get_hello(params: 'ary[]=1&ary[]=2')
+        end
+
+        event = collect_events(@tracer).first.to_yaml
+        expect(Diffy::Diff.new(<<~EVENT, event).to_s).to eq('')
+        ---
+        :id: 1
+        :event: :call
+        :http_client_request:
+          :request_method: GET
+          :url: http://localhost:19292/hello
+          :headers:
+            Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+            Accept: "*/*"
+            User-Agent: Ruby
+            Connection: close
+        :message:
+        - :name: ary
+          :class: Array
+          :value: '["1", "2"]'
+        EVENT
+      end
+
+      it 'with a URL encoded query parameter' do
+        msg = 'foo/bar?baz'
+        record do
+          get_hello(params: "msg=#{CGI.escape msg}")
+        end
+
+        event = collect_events(@tracer).first.to_yaml
+        expect(Diffy::Diff.new(<<~EVENT, event).to_s).to eq('')
+        ---
+        :id: 1
+        :event: :call
+        :http_client_request:
+          :request_method: GET
+          :url: http://localhost:19292/hello
+          :headers:
+            Accept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+            Accept: "*/*"
+            User-Agent: Ruby
+            Connection: close
+        :message:
+        - :name: msg
+          :class: String
+          :value: #{msg}
+        EVENT
+      end
+    end
+  end
+end