feat: Emit swagger-style normalized paths instead of Rails-style ones

Author: kgilpin

lib/appmap/handler/rails/request_handler.rb

@@ -65,7 +65,7 @@ def normalized_path(request, router = ::Rails.application.routes.router)
               next unless app.matches? request
               return normalized_path request, app.rack_app.routes.router if app.engine?
 
-              return route.path.spec.to_s
+              return AppMap::Util.swaggerize_path(route.path.spec.to_s)
             end
           end
         end

lib/appmap/util.rb

@@ -101,6 +101,16 @@ def normalize_path(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'

spec/abstract_controller_base_spec.rb

@@ -42,7 +42,7 @@ def tmpdir
               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(
@@ -197,7 +197,7 @@ def tmpdir
                 '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'

spec/util_spec.rb

@@ -4,8 +4,8 @@
 require 'appmap/util'
 
 describe AppMap::Util, docker: false do
-  let(:subject) { AppMap::Util.method(:scenario_filename) }
   describe 'scenario_filename' do
+    let(:subject) { AppMap::Util.method(:scenario_filename) }
     it 'leaves short names alone' do
       expect(subject.call('foobar')).to eq('foobar.appmap.json')
     end
@@ -18,4 +18,21 @@
       expect(subject.call(fname, max_length: 50)).to eq('abcdefghijklmno-RAd_SFbH1sUZ_OXfwPsfzw.appmap.json')
     end
   end
+  describe 'swaggerize path' do
+    it 'replaces rails-style parameters' do
+      expect(AppMap::Util.swaggerize_path('/org/:org_id(.:format)')).to eq('/org/{org_id}')
+    end
+
+    it 'strips the format specifier' do
+      expect(AppMap::Util.swaggerize_path('/org(.:format)')).to eq('/org')
+    end
+
+    it 'ignores malformed parameter specs' do
+      expect(AppMap::Util.swaggerize_path('/org/o:rg_id')).to eq('/org/o:rg_id')
+    end
+
+    it 'ignores already swaggerized paths' do
+      expect(AppMap::Util.swaggerize_path('/org/{org_id}')).to eq('/org/{org_id}')
+    end
+  end
 end