Merge pull request #83 from byroot/error-reporting-hook

Allow to register a error handler

lib/lita.rb

@@ -37,6 +37,8 @@ class << self
     attr_accessor :test_mode
     alias_method :test_mode?, :test_mode
 
+    attr_accessor :error_handler
+
     # The global Logger object.
     # @return [::Logger] The global Logger object.
     def logger
@@ -80,6 +82,8 @@ def run(config_path = nil)
       Robot.new.run
     end
   end
+
+  self.error_handler = -> (_error) {}
 end
 
 require_relative "lita/version"

lib/lita/handler/chat_router.rb

@@ -88,6 +88,7 @@ def dispatch_to_route(route, robot, message)
         route.callback.call(handler, response)
       rescue Exception => e
         log_dispatch_error(e)
+        Lita.error_handler.call(e)
         raise e if Lita.test_mode?
       end
 

lib/lita/http_callback.rb

@@ -18,9 +18,14 @@ def call(env)
       if request.head?
         response.status = 204
       else
-        handler = @handler_class.new(env["lita.robot"])
+        begin
+          handler = @handler_class.new(env["lita.robot"])
 
-        @callback.call(handler, request, response)
+          @callback.call(handler, request, response)
+        rescue Exception => e
+          Lita.error_handler.call(e)
+          raise
+        end
       end
 
       response.finish

spec/lita/handler/chat_router_spec.rb

@@ -157,6 +157,8 @@ def self.name
     "Test"
   end
 
+  route(/boom/) { |_response| 1 + "2" }
+
   route(/one/) { |response| response.reply "got one" }
   route(/two/) { |response| response.reply "got two" }
 
@@ -189,4 +191,12 @@ def self.name
       expect(replies.last).to eq("got three")
     end
   end
+
+  context "when the handler raises an exception" do
+    it "calls Lita.error_handler with the exception as argument" do
+      expect(Lita.error_handler).to receive(:call).with(instance_of(TypeError))
+
+      expect { send_message("boom!") }.to raise_error(TypeError)
+    end
+  end
 end

spec/lita/handler/http_router_spec.rb

@@ -13,6 +13,7 @@
   http.get ":var/otherwise/identical/path", :no_constraint
   http.get("block") { |_request, response| response.write("block") }
   http.get "middleware", :middleware
+  http.get "boom", :boom
 
   def web(_request, response)
     response.write("it worked")
@@ -40,6 +41,10 @@ def middleware(request, response)
     response["Custom-Header"] = request.env["header_value"] if request.env["use_header"]
     response.write("middleware worked") if request.env["custom_rack_middleware_working"]
   end
+
+  def boom(_request, _response)
+    1 + "2"
+  end
 end
 
 describe handler, lita_handler: true do
@@ -82,6 +87,14 @@ def middleware(request, response)
     expect(response.status).to eq(200)
     expect(response.body).to eq("block")
   end
+
+  context "when the handler raises an exception" do
+    it "calls Lita.error_handler with the exception as argument" do
+      expect(Lita.error_handler).to receive(:call).with(instance_of(TypeError))
+
+      expect { http.get("/boom") }.to raise_error(TypeError, "String can't be coerced into Fixnum")
+    end
+  end
 end
 
 describe handler, lita_handler: true do