RubyGems - appmap - Versions diffs - 0.28.0 → 0.34.0 - Mend

appmap 0.28.0 → 0.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (50) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +32 -0
data/README.md +54 -2
data/Rakefile +1 -1
data/appmap.gemspec +1 -0
data/lib/appmap.rb +25 -14
data/lib/appmap/algorithm/stats.rb +2 -1
data/lib/appmap/class_map.rb +26 -28
data/lib/appmap/config.rb +115 -0
data/lib/appmap/event.rb +28 -19
data/lib/appmap/hook.rb +88 -129
data/lib/appmap/hook/method.rb +78 -0
data/lib/appmap/metadata.rb +1 -1
data/lib/appmap/minitest.rb +141 -0
data/lib/appmap/open.rb +57 -0
data/lib/appmap/rails/action_handler.rb +7 -7
data/lib/appmap/rails/sql_handler.rb +10 -8
data/lib/appmap/record.rb +27 -0
data/lib/appmap/rspec.rb +2 -2
data/lib/appmap/trace.rb +17 -9
data/lib/appmap/util.rb +19 -0
data/lib/appmap/version.rb +1 -1
data/package-lock.json +3 -3
data/spec/abstract_controller4_base_spec.rb +1 -1
data/spec/abstract_controller_base_spec.rb +9 -2
data/spec/config_spec.rb +3 -3
data/spec/fixtures/hook/compare.rb +7 -0
data/spec/fixtures/hook/singleton_method.rb +54 -0
data/spec/hook_spec.rb +280 -53
data/spec/open_spec.rb +19 -0
data/spec/record_sql_rails_pg_spec.rb +56 -33
data/spec/util_spec.rb +1 -1
data/test/cli_test.rb +14 -4
data/test/fixtures/minitest_recorder/Gemfile +5 -0
data/test/fixtures/minitest_recorder/appmap.yml +3 -0
data/test/fixtures/minitest_recorder/lib/hello.rb +5 -0
data/test/fixtures/minitest_recorder/test/hello_test.rb +12 -0
data/test/fixtures/openssl_recorder/Gemfile +3 -0
data/test/fixtures/openssl_recorder/appmap.yml +3 -0
data/test/fixtures/openssl_recorder/lib/openssl_cert_sign.rb +94 -0
data/test/fixtures/openssl_recorder/lib/openssl_encrypt.rb +34 -0
data/test/fixtures/openssl_recorder/lib/openssl_key_sign.rb +28 -0
data/test/fixtures/process_recorder/appmap.yml +3 -0
data/test/fixtures/process_recorder/hello.rb +9 -0
data/test/minitest_test.rb +38 -0
data/test/openssl_test.rb +203 -0
data/test/record_process_test.rb +35 -0
data/test/test_helper.rb +1 -0
metadata +38 -4
data/spec/fixtures/hook/class_method.rb +0 -17

data/lib/appmap/open.rb ADDED

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+module AppMap
+  OpenStruct = Struct.new(:appmap)
+  class Open < OpenStruct
+    attr_reader :port
+    def perform
+      server = run_server
+      open_browser
+      server.kill
+    end
+    def page
+      require 'rack/utils'
+      <<~PAGE
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>&hellip;</title>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+        <script type="text/javascript">
+        function dosubmit() { document.forms[0].submit(); }
+        </script>
+      </head>
+      <body onload="dosubmit();">
+        <form action="https://app.land/scenario_uploads" method="POST" accept-charset="utf-8">
+        <input type="hidden" name="data" value='#{Rack::Utils.escape_html appmap.to_json}'>
+        </form>
+      </body>
+      </html>
+      PAGE
+    end
+    def run_server
+      require 'rack'
+      Thread.new do
+        Rack::Handler::WEBrick.run(
+          lambda do |env|
+            return [200, { 'Content-Type' => 'text/html' }, [page]]
+          end,
+          :Port => 0
+        ) do |server|
+          @port = server.config[:Port]
+        end
+      end.tap do
+        sleep 1.0
+      end
+    end
+    def open_browser
+      system 'open', "http://localhost:#{@port}"
+      sleep 5.0
+    end
+  end
+end

data/lib/appmap/rails/action_handler.rb CHANGED

@@ -16,11 +16,11 @@ module AppMap
       class HTTPServerRequest
         include ContextKey
-        class Call < AppMap::Event::MethodEvent
+        class Call < AppMap::Event::MethodCall
           attr_accessor :payload
-          def initialize(path, lineno, payload)
-            super AppMap::Event.next_id_counter, :call, HTTPServerRequest, :call, path, lineno, false, Thread.current.object_id
+          def initialize(payload)
+            super AppMap::Event.next_id_counter, :call, Thread.current.object_id
             self.payload = payload
           end
@@ -47,7 +47,7 @@ module AppMap
         end
         def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
-          event = Call.new(__FILE__, __LINE__, payload)
+          event = Call.new(payload)
           Thread.current[context_key] = Context.new(event.id, Time.now)
           AppMap.tracing.record_event(event)
         end
@@ -59,8 +59,8 @@ module AppMap
         class Call < AppMap::Event::MethodReturnIgnoreValue
           attr_accessor :payload
-          def initialize(path, lineno, payload, parent_id, elapsed)
-            super AppMap::Event.next_id_counter, :return, HTTPServerResponse, :call, path, lineno, false, Thread.current.object_id
+          def initialize(payload, parent_id, elapsed)
+            super AppMap::Event.next_id_counter, :return, Thread.current.object_id
             self.payload = payload
             self.parent_id = parent_id
@@ -82,7 +82,7 @@ module AppMap
           context = Thread.current[context_key]
           Thread.current[context_key] = nil
-          event = Call.new(__FILE__, __LINE__, payload, context.id, Time.now - context.start_time)
+          event = Call.new(payload, context.id, Time.now - context.start_time)
           AppMap.tracing.record_event(event)
         end
       end

data/lib/appmap/rails/sql_handler.rb CHANGED

@@ -5,11 +5,11 @@ require 'appmap/event'
 module AppMap
   module Rails
     class SQLHandler
-      class SQLCall < AppMap::Event::MethodEvent
+      class SQLCall < AppMap::Event::MethodCall
         attr_accessor :payload
-        def initialize(path, lineno, payload)
-          super AppMap::Event.next_id_counter, :call, SQLHandler, :call, path, lineno, false, Thread.current.object_id
+        def initialize(payload)
+          super AppMap::Event.next_id_counter, :call, Thread.current.object_id
           self.payload = payload
         end
@@ -20,7 +20,7 @@ module AppMap
               sql: payload[:sql],
               database_type: payload[:database_type]
             }.tap do |sql_query|
-              %i[server_version explain_sql].each do |attribute|
+              %i[server_version].each do |attribute|
                 sql_query[attribute] = payload[attribute] if payload[attribute]
               end
             end
@@ -29,8 +29,8 @@ module AppMap
       end
       class SQLReturn < AppMap::Event::MethodReturnIgnoreValue
-        def initialize(path, lineno, parent_id, elapsed)
-          super AppMap::Event.next_id_counter, :return, SQLHandler, :call, path, lineno, false, Thread.current.object_id
+        def initialize(parent_id, elapsed)
+          super AppMap::Event.next_id_counter, :return, Thread.current.object_id
           self.parent_id = parent_id
           self.elapsed = elapsed
@@ -76,6 +76,8 @@ module AppMap
             case database_type
             when :postgres
               ActiveRecord::Base.connection.postgresql_version
+            when :sqlite
+              ActiveRecord::Base.connection.database_version.to_s
             else
               warn "Unable to determine database version for #{database_type.inspect}"
             end
@@ -133,9 +135,9 @@ module AppMap
           SQLExaminer.examine payload, sql: sql
-          call = SQLCall.new(__FILE__, __LINE__, payload)
+          call = SQLCall.new(payload)
           AppMap.tracing.record_event(call)
-          AppMap.tracing.record_event(SQLReturn.new(__FILE__, __LINE__, call.id, finished - started))
+          AppMap.tracing.record_event(SQLReturn.new(call.id, finished - started))
         ensure
           Thread.current[reentry_key] = nil
         end

data/lib/appmap/record.rb ADDED

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'appmap'
+require 'json'
+tracer = AppMap.tracing.trace
+at_exit do
+  AppMap.tracing.delete(tracer)
+  events = [].tap do |event_list|
+    event_list << tracer.next_event.to_h while tracer.event?
+  end
+  metadata = AppMap.detect_metadata
+  metadata[:recorder] = {
+    name: 'record_process'
+  }
+  appmap = {
+    'version' => AppMap::APPMAP_FORMAT_VERSION,
+    'metadata' => metadata,
+    'classMap' => AppMap.class_map(tracer.event_methods),
+    'events' => events
+  }
+  File.write 'appmap.json', JSON.generate(appmap)
+end

data/lib/appmap/rspec.rb CHANGED

@@ -154,7 +154,7 @@ module AppMap
         end
         labels = labels.map(&:to_s).map(&:strip).reject(&:blank?).map(&:downcase).uniq
-        description.reject!(&:nil?).reject(&:blank?)
+        description.reject!(&:nil?).reject!(&:blank?)
         default_description = description.last
         description.reverse!
@@ -218,7 +218,7 @@ module AppMap
       end
       def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
-        metadata = RSpec.metadata.tap do |m|
+        metadata = AppMap::RSpec.metadata.tap do |m|
           m[:name] = example_name
           m[:app] = AppMap.configuration.name
           m[:feature] = feature_name if feature_name

data/lib/appmap/trace.rb CHANGED

@@ -2,38 +2,46 @@
 module AppMap
   module Trace
-    ScopedMethod = Struct.new(:defined_class, :method)
+    class ScopedMethod < SimpleDelegator
+      attr_reader :defined_class, :static
+      def initialize(defined_class, method, static)
+        @defined_class = defined_class
+        @static = static
+        super(method)
+      end
+    end
     class Tracing
       def initialize
-        @Tracing = []
+        @tracing = []
       end
       def empty?
-        @Tracing.empty?
+        @tracing.empty?
       end
       def trace(enable: true)
         Tracer.new.tap do |tracer|
-          @Tracing << tracer
+          @tracing << tracer
           tracer.enable if enable
         end
       end
       def enabled?
-        @Tracing.any?(&:enabled?)
+        @tracing.any?(&:enabled?)
       end
       def record_event(event, defined_class: nil, method: nil)
-        @Tracing.each do |tracer|
+        @tracing.each do |tracer|
           tracer.record_event(event, defined_class: defined_class, method: method)
         end
       end
       def delete(tracer)
-        return unless @Tracing.member?(tracer)
+        return unless @tracing.member?(tracer)
-        @Tracing.delete(tracer)
+        @tracing.delete(tracer)
         tracer.disable
       end
     end
@@ -67,7 +75,7 @@ module AppMap
       return unless @enabled
       @events << event
-      @methods << Trace::ScopedMethod.new(defined_class, method) if defined_class && method
+      @methods << Trace::ScopedMethod.new(defined_class, method, event.static) if (defined_class && method && event.event == :call)
     end
     # Gets a unique list of the methods that were invoked by the program.

data/lib/appmap/util.rb CHANGED

@@ -35,6 +35,25 @@ module AppMap
         [ fname, extension ].join
       end
+      # sanitize_event removes ephemeral values from an event, making
+      # events easier to compare across runs.
+      def sanitize_event(event, &block)
+        event.delete(:thread_id)
+        event.delete(:elapsed)
+        delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
+        delete_object_id.call(event[:receiver])
+        delete_object_id.call(event[:return_value])
+        (event[:parameters] || []).each(&delete_object_id)
+        (event[:exceptions] || []).each(&delete_object_id)
+        case event[:event]
+        when :call
+          event[:path] = event[:path].gsub(Gem.dir + '/', '')
+        end
+        event
+      end
     end
   end
 end

data/lib/appmap/version.rb CHANGED

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

data/package-lock.json CHANGED

@@ -551,9 +551,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
     },
     "longest": {
       "version": "1.0.1",

data/spec/abstract_controller4_base_spec.rb CHANGED

@@ -48,12 +48,12 @@ describe 'AbstractControllerBase' do
       expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
+  thread_id: .*
   defined_class: Api::UsersController
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
   static: false
-  thread_id: .*
   parameters:
   - name: params
     class: Hash

data/spec/abstract_controller_base_spec.rb CHANGED

@@ -47,18 +47,18 @@ describe 'AbstractControllerBase' do
       SERVER_REQUEST
     end
-    it 'Properly captures method parameters in the appmap' do
+    it 'properly captures method parameters in the appmap' do
       expect(File).to exist(appmap_json)
       appmap = JSON.parse(File.read(appmap_json)).to_yaml
       expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
+  thread_id: .*
   defined_class: Api::UsersController
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
   static: false
-  thread_id: .*
   parameters:
   - name: params
     class: ActiveSupport::HashWithIndifferentAccess
@@ -68,5 +68,12 @@ describe 'AbstractControllerBase' do
   receiver:
       CREATE_CALL
     end
+    it 'returns a minimal event' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json))
+      event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
+      expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+    end
   end
 end

data/spec/config_spec.rb CHANGED

@@ -2,9 +2,9 @@
 require 'rails_spec_helper'
 require 'active_support/core_ext'
-require 'appmap/hook'
+require 'appmap/config'
-describe AppMap::Hook::Config do
+describe AppMap::Config, docker: false do
   it 'loads from a Hash' do
     config_data = {
       name: 'test',
@@ -18,7 +18,7 @@ describe AppMap::Hook::Config do
         }
       ]
     }.deep_stringify_keys!
-    config = AppMap::Hook::Config.load(config_data)
+    config = AppMap::Config.load(config_data)
     expect(config.to_h.deep_stringify_keys!).to eq(config_data)
   end

data/spec/fixtures/hook/compare.rb ADDED

@@ -0,0 +1,7 @@
+require 'active_support/security_utils'
+class Compare
+  def self.compare(s1, s2)
+    ActiveSupport::SecurityUtils.secure_compare(s1, s2)
+  end
+end

data/spec/fixtures/hook/singleton_method.rb ADDED

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+class SingletonMethod
+  class << self
+    def say_default
+      'default'
+    end
+  end
+  def SingletonMethod.say_class_defined
+    'defined with explicit class scope'
+  end
+  def self.say_self_defined
+    'defined with self class scope'
+  end
+  # When called, do_include calls +include+ to bring in the module
+  # AddMethod. AddMethod defines a new instance method, which gets
+  # added to the singleton class of SingletonMethod.
+  def do_include
+    class << self
+      SingletonMethod.include(AddMethod)
+    end
+    self
+  end
+  def self.new_with_instance_method
+    SingletonMethod.new.tap do |m|
+      def m.say_instance_defined
+        'defined for an instance'
+      end
+    end
+  end
+  def to_s
+    'Singleton Method fixture'
+  end
+end
+module AddMethod
+  def self.included(base)
+    base.module_eval do
+      define_method "added_method" do
+        _added_method
+      end
+    end
+  end
+  def _added_method
+    'defined by including a module'
+  end
+end