appsignal 2.9.18 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d3694d0f2970749ad1d8951a3989c2f6ea77c10f3cb695c3992266962bba09e
-  data.tar.gz: b16b94135fc7f014ec2a3b5b6904696d6b262972bb229d908f3d0c7f2f6bb6ff
+  metadata.gz: 4dcc9f0ae3d601a8d8a7851943568176af63fc2aae714f996449227607a74fee
+  data.tar.gz: c5a44f8e88184697b7ae5ccd56bb13451a64e5fc51eb427fb04ee01c77aaf7ba
 SHA512:
-  metadata.gz: cb9e78c6e46f317ea3092e6045afd21abb7bea8ed3858021fbd4d2ef0d4d743a778becf69a3e2c4dc0dd64a00a353b2793601d22ed5163d99c9dfd779f748b8b
-  data.tar.gz: fc32dfdfb9beadac21752e730340306674948458a2cc260d66e5dca646efa4bfe7a6c44e01d62a17844f229a08562d55534651c7744d82a9da8c98a8e23e9869
+  metadata.gz: 71b733951dfa43726b103e3ba39e5898e68009063b97d74d7382c1f7a0687754dba9e3954da5a3f7e5646ef1871c6ef643e238afac4319b787413fe58822a91a
+  data.tar.gz: e0995a18c18ee86162d7a4bc33e046f6b3a956f955c9b6f61f0bc188a161dd222983abc26852ce69bfac0008447612702c587134b010b432dfe449c70b6f1c9d

data/.rubocop_todo.yml

@@ -89,12 +89,6 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/appsignal/integrations/padrino.rb'
 
-# Offense count: 6
-Style/ClassVars:
-  Exclude:
-    - 'lib/appsignal/event_formatter.rb'
-    - 'lib/appsignal/minutely.rb'
-
 # Offense count: 1
 Style/DoubleNegation:
   Exclude:

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 
-## 2.9.18 (Beta)
+## 2.10.0
+- Rescue errors while parsing `appsignal.yml` file. It will prints a warning
+  instead. PR #517
+- Refactoring: Reduce class variable usage. PR #520
+- Bump log level about starting new transactions while a transaction is already
+  active from debug to a warning. PR #525
+- Refactoring: Add internal AppSignal test helpers and other test suite
+  refactorings. PR #536, #537, #538, #539
+- Fix internal Rakefile loading on Ruby 1.9.3. PR #541
+- Add a `--no-color` option to the `appsignal install` command. PR #550
+- Add output coloring to `appsignal diagnose` warnings. PR #551
+- Add validation for empty Push API key. Empty Push API key values will no
+  longer start AppSignal. PR #569
+- Deprecate the JSExceptionCatcher middleware in favor of our new front-end
+  JavaScript integration (https://docs.appsignal.com/front-end/). PR #572
+
+## 2.9.18
 - Bump agent to v-c348132
   - Improve transmitter logging on timeout
   - Improve queued payloads transmitter. Should prevent payloads being sent

data/Rakefile

@@ -143,9 +143,23 @@ namespace :build do
     end
   end
 
+  def define_build_task(task_name, base_gemspec, &block)
+    Gem::PackageTask.new(base_gemspec, &block)
+  rescue StandardError => error
+    puts "Warning: An error occurred defining `build:#{task_name}:gem` Rake task."
+    puts "This task will not be availble."
+    if ENV["DEBUG"]
+      puts "#{error}: #{error.message}"
+      puts error.backtrace
+    else
+      puts "For more information, run the same command with `DEBUG=true`."
+    end
+    puts
+  end
+
   namespace :ruby do
     # Extension default set in `appsignal.gemspec`
-    Gem::PackageTask.new(base_gemspec) { |_pkg| }
+    define_build_task(:ruby, base_gemspec) { |_pkg| }
   end
 
   namespace :jruby do
@@ -157,7 +171,7 @@ namespace :build do
       s.add_dependency "ffi"
     end
 
-    Gem::PackageTask.new(spec) { |_pkg| }
+    define_build_task(:jruby, spec) { |_pkg| }
   end
 
   desc "Build all gem versions"

data/lib/appsignal/cli.rb

@@ -32,7 +32,7 @@ module Appsignal
             when :diagnose
               Appsignal::CLI::Diagnose.run(options)
             when :install
-              Appsignal::CLI::Install.run(argv.shift)
+              Appsignal::CLI::Install.run(argv.shift, options)
             when :notify_of_deploy
               Appsignal::CLI::NotifyOfDeploy.run(options)
             end
@@ -85,8 +85,15 @@ module Appsignal
             o.on "--[no-]send-report", "Confirm sending the report to AppSignal automatically" do |arg|
               options[:send_report] = arg
             end
+            o.on "--[no-]color", "Colorize the output of the diagnose command" do |arg|
+              options[:color] = arg
+            end
+          end,
+          "install" => OptionParser.new do |o|
+            o.on "--[no-]color", "Colorize the output of the diagnose command" do |arg|
+              options[:color] = arg
+            end
           end,
-          "install" => OptionParser.new,
           "notify_of_deploy" => OptionParser.new do |o|
             o.banner = "Usage: appsignal notify_of_deploy [options]"
 

data/lib/appsignal/cli/diagnose.rb

@@ -77,6 +77,7 @@ module Appsignal
         # @return [void]
         # @api private
         def run(options = {})
+          self.coloring = options.delete(:color) { true }
           $stdout.sync = true
           header
           print_empty_line
@@ -200,7 +201,7 @@ module Appsignal
         def run_agent_diagnose_mode
           puts "Agent diagnostics"
           unless Appsignal.extension_loaded?
-            puts "  Extension is not loaded. No agent report created."
+            puts colorize("  Extension is not loaded. No agent report created.", :red)
             return
           end
 
@@ -461,10 +462,11 @@ module Appsignal
           print "  Environment: #{format_config_option(env)}"
 
           if env == ""
-            puts "\n    Warning: No environment set, no config loaded!"
-            puts "    Please make sure appsignal diagnose is run within your "
-            puts "    project directory with an environment."
-            puts "      appsignal diagnose --environment=production"
+            message = "    Warning: No environment set, no config loaded!\n" \
+              "    Please make sure appsignal diagnose is run within your\n" \
+              "    project directory with an environment.\n" \
+              "      appsignal diagnose --environment=production"
+            puts "\n#{colorize(message, :red)}"
           else
             puts sources_label
           end
@@ -531,20 +533,19 @@ module Appsignal
 
         def check_api_key
           puts "Validation"
-          data_section :validation do
-            auth_check = ::Appsignal::AuthCheck.new(Appsignal.config)
-            status, error = auth_check.perform_with_result
-            result =
-              case status
-              when "200"
-                "valid"
-              when "401"
-                "invalid"
-              else
-                "Failed with status #{status}\n#{error.inspect}"
-              end
-            puts_and_save :push_api_key, "Validating Push API key", result
-          end
+          auth_check = ::Appsignal::AuthCheck.new(Appsignal.config)
+          status, error = auth_check.perform_with_result
+          result, color =
+            case status
+            when "200"
+              ["valid", :green]
+            when "401"
+              ["invalid", :red]
+            else
+              ["Failed with status #{status}\n#{error.inspect}", :red]
+            end
+          data[:validation][:push_api_key] = result
+          puts_value "Validating Push API key", colorize(result, color)
         end
 
         def print_paths_section(report)

data/lib/appsignal/cli/helpers.rb

@@ -7,24 +7,36 @@ module Appsignal
     module Helpers
       private
 
+      COLOR_CODES = {
+        :red => 31,
+        :green => 32,
+        :yellow => 33,
+        :blue => 34,
+        :pink => 35,
+        :default => 0
+      }.freeze
+
       def ruby_2_6_or_up?
         Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
       end
 
+      def coloring=(value)
+        @coloring = value
+      end
+
+      def coloring?
+        return true unless defined?(@coloring)
+        @coloring
+      end
+
       def colorize(text, color)
+        return text unless coloring?
         return text if Gem.win_platform?
 
-        color_code =
-          case color
-          when :red then 31
-          when :green then 32
-          when :yellow then 33
-          when :blue then 34
-          when :pink then 35
-          else 0
-          end
+        reset_color_code = COLOR_CODES.fetch(:default)
+        color_code = COLOR_CODES.fetch(color, reset_color_code)
 
-        "\e[#{color_code}m#{text}\e[0m"
+        "\e[#{color_code}m#{text}\e[#{reset_color_code}m"
       end
 
       def periods

data/lib/appsignal/cli/install.rb

@@ -13,7 +13,8 @@ module Appsignal
       EXCLUDED_ENVIRONMENTS = ["test"].freeze
 
       class << self
-        def run(push_api_key)
+        def run(push_api_key, options) # rubocop:disable Metrics/AbcSize
+          self.coloring = options.delete(:color) { true }
           $stdout.sync = true
 
           puts

data/lib/appsignal/config.rb

@@ -237,11 +237,12 @@ module Appsignal
           "#{endpoint_uri.scheme}://#{endpoint_uri.host}:#{endpoint_uri.port}"
         end
 
-      if config_hash[:push_api_key]
-        @valid = true
-      else
+      push_api_key = config_hash[:push_api_key] || ""
+      if push_api_key.strip.empty?
         @valid = false
-        @logger.error "Push api key not set after loading config"
+        @logger.error "Push API key not set after loading config"
+      else
+        @valid = true
       end
     end
 
@@ -256,8 +257,10 @@ module Appsignal
       {}.tap do |hash|
         hash[:log] = "stdout" if Appsignal::System.heroku?
 
-        # Make active by default if APPSIGNAL_PUSH_API_KEY is present
-        hash[:active] = true if ENV["APPSIGNAL_PUSH_API_KEY"]
+        # Make AppSignal active by default if APPSIGNAL_PUSH_API_KEY
+        # environment variable is present and not empty.
+        env_push_api_key = ENV["APPSIGNAL_PUSH_API_KEY"] || ""
+        hash[:active] = true unless env_push_api_key.strip.empty?
       end
     end
 
@@ -274,9 +277,17 @@ module Appsignal
 
         maintain_backwards_compatibility(config_for_this_env)
       else
-        @logger.error "Not loading from config file: config for '#{env}' not found"
+        logger.error "Not loading from config file: config for '#{env}' not found"
         nil
       end
+    rescue => e
+      message = "An error occured while loading the AppSignal config file." \
+        " Skipping file config.\n" \
+        "File: #{config_file.inspect}\n" \
+        "#{e.name}: #{e}"
+      $stderr.puts "appsignal: #{message}"
+      logger.error "#{message}\n#{e.backtrace.join("\n")}"
+      nil
     end
 
     # Maintain backwards compatibility with config files generated by earlier

data/lib/appsignal/event_formatter.rb

@@ -17,15 +17,15 @@ module Appsignal
       include Appsignal::Utils::DeprecationMessage
 
       def formatters
-        @@formatters ||= {}
+        @formatters ||= {}
       end
 
       def deprecated_formatter_classes
-        @@deprecated_formatter_classes ||= {}
+        @deprecated_formatter_classes ||= {}
       end
 
       def formatter_classes
-        @@formatter_classes ||= {}
+        @formatter_classes ||= {}
       end
 
       def register(name, formatter = nil)
@@ -94,7 +94,7 @@ module Appsignal
           "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html",
           logger
 
-        deprecated_formatter_classes[name] = self
+        EventFormatter.deprecated_formatter_classes[name] = self
       end
 
       def logger

data/lib/appsignal/minutely.rb

@@ -129,13 +129,13 @@ module Appsignal
       # @see ProbeCollection
       # @return [ProbeCollection] Returns list of probes.
       def probes
-        @@probes ||= ProbeCollection.new
+        @probes ||= ProbeCollection.new
       end
 
       # @api private
       def start
         stop
-        @@thread = Thread.new do
+        @thread = Thread.new do
           sleep initial_wait_time
           initialize_probes
           loop do
@@ -157,7 +157,7 @@ module Appsignal
 
       # @api private
       def stop
-        defined?(@@thread) && @@thread.kill
+        defined?(@thread) && @thread.kill
         probe_instances.clear
       end
 
@@ -206,7 +206,7 @@ module Appsignal
       end
 
       def probe_instances
-        @@probe_instances ||= {}
+        @probe_instances ||= {}
       end
     end
   end

data/lib/appsignal/rack/js_exception_catcher.rb

@@ -23,9 +23,15 @@ module Appsignal
     # @see http://docs.appsignal.com/front-end/error-handling.html
     # @api private
     class JSExceptionCatcher
+      include Appsignal::Utils::DeprecationMessage
+
       def initialize(app, _options = nil)
         Appsignal.logger.debug \
           "Initializing Appsignal::Rack::JSExceptionCatcher"
+        message = "The Appsignal::Rack::JSExceptionCatcher is deprecated. " \
+          "Please use the official AppSignal JavaScript integration instead. " \
+          "https://docs.appsignal.com/front-end/"
+        deprecation_message message, Appsignal.logger
         @app = app
       end
 

data/lib/appsignal/transaction.rb

@@ -25,7 +25,7 @@ module Appsignal
           Thread.current[:appsignal_transaction] = Appsignal::Transaction.new(id, namespace, request, options)
         else
           # Otherwise, log the issue about trying to start another transaction
-          Appsignal.logger.debug "Trying to start new transaction with id " \
+          Appsignal.logger.warn "Trying to start new transaction with id " \
             "'#{id}', but a transaction with id '#{current.transaction_id}' " \
             "is already running. Using transaction '#{current.transaction_id}'."
 

data/lib/appsignal/version.rb

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

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

@@ -2,7 +2,7 @@ require "bundler/cli"
 require "bundler/cli/common"
 require "appsignal/cli"
 
-describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_input do
+describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_input, :color => false do
   include CLIHelpers
 
   class DiagnosticsReportEndpoint
@@ -24,7 +24,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
     let(:out_stream) { std_stream }
     let(:output) { out_stream.read }
     let(:config) { project_fixture_config }
-    let(:cli) { described_class }
+    let(:cli_class) { described_class }
     let(:options) { { :environment => config.env } }
     let(:gem_path) { Bundler::CLI::Common.select_spec("appsignal").full_gem_path.strip }
     let(:received_report) { DiagnosticsReportEndpoint.received_report }
@@ -34,11 +34,11 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
     before do
       # Clear previous reports
       DiagnosticsReportEndpoint.clear_report!
-      if cli.instance_variable_defined? :@data
+      if cli_class.instance_variable_defined? :@data
         # Because this is saved on the class rather than an instance of the
         # class we need to clear it like this in case a certain test doesn't
         # generate a report.
-        cli.remove_instance_variable :@data
+        cli_class.remove_instance_variable :@data
       end
 
       if DependencyHelper.rails_present?
@@ -54,16 +54,18 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
     before :api_stub => true do
       stub_api_request config, "auth"
     end
+    before(:color => false) { options["no-color"] = nil }
+    before(:color => true) { options["color"] = nil }
     before(:send_report => :yes_cli_input) do
       accept_prompt_to_send_diagnostics_report
       capture_diagnatics_report_request
     end
     before(:send_report => :no_cli_input) { dont_accept_prompt_to_send_diagnostics_report }
     before(:send_report => :yes_cli_option) do
-      options[:send_report] = true
+      options["send-report"] = nil
       capture_diagnatics_report_request
     end
-    before(:send_report => :no_cli_option) { options[:send_report] = false }
+    before(:send_report => :no_cli_option) { options["no-send-report"] = nil }
     after { Appsignal.config = nil }
 
     def capture_diagnatics_report_request
@@ -77,7 +79,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
     def run_within_dir(chdir)
       prepare_cli_input
       Dir.chdir chdir do
-        capture_stdout(out_stream) { cli.run(options) }
+        capture_stdout(out_stream) { run_cli("diagnose", options) }
       end
     end
 
@@ -228,6 +230,14 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
 
         it "outputs extension is not loaded" do
           expect(output).to include "Extension loaded: false"
+          expect(output).to include "Extension is not loaded. No agent report created."
+        end
+
+        context "with color", :color => true do
+          it "outputs extension is not loaded in color" do
+            expect(output).to have_colorized_text :red,
+              "  Extension is not loaded. No agent report created."
+          end
         end
 
         it "transmits extension_loaded: false in report" do
@@ -682,6 +692,12 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
       context "without environment" do
         let(:config) { project_fixture_config(nil) }
         let(:options) { {} }
+        let(:warning_message) do
+          "    Warning: No environment set, no config loaded!\n" \
+            "    Please make sure appsignal diagnose is run within your\n" \
+            "    project directory with an environment.\n" \
+            "      appsignal diagnose --environment=production"
+        end
         before do
           ENV.delete("RAILS_ENV") # From spec_helper
           ENV.delete("RACK_ENV")
@@ -689,10 +705,15 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         end
 
         it "outputs a warning that no config is loaded" do
-          expect(output).to include \
-            "Environment: \"\"\n",
-            "    Warning: No environment set, no config loaded!",
-            "  appsignal diagnose --environment=production"
+          expect(output).to include "Environment: \"\"\n#{warning_message}"
+          expect(output).to_not have_color_markers
+        end
+
+        context "with color", :color => true do
+          it "outputs a warning that no config is loaded in color" do
+            expect(output).to include "Environment: \"\"\n"
+            expect(output).to have_colorized_text :red, warning_message
+          end
         end
 
         it "outputs config defaults" do
@@ -890,6 +911,13 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
             "Validating Push API key: valid"
         end
 
+        context "with color", :color => true do
+          it "outputs valid in color" do
+            expect(output).to include "Validation",
+              "Validating Push API key: #{colorize("valid", :green)}"
+          end
+        end
+
         it "transmits validation in report" do
           expect(received_report).to include(
             "validation" => {
@@ -910,6 +938,13 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
             "Validating Push API key: invalid"
         end
 
+        context "with color", :color => true do
+          it "outputs invalid in color" do
+            expect(output).to include "Validation",
+              "Validating Push API key: #{colorize("invalid", :red)}"
+          end
+        end
+
         it "transmits validation in report" do
           expect(received_report).to include(
             "validation" => {
@@ -931,6 +966,14 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
             %("Could not confirm authorization: 500")
         end
 
+        context "with color", :color => true do
+          it "outputs error in color" do
+            expect(output).to include "Validation",
+              "Validating Push API key: " +
+              colorize(%(Failed with status 500\n"Could not confirm authorization: 500"), :red)
+          end
+        end
+
         it "transmits validation in report" do
           expect(received_report).to include(
             "validation" => {