appsignal 4.5.1 → 4.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a3c994c51b2372d7eb37af9efd818a4b432980282716feda7bb30a62d1df68
-  data.tar.gz: 992757e738854650edd3b7ced396d00a84fa6016a22ed0b754e9be3d3a9a3ae6
+  metadata.gz: ad734051c53b1a0186c335e983a7c8c5062d151a108d480759fbdb0e35be8270
+  data.tar.gz: cd669a754156ec1a8a2854efaa1e927397eae75d58f9df5e6c277e856711df91
 SHA512:
-  metadata.gz: adc1a98235a0cd31c69d1b9c1a7498856bb381b4c97a6efb365204fb1a6565a21fcf55f474961028a70c9dd8e2751bdf6b3758574e0a0c823b2b555021536d3a
-  data.tar.gz: 531c4fa256cb99ccd5fe17af6f25ee637ee0b17c8790d3cb3d45c72cdec6fcc19a98c45b7d8098e4c12216b97020ccd6b8ce4854234715145c4f23e5a72951cf
+  metadata.gz: 3c24a9dc9fbd1c48e235fa22205a8780a8aa91099ce63502d9b2ae11ce05cdecca8d0848e80f584da84375091cbefe87ec75b057cf58e87ee4c39390241604c1
+  data.tar.gz: 6edd7715a85f5ae40c7ff6679ad432c16811ad45dd3541f83392c194391178174db0987a9ffd47797e1138f4df4176b03021f20e9091d6bc84df44c36acefc78

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.5.2
+
+_Published on 2025-02-24._
+
+### Fixed
+
+- Validate application environment sources so nil values and empty strings are not valid app environments.
+  Symbols are now always cast to a String before set as the application environment.
+
+  ```ruby
+  # These will no longer be accepted as valid app environments
+  Appsignal.configure("")
+  Appsignal.configure(" ")
+  ```
+
+  (patch [bfe37be9](https://github.com/appsignal/appsignal-ruby/commit/bfe37be9ca14248f5e5a030d0cab42998d371d36))
+- Fix Capistrano version 2 and 3 support when using an `appsignal.rb` config file. It will now pick up the config from `appsignal.rb` file. (patch [2a694196](https://github.com/appsignal/appsignal-ruby/commit/2a6941967435d6672c122e0aa07ec9c2de3e30bc))
+
 ## 4.5.1
 
 _Published on 2025-02-24._

data/lib/appsignal/config.rb

@@ -39,8 +39,10 @@ module Appsignal
         ENV.fetch("APPSIGNAL_APP_ENV", nil),
         ENV.fetch("RAILS_ENV", nil),
         ENV.fetch("RACK_ENV", nil)
-      ].compact.each do |env|
-        return env if env
+      ].compact.each do |env_value|
+        value = env_value.to_s.strip
+        next if value.empty?
+        return value if value
       end
 
       loader_defaults.reverse.each do |loader_defaults|
@@ -246,8 +248,8 @@ module Appsignal
     )
       @load_yaml_file = load_yaml_file
       @root_path = root_path.to_s
-      @config_file_error = false
-      @config_file = config_file
+      @yml_config_file_error = false
+      @yml_config_file = yml_config_file
       @valid = false
 
       @env = env.to_s
@@ -479,9 +481,9 @@ module Appsignal
 
     # @api private
     def yml_config_file?
-      return false unless config_file
+      return false unless yml_config_file
 
-      File.exist?(config_file)
+      File.exist?(yml_config_file)
     end
 
     private
@@ -490,8 +492,8 @@ module Appsignal
       Appsignal.internal_logger
     end
 
-    def config_file
-      @config_file ||=
+    def yml_config_file
+      @yml_config_file ||=
         root_path.nil? ? nil : File.join(root_path, "config", "appsignal.yml")
     end
 
@@ -510,7 +512,7 @@ module Appsignal
       return unless yml_config_file?
 
       read_options = YAML::VERSION >= "4.0.0" ? { :aliases => true } : {}
-      configurations = YAML.load(ERB.new(File.read(config_file)).result, **read_options)
+      configurations = YAML.load(ERB.new(File.read(yml_config_file)).result, **read_options)
       config_for_this_env = configurations[env]
       if config_for_this_env
         config_for_this_env.transform_keys(&:to_sym)
@@ -519,10 +521,10 @@ module Appsignal
         nil
       end
     rescue => e
-      @config_file_error = true
+      @yml_config_file_error = true
       message = "An error occurred while loading the AppSignal config file. " \
         "Not starting AppSignal.\n" \
-        "File: #{config_file.inspect}\n" \
+        "File: #{yml_config_file.inspect}\n" \
         "#{e.class.name}: #{e}"
       Kernel.warn "appsignal: #{message}"
       logger.error "#{message}\n#{e.backtrace.join("\n")}"
@@ -574,7 +576,7 @@ module Appsignal
       # If an error was detected during config file reading/parsing and the new
       # behavior is enabled to not start AppSignal on incomplete config, do not
       # start AppSignal.
-      config[:active] = false if @config_file_error
+      config[:active] = false if @yml_config_file_error
 
       if config_hash[:activejob_report_errors] == "discard" &&
           !Appsignal::Hooks::ActiveJobHook.version_7_1_or_higher?

data/lib/appsignal/integrations/capistrano/appsignal.cap

@@ -8,22 +8,18 @@ namespace :appsignal do
     user = fetch(:appsignal_user, ENV["USER"] || ENV.fetch("USERNAME", nil))
     revision = fetch(:appsignal_revision, fetch(:current_revision))
 
-    appsignal_config = Appsignal::Config.new(
-      Dir.pwd,
-      appsignal_env
-    ).tap do |c|
-      c.merge_dsl_options(fetch(:appsignal_config, {}))
-      c.validate
+    Appsignal._load_config!(appsignal_env) do |config|
+      config&.merge_dsl_options(fetch(:appsignal_config, {}))
     end
     Appsignal._start_logger
 
-    if appsignal_config&.active?
+    if Appsignal.config&.active?
       marker_data = {
         :revision => revision,
         :user => user
       }
 
-      marker = Appsignal::Marker.new(marker_data, appsignal_config)
+      marker = Appsignal::Marker.new(marker_data, Appsignal.config)
       # {#dry_run?} helper was added in Capistrano 3.5.0
       # https://github.com/capistrano/capistrano/commit/38d8d6d2c8485f1b5643857465b16ff01da57aff
       if respond_to?(:dry_run?) && dry_run?

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -5,40 +5,37 @@ module Appsignal
     # @api private
     class Capistrano
       def self.tasks(config)
-        config.load do # rubocop:disable Metrics/BlockLength
+        config.load do
           after "deploy", "appsignal:deploy"
           after "deploy:migrations", "appsignal:deploy"
 
           namespace :appsignal do
             task :deploy do
-              env = fetch(:appsignal_env,
+              appsignal_env = fetch(:appsignal_env,
                 fetch(:stage, fetch(:rails_env, fetch(:rack_env, "production"))))
               user = fetch(:appsignal_user, ENV["USER"] || ENV.fetch("USERNAME", nil))
               revision = fetch(:appsignal_revision, fetch(:current_revision))
 
-              appsignal_config = Appsignal::Config.new(
-                ENV.fetch("PWD", nil),
-                env
-              ).tap do |c|
-                c.merge_dsl_options(fetch(:appsignal_config, {}))
-                c.validate
+              Appsignal._load_config!(appsignal_env) do |conf|
+                conf&.merge_dsl_options(fetch(:appsignal_config, {}))
               end
               Appsignal._start_logger
 
-              if appsignal_config&.active?
+              if Appsignal.config&.active?
                 marker_data = {
                   :revision => revision,
                   :user => user
                 }
 
-                marker = Marker.new(marker_data, appsignal_config)
+                marker = Marker.new(marker_data, Appsignal.config)
                 if config.dry_run
                   puts "Dry run: AppSignal deploy marker not actually sent."
                 else
                   marker.transmit
                 end
               else
-                puts "Not notifying of deploy, config is not active for environment: #{env}"
+                puts "Not notifying of deploy, config is not active for " \
+                  "environment: #{appsignal_env}"
               end
             end
           end

data/lib/appsignal/marker.rb

@@ -49,7 +49,7 @@ module Appsignal
     # @return [void]
     def transmit
       transmitter = Transmitter.new(ACTION, config)
-      puts "Notifying AppSignal of deploy with: " \
+      puts "Notifying AppSignal of '#{config.env}' deploy with " \
         "revision: #{marker_data[:revision]}, user: #{marker_data[:user]}"
 
       response = transmitter.transmit(marker_data)

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "4.5.1"
+  VERSION = "4.5.2"
 end

data/lib/appsignal.rb

@@ -152,7 +152,12 @@ module Appsignal
     # @param env_var [String, NilClass] Used by diagnose CLI to pass through
     #   the environment CLI option value.
     # @api private
-    def _load_config!(env_param = nil)
+    def _load_config!(env_param = nil, &block)
+      # Ensure it's not an empty string if it's a value
+      proper_env_param = env_param&.to_s&.strip
+      # Unset it if it's an empty string
+      proper_env_param = nil if proper_env_param&.empty?
+
       context = Appsignal::Config::Context.new(
         :env => Config.determine_env(env_param),
         :root_path => Config.determine_root_path
@@ -171,13 +176,25 @@ module Appsignal
           Appsignal::Utils::StdoutAndLoggerMessage.warning(message)
         else
           # Load it when no config is present
-          load_dsl_config_file(context.dsl_config_file, env_param)
+          #
+          # We don't pass the `env_var` or `context.env` here so that the
+          # `Appsignal.configure` or `Appsignal.start` can figure out the
+          # environment themselves if it was not explicitly set.
+          # This way we prevent forcing an environment that's auto loaded on
+          # the to-be-loaded config file.
+          #
+          # The `(proper)_env_param` is only set when it's explicitly set,
+          # which means it needs to override any auto detected environment.
+          load_dsl_config_file(context.dsl_config_file, proper_env_param)
         end
       else
         # Load config if no config file was found and no config is present yet
         # This will load the config/appsignal.yml file automatically
         @config ||= Config.new(context.root_path, context.env)
       end
+      # Allow a block to be given to customize the config and override any
+      # loaded config before it's validated.
+      block.call(config) if block_given?
       # Validate the config, if present
       config&.validate
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.5.1
+  version: 4.5.2
 platform: ruby
 authors:
 - Robert Beekman
@@ -316,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com