pact_broker 2.72.0 → 2.76.0

data/lib/pact_broker/application_context.rb

@@ -0,0 +1,41 @@
+require 'pact_broker/api/decorators/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'
+
+module PactBroker
+  class ApplicationContext
+    attr_reader :decorator_configuration,
+                :decorator_context_creator,
+                :webhook_execution_configuration_creator,
+                :resource_authorizer,
+                :before_resource,
+                :after_resource,
+                :error_logger,
+                :error_response_body_generator
+
+    def initialize(params = {})
+      params_with_defaults = {
+        decorator_configuration: PactBroker::Api::Decorators::Configuration.default_configuration,
+        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
+      }.merge(params)
+
+      @decorator_configuration = params_with_defaults[:decorator_configuration]
+      @decorator_context_creator = params_with_defaults[:decorator_context_creator]
+      @webhook_execution_configuration_creator = params_with_defaults[:webhook_execution_configuration_creator]
+      @resource_authorizer = params_with_defaults[:resource_authorizer]
+      @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]
+    end
+
+    def self.default_application_context(overrides = {})
+      ApplicationContext.new(overrides)
+    end
+  end
+end

data/lib/pact_broker/configuration.rb

@@ -38,7 +38,8 @@ module PactBroker
       :log_dir,
       :allow_missing_migration_files,
       :auto_migrate_db_data,
-      :use_rack_protection
+      :use_rack_protection,
+      :metrics_sql_statement_timeout
     ]
 
     attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :allow_missing_migration_files, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
@@ -57,6 +58,7 @@ module PactBroker
     attr_reader :api_error_reporters
     attr_reader :custom_logger
     attr_accessor :policy_builder, :policy_scope_builder, :base_resource_class_factory
+    attr_accessor :metrics_sql_statement_timeout
 
     alias_method :policy_finder=, :policy_builder=
     alias_method :policy_scope_finder=, :policy_scope_builder=
@@ -125,7 +127,8 @@ module PactBroker
         require 'pact_broker/api/resources/default_base_resource'
         PactBroker::Api::Resources::DefaultBaseResource
       }
-      config.warning_error_class_names = ['Sequel::ForeignKeyConstraintViolation']
+      config.warning_error_class_names = ['Sequel::ForeignKeyConstraintViolation', 'PG::QueryCanceled']
+      config.metrics_sql_statement_timeout = 30
       config
     end
 
@@ -247,8 +250,13 @@ module PactBroker
 
     def warning_error_classes
       warning_error_class_names.collect do | class_name |
-        Object.const_get(class_name)
-      end
+        begin
+          Object.const_get(class_name)
+        rescue NameError => e
+          logger.warn("Class #{class_name} couldn't be loaded as a warning error class (#{e.class} - #{e.message}). Ignoring.")
+          nil
+        end
+      end.compact
     end
 
     private

data/lib/pact_broker/doc/controllers/app.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'padrino-core'
 require 'redcarpet'
 
@@ -50,9 +51,9 @@ module PactBroker
           # https://www.acunetix.com/blog/articles/automated-detection-of-host-header-attacks/
           # Either use the explicitly configured base url or an empty string,
           # rather than request.base_url, which uses the X-Forwarded headers.
-          PactBroker.configuration.base_url || ''
+          env["pactbroker.base_url"] || ''
         end
       end
     end
   end
-end
+end

data/lib/pact_broker/domain/version.rb

@@ -47,13 +47,20 @@ module PactBroker
       dataset_module do
         include PactBroker::Repositories::Helpers
 
+        def for(pacticipant_name, version_number)
+          where_pacticipant_name(pacticipant_name).where_number(version_number).single_record
+        end
+
         def where_pacticipant_name(pacticipant_name)
-          join(:pacticipants) do | p |
-            Sequel.&(
-              { Sequel[first_source_alias][:pacticipant_id] => Sequel[p][:id] },
-              name_like(Sequel[p][:name], pacticipant_name)
-            )
-          end
+          where(pacticipant_id: db[:pacticipants].select(:id).where(name_like(:name, pacticipant_name)))
+          # If we do a join, we get the extra columns from the pacticipant table that then
+          # make == not work
+          # join(:pacticipants) do | p |
+          #   Sequel.&(
+          #     { Sequel[first_source_alias][:pacticipant_id] => Sequel[p][:id] },
+          #     name_like(Sequel[p][:name], pacticipant_name)
+          #   )
+          # end
         end
 
         def where_tag(tag)

data/lib/pact_broker/domain/webhook_request.rb

@@ -51,7 +51,7 @@ module PactBroker
       end
 
       def execute
-        options = PactBroker::BuildHttpOptions.call(uri)
+        options = PactBroker::BuildHttpOptions.call(uri).merge(read_timeout: 15, open_timeout: 15)
         req = http_request
         Net::HTTP.start(uri.hostname, uri.port, :ENV, options) do |http|
           http.request req

data/lib/pact_broker/error.rb

@@ -1,6 +1,4 @@
 module PactBroker
-
   class Error < StandardError; end
   class TestError < StandardError; end
-
 end

data/lib/pact_broker/errors.rb

@@ -0,0 +1,28 @@
+require 'pact_broker/configuration'
+require 'pact_broker/error'
+require 'pact_broker/logging'
+require 'securerandom'
+
+module PactBroker
+  module Errors
+    include PactBroker::Logging
+
+    def self.generate_error_reference
+      SecureRandom.urlsafe_base64.gsub(/[^a-z]/i, '')[0,10]
+    end
+
+    def self.reportable_error?(error)
+      !error.is_a?(PactBroker::Error) && !error.is_a?(JSON::JSONError)
+    end
+
+    def self.report error, error_reference, request
+      PactBroker.configuration.api_error_reporters.each do | error_notifier |
+        begin
+          error_notifier.call(error, env: request.env, error_reference: error_reference)
+        rescue StandardError => e
+          log_error(e, "Error executing api_error_reporter")
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/errors/error_logger.rb

@@ -0,0 +1,25 @@
+require 'pact_broker/configuration'
+require 'pact_broker/logging'
+
+module PactBroker
+  module Errors
+    class ErrorLogger
+      include PactBroker::Logging
+
+      # don't need the env, just in case PF needs it
+      def self.call(error, error_reference, env = {})
+        if log_as_warning?(error)
+          logger.warn("Error reference #{error_reference}", error)
+        elsif PactBroker::Errors.reportable_error?(error)
+          log_error(error, "Error reference #{error_reference}")
+        else
+          logger.info("Error reference #{error_reference}", error)
+        end
+      end
+
+      def self.log_as_warning?(error)
+        PactBroker.configuration.warning_error_classes.any? { |clazz| error.is_a?(clazz) || error.cause&.is_a?(clazz) }
+      end
+    end
+  end
+end

data/lib/pact_broker/metrics/service.rb

@@ -1,3 +1,4 @@
+require 'pact_broker/configuration'
 require 'pact_broker/pacts/pact_publication'
 require 'pact_broker/pacts/pact_version'
 require 'pact_broker/domain/pacticipant'
@@ -66,7 +67,7 @@ module PactBroker
             count: PactBroker::Webhooks::Execution.count
           },
           matrix: {
-            count: PactBroker::Matrix::Row.count
+            count: matrix_count
           }
         }
       end
@@ -87,6 +88,16 @@ module PactBroker
           order by 1"
           PactBroker::Pacts::PactPublication.db[query].all.each_with_object({}) { |row, hash| hash[row[:number_of_verifications]] = row[:pact_version_count] }
       end
+
+      def matrix_count
+        begin
+          PactBroker::Matrix::Row.db.with_statement_timeout(PactBroker.configuration.metrics_sql_statement_timeout) do
+            PactBroker::Matrix::Row.count
+          end
+        rescue Sequel::DatabaseError => e
+          -1
+        end
+      end
     end
   end
 end

data/lib/pact_broker/pacts/metadata.rb

@@ -1,10 +1,17 @@
-require 'pact_broker/feature_toggle'
-
 module PactBroker
   module Pacts
     module Metadata
       extend self
 
+      MAPPINGS = [
+        [:consumer_version_tags, "cvt"],
+        [:consumer_version_number, "cvn"],
+        [:wip, "w"],
+        [:consumer_version_selectors, "s"],
+        [:tag, "t"],
+        [:latest, "l"]
+      ]
+
       # When verifying a pact at /.../latest/TAG, this stores the
       # tag and the current consumer version number in the
       # metadata parameter of the URL for publishing the verification results.
@@ -13,12 +20,12 @@ module PactBroker
       def build_metadata_for_latest_pact(pact, selection_parameters)
         if selection_parameters[:tag]
           {
-            consumer_version_tags: [selection_parameters[:tag]],
-            consumer_version_number: pact.consumer_version_number
+            "cvt" => [selection_parameters[:tag]],
+            "cvn" => pact.consumer_version_number
           }
         else
           {
-            consumer_version_number: pact.consumer_version_number
+            "cvn" => pact.consumer_version_number
           }
         end
       end
@@ -30,12 +37,50 @@ module PactBroker
       # go back to the correct consumer version number (eg for git statuses)
       def build_metadata_for_webhook_triggered_by_pact_publication(pact)
         metadata = {
-          consumer_version_number: pact.consumer_version_number,
-          consumer_version_tags: pact.consumer_version_tag_names
+          "cvn" => pact.consumer_version_number,
+          "cvt" => pact.consumer_version_tag_names
         }
-        metadata[:wip] = "true" if PactBroker.feature_enabled?(:experimental_webhook_wip)
+        metadata["w"] = "true"
         metadata
       end
+
+      def build_metadata_for_pact_for_verification(verifiable_pact)
+        # todo put in tags
+        if verifiable_pact.wip
+          {
+            "w" => true
+          }
+        else
+          {
+            "s" => verifiable_pact.selectors.collect do | selector |
+              {
+                "t" => selector.tag,
+                "l" => selector.latest,
+                "cvn" => selector.consumer_version.number
+              }.compact
+            end
+          }
+        end
+      end
+
+      def parse_metadata(metadata)
+        parse_object(metadata)
+      end
+
+      def parse_object(object)
+        case object
+        when Hash then parse_hash(object)
+        when Array then object.collect{|i| parse_object(i) }
+        else object
+        end
+      end
+
+      def parse_hash(hash)
+        hash.each_with_object({}) do | (key, value), new_hash |
+          long_key = MAPPINGS.find{ |mapping| mapping.last == key }&.first
+          new_hash[long_key || key] = parse_object(value)
+        end
+      end
     end
   end
 end

data/lib/pact_broker/pacts/repository.rb

@@ -168,7 +168,7 @@ module PactBroker
           .values
           .collect do | pact_publications |
             latest_pact_publication = pact_publications.sort_by{ |p| p.values.fetch(:consumer_version_order) }.last
-            SelectedPact.new(latest_pact_publication.to_domain, Selectors.new(selector))
+            SelectedPact.new(latest_pact_publication.to_domain, Selectors.new(selector).resolve(latest_pact_publication.consumer_version))
           end
       end
 
@@ -428,7 +428,7 @@ module PactBroker
             .order_ignore_case(:consumer_name)
             .collect do | latest_pact_publication |
               pact_publication = PactPublication.find(id: latest_pact_publication.id)
-              SelectedPact.new(pact_publication.to_domain, Selectors.create_for_overall_latest)
+              SelectedPact.new(pact_publication.to_domain, Selectors.create_for_overall_latest.resolve(pact_publication.consumer_version))
             end
         else
           selectors_for_overall_latest = consumer_version_selectors.select(&:overall_latest?)
@@ -438,7 +438,7 @@ module PactBroker
             query.collect do | latest_pact_publication |
               pact_publication = PactPublication.find(id: latest_pact_publication.id)
               resolved_selector = selector.consumer ? Selector.latest_for_consumer(selector.consumer) : Selector.overall_latest
-              SelectedPact.new(pact_publication.to_domain, Selectors.new(resolved_selector))
+              SelectedPact.new(pact_publication.to_domain, Selectors.new(resolved_selector).resolve(pact_publication.consumer_version))
             end
           end
         end
@@ -453,26 +453,19 @@ module PactBroker
           query = query.consumer(selector.consumer) if selector.consumer
           query.all.collect do | latest_tagged_pact_publication |
             pact_publication = PactPublication.find(id: latest_tagged_pact_publication.id)
-            resolved_pact = selector.consumer ? Selector.latest_for_tag_and_consumer(selector.tag, selector.consumer) : Selector.latest_for_tag(selector.tag)
+            resolved_selector = if selector.consumer
+              Selector.latest_for_tag_and_consumer(selector.tag, selector.consumer).resolve(pact_publication.consumer_version)
+            else
+              Selector.latest_for_tag(selector.tag).resolve(pact_publication.consumer_version)
+            end
             SelectedPact.new(
               pact_publication.to_domain,
-              Selectors.new(resolved_pact)
+              Selectors.new(resolved_selector)
             )
           end
         end
       end
 
-      def create_fallback_selected_pact(pact_publications, consumer_version_selectors)
-        selector_tag_names = pact_publications.collect(&:tag_name)
-        selectors = Selectors.create_for_latest_fallback_of_each_tag(selector_tag_names)
-        last_pact_publication = pact_publications.sort_by(&:consumer_version_order).last
-        pact_publication = unscoped(PactPublication).find(id: last_pact_publication.id)
-        SelectedPact.new(
-          pact_publication.to_domain,
-          selectors
-        )
-      end
-
       def find_pacts_for_which_the_latest_version_for_the_fallback_tag_is_required(provider_name, selectors)
         selectors.collect do | selector |
           query = scope_for(LatestTaggedPactPublications).provider(provider_name).where(tag_name: selector.fallback_tag)
@@ -482,7 +475,7 @@ module PactBroker
               pact_publication = unscoped(PactPublication).find(id: latest_tagged_pact_publication.id)
               SelectedPact.new(
                 pact_publication.to_domain,
-                Selectors.new(selector)
+                Selectors.new(selector.resolve(pact_publication.consumer_version))
               )
             end
         end.flatten

data/lib/pact_broker/pacts/selector.rb

@@ -5,6 +5,10 @@ module PactBroker
         merge!(options)
       end
 
+      def resolve(consumer_version)
+        ResolvedSelector.new(self.to_h, consumer_version)
+      end
+
       def tag= tag
         self[:tag] = tag
       end
@@ -94,6 +98,10 @@ module PactBroker
         !!(tag && !latest?)
       end
 
+      def == other
+        other.class == self.class && super
+      end
+
       def <=> other
         if overall_latest? || other.overall_latest?
           if overall_latest? == other.overall_latest?
@@ -124,5 +132,19 @@ module PactBroker
         !!self[:latest]
       end
     end
+
+    class ResolvedSelector < Selector
+      def initialize(options = {}, consumer_version)
+        super(options.merge(consumer_version: consumer_version))
+      end
+
+      def consumer_version
+        self[:consumer_version]
+      end
+
+      def == other
+        super && consumer_version == other.consumer_version
+      end
+    end
   end
 end

data/lib/pact_broker/pacts/selectors.rb

@@ -19,6 +19,10 @@ module PactBroker
         Selectors.new([Selector.overall_latest])
       end
 
+      def resolve(consumer_version)
+        Selectors.new(collect{ |selector| selector.resolve(consumer_version) })
+      end
+
       def + other
         Selectors.new(super)
       end

data/lib/pact_broker/services.rb

@@ -1,80 +1,155 @@
 module PactBroker
   module Services
 
+    FACTORIES = {}
+
+    extend self
+
+    def register_service(name, &block)
+      FACTORIES[name] = block
+    end
+
+    def get(name)
+      FACTORIES[name].call
+    end
+
     def index_service
-      require 'pact_broker/index/service'
-      Index::Service
+      get(:index_service)
     end
 
     def pact_service
-      # TODO work out how to fix circular dependency
-      require 'pact_broker/pacts/service'
-      Pacts::Service
+      get(:pact_service)
     end
 
     def pacticipant_service
-      require 'pact_broker/pacticipants/service'
-      Pacticipants::Service
+      get(:pacticipant_service)
     end
 
     def tag_service
-      require 'pact_broker/tags/service'
-      Tags::Service
+      get(:tag_service)
     end
 
     def label_service
-      require 'pact_broker/labels/service'
-      Labels::Service
+      get(:label_service)
     end
 
     def group_service
-      require 'pact_broker/groups/service'
-      Groups::Service
+      get(:group_service)
     end
 
     def webhook_service
-      require 'pact_broker/webhooks/service'
-      Webhooks::Service
+      get(:webhook_service)
     end
 
     def version_service
-      require 'pact_broker/versions/service'
-      Versions::Service
+      get(:version_service)
     end
 
     def verification_service
-      require 'pact_broker/verifications/service'
-      Verifications::Service
+      get(:verification_service)
     end
 
     def badge_service
-      require 'pact_broker/badges/service'
-      Badges::Service
+      get(:badge_service)
     end
 
     def matrix_service
-      require 'pact_broker/matrix/service'
-      Matrix::Service
+      get(:matrix_service)
     end
 
     def certificate_service
-      require 'pact_broker/certificates/service'
-      Certificates::Service
+      get(:certificate_service)
     end
 
     def integration_service
-      require 'pact_broker/integrations/service'
-      Integrations::Service
+      get(:integration_service)
     end
 
     def webhook_trigger_service
-      require 'pact_broker/webhooks/trigger_service'
-      Webhooks::TriggerService
+      get(:webhook_trigger_service)
     end
 
     def metrics_service
-      require 'pact_broker/metrics/service'
-      Metrics::Service
+      get(:metrics_service)
+    end
+
+    def register_default_services
+      register_service(:index_service) do
+        require 'pact_broker/index/service'
+        Index::Service
+      end
+
+      register_service(:metrics_service) do
+        require 'pact_broker/metrics/service'
+        Metrics::Service
+      end
+
+      register_service(:matrix_service) do
+        require 'pact_broker/matrix/service'
+        Matrix::Service
+      end
+
+      register_service(:pact_service) do
+        require 'pact_broker/pacts/service'
+        Pacts::Service
+      end
+
+      register_service(:pacticipant_service) do
+        require 'pact_broker/pacticipants/service'
+        Pacticipants::Service
+      end
+
+      register_service(:tag_service) do
+        require 'pact_broker/tags/service'
+        Tags::Service
+      end
+
+      register_service(:label_service) do
+        require 'pact_broker/labels/service'
+        Labels::Service
+      end
+
+      register_service(:group_service) do
+        require 'pact_broker/groups/service'
+        Groups::Service
+      end
+
+      register_service(:webhook_service) do
+        require 'pact_broker/webhooks/service'
+        Webhooks::Service
+      end
+
+      register_service(:version_service) do
+        require 'pact_broker/versions/service'
+        Versions::Service
+      end
+
+      register_service(:verification_service) do
+        require 'pact_broker/verifications/service'
+        Verifications::Service
+      end
+
+      register_service(:badge_service) do
+        require 'pact_broker/badges/service'
+        Badges::Service
+      end
+
+      register_service(:certificate_service) do
+        require 'pact_broker/certificates/service'
+        Certificates::Service
+      end
+
+      register_service(:integration_service) do
+        require 'pact_broker/integrations/service'
+        Integrations::Service
+      end
+
+      register_service(:webhook_trigger_service) do
+        require 'pact_broker/webhooks/trigger_service'
+        Webhooks::TriggerService
+      end
     end
   end
 end
+
+PactBroker::Services.register_default_services