airbrake-ruby 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a6cbbc0e744591a711d5452e6bae85c3c261607
-  data.tar.gz: 5b35acf12d2e1f8d6fb59ce953cf93c1611953b9
+  metadata.gz: 3f92ef10b01c37b9374a6662bedba21c1593ef34
+  data.tar.gz: 957da6a830307c3d3cd9f583f1eaa9bf4a2df96f
 SHA512:
-  metadata.gz: 85e6610457fb10e5b7247a6fdf20e694abff4b5ab94d27484078c04b8fc0f4fdf350b8da76412e55f0348a80bdca6169cc9a97c3f5e32bbf529916e02252c7e8
-  data.tar.gz: 80a7f9beddf36c304a264edbfe2044732654f9026f6a7a82feffdba95d6859c1746cb631bd09f7400a630008794daf61f53f84ac3d9d62ea0db5b48237798a18
+  metadata.gz: b0ca6c8f84dfc39758f22203519765820a25c4bddd8e7aae90928d46b1f201ee7ab283679fdc16020043cd222c3a6f3e09def0642d1428d005b3022b8dfc59ee
+  data.tar.gz: 46f263d46199864c89c70c721ecb1c50f13262a13b9b3603b31260cd0f6ea44536fa2ceb419b3efaee1bd82b7877f53246c754288f433054c43ca3b0af3bba58

data/lib/airbrake-ruby.rb

@@ -27,6 +27,8 @@ require 'airbrake-ruby/filters/context_filter'
 require 'airbrake-ruby/filters/exception_attributes_filter'
 require 'airbrake-ruby/filters/dependency_filter'
 require 'airbrake-ruby/filters/git_revision_filter'
+require 'airbrake-ruby/filters/git_repository_filter'
+require 'airbrake-ruby/filters/git_last_checkout_filter'
 require 'airbrake-ruby/filter_chain'
 require 'airbrake-ruby/notifier'
 require 'airbrake-ruby/code_hunk'

data/lib/airbrake-ruby/config.rb

@@ -98,7 +98,7 @@ module Airbrake
 
       self.project_id = user_config[:project_id]
       self.project_key = user_config[:project_key]
-      self.host = 'https://airbrake.io'
+      self.host = 'https://api.airbrake.io'
 
       self.ignore_environments = []
 

data/lib/airbrake-ruby/filters/git_last_checkout_filter.rb

@@ -0,0 +1,88 @@
+module Airbrake
+  module Filters
+    # Attaches git checkout info to `context`. The info includes:
+    #   * username
+    #   * email
+    #   * revision
+    #   * time
+    #
+    # This information is used to track deploys automatically.
+    #
+    # @api private
+    # @since v2.12.0
+    class GitLastCheckoutFilter
+      # @return [Integer]
+      attr_reader :weight
+
+      # @return [Integer] least possible amount of columns in git's `logs/HEAD`
+      #   file (checkout information is omitted)
+      MIN_HEAD_COLS = 6
+
+      # @param [Logger] logger
+      # @param [String] root_directory
+      def initialize(logger, root_directory)
+        @git_path = File.join(root_directory, '.git')
+        @logger = logger
+        @weight = 116
+        @last_checkout = nil
+      end
+
+      # @macro call_filter
+      def call(notice)
+        return if notice[:context].key?(:lastCheckout)
+
+        if @last_checkout
+          notice[:context][:lastCheckout] = @last_checkout
+          return
+        end
+
+        return unless File.exist?(@git_path)
+        return unless (checkout = last_checkout)
+        notice[:context][:lastCheckout] = checkout
+      end
+
+      private
+
+      def last_checkout
+        return unless (line = last_checkout_line)
+
+        parts = line.chomp.split("\t").first.split(' ')
+        if parts.size < MIN_HEAD_COLS
+          @logger.error(
+            "#{LOG_LABEL} Airbrake::#{self.class.name}: can't parse line: #{line}"
+          )
+          return
+        end
+
+        author = parts[2..-4]
+        @last_checkout = {
+          username: author[0..1].join(' '),
+          email: parts[-3][1..-2],
+          revision: parts[1],
+          time: timestamp(parts[-2].to_i)
+        }
+      end
+
+      def last_checkout_line
+        head_path = File.join(@git_path, 'logs', 'HEAD')
+        return unless File.exist?(head_path)
+
+        last_line = nil
+        IO.foreach(head_path) do |line|
+          last_line = line if checkout_line?(line)
+        end
+        last_line
+      end
+
+      def checkout_line?(line)
+        line.include?("\tclone:") ||
+          line.include?("\tpull:") ||
+          line.include?("\tcheckout:")
+      end
+
+      def timestamp(utime)
+        Time.at(utime).to_datetime.rfc3339
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/filters/git_repository_filter.rb

@@ -0,0 +1,34 @@
+module Airbrake
+  module Filters
+    # Attaches git repository URL to `context`.
+    # @api private
+    # @since v2.12.0
+    class GitRepositoryFilter
+      # @return [Integer]
+      attr_reader :weight
+
+      # @param [String] root_directory
+      def initialize(root_directory)
+        @git_path = File.join(root_directory, '.git')
+        @repository = nil
+        @weight = 116
+      end
+
+      # @macro call_filter
+      def call(notice)
+        return if notice[:context].key?(:repository)
+
+        if @repository
+          notice[:context][:repository] = @repository
+          return
+        end
+
+        return unless File.exist?(@git_path)
+
+        @repository = `cd #{@git_path} && git remote get-url origin`.chomp
+        return unless @repository
+        notice[:context][:repository] = @repository
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/filters/git_revision_filter.rb

@@ -13,16 +13,24 @@ module Airbrake
       # @param [String] root_directory
       def initialize(root_directory)
         @git_path = File.join(root_directory, '.git')
+        @revision = nil
         @weight = 116
       end
 
       # @macro call_filter
       def call(notice)
         return if notice[:context].key?(:revision)
+
+        if @revision
+          notice[:context][:revision] = @revision
+          return
+        end
+
         return unless File.exist?(@git_path)
 
-        revision = find_revision
-        notice[:context][:revision] = revision if revision
+        @revision = find_revision
+        return unless @revision
+        notice[:context][:revision] = @revision
       end
 
       private

data/lib/airbrake-ruby/notifier.rb

@@ -76,9 +76,12 @@ module Airbrake
     # @macro see_public_api_method
     def create_deploy(deploy_params)
       deploy_params[:environment] ||= @config.environment
-      path = "api/v4/projects/#{@config.project_id}/deploys?key=#{@config.project_key}"
       promise = Airbrake::Promise.new
-      @sync_sender.send(deploy_params, promise, URI.join(@config.host, path))
+      @sync_sender.send(
+        deploy_params,
+        promise,
+        URI.join(@config.host, "api/v4/projects/#{@config.project_id}/deploys")
+      )
       promise
     end
 
@@ -115,8 +118,8 @@ module Airbrake
       end
 
       notice = build_notice(exception, params)
+      yield notice if block_given?
       @filter_chain.refine(notice)
-      yield notice if block_given? && !notice.ignored?
 
       return promise.reject("#{notice} was marked as ignored") if notice.ignored?
 
@@ -163,12 +166,16 @@ module Airbrake
       )
 
       return unless (root_directory = @config.root_directory)
-      @filter_chain.add_filter(
-        Airbrake::Filters::RootDirectoryFilter.new(root_directory)
-      )
+      [
+        Airbrake::Filters::RootDirectoryFilter,
+        Airbrake::Filters::GitRevisionFilter,
+        Airbrake::Filters::GitRepositoryFilter
+      ].each do |filter|
+        @filter_chain.add_filter(filter.new(root_directory))
+      end
 
       @filter_chain.add_filter(
-        Airbrake::Filters::GitRevisionFilter.new(root_directory)
+        Airbrake::Filters::GitLastCheckoutFilter.new(@config.logger, root_directory)
       )
     end
     # rubocop:enable Metrics/AbcSize

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 = '2.11.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.12.0'.freeze
 end

data/spec/config_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe Airbrake::Config do
       end
 
       it "sets the default host" do
-        expect(config.host).to eq('https://airbrake.io')
+        expect(config.host).to eq('https://api.airbrake.io')
       end
 
       it "sets the default endpoint" do

data/spec/filters/git_last_checkout_filter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Filters::GitLastCheckoutFilter do
+  subject { described_class.new(Logger.new(STDOUT), '.') }
+
+  let(:notice) do
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+  end
+
+  context "when context/lastCheckout is defined" do
+    it "doesn't attach anything to context/lastCheckout" do
+      notice[:context][:lastCheckout] = '123'
+      subject.call(notice)
+      expect(notice[:context][:lastCheckout]).to eq('123')
+    end
+  end
+
+  context "when .git directory doesn't exist" do
+    subject { described_class.new(Logger.new(STDOUT), 'root/dir') }
+
+    it "doesn't attach anything to context/lastCheckout" do
+      subject.call(notice)
+      expect(notice[:context][:lastCheckout]).to be_nil
+    end
+  end
+
+  context "when .git directory exists" do
+    before { subject.call(notice) }
+
+    it "attaches last checkouted username" do
+      expect(notice[:context][:lastCheckout][:username]).not_to be_empty
+    end
+
+    it "attaches last checkouted email" do
+      expect(notice[:context][:lastCheckout][:email]).to match(/\A\w+@\w+\.?\w+?\z/)
+    end
+
+    it "attaches last checkouted revision" do
+      expect(notice[:context][:lastCheckout][:revision]).not_to be_empty
+      expect(notice[:context][:lastCheckout][:revision].size).to eq(40)
+    end
+
+    it "attaches last checkouted time" do
+      expect(notice[:context][:lastCheckout][:time]).not_to be_empty
+      expect(notice[:context][:lastCheckout][:time].size).to eq(25)
+    end
+  end
+end

data/spec/filters/git_repository_filter.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Filters::GitRepositoryFilter do
+  subject { described_class.new('.') }
+
+  let(:notice) do
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+  end
+
+  context "when context/repository is defined" do
+    it "doesn't attach anything to context/repository" do
+      notice[:context][:repository] = 'git@github.com:kyrylo/test.git'
+      subject.call(notice)
+      expect(notice[:context][:repository]).to eq('git@github.com:kyrylo/test.git')
+    end
+  end
+
+  context "when .git directory doesn't exist" do
+    subject { described_class.new('root/dir') }
+
+    it "doesn't attach anything to context/repository" do
+      subject.call(notice)
+      expect(notice[:context][:repository]).to be_nil
+    end
+  end
+
+  context "when .git directory exists" do
+    it "attaches context/repository" do
+      subject.call(notice)
+      expect(notice[:context][:repository]).to eq(
+        'ssh://git@github.com/airbrake/airbrake-ruby.git'
+      )
+    end
+  end
+end

data/spec/notifier_spec.rb

@@ -95,7 +95,7 @@ RSpec.describe Airbrake::Notifier do
   end
 
   describe "#notify" do
-    let(:endpoint) { 'https://airbrake.io/api/v3/projects/1/notices' }
+    let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/1/notices' }
 
     subject { described_class.new(user_params) }
 
@@ -129,12 +129,12 @@ RSpec.describe Airbrake::Notifier do
       end
     end
 
-    context "when a notice is ignored" do
+    context "when a notice is ignored via a filter" do
       before { subject.add_filter(&:ignore!) }
 
-      it "doesn't yield the notice" do
+      it "yields the notice" do
         expect { |b| subject.notify('ex', &b) }
-          .not_to yield_with_args(Airbrake::Notice)
+          .to yield_with_args(Airbrake::Notice)
       end
 
       it "returns a rejected promise" do
@@ -143,6 +143,14 @@ RSpec.describe Airbrake::Notifier do
       end
     end
 
+    context "when a notice is ignored via an inline filter" do
+      before { subject.add_filter { raise AirbrakeTestError } }
+
+      it "doesn't invoke regular filters" do
+        expect { subject.notify('ex', &:ignore!) }.not_to raise_error
+      end
+    end
+
     context "when async sender has workers" do
       it "sends an exception asynchronously" do
         expect_any_instance_of(Airbrake::AsyncSender).to receive(:send)
@@ -179,7 +187,7 @@ RSpec.describe Airbrake::Notifier do
   end
 
   describe "#notify_sync" do
-    let(:endpoint) { 'https://airbrake.io/api/v3/projects/1/notices' }
+    let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/1/notices' }
 
     let(:user_params) do
       { project_id: 1, project_key: 'abc', logger: Logger.new('/dev/null') }
@@ -221,12 +229,12 @@ RSpec.describe Airbrake::Notifier do
       end
     end
 
-    context "when a notice is ignored" do
+    context "when a notice is ignored via a filter" do
       before { subject.add_filter(&:ignore!) }
 
-      it "doesn't yield the notice" do
+      it "yields the notice" do
         expect { |b| subject.notify_sync('ex', &b) }
-          .not_to yield_with_args(Airbrake::Notice)
+          .to yield_with_args(Airbrake::Notice)
       end
 
       it "returns an error hash" do
@@ -235,6 +243,14 @@ RSpec.describe Airbrake::Notifier do
       end
     end
 
+    context "when a notice is ignored via an inline filter" do
+      before { subject.add_filter { raise AirbrakeTestError } }
+
+      it "doesn't invoke regular filters" do
+        expect { subject.notify('ex', &:ignore!) }.not_to raise_error
+      end
+    end
+
     context "when the provided environment is ignored" do
       subject do
         described_class.new(
@@ -393,7 +409,7 @@ RSpec.describe Airbrake::Notifier do
 
   describe "#create_deploy" do
     it "returns a promise" do
-      stub_request(:post, "https://airbrake.io/api/v4/projects/1/deploys?key=abc")
+      stub_request(:post, 'https://api.airbrake.io/api/v4/projects/1/deploys')
         .to_return(status: 201, body: '')
       expect(subject.create_deploy({})).to be_an(Airbrake::Promise)
     end
@@ -403,7 +419,7 @@ RSpec.describe Airbrake::Notifier do
         expect_any_instance_of(Airbrake::SyncSender).to receive(:send).with(
           { environment: 'barenv' },
           instance_of(Airbrake::Promise),
-          URI('https://airbrake.io/api/v4/projects/1/deploys?key=abc')
+          URI('https://api.airbrake.io/api/v4/projects/1/deploys')
         )
         described_class.new(
           user_params.merge(environment: 'fooenv')
@@ -416,7 +432,7 @@ RSpec.describe Airbrake::Notifier do
         expect_any_instance_of(Airbrake::SyncSender).to receive(:send).with(
           { environment: 'fooenv' },
           instance_of(Airbrake::Promise),
-          URI('https://airbrake.io/api/v4/projects/1/deploys?key=abc')
+          URI('https://api.airbrake.io/api/v4/projects/1/deploys')
         )
         subject.create_deploy(environment: 'fooenv')
       end

data/spec/notifier_spec/options_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Airbrake::Notifier do
   let(:localhost) { 'http://localhost:8080' }
 
   let(:endpoint) do
-    "https://airbrake.io/api/v3/projects/#{project_id}/notices"
+    "https://api.airbrake.io/api/v3/projects/#{project_id}/notices"
   end
 
   let(:airbrake_params) do

data/spec/sync_sender_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Airbrake::SyncSender do
 
     let(:sender) { described_class.new(config) }
     let(:notice) { Airbrake::Notice.new(config, AirbrakeTestError.new) }
-    let(:endpoint) { 'https://airbrake.io/api/v3/projects/1/notices' }
+    let(:endpoint) { 'https://api.airbrake.io/api/v3/projects/1/notices' }
 
     before { stub_request(:post, endpoint).to_return(body: '{}') }
 
@@ -90,7 +90,7 @@ RSpec.describe Airbrake::SyncSender do
     end
 
     context "when IP is rate limited" do
-      let(:endpoint) { %r{https://airbrake.io/api/v3/projects/1/notices} }
+      let(:endpoint) { %r{https://api.airbrake.io/api/v3/projects/1/notices} }
 
       before do
         stub_request(:post, endpoint).to_return(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.12.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -127,6 +127,8 @@ files:
 - lib/airbrake-ruby/filters/dependency_filter.rb
 - lib/airbrake-ruby/filters/exception_attributes_filter.rb
 - lib/airbrake-ruby/filters/gem_root_filter.rb
+- lib/airbrake-ruby/filters/git_last_checkout_filter.rb
+- lib/airbrake-ruby/filters/git_repository_filter.rb
 - lib/airbrake-ruby/filters/git_revision_filter.rb
 - lib/airbrake-ruby/filters/keys_blacklist.rb
 - lib/airbrake-ruby/filters/keys_filter.rb
@@ -154,6 +156,8 @@ files:
 - spec/filters/dependency_filter_spec.rb
 - spec/filters/exception_attributes_filter_spec.rb
 - spec/filters/gem_root_filter_spec.rb
+- spec/filters/git_last_checkout_filter_spec.rb
+- spec/filters/git_repository_filter.rb
 - spec/filters/git_revision_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/keys_whitelist_spec.rb
@@ -210,9 +214,11 @@ test_files:
 - spec/filters/thread_filter_spec.rb
 - spec/filters/dependency_filter_spec.rb
 - spec/filters/context_filter_spec.rb
+- spec/filters/git_last_checkout_filter_spec.rb
 - spec/filters/git_revision_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/gem_root_filter_spec.rb
+- spec/filters/git_repository_filter.rb
 - spec/spec_helper.rb
 - spec/notice_spec.rb
 - spec/config_spec.rb