bugsnag 6.7.0 → 6.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60129feaa76e872e91284f6c222eeeaa6728fb23
-  data.tar.gz: ab2269d57bd7c131967acf0a37b7508fd1095d7a
+  metadata.gz: 313641e103c52e05c89cc8d3277a0a7285504523
+  data.tar.gz: 3bbe2d377ff467cec0a868510c507f467385d069
 SHA512:
-  metadata.gz: 123b069a26b2e6d3b611eb65a43b36c79878ad49075e63e7b0d600fcdcaecd9396bf7c9a42e66cbeb236d4d06a44290bdc7125b8eff0dab54ae4531209882b07
-  data.tar.gz: 2afa07a981784dff59491cb8a156f977905f06e462dcaacb352b3f09241d6ae90afadf6b3bd0bbecd4ce1a321e88bda4af35a8e03f9a2dbfce3009ac886bc976
+  metadata.gz: ca1371c07f154c2c3d2241e868b9bb49fefc86cc682f4744d819552dd75d517bdeb04dbb3fb5b11f007efa9fd08458e2d6cd198da810e089381965744206a8d6
+  data.tar.gz: 39beb55e75be93fba3921dec840ed1d118de8b9818df62bd3b4a3a3a6d1bce190b087acb7aa36493986264cd7135020e5e38980fe535e225c9b89df679def20a

data/.travis.yml

@@ -63,11 +63,10 @@ jobs:
     rvm: 2.4.1
     script: bundle exec rake rdoc
     if: tag =~ ^v[1-9]
-
-deploy:
-  provider: pages
-  local_dir: rdoc # only include the contents of the generated docs dir
-  skip_cleanup: true
-  github_token: $GITHUB_TOKEN # set in travis-ci dashboard
-  on:
-    tags: true # only deploy when tag is applied to commit
+    deploy:
+      provider: pages
+      local_dir: rdoc # only include the contents of the generated docs dir
+      skip_cleanup: true
+      github_token: $GITHUB_TOKEN # set in travis-ci dashboard
+      on:
+        tags: true # only deploy when tag is applied to commit

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+## 6.7.1 (11 Apr 2018)
+
+### Fixes
+
+* (Rails) Log missing key warning after initialization completes, avoiding
+  incorrectly logging a warning that the API key is missing
+  | [#444](https://github.com/bugsnag/bugsnag-ruby/pull/444)
+
 ## 6.7.0 (05 Apr 2018)
 
 ### Enhancements

data/VERSION

@@ -1 +1 @@
-6.7.0
+6.7.1

data/lib/bugsnag.rb

@@ -37,14 +37,10 @@ module Bugsnag
     # Configure the Bugsnag notifier application-wide settings.
     #
     # Yields a configuration object to use to set application settings.
-    def configure
+    def configure(validate_api_key=true)
       yield(configuration) if block_given?
 
-      @key_warning = false unless defined?(@key_warning)
-      if !configuration.valid_api_key? && !@key_warning
-        configuration.warn("No valid API key has been set, notifications will not be sent")
-        @key_warning = true
-      end
+      check_key_valid if validate_api_key
     end
 
     ##
@@ -179,6 +175,15 @@ module Bugsnag
         configuration.debug("Integration #{integration} is not currently supported")
       end
     end
+
+    # Check if the API key is valid and warn (once) if it is not
+    def check_key_valid
+      @key_warning = false unless defined?(@key_warning)
+      if !configuration.valid_api_key? && !@key_warning
+        configuration.warn("No valid API key has been set, notifications will not be sent")
+        @key_warning = true
+      end
+    end
   end
 end
 

data/lib/bugsnag/integrations/railtie.rb

@@ -36,7 +36,9 @@ module Bugsnag
 
     config.before_initialize do
       # Configure bugsnag rails defaults
-      Bugsnag.configure do |config|
+      # Skipping API key validation as the key may be set later in an
+      # initializer. If not, the key will be validated in after_initialize.
+      Bugsnag.configure(false) do |config|
         config.logger = ::Rails.logger
         config.release_stage = ENV["BUGSNAG_RELEASE_STAGE"] || ::Rails.env.to_s
         config.project_root = ::Rails.root.to_s

data/spec/configuration_spec.rb

@@ -115,6 +115,66 @@ describe Bugsnag::Configuration do
       end
     end
 
+    context "using configure" do
+      before do
+        Bugsnag.configuration.api_key = nil
+        Bugsnag.instance_variable_set("@key_warning", nil)
+        ENV['BUGSNAG_API_KEY'] = nil
+        expect(@logger.logs.size).to eq(0)
+      end
+
+      context "API key is not specified" do
+        it "skips logging a warning if validate_api_key is false" do
+          Bugsnag.configure(false)
+          expect(@logger.logs.size).to eq(0)
+        end
+
+        it "logs a warning by default" do
+          Bugsnag.configure
+          expect(@logger.logs.size).to eq(1)
+          log = @logger.logs.first
+          expect(log).to eq({
+            :level => "warning",
+            :name => "[Bugsnag]",
+            :message => "No valid API key has been set, notifications will not be sent"
+          })
+        end
+
+        it "logs a warning if validate_api_key is true" do
+          Bugsnag.configure(true)
+          expect(@logger.logs.size).to eq(1)
+          log = @logger.logs.first
+          expect(log).to eq({
+            :level => "warning",
+            :name => "[Bugsnag]",
+            :message => "No valid API key has been set, notifications will not be sent"
+          })
+        end
+      end
+
+      context "API key is set" do
+        it "skips logging a warning when configuring with an API key" do
+          Bugsnag.configure do |config|
+            config.api_key = 'd57a2472bd130ac0ab0f52715bbdc600'
+          end
+          expect(@logger.logs.size).to eq(0)
+        end
+
+        it "logs a warning if the configured API key is invalid" do
+          Bugsnag.configure do |config|
+            config.api_key = 'WARNING: not a real key'
+          end
+          expect(@logger.logs.size).to eq(1)
+          log = @logger.logs.first
+          expect(log).to eq({
+            :level => "warning",
+            :name => "[Bugsnag]",
+            :message => "No valid API key has been set, notifications will not be sent"
+          })
+        end
+      end
+    end
+
     it "should log info messages to the set logger" do
       expect(@logger.logs.size).to eq(0)
       Bugsnag.configuration.info("Info message")

data/spec/fixtures/apps/rails-initializer-config/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'railties', '4.2.10', require: %w(action_controller rails)
+gem 'bugsnag', path: '../../../..'

data/spec/fixtures/apps/rails-initializer-config/config.ru

@@ -0,0 +1,16 @@
+Bundler.require
+
+run InitializerConfigApp ||= Class.new(Rails::Application) {
+  config.secret_key_base = routes.append {
+    root to: proc {
+      [200, {"Content-Type" => "text/plain"}, ["Hello!"]]
+    }
+  }.to_s
+
+  config.cache_classes = true
+  config.eager_load = true
+  config.logger = Logger.new(STDOUT)
+  config.log_level = :warn
+
+  initialize!
+}

data/spec/fixtures/apps/rails-initializer-config/config/initializers/bugsnag.rb

@@ -0,0 +1,3 @@
+Bugsnag.configure do |config|
+  config.api_key = 'c34a2472bd240ac0ab0f52715bbdc05d'
+end

data/spec/fixtures/apps/rails-invalid-initializer-config/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'railties', '4.2.10', require: %w(action_controller rails)
+gem 'bugsnag', path: '../../../..'

data/spec/fixtures/apps/rails-invalid-initializer-config/config.ru

@@ -0,0 +1,16 @@
+Bundler.require
+
+run InitializerConfigApp ||= Class.new(Rails::Application) {
+  config.secret_key_base = routes.append {
+    root to: proc {
+      [200, {"Content-Type" => "text/plain"}, ["Hello!"]]
+    }
+  }.to_s
+
+  config.cache_classes = true
+  config.eager_load = true
+  config.logger = Logger.new(STDOUT)
+  config.log_level = :warn
+
+  initialize!
+}

data/spec/fixtures/apps/rails-invalid-initializer-config/config/initializers/bugsnag.rb

@@ -0,0 +1,3 @@
+Bugsnag.configure do |config|
+  config.api_key = '1'
+end

data/spec/fixtures/apps/rails-no-config/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'railties', '4.2.10', require: %w(action_controller rails)
+gem 'bugsnag', path: '../../../..'

data/spec/fixtures/apps/rails-no-config/config.ru

@@ -0,0 +1,16 @@
+Bundler.require
+
+run NoConfigApp ||= Class.new(Rails::Application) {
+  config.secret_key_base = routes.append {
+    root to: proc {
+      [200, {"Content-Type" => "text/plain"}, ["Hello!"]]
+    }
+  }.to_s
+
+  config.cache_classes = true
+  config.eager_load = true
+  config.logger = Logger.new(STDOUT)
+  config.log_level = :warn
+
+  initialize!
+}

data/spec/fixtures/apps/scripts/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'bugsnag', path: '../../../..'

data/spec/fixtures/apps/scripts/configure_invalid_key.rb

@@ -0,0 +1,5 @@
+require 'bugsnag'
+
+Bugsnag.configure do |config|
+  config.api_key = 'no'
+end

data/spec/fixtures/apps/scripts/configure_key.rb

@@ -0,0 +1,5 @@
+require 'bugsnag'
+
+Bugsnag.configure do |config|
+  config.api_key = 'f25a2472bd230ac0ab0fa2715bbdc654'
+end

data/spec/fixtures/apps/scripts/no_config.rb

@@ -0,0 +1,3 @@
+require 'bugsnag'
+
+Bugsnag.configure

data/spec/integrations/logger_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe 'Configuration.logger' do
+
+  before do
+    @env = {}
+  end
+
+  context 'in a Rails app' do
+    key_warning = '[Bugsnag]: No valid API key has been set, notifications will not be sent'
+    is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+    incompatible = (RUBY_VERSION < '2.0.0') || is_jruby
+
+    before do
+      skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
+      @env['RACK_ENV'] = 'production'
+    end
+
+    def run_app(name)
+      out_reader, out_writer = IO.pipe
+      Dir.chdir(File.join(File.dirname(__FILE__), "../fixtures/apps/#{name}")) do
+        Bundler.with_clean_env do
+          pid = Process.spawn('bundle install',
+                              out: out_writer.fileno,
+                              err: out_writer.fileno)
+          Process.waitpid(pid, 0)
+          pid = Process.spawn(@env, 'bundle exec rackup config.ru',
+                              out: out_writer.fileno,
+                              err: out_writer.fileno)
+          sleep(2)
+          Process.kill(1, pid)
+        end
+      end
+      out_writer.close
+      output = ""
+      output << out_reader.gets until out_reader.eof?
+      output
+    end
+    context 'sets an API key using the BUGSNAG_API_KEY env var' do
+      it 'does not log a warning' do
+        skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
+        @env['BUGSNAG_API_KEY'] = 'c34a2472bd240ac0ab0f52715bbdc05d'
+        output = run_app('rails-no-config')
+        expect(output).not_to include(key_warning)
+      end
+    end
+
+    context 'sets an API key using the bugsnag initializer' do
+      it 'does not log a warning' do
+        skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
+        output = run_app('rails-initializer-config')
+        expect(output).not_to include(key_warning)
+      end
+    end
+
+    context 'skips setting an API key' do
+      it 'logs a warning' do
+        skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
+        output = run_app('rails-no-config')
+        expect(output).to include(key_warning)
+      end
+    end
+
+    context 'sets an invalid API key using the BUGSNAG_API_KEY env var' do
+      it 'logs a warning' do
+        skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
+        output = run_app('rails-invalid-initializer-config')
+        expect(output).to include(key_warning)
+      end
+    end
+
+    context 'sets an invalid API key using the BUGSNAG_API_KEY env var' do
+      it 'logs a warning' do
+        skip "Incompatible with Ruby <2.0 and JRuby" if incompatible
+        @env['BUGSNAG_API_KEY'] = 'not a real key'
+        output = run_app('rails-no-config')
+        expect(output).to include(key_warning)
+      end
+    end
+  end
+
+  context 'in a script' do
+    key_warning = /\[Bugsnag\] .* No valid API key has been set, notifications will not be sent/
+
+    def run_app(name)
+      out_reader, out_writer = IO.pipe
+      Dir.chdir(File.join(File.dirname(__FILE__), "../fixtures/apps/scripts")) do
+        Bundler.with_clean_env do
+          pid = Process.spawn(@env, "bundle exec ruby #{name}.rb",
+                              out: out_writer.fileno,
+                              err: out_writer.fileno)
+          Process.waitpid(pid, 0)
+        end
+      end
+      out_writer.close
+      output = ""
+      output << out_reader.gets until out_reader.eof?
+      output
+    end
+
+    context 'sets an API key using the BUGSNAG_API_KEY env var' do
+      it 'does not log a warning' do
+        @env['BUGSNAG_API_KEY'] = 'c34a2472bd240ac0ab0f52715bbdc05d'
+        output = run_app('no_config')
+        expect(output).not_to match(key_warning)
+      end
+    end
+
+    context 'sets an API key using Bugsnag.configure' do
+      it 'does not log a warning' do
+        output = run_app('configure_key')
+        expect(output).not_to match(key_warning)
+      end
+    end
+
+    context 'sets an invalid API key using Bugsnag.configure' do
+      it 'logs a warning' do
+        output = run_app('configure_invalid_key')
+        expect(output).to match(key_warning)
+      end
+    end
+
+    context 'sets an invalid API key using the BUGSNAG_API_KEY env var' do
+      it 'logs a warning' do
+        @env['BUGSNAG_API_KEY'] = 'bad key bad key whatcha gonna do'
+        output = run_app('no_config')
+        expect(output).to match(key_warning)
+      end
+    end
+
+    context 'skips setting an API key' do
+      it 'logs a warning' do
+        output = run_app('no_config')
+        expect(output).to match(key_warning)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bugsnag
 version: !ruby/object:Gem::Version
-  version: 6.7.0
+  version: 6.7.1
 platform: ruby
 authors:
 - James Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-05 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -92,6 +92,18 @@ files:
 - spec/bugsnag_spec.rb
 - spec/cleaner_spec.rb
 - spec/configuration_spec.rb
+- spec/fixtures/apps/rails-initializer-config/Gemfile
+- spec/fixtures/apps/rails-initializer-config/config.ru
+- spec/fixtures/apps/rails-initializer-config/config/initializers/bugsnag.rb
+- spec/fixtures/apps/rails-invalid-initializer-config/Gemfile
+- spec/fixtures/apps/rails-invalid-initializer-config/config.ru
+- spec/fixtures/apps/rails-invalid-initializer-config/config/initializers/bugsnag.rb
+- spec/fixtures/apps/rails-no-config/Gemfile
+- spec/fixtures/apps/rails-no-config/config.ru
+- spec/fixtures/apps/scripts/Gemfile
+- spec/fixtures/apps/scripts/configure_invalid_key.rb
+- spec/fixtures/apps/scripts/configure_key.rb
+- spec/fixtures/apps/scripts/no_config.rb
 - spec/fixtures/crashes/end_of_file.rb
 - spec/fixtures/crashes/short_file.rb
 - spec/fixtures/crashes/start_of_file.rb
@@ -102,6 +114,7 @@ files:
 - spec/integration_spec.rb
 - spec/integrations/clearance_user_spec.rb
 - spec/integrations/delayed_job_spec.rb
+- spec/integrations/logger_spec.rb
 - spec/integrations/mailman_spec.rb
 - spec/integrations/que_spec.rb
 - spec/integrations/rack_spec.rb
@@ -138,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for bugsnag.com