appmap 0.90.1 → 0.92.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8c53e191f43fe539ca2fd9381bf690597ec89b96ab1848680344b3d52a1b8f6
-  data.tar.gz: 1ee5593abdd95aefcc4b10a9ac717ea281e27885a4fd6a89fa0dc10ea5c2f66a
+  metadata.gz: 78d8c3cf7967b06242390e3d11ddd24c5cf29fd70244b93b2bf170323747b762
+  data.tar.gz: 10147c54915b55d8a67723d1721c31a9e809983bb9b0012cdb2f480e9dcf3695
 SHA512:
-  metadata.gz: c718347cfdb809cdfbdd46bee5399a98e6100d5afc3120e060f297d6f950227f1e263fab6baf5b705c4ec3573ef2f9aa1d1e96aff2053e120de1a2cc7dc4a55e
-  data.tar.gz: 89e90d35c06c1ae3db76bb58481dce70420081c92e386dc1b75922fbe53fcdac2609f157967fdacf476e3ed9c5f5c79bcfe83a88e56f84ab14aebaaab36fccfe
+  metadata.gz: 7ce433191ab8e3699feeb995951df0653ef9b89bb11edc7ca671b80011a2af1818e08c22eaa4f0777ec364be9e6e9d8bfec84099ff518d43768fb710e005b681
+  data.tar.gz: f0c99190697605e71658d9c3c602913954604396c7fb3cc31db09edb1b4cb8bdd1fb4f184e762ff15458b64e5078cd69ac04c324eddd0b4d83e28e3c2b324bb0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [0.92.0](https://github.com/applandinc/appmap-ruby/compare/v0.91.0...v0.92.0) (2022-09-19)
+
+
+### Bug Fixes
+
+* Detect Rails via Rails::Railtie ([cf83f00](https://github.com/applandinc/appmap-ruby/commit/cf83f005e0a85d016f864c0ad2f1dfa1af2fe6b9))
+
+
+### Features
+
+* Don't auto-enable requests recording in 'test' ([30413cd](https://github.com/applandinc/appmap-ruby/commit/30413cdc23b3851e8e1272d30063e463b4b23aba))
+* Enable recording for known environments ([6c59c8a](https://github.com/applandinc/appmap-ruby/commit/6c59c8a5a0b61c19cec185d7406b148846ac5c24))
+* Use APPMAP=true to flag library loading ([9900631](https://github.com/applandinc/appmap-ruby/commit/9900631c07165a877704b7d7fd73857ccf9e32b3))
+
+# [0.91.0](https://github.com/applandinc/appmap-ruby/compare/v0.90.1...v0.91.0) (2022-09-19)
+
+
+### Features
+
+* Emit metadata.recorder.type ([6358669](https://github.com/applandinc/appmap-ruby/commit/6358669d5dc5123a613b18301519dac709614406))
+
 ## [0.90.1](https://github.com/applandinc/appmap-ruby/compare/v0.90.0...v0.90.1) (2022-09-19)
 
 

data/lib/appmap/agent.rb

@@ -9,6 +9,7 @@ require_relative 'open'
 
 # load extension
 require_relative 'appmap'
+require_relative './detect_enabled'
 
 module AppMap
   class << self
@@ -114,5 +115,9 @@ module AppMap
     def explain_queries?
       ENV['APPMAP_EXPLAIN_QUERIES'] == 'true'
     end
+
+    def recording_enabled?(recording_method = nil)
+      DetectEnabled.new(recording_method).enabled?
+    end
   end
 end

data/lib/appmap/cucumber.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'appmap'
 require 'appmap/util'
 require 'fileutils'
 
@@ -55,7 +56,7 @@ module AppMap
       end
 
       def enabled?
-        ENV['APPMAP'] == 'true'
+        AppMap.recording_enabled?(:cucumber)
       end
 
       def run
@@ -92,7 +93,8 @@ module AppMap
             'version' => Gem.loaded_specs['cucumber']&.version&.to_s
           }
           m['recorder'] = {
-            'name' => 'cucumber'
+            'name' => 'cucumber',
+            'type' => 'tests'
           }
         end
       end

data/lib/appmap/detect_enabled.rb

@@ -0,0 +1,111 @@
+require_relative './recording_methods'
+
+module AppMap
+  # Detects whether AppMap recording should be enabled. This test can be performed generally, or for
+  # a particular recording method. Recording can be enabled explicitly, for example via APPMAP=true,
+  # or it can be enabled implicitly, by running in a dev or test web application environment. Recording
+  # can also disabled explicitly, using environment variables.
+  class DetectEnabled
+    @@detected_for_method = {}
+
+    class << self
+      def clear_cache
+        @@detected_for_method = {}
+      end
+    end
+
+    def initialize(recording_method)
+      @recording_method = recording_method
+    end
+
+    def enabled?
+      unless @@detected_for_method[@recording_method].nil?
+        return @@detected_for_method[@recording_method]
+      end
+
+      raise "Unrecognized recording method: #{@recording_method}" if @recording_method && !AppMap::RECORDING_METHODS.member?(@recording_method)
+
+      message, enabled, enabled_by_env = detect_enabled
+
+      @@detected_for_method[@recording_method] = enabled
+
+      if @recording_method
+        if enabled && enabled_by_app_env?
+          warn AppMap::Util.color("AppMap #{@recording_method.nil? ? '' : "#{@recording_method} "}recording is enabled because #{message}", :magenta)
+        end
+      end
+
+      enabled
+    end
+
+    def detect_enabled
+      detection_functions = %i[globally_disabled? recording_method_disabled? enabled_by_app_env? recording_method_enabled? globally_enabled?]
+
+      message, enabled = []
+      while enabled.nil? && !detection_functions.empty?
+        message, enabled = method(detection_functions.shift).call
+      end
+
+      unless enabled.nil?
+        _, enabled_by_env = enabled_by_app_env?
+        return [ message, enabled, enabled_by_env ]
+      else
+        return [ 'it is not enabled by any configuration or framework', false, false ]
+      end
+    end
+
+    def enabled_by_app_env?
+      env_name, app_env = detect_app_env
+      if %i[rspec minitest cucumber].member?(@recording_method)
+        return [ "#{env_name} is '#{app_env}'", true ] if app_env == 'test'
+      end
+
+      if @recording_method.nil?
+        return [ "#{env_name} is '#{app_env}'", true ] if %w[test development].member?(app_env)
+      end
+
+      if %i[remote requests].member?(@recording_method)
+        return [ "#{env_name} is '#{app_env}'", true ] if app_env == 'development'
+      end
+    end
+
+    def detect_app_env
+      if rails_env
+        return [ 'RAILS_ENV', rails_env ]
+      elsif ENV['APP_ENV']
+        return [ 'APP_ENV', ENV['APP_ENV']]
+      end
+    end
+
+    def globally_enabled?
+      # Don't auto-enable request recording in the 'test' environment, because users probably don't want
+      # AppMaps of both test cases and requests. Requests recording can always be enabled by APPMAP_RECORD_REQUESTS=true.
+      requests_recording_in_test = -> () { [ :requests ].member?(@recording_method) && detect_app_env == 'test' }
+      [ 'APPMAP=true', true ] if ENV['APPMAP'] == 'true' && !requests_recording_in_test.()
+    end
+
+    def globally_disabled?
+      [ 'APPMAP=false', false ] if ENV['APPMAP'] == 'false'
+    end
+
+    def recording_method_disabled?
+      return false unless @recording_method
+
+      env_var = [ 'APPMAP', 'RECORD', @recording_method.upcase ].join('_')
+      [ "#{[ 'APPMAP', 'RECORD', @recording_method.upcase ].join('_')}=false", false ] if ENV[env_var] == 'false'
+    end
+
+    def recording_method_enabled?
+      return false unless @recording_method
+
+      env_var = [ 'APPMAP', 'RECORD', @recording_method.upcase ].join('_')
+      [ "#{[ 'APPMAP', 'RECORD', @recording_method.upcase ].join('_')}=true", true ] if ENV[env_var] == 'true'
+    end
+
+    def rails_env
+      return Rails.env if defined?(::Rails::Railtie)
+      
+      return ENV['RAILS_ENV']
+    end
+  end
+end

data/lib/appmap/middleware/remote_recording.rb

@@ -63,7 +63,8 @@ module AppMap
 
         metadata = AppMap.detect_metadata
         metadata[:recorder] = {
-          name: 'remote_recording'
+          name: 'remote_recording',
+          type: 'remote'
         }
 
         response = JSON.generate \
@@ -81,7 +82,7 @@ module AppMap
         # 0
 
         req = Rack::Request.new(env)
-        return handle_record_request(req) if req.path == '/_appmap/record'
+        return handle_record_request(req) if AppMap.recording_enabled?(:remote) && req.path == '/_appmap/record'
 
         start_time = Time.now
         # Support multi-threaded web server such as Puma by recording each thread
@@ -103,7 +104,8 @@ module AppMap
             metadata[:name] = appmap_name
             metadata[:timestamp] = start_time.to_f
             metadata[:recorder] = {
-              name: 'record_requests'
+              name: 'rack',
+              type: 'requests'
             }
     
             appmap = {
@@ -148,7 +150,7 @@ module AppMap
       end
 
       def record_all_requests?
-        ENV['APPMAP_RECORD_REQUESTS'] == 'true'
+        AppMap.recording_enabled?(:requests)
       end
 
       def recording?

data/lib/appmap/minitest.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'appmap'
 require 'appmap/util'
 require 'fileutils'
 require 'active_support'
@@ -101,7 +102,8 @@ module AppMap
             version: Gem.loaded_specs['minitest']&.version&.to_s
           }
           m[:recorder] = {
-            name: 'minitest'
+            name: 'minitest',
+            type: 'tests'
           }
           m[:test_status] = test_status
           if exception
@@ -124,7 +126,7 @@ module AppMap
       end
 
       def enabled?
-        ENV['APPMAP'] == 'true'
+        AppMap.recording_enabled?(:minitest)
       end
 
       def run

data/lib/appmap/railtie.rb

@@ -4,6 +4,11 @@ module AppMap
   # Railtie connects the AppMap recorder to Rails-specific features.
   class Railtie < ::Rails::Railtie
     initializer 'appmap.remote_recording' do
+      # Indicate early in the log when these methods are enabled.
+      %i[remote requests].each do |recording_method|
+        AppMap.recording_enabled?(recording_method)
+      end
+
       require 'appmap/middleware/remote_recording'
       Rails.application.config.middleware.insert_before \
         ActionDispatch::Executor,
@@ -29,4 +34,4 @@ module AppMap
       end
     end
   end
-end if ENV['APPMAP'] == 'true'
+end if AppMap.recording_enabled?

data/lib/appmap/record.rb

@@ -14,7 +14,8 @@ at_exit do
 
   metadata = AppMap.detect_metadata
   metadata[:recorder] = {
-    name: 'record_process'
+    name: 'record_process',
+    type: 'process'
   }
 
   appmap = {

data/lib/appmap/recording_methods.rb

@@ -0,0 +1,3 @@
+module AppMap
+  RECORDING_METHODS = %i[rspec minitest cucumber remote requests].freeze
+end

data/lib/appmap/rspec.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
+require 'appmap'
 require 'appmap/util'
 require 'set'
 require 'fileutils'
 
 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`.
   module RSpec
     APPMAP_OUTPUT_DIR = 'tmp/appmap/rspec'
     LOG = false
@@ -192,7 +191,8 @@ module AppMap
             version: Gem.loaded_specs['rspec-core']&.version&.to_s
           }
           m[:recorder] = {
-            name: 'rspec'
+            name: 'rspec',
+            type: 'tests'
           }
           m[:test_status] = test_status
           if exception
@@ -215,7 +215,7 @@ module AppMap
       end
 
       def enabled?
-        ENV['APPMAP'] == 'true'
+        AppMap.recording_enabled?(:rspec)
       end
 
       def run
@@ -226,7 +226,6 @@ module AppMap
 end
 
 if AppMap::RSpec.enabled?
-  require 'appmap'
   require 'active_support/inflector/transliterate'
   require 'rspec/core'
   require 'rspec/core/example'

data/lib/appmap/service/test_command_provider.rb

@@ -16,7 +16,7 @@ module AppMap
               command: {
                 program: 'bundle',
                 args: %w[exec rspec] + integration_test_paths[:rspec].map { |path| "./#{path}" },
-                environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
+                environment: { }
               }
             }
           end
@@ -30,7 +30,7 @@ module AppMap
               command: {
                 program: 'bundle',
                 args: %w[exec cucumber],
-                environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
+                environment: { }
               }
             }
           end
@@ -48,7 +48,7 @@ module AppMap
                 command: {
                   program: 'bundle',
                   args: %w[exec rails test] + integration_test_paths[:minitest].map { |path| "./#{path}" },
-                  environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
+                  environment: { }
                 }
               }
             ]
@@ -59,7 +59,7 @@ module AppMap
                 command: {
                   program: 'bundle',
                   args: ['exec', 'ruby', "./#{path}"],
-                  environment: { APPMAP: 'true', DISABLE_SPRING: 'true' }
+                  environment: { }
                 }
               }
             end

data/lib/appmap/version.rb

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

data/lib/appmap.rb

@@ -57,7 +57,7 @@ lambda do
     end
   end.enable
 
-  if defined?(::Rails)
+  if defined?(::Rails::Railtie)
     require 'appmap/railtie'
   end
 
@@ -76,4 +76,4 @@ lambda do
 
 end.call unless ENV['APPMAP_AUTOREQUIRE'] == 'false'
 
-AppMap.initialize_configuration if ENV['APPMAP'] == 'true' && ENV['APPMAP_INITIALIZE'] != 'false'
+AppMap.initialize_configuration if AppMap.recording_enabled? && ENV['APPMAP_INITIALIZE'] != 'false'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.90.1
+  version: 0.92.0
 platform: ruby
 authors:
 - Kevin Gilpin
@@ -378,6 +378,7 @@ files:
 - lib/appmap/depends/test_file_inspector.rb
 - lib/appmap/depends/test_runner.rb
 - lib/appmap/depends/util.rb
+- lib/appmap/detect_enabled.rb
 - lib/appmap/event.rb
 - lib/appmap/gem_hooks/actionpack.yml
 - lib/appmap/gem_hooks/actionview.yml
@@ -415,6 +416,7 @@ files:
 - lib/appmap/open.rb
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
+- lib/appmap/recording_methods.rb
 - lib/appmap/rspec.rb
 - lib/appmap/service/config_analyzer.rb
 - lib/appmap/service/guesser.rb