process_handler 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16ff070c1f4e04220f402a1269a7f2e41bd5f6ba
-  data.tar.gz: 551acbbe76055fff1fb1f49e1359d6a4e9eb48c5
+  metadata.gz: 3e495c8a8ec6bf3798941bd11f2792b9a28f1c95
+  data.tar.gz: 8923ae242c65ba6120b48184588b2534060ff831
 SHA512:
-  metadata.gz: 1da185b0c6a35a84a5989aaeebdc4ac72914f439999b8bce185f117f46400239c097b50238807a453d526042193b295ff85162c5156429cb688bc7a4b1a77d60
-  data.tar.gz: 42f98184302acd238e21ca550956fc47e78f4b7852c5bde1bad6f42679d897d4db3b769e0b619a3e41cc1134081357accdac6b4eb6a7ed99d222d31029966a25
+  metadata.gz: 337003df5486731c3b8addbb93e85159e664f20996fda1b22252e111d09831a1b735b3962f242f3f1ec44c88340025ca80356ebf468a1f610be5bc96b2870812
+  data.tar.gz: 33b8e7e9d3d0f4368a53f11610449b0e5394177cf286495a52d843885e077425d3ff486621ae9a107c8ad2e05e91ec3550b7bea80f79b4de5436c5049379bfc4

data/Gemfile

@@ -5,7 +5,7 @@ gem 'rufus-scheduler', '~> 3.2.1'
 gem 'logasm'
 
 group :test do
-  gem 'rspec', '~> 3.1.0'
+  gem 'rspec', '~> 3.4'
   gem 'pry'
 end
 

data/lib/salemove/process_handler/cron_process.rb

@@ -13,9 +13,7 @@ module Salemove
       end
 
       def on_error(job, error)
-        if @exception_notifier
-          @exception_notifier.notify_or_ignore(error, cgi_data: ENV.to_hash)
-        end
+        @exception_notifier.notify_or_ignore(error, {}) if @exception_notifier
         super
       end
 

data/lib/salemove/process_handler/notifier_factory.rb

@@ -8,19 +8,20 @@ module Salemove
 
       def self.get_notifier(process_name, conf)
         if conf && conf[:type] == 'airbrake'
-          Airbrake.configure do |airbrake|
-            airbrake.async = true
-            airbrake.environment_name = conf.fetch(:environment_name)
-            airbrake.secure = true
+          notifier_name = conf[:notifier_name] || :default
+          Airbrake.configure(notifier_name) do |airbrake|
+            airbrake.environment = conf.fetch(:environment)
             airbrake.host = conf.fetch(:host)
-            airbrake.api_key = conf.fetch(:api_key)
-            [/_HOST$/, /_TCP$/, /_UDP$/, /_PROTO$/, /_ADDR$/, 'PWD',
-            'GEM_HOME', 'PATH', 'SERVICE_NAME', 'RUBY_MAJOR', 'RUBY_VERSION',
-            'RUN_ENV', 'HOME', 'RUBYGEMS_VERSION', 'BUNDLER_VERSION'].each {
-              | param_whitelist_filter| airbrake.params_whitelist_filters << param_whitelist_filter
-            }
+            airbrake.project_id = conf.fetch(:project_id)
+            airbrake.project_key = conf.fetch(:project_key)
+            airbrake.ignore_environments = conf[:ignore_environments] if conf[:ignore_environments]
+            airbrake.whitelist_keys = [
+              /_HOST$/, /_TCP$/, /_UDP$/, /_PROTO$/, /_ADDR$/, 'PWD',
+              'GEM_HOME', 'PATH', 'SERVICE_NAME', 'RUBY_MAJOR', 'RUBY_VERSION',
+              'RACK_ENV', 'RUN_ENV', 'HOME', 'RUBYGEMS_VERSION', 'BUNDLER_VERSION'
+            ]
           end
-          Airbrake
+          AirbrakeNotifier.new
         elsif conf && conf[:type] == 'growl'
           GrowlNotifier.new(process_name)
         elsif conf && conf[:type] == 'terminal-notifier'
@@ -29,13 +30,19 @@ module Salemove
       end
     end
 
+    class AirbrakeNotifier
+      def notify_or_ignore(error, params)
+        Airbrake.notify(error, params)
+      end
+    end
+
     class GrowlNotifier
       def initialize(process_name)
         @process_name = process_name
       end
 
       def notify_or_ignore(error, _)
-        Growl.notify error.message, title: "Error in #{@process_name}"
+        Growl.notify(error.message, title: "Error in #{@process_name}")
       end
     end
 

data/lib/salemove/process_handler/pivot_process.rb

@@ -113,13 +113,7 @@ module Salemove
           message = [exception.inspect, *exception.backtrace].join("\n")
           @logger.error(message, input)
 
-          if @exception_notifier
-            @exception_notifier.notify_or_ignore(
-              exception,
-              cgi_data: ENV.to_hash,
-              parameters: input
-            )
-          end
+          @exception_notifier.notify_or_ignore(exception, input) if @exception_notifier
         end
       end
 
@@ -207,13 +201,7 @@ module Salemove
           message = [exception.inspect, *exception.backtrace].join("\n")
           @logger.error(message, input)
 
-          if @exception_notifier
-            @exception_notifier.notify_or_ignore(
-              exception,
-              cgi_data: ENV.to_hash,
-              parameters: input
-            )
-          end
+          @exception_notifier.notify_or_ignore(exception, input) if @exception_notifier
 
           { success: false, error: exception.message }
         end

data/lib/salemove/process_handler/version.rb

@@ -1,5 +1,5 @@
 module Salemove
   module ProcessHandler
-    VERSION = '2.3.0'
+    VERSION = '3.0.0'
   end
 end

data/process_handler.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'airbrake', '~> 4.3'
+  spec.add_dependency 'airbrake', '~> 7.4'
+  spec.add_dependency 'timers', '~> 4.1.2'
   spec.add_dependency 'sucker_punch', '~> 1.1' # for async airbrake notifications
   spec.add_dependency 'growl'
   spec.add_dependency 'terminal-notifier'

data/spec/process_handler/airbrake_spec.rb

@@ -1,63 +1,61 @@
 require 'spec_helper'
-require 'airbrake'
-require 'airbrake/notice'
 require 'salemove/process_handler/notifier_factory'
+require 'securerandom'
 
 describe 'Airbrake configuration' do
-
-  let (:notice) { Airbrake::Notice.new(notice_args.merge(custom_notice_args)) }
-  let (:environment_name) { 'SOME_ENVIRONMENT' }
-  let (:notifier_factory_conf) { {:type => 'airbrake',
-                                  :host => 'localhost',
-                                  :api_key => 'abc123',
-                                  :environment_name => environment_name} }
-  let (:airbrake) { ProcessHandler::NotifierFactory.get_notifier('Process name', notifier_factory_conf) }
-  # Notice needs Airbrake configuration merged with :exception for creating the exception notification
-  let (:notice_args) { {:exception => Exception.new}.merge(airbrake.configuration) }
-  let (:custom_notice_args) { {} }
-  let (:filtered) { '[FILTERED]' }
-
-  # Uses Airbrake configuration's 'params_whitelist_filters' param for filtering
-  describe 'whitelist filtering' do
-
-    let (:custom_notice_args) {
-      {
-        :params_filters => [], # Remove blacklist to test whitelist
-        :parameters => {
-          'API_PORT_80_TCP_PROTO' => 'tcp',
-          'HOME' => '/home/sm',
-          'SECRET_PASS' => 'Parool123',
-          'SOME_PROTO_KEY' => 'value',
-          'PROTO_KEY' => 'abc123'
-        },
-        :cgi_data => {
-          'HTTP_HOST' => 'localhost:3001',
-          'RANDOM' => 'value',
-          'HOME' => 'sweet home'
-        }
-      }
+  let(:environment) { 'SOME_ENVIRONMENT' }
+  let(:config) { airbrake_config.merge(type: 'airbrake') }
+  let(:airbrake_config) { base_params }
+  let(:base_params) do
+    {
+      environment: environment,
+      host: 'localhost',
+      project_id: '123456',
+      project_key: 'abc123',
+      ignore_environments: ['dev'],
+      # Airbrake module raises an error when same notifier configured multiple times
+      # Provide a random notifier name for each test case
+      notifier_name: SecureRandom.hex
     }
+  end
+  let(:airbrake) do
+    ProcessHandler::NotifierFactory.get_notifier('Process name', config)
+  end
 
-    it 'allows parameters by regex' do
-      expect(notice[:parameters]['API_PORT_80_TCP_PROTO']).to eq 'tcp'
-      expect(notice[:cgi_data]['HTTP_HOST']).to eq 'localhost:3001'
+  context 'when all params set' do
+    it 'does not raise an error' do
+      expect { airbrake }.not_to raise_error
     end
+  end
 
-    it 'allows parameters by string' do
-      expect(notice[:parameters]['HOME']).to eq '/home/sm'
-      expect(notice[:cgi_data]['HOME']).to eq 'sweet home'
-    end
+  context 'when project_id is not a number' do
+    let(:airbrake_config) { base_params.merge(project_id: 'abc') }
 
-    it 'filters variables not in whitelist' do
-      expect(notice[:parameters]['SECRET_PASS']).to eq filtered
-      expect(notice[:parameters]['SOME_PROTO_KEY']).to eq filtered
-      expect(notice[:parameters]['PROTO_KEY']).to eq filtered
-      expect(notice[:cgi_data]['RANDOM']).to eq filtered
+    it 'raises error' do
+      expect { airbrake }.to raise_error
     end
+  end
 
+  context 'when ignore_environments missing' do
+    before { base_params.delete(:ignore_environments) }
+
+    it 'does not raise an error' do
+      expect { airbrake }.not_to raise_error
+    end
   end
 
-  it 'configures environment_name' do
-    expect(notice[:environment_name]).to eq environment_name
+  shared_examples_for 'raises error if config param missing' do |key|
+    context "when #{key} missing" do
+      before { base_params.delete(key) }
+
+      it 'raises error' do
+        expect { airbrake }.to raise_error
+      end
+    end
   end
+
+  it_behaves_like 'raises error if config param missing', :environment
+  it_behaves_like 'raises error if config param missing', :host
+  it_behaves_like 'raises error if config param missing', :project_id
+  it_behaves_like 'raises error if config param missing', :project_key
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process_handler
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '7.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '7.4'
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.2
 - !ruby/object:Gem::Dependency
   name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: ''