appmap 0.101.0 → 0.102.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d9d1069381257dbf69ca6becafb2bfbbc948039b89060aeb607f73b8992392
-  data.tar.gz: da3124df4bc13ca45b0ed5c67f57667cf5c9d2773afcd4f5f9bcee4b0bf8aa0a
+  metadata.gz: 1df97ff2f7c62ce830193389327e102a89798678350dbc653aecc98157e502cb
+  data.tar.gz: ff14a72537014f549a5094b592a6dd28e9a6658679e0c411529d7c4c12491822
 SHA512:
-  metadata.gz: 854833429a403e7ae83cfd8eabe76228d273787713aa4d44a829746264044e2a1ab8b4b7620dbc1ba36043c6c6b5128f223d38231ff281d6c48dd1b900cde800
-  data.tar.gz: f907c847bb4a20a57b6ad0172e289d45ddb08162d526470ae3ee05c3d2f0988b7a820c47335d65c1f399b15cc2a611aeb30e0660a2b0c24ef8f2f880ecc13df2
+  metadata.gz: 21781f0d7b9d61d72cd6b442b1105a1eabd19ba07ccca62bb8fd5acaede9e6db2a3cf5594a80c1270ff574d977b709c22031a12a88361cd36fe3013e5238cb03
+  data.tar.gz: bcc9fd8526da90172d0f7f159a1c4a61a0245e70d1d800f38b98e1d13f0a35ee26898c064107a0de5eb3f7d11d1eecf98c12df1f14a4c37cb72582a1a6bdcf1d

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.102.0](https://github.com/getappmap/appmap-ruby/compare/v0.101.0...v0.102.0) (2023-07-18)
+
+
+### Features
+
+* Discourage conflicting recording methods ([f86303b](https://github.com/getappmap/appmap-ruby/commit/f86303bf1b62d5131d9ed2c10e01225ec21c1405))
+
 # [0.101.0](https://github.com/getappmap/appmap-ruby/compare/v0.100.0...v0.101.0) (2023-07-17)
 
 

data/lib/appmap/cucumber.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'appmap'
-require 'appmap/util'
+require_relative '../appmap'
+require_relative './util'
+require_relative './detect_enabled'
 require 'fileutils'
 
 module AppMap
   module Cucumber
     APPMAP_OUTPUT_DIR = 'tmp/appmap/cucumber'
-    
+
     ScenarioAttributes = Struct.new(:name, :feature, :feature_group)
 
     ProviderStruct = Struct.new(:scenario) do
@@ -43,11 +44,13 @@ module AppMap
 
     class << self
       def init
+        AppMap::DetectEnabled.discourage_conflicting_recording_methods :cucumber
+
         warn 'Configuring AppMap recorder for Cucumber'
 
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
       end
-      
+
       def write_scenario(scenario, appmap)
         appmap['metadata'] = update_metadata(scenario, appmap['metadata'])
         scenario_filename = AppMap::Util.scenario_filename(appmap['metadata']['name'])
@@ -62,7 +65,7 @@ module AppMap
       def run
         init
       end
-      
+
       protected
 
       def cucumber_version

data/lib/appmap/detect_enabled.rb

@@ -9,6 +9,32 @@ module AppMap
     @@detected_for_method = {}
 
     class << self
+      def discourage_conflicting_recording_methods(recording_method)
+        return if ENV['APPMAP_DISCOURAGE_CONFLICTING_RECORDING_METHODS'] == 'false'
+
+        return unless enabled?(recording_method.to_sym) && enabled?(:requests)
+
+        warn Util.color <<~MSG, :yellow
+AppMap recording is enabled for both 'requests' and '#{recording_method}'. This is not recommended
+because the recordings will contain duplicitive information, and in some case may conflict with each other.
+        MSG
+
+        return unless ENV['APPMAP'] == 'true'
+
+        warn Util.color <<~MSG, :yellow
+The environment contains APPMAP=true, which is not recommended in this application environment because
+it enables all recording methods. Consider letting AppMap detect the appropriate recording method,
+or explicitly enabling only the recording methods you want to use using environment variables like
+APPMAP_RECORD_REQUESTS, APPMAP_RECORD_RSPEC, etc.
+
+See https://appmap.io/docs/reference/appmap-ruby.html#advanced-runtime-options for more information.
+        MSG
+      end
+
+      def enabled?(recording_method)
+        new(recording_method).enabled?
+      end
+
       def clear_cache
         @@detected_for_method = {}
       end
@@ -19,20 +45,20 @@ module AppMap
     end
 
     def enabled?
-      unless @@detected_for_method[@recording_method].nil?
-        return @@detected_for_method[@recording_method]
-      end
+      return @@detected_for_method[@recording_method] unless @@detected_for_method[@recording_method].nil?
 
-      raise "Unrecognized recording method: #{@recording_method}" if @recording_method && !AppMap::RECORDING_METHODS.member?(@recording_method)
+      if @recording_method && !AppMap::RECORDING_METHODS.member?(@recording_method)
+        raise "Unrecognized recording method: #{@recording_method}"
+      end
 
       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
+      if @recording_method && (enabled && enabled_by_app_env?)
+        warn AppMap::Util.color(
+          "AppMap #{@recording_method.nil? ? '' : "#{@recording_method} "}recording is enabled because #{message}", :magenta
+        )
       end
 
       enabled
@@ -49,48 +75,41 @@ module AppMap
       ]
 
       message, enabled = []
-      while enabled.nil? && !detection_functions.empty?
-        message, enabled = method(detection_functions.shift).call
-      end
+      message, enabled = method(detection_functions.shift).call while enabled.nil? && !detection_functions.empty?
 
-      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
+      return [ 'it is not enabled by any configuration or framework', false, false ] if enabled.nil?
+
+      _, enabled_by_env = enabled_by_app_env?
+      [ message, enabled, enabled_by_env ]
     end
 
     def enabled_by_testing?
-      if %i[rspec minitest cucumber].member?(@recording_method)
-        [ "running tests with #{@recording_method}", true ]
-      end
+      return unless %i[rspec minitest cucumber].member?(@recording_method)
+
+      [ "running tests with #{@recording_method}", true ]
     end
 
     def enabled_by_app_env?
       env_name, app_env = detect_app_env
-      if @recording_method.nil?
-        return [ "#{env_name} is '#{app_env}'", true ] if %w[test development].member?(app_env)
-      end
+      return [ "#{env_name} is '#{app_env}'", true ] if @recording_method.nil? && %w[test development].member?(app_env)
 
-      if %i[remote requests].member?(@recording_method)
-        return [ "#{env_name} is '#{app_env}'", true ] if app_env == 'development'
-      end
+      return unless %i[remote requests].member?(@recording_method)
+      return [ "#{env_name} is '#{app_env}'", true ] if app_env == 'development'
     end
 
     def detect_app_env
       if rails_env
-        return [ 'RAILS_ENV', rails_env ]
+        [ 'RAILS_ENV', rails_env ]
       elsif ENV['APP_ENV']
-        return [ 'APP_ENV', ENV['APP_ENV']]
+        [ '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.()
+      requests_recording_in_test = -> { [ :requests ].member?(@recording_method) && detect_app_env == 'test' }
+      [ 'APPMAP=true', true ] if ENV['APPMAP'] == 'true' && !requests_recording_in_test.call
     end
 
     def globally_disabled?
@@ -114,7 +133,7 @@ module AppMap
     def rails_env
       return Rails.env if defined?(::Rails::Railtie)
 
-      return ENV['RAILS_ENV']
+      ENV.fetch('RAILS_ENV', nil)
     end
   end
 end

data/lib/appmap/minitest.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'appmap'
-require 'appmap/util'
+require_relative '../appmap'
+require_relative './util'
+require_relative './detect_enabled'
 require 'fileutils'
 require 'active_support'
 require 'active_support/core_ext'
@@ -32,7 +33,9 @@ module AppMap
 
       def finish(failures, exception)
         failed = failures.any? || exception
-        warn "Finishing recording of #{failed ? 'failed ' : ''} test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
+        if AppMap::Minitest::LOG
+          warn "Finishing recording of #{failed ? 'failed ' : ''} test #{test.class}.#{test.name}"
+        end
         warn "Exception: #{exception}" if exception && AppMap::Minitest::LOG
 
         if failed
@@ -78,7 +81,8 @@ module AppMap
       end
 
       def begin_test(test, name)
-        AppMap.info 'Configuring AppMap recorder for Minitest' if first_recording?
+        AppMap::DetectEnabled.discourage_conflicting_recording_methods :minitest if first_recording?
+
         @recording_count += 1
 
         @recordings_by_test[test.object_id] = Recording.new(test, name)
@@ -107,24 +111,22 @@ module AppMap
           m[:frameworks] ||= []
           m[:frameworks] << {
             name: 'minitest',
-            version: Gem.loaded_specs['minitest']&.version&.to_s,
+            version: Gem.loaded_specs['minitest']&.version&.to_s
           }
           m[:recorder] = {
             name: 'minitest',
-            type: 'tests',
+            type: 'tests'
           }
           m[:test_status] = test_status
           m[:test_failure] = test_failure if test_failure
-          if exception
-            m[:exception] = Util.format_exception(exception)
-          end
+          m[:exception] = Util.format_exception(exception) if exception
         end
 
         appmap = {
           version: AppMap::APPMAP_FORMAT_VERSION,
           metadata: metadata,
           classMap: class_map,
-          events: events,
+          events: events
         }.compact
         fname = AppMap::Util.scenario_filename(name)
 

data/lib/appmap/rspec.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'appmap'
-require 'appmap/util'
+require_relative '../appmap'
+require_relative './util'
+require_relative './detect_enabled'
 require 'set'
 require 'fileutils'
 
@@ -161,6 +162,8 @@ module AppMap
       end
 
       def begin_spec(example)
+        AppMap::DetectEnabled.discourage_conflicting_recording_methods :rspec if first_recording?
+
         @recording_count += 1
         # Disable RSpec recording for RSwag, because all the action happens in the before block.
         # The example is empty except for assertions. So RSwag has its own recorder, and RSpec

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.101.0'
+  VERSION = '0.102.0'
 
   APPMAP_FORMAT_VERSION = '1.12.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.101.0
+  version: 0.102.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source