RubyGems - appmap - Versions diffs - 0.27.0 → 0.33.0 - Mend

appmap 0.27.0 → 0.33.0

Files changed (73) hide show

checksums.yaml +4 -4
data/.gitignore +1 -3
data/CHANGELOG.md +37 -0
data/README.md +170 -29
data/Rakefile +1 -1
data/appmap.gemspec +1 -0
data/exe/appmap +3 -1
data/lib/appmap.rb +54 -38
data/lib/appmap/algorithm/stats.rb +2 -1
data/lib/appmap/class_map.rb +21 -28
data/lib/appmap/command/record.rb +2 -61
data/lib/appmap/config.rb +89 -0
data/lib/appmap/cucumber.rb +89 -0
data/lib/appmap/event.rb +28 -19
data/lib/appmap/hook.rb +56 -128
data/lib/appmap/hook/method.rb +78 -0
data/lib/appmap/metadata.rb +62 -0
data/lib/appmap/middleware/remote_recording.rb +2 -6
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/railtie.rb +2 -2
data/lib/appmap/record.rb +27 -0
data/lib/appmap/rspec.rb +9 -37
data/lib/appmap/trace.rb +18 -10
data/lib/appmap/util.rb +59 -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/fixtures/rails_users_app/Gemfile +1 -0
data/spec/fixtures/rails_users_app/features/api_users.feature +13 -0
data/spec/fixtures/rails_users_app/features/support/env.rb +4 -0
data/spec/fixtures/rails_users_app/features/support/hooks.rb +11 -0
data/spec/fixtures/rails_users_app/features/support/steps.rb +18 -0
data/spec/hook_spec.rb +228 -53
data/spec/open_spec.rb +19 -0
data/spec/rails_spec_helper.rb +2 -0
data/spec/record_sql_rails_pg_spec.rb +56 -33
data/spec/rspec_feature_metadata_spec.rb +2 -0
data/spec/spec_helper.rb +4 -0
data/spec/util_spec.rb +21 -0
data/test/cli_test.rb +4 -4
data/test/cucumber_test.rb +72 -0
data/test/fixtures/cucumber4_recorder/Gemfile +5 -0
data/test/fixtures/cucumber4_recorder/appmap.yml +3 -0
data/test/fixtures/cucumber4_recorder/features/say_hello.feature +5 -0
data/test/fixtures/cucumber4_recorder/features/support/env.rb +5 -0
data/test/fixtures/cucumber4_recorder/features/support/hooks.rb +11 -0
data/test/fixtures/cucumber4_recorder/features/support/steps.rb +9 -0
data/test/fixtures/cucumber4_recorder/lib/hello.rb +7 -0
data/test/fixtures/cucumber_recorder/Gemfile +5 -0
data/test/fixtures/cucumber_recorder/appmap.yml +3 -0
data/test/fixtures/cucumber_recorder/features/say_hello.feature +5 -0
data/test/fixtures/cucumber_recorder/features/support/env.rb +5 -0
data/test/fixtures/cucumber_recorder/features/support/hooks.rb +11 -0
data/test/fixtures/cucumber_recorder/features/support/steps.rb +9 -0
data/test/fixtures/cucumber_recorder/lib/hello.rb +7 -0
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/process_recorder/appmap.yml +3 -0
data/test/fixtures/process_recorder/hello.rb +9 -0
data/test/minitest_test.rb +38 -0
data/test/record_process_test.rb +35 -0
data/test/test_helper.rb +1 -0
metadata +55 -3
data/spec/fixtures/hook/class_method.rb +0 -17

@@ -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/railtie.rb CHANGED

@@ -5,8 +5,8 @@ module AppMap
   class Railtie < ::Rails::Railtie
     config.appmap = ActiveSupport::OrderedOptions.new
-    initializer 'appmap.init' do |_| #  params: app
-      AppMap.configure
+    initializer 'appmap.init' do |_| # params: app
+      require 'appmap'
     end
     # appmap.subscribe subscribes to ActiveSupport Notifications so that they can be recorded as

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
+require 'appmap/util'
 module AppMap
   # Integration of AppMap with RSpec. When enabled with APPMAP=true, the AppMap tracer will
   # be activated around each scenario which has the metadata key `:appmap`.
@@ -8,10 +10,7 @@ module AppMap
     LOG = false
     def self.metadata
-      require 'appmap/command/record'
-      @metadata ||= AppMap::Command::Record.detect_metadata
-      @metadata.freeze
-      @metadata.deep_dup
+      AppMap.detect_metadata
     end
     module FeatureAnnotations
@@ -139,7 +138,7 @@ module AppMap
         AppMap::RSpec.add_event_methods @trace.event_methods
-        class_map = AppMap.class_map(AppMap::RSpec.config, @trace.event_methods)
+        class_map = AppMap.class_map(@trace.event_methods)
         description = []
         scope = ScopeExample.new(example)
@@ -190,7 +189,6 @@ module AppMap
     end
     @recordings_by_example = {}
-    @config = nil
     @event_methods = Set.new
     class << self
@@ -198,10 +196,6 @@ module AppMap
         warn 'Configuring AppMap recorder for RSpec'
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
-        require 'appmap/hook'
-        @config = AppMap.configure
-        AppMap::Hook.hook(@config)
       end
       def begin_spec(example)
@@ -224,9 +218,9 @@ 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] = @config.name
+          m[:app] = AppMap.configuration.name
           m[:feature] = feature_name if feature_name
           m[:feature_group] = feature_group_name if feature_group_name
           m[:labels] = labels if labels
@@ -246,13 +240,13 @@ module AppMap
           classMap: class_map,
           events: events
         }.compact
-        fname = sanitize_filename(example_name)
+        fname = AppMap::Util.scenario_filename(example_name)
-        File.write(File.join(APPMAP_OUTPUT_DIR, "#{fname}.appmap.json"), JSON.generate(appmap))
+        File.write(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
       end
       def print_inventory
-        class_map = AppMap.class_map(@config, @event_methods)
+        class_map = AppMap.class_map(@event_methods)
         save 'Inventory', class_map, labels: %w[inventory]
       end
@@ -266,28 +260,6 @@ module AppMap
           print_inventory
         end
       end
-      private
-      # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
-      # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
-      def sanitize_filename(fname, separator: '_')
-        # Replace accented chars with their ASCII equivalents.
-        fname = fname.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
-        # Turn unwanted chars into the separator.
-        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
-        re_sep = Regexp.escape(separator)
-        re_duplicate_separator        = /#{re_sep}{2,}/
-        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
-        # No more than one of the separator in a row.
-        fname.gsub!(re_duplicate_separator, separator)
-        # Finally, Remove leading/trailing separator.
-        fname.gsub(re_leading_trailing_separator, '')
-      end
     end
   end
 end

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 Tracers
+    class Tracing
       def initialize
-        @tracers = []
+        @tracing = []
       end
       def empty?
-        @tracers.empty?
+        @tracing.empty?
       end
       def trace(enable: true)
         Tracer.new.tap do |tracer|
-          @tracers << tracer
+          @tracing << tracer
           tracer.enable if enable
         end
       end
       def enabled?
-        @tracers.any?(&:enabled?)
+        @tracing.any?(&:enabled?)
       end
       def record_event(event, defined_class: nil, method: nil)
-        @tracers.each do |tracer|
+        @tracing.each do |tracer|
           tracer.record_event(event, defined_class: defined_class, method: method)
         end
       end
       def delete(tracer)
-        return unless @tracers.member?(tracer)
+        return unless @tracing.member?(tracer)
-        @tracers.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 ADDED

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module AppMap
+  module Util
+    class << self
+      # scenario_filename builds a suitable file name from a scenario name.
+      # Special characters are removed, and the file name is truncated to fit within
+      # shell limitations.
+      def scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json')
+        # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
+        # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
+        # Replace accented chars with their ASCII equivalents.
+        fname = name.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+        # Turn unwanted chars into the separator.
+        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
+        re_sep = Regexp.escape(separator)
+        re_duplicate_separator        = /#{re_sep}{2,}/
+        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
+        # No more than one of the separator in a row.
+        fname.gsub!(re_duplicate_separator, separator)
+        # Finally, Remove leading/trailing separator.
+        fname.gsub!(re_leading_trailing_separator, '')
+        if (fname.length + extension.length) > max_length
+          require 'base64'
+          require 'digest'
+          fname_digest = Base64.urlsafe_encode64 Digest::MD5.digest(fname), padding: false
+          fname[max_length - fname_digest.length - extension.length - 1..-1] = [ '-', fname_digest ].join
+        end
+        [ 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.27.0'
+  VERSION = '0.33.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