redmine_airbrake_backend 0.4.3 → 0.5.0

data/app/controllers/airbrake_report_controller.rb

@@ -0,0 +1,15 @@
+# Controller for airbrake notices
+class AirbrakeReportController < ::AirbrakeController
+  prepend_before_filter :parse_json_request
+
+  accept_api_auth :report
+
+  # Handle airbrake reports
+  def report
+    render json: {
+      report: {
+        id: (@results.first[:hash] rescue nil)
+      }
+    }
+  end
+end

data/app/helpers/airbrake_helper.rb

@@ -1,5 +1,7 @@
-module AirbrakeHelper
+require 'htmlentities'
 
+module AirbrakeHelper
+  # Wiki markup for a table
   def format_table(data)
     lines = []
     data.each do |key, value|
@@ -9,6 +11,7 @@ module AirbrakeHelper
     lines.join("\n")
   end
 
+  # Wiki markup for logs
   def format_log(data)
     lines = []
     data.each do |log|
@@ -18,41 +21,63 @@ module AirbrakeHelper
     lines.join("\n")
   end
 
+  # Wiki markup for a list item
   def 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)
     @htmlentities ||= HTMLEntities.new
 
     repository = repository_for_backtrace_element(element)
 
     if repository.blank?
-      file = "@#{@htmlentities.decode(element[:file])}:#{element[:number]}@"
-    elsif repository.identifier.blank?
-      file = "source:\"#{@htmlentities.decode(element[:file][14..-1])}#L#{element[:number]}\""
+      if element[:number].blank?
+        markup = "@#{@htmlentities.decode(element[:file])}@"
+      else
+        markup = "@#{@htmlentities.decode(element[:file])}:#{element[:number]}@"
+      end
     else
-      file = "source:\"#{repository.identifier}|#{@htmlentities.decode(element[:file][14..-1])}#L#{element[:number]}\""
+      filename = @htmlentities.decode(filename_for_backtrace_element(element))
+
+      if repository.identifier.blank?
+        markup = "source:\"#{filename}#L#{element[:number]}\""
+      else
+        markup = "source:\"#{repository.identifier}|#{filename}#L#{element[:number]}\""
+      end
     end
 
-    file + " in ??<notextile>#{@htmlentities.decode(element[:method])}</notextile>??"
+    markup + " in ??<notextile>#{@htmlentities.decode(element[:method])}</notextile>??"
   end
 
   private
 
   def repository_for_backtrace_element(element)
-    if element[:file].start_with?('[PROJECT_ROOT]')
-      file = element[:file][14..-1]
-      if @notice.params.key?(:repository)
-        r = @project.repositories.where(identifier: (@notice.params[:repository] || '')).first
-        return r if r.present? && r.entry(file)
-      else
-        return @project.repositories.select{|r| r.entry(file)}.first
-      end
+    return nil unless element[:file].start_with?('[PROJECT_ROOT]')
+
+    filename = filename_for_backtrace_element(element)
+
+    repositories_for_backtrace.find { |r| r.entry(filename) }
+  end
+
+  def repositories_for_backtrace
+    return @_bactrace_repositories unless @_bactrace_repositories.nil?
+
+    if request.repository.present?
+      @_bactrace_repositories = [request.repository]
+    else
+      @_bactrace_repositories = request.project.repositories.to_a
     end
 
-    nil
+    @_bactrace_repositories
   end
 
+  def filename_for_backtrace_element(element)
+    return nil if  element[:file].blank?
+
+    element[:file][14..-1]
+  end
 end

data/app/models/airbrake_project_setting.rb

@@ -1,5 +1,6 @@
 require 'redmine/safe_attributes'
 
+# Project-specific settings for airbrake
 class AirbrakeProjectSetting < ActiveRecord::Base
   include Redmine::SafeAttributes
 

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

@@ -0,0 +1,52 @@
+<% if error.present? %>
+h1. <%= error.message %>
+
+<% if error.backtrace.present? %>
+h2. Stacktrace:
+
+p((. <%=raw error.backtrace.collect { |e| format_backtrace_element(e) }.join("\n") %>
+<% end %>
+<% end %>
+
+<% if request.request.present? %>
+h2. Request:
+
+<%=format_list_item('URL', request.request[:url]) %>
+<%=format_list_item('Component', request.request[:component]) %>
+<%=format_list_item('Action', request.request[:action]) %>
+
+<% if request.request[:params].present? %>
+h2. Parameters:
+
+<%=format_table(request.request[:params]) %>
+<% end %>
+
+<% if request.request[:cgi_data].present? %>
+h2. Headers:
+
+<%=format_table(request.request[:cgi_data]) %>
+<% end %>
+
+<% log = request.request[:session].delete(:log) if request.request[:session].present? %>
+<% if request.request[:session].present? %>
+h2. Session:
+
+<%=format_table(request.request[:session]) %>
+<% end %>
+
+<% if log.present? %>
+h2. Log:
+
+<pre>
+<%=format_log(log) %>
+</pre>
+<% end %>
+<% end %>
+
+<% if request.env.present? %>
+h2. Environment
+
+<%=format_list_item('Name', request.environment_name) %>
+<%=format_list_item('Directory', request.env[:project_root]) %>
+<%=format_list_item('Hostname', request.env[:hostname]) %>
+<% end %>

data/config/routes.rb

@@ -1,6 +1,10 @@
 Rails.application.routes.draw do
-  post '/notifier_api/v2/notices/' => 'airbrake#notice'
+  # notifier api
+  post '/notifier_api/v2/notices'       => 'airbrake_notice#notice_xml'
+  post '/notifier_api/v3/notices'       => 'airbrake_notice#notice_json'
+  post '/notifier_api/v3/reports/:type' => 'airbrake_report#report'
 
+  # settings
   resources :projects do
     member do
       post 'airbrake_settings' => 'airbrake_project_settings#update'

data/db/migrate/20130708102357_create_airbrake_project_settings.rb

@@ -1,5 +1,4 @@
 class CreateAirbrakeProjectSettings < ActiveRecord::Migration
-
   def up
     create_table :airbrake_project_settings do |t|
       t.references :project, index: true, null: false
@@ -14,5 +13,4 @@ class CreateAirbrakeProjectSettings < ActiveRecord::Migration
   def down
     drop_table :airbrake_project_settings
   end
-
 end

data/db/migrate/20131003151228_add_reopen_repeat_description.rb

@@ -1,5 +1,4 @@
 class AddReopenRepeatDescription < ActiveRecord::Migration
-
   def up
     add_column :airbrake_project_settings, :reopen_repeat_description, :boolean
 
@@ -16,5 +15,4 @@ class AddReopenRepeatDescription < ActiveRecord::Migration
   def down
     remove_column :airbrake_project_settings, :reopen_repeat_description
   end
-
 end

data/lib/redmine_airbrake_backend.rb

@@ -1,9 +1,7 @@
 require 'redmine_airbrake_backend/engine'
 
 module RedmineAirbrakeBackend
-
   def self.directory
     File.expand_path(File.join(File.dirname(__FILE__), '..'))
   end
-
 end

data/lib/redmine_airbrake_backend/engine.rb

@@ -30,20 +30,20 @@ module RedmineAirbrakeBackend
 
     def register_redmine_plugin
       Redmine::Plugin.register :redmine_airbrake_backend do
-        name 'Airbrake Backend'
-        author 'Florian Schwab'
-        author_url 'https://github.com/ydkn'
-        description 'Airbrake Backend for Redmine'
-        url 'https://github.com/ydkn/redmine_airbrake_backend'
-        version ::RedmineAirbrakeBackend::VERSION
-        requires_redmine :version_or_higher => '2.3.2'
-        directory RedmineAirbrakeBackend.directory
+        name             'Airbrake Backend'
+        author           'Florian Schwab'
+        author_url       'https://github.com/ydkn'
+        description      'Airbrake Backend for Redmine'
+        url              'https://github.com/ydkn/redmine_airbrake_backend'
+        version          ::RedmineAirbrakeBackend::VERSION
+        requires_redmine version_or_higher: '2.4.0'
+        directory        RedmineAirbrakeBackend.directory
 
         project_module :airbrake do
-          permission :manage_airbrake, {airbrake: [:update]}
+          permission :manage_airbrake, { airbrake: [:update] }
         end
 
-        settings default: {hash_field: '', occurrences_field: ''}, partial: 'settings/airbrake'
+        settings default: { hash_field: '', occurrences_field: '' }, partial: 'settings/airbrake'
       end
     end
   end

data/lib/redmine_airbrake_backend/error.rb

@@ -0,0 +1,78 @@
+require 'digest/md5'
+
+module RedmineAirbrakeBackend
+  # Error received by airbrake
+  class Error
+    attr_accessor :request
+    attr_reader :type, :message, :backtrace
+    attr_reader :airbrake_hash, :subject, :attachments
+
+    def initialize(error_data)
+      # Data
+      @data = error_data
+
+      # Type
+      @type = @data[:type]
+
+      # Message
+      @message = @data[:message]
+
+      # Backtrace
+      @backtrace = @data[:backtrace]
+
+      # Attachments
+      @attachments = @data[:attachments]
+
+      # Hash
+      @airbrake_hash = generate_hash
+
+      # Subject
+      @subject = generate_subject
+    end
+
+    private
+
+    def generate_hash
+      h = []
+      h << filter_hex_values(@type)
+      h << filter_hex_values(@message)
+      h += normalized_backtrace
+
+      Digest::MD5.hexdigest(h.compact.join("\n"))
+    end
+
+    def generate_subject
+      s = ''
+
+      if @type.blank? || @message.starts_with?("#{@type}:")
+        s = "[#{@airbrake_hash[0..7]}] #{@message}"
+      else
+        s = "[#{@airbrake_hash[0..7]}] #{@type}: #{@message}"
+      end
+
+      s[0..254].strip
+    end
+
+    def normalized_backtrace
+      if @backtrace.present?
+        @backtrace.map do |e|
+          "#{e[:file]}|#{normalize_method_name(e[:method])}|#{e[:number]}" rescue nil
+        end.compact
+      else
+        []
+      end
+    end
+
+    def normalize_method_name(method_name)
+      name = e[:method]
+        .downcase
+        .gsub(/_\d+_/, '') # ruby blocks
+
+      filter_hex_values(name)
+    end
+
+    def filter_hex_values(value)
+      value.gsub(/0x[0-9a-f]+/, '')
+    end
+  end
+end

data/lib/redmine_airbrake_backend/patches/projects_helper.rb

@@ -8,17 +8,18 @@ module RedmineAirbrakeBackend::Patches
       alias_method_chain :project_settings_tabs, :airbrake_backend_tab
     end
 
+    # add airbrake tab to project settings
     def project_settings_tabs_with_airbrake_backend_tab
       tabs = project_settings_tabs_without_airbrake_backend_tab
 
-      tabs.push({
-          :name => 'airbrake',
-          :action => :manage_airbrake,
-          :partial => 'projects/settings/airbrake',
-          :label => :project_module_airbrake
-        })
+      tabs.push(
+          name:    'airbrake',
+          action:  :manage_airbrake,
+          partial: 'projects/settings/airbrake',
+          label:   :project_module_airbrake
+        )
 
-      tabs.select{|tab| User.current.allowed_to?(tab[:action], @project)}
+      tabs.select { |tab| User.current.allowed_to?(tab[:action], @project) }
     end
   end
 end

data/lib/redmine_airbrake_backend/report/ios.rb

@@ -0,0 +1,71 @@
+module RedmineAirbrakeBackend
+  # Represents a report contained in a request
+  class Report
+    # iOS report
+    class Ios
+      # Parse an iOS crash log
+      def self.parse(data)
+        error = {
+          backtrace:   [],
+          attachments: []
+        }
+
+        header_finished      = false
+        next_line_is_message = false
+        crashed_thread       = false
+        indicent_identifier  = nil
+
+        data.split("\n").each do |line|
+          header_finished = true if line =~ /^(Application Specific Information|Last Exception Backtrace|Thread \d+( Crashed)?):$/
+
+          unless header_finished
+            key, value = line.split(':', 2)
+
+            next if key.blank? || value.blank?
+
+            error[:type]    = value.strip if key.strip == 'Exception Type'
+            error[:message] = value.strip if key.strip == 'Exception Codes'
+
+            indicent_identifier = value.strip if key.strip == 'Incident Identifier'
+          end
+
+          if next_line_is_message
+            next_line_is_message = false
+
+            error[:message] = line
+
+            if line =~ /^\*\*\* Terminating app due to uncaught exception '([^']+)', reason: '\*\*\* (.*)'$/
+              error[:type]    = Regexp.last_match(1)
+              error[:message] = Regexp.last_match(2)
+            end
+          end
+
+          crashed_thread = false if line =~ /^Thread \d+:$/
+
+          if crashed_thread
+            if line =~ /^(\d+)\s+([^\s]+)\s+(0x[0-9a-f]+)\s+(.+) \+ (\d+)$/
+              error[:backtrace] << {
+                file:   Regexp.last_match(2),
+                method: Regexp.last_match(4),
+                line:   Regexp.last_match(5),
+              }
+            end
+          end
+
+          crashed_thread = true if error[:backtrace].blank? && line =~ /^(Last Exception Backtrace|Thread \d+ Crashed):$/
+
+          next_line_is_message = true if line =~ /^Application Specific Information:$/
+        end
+
+        return nil if error.blank?
+
+        error[:attachments] << {
+          filename: "#{indicent_identifier}.crash",
+          data:     data
+        } if indicent_identifier.present?
+
+        error
+      end
+    end
+  end
+end

data/lib/redmine_airbrake_backend/request.rb

@@ -0,0 +1,132 @@
+require 'json'
+require 'base64'
+require 'redmine_airbrake_backend/error'
+
+module RedmineAirbrakeBackend
+  # Represents a request received by airbrake
+  class Request
+    class Error < StandardError; end
+    class Invalid < Error; end
+
+    attr_reader :api_key, :project, :tracker, :category, :priority, :assignee, :repository, :type
+    attr_reader :params, :notifier, :errors, :context, :request, :env
+    attr_reader :environment_name
+
+    def initialize(config, data = {})
+      # config
+      @config = self.class.parse_config(config)
+      raise Invalid.new('Encoded configuration in api-key is missing') if @config.blank?
+
+      # API key
+      @api_key = @config[:api_key]
+      raise Invalid.new('No or invalid api-key') if @api_key.blank?
+
+      # Project
+      @project = Project.where(identifier: @config[:project]).first
+      raise Invalid.new('No or invalid project') if @project.blank?
+
+      # Check configuration
+      raise Invalid.new('Custom field for notice hash is not configured!') if notice_hash_field.blank?
+
+      # Tracker
+      @tracker = record_for(@project.trackers, :tracker)
+      raise Invalid.new('No or invalid tracker') if @tracker.blank?
+      raise Invalid.new('Custom field for notice hash not available on selected tracker') if @tracker.custom_fields.where(id: notice_hash_field.id).first.blank?
+
+      # Category
+      @category = record_for(@project.issue_categories, :category)
+
+      # Priority
+      @priority = record_for(IssuePriority, :priority) || IssuePriority.default
+
+      # Assignee
+      @assignee = record_for(@project.users, :assignee, [:id, :login])
+
+      # Repository
+      @repository = @project.repositories.where(identifier: (@config[:repository] || '')).first
+
+      # Type
+      @type = @config[:type]
+
+      # Errors
+      @errors = (data[:errors] || [])
+      @errors.each { |e| e.request = self }
+
+      # Environment
+      @env = data[:env]
+
+      # Request
+      @request = data[:request]
+
+      # Context
+      @context = data[:context]
+
+      # Notifier
+      @notifier = data[:notifier]
+
+      # Params
+      @params = data[:params]
+
+      # Environment name
+      @environment_name   = (@env[:environment_name].presence || @env[:name].presence) if @env.present?
+      @environment_name ||= @context[:environment].presence if @context.present?
+    end
+
+    def notice_hash_field
+      custom_field(:hash_field)
+    end
+
+    def occurrences_field
+      custom_field(:occurrences_field)
+    end
+
+    def reopen?
+      reopen_regexp = project_setting(:reopen_regexp)
+
+      return false if environment_name.blank? || reopen_regexp.blank?
+
+      !!(environment_name =~ /#{reopen_regexp}/i)
+    end
+
+    def reopen_repeat_description?
+      !!project_setting(:reopen_repeat_description)
+    end
+
+    private
+
+    def record_for(on, config_key, fields = [:id, :name])
+      fields.each do |field|
+        val = on.where(field => @config[config_key]).first
+        return val if val.present?
+      end
+
+      project_setting(config_key)
+    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.where(id: global_setting(key)).first || CustomField.where(id: global_setting(key), is_for_all: true).first
+    end
+
+    def global_setting(key)
+      Setting.plugin_redmine_airbrake_backend[key]
+    end
+
+    def self.parse_config(api_key_data)
+      config = ::JSON.parse(api_key_data).symbolize_keys rescue nil
+
+      return config.symbolize_keys if config.is_a?(Hash)
+
+      config = ::JSON.parse(Base64.decode64(api_key_data)) rescue nil
+
+      return config.symbolize_keys if config.is_a?(Hash)
+
+      nil
+    end
+  end
+end