feat: Make activesupport a runtime dependency

Author: kgilpin

appmap.gemspec

@@ -27,11 +27,12 @@ Gem::Specification.new do |spec|
   spec.extensions << "ext/appmap/extconf.rb"
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport'
   spec.add_dependency 'method_source'
   spec.add_dependency 'rack'
   spec.add_dependency 'reverse_markdown'
 
+  spec.add_runtime_dependency 'activesupport'
+
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'minitest', '~> 5.15'
   spec.add_development_dependency 'pry-byebug'

lib/appmap.rb

@@ -20,13 +20,6 @@
 # - appmap/swagger (Rake task)
 # - appmap/depends (Rake task)
 
-begin
-  require 'active_support'
-  require 'active_support/core_ext'
-rescue NameError
-  warn 'active_support is not available. AppMap execution will continue optimistically without it...'
-end
-
 require 'appmap/version'
 require 'appmap/agent'
 

lib/appmap/gem_hooks/activesupport.yml renamed to lib/appmap/builtin_hooks/activesupport.yml

@@ -72,7 +72,7 @@ def build_from_builtin(path, shallow: false, require_name: nil, exclude: [], lab
         # Builds a package for gem. Generally corresponds to a `gem:` entry in appmap.yml. Also used when mapping
         # a builtin.
         def build_from_gem(gem, shallow: true, require_name: nil, exclude: [], labels: [], optional: false, force: false)
-          if !force && %w[method_source activesupport].member?(gem)
+          if !force && %w[method_source].member?(gem)
             warn "WARNING: #{gem} cannot be AppMapped because it is a dependency of the appmap gem"
             return
           end

lib/appmap/config.rb

@@ -193,6 +193,7 @@ def underscore(camel_cased_word)
       end
 
       def deep_dup(hash)
+        require 'active_support/core_ext'
         hash.deep_dup
       end
 

lib/appmap/util.rb

@@ -52,8 +52,7 @@
       "description" => "Generate Swagger from AppMaps"
     })
     expect(config.as_json['hook_paths']).to eq([
-      "pkg",
-      "#{Gem.loaded_specs['activesupport'].gem_dir}"
+      "pkg"
     ])
     expect(config.as_json['exclude']).to eq([])
     expect(config.as_json['functions'].map(&:deep_stringify_keys)).to eq([
@@ -99,8 +98,8 @@
         ]
       }
     ])
-    expect(config.as_json['gem_hooks']).to have_key('ActiveSupport::Callbacks::CallbackSequence')
-    expect(config.as_json['gem_hooks']['ActiveSupport::Callbacks::CallbackSequence'].map(&:deep_stringify_keys)).to eq([
+    expect(config.as_json['builtin_hooks']).to have_key('ActiveSupport::Callbacks::CallbackSequence')
+    expect(config.as_json['builtin_hooks']['ActiveSupport::Callbacks::CallbackSequence'].map(&:deep_stringify_keys)).to eq([
       {
         "package" => "activesupport",
         "method_names" => [

spec/config_spec.rb

@@ -890,100 +890,6 @@ def test_hook_behavior(file, events_yaml, setup: nil, &block)
 
   context 'ActiveSupport::SecurityUtils.secure_compare' do
     it 'is hooked' do
-      events_yaml = <<~YAML
-      ---
-      - :id: 1
-        :event: :call
-        :defined_class: Compare
-        :method_id: compare
-        :path: spec/fixtures/hook/compare.rb
-        :lineno: 4
-        :static: true
-        :parameters:
-        - :name: :s1
-          :class: String
-          :value: string
-          :kind: :req
-        - :name: :s2
-          :class: String
-          :value: string
-          :kind: :req
-        :receiver:
-          :class: Class
-          :value: Compare
-      - :id: 2
-        :event: :call
-        :defined_class: ActiveSupport::SecurityUtils
-        :method_id: secure_compare
-        :path: lib/active_support/security_utils.rb
-        :lineno: 26
-        :static: true
-        :parameters:
-        - :name: :a
-          :class: String
-          :value: string
-          :kind: :req
-        - :name: :b
-          :class: String
-          :value: string
-          :kind: :req
-        :receiver:
-          :class: Module
-          :value: ActiveSupport::SecurityUtils
-      - :id: 3
-        :event: :call
-        :defined_class: Digest::Instance
-        :method_id: digest
-        :path: Digest::Instance#digest
-        :static: false
-        :parameters:
-        - :name: arg
-          :class: Array
-          :value: '["string"]'
-          :kind: :rest
-        :receiver:
-          :class: Digest::SHA256
-          :value: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
-      - :id: 4
-        :event: :return
-        :parent_id: 3
-        :return_value:
-          :class: String
-          :value: "G2__)__qc____X____3_].\\x02y__.___/_"
-      - :id: 5
-        :event: :call
-        :defined_class: Digest::Instance
-        :method_id: digest
-        :path: Digest::Instance#digest
-        :static: false
-        :parameters:
-        - :name: arg
-          :class: Array
-          :value: '["string"]'
-          :kind: :rest
-        :receiver:
-          :class: Digest::SHA256
-          :value: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
-      - :id: 6
-        :event: :return
-        :parent_id: 5
-        :return_value:
-          :class: String
-          :value: "G2__)__qc____X____3_].\\x02y__.___/_"
-      - :id: 7
-        :event: :return
-        :parent_id: 2
-        :return_value:
-          :class: TrueClass
-          :value: 'true'
-      - :id: 8
-        :event: :return
-        :parent_id: 1
-        :return_value:
-          :class: TrueClass
-          :value: 'true'
-      YAML
-
       _, _, events = test_hook_behavior 'spec/fixtures/hook/compare.rb', nil do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
@@ -1078,6 +984,7 @@ def secure_compare(a, b)
       _, tracer = invoke_test_file 'spec/fixtures/hook/compare.rb' do
         expect(Compare.compare('string', 'string')).to be_truthy
       end
+
       cm = AppMap::Util.sanitize_paths(AppMap::ClassMap.build_from_methods(tracer.event_methods))
       entry = cm[1][:children][0][:children][0][:children][0]
       # Sanity check, make sure we got the right one