appmap 0.35.1 → 0.35.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baf04e5395f8456142064fd8413363f6e29aa1bf2b68150e79b904d3879b8b7f
-  data.tar.gz: ca27e18b4778b9341801ac81e25e9025ab26a047824b58ab4bcf113ab91fd5b9
+  metadata.gz: 9e7d5c58bd3addf395c32591fe468c4a0b0e886d715cb711ffb6c898049455e5
+  data.tar.gz: 271ac50ee1ebe139ed8e52262a98a13e6b3d471ddcab49316669e66d0b7be57a
 SHA512:
-  metadata.gz: f7a97d2d7a4e8bd5ae7db133e6287775dcff0373af82f187bc7d82411f868731e30fdb1a1267b173578a38d44017b20127cb20dcd7ddf3924d813e9ba6b32eb5
-  data.tar.gz: 784ea7d032b9186d50352c0222b168887249b0a9bde5d850f4b2b98e12555ed728f1dc95c1604e2e45d7d6a15c6765eda467ddbd55530af859c82842a1aca4ca
+  metadata.gz: b84b1d76d8890a72fb376e95c7ab3811814b75e99304d2f1c15bb091cba1aef1e81f7688fd69c35b8c7735fd72167f89c67eeb25f76e54253503be610fff52cc
+  data.tar.gz: 12b27887ae25d8f91fa6321ea59c222c7ec7d1e2d6a198f6672fa166fcd3c32456fe0d3969dda729d4c4817129a3eb874f8bae0afb5dca6b74253ccf457bd51b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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/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

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.35.1'
+  VERSION = '0.35.2'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/spec/fixtures/hook/exception_method.rb

@@ -9,3 +9,47 @@ class ExceptionMethod
     raise 'Exception occurred in raise_exception'
   end
 end
+
+# subclass from BasicObject so we don't get #to_s. Requires some
+# hackery to implement the other methods normally provided by Object.
+class NoToSMethod < BasicObject
+  def is_a?(*args)
+    return false
+  end
+
+  def class
+    return ::Class
+  end
+
+  def respond_to?(*args)
+    return false
+  end
+
+  def inspect
+    "NoToSMethod"
+  end
+
+  def say_hello
+    "hello"
+  end
+end
+
+class InspectRaises < NoToSMethod
+  def inspect
+    ::Kernel.raise "#to_s missing, #inspect raises"
+  end
+
+  def say_hello
+    "hello"
+  end
+end
+
+class ToSRaises
+  def to_s
+    raise "#to_s raises"
+  end
+
+  def say_hello
+    "hello"
+  end
+end

data/spec/hook_spec.rb

@@ -465,6 +465,132 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  context 'string conversions works for the receiver when' do
+
+    it 'is missing #to_s' do
+      events_yaml = <<~YAML
+      ---
+      - :id: 1
+        :event: :call
+        :defined_class: NoToSMethod
+        :method_id: respond_to?
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 24
+        :static: false
+        :parameters:
+        - :name: :args
+          :class: Symbol
+          :value: to_s
+          :kind: :rest
+        :receiver:
+          :class: Class
+          :value: NoToSMethod
+      - :id: 2
+        :event: :return
+        :parent_id: 1
+      - :id: 3
+        :event: :call
+        :defined_class: NoToSMethod
+        :method_id: say_hello
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 32
+        :static: false
+        :parameters: []
+        :receiver:
+          :class: Class
+          :value: NoToSMethod
+      - :id: 4
+        :event: :return
+        :parent_id: 3
+        :return_value:
+          :class: String
+          :value: hello
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+        inst = NoToSMethod.new
+        # sanity check
+        expect(inst).not_to respond_to(:to_s)
+        inst.say_hello
+      end
+    end
+
+    it 'it is missing #to_s and it raises an exception in #inspect' do
+      events_yaml = <<~YAML
+      ---
+      - :id: 1
+        :event: :call
+        :defined_class: NoToSMethod
+        :method_id: respond_to?
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 24
+        :static: false
+        :parameters:
+        - :name: :args
+          :class: Symbol
+          :value: to_s
+          :kind: :rest
+        :receiver:
+          :class: Class
+          :value: "*Error inspecting variable*"
+      - :id: 2
+        :event: :return
+        :parent_id: 1
+      - :id: 3
+        :event: :call
+        :defined_class: InspectRaises
+        :method_id: say_hello
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 42
+        :static: false
+        :parameters: []
+        :receiver:
+          :class: Class
+          :value: "*Error inspecting variable*"
+      - :id: 4
+        :event: :return
+        :parent_id: 3
+        :return_value:
+          :class: String
+          :value: hello
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+        inst = InspectRaises.new
+        # sanity check
+        expect(inst).not_to respond_to(:to_s)
+        inst.say_hello
+      end
+    end
+
+    it 'it raises an exception in #to_s' do
+      events_yaml = <<~YAML
+      ---
+      - :id: 1
+        :event: :call
+        :defined_class: ToSRaises
+        :method_id: say_hello
+        :path: spec/fixtures/hook/exception_method.rb
+        :lineno: 52
+        :static: false
+        :parameters: []
+        :receiver:
+          :class: ToSRaises
+          :value: "*Error inspecting variable*"
+      - :id: 2
+        :event: :return
+        :parent_id: 1
+        :return_value:
+          :class: String
+          :value: hello
+      YAML
+
+      test_hook_behavior 'spec/fixtures/hook/exception_method.rb', events_yaml do
+        ToSRaises.new.say_hello
+      end
+    end
+  end
+
   it 're-raises exceptions' do
     RSpec::Expectations.configuration.on_potential_false_positives = :nothing
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.35.2
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport