appmap 0.66.1 → 0.66.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 555d4e55395c91b5beff0d992e97dc2db617db875473db4e2adc7521e902ad74
-  data.tar.gz: d2c75227d4d600d702d818eaf3416610f9200969c458acc0362d1ddd3f4360d3
+  metadata.gz: 2dd5295e0bbe8c9a4281b27bd712b61640672e93a03d6c3e31af3e201c9ca592
+  data.tar.gz: 8fb74d28bb2367918831c6d3af029440591da8ee694f1645fc2ef8baf5b28b60
 SHA512:
-  metadata.gz: 681aa6437aa1632ada6f67be308953936dbda5bd8c383049e81b73ada9c8999c9e8222d5204a1195042ae73d1c1f0b37d41009d1774208724a20726acd5a0d6f
-  data.tar.gz: 27587ac886bd8467604278fb9918f4b420f3f8642bb5b42e507f094a1d41365395e06bbd70ddaea94529afef5ecab2343f955078c0e248da46885718f31e79db
+  metadata.gz: ef07a3169b2d1f4dcabb406296275506250840cc767440b60a106f48ad5ee251017a9e9f7cd9769e7d0d133a3b9704f76bfef571fd69feef85163979cec80a80
+  data.tar.gz: 34c9c18e230dc46d868b759422eb7aeaba79b99fd1cca610bbc1a8bdc70a7cfa18e34a064a43cc50847c8c452bf267a6003a5b98cb3a2e2e8fa40028552fe112

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+dist: bionic
 
 rbenv:
 - 2.6
@@ -15,6 +16,7 @@ services:
 - docker
 
 before_install:
+  - sudo apt-get update && sudo apt-get install apt-transport-https ca-certificates -y && sudo update-ca-certificates
   # see https://blog.travis-ci.com/docker-rate-limits 
   # and also https://www.docker.com/blog/what-you-need-to-know-about-upcoming-docker-hub-rate-limiting/
   # if we do not use authorized account, 

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.66.2](https://github.com/applandinc/appmap-ruby/compare/v0.66.1...v0.66.2) (2021-10-07)
+
+
+### Bug Fixes
+
+* fix Travis for Ruby 3.0 ([8ec7359](https://github.com/applandinc/appmap-ruby/commit/8ec7359287f5b204ae9fb0724d8b683adfb79df5))
+* Fix warning of circular import ([84d456d](https://github.com/applandinc/appmap-ruby/commit/84d456d8ac26ef3fc7a81ca6517e4363aac9916d))
+* Properly handle headers which aren't mangled by Rack ([8e78e13](https://github.com/applandinc/appmap-ruby/commit/8e78e138776cb563f984e3592cf5024af16da2b7))
+* replace deprecated File.exists? method ([80ce5b5](https://github.com/applandinc/appmap-ruby/commit/80ce5b59fd010a806ca6320365f453f1e74f095d))
+* Validate presence package configuration ([f478d6b](https://github.com/applandinc/appmap-ruby/commit/f478d6b60a786608c21217755cec9a8185e084d3))
+
 ## [0.66.1](https://github.com/applandinc/appmap-ruby/compare/v0.66.0...v0.66.1) (2021-09-29)
 
 

data/lib/appmap/config.rb

@@ -176,8 +176,8 @@ module AppMap
       package_hooks('actionpack',
         [
           method_hook('ActionDispatch::Request::Session', %i[[] dig values fetch], %w[http.session.read]),
-          method_hook('ActionDispatch::Request::Session', %i[destroy[]= clear update delete merge], %w[http.session.write]),
-          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session.read]),
+          method_hook('ActionDispatch::Request::Session', %i[destroy []= clear update delete merge], %w[http.session.write]),
+          method_hook('ActionDispatch::Cookies::CookieJar', %i[[] fetch], %w[http.session.read]),
           method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session.write]),
           method_hook('ActionDispatch::Cookies::EncryptedCookieJar', %i[[]= clear update delete recycle], %w[http.cookie crypto.encrypt])
         ],
@@ -287,7 +287,7 @@ module AppMap
           LOGO
         end
 
-        config_present = true if File.exists?(config_file_name)
+        config_present = true if File.exist?(config_file_name)
 
         config_data = if config_present
           YAML.safe_load(::File.read(config_file_name))
@@ -360,6 +360,7 @@ module AppMap
               gem = package['gem']
               path = package['path']
               raise %q(AppMap config 'package' element should specify 'gem' or 'path', not both) if gem && path
+              raise %q(AppMap config 'package' element should specify 'gem' or 'path') unless gem || path
 
               if gem
                 shallow = package['shallow']

data/lib/appmap/depends/api.rb

@@ -63,7 +63,7 @@ module AppMap
         removed = []
         out_of_date_appmaps.each do |appmap_path|
           mtime_path = File.join(appmap_path, 'mtime')
-          next unless File.exists?(mtime_path)
+          next unless File.exist?(mtime_path)
 
           appmap_mtime = File.read(mtime_path).to_i
           if appmap_mtime < since_ms

data/lib/appmap/depends/configuration.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'appmap'
-
 module AppMap
   module Depends
     class Configuration

data/lib/appmap/depends/util.rb

@@ -16,7 +16,7 @@ module AppMap
       def delete_appmap(appmap_path)
         FileUtils.rm_rf(appmap_path)
         appmap_file_path = [ appmap_path, 'appmap.json' ].join('.')
-        File.unlink(appmap_file_path) if File.exists?(appmap_file_path)
+        File.unlink(appmap_file_path) if File.exist?(appmap_file_path)
       rescue
         warn "Unable to delete AppMap: #{$!}"
       end

data/lib/appmap/handler/net_http.rb

@@ -27,7 +27,7 @@ module AppMap
 
         self.request_method = request.method
         self.url = url
-        self.headers = AppMap::Util.select_headers(NetHTTP.request_headers(request))
+        self.headers = NetHTTP.copy_headers(request)
         self.params = Rack::Utils.parse_nested_query(query)
       end
 
@@ -55,7 +55,7 @@ module AppMap
     end
 
     class HTTPClientResponse < AppMap::Event::MethodReturnIgnoreValue
-      attr_accessor :status, :mime_type, :headers
+      attr_accessor :status, :headers
 
       def initialize(response, parent_id, elapsed)
         super AppMap::Event.next_id_counter, :return, Thread.current.object_id
@@ -63,14 +63,13 @@ module AppMap
         self.status = response.code.to_i
         self.parent_id = parent_id
         self.elapsed = elapsed
-        self.headers = AppMap::Util.select_headers(NetHTTP.response_headers(response))
+        self.headers = NetHTTP.copy_headers(response)
       end
 
       def to_h
         super.tap do |h|
           h[:http_client_response] = {
             status_code: status,
-            mime_type: mime_type,
             headers: headers
           }.compact
         end
@@ -79,17 +78,15 @@ module AppMap
 
     class NetHTTP
       class << self
-        def request_headers(request)
+        def copy_headers(obj)
           {}.tap do |headers|
-            request.each_header do |k,v|
-              key = [ 'HTTP', Util.underscore(k).upcase ].join('_')
-              headers[key] = v
+            obj.each_header do |key, value|
+              key = key.split('-').map(&:capitalize).join('-')
+              headers[key] = value
             end
           end
         end
-    
-        alias response_headers request_headers
-    
+
         def handle_call(defined_class, hook_method, receiver, args)
           # request will call itself again in a start block if it's not already started.
           return unless receiver.started?

data/lib/appmap/handler/rails/request_handler.rb

@@ -9,16 +9,14 @@ module AppMap
     module Rails
       module RequestHandler
         class HTTPServerRequest < AppMap::Event::MethodEvent
-          attr_accessor :normalized_path_info, :request_method, :path_info, :params, :mime_type, :headers, :authorization
+          attr_accessor :normalized_path_info, :request_method, :path_info, :params, :headers
 
           def initialize(request)
             super AppMap::Event.next_id_counter, :call, Thread.current.object_id
 
             self.request_method = request.request_method
             self.normalized_path_info = normalized_path(request)
-            self.mime_type = request.headers['Content-Type']
-            self.headers = AppMap::Util.select_headers(request.env)
-            self.authorization = request.headers['Authorization']
+            self.headers = AppMap::Util.select_rack_headers(request.env)
             self.path_info = request.path_info.split('?')[0]
             # ActionDispatch::Http::ParameterFilter is deprecated
             parameter_filter_cls = \
@@ -35,9 +33,7 @@ module AppMap
               h[:http_server_request] = {
                 request_method: request_method,
                 path_info: path_info,
-                mime_type: mime_type,
                 normalized_path_info: normalized_path_info,
-                authorization: authorization,
                 headers: headers,
               }.compact
 
@@ -72,23 +68,21 @@ module AppMap
         end
 
         class HTTPServerResponse < AppMap::Event::MethodReturnIgnoreValue
-          attr_accessor :status, :mime_type, :headers
+          attr_accessor :status, :headers
 
           def initialize(response, parent_id, elapsed)
             super AppMap::Event.next_id_counter, :return, Thread.current.object_id
 
             self.status = response.status
-            self.mime_type = response.headers['Content-Type']
             self.parent_id = parent_id
             self.elapsed = elapsed
-            self.headers = AppMap::Util.select_headers(response.headers)
+            self.headers = response.headers.dup
           end
 
           def to_h
             super.tap do |h|
               h[:http_server_response] = {
                 status_code: status,
-                mime_type: mime_type,
                 headers: headers
               }.compact
             end

data/lib/appmap/swagger/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module AppMap

data/lib/appmap/util.rb

@@ -108,8 +108,18 @@ module AppMap
         event
       end
 
-      def select_headers(env)
+      def select_rack_headers(env)
+        finalize_headers = lambda do |headers|
+          blank?(headers) ? nil : headers
+        end
+
         # Rack prepends HTTP_ to all client-sent headers.
+
+        if !env['rack.version']
+          warn "Request headers does not contain rack.version. HTTP_ prefix is not expected."
+          return finalize_headers.call(env.dup)
+        end
+
         matching_headers = env
           .select { |k,v| k.start_with? 'HTTP_'}
           .reject { |k,v| blank?(v) }
@@ -118,7 +128,7 @@ module AppMap
             value = kv[1]
             memo[key] = value
           end
-        blank?(matching_headers) ? nil : matching_headers
+        finalize_headers.call(matching_headers)
       end
 
       def normalize_path(path)

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.66.1'
+  VERSION = '0.66.2'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 

data/spec/depends/api_spec.rb

@@ -93,9 +93,9 @@ describe 'Depends API' do
 
         test_report.clean_appmaps
 
-        expect(File.exists?(new_spec_file)).to be_falsey
+        expect(File.exist?(new_spec_file)).to be_falsey
       ensure
-        FileUtils.rm_f new_spec_file if File.exists?(new_spec_file)
+        FileUtils.rm_f new_spec_file if File.exist?(new_spec_file)
         FileUtils.rm_rf new_spec_file.split('.')[0]
       end
     end

data/spec/fixtures/config/missing_path_or_gem.yml

@@ -0,0 +1,3 @@
+name: name
+packages:
+  - dogs: are friendly

data/spec/rails_recording_spec.rb

@@ -58,7 +58,7 @@ describe 'Rails' do
               hash_including(
                 'http_server_response' => hash_including(
                   'status_code' => 201,
-                  'mime_type' => 'application/json; charset=utf-8',
+                  'headers' => hash_including('Content-Type' => 'application/json; charset=utf-8'),
                 )
               )
             )

data/test/agent_setup_validate_test.rb

@@ -6,6 +6,7 @@ class AgentSetupValidateTest < Minitest::Test
   NON_EXISTING_CONFIG_FILENAME = '123.yml'
   INVALID_YAML_CONFIG_FILENAME = 'spec/fixtures/config/invalid_yaml_config.yml'
   INVALID_CONFIG_FILENAME = 'spec/fixtures/config/invalid_config.yml'
+  MISSING_PATH_OR_GEM_CONFIG_FILENAME = 'spec/fixtures/config/missing_path_or_gem.yml'
 
   def test_init_when_config_exists
     output = `./exe/appmap-agent-validate`
@@ -72,4 +73,22 @@ class AgentSetupValidateTest < Minitest::Test
     ])
     assert_equal expected, output.strip
   end
+
+  def test_init_with_missing_package_key
+    output = `./exe/appmap-agent-validate -c #{MISSING_PATH_OR_GEM_CONFIG_FILENAME}`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    expected = JSON.pretty_generate([
+      {
+        level: :error,
+        message: 'AppMap auto-configuration is currently not available for non Rails projects'
+      },
+      {
+        level: :error,
+        filename: MISSING_PATH_OR_GEM_CONFIG_FILENAME,
+        message: "AppMap configuration #{MISSING_PATH_OR_GEM_CONFIG_FILENAME} could not be loaded",
+        detailed_message: "AppMap config 'package' element should specify 'gem' or 'path'"
+      }
+    ])
+    assert_equal expected, output.strip
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.66.1
+  version: 0.66.2
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -3462,6 +3462,7 @@ files:
 - spec/fixtures/config/incomplete_config.yml
 - spec/fixtures/config/invalid_config.yml
 - spec/fixtures/config/invalid_yaml_config.yml
+- spec/fixtures/config/missing_path_or_gem.yml
 - spec/fixtures/config/valid_config.yml
 - spec/fixtures/depends/.gitignore
 - spec/fixtures/depends/app/controllers/api/api_keys_controller.rb
@@ -3738,7 +3739,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.