redmine_airbrake_backend 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a675ca6c57b6334a15a7f53bcfffc8e6ce4a75bedb9f562eda35cfec2741744b
-  data.tar.gz: 825e1ed47ea45f1e2c186fd3c0f014bda2fd8ad1803048858dd2742b1989ce19
+  metadata.gz: e94a784058235695f5420da63caf59103aadd0e2f9479dc7ad6da0619b296035
+  data.tar.gz: 8dfb3a85f877301c7507c8066000d0e5677cb8df86d937243c55fce9963ba9d4
 SHA512:
-  metadata.gz: f65356a879aa32b8e0d60244181e43a76e5ce34f6f2d5819e63f9522e3e346ff8535ae2add2919fa96c9ecd95af43d229e53b656f93611564e4be6ed92793b15
-  data.tar.gz: b8ac9d2f823e7e484d4c5ff4b29cfd6fcf7aa34b616297f08957b518ba804a01a2fffcd2a6e3bde95cd108d1d66e5db6972583a5171383de5048b6d634895ebc
+  metadata.gz: 56af38387d929c822fe89205f77a05590ebc6e9bd4a7354791548821edff783b252bb0a7f5846b2116163a21c5afd35a98fe251b335d6c700cbaadf97f7b5f84
+  data.tar.gz: e53f9f81f788630b003c6fa2f1cd4c6cb135c22b2f9578f40a22f3091d97ec595439c003faaf6023aa14a0df1bd1503f5788ce4f23d50a7a1e96c1f76f87c645

data/.gitlab-ci.yml

@@ -6,7 +6,7 @@ stages:
 
 build:
   stage: build
-  image: ruby:2.5
+  image: ruby:2.6
   script:
     - gem install bundler --no-document
     - bundle update
@@ -16,7 +16,7 @@ build:
 
 test:
   stage: test
-  image: ruby:2.5
+  image: ruby:2.6
   script:
     - gem install bundler --no-document
     - bundle update
@@ -24,9 +24,9 @@ test:
 
 rubocop:
   stage: codequality
-  image: ruby:2.5
+  image: ruby:2.6
   script:
-    - gem install rubocop --no-document
+    - gem install rubocop rubocop-performance rubocop-rails --no-document
     - rubocop
 
 dependency_scanning:

data/.rubocop.yml

@@ -1,3 +1,7 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
+
 AllCops:
   TargetRubyVersion: 2.4
   Exclude:

data/CHANGELOG.md

@@ -1,75 +1,87 @@
 # Changelog
+All notable changes to this project will be documented in this file.
 
-## 1.3.0 (2019-02-11)
-### Changes
-  - Redmine 4.0 / Rails 5.0 compatibility
-
-## 1.2.4 (2019-01-30)
-### Fixes
-  - Require Rake::TestTask to avoid error with Redmine >= 4.0.0
-
-## 1.2.3 (2019-01-27)
-### Fixes
-  - Fix reopen of issues
-
-## 1.2.2 (2018-11-03)
-### Fixes
-  - Fix finding repository if no filename is for backtrace element
-### Changes
-  - Internal restructuring for better code style
-  - Requires Ruby >= 2.4.0
-  - Requires Redmine >= 3.4.0
-
-## 1.2.1 (2018-01-29)
-### Features
-  - All responses are formatted as JSON
-
-## 1.2.0 (2018-01-17)
-### Features
-  - Support airbrake token based authentication
-
-## 1.1.2 (2017-12-12)
-### Fixes
-  - Prevent rendering of empty sections
-  - Handle notices without a backtrace
-
-## 1.1.1 (2016-05-18)
-### Fixes
-  - Add missing foreign_key option on issue category has many relation. Caused error on removing issue category
-
-## 1.1.0 (2016-01-29)
-### Fixes
-  - Handle new ruby lambda backtrace syntax
-  - Don't treat nested errors separately
-
-## 1.0.3 (2016-01-26)
-### Fixes
-  - Fix syntax error
-
-## 1.0.2 (2016-01-26)
-### Fixes
-  - Wrong status code for response
-
-## 1.0.1 (2016-01-25)
-### Fixes
-  - Add space to comma separated key-value list in description tables
-  - Exclude notifier information from context table
-
-## 1.0.0 (2016-01-23)
-### Changes
-  - Add support for new v3 JSON notices
-  - Add support for new v3 JSON iOS reports
-  - Dropped support for old notices and reports APIs
-  - Add permission to use Airbrake API. No longer bound to issue create permission
-  - Added new key *column* in backtrace to ID calculation
-  - Require Redmine >= 3.2.0
-  - Show hashes in table sections (no recursion)
-
-## 0.6.1 (2015-04-28)
-### Fixes
-  - Usage as Redmine plugin additional to gem
-
-## 0.6.0 (2015-04-22)
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.4.0] - 2019-08-26
+### Fixed
+- Mapping of backtrace elements to repository entries
+### Changed
+- Respect new rubocop suggestions
+
+## [1.3.0] - 2019-02-11
+### Changed
+- Redmine 4.0 / Rails 5.0 compatibility
+
+## [1.2.4] - 2019-01-30
+### Fixed
+- Require Rake::TestTask to avoid error with Redmine >= 4.0.0
+
+## [1.2.3] - 2019-01-27
+### Fixed
+- Fix reopen of issues
+
+## [1.2.2] - 2018-11-03
+### Fixed
+- Fix finding repository if no filename is for backtrace element
+### Changed
+- Internal restructuring for better code style
+- Requires Ruby >= 2.4.0
+- Requires Redmine >= 3.4.0
+
+## [1.2.1] - 2018-01-29
+### Added
+- All responses are formatted as JSON
+
+## [1.2.0] - 2018-01-17
+### Added
+- Support airbrake token based authentication
+
+## [1.1.2] - 2017-12-12
+### Fixed
+- Prevent rendering of empty sections
+- Handle notices without a backtrace
+
+## [1.1.1] - 2016-05-18
+### Fixed
+- Add missing foreign_key option on issue category has many relation. Caused error on removing issue category
+
+## [1.1.0] - 2016-01-29
+### Fixed
+- Handle new ruby lambda backtrace syntax
+- Don't treat nested errors separately
+
+## [1.0.3] - 2016-01-26
+### Fixed
+- Fix syntax error
+
+## [1.0.2] - 2016-01-26
+### Fixed
+- Wrong status code for response
+
+## [1.0.1] - 2016-01-25
+### Fixed
+- Add space to comma separated key-value list in description tables
+- Exclude notifier information from context table
+
+## [1.0.0] - 2016-01-23
+### Changed
+- Add support for new v3 JSON notices
+- Add support for new v3 JSON iOS reports
+- Dropped support for old notices and reports APIs
+- Add permission to use Airbrake API. No longer bound to issue create permission
+- Added new key *column* in backtrace to ID calculation
+- Require Redmine >= 3.2.0
+- Show hashes in table sections (no recursion)
+
+## [0.6.1] - 2015-04-28
+### Fixed
+- Usage as Redmine plugin additional to gem
+
+## [0.6.0] - 2015-04-22
 ### Changed
-  - Redmine 3.0.x compatibility
-  - Switched from hpricot to nokogiri for XML parsing
+- Redmine 3.0.x compatibility
+- Switched from hpricot to nokogiri for XML parsing

data/README.md

@@ -41,17 +41,18 @@ gem 'airbrake'
 And configure it, e.g. with an initializer `config/initializers/airbrake.rb`:
 ```ruby
 Airbrake.configure do |c|
-  c.project_id     = 'redmine_project_identifier'
-  c.project_key    = {
+  c.project_id = 'redmine_project_identifier'
+  c.project_key = {
       key:      'redmine_api_key', # the api key for a user which has permission to create issues in the project specified in the previous step
       tracker:  'Bug',             # the name or id of your desired tracker (optional if default is configured)
       category: 'Development',     # the name or id of a ticket category, optional
       priority: 5,                 # the name or id of the priority for new tickets, optional.
       assignee: 'admin'            # the login or id of a user the ticket should get assigned to by default, optional
     }.to_json
-  c.host           = 'https://redmine.example.com/'
+  c.host = 'https://redmine.example.com/'
   c.root_directory = Rails.root
-  c.environment    = 'production'
+  c.environment = 'production'
+  c.performance_stats = false # Performance stats are not supported
 end
 ```
 

data/app/controllers/airbrake_controller.rb

@@ -4,6 +4,7 @@ require 'redmine_airbrake_backend/notice'
 
 # Controller with airbrake related stuff
 class AirbrakeController < ::ApplicationController
+  include AirbrakeSettings
   include AirbrakeIssueHandling
   include AirbrakeRendering
 
@@ -19,7 +20,7 @@ class AirbrakeController < ::ApplicationController
   before_action :find_category
   before_action :find_priority
   before_action :find_assignee
-  before_action :find_repository
+  before_action :find_repositories
 
   private
 
@@ -44,7 +45,7 @@ class AirbrakeController < ::ApplicationController
   end
 
   def authorize
-    User.current = User.find_by_api_key(@key[:key])
+    User.current = User.find_by_api_key(@key[:key]) # rubocop:disable Rails/DynamicFindBy
 
     if User.current.blank? || User.current.anonymous?
       render_error('Failed to authenticate', :unauthorized)
@@ -63,7 +64,7 @@ class AirbrakeController < ::ApplicationController
     render_error('No or invalid tracker', :failed_dependency) if @tracker.blank?
 
     # Check notice ID field
-    return unless @tracker.custom_fields.find_by(id: notice_hash_field.id).blank?
+    return if @tracker.custom_fields.find_by(id: notice_hash_field.id).present?
 
     render_error('Custom field for notice hash not available on selected tracker', :failed_dependency)
   end
@@ -80,8 +81,12 @@ class AirbrakeController < ::ApplicationController
     @assignee = record_for(@project.users, :assignee, %i[id login])
   end
 
-  def find_repository
-    @repository = @project.repositories.find_by(identifier: (@key[:repository] || ''))
+  def find_repositories
+    @repositories = if @key[:repositories].present?
+                      @project.repositories.where(identifier: @key[:repositories].split(',').map(&:strip)).to_a
+                    else
+                      @project.repositories.to_a
+                    end
   end
 
   def render_error(error, status = :internal_server_error)
@@ -116,16 +121,6 @@ class AirbrakeController < ::ApplicationController
     project_setting(key)
   end
 
-  def global_setting(key)
-    Setting.plugin_redmine_airbrake_backend[key.to_s]
-  end
-
-  def project_setting(key)
-    return nil if @project.airbrake_settings.blank?
-
-    @project.airbrake_settings.send(key) if @project.airbrake_settings.respond_to?(key)
-  end
-
   def custom_field(key)
     @project.issue_custom_fields.find_by(id: global_setting(key)) ||
       CustomField.find_by(id: global_setting(key), is_for_all: true)

data/app/controllers/concerns/airbrake_issue_finding.rb

@@ -28,7 +28,7 @@ module AirbrakeIssueFinding
       author:      User.current,
       category:    @category,
       priority:    @priority,
-      description: render_description(notice),
+      description: render_description(notice, repositories: @repositories),
       assigned_to: @assignee
     )
 

data/app/controllers/concerns/airbrake_issue_handling.rb

@@ -69,7 +69,7 @@ module AirbrakeIssueHandling
     return if notice.environment_name.blank?
 
     desc  = "*Issue reopened after occurring again in _#{notice.environment_name}_ environment.*"
-    desc += "\n\n#{render_description(notice)}" if issue_reopen_repeat_description?
+    desc += "\n\n#{render_description(notice, repositories: @repositories)}" if issue_reopen_repeat_description?
 
     issue.status = issue.tracker.default_status
 

data/app/controllers/concerns/airbrake_rendering.rb

@@ -4,8 +4,8 @@
 module AirbrakeRendering
   extend ActiveSupport::Concern
 
-  def render_description(notice)
-    locals = { notice: notice }
+  def render_description(notice, locals)
+    locals = { notice: notice, repositories: [] }.merge(locals)
 
     if template_exists?("airbrake/issue_description/#{notice.type}")
       render_to_string("airbrake/issue_description/#{notice.type}", layout: false, locals: locals)

data/app/controllers/concerns/airbrake_settings.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Get Airbrake global or project settings
+module AirbrakeSettings
+  extend ActiveSupport::Concern
+
+  private
+
+  def global_setting(key)
+    Setting.plugin_redmine_airbrake_backend[key.to_s]
+  end
+
+  def project_setting(key)
+    return nil if @project.airbrake_settings.blank?
+
+    @project.airbrake_settings.send(key) if @project.airbrake_settings.respond_to?(key)
+  end
+end

data/app/helpers/airbrake_helper.rb

@@ -36,8 +36,8 @@ module AirbrakeHelper
   end
 
   # Wiki markup for backtrace element with link to repository if possible
-  def airbrake_format_backtrace_element(element)
-    repository = airbrake_repository_for_backtrace_element(element)
+  def airbrake_format_backtrace_element(repositories, element)
+    repository = airbrake_repository_for_backtrace_element(repositories, element)
 
     markup = if repository.blank?
                airbrake_backtrace_element_markup_without_repository(element)
@@ -56,48 +56,28 @@ module AirbrakeHelper
 
   private
 
-  def airbrake_repository_for_backtrace_element(element)
-    return nil unless element.file.present?
-    return nil unless element.file.start_with?('[PROJECT_ROOT]')
-
-    filename = airbrake_filename_for_backtrace_element(element)
-
-    airbrake_repositories_for_backtrace.find { |r| r.entry(filename) }
-  end
-
-  def airbrake_repositories_for_backtrace
-    return @bactrace_repositories unless @bactrace_repositories.nil?
-
-    @bactrace_repositories = if @repository.present?
-                               [@repository]
-                             else
-                               @project.repositories.to_a
-                             end
-
-    @bactrace_repositories
-  end
-
-  def airbrake_filename_for_backtrace_element(element)
+  def airbrake_repository_for_backtrace_element(repositories, element)
+    return nil unless element.root.project?
     return nil if element.file.blank?
 
-    element.file[14..-1]
+    (repositories || []).find { |r| r.entry(element.file) }
   end
 
   def airbrake_backtrace_element_markup_without_repository(element)
+    file = element.root.undefined? ? element.file : "[#{element.root.upcase}_ROOT]#{element.file}"
+
     if element.line.blank?
-      "@#{element.file}@"
+      "@#{ile}@"
     else
-      "@#{element.file}:#{element.line}@"
+      "@#{file}:#{element.line}@"
     end
   end
 
   def airbrake_backtrace_element_markup_with_repository(repository, element)
-    filename = airbrake_filename_for_backtrace_element(element)
-
     if repository.identifier.blank?
-      "source:\"#{filename}#L#{element.line}\""
+      "source:\"#{element.file}#L#{element.line}\""
     else
-      "source:\"#{repository.identifier}|#{filename}#L#{element.line}\""
+      "source:\"#{repository.identifier}|#{element.file}#L#{element.line}\""
     end
   end
 end

data/app/models/airbrake_project_setting.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Project-specific settings for airbrake
-class AirbrakeProjectSetting < ActiveRecord::Base
+class AirbrakeProjectSetting < ActiveRecord::Base # rubocop:disable Rails/ApplicationRecord
   belongs_to :project
   belongs_to :tracker
-  belongs_to :category, class_name: IssueCategory.name
-  belongs_to :priority, class_name: IssuePriority.name
+  belongs_to :category, class_name: 'IssueCategory'
+  belongs_to :priority, class_name: 'IssuePriority'
 
   validates :project_id, presence: true
 end

data/app/views/airbrake/issue_description/default.erb

@@ -4,7 +4,7 @@ h1. <%= airbrake_error_title(error) %>
 <% if error.backtrace.present? %>
 h2. Stacktrace:
 
-p((. <%= raw error.backtrace.map { |e| airbrake_format_backtrace_element(e) }.join("\n") %>
+p((. <%= raw error.backtrace.map { |e| airbrake_format_backtrace_element(repositories, e) }.join("\n") %>
 <% end %>
 
 <% end %>

data/lib/redmine_airbrake_backend/backtrace_element.rb

@@ -5,28 +5,41 @@ require 'digest/md5'
 module RedmineAirbrakeBackend
   # Backtrace element received by airbrake
   class BacktraceElement
-    attr_reader :file, :line, :function, :column
+    DEFAULT_ROOT = ActiveSupport::StringInquirer.new('undefined')
 
-    def initialize(data)
-      # File
-      @file = data[:file].presence
+    attr_reader :root, :file, :line, :function, :column
 
-      # Line
+    def initialize(data)
+      @root, @file = parse_root_and_file(data[:file].presence)
       @line = data[:line].presence
-
-      # Function
       @function = data[:function].presence
-
-      # Column
       @column = data[:column].presence
     end
 
     def checksum
-      @checksum ||= Digest::MD5.hexdigest("#{@file}|#{normalized_function_name}|#{@line}|#{@column}")
+      @checksum ||= Digest::MD5.hexdigest("#{root}|#{file}|#{normalized_function_name}|#{line}|#{column}")
+    end
+
+    def formatted_file
+      if root.undefined?
+        file
+      else
+        "[#{root.upcase}_ROOT]#{file}"
+      end
     end
 
     private
 
+    def parse_root_and_file(file)
+      return DEFAULT_ROOT, file if file.blank?
+
+      match = %r{\A/([A-Z]+)_ROOT(/.+)}.match(file.strip)
+
+      return ActiveSupport::StringInquirer.new(match[1].downcase), match[2].strip if match.present?
+
+      [DEFAULT_ROOT, file]
+    end
+
     def normalized_function_name
       name = @function
              .downcase

data/lib/redmine_airbrake_backend/ios_report.rb

@@ -43,7 +43,7 @@ module RedmineAirbrakeBackend
           parse_message(line, error)
         end
 
-        crashed_thread = false if line =~ /^Thread \d+:$/
+        crashed_thread = false if line.match?(/^Thread \d+:$/)
 
         if crashed_thread
           backtrace = parse_backtrace_element(line)
@@ -54,7 +54,7 @@ module RedmineAirbrakeBackend
           crashed_thread = true
         end
 
-        next_line_is_message = true if line =~ /^Application Specific Information:$/
+        next_line_is_message = true if line.match?(/^Application Specific Information:$/)
       end
 
       return nil if error.blank?

data/lib/redmine_airbrake_backend/patches/project.rb

@@ -9,7 +9,7 @@ module RedmineAirbrakeBackend
       extend ActiveSupport::Concern
 
       included do
-        has_one :airbrake_settings, class_name: AirbrakeProjectSetting.name, dependent: :destroy
+        has_one :airbrake_settings, class_name: 'AirbrakeProjectSetting', dependent: :destroy
       end
     end
   end

data/lib/redmine_airbrake_backend/version.rb

@@ -2,5 +2,5 @@
 
 module RedmineAirbrakeBackend
   # Version of this gem
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/redmine_airbrake_backend.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rails'
 end

data/test/unit/notice_test.rb

@@ -67,6 +67,6 @@ class NoticeTest < ActiveSupport::TestCase
     assert_equal(1, notice.errors.length)
     assert_equal('OpenURI::HTTPError', notice.errors.first.type)
     assert_equal('404 Not Found', notice.errors.first.message)
-    assert_equal('a16abb78bf4b40460258c72cdc971ca0', notice.id)
+    assert_equal('cfc605db663aab8c1cc7864567dab734', notice.id)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_airbrake_backend
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Plugin which adds Airbrake support to Redmine
 email:
 - me@ydkn.de
@@ -89,6 +117,7 @@ files:
 - app/controllers/concerns/airbrake_issue_finding.rb
 - app/controllers/concerns/airbrake_issue_handling.rb
 - app/controllers/concerns/airbrake_rendering.rb
+- app/controllers/concerns/airbrake_settings.rb
 - app/helpers/airbrake_helper.rb
 - app/models/airbrake_project_setting.rb
 - app/views/airbrake/issue_description/_section.erb
@@ -136,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: This plugin provides the necessary API to use Redmine as a Airbrake backend