appmap 0.54.4 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13450fa6c0ff3576dc48e27f35355e3eb4bd4ed70aac677af1235b8b8b8ce793
-  data.tar.gz: 2c08a504d3e6a467d212630290205ecab9391c64a33831574df43cb8526ab0ad
+  metadata.gz: dfd518bd44a86f1270fe90e70c397e213763dd582260ace7c5a01898b94030d2
+  data.tar.gz: cf449bff5700a1bfd5efabda40ccd59c5281d595aa34ca551d6a3b4b1f89f5f8
 SHA512:
-  metadata.gz: 49585b5fba1c9b7a0aabffd6dfc44fb051532fd9fe96d35a0176c6bcf382a51df948bfac8f1f0d3db474917f5587dbf07e90de9c9097d3de9a1650a1632f8fd6
-  data.tar.gz: aa489a3dc598dfc2c16ee3a6167e53683e5564870c3b1ed0552e9e0ba0d758da2d1c442059bee3efbe57206f9088a98ca7c271d8550f52ed5d18d0aa2a039635
+  metadata.gz: 1824e49817ccceca6571fb2cb6f4a3033fb4873bb184577ec3989af3d74d09aecbf7685f9ce9f7efeb2a43e811f9477b0cfc5c6f6778ba3ec8d141c37560112c
+  data.tar.gz: da796d7072dab9b505f6fe1220ae3987e0577be458dfb1253b3d4b860df41d7a4856640629dd300ebcb6588f350f4f55af2b867bf730d0a65e90788c0f2eeb0d

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [0.55.0](https://github.com/applandinc/appmap-ruby/compare/v0.54.4...v0.55.0) (2021-06-28)
+
+
+### Bug Fixes
+
+* Avoid calling == ([f30ed9f](https://github.com/applandinc/appmap-ruby/commit/f30ed9f309753252df35e372d925db3b914260d4))
+* Log dynamic loading of appmap helpers at info level ([15dcd3c](https://github.com/applandinc/appmap-ruby/commit/15dcd3c913fa1c32aea034b28ddae59668efa217))
+* Remove dynamic loading of rake and rspec helpers ([6790970](https://github.com/applandinc/appmap-ruby/commit/67909702f3c8a52081ef1e23a87c292908883334))
+
+
+### Features
+
+* APPMAP_PROFILE_DISPLAY_STRING and APPMAP_OBJECT_STRING ([3f5daa8](https://github.com/applandinc/appmap-ruby/commit/3f5daa890bfbfd39b7f825794d0c43da509b3201))
+* Package name to require can be specified when hooking a gem ([fcc5eb6](https://github.com/applandinc/appmap-ruby/commit/fcc5eb691a0330444560eb4c2afe7fc3c4c8afa8))
+* Profile packaging hooking ([c020a31](https://github.com/applandinc/appmap-ruby/commit/c020a312f4545348ec7cc302443269c57a7fc026))
+
 ## [0.54.4](https://github.com/applandinc/appmap-ruby/compare/v0.54.3...v0.54.4) (2021-06-27)
 
 

data/lib/appmap.rb

@@ -28,11 +28,9 @@ lambda do
   INITIALIZERS = {
     # In a Rails app, Rails is always defined by the time the other gems are loaded. Therefore, we
     # don't try and trap the loading of Rails itself here.
-    'RSpec' => Initializer.new('AppMap::RSpec', 'appmap/rspec', 'rspec-core'),
+    # Emperically, Rake and RSpec are also defined before appmap is loaded whenever a Rake task or
+    # RSpec tests are being run. Therefore, the only hook we need here is Minitest.
     'Minitest::Unit::TestCase' => Initializer.new('AppMap::Minitest', 'appmap/minitest', 'minitest'),
-    'Rake' => [
-      Initializer.new('AppMap::Swagger', 'appmap/swagger', 'rake')
-    ]
   }
 
   TracePoint.new(:class) do |tp|

data/lib/appmap/config.rb

@@ -343,7 +343,7 @@ module AppMap
                 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)
+                Package.build_from_gem(gem, package_name: package['package'], exclude: package['exclude'] || [], shallow: shallow)
               else
                 Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow'])
               end

data/lib/appmap/event.rb

@@ -29,11 +29,31 @@ module AppMap
 
         # Gets a display string for a value. This is not meant to be a machine deserializable value.
         def display_string(value)
-          return nil unless value
+          return nil if value.equal?(nil)
 
+          # With setting APPMAP_PROFILE_DISPLAY_STRING, stringifying this class is shown to take 9 seconds(!) of a 17 second test run.
+          return nil if best_class_name(value) == 'ActiveSupport::Callbacks::Filters::Environment'
+
+          if @times.nil? && ENV['APPMAP_PROFILE_DISPLAY_STRING'] == 'true'
+            @times = Hash.new {|memo,key| memo[key] = 0}
+            Thread.new do
+              sleep 0.5
+              while true
+                warn @times.to_a.sort{|a,b| b[1] <=> a[1]}[0..9].join("\n")
+                sleep 3
+              end
+            end
+          end
+
+          start = Time.now
           value_string = custom_display_string(value) || default_display_string(value)
 
-          (value_string||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+          if @times
+            elapsed = Time.now - start
+            @times[best_class_name(value)] += elapsed
+          end
+
+          encode_dislay_string(value_string)
         end
 
         def object_properties(hash_like)
@@ -57,8 +77,16 @@ module AppMap
           value_cls.name
         end
 
+        def encode_dislay_string(value)
+          (value||'')[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+        end
+
         def custom_display_string(value)
           case value
+          when NilClass, TrueClass, FalseClass, Numeric, Time, Date
+            value.to_s
+          when String
+            value[0...LIMIT].encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
           when File
             "#{value.class}[path=#{value.path}]"
           when Net::HTTP
@@ -71,6 +99,8 @@ module AppMap
         end
 
         def default_display_string(value)
+          return nil if ENV['APPMAP_OBJECT_STRING'] == 'false'
+
           last_resort_string = lambda do
             warn "AppMap encountered an error inspecting a #{value.class.name}: #{$!.message}"
             '*Error inspecting variable*'

data/lib/appmap/hook.rb

@@ -9,6 +9,7 @@ module AppMap
 
     OBJECT_INSTANCE_METHODS = %i[! != !~ <=> == === =~ __id__ __send__ class clone define_singleton_method display dup enum_for eql? equal? extend freeze frozen? hash inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method methods nil? object_id private_methods protected_methods public_method public_methods public_send remove_instance_variable respond_to? send singleton_class singleton_method singleton_methods taint tainted? tap then to_enum to_s to_h to_a trust untaint untrust untrusted? yield_self].freeze
     OBJECT_STATIC_METHODS = %i[! != !~ < <= <=> == === =~ > >= __id__ __send__ alias_method allocate ancestors attr attr_accessor attr_reader attr_writer autoload autoload? class class_eval class_exec class_variable_defined? class_variable_get class_variable_set class_variables clone const_defined? const_get const_missing const_set constants define_method define_singleton_method deprecate_constant display dup enum_for eql? equal? extend freeze frozen? hash include include? included_modules inspect instance_eval instance_exec instance_method instance_methods instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method method_defined? methods module_eval module_exec name new nil? object_id prepend private_class_method private_constant private_instance_methods private_method_defined? private_methods protected_instance_methods protected_method_defined? protected_methods public_class_method public_constant public_instance_method public_instance_methods public_method public_method_defined? public_methods public_send remove_class_variable remove_instance_variable remove_method respond_to? send singleton_class singleton_class? singleton_method singleton_methods superclass taint tainted? tap then to_enum to_s trust undef_method untaint untrust untrusted? yield_self].freeze
+    SLOW_PACKAGE_THRESHOLD = 0.05
 
     @unbound_method_arity = ::UnboundMethod.instance_method(:arity)
     @method_arity = ::Method.instance_method(:arity)
@@ -49,6 +50,27 @@ module AppMap
       @notrace_paths = Set.new
       # Locations that have already been visited.
       @trace_locations = Set.new
+      @module_load_times = Hash.new {|memo,k| memo[k] = 0}
+      @slow_packages = Set.new
+
+      if ENV['APPMAP_PROFILE_HOOK'] == 'true'
+        Thread.new do
+          sleep 1
+          while true
+            @module_load_times
+              .keys
+              .select { |key| !@slow_packages.member?(key) }
+              .each do |key|
+              elapsed = @module_load_times[key]
+              if elapsed >= SLOW_PACKAGE_THRESHOLD
+                @slow_packages.add(key)
+                warn "AppMap: Package #{key} took #{@module_load_times[key]} seconds to hook"
+              end
+            end
+            sleep 5
+          end
+        end
+      end
 
       @trace_end = TracePoint.new(:end, &method(:trace_end))
       @trace_end.enable(&block)
@@ -157,6 +179,7 @@ module AppMap
         end
       end
 
+      start = Time.now
       instance_methods.each(&hook.(cls))
       begin
         # NoMethodError: private method `singleton_class' called for Rack::MiniProfiler:Class
@@ -166,6 +189,11 @@ module AppMap
         #   uninitialized constant Faraday::Connection
         warn "NameError in #{__FILE__}: #{$!.message}"
       end
+      elapsed = Time.now - start
+      if location.index(Bundler.bundle_path.to_s) == 0
+        package_tokens = location[Bundler.bundle_path.to_s.length + 1..-1].split('/')
+        @module_load_times[package_tokens[1]] += elapsed
+      end
     end
   end
 end

data/lib/appmap/hook/method.rb

@@ -49,9 +49,14 @@ module AppMap
 
         hook_method_def = Proc.new do |*args, &block|
           instance_method = hook_method.bind(self).to_proc
+
+          is_array_containing_empty_hash = ->(obj) {
+            obj.is_a?(Array) && obj.length == 1 && obj[0].is_a?(Hash) && obj[0].size == 0
+          }
+
           call_instance_method = -> {
             # https://github.com/applandinc/appmap-ruby/issues/153
-            if Util.ruby_minor_version >= 2.7 && args == ARRAY_OF_EMPTY_HASH && hook_method.arity == 1
+            if Util.ruby_minor_version >= 2.7 && is_array_containing_empty_hash.(args) && hook_method.arity == 1
               instance_method.call({}, &block)
             else
               instance_method.call(*args, &block)

data/lib/appmap/util.rb

@@ -185,7 +185,7 @@ module AppMap
 
       def startup_message(msg)
         if defined?(::Rails) && defined?(::Rails.logger) && ::Rails.logger
-          ::Rails.logger.debug msg
+          ::Rails.logger.info msg
         elsif ENV['DEBUG'] == 'true'
           warn msg
         end

data/lib/appmap/version.rb

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

data/spec/hook_spec.rb

@@ -970,7 +970,7 @@ describe 'AppMap class Hooking', docker: false do
         tz = ENV['TZ']
         ENV['TZ'] = 'UTC'
         Timecop.freeze(Time.utc('2020-01-01')) do
-          expect(Time).to receive(:now).exactly(3).times.and_call_original
+          expect(Time).to receive(:now).at_least(3).times.and_call_original
           expect(InstanceMethod.new.say_the_time).to be
         end
       ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.54.4
+  version: 0.55.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport