appmap 0.35.1 → 0.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baf04e5395f8456142064fd8413363f6e29aa1bf2b68150e79b904d3879b8b7f
-  data.tar.gz: ca27e18b4778b9341801ac81e25e9025ab26a047824b58ab4bcf113ab91fd5b9
+  metadata.gz: 0255347aa61c6f39bfec0f43a78b3cc3060bd20e4f80f1e39e0ff3714a52dff3
+  data.tar.gz: 822bc2fe118426d6d9c9437c85ead8e603a446cabd6bd49d0053c2b1cfaf3789
 SHA512:
-  metadata.gz: f7a97d2d7a4e8bd5ae7db133e6287775dcff0373af82f187bc7d82411f868731e30fdb1a1267b173578a38d44017b20127cb20dcd7ddf3924d813e9ba6b32eb5
-  data.tar.gz: 784ea7d032b9186d50352c0222b168887249b0a9bde5d850f4b2b98e12555ed728f1dc95c1604e2e45d7d6a15c6765eda467ddbd55530af859c82842a1aca4ca
+  metadata.gz: 031534a5eb015fa99d6ad161665b131677cadbe41ed1bce20357cb1ded7ba19e5f0bcbe37cfef0c8ad35cc2904fe83e4cc9d2b12d04260b970d24cc9aea64ba3
+  data.tar.gz: e7996262f4da21936567c1238df624220987ed04bf5aebd9a525da4d3f181ca752c1060056a5bb41b52c9cdb29e958cf7335973ac7076113278c7e8583755477

data/.dockerignore

@@ -1,5 +1,5 @@
 vendor
 node_modules
-spec/fixtures/rails_users_app
+spec/fixtures/rails*_users_app
 spec/fixtures/rack_users_app
 

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,9 @@
+AllCops:
+  NewCops: enable
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 
@@ -8,6 +14,10 @@ Layout/HeredocIndentation:
 Layout/LineLength:
   Max: 120
 
+Metrics/BlockLength:
+  ExcludedMethods:
+  - it
+
 Style/MultilineBlockChain:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# v0.38.1
+
+* Package configuration can be `shallow`, in case which only the initial entry into the package is recorded.
+
+# v0.37.2
+* Fix ParameterFilter deprecation warning.
+
+# v0.37.1
+* Fix parameter mapping with keyword and rest arguments.
+
+# 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`.

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,8 +90,12 @@ 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.
+* **shallow** When set to `true`, only the first function call entry into a package will be recorded. Subsequent function calls within 
+  the same package are not recorded unless code execution leaves the package and re-enters it. Default: `true` when using `gem`,
+  `false` when using `path`.
 
 # Running
 
@@ -248,11 +255,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 +272,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 +297,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 +347,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
 
@@ -18,7 +19,7 @@ namespace 'gem' do
 end
 
 RUBY_VERSIONS=%w[2.5 2.6]
-FIXTURE_APPS=%w[rack_users_app rails_users_app rails4_users_app]
+FIXTURE_APPS=%w[rack_users_app rails6_users_app rails5_users_app rails4_users_app]
 
 def run_cmd(*cmd)
   $stderr.puts "Running: #{cmd}"
@@ -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(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,30 +62,32 @@ module AppMap
             type: type,
             location: location,
             static: static,
-            labels: labels
+            labels: labels,
+            comment: comment,
+            source: source
           }.delete_if { |_, v| v.nil? || v == [] }
         end
       end
     end
 
     class << self
-      def build_from_methods(methods)
+      def build_from_methods(methods, options = {})
         root = Types::Root.new
         methods.each do |method|
-          add_function root, method
+          add_function root, method, options
         end
         root.children.map(&:to_h)
       end
 
       protected
 
-      def add_function(root, 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'
           }
         ]
@@ -109,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,17 +2,49 @@
 
 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, :shallow) do
+      # 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.
+      def shallow?
+        shallow
+      end
+
+      class << self
+        def build_from_path(path, shallow: false, package_name: nil, exclude: [], labels: [])
+          Package.new(path, nil, package_name, exclude, labels, shallow)
+        end
+
+        def build_from_gem(gem, shallow: true, package_name: nil, exclude: [], labels: [])
+          gem_paths(gem).map do |gem_path|
+            Package.new(gem_path, gem, package_name, exclude, labels, shallow)
+          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
+          labels: labels.blank? ? nil : labels,
+          shallow: shallow
         }.compact
       end
     end
@@ -20,29 +52,30 @@ 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])),
+      'ActionView::Renderer' => Hook.new(:render, Package.build_from_path('action_view', package_name: 'action_view', labels: %w[view]))
     }.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),
-      '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])),
-      '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
@@ -62,8 +95,19 @@ 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
+            shallow = package['shallow']
+            # shallow is true by default for gems
+            shallow = true if shallow.nil?
+            Package.build_from_gem(gem, exclude: package['exclude'] || [], shallow: shallow)
+          else
+            [ Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow']) ]
+          end
+        end.flatten
         Config.new config_data['name'], packages
       end
     end

data/lib/appmap/event.rb

@@ -31,11 +31,6 @@ module AppMap
         def display_string(value)
           return nil unless value
 
-          last_resort_string = lambda do
-            warn "AppMap encountered an error inspecting a #{value.class.name}: #{$!.message}"
-            '*Error inspecting variable*'
-          end
-
           value_string = custom_display_string(value) || default_display_string(value)
 
           (value_string||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
@@ -57,6 +52,11 @@ module AppMap
         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
+
           begin
             value.to_s
           rescue NoMethodError
@@ -89,10 +89,25 @@ module AppMap
             else
               mc.path = [ defined_class, static ? '.' : '#', method.name ].join
             end
+
+            # Check if the method has key parameters. If there are any they'll always be last.
+            # If yes, then extract it from arguments.
+            has_key = [[:dummy], *method.parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
+            kwargs = has_key && arguments[-1].dup || {}
+
             mc.parameters = method.parameters.map.with_index do |method_param, idx|
               param_type, param_name = method_param
               param_name ||= 'arg'
-              value = arguments[idx]
+              value = case param_type
+                when :keyrest
+                  kwargs
+                when /^key/
+                  kwargs.delete param_name
+                when :rest
+                  arguments[idx..(has_key ? -2 : -1)]
+                else
+                  arguments[idx]
+                end
               {
                 name: param_name,
                 class: value.class.name,