appmap 0.41.0 → 0.41.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d747c0e65dc1efb45769ae9118a7b97015b0378d79e20eec855e74c20b622af2
-  data.tar.gz: dcc3b91f32246aaefd02fbcf47672bfdf13acf6cadb715fbc5ff0040dbcfbf72
+  metadata.gz: 75523ebe41aa8e327db7ff2acc4fa20bf1283474b97baf6610e11292bb1abb8b
+  data.tar.gz: 1c0293cf928ff1f6615d7f0a72a6ba7a03acdee04d00065ffc4a0eb41e0192ad
 SHA512:
-  metadata.gz: 5f82a6a0cf8075537b0835e783779c827c5afed81e83e242bc97cbfd5b6ef0320fe352235436f57009a63db321223b9f7f82e8bcdced558d9b935a2ce4e4cbf3
-  data.tar.gz: aaa4676d24b6bb1bcbd34fb7f0e3a0244d005c36dd89782b774b342b7e30e1c9637795d0d492522b2a5e525de413e3adb9da54bd5ace2699373ffdfadf3a8157
+  metadata.gz: c0a39d8067f455a1c0179c65a7f17ffd041de405bc3c48be567970e2b987765216a33801e7c486c6aeee66cae5c2291f91196c3132bd9ad65d147617f6282468
+  data.tar.gz: bdc24d37f171945127c2ff67c834fa55932c019dbbe5e74a2f1625d11b12ca881e6a2d0c6419c0ffe625bba3295b5ef2ef1e96d6256f152ca7fbaa3d2a99b52d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.41.1
+
+* Make best effort to ensure that class name is not `null` in the appmap.json.
+* Don't try and instrument gems which are a dependency of the this gem.
+* Fix a nil exception when applying the exclude list to builtins.
+
 # v0.41.0
 
 * Adjust some label names to match `provider.*`, `format.*`.

data/README.md

@@ -9,6 +9,7 @@
   - [Minitest](#minitest)
   - [Cucumber](#cucumber)
   - [Remote recording](#remote-recording)
+  - [Server process recording](#server-process-recording)
 - [AppMap for VSCode](#appmap-for-vscode)
 - [Uploading AppMaps](#uploading-appmaps)
 - [Development](#development)
@@ -306,6 +307,26 @@ $ bundle exec rails server
 
 6. Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
 
+## Server process recording
+
+Add this line to *configuration.rb*:
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    ...
+  
+    config.appmap.enabled = true if ENV['APPMAP_RECORD']
+    
+    ...
+  end
+end
+```
+
+With this setting, you can run your Rails server with `APPMAP_RECORD=true`. When the server exits, an *appmap.json* file will be written to the project directory. This is a great way to start the server, interact with your app as a user (or through it's API), and then view an AppMap of everything that happened.
+
+Be sure and set `WEB_CONCURRENCY=1`, if you are using a webserver that can run multiple processes. You only want there to be one process while you are recording, otherwise they will both try and write *appmap.json* and one of them will clobber the other.
+
 # AppMap for VSCode
 
 The [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap) is a great way to onboard developers to new code, and troubleshoot hard-to-understand bugs with visuals.

data/lib/appmap/config.rb

@@ -16,6 +16,10 @@ module AppMap
         end
 
         def build_from_gem(gem, shallow: true, package_name: nil, exclude: [], labels: [])
+          if %w[method_source activesupport].member?(gem)
+            warn "WARNING: #{gem} cannot be AppMapped because it is a dependency of the appmap gem"
+            return
+          end
           gem_paths(gem).map do |gem_path|
             Package.new(gem_path, gem, package_name, exclude, labels, shallow)
           end
@@ -107,7 +111,7 @@ module AppMap
           else
             [ Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow']) ]
           end
-        end.flatten
+        end.flatten.compact
         Config.new config_data['name'], packages, config_data['exclude'] || []
       end
     end
@@ -137,7 +141,7 @@ module AppMap
       return unless location_file
 
       location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
-      packages.find do |pkg|
+      packages.select { |pkg| pkg.path }.find do |pkg|
         (location_file.index(pkg.path) == 0) &&
           !pkg.exclude.find { |p| location_file.index(p) }
       end

data/lib/appmap/event.rb

@@ -38,6 +38,15 @@ module AppMap
 
         protected
 
+        # Heuristic for dynamically defined class whose name can be nil
+        def best_class_name(value)
+          value_cls = value.class
+          while value_cls.name.nil?
+            value_cls = value_cls.superclass
+          end
+          value_cls.name
+        end
+
         def custom_display_string(value)
           case value
           when File
@@ -77,6 +86,7 @@ module AppMap
 
       class << self
         def build_from_invocation(mc = MethodCall.new, defined_class, method, receiver, arguments)
+          defined_class ||= 'Class'
           mc.tap do
             static = receiver.is_a?(Module)
             mc.defined_class = defined_class
@@ -110,14 +120,14 @@ module AppMap
                 end
               {
                 name: param_name,
-                class: value.class.name,
+                class: best_class_name(value),
                 object_id: value.__id__,
                 value: display_string(value),
                 kind: param_type
               }
             end
             mc.receiver = {
-              class: receiver.class.name,
+              class: best_class_name(receiver),
               object_id: receiver.__id__,
               value: display_string(receiver)
             }
@@ -172,7 +182,7 @@ module AppMap
           mr.tap do |_|
             if return_value
               mr.return_value = {
-                class: return_value.class.name,
+                class: best_class_name(return_value),
                 value: display_string(return_value),
                 object_id: return_value.__id__
               }
@@ -183,7 +193,7 @@ module AppMap
               while next_exception
                 exception_backtrace = next_exception.backtrace_locations.try(:[], 0)
                 exceptions << {
-                  class: next_exception.class.name,
+                  class: best_class_name(next_exception),
                   message: next_exception.message,
                   object_id: next_exception.__id__,
                   path: exception_backtrace&.path,

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.41.0'
+  VERSION = '0.41.1'
 
   APPMAP_FORMAT_VERSION = '1.4'
 end

data/test/fixtures/gem_test/appmap.yml

@@ -1,3 +1,3 @@
 name: gem_test
 packages:
-  - gem: activesupport
+  - gem: parser

data/test/fixtures/gem_test/test/parser_test.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'appmap/minitest'
+require 'minitest/autorun'
+require 'parser/current'
+
+class ParserTest < ::Minitest::Test
+  def test_parser
+    Parser::CurrentRuby.parse(File.read(__FILE__))
+  end
+end

data/test/gem_test.rb

@@ -19,14 +19,14 @@ class MinitestTest < Minitest::Test
   end
 
   def test_record_gem
-    perform_gem_test 'to_param' do
-      appmap_file = 'tmp/appmap/minitest/To_param_to_param.appmap.json'
+    perform_gem_test 'parser' do
+      appmap_file = 'tmp/appmap/minitest/Parser_parser.appmap.json'
       appmap = JSON.parse(File.read(appmap_file))
       events = appmap['events']
       assert_equal 2, events.size
       assert_equal 'call', events.first['event']
-      assert_equal 'to_param', events.first['method_id']
-      assert_equal "#{Gem.loaded_specs['activesupport'].gem_dir}/lib/active_support/core_ext/object/to_query.rb", events.first['path']
+      assert_equal 'default_parser', events.first['method_id']
+      assert_equal "#{Gem.loaded_specs['parser'].gem_dir}/lib/parser/base.rb", events.first['path']
       assert_equal 'return', events.second['event']
       assert_equal 1, events.second['parent_id']
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.41.0
+  version: 0.41.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -573,7 +573,7 @@ files:
 - test/fixtures/cucumber_recorder/lib/hello.rb
 - test/fixtures/gem_test/Gemfile
 - test/fixtures/gem_test/appmap.yml
-- test/fixtures/gem_test/test/to_param_test.rb
+- test/fixtures/gem_test/test/parser_test.rb
 - test/fixtures/minitest_recorder/Gemfile
 - test/fixtures/minitest_recorder/appmap.yml
 - test/fixtures/minitest_recorder/lib/hello.rb

data/test/fixtures/gem_test/test/to_param_test.rb

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'appmap/minitest'
-require 'minitest/autorun'
-require 'active_support'
-require 'active_support/core_ext'
-
-class ToParamTest < ::Minitest::Test
-  def test_to_param
-    # record use of a core extension
-    assert_equal 'my+id', 'my+id'.to_param
-  end
-end