airbrake-ruby 3.1.0 → 3.2.0

data/lib/airbrake-ruby/time_truncate.rb

@@ -0,0 +1,17 @@
+module Airbrake
+  # TimeTruncate contains methods for truncating time.
+  #
+  # @api private
+  # @since v3.2.0
+  module TimeTruncate
+    # Truncate +time+ to floor minute and turn it into an RFC3339 timestamp.
+    #
+    # @param [Time] time
+    # @return [String]
+    def self.utc_truncate_minutes(time)
+      tm = time.getutc
+
+      Time.utc(tm.year, tm.month, tm.day, tm.hour, tm.min).to_datetime.rfc3339
+    end
+  end
+end

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '3.1.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '3.2.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -1,20 +1,30 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake do
   describe ".[]" do
     it "returns a NilNotifier" do
-      expect(described_class[:test]).to be_an(Airbrake::NilNotifier)
+      expect(described_class[:test]).to be_an(Airbrake::NilNoticeNotifier)
+    end
+  end
+
+  describe ".notifiers" do
+    it "returns a Hash of notifiers" do
+      expect(described_class.notifiers).to eq(
+        notice: {}, performance: {}, deploy: {}
+      )
     end
   end
 
   let(:default_notifier) do
-    described_class.instance_variable_get(:@notifiers)[:default]
+    described_class[:default]
   end
 
   describe ".configure" do
     let(:config_params) { { project_id: 1, project_key: 'abc' } }
 
-    after { described_class.instance_variable_get(:@notifiers).clear }
+    after do
+      described_class.instance_variable_get(:@notice_notifiers).clear
+      described_class.instance_variable_get(:@performance_notifiers).clear
+      described_class.instance_variable_get(:@deploy_notifiers).clear
+    end
 
     it "yields the config" do
       expect do |b|
@@ -26,17 +36,17 @@ RSpec.describe Airbrake do
       end.to yield_with_args(Airbrake::Config)
     end
 
-    context "when invoked with a notifier name" do
-      it "sets notifier name to the provided name" do
+    context "when invoked with a notice notifier name" do
+      it "sets notice notifier name to the provided name" do
         described_class.configure(:test) { |c| c.merge(config_params) }
-        expect(described_class[:test]).to be_an(Airbrake::Notifier)
+        expect(described_class[:test]).to be_an(Airbrake::NoticeNotifier)
       end
     end
 
     context "when invoked without a notifier name" do
       it "defaults to the :default notifier name" do
         described_class.configure { |c| c.merge(config_params) }
-        expect(described_class[:default]).to be_an(Airbrake::Notifier)
+        expect(described_class[:default]).to be_an(Airbrake::NoticeNotifier)
       end
     end
 
@@ -50,6 +60,20 @@ RSpec.describe Airbrake do
         )
       end
     end
+
+    context "when user config doesn't contain a project id" do
+      it "raises error" do
+        expect { described_class.configure { |c| c.project_key = '1' } }.
+          to raise_error(Airbrake::Error, ':project_id is required')
+      end
+    end
+
+    context "when user config doesn't contain a project key" do
+      it "raises error" do
+        expect { described_class.configure { |c| c.project_id = 1 } }.
+          to raise_error(Airbrake::Error, ':project_key is required')
+      end
+    end
   end
 
   describe ".configured?" do
@@ -98,8 +122,10 @@ RSpec.describe Airbrake do
   end
 
   describe ".create_deploy" do
-    it "forwards 'create_deploy' to the notifier" do
-      expect(default_notifier).to receive(:create_deploy).with(foo: 'bar')
+    let(:default_notifier) { described_class.notifiers[:deploy][:default] }
+
+    it "calls 'notify' on the deploy notifier" do
+      expect(default_notifier).to receive(:notify).with(foo: 'bar')
       described_class.create_deploy(foo: 'bar')
     end
   end
@@ -112,7 +138,9 @@ RSpec.describe Airbrake do
   end
 
   describe ".notify_request" do
-    it "forwards 'notify_request' to the notifier" do
+    let(:default_notifier) { described_class.notifiers[:performance][:default] }
+
+    it "calls 'notify' on the route notifier" do
       params = {
         method: 'GET',
         route: '/foo',
@@ -120,8 +148,24 @@ RSpec.describe Airbrake do
         start_time: Time.new(2018, 1, 1, 0, 20, 0, 0),
         end_time: Time.new(2018, 1, 1, 0, 19, 0, 0)
       }
-      expect(default_notifier).to receive(:notify_request).with(params)
+      expect(default_notifier).to receive(:notify).with(Airbrake::Request.new(params))
       described_class.notify_request(params)
     end
   end
+
+  describe ".notify_query" do
+    let(:default_notifier) { described_class.notifiers[:performance][:default] }
+
+    it "calls 'notify' on the query notifier" do
+      params = {
+        method: 'GET',
+        route: '/foo',
+        query: 'SELECT * FROM foos',
+        start_time: Time.new(2018, 1, 1, 0, 20, 0, 0),
+        end_time: Time.new(2018, 1, 1, 0, 19, 0, 0)
+      }
+      expect(default_notifier).to receive(:notify).with(Airbrake::Query.new(params))
+      described_class.notify_query(params)
+    end
+  end
 end

data/spec/async_sender_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::AsyncSender do
   before do
     stub_request(:post, /.*/).to_return(status: 201, body: '{}')

data/spec/backtrace_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Backtrace do
   let(:config) do
     Airbrake::Config.new.tap { |c| c.logger = Logger.new('/dev/null') }

data/spec/code_hunk_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::CodeHunk do
   let(:config) { Airbrake::Config.new }
 

data/spec/config/validator_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Config::Validator do
   subject { described_class.new(config) }
 

data/spec/config_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Config do
   let(:config) { described_class.new }
 
@@ -79,12 +77,26 @@ RSpec.describe Airbrake::Config do
         expect(config.whitelist_keys).to be_empty
       end
 
-      it "enables route stats by default" do
+      it "disables route stats by default (deprecated)" do
+        out = StringIO.new
+        config.logger = Logger.new(out)
         expect(config.route_stats).to be_falsey
+        expect(out.string).to match(/'route_stats'.+is deprecated/)
+      end
+
+      it "disables performance stats by default" do
+        expect(config.performance_stats).to be_falsey
       end
 
-      it "sets the default route_stats_flush_period" do
+      it "sets the default route_stats_flush_period (deprecated)" do
+        out = StringIO.new
+        config.logger = Logger.new(out)
         expect(config.route_stats_flush_period).to eq(15)
+        expect(out.string).to match(/'route_stats_flush_period'.+is deprecated/)
+      end
+
+      it "sets the default performance_stats_flush_period" do
+        expect(config.performance_stats_flush_period).to eq(15)
       end
     end
   end

data/spec/deploy_notifier_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Airbrake::DeployNotifier do
+  let(:user_params) { { project_id: 1, project_key: 'banana' } }
+  let(:params) { {} }
+  let(:config) { Airbrake::Config.new(user_params.merge(params)) }
+
+  subject { described_class.new(config) }
+
+  describe "#notify" do
+    it "returns a promise" do
+      stub_request(:post, 'https://api.airbrake.io/api/v4/projects/1/deploys').
+        to_return(status: 201, body: '{}')
+      expect(subject.notify({})).to be_an(Airbrake::Promise)
+    end
+
+    context "when environment is configured" do
+      let(:params) { { environment: 'fooenv' } }
+
+      it "prefers the passed environment to the config env" do
+        expect_any_instance_of(Airbrake::SyncSender).to receive(:send).with(
+          { environment: 'barenv' },
+          instance_of(Airbrake::Promise),
+          URI('https://api.airbrake.io/api/v4/projects/1/deploys')
+        )
+        subject.notify(environment: 'barenv')
+      end
+    end
+
+    context "when environment is not configured" do
+      let(:params) { { environment: 'fooenv' } }
+
+      it "sets the environment from the config" do
+        expect_any_instance_of(Airbrake::SyncSender).to receive(:send).with(
+          { environment: 'fooenv' },
+          instance_of(Airbrake::Promise),
+          URI('https://api.airbrake.io/api/v4/projects/1/deploys')
+        )
+        subject.notify({})
+      end
+    end
+  end
+end

data/spec/file_cache.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::FileCache do
   after do
     %i[banana mango].each { |k| described_class.delete(k) }

data/spec/filter_chain_spec.rb

@@ -1,12 +1,6 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::FilterChain do
-  subject { described_class.new(config, {}) }
-
-  let(:config) { Airbrake::Config.new }
-
   let(:notice) do
-    Airbrake::Notice.new(config, AirbrakeTestError.new)
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
   end
 
   describe "#refine" do

data/spec/filters/context_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::ContextFilter do
   let(:notice) do
     Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)

data/spec/filters/dependency_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::DependencyFilter do
   let(:notice) do
     Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)

data/spec/filters/exception_attributes_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::ExceptionAttributesFilter do
   describe "#call" do
     let(:out) { StringIO.new }

data/spec/filters/gem_root_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::GemRootFilter do
   let(:notice) do
     Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
   subject { described_class.new(Logger.new(STDOUT), '.') }
 

data/spec/filters/git_repository_filter.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::GitRepositoryFilter do
   subject { described_class.new('.') }
 

data/spec/filters/git_revision_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::GitRevisionFilter do
   subject { described_class.new('root/dir') }
 

data/spec/filters/keys_blacklist_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::KeysBlacklist do
   subject { described_class.new(Logger.new('/dev/null'), patterns) }
 

data/spec/filters/keys_whitelist_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::KeysWhitelist do
   subject { described_class.new(Logger.new('/dev/null'), patterns) }
 

data/spec/filters/root_directory_filter_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Airbrake::Filters::RootDirectoryFilter do
   subject { described_class.new(root_directory) }
 

data/spec/filters/sql_filter_spec.rb

@@ -0,0 +1,219 @@
+RSpec.describe Airbrake::Filters::SqlFilter do
+  shared_examples "query filtering" do |test|
+    test[:dialects].each do |dialect|
+      it "correctly filters SQL like `#{test[:input]}' (#{dialect} dialect)" do
+        filter = described_class.new(dialect)
+        q = OpenStruct.new(query: test[:input])
+        filter.call(q)
+        expect(q.query).to eq(test[:output])
+      end
+    end
+  end
+
+  ALL_DIALECTS = %i[mysql postgres sqlite cassandra oracle].freeze
+
+  # rubocop:disable Metrics/LineLength
+  [
+    {
+      input: 'SELECT * FROM things;',
+      output: 'SELECT * FROM things;',
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT `t001`.`c2` FROM `t001` WHERE `t001`.`c2` = 'value' AND c3=\"othervalue\" LIMIT ?",
+      output: "SELECT `t001`.`c2` FROM `t001` WHERE `t001`.`c2` = ? AND c3=? LIMIT ?",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM t WHERE foo=\"bar/*\" AND baz=\"whatever */qux\"",
+      output: "SELECT * FROM t WHERE foo=? AND baz=?",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM t WHERE foo='bar/*' AND baz='whatever */qux'",
+      output: "SELECT * FROM t WHERE foo=? AND baz=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT \"t001\".\"c2\" FROM \"t001\" WHERE \"t001\".\"c2\" = 'value' AND c3=1234 LIMIT 1",
+      output: "SELECT \"t001\".\"c2\" FROM \"t001\" WHERE \"t001\".\"c2\" = ? AND c3=? LIMIT ?",
+      dialects: %i[postgres oracle]
+    }, {
+      input: "SELECT * FROM t WHERE foo=\"bar--\" AND\n  baz=\"qux--\"",
+      output: "SELECT * FROM t WHERE foo=? AND\n  baz=?",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM t WHERE foo='bar--' AND\n  baz='qux--'",
+      output: "SELECT * FROM t WHERE foo=? AND\n  baz=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM foo WHERE bar='baz' /* Hide Me */",
+      output: "SELECT * FROM foo WHERE bar=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM foobar WHERE password='hunter2'\n-- No peeking!",
+      output: "SELECT * FROM foobar WHERE password=?\n?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT foo, bar FROM baz WHERE password='hunter2' # Secret",
+      output: "SELECT foo, bar FROM baz WHERE password=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT \"col1\", \"col2\" from \"table\" WHERE \"col3\"=E'foo\\'bar\\\\baz' AND country=e'foo\\'bar\\\\baz'",
+      output: "SELECT \"col1\", \"col2\" from \"table\" WHERE \"col3\"=E?",
+      dialects: %i[postgres]
+    }, {
+      input: "INSERT INTO `X` values(\"test\",0, 1 , 2, 'test')",
+      output: "INSERT INTO `X` values(?,?, ? , ?, ?)",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT c11.col1, c22.col2 FROM table c11, table c22 WHERE value='nothing'",
+      output: "SELECT c11.col1, c22.col2 FROM table c11, table c22 WHERE value=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "INSERT INTO X VALUES(1, 23456, 123.456, 99+100)",
+      output: "INSERT INTO X VALUES(?, ?, ?, ?+?)",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM table WHERE name=\"foo\" AND value=\"don't\"",
+      output: "SELECT * FROM table WHERE name=? AND value=?",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM table WHERE name='foo' AND value = 'bar'",
+      output: "SELECT * FROM table WHERE name=? AND value = ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM table WHERE col='foo\\''bar'",
+      output: "SELECT * FROM table WHERE col=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM table WHERE col1='foo\"bar' AND col2='what\"ever'",
+      output: "SELECT * FROM table WHERE col1=? AND col2=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "select * from accounts where accounts.name != 'dude\n newline' order by accounts.name",
+      output: "select * from accounts where accounts.name != ? order by accounts.name",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM table WHERE col1=\"don't\" AND col2=\"won't\"",
+      output: "SELECT * FROM table WHERE col1=? AND col2=?",
+      dialects: %i[mysql]
+    }, {
+      input: "INSERT INTO X values('', 'jim''s ssn',0, 1 , 'jim''s son''s son', \"\"\"jim''s\"\" hat\", \"\\\"jim''s secret\\\"\")",
+      output: "INSERT INTO X values(?, ?,?, ? , ?, ?, ?",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM table WHERE name='foo\\' AND color='blue'",
+      output: "SELECT * FROM table WHERE name=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM table WHERE foo=\"this string ends with a backslash\\\\\"",
+      output: "SELECT * FROM table WHERE foo=?",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM table WHERE foo='this string ends with a backslash\\\\'",
+      output: "SELECT * FROM table WHERE foo=?",
+      dialects: ALL_DIALECTS
+    }, {
+      # TODO: fix this example.
+      input: "SELECT * FROM table WHERE name='foo\'' AND color='blue'",
+      output: "Error: Airbrake::Query was not filtered",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "INSERT INTO X values('', 'a''b c',0, 1 , 'd''e f''s h')",
+      output: "INSERT INTO X values(?, ?,?, ? , ?)",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM t WHERE -- '\n  bar='baz' -- '",
+      output: "SELECT * FROM t WHERE ?\n  bar=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM t WHERE /* ' */\n  bar='baz' -- '",
+      output: "SELECT * FROM t WHERE ?\n  bar=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM t WHERE -- '\n  /* ' */ c2='xxx' /* ' */\n  c='x\n  xx' -- '",
+      output: "SELECT * FROM t WHERE ?\n  ? c2=? ?\n  c=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM t WHERE -- '\n  c='x\n  xx' -- '",
+      output: "SELECT * FROM t WHERE ?\n  c=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM foo WHERE col='value1' AND /* don't */ col2='value1' /* won't */",
+      output: "SELECT * FROM foo WHERE col=? AND ? col2=? ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM table WHERE foo='bar' AND baz=\"nothing to see here'",
+      output: "Error: Airbrake::Query was not filtered",
+      dialects: %i[mysql]
+    }, {
+      input: "SELECT * FROM table WHERE foo='bar' AND baz='nothing to see here",
+      output: "Error: Airbrake::Query was not filtered",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "SELECT * FROM \"foo\" WHERE \"foo\" = $a$dollar quotes can be $b$nested$b$$a$ and bar = 'baz'",
+      output: "SELECT * FROM \"foo\" WHERE \"foo\" = ? and bar = ?",
+      dialects: %i[postgres]
+    }, {
+      input: "INSERT INTO \"foo\" (\"bar\", \"baz\", \"qux\") VALUES ($1, $2, $3) RETURNING \"id\"",
+      output: "INSERT INTO \"foo\" (\"bar\", \"baz\", \"qux\") VALUES ($?, $?, $?) RETURNING \"id\"",
+      dialects: %i[postgres]
+    }, {
+      input: "select * from foo where bar = 'some\\tthing' and baz = 10",
+      output: "select * from foo where bar = ? and baz = ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "select * from users where user = 'user1\\' password = 'hunter 2' -- ->don't count this quote",
+      output: "select * from users where user = ?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "select * from foo where bar=q'[baz's]' and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[oracle]
+    }, {
+      input: "select * from foo where bar=q'{baz's}' and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[oracle]
+    }, {
+      input: "select * from foo where bar=q'<baz's>' and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[oracle]
+    }, {
+      input: "select * from foo where bar=q'(baz's)' and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[oracle]
+    }, {
+      input: "select * from foo where bar=0xabcdef123 and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[cassandra sqlite]
+    }, {
+      input: "select * from foo where bar=0x2F and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[mysql cassandra sqlite]
+    }, {
+      input: "select * from foo where bar=1.234e-5 and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: ALL_DIALECTS
+    }, {
+      input: "select * from foo where bar=01234567-89ab-cdef-0123-456789abcdef and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[postgres cassandra]
+    }, {
+      input: "select * from foo where bar={01234567-89ab-cdef-0123-456789abcdef} and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[postgres]
+    }, {
+      input: "select * from foo where bar=0123456789abcdef0123456789abcdef and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[postgtes]
+    }, {
+      input: "select * from foo where bar={012-345678-9abc-def012345678-9abcdef} and x=5",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[postgres]
+    }, {
+      input: "select * from foo where bar=true and x=FALSE",
+      output: "select * from foo where bar=? and x=?",
+      dialects: %i[mysql postgres cassandra sqlite]
+    }
+  ].each do |test|
+    include_examples 'query filtering', test
+  end
+  # rubocop:enable Metrics/LineLength
+end