appmap 0.91.0 → 0.92.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d721301c87647a2778b1019519a7ada3fc225761b32149070ee38d8e47c5643
-  data.tar.gz: b4a130739d8974a3adbe44a9020618e9f88530174de19e8aaa0713dad23336c4
+  metadata.gz: f527f92e73d7e71cf5a4e9db3b71c570b39443ad0788bc2c6f4b4bae4bb215ba
+  data.tar.gz: 6604ce77790645d5c5a60d37a2bc1116952909fe29856ea9fb36bac29d992d81
 SHA512:
-  metadata.gz: 9f0778dc18e12f668bc072b94f21f61f1310c6d0163531e7e8407fd5e45d64d9a2e1b2a9d4c0cf98c1ba3f31697ca38ee50461f55b293893442a7b19f515ac3a
-  data.tar.gz: 9469680e79ccf0e8a43967c1c6d0104c48d35399fd39b205bfc9d3c41f32f2469d527989f38e965f80e00f320cfce9026c124ed775f27ba773bf58d449083d6c
+  metadata.gz: 841907ab84538b09c9f83509d3c65dcd6d3b0be92e452a3558194fd33a8c90336f4f8294be91ac94a8631546acc89bef91807a451a546c3c1d9408110268e237
+  data.tar.gz: 715e6d1e540a89c660f0d3a9794b0c199356b1557fc5921226a422b78eff9c62f6b696cd1d231f0c25d06b82c417f5fef4b9e613b564146a50779b6e4d4d6910

data/.github/workflows/main.yml

@@ -12,5 +12,5 @@ jobs:
     steps:
       - uses: actions/add-to-project@main
         with:
-          project-url: https://github.com/orgs/applandinc/projects/15
+          project-url: https://github.com/orgs/getappmap/projects/15
           github-token: ${{ secrets.ADD_TO_PROJECT_BOARD_PAT }}

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.92.1](https://github.com/getappmap/appmap-ruby/compare/v0.92.0...v0.92.1) (2022-09-21)
+
+
+### Bug Fixes
+
+* Drop database server version ([e52f210](https://github.com/getappmap/appmap-ruby/commit/e52f210baa26be49232003c224e4ffee19be823d))
+
+# [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)
 
 

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

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/handler/rails/sql_handler.rb

@@ -75,7 +75,6 @@ module AppMap
                 end
               end
 
-              payload[:server_version] = examiner.server_version
               payload[:database_type] = examiner.database_type.to_s
             end
 
@@ -92,6 +91,8 @@ module AppMap
 
           class SequelExaminer
             def server_version
+              # Queries the database, therefore this is pretty unsafe to do inside of a hook.
+              # As a result, this is not being used at the moment.
               Sequel::Model.db.server_version
             end
 

data/lib/appmap/middleware/remote_recording.rb

@@ -82,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
@@ -150,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'
@@ -125,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/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
@@ -216,7 +215,7 @@ module AppMap
       end
 
       def enabled?
-        ENV['APPMAP'] == 'true'
+        AppMap.recording_enabled?(:rspec)
       end
 
       def run
@@ -227,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,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.91.0'
+  VERSION = '0.92.1'
 
   APPMAP_FORMAT_VERSION = '1.9.0'
 

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.91.0
+  version: 0.92.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -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
@@ -453,7 +455,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.