bugsnag-maglev- 2.8.12

data/lib/bugsnag/tasks/bugsnag.rake

@@ -0,0 +1,89 @@
+require "bugsnag"
+
+namespace :bugsnag do
+  desc "Notify Bugsnag of a new deploy."
+  task :deploy do
+    api_key = ENV["BUGSNAG_API_KEY"]
+    release_stage = ENV["BUGSNAG_RELEASE_STAGE"]
+    app_version = ENV["BUGSNAG_APP_VERSION"]
+    revision = ENV["BUGSNAG_REVISION"]
+    repository = ENV["BUGSNAG_REPOSITORY"]
+    branch = ENV["BUGSNAG_BRANCH"]
+
+    Rake::Task["load"].invoke unless api_key
+
+    Bugsnag::Deploy.notify({
+      :api_key => api_key,
+      :release_stage => release_stage,
+      :app_version => app_version,
+      :revision => revision,
+      :repository => repository,
+      :branch => branch
+    })
+  end
+
+  desc "Send a test exception to Bugsnag."
+  task :test_exception => :load do
+    begin
+      raise RuntimeError.new("Bugsnag test exception")
+    rescue => e
+      Bugsnag.notify(e, {:context => "rake#test_exception"})
+    end
+  end
+
+  desc "Show the bugsnag middleware stack"
+  task :middleware => :load do
+    Bugsnag.configuration.middleware.each {|m| puts m.to_s}
+  end
+
+  namespace :heroku do
+    desc "Add a heroku deploy hook to notify Bugsnag of deploys"
+    task :add_deploy_hook => :load do
+      # Wrapper to run command safely even in bundler
+      run_command = lambda { |command|
+        defined?(Bundler.with_clean_env) ? Bundler.with_clean_env { `#{command}` } : `#{command}`
+      }
+
+      # Fetch heroku config settings
+      config_command = "heroku config --shell"
+      config_command += " --app #{ENV["HEROKU_APP"]}" if ENV["HEROKU_APP"]
+      heroku_env = run_command.call(config_command).split(/[\n\r]/).each_with_object({}) do |c, obj|
+        k,v = c.split("=")
+        obj[k] = v.strip.empty? ? nil : v
+      end
+
+      # Check for Bugsnag API key (required)
+      api_key = heroku_env["BUGSNAG_API_KEY"] || Bugsnag.configuration.api_key || ENV["BUGSNAG_API_KEY"]
+      unless api_key
+        puts "Error: No API key found, have you run 'heroku config:set BUGSNAG_API_KEY=your-api-key'?"
+        next
+      end
+
+      # Build the request, making use of deploy hook variables
+      # (https://devcenter.heroku.com/articles/deploy-hooks#customizing-messages)
+      params = {
+        :apiKey => api_key,
+        :branch => "master",
+        :revision => "{{head_long}}",
+        :releaseStage => heroku_env["RAILS_ENV"] || ENV["RAILS_ENV"] || "production"
+      }
+      repo = `git config --get remote.origin.url`.strip
+      params[:repository] = repo unless repo.empty?
+
+      # Add the hook
+      url = "https://notify.bugsnag.com/deploy?" + params.map {|k,v| "#{k}=#{v}"}.join("&")
+      command = "heroku addons:add deployhooks:http --url=\"#{url}\""
+      command += " --app #{ENV["HEROKU_APP"]}" if ENV["HEROKU_APP"]
+
+      puts "$ #{command}"
+      run_command.call(command)
+    end
+  end
+end
+
+task :load do
+  begin
+    Rake::Task["environment"].invoke
+  rescue
+  end
+end

data/lib/bugsnag/version.rb

@@ -0,0 +1,3 @@
+module Bugsnag
+  VERSION = File.read(File.join(File.dirname(__FILE__), "../../VERSION")).strip
+end

data/lib/generators/bugsnag/bugsnag_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+class BugsnagGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :api_key, required: true, :desc => "required"
+
+  gem "bugsnag"
+
+  desc "Configures the bugsnag notifier with your API key"
+
+  def create_initializer_file
+    unless /^[a-f0-9]{32}$/ =~ api_key
+      raise Thor::Error, "Invalid bugsnag notifier api key #{api_key.inspect}\nYou can find the api key on the Settings tab of https://bugsnag.com/"
+    end
+
+    initializer "bugsnag.rb" do
+      <<-EOF
+Bugsnag.configure do |config|
+  config.api_key = #{api_key.inspect}
+end
+      EOF
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+# On Rails 2.x GEM_ROOT/rails/init.rb is auto loaded for all gems
+# so this is the place to initialize Rails 2.x plugin support
+require "bugsnag/rails"

data/spec/code_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Bugsnag::Notification do
+  it "includes code in the stack trace" do
+    _a = 1
+    _b = 2
+    _c = 3
+    notify_test_exception
+    _d = 4
+    _e = 5
+    _f = 6
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      exception = get_exception_from_payload(payload)
+      starting_line = __LINE__ - 10
+      expect(exception["stacktrace"][1]["code"]).to eq({
+        (starting_line + 0).to_s => "    _a = 1",
+        (starting_line + 1).to_s => "    _b = 2",
+        (starting_line + 2).to_s => "    _c = 3",
+        (starting_line + 3).to_s => "    notify_test_exception",
+        (starting_line + 4).to_s => "    _d = 4",
+        (starting_line + 5).to_s => "    _e = 5",
+        (starting_line + 6).to_s => "    _f = 6"
+        })
+    }
+  end
+
+  it "allows you to disable sending code" do
+    Bugsnag.configuration.send_code = false
+
+    notify_test_exception
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      exception = get_exception_from_payload(payload)
+      expect(exception["stacktrace"][1]["code"]).to eq(nil)
+    }
+  end
+
+  it 'should send the first 7 lines of the file for exceptions near the top' do
+    load 'spec/fixtures/crashes/start_of_file.rb' rescue Bugsnag.notify $!
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      exception = get_exception_from_payload(payload)
+
+      expect(exception["stacktrace"][0]["code"]).to eq({
+        "1" => "#",
+        "2" => "raise 'hell'",
+        "3" => "#",
+        "4" => "#",
+        "5" => "#",
+        "6" => "#",
+        "7" => "#"
+      })
+    }
+  end
+
+  it 'should send the last 7 lines of the file for exceptions near the bottom' do
+    load 'spec/fixtures/crashes/end_of_file.rb' rescue Bugsnag.notify $!
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      exception = get_exception_from_payload(payload)
+
+      expect(exception["stacktrace"][0]["code"]).to eq({
+        "3" => "#",
+        "4" => "#",
+        "5" => "#",
+        "6" => "#",
+        "7" => "#",
+        "8" => "raise 'hell'",
+        "9" => "#"
+      })
+    }
+  end
+
+  it 'should send the last 7 lines of the file for exceptions near the bottom' do
+    load 'spec/fixtures/crashes/short_file.rb' rescue Bugsnag.notify $!
+
+    expect(Bugsnag).to have_sent_notification{ |payload|
+      exception = get_exception_from_payload(payload)
+
+      expect(exception["stacktrace"][0]["code"]).to eq({
+        "1" => "raise 'hell'"
+      })
+    }
+  end
+end

data/spec/fixtures/crashes/end_of_file.rb

@@ -0,0 +1,9 @@
+#
+#
+#
+#
+#
+#
+#
+raise 'hell'
+#

data/spec/fixtures/crashes/short_file.rb

@@ -0,0 +1 @@
+raise 'hell'

data/spec/fixtures/crashes/start_of_file.rb

@@ -0,0 +1,9 @@
+#
+raise 'hell'
+#
+#
+#
+#
+#
+#
+#

data/spec/fixtures/middleware/internal_info_setter.rb

@@ -0,0 +1,11 @@
+class InternalInfoSetter
+  MESSAGE = "set by internal_middleware"
+  def initialize(bugsnag)
+    @bugsnag = bugsnag
+  end
+
+  def call(notification)
+    notification.meta_data[:custom][:info] = MESSAGE
+    @bugsnag.call(notification)
+  end
+end

data/spec/fixtures/middleware/public_info_setter.rb

@@ -0,0 +1,11 @@
+class PublicInfoSetter
+  MESSAGE = "set by middleware"
+  def initialize(bugsnag)
+    @bugsnag = bugsnag
+  end
+
+  def call(notification)
+    notification.meta_data[:custom][:info] = MESSAGE
+    @bugsnag.call(notification)
+  end
+end

data/spec/fixtures/tasks/Rakefile

@@ -0,0 +1,15 @@
+require "bugsnag/rake"
+
+namespace :test do
+  desc "used by integration_spec to test that Bugsnag::Middleware::Rake runs properly"
+  task :crash do
+    port = ENV['BUGSNAG_TEST_SERVER_PORT']
+    Bugsnag.configure do |config|
+      config.endpoint = "localhost:#{port}"
+      config.api_key = "0" * 32
+      config.use_ssl = false
+    end
+
+    raise
+  end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Bugsnag::Helpers do
+  it "cleans up recursive hashes" do
+    a = {:a => {}}
+    a[:a][:b] = a
+    expect(Bugsnag::Helpers.cleanup_obj(a)).to eq({:a => {:b => "[RECURSION]"}})
+  end
+
+  it "cleans up recursive arrays" do
+    a = []
+    a << a
+    a << "hello"
+    expect(Bugsnag::Helpers.cleanup_obj(a)).to eq(["[RECURSION]", "hello"])
+  end
+
+  it "allows multiple copies of the same string" do
+    a = {:name => "bugsnag"}
+    a[:second] = a[:name]
+    expect(Bugsnag::Helpers.cleanup_obj(a)).to eq({:name => "bugsnag", :second => "bugsnag"})
+  end
+
+  it "allows multiple copies of the same object" do
+    a = []
+    b = ["hello"]
+    a << b; a << b
+    expect(Bugsnag::Helpers.cleanup_obj(a)).to eq([["hello"], ["hello"]])
+  end
+
+  it "cleans up UTF8 strings properly" do
+    obj = "André"
+    expect(Bugsnag::Helpers.cleanup_obj(obj)).to eq("André")
+  end
+
+  it "cleans up binary strings properly" do
+    if RUBY_VERSION > "1.9"
+      obj = "Andr\xc7\xff"
+      if obj.respond_to? :force_encoding
+        obj = obj.force_encoding('BINARY')
+      end
+      expect(Bugsnag::Helpers.cleanup_obj(obj)).to eq("Andr��")
+    end
+  end
+
+  it "cleans up strings returned from #to_s properly" do
+    if RUBY_VERSION > "1.9"
+      str = "Andr\xc7\xff"
+      if str.respond_to? :force_encoding
+        str = str.force_encoding('BINARY')
+      end
+      obj = RuntimeError.new(str)
+      expect(Bugsnag::Helpers.cleanup_obj(obj)).to eq("Andr��")
+    end
+  end
+
+  it "filters by string inclusion" do
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, ['f'])).to eq({ :foo => '[FILTERED]' })
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, ['b'])).to eq({ :foo => 'bar' })
+  end
+
+  it "filters by regular expression" do
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, [/fb?/])).to eq({ :foo => '[FILTERED]' })
+    expect(Bugsnag::Helpers.cleanup_obj({ :foo => 'bar' }, [/fb+/])).to eq({ :foo => 'bar' })
+  end
+
+  it "reduces hash size correctly" do
+    meta_data = {
+      :key_one => "this should not be truncated",
+      :key_two => ""
+    }
+
+    1000.times {|i| meta_data[:key_two] += "this should be truncated " }
+
+    expect(meta_data[:key_two].length).to be > 4096
+
+    meta_data_return = Bugsnag::Helpers.reduce_hash_size meta_data
+
+    expect(meta_data_return[:key_one].length).to eq(28)
+    expect(meta_data_return[:key_one]).to eq("this should not be truncated")
+
+    expect(meta_data_return[:key_two].length).to eq(4107)
+    expect(meta_data_return[:key_two].match(/\[TRUNCATED\]$/).nil?).to eq(false)
+
+    expect(meta_data[:key_two].length).to be > 4096
+    expect(meta_data[:key_two].match(/\[TRUNCATED\]$/).nil?).to eq(true)
+
+    expect(meta_data[:key_one].length).to eq(28)
+    expect(meta_data[:key_one]).to eq("this should not be truncated")
+  end
+
+  it "works with no filters configured" do
+    url = Bugsnag::Helpers.cleanup_url "/dir/page?param1=value1&param2=value2"
+
+    expect(url).to eq("/dir/page?param1=value1&param2=value2")
+  end
+
+  it "does not filter with no get params" do
+    url = Bugsnag::Helpers.cleanup_url "/dir/page"
+
+    expect(url).to eq("/dir/page")
+  end
+
+  it "leaves a url alone if no filters match" do
+    url = Bugsnag::Helpers.cleanup_url "/dir/page?param1=value1&param2=value2", ["param3"]
+
+    expect(url).to eq("/dir/page?param1=value1&param2=value2")
+  end
+
+  it "filters a single get param" do
+    url = Bugsnag::Helpers.cleanup_url "/dir/page?param1=value1&param2=value2", ["param1"]
+
+    expect(url).to eq("/dir/page?param1=[FILTERED]&param2=value2")
+  end
+
+  it "filters a get param that contains a filtered term" do
+    url = Bugsnag::Helpers.cleanup_url '/dir/page?param1=value1&param2=value2&bla=yes', ["param"]
+
+    expect(url).to eq("/dir/page?param1=[FILTERED]&param2=[FILTERED]&bla=yes")
+  end
+
+  it "filters multiple matches" do
+    url = Bugsnag::Helpers.cleanup_url "/dir/page?param1=value1&param2=value2&param3=value3", ["param1", "param2"]
+
+    expect(url).to eq("/dir/page?param1=[FILTERED]&param2=[FILTERED]&param3=value3")
+  end
+
+  it "filters using a combination of string and regex filters" do
+    url = Bugsnag::Helpers.cleanup_url "/dir/page?param1=value1&param2=value2&param3=value3", ["param1", /param2/]
+
+    expect(url).to eq("/dir/page?param1=[FILTERED]&param2=[FILTERED]&param3=value3")
+  end
+
+  it "filters regex matches" do
+    url = Bugsnag::Helpers.cleanup_url "https://host.example/sessions?access_token=abc123", [/\Aaccess_token\z/]
+    expect(url).to eq("https://host.example/sessions?access_token=[FILTERED]")
+  end
+
+  it "filters partial regex matches" do
+    url = Bugsnag::Helpers.cleanup_url "https://host.example/sessions?access_token=abc123", [/token/]
+    expect(url).to eq("https://host.example/sessions?access_token=[FILTERED]")
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,110 @@
+require 'webrick'
+require 'spec_helper'
+require 'json'
+
+describe 'Bugsnag' do
+  server = nil
+  queue = Queue.new
+
+  before do
+    server = WEBrick::HTTPServer.new :Port => 0, :Logger => WEBrick::Log.new("/dev/null"), :AccessLog => []
+    server.mount_proc '/' do |req, res|
+      queue.push req.body
+      res.status = 200
+      res.body = "OK\n"
+    end
+    Thread.new{ server.start }
+  end
+  after do
+    server.stop
+  end
+
+  let(:request) { JSON.parse(queue.pop) }
+
+  it 'should run the rake middleware when rake tasks crash' do
+    ENV['BUGSNAG_TEST_SERVER_PORT'] = server.config[:Port].to_s
+    task_fixtures_path = File.join(File.dirname(__FILE__), 'fixtures', 'tasks')
+    Dir.chdir(task_fixtures_path) do
+      system("bundle exec rake test:crash > /dev/null 2>&1")
+    end
+    expect(request["events"][0]["metaData"]["rake_task"]).not_to be_nil
+    expect(request["events"][0]["metaData"]["rake_task"]["name"]).to eq("test:crash")
+  end
+
+  it 'should send notifications over the wire' do
+    Bugsnag.configure do |config|
+      config.endpoint = "localhost:#{server.config[:Port]}"
+      config.use_ssl = false
+    end
+    WebMock.allow_net_connect!
+
+    Bugsnag.notify 'yo'
+
+    expect(request['events'][0]['exceptions'][0]['message']).to eq('yo')
+  end
+
+  it 'should send deploys over the wire' do
+    Bugsnag.configure do |config|
+      config.endpoint = "localhost:#{server.config[:Port]}"
+      config.use_ssl = false
+    end
+    WebMock.allow_net_connect!
+
+    Bugsnag::Deploy.notify :app_version => '1.1.1'
+
+    expect(request['appVersion']).to eq('1.1.1')
+  end
+
+  it 'should work with threadpool delivery' do
+    Bugsnag.configure do |config|
+      config.endpoint = "localhost:#{server.config[:Port]}"
+      config.use_ssl = false
+      config.delivery_method = :thread_queue
+    end
+    WebMock.allow_net_connect!
+
+    Bugsnag.notify 'yo'
+
+    expect(request['events'][0]['exceptions'][0]['message']).to eq('yo')
+  end
+
+  describe 'with a proxy' do
+    proxy = nil
+    pqueue = Queue.new
+
+    before do
+      proxy = WEBrick::HTTPServer.new :Port => 0, :Logger => WEBrick::Log.new("/dev/null"), :AccessLog => []
+      proxy.mount_proc '/' do |req, res|
+        pqueue.push req
+        res.status = 200
+        res.body = "OK\n"
+      end
+      Thread.new{ proxy.start }
+    end
+    after do
+      proxy.stop
+    end
+
+    let(:proxied_request) { pqueue.pop }
+
+    it 'should use a proxy when configured' do
+      Bugsnag.configure do |config|
+
+        config.endpoint = "localhost:#{server.config[:Port]}"
+        config.use_ssl = false
+
+        config.proxy_host = 'localhost'
+        config.proxy_port = proxy.config[:Port]
+        config.proxy_user = 'conrad'
+        config.proxy_password = '$ecret'
+      end
+
+      Bugsnag.notify 'oy'
+
+      r = proxied_request
+
+      expect(r.header['proxy-authorization'].first).to eq("Basic Y29ucmFkOiRlY3JldA==")
+      expect(r.request_line).to eq("POST http://localhost:#{server.config[:Port]}/ HTTP/1.1\r\n")
+    end
+  end
+end