appmap 0.44.0 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02dfa68caaa5e5413c68ae06e89664a676624c9dbb301e2ebbc2a7ae26359afd
-  data.tar.gz: af97e3fb4bb428a238b854ef30969f232c48d4f3a59956865a4cc95788ac35e8
+  metadata.gz: 0db499c7da4baea3f29fb56214a95e18047a07fc0c132ba559f7f6eb7ef9033a
+  data.tar.gz: 3aabf3bf1a31c39d6844ccf17807a4b7e206783bdf8e373008d3db0d04a854d7
 SHA512:
-  metadata.gz: 9a0f2454acf5d10c48aaf1abb6e4b23d674acbbfe495770a25ff83093c38dd81cf0bb1c85dfbae4691773586ace8500c3f9b879b31749c4142851f460ed1a87c
-  data.tar.gz: a2860fb0258b96d95e5ca98f7d13b382c86b635ce1c2d97084c1f651a55973d2ffe31e360695fdec963292081e527b96876c6b42976a90573b9201e14032d1f5
+  metadata.gz: a38e51f5c932d9a04b566c2664104e08a56af80fd3277c039603eb719336599bc9764781e1d0835c6c7b702e4e0465587fd4537e292df325c0d9efe4a90c1493
+  data.tar.gz: 168e2b8c1605cf7b4f8c4d6a5f373b5add4ce1804c4c494f3cc4e3b29da5a08f4e121889bca36e06e1e29aa4c9943c16b76f7868e9331c3a7e5b33af0817f1a0

data/.releaserc.yml

@@ -0,0 +1,11 @@
+plugins:
+  - '@semantic-release/commit-analyzer'
+  - '@semantic-release/release-notes-generator'
+  - '@semantic-release/changelog'
+  - 'semantic-release-rubygem'
+  - - '@semantic-release/git'
+    - assets:
+        - CHANGELOG.md
+        - appmap.gemspec
+        - lib/appmap/version.rb
+  - '@semantic-release/github'

data/.travis.yml

@@ -16,23 +16,29 @@ before_script:
 
 cache:
   bundler: true
-  directories:
-    - $HOME/docker
-
-# https://stackoverflow.com/a/41975912
-before_cache:
-  # Save tagged docker images
-  - >
-    mkdir -p $HOME/docker && docker images -a --filter='dangling=false' --format '{{.Repository}}:{{.Tag}} {{.ID}}'
-    | xargs -n 2 -t sh -c 'test -e $HOME/docker/$1.tar.gz || docker save $0 | gzip -2 > $HOME/docker/$1.tar.gz'
-
-before_install:
-  # Load cached docker images
-  - if [[ -d $HOME/docker ]]; then ls $HOME/docker/*.tar.gz | xargs -I {file} sh -c "zcat {file} | docker load"; fi
 
+ 
+# GEM_ALTERNATIVE_NAME only needed for deployment 
 jobs:
   include:
   - stage: test
     script:
     - mkdir tmp
-    - bundle exec rake test
+    - GEM_ALTERNATIVE_NAME='' bundle exec rake test
+
+    
+before_deploy:
+  - |
+    nvm install --lts \
+      && nvm use --lts \
+      && npm i -g \
+        semantic-release \
+        @semantic-release/git \
+        @semantic-release/changelog \
+        semantic-release-rubygem
+
+deploy:
+  - provider: script
+    script: ./release.sh
+    on:
+      branch: master

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.45.0](https://github.com/applandinc/appmap-ruby/compare/v0.44.0...v0.45.0) (2021-05-03)
+
+
+### Bug Fixes
+
+* Properly name status_code in HTTP server response ([556e87c](https://github.com/applandinc/appmap-ruby/commit/556e87c9a7bf214f6b8714add4f77448fd223d33))
+
+
+### Features
+
+* Record http_client_request and http_client_response ([1db32ae](https://github.com/applandinc/appmap-ruby/commit/1db32ae0d26a7f1400b6b814d25b13368f06c158))
+* Update AppMap format version to 1.5.0 ([061705e](https://github.com/applandinc/appmap-ruby/commit/061705e4619cb881e8edd022ef835183e399e127))
+* **build:** add deployment via `semantic-release` with automatic publication to rubygems ([9f183de](https://github.com/applandinc/appmap-ruby/commit/9f183de13f405900000c3da979c3a8a5b6e34a24))
+
 # v0.44.0
 
 * Support recording and labeling of indivudal functions via `functions:` section in *appmap.yml*.

data/README_CI.md

@@ -0,0 +1,29 @@
+# Configuration variables:
+
+* `GH_TOKEN`: used by `semantic-release` to push changes to Github and manage releases
+* `GEM_HOST_API_KEY`: rubygems API key
+* `GEM_ALTERNATIVE_NAME` (optional): used for testing of CI flows, 
+to avoid publication of test releases under official package name
+* `DOCKERHUB\_USERNAME`, `DOCKERHUB_PASSWORD`: optional dockerhub credentials, 
+to avoid throttling of dockerhub anonymous pulls
+
+Note: for security reasons, it's better to use dedicated (not personal) 
+Dockerhub account, 
+and also use [access tokens](https://docs.docker.com/docker-hub/access-tokens/) 
+instead of primary password
+
+# Release command
+
+`./release.sh` 
+
+Bash wrapper script is used merely as a launcher of `semantic-release` 
+with extra logic to explicitly determine git url from `TRAVIS_REPO_SLUG` \
+variable if its defined (otherwise git url is taken from `package.json`, 
+which breaks CI on forked repos).
+
+# CI flow
+
+1. Test happens using current version number specified in `lib/appmap/version.rb`, then `release.sh` launches `semantic-release` to do the rest
+2. The version number is increased (including modicication of `version.rb`)
+3. Gem is published under new version number
+4. Github release is created with the new version number

data/Rakefile

@@ -37,7 +37,8 @@ end
   
 def build_base_image(ruby_version)
   run_cmd "docker build" \
-         " --build-arg RUBY_VERSION=#{ruby_version} --build-arg GEM_VERSION=#{GEM_VERSION}" \
+         " --build-arg RUBY_VERSION=#{ruby_version}"    \
+         " --build-arg GEM_VERSION=#{GEM_VERSION}"      \
          " -t appmap:#{GEM_VERSION} -f Dockerfile.appmap ."
 end
   
@@ -46,7 +47,7 @@ def build_app_image(app, ruby_version)
     run_cmd( {"RUBY_VERSION" => ruby_version, "GEM_VERSION" => GEM_VERSION},
       " docker-compose build" \
       " --build-arg RUBY_VERSION=#{ruby_version}" \
-      " --build-arg GEM_VERSION=#{GEM_VERSION}")
+      " --build-arg GEM_VERSION=#{GEM_VERSION}"  ) 
   end
 end
 
@@ -138,3 +139,4 @@ task spec: %i[spec:all]
 task test: %i[spec:all minitest]
 
 task default: :test
+

data/appmap.gemspec

@@ -4,8 +4,12 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appmap/version'
 
+
+
 Gem::Specification.new do |spec|
-  spec.name          = 'appmap'
+  # ability to parameterize gem name is added intentionally, 
+  # to support the possibility of unofficial releases, e.g. during CI tests
+  spec.name          = (ENV['GEM_ALTERNATIVE_NAME'].to_s.empty? ? 'appmap' : ENV["GEM_ALTERNATIVE_NAME"] )
   spec.version       = AppMap::VERSION
   spec.authors       = ['Kevin Gilpin']
   spec.email         = ['kgilpin@gmail.com']

data/lib/appmap.rb

@@ -9,6 +9,7 @@ end
 
 require 'appmap/version'
 require 'appmap/hook'
+require 'appmap/handler/net_http'
 require 'appmap/config'
 require 'appmap/trace'
 require 'appmap/class_map'

data/lib/appmap/config.rb

@@ -3,6 +3,13 @@
 module AppMap
   class Config
     Package = Struct.new(:path, :gem, :package_name, :exclude, :labels, :shallow) do
+      attr_writer :handler_class
+
+      def handler_class
+        require 'appmap/handler/function'
+        @handler_class || AppMap::Handler::Function
+      end
+
       # Indicates that only the entry points to a package will be recorded.
       # Once the code has entered a package, subsequent calls within the package will not be
       # recorded unless the code leaves the package and re-enters it.
@@ -42,6 +49,7 @@ module AppMap
           path: path,
           package_name: package_name,
           gem: gem,
+          handler_class: handler_class.name,
           exclude: exclude.blank? ? nil : exclude,
           labels: labels.blank? ? nil : labels,
           shallow: shallow
@@ -107,7 +115,9 @@ module AppMap
         Hook.new(:invoke_after, Package.build_from_path('active_support', package_name: 'active_support', labels: %w[mvc.after_action])),
       ],
       'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGES.(%w[crypto.x509])),
-      'Net::HTTP' => Hook.new(:request, Package.build_from_path('net/http', package_name: 'net/http', labels: %w[protocol.http])),
+      'Net::HTTP' => Hook.new(:request, Package.build_from_path('net/http', package_name: 'net/http', labels: %w[protocol.http]).tap do |package|
+        package.handler_class = AppMap::Handler::NetHTTP
+      end),
       'Net::SMTP' => Hook.new(:send, Package.build_from_path('net/smtp', package_name: 'net/smtp', labels: %w[protocol.email.smtp])),
       'Net::POP3' => Hook.new(:mails, Package.build_from_path('net/pop3', package_name: 'net/pop', labels: %w[protocol.email.pop])),
       'Net::IMAP' => Hook.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[protocol.email.imap])),

data/lib/appmap/handler/function.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'appmap/event'
+
+module AppMap
+  module Handler
+    module Function
+      class << self
+        def handle_call(defined_class, hook_method, receiver, args)
+          AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args)
+        end
+
+        def handle_return(call_event_id, elapsed, return_value, exception)
+          AppMap::Event::MethodReturn.build_from_invocation(call_event_id, elapsed, return_value, exception)
+        end
+      end
+    end
+  end
+end

data/lib/appmap/handler/net_http.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'appmap/event'
+
+module AppMap
+  module Handler
+    class HTTPClientRequest < AppMap::Event::MethodEvent
+      attr_accessor :request_method, :url, :params, :headers
+
+      def initialize(http, request)
+        super AppMap::Event.next_id_counter, :call, Thread.current.object_id
+
+        path, query = request.path.split('?')
+        query ||= ''
+
+        protocol = http.use_ssl? ? 'https' : 'http'
+        port = if http.use_ssl? && http.port == 443
+          nil
+        elsif !http.use_ssl? && http.port == 80
+          nil
+        else
+          ":#{http.port}"
+        end
+
+        url = [ protocol, '://', http.address, port, path ].compact.join
+
+        self.request_method = request.method
+        self.url = url
+        self.headers = AppMap::Util.select_headers(NetHTTP.request_headers(request))
+        self.params = Rack::Utils.parse_nested_query(query)
+      end
+
+      def to_h
+        super.tap do |h|
+          h[:http_client_request] = {
+            request_method: request_method,
+            url: url,
+            headers: headers
+          }.compact
+
+          unless params.blank?
+            h[:message] = params.keys.map do |key|
+              val = params[key]
+              {
+                name: key,
+                class: val.class.name,
+                value: self.class.display_string(val),
+                object_id: val.__id__,
+              }
+            end
+          end
+        end
+      end
+    end
+
+    class HTTPClientResponse < AppMap::Event::MethodReturnIgnoreValue
+      attr_accessor :status, :mime_type, :headers
+
+      def initialize(response, parent_id, elapsed)
+        super AppMap::Event.next_id_counter, :return, Thread.current.object_id
+
+        self.status = response.code.to_i
+        self.parent_id = parent_id
+        self.elapsed = elapsed
+        self.headers = AppMap::Util.select_headers(NetHTTP.response_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
+      end
+    end
+
+    class NetHTTP
+      class << self
+        def request_headers(request)
+          {}.tap do |headers|
+            request.each_header do |k,v|
+              key = [ 'HTTP', k.underscore.upcase ].join('_')
+              headers[key] = v
+            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?
+
+          http = receiver
+          request = args.first
+          HTTPClientRequest.new(http, request)
+        end
+
+        def handle_return(call_event_id, elapsed, return_value, exception)
+          HTTPClientResponse.new(return_value, call_event_id, elapsed)
+        end
+      end
+    end
+  end
+end

data/lib/appmap/hook/method.rb

@@ -76,7 +76,7 @@ module AppMap
               raise
             ensure
               with_disabled_hook.call do
-                after_hook.call(self, call_event, start_time, return_value, exception)
+                after_hook.call(self, call_event, start_time, return_value, exception) if call_event
               end
             end
           end
@@ -87,18 +87,16 @@ module AppMap
       protected
 
       def before_hook(receiver, defined_class, args)
-        require 'appmap/event'
-        call_event = AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args)
-        AppMap.tracing.record_event call_event, package: hook_package, defined_class: defined_class, method: hook_method
+        call_event = hook_package.handler_class.handle_call(defined_class, hook_method, receiver, args)
+        AppMap.tracing.record_event(call_event, package: hook_package, defined_class: defined_class, method: hook_method) if call_event
         [ call_event, TIME_NOW.call ]
       end
 
       def after_hook(_receiver, call_event, start_time, return_value, exception)
-        require 'appmap/event'
         elapsed = TIME_NOW.call - start_time
-        return_event = \
-          AppMap::Event::MethodReturn.build_from_invocation call_event.id, elapsed, return_value, exception
+        return_event = hook_package.handler_class.handle_return(call_event.id, elapsed, return_value, exception)
         AppMap.tracing.record_event return_event
+        nil
       end
 
       def with_disabled_hook(&function)

data/lib/appmap/rails/request_handler.rb

@@ -6,26 +6,6 @@ require 'appmap/hook'
 module AppMap
   module Rails
     module RequestHandler
-      # Host and User-Agent will just introduce needless variation.
-      # Content-Type and Authorization get their own fields in the request.
-      IGNORE_HEADERS = %w[host user_agent content_type authorization].map(&:upcase).map {|h| "HTTP_#{h}"}.freeze
-
-      class << self
-        def selected_headers(env)
-          # Rack prepends HTTP_ to all client-sent headers.
-          matching_headers = env
-            .select { |k,v| k.start_with? 'HTTP_'}
-            .reject { |k,v| IGNORE_HEADERS.member?(k) }
-            .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
-      end
-
       class HTTPServerRequest < AppMap::Event::MethodEvent
         attr_accessor :normalized_path_info, :request_method, :path_info, :params, :mime_type, :headers, :authorization
 
@@ -35,7 +15,7 @@ module AppMap
           self.request_method = request.request_method
           self.normalized_path_info = normalized_path(request)
           self.mime_type = request.headers['Content-Type']
-          self.headers = RequestHandler.selected_headers(request.env)
+          self.headers = AppMap::Util.select_headers(request.env)
           self.authorization = request.headers['Authorization']
           self.path_info = request.path_info.split('?')[0]
           # ActionDispatch::Http::ParameterFilter is deprecated
@@ -59,16 +39,18 @@ module AppMap
               headers: headers,
             }.compact
 
-            h[:message] = params.keys.map do |key|
-              val = params[key]
-              {
-                name: key,
-                class: val.class.name,
-                value: self.class.display_string(val),
-                object_id: val.__id__,
-              }.tap do |message|
-                properties = object_properties(val)
-                message[:properties] = properties if properties
+            unless params.blank?
+              h[:message] = params.keys.map do |key|
+                val = params[key]
+                {
+                  name: key,
+                  class: val.class.name,
+                  value: self.class.display_string(val),
+                  object_id: val.__id__,
+                }.tap do |message|
+                  properties = object_properties(val)
+                  message[:properties] = properties if properties
+                end
               end
             end
           end
@@ -97,13 +79,13 @@ module AppMap
           self.mime_type = response.headers['Content-Type']
           self.parent_id = parent_id
           self.elapsed = elapsed
-          self.headers = RequestHandler.selected_headers(response.headers)
+          self.headers = AppMap::Util.select_headers(response.headers)
         end
 
         def to_h
           super.tap do |h|
             h[:http_server_response] = {
-              status: status,
+              status_code: status,
               mime_type: mime_type,
               headers: headers
             }.compact

data/lib/appmap/trace.rb

@@ -82,7 +82,8 @@ 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::ScopedMethod.new(package, defined_class, method, static) \
         if package && defined_class && method && (event.event == :call)
     end