roqua-support 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 803305fe155529f0da3dfa1ab3e12ac47b94f111
-  data.tar.gz: 61f3227e70ac8bf18a145d07e726ef8743ff2d85
+  metadata.gz: 283954f3f130b821ad3df69490094c4117afe0d7
+  data.tar.gz: e3e51403c9b74b86754ed04536f2731a47ac4dc4
 SHA512:
-  metadata.gz: 693863caf7baa5a55fda02d6c75f8fe3b9d5e7fbd144270f704dc1aac1ac881ac6d4ff3ce5ca22a594bf69f19efa491910a071fb2b3153c23f46f742cfeab8c2
-  data.tar.gz: 2f09d28afd8b73299c5754a739e66001af653000c649616c6ce1a4721410d45ed8d436ac738a745e5d90522a32f99acf58386ba893eb0d39e021f0da7313df77
+  metadata.gz: 0e51b6995e2dd2fe974c7ef00ea4f5d2408950296fb9a90eb28c654f5e1b4dd88fe5f7f961c1767c660218e39f5b35301296c52021252cd1c14275b7874f39b4
+  data.tar.gz: 03cb728c081c0e926db89b5c8814281c904d4f608c82c17db3764c6f160e317aa0995c2297e58a558681bbed3ded85f10554417fb2a21b128aafa4e24fa22201

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.14 / 2014-11-13
+
+* Don't put request data under params
+* Robustify reporting exceptions
+
 ## 0.1.13 / 2014-11-12
 
 * Add support for reporting request data to Airbrake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roqua-support (0.1.13)
+    roqua-support (0.1.14)
       activesupport (>= 3.2, < 5.0)
 
 GEM

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.13'
+    VERSION = '0.1.14'
   end
 end

data/lib/roqua/support/errors.rb

@@ -9,46 +9,92 @@ module Roqua
         @extra_parameters = hash
       end
 
-      def self.report(exception, extra_params = {})
+      def self.report(exception, context = {})
         return if const_defined?(:Rails) and Rails.env.test?
-        controller = extra_params.delete :controller
-        parameters = extra_parameters.merge(extra_params)
-
+        parameters, controller = merge_parameters(context)
         # Notify Roqua logging
-        if Roqua.respond_to?(:logger)
-          Roqua.logger.error('roqua.exception',
-                             class_name: exception.class.to_s,
-                             message: exception.message,
-                             backtrace: exception.backtrace,
-                             parameters: parameters)
+        log_exception(exception, parameters)
+        # Notify Airbrake
+        notify_airbrake(exception, controller, parameters)
+        # Notify AppSignal
+        notify_appsignal(exception, parameters)
+      end
+
+      private
+
+      def self.merge_parameters(context)
+        begin
+          if context.is_a?(Hash) && extra_parameters.is_a?(Hash)
+            controller = context.delete :controller
+            parameters = extra_parameters.merge(context)
+          elsif context.is_a?(Hash)
+            controller = context.delete :controller
+            parameters = context
+          elsif extra_parameters.is_a?(Hash)
+            parameters = extra_parameters
+          end
+          [parameters, controller]
+        rescue Exception
         end
+      end
 
-        # Notify Airbrake
-        if const_defined?(:Airbrake)
-          parameters = parameters.merge controller.airbrake_request_data if controller
-          Airbrake.notify_or_ignore(exception, parameters: parameters)
+      def self.log_exception(exception, parameters = {})
+        begin
+          if Roqua.respond_to?(:logger)
+            Roqua.logger.error('roqua.exception',
+                               class_name: exception.class.to_s,
+                               message: exception.message,
+                               backtrace: exception.backtrace,
+                               parameters: parameters)
+          end
+        rescue Exception
         end
+      end
 
-        # Notify AppSignal
-        if const_defined?(:Appsignal) and
-           not Appsignal.is_ignored_exception?(exception)
-          # TODO: If and when https://github.com/appsignal/appsignal/pull/9 is merged,
-          # this functionality should be supported directly by Appsignal.send_exception.
-          # Appsignal.send_exception(exception, parameters: parameters)
-
-          if Appsignal.active?
-            # Hackety hack around stateful mess of Appsignal gem
-            if Appsignal::Transaction.current
-              Appsignal::Transaction.current.set_tags(parameters)
-              Appsignal::Transaction.current.add_exception(exception)
-            else
-              transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
-              transaction.set_tags(parameters)
-              transaction.add_exception(exception)
-              transaction.complete!
-              Appsignal.agent.send_queue
+      def self.notify_airbrake(exception, controller, parameters = {})
+        begin
+          if const_defined?(:Airbrake)
+            if controller && controller.respond_to?(:airbrake_request_data)
+              request_data = controller.airbrake_request_data
+              if request_data.is_a?(Hash)
+                request_data[:parameters] ||= {}
+                if request_data[:parameters].is_a?(Hash)
+                  request_data[:parameters] = parameters.merge request_data[:parameters]
+                end
+              else
+                request_data = nil
+              end
+            end
+            request_data ||= {parameters: parameters}
+            Airbrake.notify_or_ignore(exception, request_data)
+          end
+        rescue Exception
+        end
+      end
+
+      def self.notify_appsignal(exception, parameters = {})
+        begin
+          if const_defined?(:Appsignal) and
+             not Appsignal.is_ignored_exception?(exception)
+            # TODO: If and when https://github.com/appsignal/appsignal/pull/9 is merged,
+            # this functionality should be supported directly by Appsignal.send_exception.
+            # Appsignal.send_exception(exception, parameters: parameters)
+
+            if Appsignal.active?
+              # Hackety hack around stateful mess of Appsignal gem
+              if Appsignal::Transaction.current
+                Appsignal::Transaction.current.set_tags(parameters)
+                Appsignal::Transaction.current.add_exception(exception)
+              else
+                transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
+                transaction.set_tags(parameters)
+                transaction.add_exception(exception)
+                transaction.complete!
+                Appsignal.agent.send_queue
+              end
             end
           end
+        rescue Exception
         end
       end
     end

data/spec/roqua/support/errors_spec.rb

@@ -37,8 +37,27 @@ describe 'Error reporting' do
     end
 
     it 'adds request data when a controller is passed in' do
-      controller = double(airbrake_request_data: {request: 'data'})
-      Airbrake.should_receive(:notify_or_ignore).with(exception, parameters: {request: 'data'})
+      controller = double(airbrake_request_data: {request: 'data', parameters: {request: 'param'}})
+      expect(Airbrake).to receive(:notify_or_ignore)
+                      .with(exception, request: 'data', parameters: {request: 'param', some: 'context'})
+      Roqua::Support::Errors.report exception, controller: controller, some: 'context'
+    end
+
+    it 'does not fail with extra parameters of incompatible type' do
+      Roqua::Support::Errors.extra_parameters = ['extra', 'param']
+      expect(Airbrake).to receive(:notify_or_ignore).with(exception, parameters: {})
+      Roqua::Support::Errors.report exception
+      Roqua::Support::Errors.extra_parameters = {}
+    end
+
+    it 'does not fail with context of incompatible type' do
+      expect(Airbrake).to receive(:notify_or_ignore).with(exception, parameters: {})
+      Roqua::Support::Errors.report exception, ['controller', 'extra_param']
+    end
+
+    it 'does not fail with request data of incompatible type' do
+      controller = double(airbrake_request_data: ['request', 'data'])
+      expect(Airbrake).to receive(:notify_or_ignore).with(exception, parameters: {})
       Roqua::Support::Errors.report exception, controller: controller
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport