pact_broker 2.105.0 → 2.107.0.beta.1

data/lib/pact_broker/api/resources/base_resource.rb

@@ -10,6 +10,8 @@ require "pact_broker/pacts/pact_params"
 require "pact_broker/api/resources/authentication"
 require "pact_broker/api/resources/authorization"
 require "pact_broker/errors"
+require "pact_broker/api/resources/error_handling_methods"
+require "pact_broker/api/contracts/utf_8_validation"
 
 module PactBroker
   module Api
@@ -22,6 +24,8 @@ module PactBroker
         include PactBroker::Api::PactBrokerUrls
         include PactBroker::Api::Resources::Authentication
         include PactBroker::Api::Resources::Authorization
+        include PactBroker::Api::Resources::ErrorHandlingMethods
+        include PactBroker::Api::Contracts::UTF8Validation
 
         include PactBroker::Logging
 
@@ -63,12 +67,11 @@ module PactBroker
           end
         end
 
-        # The path_info segments aren't URL decoded
+        # Remove the non-path compontents in the path_info (eg. the application context, which is naughtily passed in via the path_info)
         def identifier_from_path
           @identifier_from_path ||= request.path_info.each_with_object({}) do | (key, value), hash|
-            if value.is_a?(String)
-              hash[key] = URI.decode(value)
-            elsif value.is_a?(Symbol) || value.is_a?(Numeric)
+            case value
+            when String, Symbol, Numeric
               hash[key] = value
             end
           end
@@ -111,45 +114,27 @@ module PactBroker
           { user_options: decorator_context(options) }
         end
 
-        def handle_exception(error)
-          error_reference = PactBroker::Errors.generate_error_reference
-          application_context.error_logger.call(error, error_reference, request.env)
-          if PactBroker::Errors.reportable_error?(error)
-            PactBroker::Errors.report(error, error_reference, request.env)
-          end
-          response.body = application_context.error_response_body_generator.call(error, error_reference, request.env)
-        end
-
         # rubocop: disable Metrics/CyclomaticComplexity
         def params(options = {})
           return options[:default] if options.key?(:default) && request_body.empty?
 
           symbolize_names = !options.key?(:symbolize_names) || options[:symbolize_names]
-          if symbolize_names
-            @params_with_symbol_keys ||= JSON.parse(request_body, { symbolize_names: true }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
-          else
-            @params_with_string_keys ||= JSON.parse(request_body, { symbolize_names: false }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
+          parsed_params = if symbolize_names
+                            @params_with_symbol_keys ||= JSON.parse(request_body, { symbolize_names: true }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
+                          else
+                            @params_with_string_keys ||= JSON.parse(request_body, { symbolize_names: false }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
+                          end
+
+          if !parsed_params.is_a?(Hash) && !parsed_params.is_a?(Array)
+            raise "Expected JSON Object in request body but found #{parsed_params.class.name}"
           end
-        rescue StandardError => e
-          fragment = fragment_before_invalid_utf_8_char
 
-          if fragment
-            raise NonUTF8CharacterFound.new(message("errors.non_utf_8_char_in_request_body", char_number: fragment.length + 1, fragment: fragment))
-          else
-            raise InvalidJsonError.new(e.message)
-          end
+          parsed_params
+        rescue StandardError => e
+          raise InvalidJsonError.new(e.message)
         end
         # rubocop: enable Metrics/CyclomaticComplexity
 
-        def fragment_before_invalid_utf_8_char
-          request_body.each_char.with_index do | char, index |
-            if !char.valid_encoding?
-              return index < 100 ? request_body[0...index] : request_body[index-100...index]
-            end
-          end
-          nil
-        end
-
         def params_with_string_keys
           params(symbolize_names: false)
         end
@@ -158,16 +143,6 @@ module PactBroker
           @pact_params ||= PactBroker::Pacts::PactParams.from_request(request, identifier_from_path)
         end
 
-        def set_json_error_message message
-          response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
-          response.body = { error: message }.to_json
-        end
-
-        def set_json_validation_error_messages errors
-          response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
-          response.body = { errors: errors }.to_json
-        end
-
         def request_body
           @request_body ||= request.body.to_s
         end
@@ -210,41 +185,29 @@ module PactBroker
 
         def invalid_json?
           begin
-            params
-            false
-          rescue NonUTF8CharacterFound => e
-            logger.info(e.message) # Don't use the default SemanticLogger error logging method because it will try and print out the cause which will contain non UTF-8 chars in the message
-            set_json_error_message(e.message)
-            response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
-            true
+            char_number, fragment = fragment_before_invalid_utf_8_char(request_body)
+            if char_number
+              error_message = message("errors.non_utf_8_char_in_request_body", char_number: char_number, fragment: fragment)
+              logger.info(error_message)
+              set_json_error_message(error_message)
+              true
+            else
+              params
+              false
+            end
           rescue StandardError => e
             message = "#{e.cause ? e.cause.class.name : e.class.name} - #{e.message}"
             logger.info(message)
             set_json_error_message(message)
-            response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
             true
           end
         end
 
-        def validation_errors? model
-          if (errors = model.validate).any?
-            set_json_validation_error_messages errors
-            true
-          else
-            false
-          end
-        end
-
-        def contract_validation_errors? contract, params
-          if (invalid = !contract.validate(params))
-            set_json_validation_error_messages contract.errors.messages
-          end
-          invalid
-        end
-
         def find_pacticipant name, role
           pacticipant_service.find_pacticipant_by_name(name).tap do | pacticipant |
-            set_json_error_message("No #{role} with name '#{name}' found") if pacticipant.nil?
+            if pacticipant.nil?
+              set_json_error_message("No #{role} with name '#{name}' found", title: "Not found", type: "not_found", status: 404)
+            end
           end
         end
 

data/lib/pact_broker/api/resources/branch_version.rb

@@ -26,7 +26,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:branch_version_decorator).new(branch_version).to_json(decorator_options)
+          decorator_class(:branch_version_decorator).new(branch_version).to_json(**decorator_options)
         end
 
         def delete_resource
@@ -36,7 +36,7 @@ module PactBroker
 
         def from_json
           already_existed = !!branch_version
-          @branch_version = branch_service.find_or_create_branch_version(identifier_from_path)
+          @branch_version = branch_service.find_or_create_branch_version(**identifier_from_path)
           # Make it return a 201 by setting the Location header
           response.headers["Location"] = branch_version_url(branch_version, base_url) unless already_existed
           response.body = to_json
@@ -49,7 +49,7 @@ module PactBroker
         private
 
         def branch_version
-          @branch_version ||= branch_service.find_branch_version(identifier_from_path)
+          @branch_version ||= branch_service.find_branch_version(**identifier_from_path)
         end
       end
     end

data/lib/pact_broker/api/resources/can_i_deploy.rb

@@ -1,5 +1,5 @@
 require "pact_broker/api/resources/matrix"
-require "pact_broker/matrix/can_i_deploy_query_schema"
+require "pact_broker/api/contracts/can_i_deploy_query_schema"
 require "pact_broker/matrix/parse_can_i_deploy_query"
 require "pact_broker/messages"
 
@@ -9,16 +9,9 @@ module PactBroker
       class CanIDeploy < Matrix
         include PactBroker::Messages
 
+        # Can't call super because it will execute the Matrix validation, not the BaseResource validation
         def malformed_request?
-          if (errors = query_schema.call(query_params)).any?
-            set_json_validation_error_messages(errors)
-            true
-          elsif !pacticipant
-            set_json_validation_error_messages(pacticipant: [message("errors.validation.pacticipant_not_found", name: pacticipant_name)])
-            true
-          else
-            false
-          end
+          request.get? && validation_errors_for_schema?(schema, request.query)
         end
 
         def policy_name
@@ -27,18 +20,10 @@ module PactBroker
 
         private
 
-        def query_schema
+        def schema
           PactBroker::Api::Contracts::CanIDeployQuerySchema
         end
 
-        def pacticipant
-          @pacticipant ||= pacticipant_service.find_pacticipant_by_name(pacticipant_name)
-        end
-
-        def pacticipant_name
-          selectors.first.pacticipant_name
-        end
-
         def parsed_query
           @parsed_query ||= PactBroker::Matrix::ParseCanIDeployQuery.call(query_params)
         end

data/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_branch_to_environment.rb

@@ -1,8 +1,5 @@
 require "pact_broker/api/resources/matrix"
-require "pact_broker/matrix/can_i_deploy_query_schema"
-require "pact_broker/matrix/parse_can_i_deploy_query"
 require "pact_broker/api/decorators/matrix_decorator"
-require "pact_broker/api/decorators/matrix_text_decorator"
 
 module PactBroker
   module Api
@@ -47,7 +44,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
+          decorator_class(:matrix_decorator).new(results).to_json(**decorator_options)
         end
 
         def results

data/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag.rb

@@ -1,6 +1,4 @@
 require "pact_broker/api/resources/matrix"
-require "pact_broker/matrix/can_i_deploy_query_schema"
-require "pact_broker/matrix/parse_can_i_deploy_query"
 
 module PactBroker
   module Api

data/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag_badge.rb

@@ -1,5 +1,4 @@
-require "pact_broker/matrix/can_i_deploy_query_schema"
-require "pact_broker/matrix/parse_can_i_deploy_query"
+require "pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag"
 require "pact_broker/api/resources/badge_methods"
 
 module PactBroker

data/lib/pact_broker/api/resources/currently_deployed_versions_for_environment.rb

@@ -21,7 +21,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(decorator_name).new(deployed_versions).to_json(decorator_options(title: title))
+          decorator_class(decorator_name).new(deployed_versions).to_json(**decorator_options(title: title))
         end
 
         def policy_name
@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def deployed_versions
-          @deployed_versions ||= deployed_version_service.find_currently_deployed_versions_for_environment(environment, query_params)
+          @deployed_versions ||= deployed_version_service.find_currently_deployed_versions_for_environment(environment, **query_params)
         end
 
         def environment_uuid

data/lib/pact_broker/api/resources/currently_supported_versions_for_environment.rb

@@ -21,7 +21,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(decorator_name).new(released_versions).to_json(decorator_options(title: title))
+          decorator_class(decorator_name).new(released_versions).to_json(**decorator_options(title: title))
         end
 
         def policy_name
@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def released_versions
-          @released_versions ||= released_version_service.find_currently_supported_versions_for_environment(environment, query_params)
+          @released_versions ||= released_version_service.find_currently_supported_versions_for_environment(environment, **query_params)
         end
 
         def environment_uuid

data/lib/pact_broker/api/resources/dashboard.rb

@@ -21,11 +21,11 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:dashboard_decorator).new(index_items).to_json(decorator_options)
+          decorator_class(:dashboard_decorator).new(index_items).to_json(**decorator_options)
         end
 
         def to_text
-          decorator_class(:dashboard_text_decorator).new(index_items).to_text(decorator_options)
+          decorator_class(:dashboard_text_decorator).new(index_items).to_text(**decorator_options)
         end
 
         def policy_name
@@ -35,7 +35,7 @@ module PactBroker
         private
 
         def index_items
-          index_service.find_index_items_for_api(identifier_from_path.merge(pagination_options))
+          index_service.find_index_items_for_api(**identifier_from_path.merge(pagination_options))
         end
       end
     end

data/lib/pact_broker/api/resources/deployed_version.rb

@@ -33,7 +33,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:deployed_version_decorator).new(deployed_version).to_json(decorator_options)
+          decorator_class(:deployed_version_decorator).new(deployed_version).to_json(**decorator_options)
         end
 
         def from_merge_patch_json

data/lib/pact_broker/api/resources/deployed_versions_for_version_and_environment.rb

@@ -32,11 +32,11 @@ module PactBroker
         def from_json
           @deployed_version = deployed_version_service.find_or_create(deployed_version_uuid, version, environment, application_instance)
           response.headers["Location"] = deployed_version_url(deployed_version, base_url)
-          response.body = decorator_class(:deployed_version_decorator).new(deployed_version).to_json(decorator_options)
+          response.body = decorator_class(:deployed_version_decorator).new(deployed_version).to_json(**decorator_options)
         end
 
         def to_json
-          decorator_class(:deployed_versions_decorator).new(deployed_versions).to_json(decorator_options(title: title))
+          decorator_class(:deployed_versions_decorator).new(deployed_versions).to_json(**decorator_options(title: title))
         end
 
         def policy_name

data/lib/pact_broker/api/resources/environment.rb

@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:environment_decorator).new(environment).to_json(decorator_options)
+          decorator_class(:environment_decorator).new(environment).to_json(**decorator_options)
         end
 
         def parsed_environment

data/lib/pact_broker/api/resources/environments.rb

@@ -35,7 +35,7 @@ module PactBroker
         end
 
         def from_json
-          response.body = decorator_class(:environment_decorator).new(create_environment).to_json(decorator_options)
+          response.body = decorator_class(:environment_decorator).new(create_environment).to_json(**decorator_options)
         end
 
         def policy_name
@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:environments_decorator).new(environments).to_json(decorator_options)
+          decorator_class(:environments_decorator).new(environments).to_json(**decorator_options)
         end
 
         def parsed_environment

data/lib/pact_broker/api/resources/error_handling_methods.rb

@@ -0,0 +1,57 @@
+require "pact_broker/api/decorators/validation_errors_problem_json_decorator"
+require "pact_broker/api/decorators/custom_error_problem_json_decorator"
+
+module PactBroker
+  module Api
+    module Resources
+      module ErrorHandlingMethods
+
+        # @override
+        def handle_exception(error)
+          error_reference = PactBroker::Errors.generate_error_reference
+          application_context.error_logger.call(error, error_reference, request.env)
+          if PactBroker::Errors.reportable_error?(error)
+            PactBroker::Errors.report(error, error_reference, request.env)
+          end
+          headers, body = application_context.error_response_generator.call(error, error_reference, request.env)
+          headers.each { | key, value | response.headers[key] = value }
+          response.body = body
+        end
+
+        def set_json_error_message detail, title: "Server error", type: "server_error", status: 500
+          response.headers["Content-Type"] = error_response_content_type
+          response.body = error_response_body(detail, title, type, status)
+        end
+
+        def set_json_validation_error_messages errors
+          response.headers["Content-Type"] = error_response_content_type
+          if problem_json_error_content_type?
+            response.body = PactBroker::Api::Decorators::ValidationErrorsProblemJSONDecorator.new(errors).to_json(**decorator_options)
+          else
+            response.body = { errors: errors }.to_json
+          end
+        end
+
+        def error_response_content_type
+          if problem_json_error_content_type?
+            "application/problem+json;charset=utf-8"
+          else
+            "application/hal+json;charset=utf-8"
+          end
+        end
+
+        def error_response_body(detail, title, type, status)
+          if problem_json_error_content_type?
+            PactBroker::Api::Decorators::CustomErrorProblemJSONDecorator.new(detail: detail, title: title, type: type, status: status).to_json(**decorator_options)
+          else
+            { error: detail }.to_json
+          end
+        end
+
+        def problem_json_error_content_type?
+          request.headers["Accept"]&.include?("application/problem+json")
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/resources/error_response_generator.rb

@@ -0,0 +1,70 @@
+require "pact_broker/configuration"
+require "pact_broker/api/decorators/runtime_error_problem_json_decorator"
+
+module PactBroker
+  module Api
+    module Resources
+      class ErrorResponseGenerator
+        include PactBroker::Logging
+
+        # @param error [StandardError]
+        # @param error_reference [String] an error reference to display to the user
+        # @param env [Hash] the rack env
+        # @return [Hash, String] the response headers to set, the response body to set
+        def self.call error, error_reference, env = {}
+          body = response_body_hash(error, error_reference, env, display_message(error, obfuscated_error_message(error_reference)))
+          return headers(env), body.to_json
+        end
+
+        def self.display_message(error, obfuscated_message)
+          if PactBroker.configuration.show_backtrace_in_error_response?
+            error.message || obfuscated_message
+          else
+            PactBroker::Errors.reportable_error?(error) ? obfuscated_message : error.message
+          end
+        end
+
+        private_class_method def self.response_body_hash(error, error_reference, env, message)
+          if problem_json?(env)
+            problem_json_response_body(message, env)
+          else
+            hal_json_response_body(error, error_reference, message)
+          end
+        end
+
+        private_class_method def self.hal_json_response_body(error, error_reference, message)
+          response_body = {
+            error: {
+              message: message,
+              reference: error_reference
+            }
+          }
+          if PactBroker.configuration.show_backtrace_in_error_response?
+            response_body[:error][:backtrace] = error.backtrace
+          end
+          response_body
+        end
+
+        private_class_method def self.problem_json_response_body(message, env)
+          PactBroker::Api::Decorators::RuntimeErrorProblemJSONDecorator.new(message).to_hash(user_options: { base_url: env["pactbroker.base_url" ] })
+        end
+
+        private_class_method def self.obfuscated_error_message(error_reference)
+          "An error has occurred. The details have been logged with the reference #{error_reference}"
+        end
+
+        private_class_method def self.headers(env)
+          if problem_json?(env)
+            { "Content-Type" => "application/problem+json;charset=utf-8" }
+          else
+            { "Content-Type" => "application/hal+json;charset=utf-8" }
+          end
+        end
+
+        private_class_method def self.problem_json?(env)
+          env["HTTP_ACCEPT"]&.include?("application/problem+json")
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/resources/integrations.rb

@@ -22,7 +22,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:integrations_decorator).new(integrations).to_json(decorator_options)
+          decorator_class(:integrations_decorator).new(integrations).to_json(**decorator_options)
         end
 
         def integrations

data/lib/pact_broker/api/resources/label.rb

@@ -39,7 +39,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:label_decorator).new(label).to_json(decorator_options)
+          decorator_class(:label_decorator).new(label).to_json(**decorator_options)
         end
 
         def label

data/lib/pact_broker/api/resources/latest_pact.rb

@@ -30,11 +30,11 @@ module PactBroker
 
         def to_json
           response.headers["X-Pact-Consumer-Version"] = pact.consumer_version_number
-          decorator_class(:pact_decorator).new(pact).to_json(decorator_options(metadata: metadata))
+          decorator_class(:pact_decorator).new(pact).to_json(**decorator_options(metadata: metadata))
         end
 
         def to_extended_json
-          decorator_class(:extended_pact_decorator).new(pact).to_json(decorator_options(metadata: metadata))
+          decorator_class(:extended_pact_decorator).new(pact).to_json(**decorator_options(metadata: metadata))
         end
 
         def to_html

data/lib/pact_broker/api/resources/latest_pacts.rb

@@ -14,7 +14,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pact_collection_decorator).new(pacts).to_json(decorator_options)
+          decorator_class(:pact_collection_decorator).new(pacts).to_json(**decorator_options)
         end
 
         def pacts

data/lib/pact_broker/api/resources/latest_verifications_for_consumer_version.rb

@@ -23,11 +23,11 @@ module PactBroker
 
         def to_json
           summary = verification_service.verification_summary_for_consumer_version(identifier_from_path)
-          decorator_for(summary).to_json(decorator_options(identifier_from_path))
+          decorator_for(summary).to_json(**decorator_options(identifier_from_path))
         end
 
         def policy_name
-          :'verifications::verifications'
+          :'pacticipants::pacticipant'
         end
 
         private

data/lib/pact_broker/api/resources/matrix.rb

@@ -29,11 +29,11 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
+          decorator_class(:matrix_decorator).new(results).to_json(**decorator_options)
         end
 
         def to_text
-          decorator_class(:matrix_text_decorator).new(results).to_text(decorator_options)
+          decorator_class(:matrix_text_decorator).new(results).to_text(**decorator_options)
         end
 
         def policy_name

data/lib/pact_broker/api/resources/matrix_for_consumer_and_provider.rb

@@ -34,7 +34,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
+          decorator_class(:matrix_decorator).new(results).to_json(**decorator_options)
         end
 
         def policy_name

data/lib/pact_broker/api/resources/pact.rb

@@ -54,9 +54,8 @@ module PactBroker
           potential_duplicate_pacticipants?(pact_params.pacticipant_names) || merge_conflict || disallowed_modification?
         end
 
-
         def malformed_request?
-          super || ((request.patch? || request.really_put?) && contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params), pact_params))
+          super || ((request.patch? || request.really_put?) && validation_errors_for_schema?(schema, pact_params.to_hash_for_validation))
         end
 
         def resource_exists?
@@ -78,11 +77,11 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pact_decorator).new(pact).to_json(decorator_options(metadata: identifier_from_path[:metadata]))
+          decorator_class(:pact_decorator).new(pact).to_json(**decorator_options(metadata: identifier_from_path[:metadata]))
         end
 
         def to_extended_json
-          decorator_class(:extended_pact_decorator).new(pact).to_json(decorator_options(metadata: identifier_from_path[:metadata]))
+          decorator_class(:extended_pact_decorator).new(pact).to_json(**decorator_options(metadata: identifier_from_path[:metadata]))
         end
 
         def to_html
@@ -118,6 +117,10 @@ module PactBroker
             false
           end
         end
+
+        def schema
+          api_contract_class(:put_pact_params_contract)
+        end
       end
     end
   end

data/lib/pact_broker/api/resources/pact_triggered_webhooks.rb

@@ -18,7 +18,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:triggered_webhooks_decorator).new(triggered_webhooks).to_json(decorator_options(resource_title: resource_title))
+          decorator_class(:triggered_webhooks_decorator).new(triggered_webhooks).to_json(**decorator_options(resource_title: resource_title))
         end
 
         def policy_name

data/lib/pact_broker/api/resources/pact_version.rb

@@ -11,7 +11,7 @@ module PactBroker
           ["GET", "OPTIONS"]
         end
 
-        def decorator_options(options)
+        def decorator_options(options = {})
           super(options.merge(consumer_versions: consumer_versions_from_metadata&.reverse))
         end
       end