pact_broker 2.105.0 → 2.106.0

data/lib/pact_broker/verifications/repository.rb

@@ -3,6 +3,7 @@ require "pact_broker/domain/verification"
 require "pact_broker/verifications/sequence"
 require "pact_broker/verifications/latest_verification_id_for_pact_version_and_provider_version"
 require "pact_broker/verifications/pact_version_provider_tag_successful_verification"
+require "pact_broker/repositories/scopes"
 
 module PactBroker
   module Verifications
@@ -10,6 +11,7 @@ module PactBroker
 
       include PactBroker::Repositories::Helpers
       include PactBroker::Repositories
+      include PactBroker::Repositories::Scopes
 
       # Ideally this would just be a sequence, but Sqlite and MySQL don't support sequences
       # in the way we need to use them ie. determining what the next number will be before we
@@ -33,7 +35,7 @@ module PactBroker
       end
 
       def delete(verification_id)
-        PactBroker::Domain::Verification.where(id: verification_id).delete
+        scope_for(PactBroker::Domain::Verification).where(id: verification_id).delete
       end
 
       def update_latest_verification_id verification
@@ -62,8 +64,9 @@ module PactBroker
         end
       end
 
+      # policy should be applied in resource
       def find consumer_name, provider_name, pact_version_sha, verification_number
-        PactBroker::Domain::Verification
+        unscoped(PactBroker::Domain::Verification)
           .select_all_qualified
           .join(:all_pact_publications, pact_version_id: :pact_version_id)
           .consumer(consumer_name)
@@ -73,19 +76,19 @@ module PactBroker
       end
 
       def find_latest_for_pact(pact)
-        PactBroker::Pacts::PactPublication.where(id: pact.id).single_record.latest_verification
+        scope_for(PactBroker::Pacts::PactPublication).where(id: pact.id).single_record.latest_verification
       end
 
       def find_latest_from_main_branch_for_pact(pact)
-        PactBroker::Pacts::PactPublication.where(id: pact.id).single_record.latest_main_branch_verification
+        scope_for(PactBroker::Pacts::PactPublication).where(id: pact.id).single_record.latest_main_branch_verification
       end
 
       def any_verifications?(consumer, provider)
-        PactBroker::Domain::Verification.where(consumer_id: consumer.id, provider_id: provider.id).any?
+        scope_for(PactBroker::Domain::Verification).where(consumer_id: consumer.id, provider_id: provider.id).any?
       end
 
       def search_for_latest consumer_name, provider_name
-        query = PactBroker::Domain::Verification.select_all_qualified
+        query = scope_for(PactBroker::Domain::Verification).select_all_qualified
         query = query.for_consumer_name(consumer_name) if consumer_name
         query = query.for_provider_name(provider_name) if provider_name
         query.reverse(:execution_date, :id).first
@@ -94,7 +97,7 @@ module PactBroker
       def find_latest_verifications_for_consumer_version consumer_name, consumer_version_number
         # Use remove_verifications_for_overridden_consumer_versions because we don't
         # want verifications for shadowed revisions as it would be misleading.
-        PactBroker::Domain::Verification
+        scope_for(PactBroker::Domain::Verification)
           .select_all_qualified
           .remove_verifications_for_overridden_consumer_versions
           .for_consumer_name_and_consumer_version_number(consumer_name, consumer_version_number)
@@ -115,7 +118,7 @@ module PactBroker
           Sequel[:lp][:consumer_id] => consumer.id,
           Sequel[:lp][:provider_id] => provider.id
         }
-        query = PactBroker::Domain::Verification
+        query = scope_for(PactBroker::Domain::Verification)
           .select_all_qualified
           .join(:latest_verification_ids_for_pact_versions, { Sequel[:verifications][:id] => Sequel[:lv][:latest_verification_id] }, { table_alias: :lv })
           .join(:latest_pact_publication_ids_for_consumer_versions, join_cols, { table_alias: :lp })
@@ -140,7 +143,7 @@ module PactBroker
         consumer_tag_filter = PactBroker::Repositories::Helpers.name_like(Sequel.qualify(:consumer_tags, :name), consumer_version_tag)
         provider_tag_filter = PactBroker::Repositories::Helpers.name_like(Sequel.qualify(:provider_tags, :name), provider_version_tag)
 
-        query = PactBroker::Domain::Verification
+        query = scope_for(PactBroker::Domain::Verification)
           .select_all_qualified
           .join(:versions, { Sequel[:provider_versions][:id] => Sequel[view_name][:provider_version_id] }, { table_alias: :provider_versions })
           .join(:latest_verification_id_for_pact_version_and_provider_version, { Sequel[:lv][:verification_id] => Sequel[view_name][:id] }, { table_alias: :lv })
@@ -160,13 +163,13 @@ module PactBroker
       end
 
       def delete_by_provider_version_id version_id
-        PactBroker::Domain::Verification.where(provider_version_id: version_id).delete
+        scope_for(PactBroker::Domain::Verification).where(provider_version_id: version_id).delete
       end
 
       def delete_all_verifications_between(consumer_name, options)
         consumer = pacticipant_repository.find_by_name!(consumer_name)
         provider = pacticipant_repository.find_by_name!(options.fetch(:and))
-        PactBroker::Domain::Verification.where(provider: provider, consumer: consumer).delete
+        scope_for(PactBroker::Domain::Verification).where(provider: provider, consumer: consumer).delete
       end
     end
   end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.105.0"
+  VERSION = "2.106.0"
 end

data/lib/pact_broker/versions/repository.rb

@@ -59,6 +59,18 @@ module PactBroker
           .single_record
       end
 
+      def find_all_pacticipant_versions_in_reverse_order name, pagination_options = {}
+        pacticipant = pacticipant_repository.find_by_name!(name)
+        query = PactBroker::Domain::Version
+                  .where(pacticipant: pacticipant)
+                  .eager(:pacticipant)
+                  .eager(branch_versions: [:version, :branch_head, { branch: :pacticipant }])
+                  .eager(tags: :head_tag)
+                  .eager(:pact_publications)
+                  .reverse_order(:order)
+        query.all_with_pagination_options(pagination_options)
+      end
+
       # There may be a race condition if two simultaneous requests come in to create the same version
       def create(args)
         version_params = {

data/lib/pact_broker/versions/service.rb

@@ -26,6 +26,10 @@ module PactBroker
         version_repository.find_latest_by_pacticipant_name_and_branch_name(pacticipant_name, branch_name)
       end
 
+      def self.find_all_pacticipant_versions_in_reverse_order(name, pagination_options = {})
+        version_repository.find_all_pacticipant_versions_in_reverse_order(name, pagination_options)
+      end
+
       def self.create_or_overwrite(pacticipant_name, version_number, version)
         pacticipant = pacticipant_repository.find_by_name_or_create(pacticipant_name)
         version = version_repository.create_or_overwrite(pacticipant, version_number, version)

data/lib/rack/pact_broker/request_target.rb

@@ -7,7 +7,7 @@ module Rack
       extend self
 
       WEB_ASSET_EXTENSIONS = %w[.js .woff .woff2 .css .png .html .map .ttf .ico].freeze
-      API_CONTENT_TYPES = %w[application/hal+json application/json text/csv application/yaml text/plain].freeze
+      API_CONTENT_TYPES = %w[application/hal+json application/problem+json application/json text/csv application/yaml text/plain].freeze
 
       def request_for_ui?(env)
         !(request_for_api?(env))

data/lib/webmachine/application_monkey_patch.rb

@@ -0,0 +1,10 @@
+require "webmachine/application"
+
+class Webmachine::Application
+  def application_context= application_context
+    # naughty, but better than setting each route manually
+    routes.each do | route |
+      route.instance_variable_get(:@bindings)[:application_context] = application_context
+    end
+  end
+end

data/lib/webmachine/render_error_monkey_patch.rb

@@ -0,0 +1,70 @@
+require "webmachine/errors"
+require "pact_broker/string_refinements"
+
+# Monkey patches the render_error method so that it returns hal+json or problem+json instead of text/html
+
+module Webmachine
+  using PactBroker::StringRefinements
+
+  class << self
+    alias_method :original_render_error, :render_error
+  end
+
+  # Renders a standard error message body for the response. The
+  # standard messages are defined in localization files.
+  # @param [Integer] code the response status code
+  # @param [Request] req the request object
+  # @param [Response] req the response object
+  # @param [Hash] options keys to override the defaults when rendering
+  #     the response body
+  def self.render_error(code, req, res, options={})
+    if text_html_error_content_type?(req)
+      Webmachine.original_render_error(code, req, res, options)
+    else
+      render_error_for_api(code, req, res, options)
+    end
+  end
+
+  def self.render_error_for_api(code, req, res, options)
+    res.code = code
+    unless res.body
+      title, message = t(["errors.#{code}.title", "errors.#{code}.message"],
+                         { :method => req.method,
+                           :error => res.error}.merge(options))
+
+      title = options[:title] if options[:title]
+      message = options[:message] if options[:message]
+
+      res.body = error_response_body(message, title, title.dasherize.gsub(/^\d+\-/, ""), code, req)
+      res.headers[CONTENT_TYPE] = error_response_content_type(req)
+    end
+    ensure_content_length(res)
+    ensure_date_header(res)
+  end
+
+  def self.text_html_error_content_type?(request)
+    request.headers["Accept"]&.include?("text/html")
+  end
+
+  def self.problem_json_error_content_type?(request)
+    request.headers["Accept"]&.include?("application/problem+json")
+  end
+
+  def self.error_response_content_type(request)
+    if problem_json_error_content_type?(request)
+      "application/problem+json;charset=utf-8"
+    elsif text_html_error_content_type?(request)
+      "text/html;charset=utf-8"
+    else
+      "application/json;charset=utf-8"
+    end
+  end
+
+  def self.error_response_body(detail, title, type, status, request)
+    if problem_json_error_content_type?(request)
+      PactBroker::Api::Decorators::CustomErrorProblemJSONDecorator.new(detail: detail, title: title, type: type, status: status).to_json
+    else
+      { error: detail }.to_json
+    end
+  end
+end

data/pact_broker.gemspec

@@ -79,7 +79,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "dry-logic", "0.4.2" # Later version cases ArgumentError: wrong number of arguments
   gem.add_runtime_dependency "table_print", "~> 1.5"
   gem.add_runtime_dependency "semantic_logger", "~> 4.11"
-  gem.add_runtime_dependency "sanitize", "6.0"
+  gem.add_runtime_dependency "sanitize", "~> 6.0"
   gem.add_runtime_dependency "wisper", "~> 2.0"
   gem.add_runtime_dependency "anyway_config", "~> 2.1"
   gem.add_runtime_dependency "request_store", "~> 1.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.105.0
+  version: 2.106.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -346,14 +346,14 @@ dependencies:
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -587,9 +587,14 @@ files:
 - db/migrations/20220303_increase_consumer_version_selector_hashes_column_size.rb
 - db/migrations/20220622_default_allow_dangerous_contract_modification_to_false_for_new_installations.rb
 - db/migrations/20220625_delete_pacticipants_with_no_name.rb
+- db/migrations/20221130_add_provider_version_id_index_to_verifications.rb
+- db/migrations/20221208_add_index_to_pact_version_provider_tag_successful_verifications.rb
+- db/migrations/20221215_add_prov_ver_id_ndx_to_latest_verifi_id_for_pact_ver_and_prov_ver.rb
+- db/migrations/20230131_add_cons_ver_id_ndx_to_latest_pp_id_for_cons_ver.rb
 - db/migrations/migration_helper.rb
 - docs/CONFIGURATION.md
 - docs/api/PACTICIPANTS.md
+- docs/api/PAGINATION.md
 - docs/api/WEBHOOKS.md
 - lib/pact/doc/README.md
 - lib/pact/doc/doc_file.rb
@@ -620,6 +625,7 @@ files:
 - lib/pact_broker/api/contracts/publish_contracts_schema.rb
 - lib/pact_broker/api/contracts/put_pact_params_contract.rb
 - lib/pact_broker/api/contracts/request_validations.rb
+- lib/pact_broker/api/contracts/utf_8_validation.rb
 - lib/pact_broker/api/contracts/verification_contract.rb
 - lib/pact_broker/api/contracts/webhook_contract.rb
 - lib/pact_broker/api/decorators.rb
@@ -627,6 +633,7 @@ files:
 - lib/pact_broker/api/decorators/basic_pacticipant_decorator.rb
 - lib/pact_broker/api/decorators/branch_version_decorator.rb
 - lib/pact_broker/api/decorators/configuration.rb
+- lib/pact_broker/api/decorators/custom_error_problem_json_decorator.rb
 - lib/pact_broker/api/decorators/dashboard_decorator.rb
 - lib/pact_broker/api/decorators/dashboard_text_decorator.rb
 - lib/pact_broker/api/decorators/decorator_context.rb
@@ -670,11 +677,13 @@ files:
 - lib/pact_broker/api/decorators/released_version_decorator.rb
 - lib/pact_broker/api/decorators/released_versions_decorator.rb
 - lib/pact_broker/api/decorators/representable_pact.rb
+- lib/pact_broker/api/decorators/runtime_error_problem_json_decorator.rb
 - lib/pact_broker/api/decorators/tag_decorator.rb
 - lib/pact_broker/api/decorators/tagged_pact_versions_decorator.rb
 - lib/pact_broker/api/decorators/timestamps.rb
 - lib/pact_broker/api/decorators/triggered_webhook_decorator.rb
 - lib/pact_broker/api/decorators/triggered_webhooks_decorator.rb
+- lib/pact_broker/api/decorators/validation_errors_problem_json_decorator.rb
 - lib/pact_broker/api/decorators/verifiable_pact_decorator.rb
 - lib/pact_broker/api/decorators/verifiable_pacts_decorator.rb
 - lib/pact_broker/api/decorators/verification_decorator.rb
@@ -714,7 +723,8 @@ files:
 - lib/pact_broker/api/resources/environment.rb
 - lib/pact_broker/api/resources/environments.rb
 - lib/pact_broker/api/resources/error_handler.rb
-- lib/pact_broker/api/resources/error_response_body_generator.rb
+- lib/pact_broker/api/resources/error_handling_methods.rb
+- lib/pact_broker/api/resources/error_response_generator.rb
 - lib/pact_broker/api/resources/error_test.rb
 - lib/pact_broker/api/resources/group.rb
 - lib/pact_broker/api/resources/index.rb
@@ -976,6 +986,7 @@ files:
 - lib/pact_broker/relationships/groupify.rb
 - lib/pact_broker/repositories.rb
 - lib/pact_broker/repositories/helpers.rb
+- lib/pact_broker/repositories/page.rb
 - lib/pact_broker/repositories/scopes.rb
 - lib/pact_broker/services.rb
 - lib/pact_broker/string_refinements.rb
@@ -1082,7 +1093,6 @@ files:
 - lib/rack/pact_broker/add_vary_header.rb
 - lib/rack/pact_broker/cascade.rb
 - lib/rack/pact_broker/configurable_make_it_later.rb
-- lib/rack/pact_broker/convert_404_to_hal.rb
 - lib/rack/pact_broker/convert_file_extension_to_accept_header.rb
 - lib/rack/pact_broker/database_transaction.rb
 - lib/rack/pact_broker/invalid_uri_protection.rb
@@ -1097,7 +1107,9 @@ files:
 - lib/sequel/extensions/statement_timeout.rb
 - lib/sequel/plugins/insert_ignore.rb
 - lib/sequel/plugins/upsert.rb
+- lib/webmachine/application_monkey_patch.rb
 - lib/webmachine/describe_routes.rb
+- lib/webmachine/render_error_monkey_patch.rb
 - pact_broker.gemspec
 - public/Network Graph_files/d3.v3.js
 - public/Network Graph_files/ga.js
@@ -1227,7 +1239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: See description

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

@@ -1,41 +0,0 @@
-require "pact_broker/configuration"
-
-module PactBroker
-  module Api
-    module Resources
-      class ErrorResponseBodyGenerator
-        include PactBroker::Logging
-
-        # env not needed, just passing in in case PF ever needs it
-        def self.call error, error_reference, _env = {}
-          response_body_hash(error, error_reference).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
-
-        def self.obfuscated_error_message(error_reference)
-          "An error has occurred. The details have been logged with the reference #{error_reference}"
-        end
-
-        def self.response_body_hash(error, error_reference)
-          response_body = {
-            error: {
-              message: display_message(error, obfuscated_error_message(error_reference)),
-              reference: error_reference
-            }
-          }
-          if PactBroker.configuration.show_backtrace_in_error_response?
-            response_body[:error][:backtrace] = error.backtrace
-          end
-          response_body
-        end
-      end
-    end
-  end
-end

data/lib/rack/pact_broker/convert_404_to_hal.rb

@@ -1,20 +0,0 @@
-module Rack
-  module PactBroker
-    class Convert404ToHal
-
-      def initialize app
-        @app = app
-      end
-
-      def call env
-        response = @app.call(env)
-
-        if response.first == 404 && response[1]["Content-Type"] == "text/html" && !(env["HTTP_ACCEPT"] =~ /html|javascript|css/)
-          [404, { "Content-Type" => "application/hal+json;charset=utf-8"},[]]
-        else
-          response
-        end
-      end
-    end
-  end
-end