redmine_airbrake_backend 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e17bf3121cc154d47b38ad482b7269a04b30f25
-  data.tar.gz: 8a26cee201e9a7d6b5b8e9a7b3491e76ad4da4c5
+  metadata.gz: 5926fca2b10cfdf572494c9891adc633b583bbdb
+  data.tar.gz: 0dc91282b47937a48254ff1e3da0fbd4b555c0be
 SHA512:
-  metadata.gz: cf46bb9b3d773987e39309ecc34d6dba06da4649f35459e11d1dae3ffdd6586d366b9f8fa7c4e979b23c2db3f5b966e995de3663b84058be5dbc7759c117b409
-  data.tar.gz: b3cf1f9f4514a42fa90e1019df70ed9dbed0efac0a10f4c6f42632eeee2b821c53aa055e70d4b56d5409e8eb533dd2ac7b1ff7f735128c76d0b5cc455bf5de19
+  metadata.gz: 58cfc22082b4c0098a5c756d915401fe334a3346c55541038b21fcd500978f5646ab7627234b5eb882f00561df2bbc28569de2b3c2976d1708c31857a59036ad
+  data.tar.gz: 71de8ff6c61f7894afbafb4a763cef7402651beaac638f0756839a140fdc877c0ba7f6cc0466b5f39883b39460472ddd1531d968a37599b2aaaf772bd5c589ff

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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

data/app/controllers/airbrake_controller.rb

@@ -1,5 +1,5 @@
 require 'tempfile'
-require 'redmine_airbrake_backend/error'
+require 'redmine_airbrake_backend/notice'
 
 
 # Controller with airbrake related stuff
@@ -11,7 +11,6 @@ class AirbrakeController < ::ApplicationController
   prepend_before_action :load_records
   prepend_before_action :parse_key
   prepend_before_action :find_project
-  before_action :set_environment
   before_action :authorize
 
   after_action :cleanup_tempfiles
@@ -25,14 +24,11 @@ class AirbrakeController < ::ApplicationController
   end
 
   def parse_key
-    @key = JSON.parse(params[:key]).symbolize_keys #rescue nil
+    @key = JSON.parse(params[:key]).symbolize_keys rescue nil
 
     # API key
     invalid_request!('No or invalid API key') if @key.blank? || @key[:key].blank?
     params[:key] = @key[:key]
-
-    # Type
-    @type = @key[:type] || (params[:context][:language].split('/', 2).first.downcase rescue nil)
   end
 
   def load_records
@@ -56,10 +52,6 @@ class AirbrakeController < ::ApplicationController
     @repository = @project.repositories.find_by(identifier: (@key[:repository] || ''))
   end
 
-  def set_environment
-    @environment ||= params[:context][:environment].presence rescue nil
-  end
-
   def invalid_request!(message)
     raise InvalidRequest.new(message)
   end
@@ -112,39 +104,52 @@ class AirbrakeController < ::ApplicationController
     custom_field(:occurrences_field)
   end
 
+  def create_issue!
+    return if @notice.blank?
+    return if @notice.errors.blank?
+
+    @issue = find_or_initialize_issue(@notice)
+
+    set_issue_custom_field_values(@issue, @notice)
+
+    reopen_issue(@issue, @notice) if @issue.persisted? && @issue.status.is_closed? && reopen_issue?(@notice)
+
+    @issue = nil unless @issue.save
+  end
+
   # Load or initialize issue by project, tracker and airbrake hash
-  def find_or_initialize_issue(error)
-    issue_ids = CustomValue.where(customized_type: Issue.name, custom_field_id: notice_hash_field.id, value: error.id).pluck(:customized_id)
+  def find_or_initialize_issue(notice)
+    issue_ids = CustomValue.where(customized_type: Issue.name, custom_field_id: notice_hash_field.id, value: notice.id).pluck(:customized_id)
 
     issue = Issue.find_by(id: issue_ids, project_id: @project.id, tracker_id: @tracker.id)
 
     return issue if issue.present?
 
-    initialize_issue(error)
+    initialize_issue(notice)
   end
 
-  def initialize_issue(error)
+  def initialize_issue(notice)
     issue = Issue.new(
-        subject: error.subject,
+        subject: notice.subject,
         project: @project,
         tracker: @tracker,
         author: User.current,
         category: @category,
         priority: @priority,
-        description: render_description(error),
+        description: render_description(notice),
         assigned_to: @assignee
       )
 
-    add_attachments_to_issue(issue, error)
+    add_attachments_to_issue(issue, notice)
 
     issue
   end
 
-  def set_issue_custom_field_values(issue, error)
+  def set_issue_custom_field_values(issue, notice)
     custom_field_values = {}
 
     # Error ID
-    custom_field_values[notice_hash_field.id] = error.id if issue.new_record?
+    custom_field_values[notice_hash_field.id] = notice.id if issue.new_record?
 
     # Update occurrences
     if occurrences_field.present?
@@ -155,12 +160,12 @@ class AirbrakeController < ::ApplicationController
     issue.custom_field_values = custom_field_values
   end
 
-  def add_attachments_to_issue(issue, error)
-    return if error.attachments.blank?
+  def add_attachments_to_issue(issue, notice)
+    return if notice.attachments.blank?
 
     @tempfiles ||= []
 
-    error.attachments.each do |data|
+    notice.attachments.each do |data|
       filename = data[:filename].presence || Redmine::Utils.random_hex(16)
 
       file = Tempfile.new(filename)
@@ -173,37 +178,37 @@ class AirbrakeController < ::ApplicationController
     end
   end
 
-  def reopen_issue?
+  def reopen_issue?(notice)
     reopen_regexp = project_setting(:reopen_regexp)
 
     return false if reopen_regexp.blank?
-    return false if @environment.blank?
+    return false if notice.environment_name.blank?
 
-    !!(@environment =~ /#{reopen_regexp}/i)
+    !!(notice.environment_name =~ /#{reopen_regexp}/i)
   end
 
   def issue_reopen_repeat_description?
     !!project_setting(:reopen_repeat_description)
   end
 
-  def reopen_issue(issue, error)
-    return if @environment.blank?
+  def reopen_issue(issue, notice)
+    return if notice.environment_name.blank?
 
-    desc = "*Issue reopened after occurring again in _#{@environment}_ environment.*"
-    desc << "\n\n#{render_description(error)}" if issue_reopen_repeat_description?
+    desc = "*Issue reopened after occurring again in _#{notice.environment_name}_ environment.*"
+    desc << "\n\n#{render_description(notice)}" if issue_reopen_repeat_description?
 
     issue.status = issue.tracker.default_status
 
     issue.init_journal(User.current, desc)
 
-    add_attachments_to_issue(issue, error)
+    add_attachments_to_issue(issue, notice)
   end
 
-  def render_description(error)
-    locals = { error: error }
+  def render_description(notice)
+    locals = { notice: notice }
 
-    if template_exists?("airbrake/issue_description/#{@type}")
-      render_to_string("airbrake/issue_description/#{@type}", layout: false, locals: locals)
+    if template_exists?("airbrake/issue_description/#{notice.type}")
+      render_to_string("airbrake/issue_description/#{notice.type}", layout: false, locals: locals)
     else
       render_to_string('airbrake/issue_description/default', layout: false, locals: locals)
     end

data/app/controllers/airbrake_notice_controller.rb

@@ -2,26 +2,24 @@
 class AirbrakeNoticeController < ::AirbrakeController
   accept_api_auth :notices
 
+  before_action :parse_notice
+
   # Handle airbrake notices
   def notices
-    create_issues
+    create_issue!
 
     render_airbrake_response
   end
 
   private
 
-  def create_issues
-    params[:errors].each do |e|
-      error = RedmineAirbrakeBackend::Error.new(e)
-
-      issue = find_or_initialize_issue(error)
-
-      set_issue_custom_field_values(issue, error)
-
-      reopen_issue(issue, error) if issue.persisted? && issue.status.is_closed? && reopen_issue?
-
-      @issue ||= issue if issue.save
-    end
+  def parse_notice
+    @notice = RedmineAirbrakeBackend::Notice.new(
+        errors:      params[:errors].map { |e| RedmineAirbrakeBackend::Error.new(e) },
+        params:      params[:params],
+        session:     params[:session],
+        context:     params[:context],
+        environment: params[:environment]
+      )
   end
 end

data/app/controllers/airbrake_report_controller.rb

@@ -5,24 +5,18 @@ require 'redmine_airbrake_backend/ios_report'
 class AirbrakeReportController < ::AirbrakeController
   accept_api_auth :ios_reports
 
+  before_action :parse_report
+
   # Handle airbrake iOS reports
   def ios_reports
-    create_issue
+    create_issue!
 
     render_airbrake_response
   end
 
   private
 
-  def create_issue
-    error = RedmineAirbrakeBackend::IosReport.new(params[:report])
-
-    @issue = find_or_initialize_issue(error)
-
-    set_issue_custom_field_values(@issue, error)
-
-    reopen_issue(@issue, error) if @issue.persisted? && @issue.status.is_closed? && reopen_issue?
-
-    @issue = nil unless @issue.save
+  def parse_report
+    @notice = RedmineAirbrakeBackend::IosReport.new(params)
   end
 end

data/app/helpers/airbrake_helper.rb

@@ -1,7 +1,17 @@
 module AirbrakeHelper
+  # Error title
+  def airbrake_error_title(error)
+    if error.type.blank?
+      error.message
+    else
+      "#{error.type}: #{error.message}"
+    end
+  end
+
   # Wiki markup for a table
-  def format_table(data)
+  def airbrake_format_table(data)
     lines = []
+
     data.each do |key, value|
       next if value.blank?
 
@@ -11,19 +21,20 @@ module AirbrakeHelper
         lines << "|@#{key}@|@#{value.map { |k, v| "#{k}: #{v}"}.join(', ')}@|"
       end
     end
+
     lines.join("\n")
   end
 
   # Wiki markup for a list item
-  def format_list_item(name, value)
+  def airbrake_format_list_item(name, value)
     return '' if value.blank?
 
     "* *#{name}:* #{value}"
   end
 
   # Wiki markup for backtrace element with link to repository if possible
-  def format_backtrace_element(element)
-    repository = repository_for_backtrace_element(element)
+  def airbrake_format_backtrace_element(element)
+    repository = airbrake_repository_for_backtrace_element(element)
 
     if repository.blank?
       if element.line.blank?
@@ -32,7 +43,7 @@ module AirbrakeHelper
         markup = "@#{element.file}:#{element.line}@"
       end
     else
-      filename = filename_for_backtrace_element(element)
+      filename = airbrake_filename_for_backtrace_element(element)
 
       if repository.identifier.blank?
         markup = "source:\"#{filename}#L#{element.line}\""
@@ -46,15 +57,15 @@ module AirbrakeHelper
 
   private
 
-  def repository_for_backtrace_element(element)
+  def airbrake_repository_for_backtrace_element(element)
     return nil unless element.file.start_with?('[PROJECT_ROOT]')
 
-    filename = filename_for_backtrace_element(element)
+    filename = airbrake_filename_for_backtrace_element(element)
 
-    repositories_for_backtrace.find { |r| r.entry(filename) }
+    airbrake_repositories_for_backtrace.find { |r| r.entry(filename) }
   end
 
-  def repositories_for_backtrace
+  def airbrake_repositories_for_backtrace
     return @_bactrace_repositories unless @_bactrace_repositories.nil?
 
     if @repository.present?
@@ -66,7 +77,7 @@ module AirbrakeHelper
     @_bactrace_repositories
   end
 
-  def filename_for_backtrace_element(element)
+  def airbrake_filename_for_backtrace_element(element)
     return nil if  element.file.blank?
 
     element.file[14..-1]

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

@@ -1,44 +1,45 @@
-h1. <%= error.message %>
-
+<% notice.errors.each do |error| %>
+h1. <%= airbrake_error_title(error) %>
 
 <% if error.backtrace.present? %>
 h2. Stacktrace:
 
-p((. <%= raw error.backtrace.map { |e| format_backtrace_element(e) }.join("\n") %>
+p((. <%= raw error.backtrace.map { |e| airbrake_format_backtrace_element(e) }.join("\n") %>
 <% end %>
 
+<% end %>
 
-<% if error.application.present? %>
+<% if notice.application.present? %>
 h2. Application:
 
-<%= format_list_item('Name', error.application[:name]) %>
-<%= format_list_item('Version', error.application[:version]) %>
+<%= airbrake_format_list_item('Name', notice.application[:name]) %>
+<%= airbrake_format_list_item('Version', notice.application[:version]) %>
 <% end %>
 
 
-<% if params[:params].present? %>
+<% if notice.params.present? %>
 h2. Parameters:
 
-<%= format_table(params[:params]) %>
+<%= airbrake_format_table(notice.params) %>
 <% end %>
 
 
-<% if params[:session].present? %>
+<% if notice.session.present? %>
 h2. Session
 
-<%= format_table(params[:session]) %>
+<%= airbrake_format_table(notice.session) %>
 <% end %>
 
 
-<% if params[:context].present? %>
+<% if notice.context.present? %>
 h2. Context
 
-<%= format_table(params[:context].reject { |k, v| ['notifier'].include?(k) }) %>
+<%= airbrake_format_table(notice.context) %>
 <% end %>
 
 
-<% if params[:environment].present? %>
+<% if notice.environment.present? %>
 h2. Environment
 
-<%= format_table(params[:environment]) %>
+<%= airbrake_format_table(notice.environment) %>
 <% end %>

data/lib/redmine_airbrake_backend/backtrace_element.rb

@@ -29,7 +29,7 @@ module RedmineAirbrakeBackend
     def normalize_function_name(function_name)
       name = @function
         .downcase
-        .gsub(/_\d+_/, '') # ruby blocks
+        .gsub(/([\d_]+$)?/, '') # ruby blocks
 
       RedmineAirbrakeBackend.filter_hex_values(name)
     end

data/lib/redmine_airbrake_backend/error.rb

@@ -5,30 +5,20 @@ require 'redmine_airbrake_backend/backtrace_element'
 module RedmineAirbrakeBackend
   # Error received by airbrake
   class Error
-    attr_reader :type, :message, :backtrace
-    attr_reader :id, :subject, :application, :attachments
+    attr_reader :id, :type, :message, :backtrace
 
-    def initialize(data)
+    def initialize(options)
       # Type
-      @type = data[:type]
+      @type = options[:type]
 
       # Message
-      @message = data[:message]
+      @message = options[:message]
 
       # Backtrace
-      @backtrace = data[:backtrace].map { |b| BacktraceElement.new(b) }
+      @backtrace = options[:backtrace].map { |b| BacktraceElement.new(b) }
 
       # Error ID
       @id = generate_id
-
-      # Subject
-      @subject = generate_subject
-
-      # Attachments
-      @attachments = (data[:attachments].presence || []).compact
-
-      # Application
-      @application = data[:application].presence
     end
 
     private
@@ -41,17 +31,5 @@ module RedmineAirbrakeBackend
 
       Digest::MD5.hexdigest(h.compact.join("\n"))
     end
-
-    def generate_subject
-      s = ''
-
-      if @type.blank? || @message.starts_with?("#{@type}:")
-        s = "[#{@id[0..7]}] #{@message}"
-      else
-        s = "[#{@id[0..7]}] #{@type}: #{@message}"
-      end
-
-      s[0..254].strip
-    end
   end
 end

data/lib/redmine_airbrake_backend/ios_report.rb

@@ -1,21 +1,26 @@
-require 'redmine_airbrake_backend/error'
+require 'redmine_airbrake_backend/notice'
 
 
 module RedmineAirbrakeBackend
   # iOS Report received by airbrake
-  class IosReport < Error
-    def initialize(data)
-      super(IosReport.parse(data))
+  class IosReport < Notice
+    def initialize(options)
+      error, application, attachments = self.class.parse(options[:report])
+
+      super({
+          errors:      [Error.new(error)],
+          context:     options[:context],
+          application: application,
+          attachments: attachments
+        })
     end
 
     private
 
     def self.parse(data)
-      error = {
-        application: {},
-        backtrace:   [],
-        attachments: [],
-      }
+      error       = { backtrace: [] }
+      application = {}
+      attachments = []
 
       header_finished      = false
       next_line_is_message = false
@@ -25,8 +30,8 @@ module RedmineAirbrakeBackend
       data.split("\n").each do |line|
         header_finished = true if line =~ /^(Application Specific Information|Last Exception Backtrace|Thread \d+( Crashed)?):$/
 
-        unless header_finishedii
-          ii = parse_header_line(line, error)
+        unless header_finished
+          ii = parse_header_line(line, error, application)
           indicent_identifier ||= ii if ii
         end
 
@@ -38,7 +43,10 @@ module RedmineAirbrakeBackend
 
         crashed_thread = false if line =~ /^Thread \d+:$/
 
-        error[:backtrace] << parse_backtrace_element(line) if crashed_thread
+        if crashed_thread
+          backtrace = parse_backtrace_element(line)
+          error[:backtrace] << backtrace if backtrace
+        end
 
         crashed_thread = true if error[:backtrace].compact.blank? && line =~ /^(Last Exception Backtrace|Thread \d+ Crashed):$/
 
@@ -47,15 +55,15 @@ module RedmineAirbrakeBackend
 
       return nil if error.blank?
 
-      error[:attachments] << {
+      attachments << {
         filename: "#{indicent_identifier}.crash",
         data:     data
       } if indicent_identifier.present?
 
-      error
+      [error, application, attachments]
     end
 
-    def self.parse_header_line(line, error)
+    def self.parse_header_line(line, error, application)
       key, value = line.split(':', 2).map { |s| s.strip }
 
       return nil if key.blank? || value.blank?
@@ -68,9 +76,9 @@ module RedmineAirbrakeBackend
       when 'Incident Identifier'
         return value
       when 'Identifier'
-        error[:application][:name] = value
+        application[:name] = value
       when 'Version'
-        error[:application][:version] = value
+        application[:version] = value
       end
 
       nil

data/lib/redmine_airbrake_backend/notice.rb

@@ -0,0 +1,64 @@
+require 'redmine_airbrake_backend/error'
+
+
+module RedmineAirbrakeBackend
+  # Notice received by airbrake
+  class Notice
+    attr_reader :id, :subject, :type, :environment_name
+    attr_reader :errors, :params, :session, :context, :environment, :application, :attachments
+
+    def initialize(options)
+      # Errors
+      @errors = options[:errors].compact
+
+      # Params
+      @params = options[:params]
+
+      # Session
+      @session = options[:session]
+
+      # Context
+      @context = options[:context].reject { |k, v| ['notifier'].include?(k) }
+
+      # Environment
+      @environment = options[:environment]
+
+      # Application
+      @application = options[:application]
+
+      # Attachments
+      @attachments = (options[:attachments].presence || []).compact
+
+      # Environment name
+      @environment_name = options[:context][:environment].presence rescue nil
+
+      # Type
+      @type = options[:type] || (options[:context][:language].split('/', 2).first.downcase rescue nil)
+
+      # Error ID
+      @id = generate_id
+
+      # Subject
+      @subject = generate_subject
+    end
+
+    private
+
+    def generate_id
+      Digest::MD5.hexdigest(@errors.map(&:id).join("\n"))
+    end
+
+    def generate_subject
+      error = @errors.first
+      s     = ''
+
+      if error.type.blank? || error.message.starts_with?("#{error.type}:")
+        s = "[#{@id[0..7]}] #{error.message}"
+      else
+        s = "[#{@id[0..7]}] #{error.type}: #{error.message}"
+      end
+
+      s[0..254].strip
+    end
+  end
+end

data/lib/redmine_airbrake_backend/version.rb

@@ -1,4 +1,4 @@
 module RedmineAirbrakeBackend
   # Version of this gem
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redmine_airbrake_backend
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -85,6 +85,7 @@ files:
 - lib/redmine_airbrake_backend/engine.rb
 - lib/redmine_airbrake_backend/error.rb
 - lib/redmine_airbrake_backend/ios_report.rb
+- lib/redmine_airbrake_backend/notice.rb
 - lib/redmine_airbrake_backend/patches/issue_category.rb
 - lib/redmine_airbrake_backend/patches/issue_priority.rb
 - lib/redmine_airbrake_backend/patches/project.rb