airbrake-ruby 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 706d644022c1c9c99dc3e01584d0e405411d2159
-  data.tar.gz: 56b17f05ad9e78e0579e20a58dfbeef86e35ec54
+  metadata.gz: 0a6cbbc0e744591a711d5452e6bae85c3c261607
+  data.tar.gz: 5b35acf12d2e1f8d6fb59ce953cf93c1611953b9
 SHA512:
-  metadata.gz: 8ee8b4959b41efcc3687f16a5d6ec145644bb8b28b5e3b9fd18dbb9eb729a712708cf082b0afdd0f1ccf12b150974dda5563a535b1a3229e1d8e0ecbd7df7f8b
-  data.tar.gz: dbfbf97c9f39401e42d2cd00438616432e1acf9d87a07742c0aa7b405691debd2289b955779fa76dd5dd86f5656043538e25791af06c040100f07672d5399ad8
+  metadata.gz: 85e6610457fb10e5b7247a6fdf20e694abff4b5ab94d27484078c04b8fc0f4fdf350b8da76412e55f0348a80bdca6169cc9a97c3f5e32bbf529916e02252c7e8
+  data.tar.gz: 80a7f9beddf36c304a264edbfe2044732654f9026f6a7a82feffdba95d6859c1746cb631bd09f7400a630008794daf61f53f84ac3d9d62ea0db5b48237798a18

data/lib/airbrake-ruby.rb

@@ -26,6 +26,7 @@ require 'airbrake-ruby/filters/thread_filter'
 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/filter_chain'
 require 'airbrake-ruby/notifier'
 require 'airbrake-ruby/code_hunk'

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

@@ -0,0 +1,58 @@
+module Airbrake
+  module Filters
+    # Attaches current git revision to `context`.
+    # @api private
+    # @since v2.11.0
+    class GitRevisionFilter
+      # @return [Integer]
+      attr_reader :weight
+
+      # @return [String]
+      PREFIX = 'ref: '.freeze
+
+      # @param [String] root_directory
+      def initialize(root_directory)
+        @git_path = File.join(root_directory, '.git')
+        @weight = 116
+      end
+
+      # @macro call_filter
+      def call(notice)
+        return if notice[:context].key?(:revision)
+        return unless File.exist?(@git_path)
+
+        revision = find_revision
+        notice[:context][:revision] = revision if revision
+      end
+
+      private
+
+      def find_revision
+        head_path = File.join(@git_path, 'HEAD')
+        return unless File.exist?(head_path)
+
+        head = File.read(head_path)
+        return head unless head.start_with?(PREFIX)
+        head = head.chomp[PREFIX.size..-1]
+
+        ref_path = File.join(@git_path, head)
+        return File.read(ref_path).chomp if File.exist?(ref_path)
+
+        find_from_packed_refs(head)
+      end
+
+      def find_from_packed_refs(head)
+        packed_refs_path = File.join(@git_path, 'packed-refs')
+        return head unless File.exist?(packed_refs_path)
+
+        File.readlines(packed_refs_path).each do |line|
+          next if %w[# ^].include?(line[0])
+          next unless (parts = line.split(' ')).size == 2
+          return parts.first if parts.last == head
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/airbrake-ruby/notifier.rb

@@ -143,6 +143,7 @@ module Airbrake
       clean_bt
     end
 
+    # rubocop:disable Metrics/AbcSize
     def add_default_filters
       if (whitelist_keys = @config.whitelist_keys).any?
         @filter_chain.add_filter(
@@ -165,6 +166,11 @@ module Airbrake
       @filter_chain.add_filter(
         Airbrake::Filters::RootDirectoryFilter.new(root_directory)
       )
+
+      @filter_chain.add_filter(
+        Airbrake::Filters::GitRevisionFilter.new(root_directory)
+      )
     end
+    # rubocop:enable Metrics/AbcSize
   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 = '2.10.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.11.0'.freeze
 end

data/spec/filters/git_revision_filter_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Filters::GitRevisionFilter do
+  subject { described_class.new('root/dir') }
+
+  let(:notice) do
+    Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
+  end
+
+  context "when context/revision is defined" do
+    it "doesn't attach anything to context/revision" do
+      notice[:context][:revision] = '1.2.3'
+      subject.call(notice)
+      expect(notice[:context][:revision]).to eq('1.2.3')
+    end
+  end
+
+  context "when .git directory doesn't exist" do
+    it "doesn't attach anything to context/revision" do
+      subject.call(notice)
+      expect(notice[:context][:revision]).to be_nil
+    end
+  end
+
+  context "when .git directory exists" do
+    before do
+      expect(File).to receive(:exist?).with('root/dir/.git').and_return(true)
+    end
+
+    context "and when HEAD doesn't exist" do
+      before do
+        expect(File).to receive(:exist?).with('root/dir/.git/HEAD').and_return(false)
+      end
+
+      it "doesn't attach anything to context/revision" do
+        subject.call(notice)
+        expect(notice[:context][:revision]).to be_nil
+      end
+    end
+
+    context "and when HEAD exists" do
+      before do
+        expect(File).to receive(:exist?).with('root/dir/.git/HEAD').and_return(true)
+      end
+
+      context "and also when HEAD doesn't start with 'ref: '" do
+        before do
+          expect(File).to(
+            receive(:read).with('root/dir/.git/HEAD').and_return('refs/foo')
+          )
+        end
+
+        it "attaches the content of HEAD to context/revision" do
+          subject.call(notice)
+          expect(notice[:context][:revision]).to eq('refs/foo')
+        end
+      end
+
+      context "and also when HEAD starts with 'ref: " do
+        before do
+          expect(File).to(
+            receive(:read).with('root/dir/.git/HEAD').and_return("ref: refs/foo\n")
+          )
+        end
+
+        context "when the ref exists" do
+          before do
+            expect(File).to(
+              receive(:exist?).with('root/dir/.git/refs/foo').and_return(true)
+            )
+            expect(File).to(
+              receive(:read).with('root/dir/.git/refs/foo').and_return("d34db33f\n")
+            )
+          end
+
+          it "attaches the revision from the ref to context/revision" do
+            subject.call(notice)
+            expect(notice[:context][:revision]).to eq('d34db33f')
+          end
+        end
+
+        context "when the ref doesn't exist" do
+          before do
+            expect(File).to(
+              receive(:exist?).with('root/dir/.git/refs/foo').and_return(false)
+            )
+          end
+
+          context "and when '.git/packed-refs' exists" do
+            before do
+              expect(File).to(
+                receive(:exist?).with('root/dir/.git/packed-refs').and_return(true)
+              )
+              expect(File).to(
+                receive(:readlines).with('root/dir/.git/packed-refs').and_return(
+                  [
+                    "# pack-refs with: peeled fully-peeled\n",
+                    "ccb316eecff79c7528d1ad43e5fa165f7a44d52e refs/tags/v3.0.30\n",
+                    "^d358900f73ee5bfd6ca3a592cf23ac6e82df83c1",
+                    "d34db33f refs/foo\n"
+                  ]
+                )
+              )
+            end
+
+            it "attaches the revision from 'packed-refs' to context/revision" do
+              subject.call(notice)
+              expect(notice[:context][:revision]).to eq('d34db33f')
+            end
+          end
+
+          context "and when '.git/packed-refs' doesn't exist" do
+            before do
+              expect(File).to(
+                receive(:exist?).with('root/dir/.git/packed-refs').and_return(false)
+              )
+            end
+
+            it "attaches the content of HEAD to context/revision" do
+              subject.call(notice)
+              expect(notice[:context][:revision]).to eq('refs/foo')
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -127,6 +127,7 @@ 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_revision_filter.rb
 - lib/airbrake-ruby/filters/keys_blacklist.rb
 - lib/airbrake-ruby/filters/keys_filter.rb
 - lib/airbrake-ruby/filters/keys_whitelist.rb
@@ -153,6 +154,7 @@ files:
 - spec/filters/dependency_filter_spec.rb
 - spec/filters/exception_attributes_filter_spec.rb
 - spec/filters/gem_root_filter_spec.rb
+- spec/filters/git_revision_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/keys_whitelist_spec.rb
 - spec/filters/root_directory_filter_spec.rb
@@ -208,6 +210,7 @@ test_files:
 - spec/filters/thread_filter_spec.rb
 - spec/filters/dependency_filter_spec.rb
 - spec/filters/context_filter_spec.rb
+- spec/filters/git_revision_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
 - spec/filters/gem_root_filter_spec.rb
 - spec/spec_helper.rb