pact_broker 2.105.0 → 2.106.0

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/latest_verifications_for_consumer_version.rb

@@ -27,7 +27,7 @@ module PactBroker
         end
 
         def policy_name
-          :'verifications::verifications'
+          :'pacticipants::pacticipant'
         end
 
         private

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

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

@@ -3,12 +3,15 @@ require "pact_broker/api/decorators/pacticipant_decorator"
 require "pact_broker/domain/pacticipant"
 require "pact_broker/hash_refinements"
 require "pact_broker/api/contracts/pacticipant_create_schema"
+require "pact_broker/api/resources/pagination_methods"
 
 module PactBroker
   module Api
     module Resources
       class Pacticipants < BaseResource
         using PactBroker::HashRefinements
+        include PaginationMethods
+
 
         def content_types_provided
           [["application/hal+json", :to_json]]
@@ -44,7 +47,7 @@ module PactBroker
         end
 
         def to_json
-          generate_json(pacticipant_service.find_all_pacticipants)
+          generate_json(pacticipant_service.find_all_pacticipants(pagination_options))
         end
 
         def generate_json pacticipants

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

@@ -3,10 +3,14 @@ module PactBroker
     module Resources
       module PaginationMethods
         def pagination_options
-          {
-            page_number: request.query["pageNumber"]&.to_i,
-            page_size: request.query["pageSize"]&.to_i
-          }.compact
+          if request.query["pageNumber"] || request.query["pageSize"]
+            {
+              page_number: request.query["pageNumber"]&.to_i || 1,
+              page_size: request.query["pageSize"]&.to_i || 100
+            }
+          else
+            {}
+          end
         end
       end
     end

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

@@ -40,7 +40,7 @@ module PactBroker
           :'contracts::contracts'
         end
 
-        # for Pactflow
+        # for PactFlow
         def policy_record
           @policy_record ||= pacticipant_service.find_pacticipant_by_name(parsed_contracts.pacticipant_name)
         end

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

@@ -1,11 +1,15 @@
 require "pact_broker/api/resources/base_resource"
 require "pact_broker/configuration"
 require "pact_broker/api/decorators/versions_decorator"
+require "pact_broker/api/resources/pagination_methods"
+
 
 module PactBroker
   module Api
     module Resources
       class Versions < BaseResource
+        include PaginationMethods
+
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
@@ -23,23 +27,12 @@ module PactBroker
         end
 
         def versions
-          @versions ||= pacticipant_service.find_all_pacticipant_versions_in_reverse_order(pacticipant_name, pagination_options)
+          @versions ||= version_service.find_all_pacticipant_versions_in_reverse_order(pacticipant_name, pagination_options)
         end
 
         def policy_name
           :'versions::versions'
         end
-
-        def pagination_options
-          if request.query["pageNumber"] || request.query["pageSize"]
-            {
-              page_number: request.query["pageNumber"]&.to_i || 1,
-              page_size: request.query["pageSize"]&.to_i || 100
-            }
-          else
-            nil
-          end
-        end
       end
     end
   end

data/lib/pact_broker/api.rb

@@ -1,4 +1,6 @@
 require "webmachine/adapters/rack_mapped"
+require "webmachine/application_monkey_patch"
+require "webmachine/render_error_monkey_patch"
 require "pact_broker/db/models"
 require "pact_broker/api/resources"
 require "pact_broker/api/decorators"
@@ -140,10 +142,7 @@ module PactBroker
       end
     end
 
-    # naughty, but better than setting each route manually
-    pact_api.routes.each do | route |
-      route.instance_variable_get(:@bindings)[:application_context] = application_context
-    end
+    pact_api.application_context = application_context
 
     pact_api.configure do |config|
       config.adapter = :RackMapped

data/lib/pact_broker/app.rb

@@ -20,7 +20,6 @@ require "rack/pact_broker/ui_request_filter"
 require "rack/pact_broker/ui_authentication"
 require "rack/pact_broker/configurable_make_it_later"
 require "rack/pact_broker/no_auth"
-require "rack/pact_broker/convert_404_to_hal"
 require "rack/pact_broker/reset_thread_data"
 require "rack/pact_broker/add_vary_header"
 require "rack/pact_broker/use_when"
@@ -256,7 +255,6 @@ module PactBroker
       api_apps.unshift(@custom_api) if @custom_api
       builder = ::Rack::Builder.new
       builder.use @make_it_later_api_auth
-      builder.use Rack::PactBroker::Convert404ToHal
       builder.use Rack::PactBroker::DatabaseTransaction, configuration.database_connection
       builder.run Rack::Cascade.new(api_apps, [404])
       builder

data/lib/pact_broker/application_context.rb

@@ -3,7 +3,7 @@ require "pact_broker/api/contracts/configuration"
 require "pact_broker/api/decorators/decorator_context_creator"
 require "pact_broker/webhooks/execution_configuration_creator"
 require "pact_broker/errors/error_logger"
-require "pact_broker/api/resources/error_response_body_generator"
+require "pact_broker/api/resources/error_response_generator"
 
 module PactBroker
   class ApplicationContext
@@ -15,7 +15,7 @@ module PactBroker
                 :before_resource,
                 :after_resource,
                 :error_logger,
-                :error_response_body_generator
+                :error_response_generator
 
     def initialize(params = {})
       params_with_defaults = {
@@ -24,7 +24,7 @@ module PactBroker
         decorator_context_creator: PactBroker::Api::Decorators::DecoratorContextCreator,
         webhook_execution_configuration_creator: PactBroker::Webhooks::ExecutionConfigurationCreator,
         error_logger: PactBroker::Errors::ErrorLogger,
-        error_response_body_generator: PactBroker::Api::Resources::ErrorResponseBodyGenerator
+        error_response_generator: PactBroker::Api::Resources::ErrorResponseGenerator
       }.merge(params)
 
       @decorator_configuration = params_with_defaults[:decorator_configuration]
@@ -35,7 +35,7 @@ module PactBroker
       @before_resource = params_with_defaults[:before_resource]
       @after_resource = params_with_defaults[:after_resource]
       @error_logger = params_with_defaults[:error_logger]
-      @error_response_body_generator = params_with_defaults[:error_response_body_generator]
+      @error_response_generator = params_with_defaults[:error_response_generator]
 
     end
 

data/lib/pact_broker/db/clean_incremental.rb

@@ -25,6 +25,36 @@ module PactBroker
         @options = options
       end
 
+      def call
+        require "pact_broker/db/models"
+
+        if dry_run?
+          dry_run_results
+        else
+          execute_clean
+        end
+      end
+
+      private
+
+      attr_reader :db, :options
+
+      def execute_clean
+        db.transaction do
+          before_counts = current_counts
+          PactBroker::Domain::Version.where(id: versions_to_delete.from_self.select_map(:id)).delete
+          delete_orphan_pact_versions
+          after_counts = current_counts
+
+          TABLES.each_with_object({}) do | table_name, comparison_counts |
+            comparison_counts[table_name.to_s] = {
+                                                    "deleted" => before_counts[table_name] - after_counts[table_name],
+                                                    "kept" => after_counts[table_name]
+                                                  }
+          end
+        end
+      end
+
       def logger
         options[:logger] || PactBroker.logger
       end
@@ -42,47 +72,20 @@ module PactBroker
         options[:limit] || 1000
       end
 
-      def resolve_ids(query, column_name = :id)
-        query.collect { |h| h[column_name] }
-      end
-
-      def version_ids_to_delete
-        db[:versions].where(id: version_ids_to_keep).invert.limit(limit).order(Sequel.asc(:id))
+      def versions_to_delete(columns = [:id])
+        fully_qualified_columns = columns.collect { |col| Sequel[:versions][col] }
+        PactBroker::Domain::Version
+          .select(*fully_qualified_columns)
+          .left_outer_join(version_ids_to_keep, { Sequel[:versions][:id] => Sequel[:keep_versions][:id] }, table_alias: :keep_versions)
+          .where(Sequel[:keep_versions][:id] => nil)
+          .order(Sequel.asc( Sequel[:versions][:id]))
+          .limit(limit)
       end
 
       def version_ids_to_keep
-        @version_ids_to_keep ||= selected_versions_to_keep.reduce(&:union)
+        @version_ids_to_keep ||=  keep.collect { |selector| PactBroker::Domain::Version.select(:id).for_selector(selector) }.reduce(&:union)
       end
 
-      def selected_versions_to_keep
-        keep.collect do | selector |
-          PactBroker::Domain::Version.select(:id).for_selector(selector)
-        end
-      end
-
-      def call
-        require "pact_broker/db/models"
-
-        if dry_run?
-          dry_run_results
-        else
-          db.transaction do
-            before_counts = current_counts
-            PactBroker::Domain::Version.where(id: resolve_ids(version_ids_to_delete)).delete
-            delete_orphan_pact_versions
-            after_counts = current_counts
-
-            TABLES.each_with_object({}) do | table_name, comparison_counts |
-              comparison_counts[table_name.to_s] = { "deleted" => before_counts[table_name] - after_counts[table_name], "kept" => after_counts[table_name] }
-            end
-          end
-        end
-      end
-
-      private
-
-      attr_reader :db, :options
-
       def current_counts
         TABLES.each_with_object({}) do | table_name, counts |
           counts[table_name] = db[table_name].count
@@ -122,8 +125,8 @@ module PactBroker
       end
 
       def dry_run_results
-        to_delete = dry_run_to_delete
-        to_keep = dry_run_to_keep
+        to_delete = dry_run_to_delete_by_pacticipant
+        to_keep = dry_run_to_keep_by_pacticipant
 
         kept_per_selector = keep.collect do | selector |
           {
@@ -141,7 +144,7 @@ module PactBroker
 
         total_versions_count = PactBroker::Domain::Version.count
         versions_to_keep_count = version_ids_to_keep.count
-        versions_to_delete_count = version_ids_to_delete.count
+        versions_to_delete_count = versions_to_delete.count
 
         {
           "counts" => {
@@ -155,9 +158,15 @@ module PactBroker
         }
       end
 
-      def dry_run_latest_versions_to_keep
-        latest_undeleted_versions_by_order = PactBroker::Domain::Version.where(id: version_ids_to_delete.select(:id))
-          .invert
+      def expected_remaining_versions
+        PactBroker::Domain::Version
+          .left_outer_join(versions_to_delete, { Sequel[:versions][:id] => Sequel[:delete_versions][:id] }, table_alias: :delete_versions )
+          .where(Sequel[:delete_versions][:id] => nil)
+      end
+
+      # Returns the latest version that will be kept for each pacticipant
+      def dry_run_latest_versions_to_keep_by_pacticipant
+        latest_undeleted_versions_by_order = expected_remaining_versions
           .select_group(:pacticipant_id)
           .select_append{ max(order).as(latest_order) }
 
@@ -171,9 +180,9 @@ module PactBroker
           .join(latest_undeleted_versions_by_order, lv_versions_join, { table_alias: :lv })
       end
 
-      def dry_run_earliest_versions_to_keep
-        earliest_undeleted_versions_by_order = PactBroker::Domain::Version.where(id: version_ids_to_delete.select(:id))
-          .invert
+      # Returns the earliest version that will be kept for each pacticipant
+      def dry_run_earliest_versions_to_keep_by_pacticipant
+        earliest_undeleted_versions_by_order = expected_remaining_versions
           .select_group(:pacticipant_id)
           .select_append{ min(order).as(first_order) }
 
@@ -187,13 +196,16 @@ module PactBroker
           .join(earliest_undeleted_versions_by_order, ev_versions_join, { table_alias: :lv })
       end
 
-      def dry_run_to_delete
-        PactBroker::Domain::Version
-          .where(id: version_ids_to_delete.select(:id))
+      # Returns Hash of pacticipant name => Hash, where the Hash value contains the count, fromVersion and toVersion
+      # that will be deleted.
+      # @return Hash
+      def dry_run_to_delete_by_pacticipant
+        versions_to_delete
+          .select(Sequel[:versions].*)
           .all
           .group_by{ | v | v.pacticipant_id }
-          .each_with_object({}) do | (_pacticipant_id, versions), thing |
-            thing[versions.first.pacticipant.name] = {
+          .each_with_object({}) do | (_pacticipant_id, versions), hash |
+            hash[versions.first.pacticipant.name] = {
               "count" => versions.count,
               "fromVersion" => version_info(versions.first),
               "toVersion" => version_info(versions.last)
@@ -202,14 +214,14 @@ module PactBroker
       end
 
       # rubocop: disable Metrics/CyclomaticComplexity
-      def dry_run_to_keep
-        latest_to_keep = dry_run_latest_versions_to_keep.eager(:tags).each_with_object({}) do | version, r |
+      def dry_run_to_keep_by_pacticipant
+        latest_to_keep = dry_run_latest_versions_to_keep_by_pacticipant.eager(:tags).each_with_object({}) do | version, r |
           r[version.pacticipant_id] = {
             "firstVersion" => version_info(version)
           }
         end
 
-        earliest_to_keep = dry_run_earliest_versions_to_keep.eager(:tags).each_with_object({}) do | version, r |
+        earliest_to_keep = dry_run_earliest_versions_to_keep_by_pacticipant.eager(:tags).each_with_object({}) do | version, r |
           r[version.pacticipant_id] = {
             "latestVersion" => version_info(version)
           }
@@ -226,14 +238,10 @@ module PactBroker
       # rubocop: enable Metrics/CyclomaticComplexity
 
       def counts_to_keep
-        db[:versions].where(id: version_ids_to_delete.select(:id))
-          .invert
+        expected_remaining_versions
           .select_group(:pacticipant_id)
           .select_append{ count(1).as(count) }
-          .all
-          .each_with_object({}) do | row, counts |
-            counts[row[:pacticipant_id]] = row[:count]
-          end
+          .as_hash(:pacticipant_id, :count)
       end
 
       def pacticipants

data/lib/pact_broker/index/service.rb

@@ -18,7 +18,7 @@ module PactBroker
       DEFAULT_PAGE_NUMBER = 1
 
       # This method provides data for both the OSS server side rendered index (with and without tags)
-      # and the Pactflow UI. It really needs to be broken into to separate methods, as it's getting too messy
+      # and the PactFlow UI. It really needs to be broken into to separate methods, as it's getting too messy
       # supporting both
 
       def self.pact_publication_scope

data/lib/pact_broker/locale/en.yml

@@ -109,6 +109,7 @@ en:
       new_line_in_url_path: URL path cannot contain a new line character.
       tab_in_url_path: URL path cannot contain a tab character.
       non_utf_8_char_in_request_body: "Request body has a non UTF-8 character at char %{char_number} and cannot be parsed as JSON. Fragment preceding invalid character is: '%{fragment}'"
+      non_utf_8_char_in_contract: "Contract has a non UTF-8 character at char %{char_number} and cannot be parsed as JSON. Fragment preceding invalid character is: '%{fragment}'"
 
       "400":
         title: 400 Malformed Request

data/lib/pact_broker/pacticipants/repository.rb

@@ -26,21 +26,14 @@ module PactBroker
         PactBroker::Domain::Pacticipant.where(id: id).single_record
       end
 
-      def find_all
-        find
+      def find_all(pagination_options = {})
+        find({}, pagination_options)
       end
 
-      def find options = {}
+      def find(options = {}, pagination_options = {})
         query = PactBroker::Domain::Pacticipant.select_all_qualified
         query = query.label(options[:label_name]) if options[:label_name]
-        query.order_ignore_case(Sequel[:pacticipants][:name]).eager(:labels).eager(:latest_version).all
-      end
-
-      def find_all_pacticipant_versions_in_reverse_order name, pagination_options = nil
-        pacticipant = pacticipant_repository.find_by_name!(name)
-        query = PactBroker::Domain::Version.where(pacticipant: pacticipant).reverse_order(:order)
-        query = query.paginate(pagination_options[:page_number], pagination_options[:page_size]) if pagination_options
-        query
+        query.order_ignore_case(Sequel[:pacticipants][:name]).eager(:labels).eager(:latest_version).all_with_pagination_options(pagination_options)
       end
 
       def find_by_name_or_create name

data/lib/pact_broker/pacticipants/service.rb

@@ -32,8 +32,8 @@ module PactBroker
           } .collect{ | name | pacticipant_repository.find_by_name(name) }
       end
 
-      def self.find_all_pacticipants
-        pacticipant_repository.find_all
+      def self.find_all_pacticipants(pagination_options = {})
+        pacticipant_repository.find_all(pagination_options)
       end
 
       def self.find_pacticipant_by_name(name)
@@ -48,12 +48,8 @@ module PactBroker
         pacticipant_repository.find_by_id(id)
       end
 
-      def self.find(options)
-        pacticipant_repository.find options
-      end
-
-      def self.find_all_pacticipant_versions_in_reverse_order(name, pagination_options = nil)
-        pacticipant_repository.find_all_pacticipant_versions_in_reverse_order(name, pagination_options)
+      def self.find(options, pagination_options = {})
+        pacticipant_repository.find(options, pagination_options)
       end
 
       def self.find_pacticipant_repository_url_by_pacticipant_name(name)

data/lib/pact_broker/pacts/selected_pact.rb

@@ -2,9 +2,13 @@ require "delegate"
 
 module PactBroker
   module Pacts
+
     class SelectedPact < SimpleDelegator
       attr_reader :pact, :selectors
 
+      # @param pact [PactBroker::Domain::Pact]
+      # @param selectors [PactBroker::Pacts::Selectors<PactBroker::Pacts::Selector::ResolvedSelector>] the Selectors object
+      #                  containing the ResolvedSelector objects that caused the pact to be selected.
       def initialize(pact, selectors)
         super(pact)
         @pact = pact

data/lib/pact_broker/repositories/helpers.rb

@@ -1,3 +1,5 @@
+require "pact_broker/repositories/page"
+
 Sequel.extension :escaped_like
 
 module PactBroker
@@ -6,6 +8,15 @@ module PactBroker
 
       extend self
 
+      def all_with_pagination_options(pagination_options)
+        if pagination_options&.any?
+          query = paginate(pagination_options[:page_number], pagination_options[:page_size])
+          Page.new(query.all, query)
+        else
+          all
+        end
+      end
+
       def all_forbidding_lazy_load
         all.each{ | row | row.forbid_lazy_load if row.respond_to?(:forbid_lazy_load) }
       end

data/lib/pact_broker/repositories/page.rb

@@ -0,0 +1,24 @@
+require "forwardable"
+
+# An array that provides the pagination details
+
+module PactBroker
+  module Repositories
+    module Helpers
+      class Page < Array
+        extend Forwardable
+
+        attr_reader :query
+
+        PAGE_PROPERTIES = [:page_size, :page_count, :page_range, :current_page, :next_page, :prev_page, :first_page?, :last_page?, :pagination_record_count, :current_page_record_count, :current_page_record_range]
+
+        delegate PAGE_PROPERTIES => :query
+
+        def initialize(array, query)
+          super(array)
+          @query = query
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/string_refinements.rb

@@ -59,6 +59,10 @@ module PactBroker
         .downcase
       end
 
+      def dasherize
+        snakecase.tr("_", "-")
+      end
+
       # ripped from rubyworks/facets, thank you
       def camelcase(*separators)
         case separators.first

data/lib/pact_broker/tasks/clean_task.rb

@@ -44,7 +44,7 @@ module PactBroker
                 raise PactBroker::Error.new("You must specify which versions to keep")
               else
                 add_defaults_to_keep_selectors
-                output "#{prefix}Deleting oldest #{version_deletion_limit} versions, keeping versions that match the configured selectors", keep_version_selectors
+                output "#{prefix}Deleting oldest #{version_deletion_limit} versions, keeping versions that match the configured selectors", keep_version_selectors.collect(&:to_hash)
               end
 
               start_time = Time.now
@@ -68,11 +68,15 @@ module PactBroker
 
       def add_defaults_to_keep_selectors
         if keep_version_selectors.none?(&:currently_deployed?)
-          keep_version_selectors << PactBroker::DB::Clean::Selector.new(deployed: true)
+          selector = PactBroker::DB::Clean::Selector.new(deployed: true)
+          output("Automatically adding #{selector.to_hash} to keep version selectors")
+          keep_version_selectors << selector
         end
 
         if keep_version_selectors.none?(&:currently_supported?)
-          keep_version_selectors <<  PactBroker::DB::Clean::Selector.new(released: true)
+          selector = PactBroker::DB::Clean::Selector.new(released: true)
+          output("Automatically adding #{ selector.to_hash } to keep version selectors")
+          keep_version_selectors << selector
         end
       end
     end

data/lib/pact_broker/ui/views/matrix/show.haml

@@ -195,7 +195,7 @@
               .tag-parent{"title": tag.tooltip, "data-toggle": "tooltip", "data-placement": "right"}
                 %a{href: tag.url}
                   .tag.badge.badge-primary
-                    = "tag:" + ellipsisize(tag.name)
+                    = "tag: " + ellipsisize(tag.name)
             - line.other_provider_version_tags.each do | tag |
               .tag-parent{"title": tag.tooltip, "data-toggle": "tooltip", "data-placement": "right"}
                 %a{href: tag.url}