appsignal 3.0.21.alpha.1 → 3.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d00b4618b222cc7be43c7bcd79445b41b356714b682bf0aa3737c131ef9893b
-  data.tar.gz: 38099b1d602f9aed9b67d38e24cee1fa7b63cf069ad806e218b8d360f4655806
+  metadata.gz: 630d178d11148cc586ca48fef5dcd8a2ddeb72d7148a6d108c822891ef618b5e
+  data.tar.gz: 4bf2cdd9526d816434467686959ca3f2af27413ab3389253dfb7c7a5a0f0218c
 SHA512:
-  metadata.gz: 1514603d5cd1ae152f5b9e1bbe9297c20172e6d30f223c57a2ba7f0e9ab50e6937a207ceb32d12441a735286f0fa25cd47cc51fbc8f2fb66339d64bc2da13dbf
-  data.tar.gz: 85e43d5094ac8247abe40cade7fe61665a8fc1f0d655db63277db1a9875fa61ab675f35ef48f04f17a77882d80003b1c0d0dac4aff10f2ef6a25957b5f70796f
+  metadata.gz: 441cb813eab5b687fa86626c928d1dcfc7e92b6750a6607c56da6af92231e4c4e9f627e0353590226e651e1326c7e80f5583411ab02c9ca8de95df4c8abceb6c
+  data.tar.gz: fcd17e8dd7d8cfbd68ea2f51e2809553629cac960d3b75ce78ac42c8d5c2773faf665f7eb70886f0ffec39c9b6058cf1693dbc3d2e9112c4a98394c1e12ca15c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.21
+
+### Changed
+
+- [548dd6f4](https://github.com/appsignal/appsignal-ruby/commit/548dd6f4c61ae3be24995a200dc3e5bea1a5f58c) patch - Add config override source. Track final decisions made by the Ruby gem in the configuration in the `override` config source. This will help us track new config options which are being set by their deprecated predecessors in the diagnose report.
+
+### Removed
+
+- [3f503ade](https://github.com/appsignal/appsignal-ruby/commit/3f503ade83f22f4b0d86d76ea00e5f4dd3c56b6f) patch - Remove internal `Appsignal.extensions` system. It was unused.
+
 ## 3.0.21.alpha.1
 
 ### Changed

data/lib/appsignal/cli/diagnose.rb

@@ -471,7 +471,8 @@ module Appsignal
               :system => config.system_config,
               :initial => config.initial_config,
               :file => config.file_config,
-              :env => config.env_config
+              :env => config.env_config,
+              :override => config.override_config
             }
           }
           print_config_options(config)

data/lib/appsignal/config.rb

@@ -170,7 +170,7 @@ module Appsignal
     #   @return [Hash]
 
     attr_reader :root_path, :env, :config_hash, :system_config,
-      :initial_config, :file_config, :env_config
+      :initial_config, :file_config, :env_config, :override_config
     attr_accessor :logger
 
     # Initialize a new configuration object for AppSignal.
@@ -231,6 +231,9 @@ module Appsignal
       # Load config from environment variables
       @env_config = load_from_environment
       merge(env_config)
+      # Load config overrides
+      @override_config = determine_overrides
+      merge(override_config)
       # Handle deprecated config options
       maintain_backwards_compatibility
       # Validate that we have a correct config
@@ -396,37 +399,23 @@ module Appsignal
 
     # Maintain backwards compatibility with deprecated config options.
     #
-    # Add deprecated config options here with the behavior of setting its
-    # replacement, if the replacement option is not configured by the user.
+    # Add warnings for deprecated config options here if they have no
+    # replacement, or should be non-functional.
+    #
+    # Add them to {determine_overrides} if replacement config options should be
+    # set instead.
     #
     # Make sure to remove the contents of this method in the next major
     # version, but the method itself with an empty body can stick around as a
     # structure for future deprecations.
     def maintain_backwards_compatibility
-      skip_session_data = config_hash[:skip_session_data]
-      send_session_data = config_hash[:send_session_data]
-      if skip_session_data.nil? # Deprecated option is not set
-        if send_session_data.nil? # Not configured by user
-          @system_config[:send_session_data] = true
-          merge(:send_session_data => true) # Set default value
-        end
-      else
-        if send_session_data.nil? # Not configured by user
-          @system_config[:send_session_data] = !skip_session_data
-          merge(:send_session_data => !skip_session_data)
-        end
-        deprecation_message "The `skip_session_data` config option is " \
-          "deprecated. Please use `send_session_data` instead.",
-          logger
-      end
+      return unless config_hash.key?(:working_dir_path)
 
-      if config_hash.key?(:working_dir_path) # rubocop:disable Style/GuardClause
-        deprecation_message \
-          "The `working_dir_path` option is deprecated, please use " \
-          "`working_directory_path` instead and specify the " \
-          "full path to the working directory",
-          logger
-      end
+      deprecation_message \
+        "The `working_dir_path` option is deprecated, please use " \
+        "`working_directory_path` instead and specify the " \
+        "full path to the working directory",
+        logger
     end
 
     def load_from_environment
@@ -456,6 +445,31 @@ module Appsignal
       config
     end
 
+    # Set config options based on the final user config. Fix any conflicting
+    # config or set new config options based on deprecated config options.
+    #
+    # Make sure to remove behavior for deprecated config options in this method
+    # in the next major version, but the method itself with an empty body can
+    # stick around as a structure for future deprecations.
+    def determine_overrides
+      config = {}
+      skip_session_data = config_hash[:skip_session_data]
+      send_session_data = config_hash[:send_session_data]
+      if skip_session_data.nil? # Deprecated option is not set
+        if send_session_data.nil? # Not configured by user
+          config[:send_session_data] = true # Set default value
+        end
+      else
+        deprecation_message "The `skip_session_data` config option is " \
+          "deprecated. Please use `send_session_data` instead.",
+          logger
+        # Not configured by user
+        config[:send_session_data] = !skip_session_data if send_session_data.nil?
+      end
+
+      config
+    end
+
     def merge(new_config)
       new_config.each do |key, value|
         unless config_hash[key].nil?

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.21.alpha.1".freeze
+  VERSION = "3.0.21".freeze
 end

data/lib/appsignal.rb

@@ -58,20 +58,6 @@ module Appsignal
     #   @see start_logger
     attr_writer :logger
 
-    # @api private
-    def extensions
-      @extensions ||= []
-    end
-
-    # @api private
-    def initialize_extensions
-      Appsignal.logger.debug("Initializing extensions")
-      extensions.each do |extension|
-        Appsignal.logger.debug("Initializing #{extension}")
-        extension.initializer
-      end
-    end
-
     # @api private
     def testing?
       false
@@ -123,7 +109,6 @@ module Appsignal
           config.write_to_environment
           Appsignal::Extension.start
           Appsignal::Hooks.load_hooks
-          initialize_extensions
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?
             Appsignal::Extension.install_allocation_event_hook

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -772,10 +772,11 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
             "options" => default_config.merge("env" => "", "send_session_data" => true),
             "sources" => {
               "default" => default_config,
-              "system" => { "send_session_data" => true },
+              "system" => {},
               "initial" => { "env" => "" },
               "file" => {},
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end
@@ -890,10 +891,11 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
             "options" => hash_with_string_keys(final_config),
             "sources" => {
               "default" => hash_with_string_keys(Appsignal::Config::DEFAULT_CONFIG),
-              "system" => { "send_session_data" => true },
+              "system" => {},
               "initial" => hash_with_string_keys(config.initial_config.merge(additional_initial_config)),
               "file" => hash_with_string_keys(config.file_config),
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end
@@ -917,10 +919,11 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
             "options" => hash_with_string_keys(config.config_hash).merge("env" => "foobar"),
             "sources" => {
               "default" => hash_with_string_keys(Appsignal::Config::DEFAULT_CONFIG),
-              "system" => { "send_session_data" => true },
+              "system" => {},
               "initial" => hash_with_string_keys(config.initial_config),
               "file" => hash_with_string_keys(config.file_config),
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end

data/spec/lib/appsignal/config_spec.rb

@@ -434,6 +434,87 @@ describe Appsignal::Config do
     end
   end
 
+  describe "with config based on overrides" do
+    let(:log_stream) { StringIO.new }
+    let(:logger) { test_logger(log_stream) }
+    let(:logs) { log_contents(log_stream) }
+    let(:config) do
+      described_class.new(Dir.pwd, "production", config_options, logger)
+    end
+
+    describe "skip_session_data" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:deprecation_message) do
+        "The `skip_session_data` config option is deprecated. Please use " \
+          "`send_session_data` instead."
+      end
+      before do
+        capture_std_streams(std_stream, err_stream) { config }
+      end
+
+      context "when not set" do
+        let(:config_options) { {} }
+
+        it "sets the default send_session_data value" do
+          expect(config[:skip_session_data]).to be_nil
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to eq(true)
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to_not include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to_not include(deprecation_message)
+        end
+      end
+
+      context "when set to true" do
+        let(:config_options) { { :skip_session_data => true } }
+
+        it "sets send_session_data if send_session_data is not set by the user" do
+          expect(config[:skip_session_data]).to eq(true)
+          expect(config[:send_session_data]).to eq(false)
+          expect(config.override_config[:send_session_data]).to eq(false)
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+
+      context "when set to false" do
+        let(:config_options) { { :skip_session_data => false } }
+
+        it "sets send_session_data if send_session_data is not set by the user" do
+          expect(config[:skip_session_data]).to eq(false)
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to eq(true)
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+
+      context "when skip_session_data and send_session_data are both set" do
+        let(:config_options) { { :skip_session_data => true, :send_session_data => true } }
+
+        it "does not overwrite the send_session_data value" do
+          expect(config[:skip_session_data]).to eq(true)
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to be_nil
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+    end
+  end
+
   describe "config keys" do
     describe ":endpoint" do
       subject { config[:endpoint] }
@@ -789,78 +870,6 @@ describe Appsignal::Config do
         end
       end
     end
-
-    describe "skip_session_data" do
-      let(:err_stream) { std_stream }
-      let(:stderr) { err_stream.read }
-      let(:deprecation_message) do
-        "The `skip_session_data` config option is deprecated. Please use " \
-          "`send_session_data` instead."
-      end
-      before do
-        capture_std_streams(std_stream, err_stream) { config }
-      end
-
-      context "when not set" do
-        let(:config_options) { {} }
-
-        it "sets the default send_session_data value" do
-          expect(config[:skip_session_data]).to be_nil
-          expect(config[:send_session_data]).to eq(true)
-          expect(config.system_config[:send_session_data]).to eq(true)
-        end
-
-        it "does not print a deprecation warning" do
-          expect(stderr).to_not include("appsignal WARNING: #{deprecation_message}")
-          expect(logs).to_not include(deprecation_message)
-        end
-      end
-
-      context "when set to true" do
-        let(:config_options) { { :skip_session_data => true } }
-
-        it "sets send_session_data if send_session_data is not set by the user" do
-          expect(config[:skip_session_data]).to eq(true)
-          expect(config[:send_session_data]).to eq(false)
-          expect(config.system_config[:send_session_data]).to eq(false)
-        end
-
-        it "prints a deprecation warning" do
-          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
-          expect(logs).to include(deprecation_message)
-        end
-      end
-
-      context "when set to false" do
-        let(:config_options) { { :skip_session_data => false } }
-
-        it "sets send_session_data if send_session_data is not set by the user" do
-          expect(config[:skip_session_data]).to eq(false)
-          expect(config[:send_session_data]).to eq(true)
-          expect(config.system_config[:send_session_data]).to eq(true)
-        end
-
-        it "prints a deprecation warning" do
-          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
-          expect(logs).to include(deprecation_message)
-        end
-      end
-
-      context "when skip_session_data and send_session_data are both set" do
-        let(:config_options) { { :skip_session_data => true, :send_session_data => true } }
-
-        it "does not overwrite the send_session_data value" do
-          expect(config[:skip_session_data]).to eq(true)
-          expect(config[:send_session_data]).to eq(true)
-          expect(config.system_config[:send_session_data]).to be_nil
-        end
-
-        it "prints a deprecation warning" do
-          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
-          expect(logs).to include(deprecation_message)
-        end
-      end
-    end
   end
 
   describe "#validate" do

data/spec/lib/appsignal_spec.rb

@@ -5,7 +5,6 @@ describe Appsignal do
     # Make sure we have a clean state because we want to test
     # initialization here.
     Appsignal.config = nil
-    Appsignal.extensions.clear
   end
 
   let(:transaction) { http_request_transaction }
@@ -20,14 +19,6 @@ describe Appsignal do
     end
   end
 
-  describe ".extensions" do
-    it "should keep a list of extensions" do
-      expect(Appsignal.extensions).to be_empty
-      Appsignal.extensions << Appsignal::MockExtension
-      expect(Appsignal.extensions.size).to eq(1)
-    end
-  end
-
   describe ".start" do
     context "with no config set beforehand" do
       it "should do nothing when config is not set and there is no valid config in the env" do
@@ -63,15 +54,6 @@ describe Appsignal do
         Appsignal.start
       end
 
-      context "with an extension" do
-        before { Appsignal.extensions << Appsignal::MockExtension }
-
-        it "should call the extension's initializer" do
-          expect(Appsignal::MockExtension).to receive(:initializer)
-          Appsignal.start
-        end
-      end
-
       context "when allocation tracking and gc instrumentation have been enabled" do
         before do
           allow(GC::Profiler).to receive(:enable)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.21.alpha.1
+  version: 3.0.21
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -391,7 +391,6 @@ files:
 - spec/support/matchers/contains_log.rb
 - spec/support/matchers/have_colorized_text.rb
 - spec/support/mocks/fake_gc_profiler.rb
-- spec/support/mocks/mock_extension.rb
 - spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
@@ -423,9 +422,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key:
@@ -545,7 +544,6 @@ test_files:
 - spec/support/matchers/contains_log.rb
 - spec/support/matchers/have_colorized_text.rb
 - spec/support/mocks/fake_gc_profiler.rb
-- spec/support/mocks/mock_extension.rb
 - spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb

data/spec/support/mocks/mock_extension.rb

@@ -1,6 +0,0 @@
-module Appsignal
-  module MockExtension
-    def self.initializer
-    end
-  end
-end