Implement error handling for simple text errors in BoomtownWithError handler and add corresponding acceptance test

Author: GrantBirki

lib/hooks/app/api.rb

@@ -112,24 +112,22 @@ def self.create(config:, endpoints:, log:)
                   content_type "application/json"
                   response.to_json
                 rescue Hooks::Plugins::Handlers::Error => e
-                  # Handler called error! method - return the specified error response
-                  log.info("handler returned error response: #{handler_class_name} - status: #{e.status} - body: #{e.body}")
+                  # Handler called error! method - immediately return error response and exit the request
+                  log.debug("handler #{handler_class_name} called `error!` method")
 
-                  # Call lifecycle hooks: on_response (treating error! as a valid response)
-                  if defined?(rack_env)
-                    Core::PluginLoader.lifecycle_plugins.each do |plugin|
-                      plugin.on_response(rack_env, e.body)
-                    end
-                  end
+                  error_response = nil
 
                   status e.status
-                  content_type "application/json"
                   case e.body
                   when String
-                    e.body
+                    content_type "text/plain"
+                    error_response = e.body
                   else
-                    e.body.to_json
+                    content_type "application/json"
+                    error_response = e.body.to_json
                   end
+
+                  return error_response
                 rescue StandardError => e
                   err_msg = "Error processing webhook event with handler: #{handler_class_name} - #{e.message} " \
                     "- request_id: #{request_id} - path: #{full_path} - method: #{http_method} - " \

spec/acceptance/acceptance_tests.rb

@@ -508,6 +508,17 @@ def expired_unix_timestamp(seconds_ago = 600)
         expect(body["foo"]).to eq("bar")
         expect(body["truthy"]).to eq(true)
       end
+
+      it "sends a POST request to the /webhooks/boomtown_with_error endpoint and it explodes with a simple text error" do
+        payload = { boom_simple_text: true }.to_json
+        response = make_request(:post, "/webhooks/boomtown_with_error", payload, json_headers)
+        expect_response(response, Net::HTTPInternalServerError, "boomtown_with_error: the payload triggered a simple text boomtown error")
+
+        body = response.body
+        expect(body).to eq("boomtown_with_error: the payload triggered a simple text boomtown error")
+        expect(response.content_type).to eq("text/plain")
+        expect(response.code).to eq("500")
+      end
     end
   end
 end

spec/acceptance/plugins/handlers/boomtown_with_error.rb

@@ -18,6 +18,13 @@ def call(payload:, headers:, env:, config:)
       }, 500)
     end
 
+    if payload["boom_simple_text"] == true
+      log.error("boomtown simple text error triggered by payload: #{payload.inspect} - request_id: #{env["hooks.request_id"]}")
+
+      # Use Grape's `error!` method to return a simple text error response
+      error!("boomtown_with_error: the payload triggered a simple text boomtown error", 500)
+    end
+
     return { status: "ok" }
   end
 end