appmap 0.93.4 → 0.94.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b703d48969c96f7967495b9719c47c2a391d8cbe612581480152614ff60cc5
-  data.tar.gz: 5fb1da8f5574f3d96db8216fdcc4710e83c2d1a72a66f9b942be9eeba7b2ea95
+  metadata.gz: f15bcc9505431c7f47af59305eb18a7c8472f119396ab4cd2441114cbf95a0ca
+  data.tar.gz: affc5aaad8304d3a0e6b4f372934a1d38b9b6372ce2280d22a157d62c6156d8d
 SHA512:
-  metadata.gz: d040f5fda6f71885a66090e1f14e7d1c0bc815ae4bc59b2c99ef47cbe982b4143ba8af8f4eeb2d6ad032c324b66ee4a61731723b9a27b33a712f55cac7e66d37
-  data.tar.gz: e915ca689cece094856ad434241c5107dc78914967ab0b355586c512c36397a1055634e411145b604b9581b19a89afa8e7cea63e68741c35e03afe20ba1c627b
+  metadata.gz: fe56e37f042cac25f53612f4489762e42cb02ce231270fac02dda746abf73ed3e79febfc60a30829b25e7c7d395bb14f01398c62226e28a0bf795af751e33aae
+  data.tar.gz: f045b85390e4a335f9d1b62cdcefb2f45466e2d24f9009b3a31b990cfed5ffafdd475166b93a73889209f8959d60d51dcf91f80a7835bcdcc2a01dfe659f1752

data/.rubocop.yml

@@ -14,6 +14,9 @@ Layout/CaseIndentation:
 Layout/FirstArgumentIndentation:
   EnforcedStyle: consistent
 
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.94.0](https://github.com/getappmap/appmap-ruby/compare/v0.93.5...v0.94.0) (2022-11-22)
+
+
+### Features
+
+* Emit nested return_value.properties ([2c74c68](https://github.com/getappmap/appmap-ruby/commit/2c74c68f9e2a5bcb3f095850c9d520422b63e25f))
+
+## [0.93.5](https://github.com/getappmap/appmap-ruby/compare/v0.93.4...v0.93.5) (2022-11-08)
+
+
+### Bug Fixes
+
+* Only show a warning in non-Rails projects ([4ed86c7](https://github.com/getappmap/appmap-ruby/commit/4ed86c705ea0183940714af47bdda81917ad3f92)), closes [#292](https://github.com/getappmap/appmap-ruby/issues/292)
+
 ## [0.93.4](https://github.com/getappmap/appmap-ruby/compare/v0.93.3...v0.93.4) (2022-11-04)
 
 

data/lib/appmap/command/agent_setup/validate.rb

@@ -14,7 +14,7 @@ module AppMap
           schema = YAML.safe_load(File.read(schema_path))
           result = {
             version: 2,
-            errors: config_validator.valid? ? [] : config_validator.violations.map(&:to_h),
+            errors: config_validator.violations.map(&:to_h),
             schema: schema
           }
           puts JSON.pretty_generate(result)

data/lib/appmap/event.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'weakref'
+require_relative './value_inspector'
 
 module AppMap
   module Event
@@ -20,6 +21,8 @@ module AppMap
     MethodEventStruct = Struct.new(:id, :event, :thread_id)
 
     class MethodEvent < MethodEventStruct
+      extend ValueInspector
+
       MAX_ARRAY_ENUMERATION = 10
       MAX_HASH_ENUMERATION = 10
       MAX_STRING_LENGTH = 100
@@ -61,33 +64,12 @@ module AppMap
         end
 
         def add_size(param, value)
-          # Don't risk calling #size on things like data-access objects, which can and will issue queries for this information.
-          if value.is_a?(Array) || value.is_a?(Hash)
-            param[:size] = value.size
-          end
+          size = ValueInspector.detect_size(value)
+          param[:size] = size if size
         end
 
         def add_schema(param, value)
-          begin
-            if value.respond_to?(:keys)
-              param[:properties] = value.keys.map { |key| { name: key, class: best_class_name(value[key]) } }
-            elsif value.respond_to?(:first) && value.first
-              if value.first != value
-                add_schema param, value.first
-              end
-            end
-          rescue
-            warn "Error in add_schema(#{value.class})", $!
-          end
-        end
-
-        # Heuristic for dynamically defined class whose name can be nil
-        def best_class_name(value)
-          value_cls = value.class
-          while value_cls && value_cls.name.nil?
-            value_cls = value_cls.superclass
-          end
-          value_cls&.name || 'unknown'
+          ValueInspector.detect_schema(value, type_info: param)
         end
 
         def encode_display_string(value)

data/lib/appmap/service/config_analyzer.rb

@@ -25,7 +25,11 @@ module AppMap
 
       def errors
         valid?
-        config_validator.violations.map(&:message)
+        config_validator.violations.filter(&:error?).map(&:message)
+      end
+
+      def warnings
+        config_validator.violations.filter(&:warning?).map(&:message)
       end
 
       private

data/lib/appmap/service/validator/config_validator.rb

@@ -7,8 +7,6 @@ module AppMap
   module Service
     module Validator
       class ConfigValidator
-        attr_reader :violations
-
         def initialize(config_file)
           @config_file = config_file
           @violations = []
@@ -19,17 +17,29 @@ module AppMap
         end
 
         def valid?
+          validate
+          @violations.none?(&:error?)
+        end
+
+        def violations
+          validate
+          @violations
+        end
+
+        private
+
+        def validate
+          return if @validated
+
           @violations = []
           validate_ruby_version
           validate_rails_presence
           validate_config_presence
           parse_config
           validate_config_load
-          @violations.empty?
+          @validated = true
         end
 
-        private
-
         def present?
           File.exist?(@config_file)
         end
@@ -71,8 +81,10 @@ module AppMap
 
         def validate_rails_presence
           unless Gem.loaded_specs.has_key?('rails')
-            @violations << Violation.error(
-              message: 'AppMap auto-configuration is currently not available for non Rails projects'
+            @violations << Violation.warning(
+              message: "This is not a Rails project. AppMap won't be automatically loaded.",
+              detailed_message: "Please ensure you `require 'appmap'` in your test environment.",
+              help_urls: [ 'https://appmap.io/docs/reference/appmap-ruby#tests-recording' ]
             )
           end
         end

data/lib/appmap/service/validator/violation.rb

@@ -44,6 +44,14 @@ module AppMap
             hash[var.to_s.delete("@")] = self.instance_variable_get(var)
           end.compact
         end
+
+        def error?
+          @level == :error
+        end
+
+        def warning?
+          @level == :warning
+        end
       end
     end
   end

data/lib/appmap/value_inspector.rb

@@ -0,0 +1,49 @@
+module AppMap
+  module ValueInspector
+    extend self
+
+    MAX_DEPTH = 3
+
+    def detect_size(value)
+      # Don't risk calling #size on things like data-access objects, which can and will issue queries for this information.
+      if value.is_a?(Array) || value.is_a?(Hash)
+        value.size
+      end
+    end
+
+    def detect_schema(value, max_depth: MAX_DEPTH, type_info: {}, observed_values: Set.new(), depth: 0)
+      return type_info if depth == max_depth
+
+      begin
+        if value.respond_to?(:keys)
+          properties = value.keys.select { |key| key != '' && !key.nil? }.map do |key|
+            next_value = value[key]
+            next if observed_values.include?(next_value)
+
+            observed_values << next_value
+            { name: key, class: best_class_name(next_value) }.tap do |schema|
+              detect_schema(next_value, **{ max_depth: max_depth, type_info: schema, observed_values: observed_values, depth: depth + 1 })
+            end
+          end.compact
+          type_info[:properties] = properties unless properties.empty?
+        elsif value.respond_to?(:first) && !observed_values.include?(value.first)
+          observed_values << value.first
+          detect_schema(value.first, **{ max_depth: max_depth, type_info: type_info, observed_values: observed_values, depth: depth + 1 })
+        end
+      rescue
+        warn "Error in add_schema(#{value.class})", $!
+        raise
+      end
+      type_info
+    end
+
+    # Heuristic for dynamically defined class whose name can be nil
+    def best_class_name(value)
+      value_cls = value.class
+      while value_cls && value_cls.name.nil?
+        value_cls = value_cls.superclass
+      end
+      value_cls&.name || 'unknown'
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,9 +3,9 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.93.4'
+  VERSION = '0.94.0'
 
-  APPMAP_FORMAT_VERSION = '1.9.0'
+  APPMAP_FORMAT_VERSION = '1.10.0'
 
   SUPPORTED_RUBY_VERSIONS = %w[2.5 2.6 2.7 3.0 3.1].freeze
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.93.4
+  version: 0.94.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -432,6 +432,7 @@ files:
 - lib/appmap/swagger/stable.rb
 - lib/appmap/trace.rb
 - lib/appmap/util.rb
+- lib/appmap/value_inspector.rb
 - lib/appmap/version.rb
 - package.json
 - release.sh