Merge pull request #34 from can-i-has-a-job-plz/master

Add backtrace to unknown errors messages

lib/logux.rb

@@ -50,7 +50,8 @@ def initialize(msg, meta: nil)
 
   configurable :logux_host, :verify_authorized,
                :password, :logger,
-               :on_error, :auth_rule
+               :on_error, :auth_rule,
+               :render_backtrace_on_error
 
   configuration_defaults do |config|
     config.logux_host = 'localhost:1338'
@@ -61,6 +62,7 @@ def initialize(msg, meta: nil)
     end
     config.on_error = proc {}
     config.auth_rule = proc { false }
+    config.render_backtrace_on_error = false
   end
 
   def self.add(type, meta: {})

lib/logux/error_renderer.rb

@@ -16,12 +16,20 @@ def message
         build_message(exception, exception.message)
       when StandardError
         # some runtime error that should be fixed
-        ['error', 'Please look server logs for more information']
+        render_stardard_error(exception)
       end
     end
 
     private
 
+    def render_stardard_error(exception)
+      if Logux.configuration.render_backtrace_on_error
+        ['error', exception.backtrace]
+      else
+        ['error', 'Please look server logs for more information']
+      end
+    end
+
     def build_message(exception, additional_info)
       [
         exception.class.name.demodulize.camelize(:lower).gsub(/Error/, ''),

spec/logux/error_renderer_spec.rb

@@ -28,12 +28,29 @@ def build_message(exception)
       expect(build_message(exception)).to eq(%w[unauthorized test])
     end
 
-    it 'returns correct error message for some unknown error' do
-      exception = StandardError.new
+    context 'when Logux.configuration.render_backtrace_on_error is true' do
+      around do |example|
+        Logux.configuration.render_backtrace_on_error = true
+        example.run
+        Logux.configuration.render_backtrace_on_error = false
+      end
+
+      it 'returns correct error with backtrace for some unknown error' do
+        exception = StandardError.new
+        exception.set_backtrace(caller)
+
+        expect(build_message(exception)).to eq(['error', exception.backtrace])
+      end
+    end
+
+    context 'when Logux.configuration.render_backtrace_on_error is false' do
+      it 'returns correct error message for some unknown error' do
+        exception = StandardError.new
 
-      expect(build_message(exception)).to eq(
-        ['error', 'Please look server logs for more information']
-      )
+        expect(build_message(exception)).to eq(
+          ['error', 'Please look server logs for more information']
+        )
+      end
     end
   end
 end