appmap 0.38.1 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0255347aa61c6f39bfec0f43a78b3cc3060bd20e4f80f1e39e0ff3714a52dff3
-  data.tar.gz: 822bc2fe118426d6d9c9437c85ead8e603a446cabd6bd49d0053c2b1cfaf3789
+  metadata.gz: 7f48fa55666d8310e8a24c268a7b72c1748c22fe0aa9b884000b1e83a703dbac
+  data.tar.gz: 5d82f1809e549bc71659048a9dce037eafe6e261c63c09d127bbd6b1f43d5b3c
 SHA512:
-  metadata.gz: 031534a5eb015fa99d6ad161665b131677cadbe41ed1bce20357cb1ded7ba19e5f0bcbe37cfef0c8ad35cc2904fe83e4cc9d2b12d04260b970d24cc9aea64ba3
-  data.tar.gz: e7996262f4da21936567c1238df624220987ed04bf5aebd9a525da4d3f181ca752c1060056a5bb41b52c9cdb29e958cf7335973ac7076113278c7e8583755477
+  metadata.gz: 5077fd340fac2478af5361e518c777b8ef76ffeb358aee18f6f507a6314b687ea02a40721b32fe0d2886d279e76ed3d249f9ebfd7b850fb05a1d5d2168b62c6c
+  data.tar.gz: 97b2c5306bd7b07d9f853b883d1ece37f6160683ae0eec5c5d6afe9e6909311468fb2def4e2f70c439ad18a56f9262e77569c7385b2d34dca28e02119302b57d

data/.rubocop.yml

@@ -4,6 +4,9 @@ AllCops:
 Layout/CaseIndentation:
   EnforcedStyle: end
 
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 
@@ -17,13 +20,14 @@ Layout/LineLength:
 Metrics/BlockLength:
   ExcludedMethods:
   - it
+  - context
 
 Style/MultilineBlockChain:
   Enabled: false
 
 Style/NumericPredicate:
   Enabled: false
-  
+
 Style/AndOr:
   Enabled: false
 

data/.travis.yml

@@ -28,13 +28,6 @@ jobs:
     script:
     - bundle exec rake build:base:2.6
       
-  - stage: fixtures
-    script:
-    - bundle exec rake build:fixtures:2.5:all
-  - stage: fixtures
-    script:
-    - bundle exec rake build:fixtures:2.6:all
-
   - stage: spec
     script:
     - bundle exec rake spec:2.5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.39.0
+
+* Recognize and record `normalized_path_info` in Rails applications, per 1.4 AppMap format version.
+
 # v0.38.1
 
 * Package configuration can be `shallow`, in case which only the initial entry into the package is recorded.

data/README.md

@@ -171,16 +171,22 @@ Note that `test_helper.rb` in a Rails project typically loads the application's
 require_relative '../config/environment'
 ```
 
-and `appmap/rspec` must be required before this:
+and `appmap/minitest` must be required before this:
 
 ```ruby
-require 'appmap/rspec'
+require 'appmap/minitest'
 require_relative '../config/environment'
 ```
 
-2) Run the tests with the environment variable `APPMAP=true`:
+2) Run your tests as you normally would with the environment variable `APPMAP=true`. For example:  
 
-```sh-session
+```
+$ APPMAP=true bundle exec rake
+```
+
+or
+
+```
 $ APPMAP=true bundle exec -Ilib -Itest test/*
 ```
 

data/lib/appmap/rails/request_handler.rb

@@ -7,12 +7,13 @@ module AppMap
   module Rails
     module RequestHandler
       class HTTPServerRequest < AppMap::Event::MethodEvent
-        attr_accessor :request_method, :path_info, :params
+        attr_accessor :normalized_path_info, :request_method, :path_info, :params
 
         def initialize(request)
           super AppMap::Event.next_id_counter, :call, Thread.current.object_id
 
           @request_method = request.request_method
+          @normalized_path_info = normalized_path request
           @path_info = request.path_info.split('?')[0]
           # ActionDispatch::Http::ParameterFilter is deprecated
           parameter_filter_cls = \
@@ -28,8 +29,9 @@ module AppMap
           super.tap do |h|
             h[:http_server_request] = {
               request_method: request_method,
-              path_info: path_info
-            }
+              path_info: path_info,
+              normalized_path_info: normalized_path_info
+            }.compact
 
             h[:message] = params.keys.map do |key|
               val = params[key]
@@ -42,6 +44,13 @@ module AppMap
             end
           end
         end
+
+        private
+
+        def normalized_path(request)
+          route = ::Rails.application.routes.router.enum_for(:recognize, request).first
+          route.first.path.spec.to_s if route
+        end
       end
 
       class HTTPServerResponse < AppMap::Event::MethodReturnIgnoreValue

data/lib/appmap/version.rb

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

data/spec/abstract_controller_base_spec.rb

@@ -1,120 +1,150 @@
 require 'rails_spec_helper'
 
 describe 'AbstractControllerBase' do
-  shared_examples 'rails version' do |rails_major_version|
-    include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" 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"
       def run_spec(spec_name)
-        cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}"
+        FileUtils.rm_rf tmpdir
+        FileUtils.mkdir_p tmpdir
+        cmd = <<~CMD.gsub "\n", ' '
+          docker-compose run --rm -e APPMAP=true
+          -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
+        CMD
         run_cmd cmd, chdir: fixture_dir
       end
 
-      before do
-        FileUtils.rm_rf tmpdir
-        FileUtils.mkdir_p tmpdir
-        run_spec spec_name
+      def tmpdir
+        'tmp/spec/AbstractControllerBase'
       end
 
-      let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+      let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
+      let(:events) { appmap['events'] }
 
       describe 'testing with rspec' do
-        let(:spec_name) { 'spec/controllers/users_controller_api_spec.rb:8' }
-        let(:appmap_json_file) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
-
         describe 'creating a user' do
+          before(:all) { run_spec 'spec/controllers/users_controller_api_spec.rb:8' }
+          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
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file)).to_yaml
-
-            expect(appmap).to include(<<-MESSAGE.strip)
-  message:
-  - name: login
-    class: String
-    value: alice
-    object_id:
-            MESSAGE
-
-            expect(appmap).to include(<<-MESSAGE.strip)
-  - name: password
-    class: String
-    value: "[FILTERED]"
-    object_id:
-            MESSAGE
-
-            expect(appmap).to include(<<-SERVER_REQUEST.strip)
-  http_server_request:
-    request_method: POST
-    path_info: "/api/users"
-            SERVER_REQUEST
-
-            expect(appmap).to include(<<-SERVER_RESPONSE.strip)
-  http_server_response:
-    status: 201
-    mime_type: application/json; charset=utf-8
-            SERVER_RESPONSE
+            expect(events).to include(
+              hash_including(
+                'http_server_request' => hash_including(
+                  'request_method' => 'POST',
+                  'path_info' => '/api/users'
+                ),
+                'message' => include(
+                  hash_including(
+                    'name' => 'login',
+                    'class' => 'String',
+                    'value' => 'alice',
+                    'object_id' => Integer
+                  ),
+                  hash_including(
+                    'name' => 'password',
+                    'class' => 'String',
+                    'value' => '[FILTERED]',
+                    'object_id' => Integer
+                  )
+                )
+              ),
+              hash_including(
+                'http_server_response' => {
+                  'status' => 201,
+                  'mime_type' => 'application/json; charset=utf-8'
+                }
+              )
+            )
           end
 
           it 'properly captures method parameters in the appmap' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file)).to_yaml
-
-            expect(appmap).to match(<<-CREATE_CALL.strip)
-  event: call
-  thread_id: .*
-  defined_class: Api::UsersController
-  method_id: build_user
-  path: app/controllers/api/users_controller.rb
-  lineno: 23
-  static: false
-  parameters:
-  - name: params
-    class: ActiveSupport::HashWithIndifferentAccess
-    object_id: .*
-    value: '{"login"=>"alice"}'
-    kind: req
-  receiver:
-            CREATE_CALL
+            expect(events).to include hash_including(
+              'event' => 'call',
+              'thread_id' => Integer,
+              'defined_class' => 'Api::UsersController',
+              'method_id' => 'build_user',
+              'path' => 'app/controllers/api/users_controller.rb',
+              'lineno' => 23,
+              'static' => false,
+              'parameters' => include(
+                'name' => 'params',
+                'class' => 'ActiveSupport::HashWithIndifferentAccess',
+                'object_id' => Integer,
+                'value' => '{"login"=>"alice"}',
+                'kind' => 'req'
+              ),
+              'receiver' => anything
+            )
           end
 
           it 'returns a minimal event' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file))
-            event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
-            expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+            expect(events).to include hash_including(
+              'event' => 'return',
+              'return_value' => Hash,
+              'id' => Integer,
+              'thread_id' => Integer,
+              'parent_id' => Integer,
+              'elapsed' => Numeric
+            )
           end
         end
 
-        describe 'listing users' do
-          let(:spec_name) { 'spec/controllers/users_controller_spec.rb:11' }
-          let(:appmap_json_file) { File.join(tmpdir, 'appmap/rspec/UsersController_GET_users_lists_the_users.appmap.json') }
-          it 'records and labels view rendering' do
-            expect(File).to exist(appmap_json_file)
-            appmap = JSON.parse(File.read(appmap_json_file)).to_yaml
+        describe 'showing a user' do
+          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:22' }
+          let(:appmap_json_file) do
+            'UsersController_GET_users_login_shows_the_user.appmap.json'
+          end
 
-            expect(appmap).to match(<<-VIEW_CALL.strip)
-  event: call
-  thread_id: .*
-  defined_class: ActionView::Renderer
-  method_id: render
-  path: .*
-  lineno: .*
-  static: false
-            VIEW_CALL
+          it 'records the normalized path info' do
+            expect(events).to include(
+              hash_including(
+                'http_server_request' => {
+                  'request_method' => 'GET',
+                  'path_info' => '/users/alice',
+                  'normalized_path_info' => '/users/:id(.:format)'
+                }
+              )
+            )
+          end
+        end
 
-            expect(appmap).to match(<<-VIEW_LABEL.strip)
-        labels:
-        - view
-            VIEW_LABEL
+        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(
+              'event' => 'call',
+              'thread_id' => Numeric,
+              'defined_class' => 'ActionView::Renderer',
+              'method_id' => 'render',
+              'path' => String,
+              'lineno' => Integer,
+              'static' => false
+            )
+
+            expect(appmap['classMap']).to include hash_including(
+              'name' => 'action_view',
+              'children' => include(hash_including(
+                'name' => 'ActionView',
+                'children' => include(hash_including(
+                  'name' => 'Renderer',
+                  'children' => include(hash_including(
+                    'name' => 'render',
+                    'labels' => ['view']
+                  ))
+                ))
+              ))
+            )
           end
         end
       end
     end
   end
-
-  %w[5 6].each do |version|
-    it_behaves_like 'rails version', version
-  end
 end

data/spec/fixtures/rails5_users_app/app/controllers/users_controller.rb

@@ -2,4 +2,12 @@ class UsersController < ApplicationController
   def index
     @users = User.all
   end
+
+  def show
+    if (@user = User[login: params[:id]])
+      render plain: @user
+    else
+      render plain: 'Not found', status: 404
+    end
+  end
 end

data/spec/fixtures/rails5_users_app/config/routes.rb

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
     resources :users, only: %i[index create]
   end
 
-  resources :users, only: %i[index]
+  resources :users, only: %i[index show]
 
   get 'health', to: 'health#show'
 

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_spec.rb

@@ -13,4 +13,15 @@ RSpec.describe UsersController, type: :controller do
       expect(response).to be_ok
     end
   end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
 end

data/spec/fixtures/rails6_users_app/app/controllers/users_controller.rb

@@ -2,4 +2,12 @@ class UsersController < ApplicationController
   def index
     @users = User.all
   end
+
+  def show
+    if (@user = User[login: params[:id]])
+      render plain: @user
+    else
+      render plain: 'Not found', status: 404
+    end
+  end
 end

data/spec/fixtures/rails6_users_app/config/routes.rb

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
     resources :users, only: %i[index create]
   end
 
-  resources :users, only: %i[index]
+  resources :users, only: %i[index show]
 
   get 'health', to: 'health#show'
 

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -13,4 +13,15 @@ RSpec.describe UsersController, type: :controller do
       expect(response).to be_ok
     end
   end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
 end

data/spec/rails_spec_helper.rb

@@ -30,7 +30,7 @@ def run_cmd(*cmd, &failed)
 end
 
 shared_context 'Rails app pg database' do |fixture_dir|
-  let(:fixture_dir) { fixture_dir }
+  define_method(:fixture_dir) { fixture_dir }
 
   before(:all) do
     print_pg_logs = lambda do
@@ -40,7 +40,7 @@ shared_context 'Rails app pg database' do |fixture_dir|
       puts logs
     end
 
-    Dir.chdir fixture_dir do 
+    Dir.chdir fixture_dir do
       run_cmd 'docker-compose down -v'
       cmd = 'docker-compose up -d pg'
       run_cmd cmd

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.38.1
+  version: 0.39.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport