airbrake-ruby 4.8.0 → 5.2.0

data/spec/filters/{keys_blacklist_spec.rb → keys_blocklist_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Airbrake::Filters::KeysBlacklist do
+RSpec.describe Airbrake::Filters::KeysBlocklist do
   subject { described_class.new(patterns) }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
@@ -19,8 +19,8 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       [/\Abon/],
       [
         { bongo: 'bango' },
-        { bongo: '[Filtered]' }
-      ]
+        { bongo: '[Filtered]' },
+      ],
     )
 
     context "and when a key is a hash" do
@@ -40,8 +40,8 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       [:bingo],
       [
         { bingo: 'bango' },
-        { bingo: '[Filtered]' }
-      ]
+        { bingo: '[Filtered]' },
+      ],
     )
   end
 
@@ -51,8 +51,8 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       ['bingo'],
       [
         { bingo: 'bango' },
-        { bingo: '[Filtered]' }
-      ]
+        { bingo: '[Filtered]' },
+      ],
     )
   end
 
@@ -62,8 +62,8 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       ['bingo'],
       [
         { array: [{ bingo: 'bango' }, []] },
-        { array: [{ bingo: '[Filtered]' }, []] }
-      ]
+        { array: [{ bingo: '[Filtered]' }, []] },
+      ],
     )
   end
 
@@ -74,8 +74,8 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
         [proc { 'bongo' }, :bash],
         [
           { bingo: 'bango', bongo: 'bish', bash: 'bosh' },
-          { bingo: 'bango', bongo: '[Filtered]', bash: '[Filtered]' }
-        ]
+          { bingo: 'bango', bongo: '[Filtered]', bash: '[Filtered]' },
+        ],
       )
     end
 
@@ -85,16 +85,16 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
         [proc { Object.new }],
         [
           { bingo: 'bango', bongo: 'bish' },
-          { bingo: 'bango', bongo: 'bish' }
-        ]
+          { bingo: 'bango', bongo: 'bish' },
+        ],
       )
 
       it "logs an error" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /KeysBlacklist is invalid.+patterns: \[#<Object:.+>\]/
+          /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
         )
-        keys_blacklist = described_class.new(patterns)
-        keys_blacklist.call(notice)
+        keys_blocklist = described_class.new(patterns)
+        keys_blocklist.call(notice)
       end
     end
 
@@ -104,10 +104,10 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       context "and when the filter is called once" do
         it "logs an error" do
           expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /KeysBlacklist is invalid.+patterns: \[#<Proc:.+>\]/
+            /KeysBlocklist is invalid.+patterns: \[#<Proc:.+>\]/,
           )
-          keys_blacklist = described_class.new(patterns)
-          keys_blacklist.call(notice)
+          keys_blocklist = described_class.new(patterns)
+          keys_blocklist.call(notice)
         end
       end
 
@@ -127,16 +127,16 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       [Object.new],
       [
         { bingo: 'bango', bongo: 'bish' },
-        { bingo: 'bango', bongo: 'bish' }
-      ]
+        { bingo: 'bango', bongo: 'bish' },
+      ],
     )
 
     it "logs an error" do
       expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /KeysBlacklist is invalid.+patterns: \[#<Object:.+>\]/
+        /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
       )
-      keys_blacklist = described_class.new(patterns)
-      keys_blacklist.call(notice)
+      keys_blocklist = described_class.new(patterns)
+      keys_blocklist.call(notice)
     end
   end
 
@@ -147,9 +147,19 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
         ['bish'],
         [
           { bongo: { bish: 'bash' } },
-          { bongo: { bish: '[Filtered]' } }
-        ]
+          { bongo: { bish: '[Filtered]' } },
+        ],
       )
+
+      it "doesn't mutate the original hash" do
+        params = { bongo: { bish: 'bash' } }
+        notice[:params] = params
+
+        blocklist = described_class.new([:bish])
+        blocklist.call(notice)
+
+        expect(params[:bongo][:bish]).to eq('bash')
+      end
     end
 
     context "and it is recursive" do
@@ -161,8 +171,8 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
         ['bango'],
         [
           bongo,
-          { bingo: { bango: '[Filtered]' } }
-        ]
+          { bingo: { bango: '[Filtered]' } },
+        ],
       )
     end
   end
@@ -177,7 +187,7 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
 
         subject.call(notice)
         expect(notice[:context][:url]).to(
-          eq 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=[Filtered]&color=%23FFAAFF'
+          eq('http://localhost:3000/crash?foo=bar&baz=bongo&bish=[Filtered]&color=%23FFAAFF'),
         )
       end
     end

data/spec/filters/root_directory_filter_spec.rb

@@ -5,35 +5,35 @@ RSpec.describe Airbrake::Filters::RootDirectoryFilter do
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
 
   it "replaces root directory in the backtrace with a label" do
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     notice[:errors].first[:backtrace] = [
       { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
       { file: "#{root_directory}/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb " },
       { file: "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb" },
-      { file: "#{root_directory}/gems/rspec-core-3.3.2/exe/rspec" }
+      { file: "#{root_directory}/gems/rspec-core-3.3.2/exe/rspec" },
     ]
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
     subject.call(notice)
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     expect(notice[:errors].first[:backtrace]).to(
       eq(
         [
           { file: "/home/kyrylo/code/airbrake/ruby/spec/spec_helper.rb" },
           { file: "/PROJECT_ROOT/gems/rspec-core-3.3.2/lib/rspec/core/configuration.rb " },
           { file: "/opt/rubies/ruby-2.2.2/lib/ruby/2.2.0/rubygems/core_ext/kernel_require.rb" },
-          { file: "/PROJECT_ROOT/gems/rspec-core-3.3.2/exe/rspec" }
-        ]
-      )
+          { file: "/PROJECT_ROOT/gems/rspec-core-3.3.2/exe/rspec" },
+        ],
+      ),
     )
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
   end
 
   it "does not filter file when it is nil" do
     expect(notice[:errors].first[:file]).to be_nil
     expect { subject.call(notice) }.not_to(
-      change { notice[:errors].first[:file] }
+      change { notice[:errors].first[:file] },
     )
   end
 end

data/spec/filters/sql_filter_spec.rb

@@ -10,12 +10,10 @@ RSpec.describe Airbrake::Filters::SqlFilter do
     end
   end
 
-  shared_examples "query blacklisting" do |query, opts|
+  shared_examples "query blocklisting" do |query, opts|
     it "ignores '#{query}'" do
       filter = described_class.new('postgres')
-      q = Airbrake::Query.new(
-        query: query, method: 'GET', route: '/', start_time: Time.now
-      )
+      q = Airbrake::Query.new(query: query, method: 'GET', route: '/', timing: 1)
       filter.call(q)
 
       expect(q.ignored?).to eq(opts[:should_ignore])
@@ -24,214 +22,214 @@ RSpec.describe Airbrake::Filters::SqlFilter do
 
   ALL_DIALECTS = %i[mysql postgres sqlite cassandra oracle].freeze
 
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   [
     {
       input: 'SELECT * FROM things;',
       output: 'SELECT * FROM things;',
-      dialects: ALL_DIALECTS
+      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]
+      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]
+      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
+      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]
+      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]
+      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
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM foo WHERE bar='baz' /* Hide Me */",
       output: "SELECT * FROM foo WHERE bar=? ?",
-      dialects: ALL_DIALECTS
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM foobar WHERE password='hunter2'\n-- No peeking!",
       output: "SELECT * FROM foobar WHERE password=?\n?",
-      dialects: ALL_DIALECTS
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT foo, bar FROM baz WHERE password='hunter2' # Secret",
       output: "SELECT foo, bar FROM baz WHERE password=? ?",
-      dialects: ALL_DIALECTS
+      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]
+      dialects: %i[postgres],
     }, {
       input: "INSERT INTO `X` values(\"test\",0, 1 , 2, 'test')",
       output: "INSERT INTO `X` values(?)",
-      dialects: %i[mysql]
+      dialects: %i[mysql],
     }, {
       input: "INSERT INTO `X` values(\"test\",0, 1 , 2, 'test')",
       output: "INSERT INTO `X` values(?)",
-      dialects: %i[mysql]
+      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
+      dialects: ALL_DIALECTS,
     }, {
       input: "INSERT INTO X VALUES(1, 23456, 123.456, 99+100)",
       output: "INSERT INTO X VALUES(?)",
-      dialects: ALL_DIALECTS
+      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]
+      dialects: %i[mysql],
     }, {
       input: "SELECT * FROM table WHERE name='foo' AND value = 'bar'",
       output: "SELECT * FROM table WHERE name=? AND value = ?",
-      dialects: ALL_DIALECTS
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM table WHERE col='foo\\''bar'",
       output: "SELECT * FROM table WHERE col=?",
-      dialects: ALL_DIALECTS
+      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
+      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
+      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]
+      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]
+      dialects: %i[mysql],
     }, {
       input: "SELECT * FROM table WHERE name='foo\\' AND color='blue'",
       output: "SELECT * FROM table WHERE name=?",
-      dialects: ALL_DIALECTS
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM table WHERE foo=\"this string ends with a backslash\\\\\"",
       output: "SELECT * FROM table WHERE foo=?",
-      dialects: %i[mysql]
+      dialects: %i[mysql],
     }, {
       input: "SELECT * FROM table WHERE foo='this string ends with a backslash\\\\'",
       output: "SELECT * FROM table WHERE foo=?",
-      dialects: ALL_DIALECTS
+      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
+      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
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM t WHERE -- '\n  bar='baz' -- '",
       output: "SELECT * FROM t WHERE ?\n  bar=? ?",
-      dialects: ALL_DIALECTS
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM t WHERE /* ' */\n  bar='baz' -- '",
       output: "SELECT * FROM t WHERE ?\n  bar=? ?",
-      dialects: ALL_DIALECTS
+      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
+      dialects: ALL_DIALECTS,
     }, {
       input: "SELECT * FROM t WHERE -- '\n  c='x\n  xx' -- '",
       output: "SELECT * FROM t WHERE ?\n  c=? ?",
-      dialects: ALL_DIALECTS
+      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
+      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]
+      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
+      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]
+      dialects: %i[postgres],
     }, {
       input: "INSERT INTO \"foo\" (\"bar\", \"baz\", \"qux\") VALUES ($1, $2, $3) RETURNING \"id\"",
       output: "INSERT INTO \"foo\" (?) RETURNING \"id\"",
-      dialects: %i[postgres]
+      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
+      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
+      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]
+      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]
+      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]
+      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]
+      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]
+      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]
+      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
+      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]
+      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]
+      dialects: %i[postgres],
     }, {
       input: "select * from foo where bar=0123456789abcdef0123456789abcdef and x=5",
       output: "select * from foo where bar=? and x=?",
-      dialects: %i[postgtes]
+      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]
+      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]
+      dialects: %i[mysql postgres cassandra sqlite],
     }
   ].each do |test|
     include_examples 'query filtering', test
   end
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
 
   [
     'COMMIT',
@@ -263,14 +261,14 @@ RSpec.describe Airbrake::Filters::SqlFilter do
     'oid = rngtypid WHERE t.typname IN (?) OR t.typtype IN (?) OR t.typinput ' \
     '= ?::regprocedure OR t.typelem != ?',
 
-    'SELECT t.oid, t.typname FROM pg_type as t WHERE t.typname IN (?)'
+    'SELECT t.oid, t.typname FROM pg_type as t WHERE t.typname IN (?)',
   ].each do |query|
-    include_examples 'query blacklisting', query, should_ignore: true
+    include_examples 'query blocklisting', query, should_ignore: true
   end
 
   [
-    'UPDATE "users" SET "last_sign_in_at" = ? WHERE "users"."id" = ?'
+    'UPDATE "users" SET "last_sign_in_at" = ? WHERE "users"."id" = ?',
   ].each do |query|
-    include_examples 'query blacklisting', query, should_ignore: false
+    include_examples 'query blocklisting', query, should_ignore: false
   end
 end