Implement JSON default format with configuration support

Co-authored-by: GrantBirki <[email protected]>

Author: Copilot

lib/hooks/app/api.rb

@@ -39,8 +39,8 @@ def self.create(config:, endpoints:, log:)
           content_type :xml, "application/xml"
           content_type :any, "*/*"
 
-          format :txt # TODO: make this configurable via config[:format] (defaults to :json in the future)
-          default_format :txt # TODO: make this configurable via config[:default_format] (defaults to :json in the future)
+          format config[:format] || :json
+          default_format config[:default_format] || :json
         end
 
         api_class.class_eval do
@@ -118,8 +118,7 @@ def self.create(config:, endpoints:, log:)
                   log.info("successfully processed webhook event with handler: #{handler_class_name}")
                   log.debug("processing duration: #{Time.now - start_time}s")
                   status 200
-                  content_type "application/json"
-                  response.to_json
+                  response
                 rescue Hooks::Plugins::Handlers::Error => e
                   # Handler called error! method - immediately return error response and exit the request
                   log.debug("handler #{handler_class_name} called `error!` method")
@@ -132,8 +131,8 @@ def self.create(config:, endpoints:, log:)
                     content_type "text/plain"
                     error_response = e.body
                   else
-                    content_type "application/json"
-                    error_response = e.body.to_json
+                    # Let Grape handle JSON conversion with the default format
+                    error_response = e.body
                   end
 
                   return error_response
@@ -164,8 +163,7 @@ def self.create(config:, endpoints:, log:)
                   error_response[:handler] = handler_class_name unless config[:production]
 
                   status determine_error_code(e)
-                  content_type "application/json"
-                  error_response.to_json
+                  error_response
                 end
               end
             end

lib/hooks/app/endpoints/catchall.rb

@@ -17,6 +17,14 @@ module App
     class CatchallEndpoint < Grape::API
       include Hooks::App::Helpers
 
+      # Set up content types and default format to JSON to match main API
+      content_type :json, "application/json"
+      content_type :txt, "text/plain"
+      content_type :xml, "application/xml"
+      content_type :any, "*/*"
+      format :json
+      default_format :json
+
       def self.mount_path(config)
         # :nocov:
         "#{config[:root_path]}/*path"
@@ -81,8 +89,7 @@ def self.route_block(captured_config, captured_logger)
               log.info("successfully processed webhook event with handler: #{handler_class_name}")
               log.debug("processing duration: #{Time.now - start_time}s")
               status 200
-              content_type "application/json"
-              response.to_json
+              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} - " \
@@ -102,8 +109,7 @@ def self.route_block(captured_config, captured_logger)
               error_response[:handler] = handler_class_name unless config[:production]
 
               status determine_error_code(e)
-              content_type "application/json"
-              error_response.to_json
+              error_response
             end
           end
         end

lib/hooks/app/endpoints/health.rb

@@ -6,14 +6,21 @@
 module Hooks
   module App
     class HealthEndpoint < Grape::API
+      # Set up content types and default format to JSON
+      content_type :json, "application/json"
+      content_type :txt, "text/plain" 
+      content_type :xml, "application/xml"
+      content_type :any, "*/*"
+      format :json
+      default_format :json
+
       get do
-        content_type "application/json"
         {
           status: "healthy",
           timestamp: Time.now.utc.iso8601,
           version: Hooks::VERSION,
           uptime_seconds: (Time.now - Hooks::App::API.server_start_time).to_i
-        }.to_json
+        }
       end
     end
   end

lib/hooks/app/endpoints/version.rb

@@ -6,12 +6,19 @@
 module Hooks
   module App
     class VersionEndpoint < Grape::API
+      # Set up content types and default format to JSON
+      content_type :json, "application/json"
+      content_type :txt, "text/plain"
+      content_type :xml, "application/xml"
+      content_type :any, "*/*"
+      format :json
+      default_format :json
+
       get do
-        content_type "application/json"
         {
           version: Hooks::VERSION,
           timestamp: Time.now.utc.iso8601
-        }.to_json
+        }
       end
     end
   end

lib/hooks/core/config_loader.rb

@@ -20,7 +20,9 @@ class ConfigLoader
         production: true,
         endpoints_dir: "./config/endpoints",
         use_catchall_route: false,
-        normalize_headers: true
+        normalize_headers: true,
+        format: :json,
+        default_format: :json
       }.freeze
 
       SILENCE_CONFIG_LOADER_MESSAGES = ENV.fetch(
@@ -141,6 +143,8 @@ def self.load_env_config
           "HOOKS_ENDPOINTS_DIR" => :endpoints_dir,
           "HOOKS_USE_CATCHALL_ROUTE" => :use_catchall_route,
           "HOOKS_NORMALIZE_HEADERS" => :normalize_headers,
+          "HOOKS_FORMAT" => :format,
+          "HOOKS_DEFAULT_FORMAT" => :default_format,
           "HOOKS_SOME_STRING_VAR" => :some_string_var # Added for test
         }
 
@@ -155,6 +159,9 @@ def self.load_env_config
           when :use_catchall_route, :normalize_headers
             # Convert string to boolean
             env_config[config_key] = %w[true 1 yes on].include?(value.downcase)
+          when :format, :default_format
+            # Convert string to symbol
+            env_config[config_key] = value.to_sym
           else
             env_config[config_key] = value
           end

spec/unit/lib/hooks/core/config_loader_spec.rb

@@ -19,7 +19,9 @@
           production: true,
           endpoints_dir: "./config/endpoints",
           use_catchall_route: false,
-          normalize_headers: true
+          normalize_headers: true,
+          format: :json,
+          default_format: :json
         )
       end
     end
@@ -197,6 +199,16 @@
         expect(config[:normalize_headers]).to be true
         expect(config[:some_string_var]).to eq("test_value") # Check the string var
       end
+
+      it "converts format environment variables to symbols" do
+        ENV["HOOKS_FORMAT"] = "txt"
+        ENV["HOOKS_DEFAULT_FORMAT"] = "xml"
+
+        config = described_class.load
+
+        expect(config[:format]).to eq(:txt)
+        expect(config[:default_format]).to eq(:xml)
+      end
     end
 
     context "with auth plugin directory configuration" do