appmap 0.34.5 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4318e1ef7e025a8f616022cefd323784e7b8ee8ccf06b1b7167b9937e860df
-  data.tar.gz: c6a743f2c7f4ebe8cd58f7ae971b5dae15791bc808dab9d4dcf87f4971986818
+  metadata.gz: fba24ecdb42c951741292378419eef430a56cc16816df46a14b2ae3e318f8f94
+  data.tar.gz: 67ff27467f72322c5a8514c90b0a6039e3fd1268dba103dea3b832eda95ac317
 SHA512:
-  metadata.gz: 9f271a71bb8bffa7004d054ae91646c9c93a476b15cbe80c459a9cafcb13ab0169be6c8a2db9b8cc993c3bc767deef4c9c0ca4befe6bd6881cf2d93c7b692b64
-  data.tar.gz: 3b6c5067a325fa2a0aed71b5ed92179196061cd6cfa015f907a25dab798e757c2cd53efbd028513df1f22cc2e2b8aa9345f8d19aa27018eccfbee4cd39766ece
+  metadata.gz: 1823304c2733b46470481fd731a1f4650a80e769d96b47dbcdb0e5763e59930d6754068b4cf0729f9f748c55109575f3c8146b09030741fccfafd06cd45669b9
+  data.tar.gz: bbebe31041ed1720dc54b9522e4c6baac3b27d8d77be0622315657d0fa5b355c3e12474aa756811a6d747b563999c6e76206805c1392a015f92c6b863e8eeda0

data/.gitignore

@@ -14,4 +14,5 @@ Gemfile.lock
 appmap.json
 .vscode
 .byebug_history
-/lib/appmap/appmap.bundle
+/lib/appmap/appmap.bundle
+*.so

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  NewCops: enable
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v0.37.0
+* Capture method source and comment.
+
+# v0.36.0
+* *appmap.yml* package definition may specify `gem`.
+* Skip loading the railtie if `APPMAP_INITIALIZE` environment variable
+  is set to `false`.
+
+# v0.35.2
+* Make sure `MethodEvent#display_string` works when the value's `#to_s` and/or `#inspect`
+  methods have problems.
+  
+# v0.35.1
+* Take out hooking of `IO` and `Logger` methods.
+* Enable logging if either `APPMAP_DEBUG` or `DEBUG` is `true`.
+
+# v0.35.0
+* Provide a custom display string for files and HTTP requests.
+* Report `mime_type` on HTTP response.
+
+# v0.34.6
+* Only warn once about problems determining database version for an ActiveRecord
+  connection.
+
 # v0.34.5
 * Ensure that hooking a method doesn't change its arity.
 

data/README.md

@@ -1,3 +1,4 @@
+
 - [About](#about)
 - [Installation](#installation)
 - [Configuration](#configuration)
@@ -13,7 +14,7 @@
   - [Using fixture apps](#using-fixture-apps)
     - [`test/fixtures`](#testfixtures)
     - [`spec/fixtures`](#specfixtures)
-- [Build status](#build-status)
+
 
 # About
 
@@ -27,8 +28,9 @@ granular than a full debug trace. It's designed to be optimal for understanding
 There are several ways to record AppMaps of your Ruby program using the `appmap` gem:
 
 * Run your RSpec tests with the environment variable `APPMAP=true`. An AppMap will be generated for each spec.
-* Run your application server with AppMap remote recording enabled, and use the AppMap.
-  browser extension to start, stop, and upload recordings.
+* Run your application server with AppMap remote recording enabled, and use the [AppLand
+  browser extension](https://github.com/applandinc/appland-browser-extension) to start,
+  stop, and upload recordings.
 * Run the command `appmap record <program>` to record the entire execution of a program.
 
 Once you have recorded some AppMaps (for example, by running RSpec tests), you use the `appland upload` command
@@ -76,6 +78,7 @@ name: MyProject
 packages:
 - path: app/controllers
 - path: app/models
+- gem: activerecord
 ```
 
 * **name** Provides the project name (required)
@@ -87,6 +90,7 @@ Each entry in the `packages` list is a YAML object which has the following keys:
 
 * **path** The path to the source code directory. The path may be relative to the current working directory, or it may
   be an absolute path.
+* **gem** As an alternative to specifying the path, specify the name of a dependency gem. When using `gem`, don't specify `path`.
 * **exclude** A list of files and directories which will be ignored. By default, all modules, classes and public
   functions are inspected.
 
@@ -248,11 +252,11 @@ end
 $ bundle exec rails server
 ```
 
-4. Open the AppApp browser extension and push `Start`.
+4. Open the AppLand browser extension and push `Start`.
 
 5. Use your app. For example, perform a login flow, or run through a manual UI test.
 
-6. Open the AppApp browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
+6. Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
 
 ## Ruby on Rails
 
@@ -265,6 +269,7 @@ Note that using this method is kind of a blunt instrument. Recording RSpecs and
 For instructions on uploading, see the documentation of the [AppLand CLI](https://github.com/applandinc/appland-cli).
 
 # Development
+[![Build Status](https://travis-ci.org/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.org/applandinc/appmap-ruby)
 
 ## Running tests
 
@@ -289,7 +294,7 @@ $ bundle exec rake compile
 ### `test/fixtures`
 
 The fixture apps in `test/fixtures` are plain Ruby projects that exercise the basic functionality of the
-`appmap` gem. To develop in a fixture, simple enter the fixture directory and `bundle`.
+`appmap` gem. To develop in a fixture, simply enter the fixture directory and `bundle`.
 
 ### `spec/fixtures`
 
@@ -339,5 +344,3 @@ Finished in 0.07357 seconds (files took 2.1 seconds to load)
 4 examples, 0 failures
 ```
 
-# Build status
-[![Build Status](https://travis-ci.org/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.org/applandinc/appmap-ruby)

data/Rakefile

@@ -1,3 +1,4 @@
+$: << File.join(__dir__, 'lib')
 require 'appmap/version'
 GEM_VERSION = AppMap::VERSION
 
@@ -113,7 +114,7 @@ namespace :spec do
     desc ruby_version
     task ruby_version, [:specs] => ["compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
       run_specs(ruby_version, task_args)
-    end.tap do|t|
+    end.tap do |t|
       desc "Run all specs"
       task :all, [:specs] => t
     end

data/appmap.gemspec

@@ -27,10 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday'
   spec.add_dependency 'gli'
+  spec.add_dependency 'method_source'
   spec.add_dependency 'parser'
   spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'

data/appmap.yml

@@ -1,8 +1,2 @@
 name: AppMap Rubygem
-packages:
-  - path: lib/appmap
-    exclude:
-      - server
-      - trace
-
-  - path: examples
+packages: []

data/lib/appmap.rb

@@ -83,8 +83,8 @@ module AppMap
     end
 
     # Builds a class map from a config and a list of Ruby methods.
-    def class_map(methods)
-      ClassMap.build_from_methods(configuration, methods)
+    def class_map(methods, options = {})
+      ClassMap.build_from_methods(methods, options)
     end
 
     # Returns default metadata detected from the Ruby system and from the

data/lib/appmap/class_map.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'method_source'
+
 module AppMap
   class ClassMap
     module HasChildren
@@ -48,7 +50,7 @@ module AppMap
         end
       end
       Function = Struct.new(:name) do
-        attr_accessor :static, :location, :labels
+        attr_accessor :static, :location, :labels, :comment, :source
 
         def type
           'function'
@@ -60,31 +62,32 @@ module AppMap
             type: type,
             location: location,
             static: static,
-            labels: labels
-          }.delete_if { |k,v| v.nil? || v == [] }
+            labels: labels,
+            comment: comment,
+            source: source
+          }.delete_if { |_, v| v.nil? || v == [] }
         end
       end
     end
 
     class << self
-      def build_from_methods(config, methods)
+      def build_from_methods(methods, options = {})
         root = Types::Root.new
         methods.each do |method|
-          package = config.package_for_method(method) \
-            or raise "No package found for method #{method}"
-          add_function root, package, method
+          add_function root, method, options
         end
         root.children.map(&:to_h)
       end
 
       protected
 
-      def add_function(root, package, method)
+      def add_function(root, method, include_source: true)
+        package = method.package
         static = method.static
 
         object_infos = [
           {
-            name: package.path,
+            name: package.name,
             type: 'package'
           }
         ]
@@ -110,6 +113,16 @@ module AppMap
             [ method.defined_class, static ? '.' : '#', method.name ].join
           end
 
+        if include_source
+          begin
+            function_info[:source] = method.source
+            comment = method.comment || ''
+            function_info[:comment] = comment unless comment.empty?
+          rescue MethodSource::SourceNotFoundError
+            # pass
+          end
+        end
+
         function_info[:labels] = package.labels if package.labels
         object_infos << function_info
 

data/lib/appmap/config.rb

@@ -2,15 +2,39 @@
 
 module AppMap
   class Config
-    Package = Struct.new(:path, :package_name, :exclude, :labels) do
-      def initialize(path, package_name: nil, exclude: [], labels: [])
-        super path, package_name, exclude, labels
+    Package = Struct.new(:path, :gem, :package_name, :exclude, :labels) do
+      class << self
+        def build_from_path(path, package_name: nil, exclude: [], labels: [])
+          Package.new(path, nil, package_name, exclude, labels)
+        end
+
+        def build_from_gem(gem, package_name: nil, exclude: [], labels: [])
+          gem_paths(gem).map do |gem_path|
+            Package.new(gem_path, gem, package_name, exclude, labels)
+          end
+        end
+
+        private_class_method :new
+
+        protected
+
+        def gem_paths(gem)
+          gemspec = Gem.loaded_specs[gem] or raise "Gem #{gem.inspect} not found"
+          gemspec.source_paths.map do |path|
+            File.join(gemspec.gem_dir, path)
+          end
+        end
+      end
+
+      def name
+        gem || path
       end
-  
+
       def to_h
         {
           path: path,
           package_name: package_name,
+          gem: gem,
           exclude: exclude.blank? ? nil : exclude,
           labels: labels.blank? ? nil : labels
         }.compact
@@ -20,31 +44,29 @@ module AppMap
     Hook = Struct.new(:method_names, :package) do
     end
 
-    OPENSSL_PACKAGE = Package.new('openssl', package_name: 'openssl', labels: %w[security crypto])
+    OPENSSL_PACKAGES = Package.build_from_path('openssl', package_name: 'openssl', labels: %w[security crypto])
 
     # Methods that should always be hooked, with their containing
     # package and labels that should be applied to them.
     HOOKED_METHODS = {
-      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.new('active_support', package_name: 'active_support', labels: %w[security crypto]))
+      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.build_from_path('active_support', package_name: 'active_support', labels: %w[security crypto]))
     }.freeze
 
     BUILTIN_METHODS = {
-      'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGE),
-      'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGE),
-      'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGE),
-      'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGE),
-      'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGE),
-      'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGE),
-      'Logger' => Hook.new(:add, Package.new('logger', labels: %w[log io])),
-      'Net::HTTP' => Hook.new(:request, Package.new('net/http', package_name: 'net/http', labels: %w[http io])),
-      'Net::SMTP' => Hook.new(:send, Package.new('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])),
-      'Net::POP3' => Hook.new(:mails, Package.new('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])),
-      'Net::IMAP' => Hook.new(:send_command, Package.new('net/imap', package_name: 'net/imap', labels: %w[imap email io])),
-      'IO' => Hook.new(%i[read write open close], Package.new('io', labels: %w[io])),
-      'Marshal' => Hook.new(%i[dump load], Package.new('marshal', labels: %w[serialization marshal])),
-      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.new('yaml', package_name: 'psych', labels: %w[serialization yaml])),
-      'JSON::Ext::Parser' => Hook.new(:parse, Package.new('json', package_name: 'json', labels: %w[serialization json])),
-      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.new('json', package_name: 'json', labels: %w[serialization json]))
+      'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGES),
+      'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGES),
+      'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGES),
+      'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGES),
+      'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGES),
+      'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGES),
+      'Net::HTTP' => Hook.new(:request, Package.build_from_path('net/http', package_name: 'net/http', labels: %w[http io])),
+      'Net::SMTP' => Hook.new(:send, Package.build_from_path('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])),
+      'Net::POP3' => Hook.new(:mails, Package.build_from_path('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])),
+      'Net::IMAP' => Hook.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[imap email io])),
+      'Marshal' => Hook.new(%i[dump load], Package.build_from_path('marshal', labels: %w[serialization marshal])),
+      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[serialization yaml])),
+      'JSON::Ext::Parser' => Hook.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json])),
+      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json]))
     }.freeze
 
     attr_reader :name, :packages
@@ -64,8 +86,16 @@ module AppMap
       # Loads configuration from a Hash.
       def load(config_data)
         packages = (config_data['packages'] || []).map do |package|
-          Package.new(package['path'], exclude: package['exclude'] || [])
-        end
+          gem = package['gem']
+          path = package['path']
+          raise 'AppMap package configuration should specify gem or path, not both' if gem && path
+
+          if gem
+            Package.build_from_gem(gem, exclude: package['exclude'] || [])
+          else
+            [ Package.build_from_path(path, exclude: package['exclude'] || []) ]
+          end
+        end.flatten
         Config.new config_data['name'], packages
       end
     end
@@ -105,7 +135,7 @@ module AppMap
       hook = find_hook(defined_class)
       return nil unless hook
 
-      Array(hook.method_names).include?(method_name) ? hook.package : nil      
+      Array(hook.method_names).include?(method_name) ? hook.package : nil
     end
 
     def find_hook(defined_class)

data/lib/appmap/event.rb

@@ -31,25 +31,43 @@ module AppMap
         def display_string(value)
           return nil unless value
 
+          value_string = custom_display_string(value) || default_display_string(value)
+
+          (value_string||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+        end
+
+        protected
+
+        def custom_display_string(value)
+          case value
+          when File
+            "#{value.class}[path=#{value.path}]"
+          when Net::HTTP
+            "#{value.class}[#{value.address}:#{value.port}]"
+          when Net::HTTPGenericRequest
+            "#{value.class}[#{value.method} #{value.path}]"
+          end
+        rescue StandardError
+          nil
+        end
+
+        def default_display_string(value)
           last_resort_string = lambda do
             warn "AppMap encountered an error inspecting a #{value.class.name}: #{$!.message}"
             '*Error inspecting variable*'
           end
 
-          value_string = \
+          begin
+            value.to_s
+          rescue NoMethodError
             begin
-              value.to_s
-            rescue NoMethodError
-              begin
-                value.inspect
-              rescue StandardError
-                last_resort_string.call
-              end
+              value.inspect
             rescue StandardError
               last_resort_string.call
             end
-
-          (value_string||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+          rescue StandardError
+            last_resort_string.call
+          end
         end
       end
     end

data/lib/appmap/hook.rb

@@ -4,7 +4,7 @@ require 'English'
 
 module AppMap
   class Hook
-    LOG = (ENV['DEBUG'] == 'true')
+    LOG = (ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true')
 
     @unbound_method_arity = ::UnboundMethod.instance_method(:arity)
     @method_arity = ::Method.instance_method(:arity)
@@ -48,7 +48,6 @@ module AppMap
         hook = lambda do |hook_cls|
           lambda do |method_id|
             method = hook_cls.public_instance_method(method_id)
-            hook_method = Hook::Method.new(hook_cls, method)
 
             warn "AppMap: Examining #{hook_cls} #{method.name}" if LOG
 
@@ -56,14 +55,16 @@ module AppMap
             # Skip methods that have no instruction sequence, as they are obviously trivial.
             next unless disasm
 
-            # Don't try and trace the AppMap methods or there will be
-            # a stack overflow in the defined hook method.
-            next if /\AAppMap[:\.]/.match?(hook_method.method_display_name)
-
             next unless \
               config.always_hook?(hook_cls, method.name) ||
               config.included_by_location?(method)
 
+            hook_method = Hook::Method.new(config.package_for_method(method), hook_cls, method)
+
+            # Don't try and trace the AppMap methods or there will be
+            # a stack overflow in the defined hook method.
+            next if /\AAppMap[:\.]/.match?(hook_method.method_display_name)
+
             hook_method.activate
           end
         end
@@ -97,9 +98,9 @@ module AppMap
             end
 
           if method
-            Hook::Method.new(cls, method).activate
+            Hook::Method.new(hook.package, cls, method).activate
           else
-            warn "Method #{method_name} not found on #{cls.name}" 
+            warn "Method #{method_name} not found on #{cls.name}"
           end
         end
       end