gitlab_exception_notification 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe39c86fd3708a6ad6b2115ab9cad7f2d8cb7bee
-  data.tar.gz: 3043cdf0626015276cb2bb694b458d142b0044fd
+  metadata.gz: 5605432556fe4818136d9665283a4cdc2539df00
+  data.tar.gz: d6e6c3db460a7b0042426ed2effe0cd4e35d41d9
 SHA512:
-  metadata.gz: 6347f9bd84b8acba6eef8def9248b995b02b04b41b23bf889317887468b35ee1da11adaf462aae12c0471bdd9b6d21d10f88bfc47b38423790edba2827e1415f
-  data.tar.gz: b04eb97d33d36fbb7e3654cc103d3377b63e64ac7eef231934261fd087454f81bc9d5b4d399c5a5276eccde4c6f568e89cdfbfd30118abff1b2093e8ce08c49a
+  metadata.gz: e39f635df1ecf5bec0c02398b1b2ed7c2f8e1a4b65c6c47ab526df220db91d8fa433961a7c6bdbfc23846050e4aa67c94f0080f2b9ce8e88ed4e21ec32f75a43
+  data.tar.gz: c5455fef59681269060cd1867fe423e4dcdcc5348d0ae490e2f3d89d72e66a45e5de9b94f94a2c04e1d5fc8aec1b83fb657d53ae464b1b0dfd8997ec72fdf2b2

data/lib/gitlab_exception_notification.rb

@@ -1,2 +1,16 @@
 module GitlabExceptionNotification
+
+  require "gitlab"
+  require 'digest'
+
+  REJECT_HEADERS = /HTTP_COOKIE|(rack.*)|(action_dispatch.*)/
+  SLINE = "
+  "
+  STAB = SLINE + "    "
+
+  PER_PAGE = 40
+
+  require 'gitlab_exception_notification/issue'
+  require 'gitlab_exception_notification/gitlab_notifier'
+
 end

data/lib/gitlab_exception_notification/gitlab_notifier.rb

@@ -1,139 +1,24 @@
 
-require "gitlab"
-
-REJECT_HEADERS = /HTTP_COOKIE|(rack.*)|(action_dispatch.*)/
-SLINE = "
-"
-STAB = SLINE + "    "
-
-PER_PAGE = 40
 
 module ExceptionNotifier
   class GitlabNotifier
     def initialize(options)
-      p "Booting issue notifications"
-      @client = Gitlab.client(endpoint: 'http://gitlab.42.fr/api/v3', private_token: options[:private_token])
-      @project_id = @client.project_search(options[:project_name]).first.id
-      @issues = get_all_issues
-    end
-
-    def issue_exists?(exception)
-      @issues = get_all_issues
-      rest = @issues.select do |i|
-        i.title == issue_title(exception) and i.description and i.description[exception.backtrace.first]
-      end
-      (rest.count > 0 ? rest.first.id : false)
-    end
-
-    def get_all_issues
-      page = 1
-      i = @client.issues(@project_id, per_page: PER_PAGE, page: page, order_by: :updated_at)
-      @issues = i
-      while i.count == PER_PAGE
-        i = @client.issues(@project_id, per_page: PER_PAGE, page: page, order_by: :updated_at)
-        @issues += i
-        page += 1
-      end
-      return @issues.flatten
-    end
-
-    def update_issue(id, exception)
-      issue = @client.issue(@project_id, id)
-      last = issue.updated_at.to_date
-      if last < 1.hour.ago        
-        begin
-          @client.edit_issue(@project_id, id, {state_event: "reopen"})
-          iss = @client.edit_issue(@project_id, id, {title: "#{issue.title}"})
-        rescue Exception => e
-          p "An error occured: #{e.inspect}"
-        end
-      else
-        body = ":fire: This issue occured again #{Time.current}.
-        \n#### Summary:\n
-        #{issue_summary(exception).map { |k, v|  "- #{k}: #{v}"}.join(SLINE)}
-        "
-        @client.reopen_issue(@project_id, id)
-        @client.create_issue_note @project_id, id, body
-      end
-    end
-      
-
-    # The issue title
-    def issue_title exception
-      title = []
-      title << "#{@kontroller.controller_name}##{@kontroller.action_name}" if @kontroller
-      title << "(#{exception.class})"
-      title << (exception.message.length > 120 ? exception.message[0..120] + "..." : exception.message)
-      title.join(' ')
-    end
-
-    def issue_summary exception
-      {
-        'URL': @request.url,
-        'HTTP Method': @request.request_method,
-        'IP address': @request.remote_ip,
-        'Parameters': md_hash(@request.filtered_parameters, STAB),
-        'Timestamp': Time.current,
-        'Server': Socket.gethostname,
-        'Rails root': (defined?(Rails) && Rails.respond_to?(:root) ? Rails.root : nil),
-        'Process': $$,
-        'session data': md_hash(@request.session.to_hash, STAB),
-      }
+      @options = options
     end
 
-    def issue_description exception
-
-      # Get a 'mardowned' backtrace
-      m_backtrace = "```#{SLINE} #{exception.backtrace.join(SLINE)}#{SLINE}```"
-
-      # Get the concerned file
-      file = exception.backtrace.first
-
-      description = ["#{exception.message} #{@kontroller ? 'in controller ' + @kontroller.controller_name + '#' + @kontroller.action_name : ''}"]
-      description << "File: #{file}"
-      {
-        'Summary': issue_summary(exception).map { |k, v|  "- #{k}: #{v}"}.join(SLINE),
-        'session id': @request.ssl? ? "[FILTERED]" : (@request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id])).inspect,
-        'data': @data,
-        'backtrace': m_backtrace,
-        'request headers': md_hash(@request.headers),
-        'environment': md_hash(@env.reject{|k, v| (REJECT_HEADERS =~ k).nil? })
-      }.reject{|k, v| v.nil? or v.blank?}.each do |k, v|
-        description << "--------------------------------"
-        description << "#### #{k.to_s.humanize}: "
-        description << v.to_s
-      end
-      description.join("\n\n")
-    end
-
-    def md_hash hash, pre = ""
-      hash.map { |k, v|  "#{pre}- **#{k}**: `#{v}`"}.join(SLINE)
-    end
-
-    def create_issue(exception)
-      @client.create_issue(@project_id, issue_title(exception), {description: issue_description(exception)})
-    end
 
     def exception_notification(env, exception, options={})
-      @env        = env
-      @exception  = exception
-      @options    = options.reverse_merge(env['exception_notifier.options'] || {})
-      @kontroller = env['action_controller.instance'] || MissingController.new
-      @request    = ActionDispatch::Request.new(env)
-      @sections   = @options[:sections]
-      @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
-      @sections   = @sections + %w(data) unless @data.empty?
-
-      if issue_id = issue_exists?(exception)
-        update_issue(issue_id, exception)
+      issue = GitlabExceptionNotification::Issue.new(env, exception, options)
+      if issue_id = issue.exists?
+        issue.update(issue_id)
       else
-        create_issue(exception)
+        issue.create
       end
     end
 
     def call(exception, options={})
       env = options[:env] || {}
-      exception_notification(env, exception, options)
+      exception_notification(env, exception, @options.merge(options))
     end
   end
 end

data/lib/gitlab_exception_notification/issue.rb

@@ -0,0 +1,142 @@
+module GitlabExceptionNotification
+
+  class Issue
+    
+    def initialize(env, exception, options={})
+      @env        = env
+      @exception  = exception
+      @options    = options.reverse_merge(env['exception_notifier.options'] || {})
+      @kontroller = env['action_controller.instance'] || MissingController.new
+      @request    = ActionDispatch::Request.new(env)
+      @data       = (env['exception_notifier.exception_data'] || {}).merge(options[:data] || {})
+      @digest     = digest
+      @client = Gitlab.client(endpoint: 'http://gitlab.42.fr/api/v3', private_token: options[:private_token])
+      @project_id = @client.project_search(options[:project_name]).first.id
+      @issues     = self.all
+    end
+
+    def create
+      @client.create_issue(@project_id, title, {description: description})
+    end
+
+    def update(id)
+      issue = @client.issue(@project_id, id)
+      last = issue.updated_at.to_date
+      if last < 1.hour.ago
+        begin
+          @client.edit_issue(@project_id, id, {state_event: "reopen"})
+          iss = @client.edit_issue(@project_id, id, {title: increment_title(issue)})
+        rescue Exception => e
+          p "An error occured: #{e.inspect}"
+        end
+      else
+        body = ":fire: This issue occured again #{Time.current}.
+        \n#### Summary:\n
+        #{summary.map { |k, v|  "- #{k}: #{v}"}.join(SLINE)}
+        "
+        @client.reopen_issue(@project_id, id)
+        @client.create_issue_note @project_id, id, body
+      end
+    end
+
+    def is_same_exception? issue
+      return false if issue.nil? or issue.description.nil?
+      issue.description.split(SLINE).last.strip == @digest
+    end
+
+    def exists?
+      # @issues = self.all
+      rest = @issues.select do |i|
+        is_same_exception?(i)
+      end
+      (rest.count > 0 ? rest.first.id : false)
+    end
+
+    def all
+      page = 1
+      i = @client.issues(@project_id, per_page: PER_PAGE, page: page, order_by: :updated_at)
+      @issues = i
+      while i.count == PER_PAGE
+        i = @client.issues(@project_id, per_page: PER_PAGE, page: page, order_by: :updated_at)
+        @issues += i
+        page += 1
+      end
+      return @issues.flatten
+    end
+
+    # =====================================================================================
+    #                                       Formatters
+    # =====================================================================================
+
+
+    # The issue title
+    def title
+      t = []
+      t << "#{@kontroller.controller_name}##{@kontroller.action_name}" if @kontroller
+      t << "(#{@exception.class})"
+      t << (@exception.message.length > 120 ? @exception.message[0..120] + "..." : @exception.message)
+      t.join(' ')
+    end
+
+    def summary
+      {
+        'URL': @request.url,
+        'HTTP Method': @request.request_method,
+        'IP address': @request.remote_ip,
+        'Parameters': md_hash(@request.filtered_parameters, STAB),
+        'Timestamp': Time.current,
+        'Server': Socket.gethostname,
+        'Rails root': (defined?(Rails) && Rails.respond_to?(:root) ? Rails.root : nil),
+        'Process': $$,
+        'session data': md_hash(@request.session.to_hash, STAB),
+      }
+    end
+
+    def description
+      # Get a 'mardowned' backtrace
+      m_backtrace = "```#{SLINE} #{@exception.backtrace.join(SLINE)}#{SLINE}```"
+
+      # Get the concerned file
+      file = @exception.backtrace.first
+
+      d = ["#{@exception.message} #{@kontroller ? 'in controller ' + @kontroller.controller_name + '#' + @kontroller.action_name : ''}"]
+      d << "File: #{file}"
+      {
+        'Summary': summary.map { |k, v|  "- #{k}: #{v}"}.join(SLINE),
+        'session id': @request.ssl? ? "[FILTERED]" : (@request.session['session_id'] || (@request.env["rack.session.options"] and @request.env["rack.session.options"][:id])).inspect,
+        'data': @data,
+        'backtrace': m_backtrace,
+        'request headers': md_hash(@request.headers),
+        'environment': md_hash(@env.reject{|k, v| (REJECT_HEADERS =~ k).nil? })
+      }.reject{|k, v| v.nil? or v.blank?}.each do |k, v|
+        d << "--------------------------------"
+        d << "#### #{k.to_s.humanize}: "
+        d << v.to_s
+      end
+      d << @digest
+      d.join(SLINE)
+    end
+
+    # =====================================================================================
+    #                                       Utilities
+    # =====================================================================================
+
+    protected
+
+    def increment_title issue
+      count = ((issue.title =~ /^\([0-9]+\).*/) == 0 ? issue.title.gsub(/^\(([0-9]*)\)(.*)/,'\1').to_i + 1 : 1)
+      new_title = ((issue.title =~ /^\([0-9]+\).*/) == 0 ? issue.title.gsub(/^\(([0-9]*)\)(.*)/, '(' + count.to_s + ')\2') : "(#{count.to_s}) #{issue.title}")
+      return new_title
+    end
+
+    def md_hash hash, pre = ""
+      hash.map { |k, v|  "#{pre}- **#{k}**: `#{v}`"}.join(SLINE)
+    end
+    
+    def digest
+      "EXC" + Digest::SHA256.hexdigest(@exception.to_s + @exception.backtrace.first.split(":in").first.to_s)
+    end
+
+
+  end
+end

data/lib/gitlab_exception_notification/version.rb

@@ -1,3 +1,3 @@
 module GitlabExceptionNotification
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_exception_notification
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andre Aubin
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.4
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,27 @@ dependencies:
         version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.4
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +82,7 @@ files:
 - Rakefile
 - lib/gitlab_exception_notification.rb
 - lib/gitlab_exception_notification/gitlab_notifier.rb
+- lib/gitlab_exception_notification/issue.rb
 - lib/gitlab_exception_notification/version.rb
 - test/dummy/README.rdoc
 - test/dummy/Rakefile