appsignal 3.0.19 → 3.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff92b4ae6715fa80b1910e0023b49e0032a28fa1ea13b7b64587568ceae07edf
-  data.tar.gz: 6faac0d1b0fa8abefc0908628a98918d3cbec6eae45ae4a7d275c4537eb03b59
+  metadata.gz: 18e505270b1fc0966691e2d270ae08fbe7157ee4fde1708dd3252e7da69c7c9e
+  data.tar.gz: 37340595960a772bd6e094a6fc04d4f8940ac0ef96ecb3e848d7ce58f3f5019e
 SHA512:
-  metadata.gz: 1cd66bc7159a7ce2817d5190073d4af45e5f7dcb7c5f7c5c9ebdf6b986af9f3e3b46f7149a3fabf81ce03a03c62734c87984f92b5f0a468240b9d3a7b513168f
-  data.tar.gz: cf0735657d7c4ebcaff3c28863d7ee8e5b244f8945dbe16d0d764130826d99bce49aca1c13a5adbd62a196acbf23827fcbfe8a3558843298e56585896a3a0812
+  metadata.gz: e4caeabfd901dfaae05d3aece53d2f346a80cb7e7134a98e59cc9c52788d0536ec3866dbb0371e5da8f3514a2b1e6301686670604c7b43c2a30c0ea24dd78ae2
+  data.tar.gz: a3c490e7d04be8896d9513041d3d37e58dd5179664c8725d6939b432f6b516f70d27b3e27f2afde407cf145775a174619745976ab31c50747acbbbc7af29eb55

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.20
+
+### Added
+
+- [35bd83b8](https://github.com/appsignal/appsignal-ruby/commit/35bd83b84fd30f0188d9f134cfd249360b6e281d) patch - Add `send_session_data` option to configure if session data is automatically included transactions. By default this is turned on. It can be disabled by configuring `send_session_data` to `false`.
+
+### Deprecated
+
+- [35bd83b8](https://github.com/appsignal/appsignal-ruby/commit/35bd83b84fd30f0188d9f134cfd249360b6e281d) patch - Deprecate `skip_session_data` option in favor of the newly introduced `send_session_data` option. If it is configured it will print a warning on AppSignal load, but will also retain its functionality until the config option is fully removed in the next major release.
+- [e51a8fb6](https://github.com/appsignal/appsignal-ruby/commit/e51a8fb653fccc5a6b72ac7af9c9417e6827e2e9) patch - Warn about the deprecated `working_dir_path` option from all config sources. It previously only printed a warning when it was configured in the `config/appsignal.yml` file, but now also prints the warning if it's set via the Config class initialize options and environment variables. Please use the `working_directory_path` option instead.
+
+### Fixed
+
+- [c9000eee](https://github.com/appsignal/appsignal-ruby/commit/c9000eeefec722cb940b2e14f37d31a7827986d6) patch - Fix reported Ruby version in diagnose report. It would report only the first major release of the series, e.g. 2.6.0 for 2.6.1.
+
 ## 3.0.19
 
 ### Changed

data/ext/base.rb

@@ -31,7 +31,7 @@ def report
         },
         "language" => {
           "name" => "ruby",
-          "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"
+          "version" => "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"
         },
         "download" => {
           "checksum" => "unverified",

data/lib/appsignal/cli/diagnose.rb

@@ -443,7 +443,7 @@ module Appsignal
             save :os, os
             puts_value "Operating System", os_label
 
-            language_version = "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"
+            language_version = "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"
             save :language_version, language_version
             puts_format "Ruby version", language_version
 

data/lib/appsignal/config.rb

@@ -39,7 +39,6 @@ module Appsignal
       ],
       :send_environment_metadata      => true,
       :send_params                    => true,
-      :skip_session_data              => false,
       :transaction_debug_mode         => false
     }.freeze
 
@@ -88,6 +87,7 @@ module Appsignal
       "APPSIGNAL_RUNNING_IN_CONTAINER"           => :running_in_container,
       "APPSIGNAL_SEND_ENVIRONMENT_METADATA"      => :send_environment_metadata,
       "APPSIGNAL_SEND_PARAMS"                    => :send_params,
+      "APPSIGNAL_SEND_SESSION_DATA"              => :send_session_data,
       "APPSIGNAL_SKIP_SESSION_DATA"              => :skip_session_data,
       "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APPSIGNAL_WORKING_DIRECTORY_PATH"         => :working_directory_path,
@@ -125,6 +125,7 @@ module Appsignal
       APPSIGNAL_RUNNING_IN_CONTAINER
       APPSIGNAL_SEND_ENVIRONMENT_METADATA
       APPSIGNAL_SEND_PARAMS
+      APPSIGNAL_SEND_SESSION_DATA
       APPSIGNAL_SKIP_SESSION_DATA
       APPSIGNAL_TRANSACTION_DEBUG_MODE
     ].freeze
@@ -230,6 +231,8 @@ module Appsignal
       # Load config from environment variables
       @env_config = load_from_environment
       merge(env_config)
+      # Handle deprecated config options
+      maintain_backwards_compatibility
       # Validate that we have a correct config
       validate
       # Track origin of env
@@ -374,12 +377,9 @@ module Appsignal
       configurations = YAML.load(ERB.new(IO.read(config_file)).result, **read_options)
       config_for_this_env = configurations[env]
       if config_for_this_env
-        config_for_this_env =
-          config_for_this_env.each_with_object({}) do |(key, value), hash|
-            hash[key.to_sym] = value # convert keys to symbols
-          end
-
-        maintain_backwards_compatibility(config_for_this_env)
+        config_for_this_env.each_with_object({}) do |(key, value), hash|
+          hash[key.to_sym] = value # convert keys to symbols
+        end
       else
         logger.error "Not loading from config file: config for '#{env}' not found"
         nil
@@ -394,19 +394,38 @@ module Appsignal
       nil
     end
 
-    # Maintain backwards compatibility with config files generated by earlier
-    # versions of the gem
+    # Maintain backwards compatibility with deprecated config options.
     #
-    # Used by {#load_from_disk}. No compatibility for env variables or initial config currently.
-    def maintain_backwards_compatibility(configuration)
-      configuration.tap do |config|
-        if config.include?(:working_dir_path)
-          deprecation_message \
-            "'working_dir_path' is deprecated, please use " \
-            "'working_directory_path' instead and specify the " \
-            "full path to the working directory",
-            logger
+    # Add deprecated config options here with the behavior of setting its
+    # replacement, if the replacement option is not configured by the user.
+    #
+    # 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
+
+      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
     end
 

data/lib/appsignal/transaction.rb

@@ -476,12 +476,12 @@ module Appsignal
     #
     # The session data is sanitized by the {Appsignal::Utils::HashSanitizer}.
     #
-    # @return [nil] if `:skip_session_data` config is set to `true`.
+    # @return [nil] if `:send_session_data` config is set to `false`.
     # @return [nil] if the {#request} object doesn't respond to `#session`.
     # @return [nil] if the {#request} session data is `nil`.
     # @return [Hash<String, Object>]
     def sanitized_session_data
-      return if Appsignal.config[:skip_session_data] ||
+      return if !Appsignal.config[:send_session_data] ||
           !request.respond_to?(:session)
       session = request.session
       return unless session

data/lib/appsignal/version.rb

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

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

@@ -258,7 +258,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           },
           "language" => {
             "name" => "ruby",
-            "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}",
+            "version" => "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}",
             "implementation" => jruby ? "jruby" : "ruby"
           },
           "download" => {
@@ -295,7 +295,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           "  Status: success",
           "Language details",
           "  Implementation: \"#{jruby ? "jruby" : "ruby"}\"",
-          "  Ruby version: \"#{"#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"}\"",
+          "  Ruby version: \"#{"#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"}\"",
           "Download details",
           "  Download URL: \"https://",
           "  Checksum: \"verified\"",
@@ -604,7 +604,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
 
     describe "host information" do
       let(:rbconfig) { RbConfig::CONFIG }
-      let(:language_version) { "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}" }
+      let(:language_version) { "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}" }
 
       it "outputs host information" do
         run
@@ -769,10 +769,10 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         it "transmits validation in report" do
           default_config = hash_with_string_keys(Appsignal::Config::DEFAULT_CONFIG)
           expect(received_report["config"]).to eq(
-            "options" => default_config.merge("env" => ""),
+            "options" => default_config.merge("env" => "", "send_session_data" => true),
             "sources" => {
               "default" => default_config,
-              "system" => {},
+              "system" => { "send_session_data" => true },
               "initial" => { "env" => "" },
               "file" => {},
               "env" => {}
@@ -890,7 +890,7 @@ 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" => {},
+              "system" => { "send_session_data" => true },
               "initial" => hash_with_string_keys(config.initial_config.merge(additional_initial_config)),
               "file" => hash_with_string_keys(config.file_config),
               "env" => {}
@@ -917,7 +917,7 @@ 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" => {},
+              "system" => { "send_session_data" => true },
               "initial" => hash_with_string_keys(config.initial_config),
               "file" => hash_with_string_keys(config.file_config),
               "env" => {}

data/spec/lib/appsignal/config_spec.rb

@@ -69,8 +69,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => "abc")
-            expect(config.system_config).to eq(:active => true)
+            expect(config.env_config).to include(:push_api_key => "abc")
+            expect(config.system_config).to include(:active => true)
           end
         end
 
@@ -82,8 +82,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => "")
-            expect(config.system_config).to be_empty
+            expect(config.env_config).to include(:push_api_key => "")
+            expect(config.system_config).to_not have_key(:active)
           end
         end
 
@@ -95,8 +95,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => " ")
-            expect(config.system_config).to be_empty
+            expect(config.env_config).to include(:push_api_key => " ")
+            expect(config.system_config).to_not have_key(:active)
           end
         end
       end
@@ -119,7 +119,7 @@ describe Appsignal::Config do
         end
 
         it "sets the log as loaded through the system" do
-          expect(config.system_config).to eq(:log => "stdout")
+          expect(config.system_config).to include(:log => "stdout")
         end
       end
 
@@ -129,7 +129,7 @@ describe Appsignal::Config do
         end
 
         it "does not set log as loaded through the system" do
-          expect(config.system_config).to eq({})
+          expect(config.system_config).to_not have_key(:log)
         end
       end
     end
@@ -177,7 +177,7 @@ describe Appsignal::Config do
         :revision                       => "v2.5.1",
         :send_environment_metadata      => true,
         :send_params                    => true,
-        :skip_session_data              => false,
+        :send_session_data              => true,
         :transaction_debug_mode         => false
       )
     end
@@ -743,6 +743,126 @@ describe Appsignal::Config do
     end
   end
 
+  describe "#maintain_backwards_compatibility" 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 "working_dir_path" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:deprecation_message) do
+        "The `working_dir_path` option is deprecated, please use " \
+          "`working_directory_path` instead and specify the " \
+          "full path to the working directory"
+      end
+      before do
+        capture_std_streams(std_stream, err_stream) { config }
+      end
+
+      context "when not set" do
+        let(:config_options) { {} }
+
+        it "sets the default working_dir_path value" do
+          expect(config[:working_dir_path]).to be_nil
+        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" do
+        let(:config_options) { { :working_dir_path => "/tmp/appsignal2" } }
+
+        it "sets the default working_dir_path value" do
+          expect(config[:working_dir_path]).to eq("/tmp/appsignal2")
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        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
     subject { config.valid? }
     let(:config) do

data/spec/lib/appsignal/transaction_spec.rb

@@ -1282,8 +1282,8 @@ describe Appsignal::Transaction do
           end
         end
 
-        context "when skipping session data" do
-          before { Appsignal.config[:skip_session_data] = true }
+        context "when not sending session data" do
+          before { Appsignal.config[:send_session_data] = false }
 
           it "does not set any session data on the transaction" do
             expect(subject).to be_nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.19
+  version: 3.0.20
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack