pact_broker 2.107.1 → 2.109.0

data/lib/pact_broker/config/runtime_configuration_coercion_methods.rb

@@ -1,15 +1,45 @@
 require "pact_broker/config/space_delimited_string_list"
 require "pact_broker/config/space_delimited_integer_list"
+require "pact_broker/hash_refinements"
+require "pact_broker/error"
 
 module PactBroker
   module Config
     module RuntimeConfigurationCoercionMethods
 
-      def all_keys_are_number_strings?(hash)
+      using PactBroker::HashRefinements
+
+      COERCE_FEATURES = lambda { | value |
+        if value.is_a?(String)
+          value.split(" ").each_with_object({}) { | k, h | h[k.downcase.to_sym] = true }
+        elsif value.is_a?(Array)
+          value.each_with_object({}) { | k, h | h[k.downcase.to_sym] = true }
+        elsif value.is_a?(Hash)
+          value.each_with_object({}) { | (k, v), new_hash | new_hash[k.downcase.to_sym] = Anyway::AutoCast.call(v) }
+        else
+          raise PactBroker::ConfigurationError, "Expected a String, Hash or Array for features but got a #{value.class.name}"
+        end
+      }
+
+      COERCE_WEBHOOKS = lambda { | value |
+        if value.is_a?(Hash) # from env vars
+          if RuntimeConfigurationCoercionMethods.all_keys_are_number_strings?(value)
+            RuntimeConfigurationCoercionMethods.convert_hash_with_number_string_keys_to_array(value).collect(&:symbolize_keys)
+          else
+            raise PactBroker::ConfigurationError, "Could not coerce #{value} into an array of webhook configurations. Please check docs for the expected format."
+          end
+        elsif value.is_a?(Array) # from YAML
+          value.collect(&:symbolize_keys)
+        else
+          raise PactBroker::ConfigurationError, "Webhook certificates cannot be set using a #{value.class}"
+        end
+      }
+
+      def self.all_keys_are_number_strings?(hash)
         hash.keys.all? { | k | k.to_s.to_i.to_s == k } # is an integer as a string
       end
 
-      def convert_hash_with_number_string_keys_to_array(hash)
+      def self.convert_hash_with_number_string_keys_to_array(hash)
         hash.keys.collect{ |k| [k, k.to_i]}.sort_by(&:last).collect(&:first).collect do | key |
           hash[key]
         end

data/lib/pact_broker/config/runtime_configuration_database_methods.rb

@@ -27,7 +27,7 @@ module PactBroker
             allow_missing_migration_files: true,
             validate_database_connection_config: true,
             database_statement_timeout: 15,
-            metrics_sql_statement_timeout: 30,
+            metrics_sql_statement_timeout: 30, # TODO get rid of this in next major version
             database_connection_validation_timeout: nil
           )
 

data/lib/pact_broker/config/runtime_configuration_logging_methods.rb

@@ -25,16 +25,19 @@ module PactBroker
         # base_url raises a not implemented error
         def log_configuration(logger)
           source_info = to_source_trace
-          (self.class.config_attributes - [:base_url]).collect(&:to_s).each_with_object({})do | key, new_hash |
+          attributes_to_log.collect(&:to_s).each_with_object({}) do | key, new_hash |
             new_hash[key] = {
               value: self.send(key.to_sym),
-              source: source_info.dig(key, :source) || {:type=>:defaults}
+              source: source_info.dig(key, :source) || source_info.dig(key) || { type: :defaults }
             }
           end.sort_by { |key, _| key }.each { |key, value| log_config_inner(key, value, logger) }
-          if self.webhook_redact_sensitive_data == false
-            logger.warn("WARNING!!! webhook_redact_sensitive_data is set to false. This will allow authentication information to be included in the webhook logs. This should only be used for debugging purposes. Do not run the application permanently in production with this value.")
-          end
+          print_warnings(logger)
+        end
+
+        def attributes_to_log
+          self.class.config_attributes - [:base_url]
         end
+        private :attributes_to_log
 
         def log_config_inner(key, value, logger)
           # TODO fix the source display for webhook_certificates set by environment variables
@@ -68,6 +71,13 @@ module PactBroker
           end
         end
         private :redact
+
+        def print_warnings(logger)
+          if self.webhook_redact_sensitive_data == false
+            logger.warn("WARNING!!! webhook_redact_sensitive_data is set to false. This will allow authentication information to be included in the webhook logs. This should only be used for debugging purposes. Do not run the application permanently in production with this value.")
+          end
+        end
+        private :print_warnings
       end
 
       def self.included(receiver)

data/lib/pact_broker/configuration.rb

@@ -82,23 +82,14 @@ module PactBroker
 
     def override_runtime_configuration!(overrides)
       new_runtime_configuration = runtime_configuration.dup
-      valid_overrides = {}
-      invalid_overrides = {}
-
-      overrides.each do | key, value |
-        if new_runtime_configuration.respond_to?("#{key}=")
-          valid_overrides[key] = Anyway::AutoCast.call(value)
-        else
-          invalid_overrides[key] = Anyway::AutoCast.call(value)
-        end
-      end
+      valid_overrides, invalid_overrides = identify_valid_and_invalid_configuration_overrides(new_runtime_configuration, overrides)
 
       if logger.debug?
-        logger.debug("Overridding runtime configuration", overrides: valid_overrides, ignoring: invalid_overrides)
+        logger.debug("Overriding runtime configuration", overrides: valid_overrides, ignoring: invalid_overrides)
       end
 
       valid_overrides.each do | key, value |
-        new_runtime_configuration.public_send("#{key}=", value)
+        override_or_merge_value(new_runtime_configuration, key, value)
       end
 
       self.runtime_configuration = new_runtime_configuration
@@ -220,5 +211,31 @@ module PactBroker
       require "pact_broker/config/load"
       PactBroker::Config::Load.call(runtime_configuration)
     end
+
+    private
+
+    def identify_valid_and_invalid_configuration_overrides(new_runtime_configuration, overrides)
+      valid_overrides = {}
+      invalid_overrides = {}
+
+      overrides.each do | key, value |
+        if new_runtime_configuration.respond_to?("#{key}=")
+          valid_overrides[key] = Anyway::AutoCast.call(value)
+        else
+          invalid_overrides[key] = Anyway::AutoCast.call(value)
+        end
+      end
+
+      return valid_overrides, invalid_overrides
+    end
+
+    def override_or_merge_value(new_runtime_configuration, key, value)
+      # Do a merge if original value and new value are both hashes
+      if value.is_a?(Hash) && new_runtime_configuration.public_send(key).is_a?(Hash)
+        new_runtime_configuration.public_send("#{key}=", new_runtime_configuration.public_send(key).merge(value))
+      else
+        new_runtime_configuration.public_send("#{key}=", value)
+      end
+    end
   end
 end

data/lib/pact_broker/contracts/contract_to_publish.rb

@@ -1,11 +1,10 @@
 module PactBroker
   module Contracts
-    ContractToPublish = Struct.new(:consumer_name, :provider_name, :decoded_content, :content_type, :specification, :on_conflict) do
-      # rubocop: disable Metrics/ParameterLists
-      def self.from_hash(consumer_name: nil, provider_name: nil, decoded_content: nil, content_type: nil, specification: nil, on_conflict: nil)
-        new(consumer_name, provider_name, decoded_content, content_type, specification, on_conflict)
+    ContractToPublish = Struct.new(:consumer_name, :provider_name, :decoded_content, :content_type, :specification, :on_conflict, :pact_version_sha, keyword_init: true) do
+
+      def self.from_hash(hash)
+        new(**hash)
       end
-      # rubocop: enable Metrics/ParameterLists
 
       def pact?
         specification == "pact"

data/lib/pact_broker/contracts/contracts_to_publish.rb

@@ -10,6 +10,14 @@ module PactBroker
       def pacticipant_names
         contracts.flat_map(&:pacticipant_names).uniq
       end
+
+      def provider_names
+        contracts.flat_map(&:provider_name).uniq
+      end
+
+      def logging_info
+        to_h.slice(:pacticipant_name, :pacticipant_version_number, :tags, :branch, :build_url).merge(provider_names: provider_names)
+      end
     end
   end
 end

data/lib/pact_broker/contracts/service.rb

@@ -31,9 +31,11 @@ module PactBroker
       end
 
       def publish(parsed_contracts, base_url: )
+        logger.info("Publishing contracts", parsed_contracts.logging_info)
         version, version_notices = create_version(parsed_contracts)
         tags = create_tags(parsed_contracts, version)
         pacts, pact_notices = create_pacts(parsed_contracts, base_url)
+        update_integrations(pacts)
         notices = version_notices + pact_notices
         ContractsPublicationResults.from_hash(
           pacticipant: version.pacticipant,
@@ -55,7 +57,7 @@ module PactBroker
         parsed_contracts.contracts.collect do | contract_to_publish |
           pact_params = create_pact_params(parsed_contracts, contract_to_publish)
           existing_pact = pact_service.find_pact(pact_params)
-          if existing_pact && pact_service.disallowed_modification?(existing_pact, contract_to_publish.decoded_content)
+          if existing_pact && pact_service.disallowed_modification?(existing_pact, contract_to_publish.pact_version_sha)
             add_pact_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_pact.json_content, contract_to_publish.decoded_content)
           end
         end
@@ -65,7 +67,7 @@ module PactBroker
 
       def add_pact_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_json_content, new_json_content)
         message_params = {
-          consumer_name: contract_to_publish.provider_name,
+          consumer_name: contract_to_publish.consumer_name,
           consumer_version_number: parsed_contracts.pacticipant_version_number,
           provider_name: contract_to_publish.provider_name
         }
@@ -132,7 +134,7 @@ module PactBroker
           pact_params = create_pact_params(parsed_contracts, contract_to_publish)
           existing_pact = pact_service.find_pact(pact_params)
           listener = TriggeredWebhooksCreatedListener.new
-          created_pact = create_or_merge_pact(contract_to_publish.merge?, existing_pact, pact_params, listener)
+          created_pact = create_or_merge_pact(contract_to_publish.merge?, existing_pact, pact_params.merge(pact_version_sha: contract_to_publish.pact_version_sha), listener)
           notices.concat(notices_for_pact(parsed_contracts, contract_to_publish, existing_pact, created_pact, listener, base_url))
           created_pact
         end
@@ -302,6 +304,10 @@ module PactBroker
         PactBroker::Api::PactBrokerUrls.triggered_webhook_logs_url(triggered_webhook, base_url)
       end
 
+      def update_integrations(pacts)
+        integration_service.handle_bulk_contract_data_published(pacts)
+      end
+
       private :url_for_triggered_webhook
     end
   end

data/lib/pact_broker/dataset/page.rb

@@ -0,0 +1,22 @@
+require "forwardable"
+
+# An array that provides the pagination details
+
+module PactBroker
+  module Dataset
+    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

data/lib/pact_broker/dataset.rb

@@ -0,0 +1,122 @@
+require "sequel"
+require "pact_broker/dataset/page"
+
+Sequel.extension :escaped_like
+
+module PactBroker
+  module Dataset
+    module Helpers
+      extend self
+
+      def mysql?
+        Sequel::Model.db.adapter_scheme.to_s =~ /mysql/
+      end
+
+      def postgres?
+        Sequel::Model.db.adapter_scheme.to_s =~ /postgres/
+      end
+
+      def escape_wildcards(value)
+        value.gsub("_", "\\_").gsub("%", "\\%")
+      end
+    end
+
+    include Helpers
+
+    # Return a dataset that only includes the rows where the specified column
+    # includes the given query string.
+    # @return [Sequel::Dataset]
+    def filter(column_name, query_string)
+      where(Sequel.ilike(column_name, "%" + escape_wildcards(query_string) + "%"))
+    end
+
+    def name_like column_name, value
+      if PactBroker.configuration.use_case_sensitive_resource_names
+        if mysql?
+          # sigh, mysql, this is the only way to perform a case sensitive search
+          Sequel.like(column_name, value.gsub("_", "\\_"), { case_insensitive: false })
+        else
+          { column_name => value }
+        end
+      else
+        Sequel.like(column_name, value.gsub("_", "\\_"), { case_insensitive: true })
+      end
+    end
+
+    def where_name_like(column_name, value)
+      where(name_like(column_name, value))
+    end
+
+    def select_all_qualified
+      select(Sequel[model.table_name].*)
+    end
+
+    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
+
+    def all_allowing_lazy_load
+      all.each{ | row | row.allow_lazy_load if row.respond_to?(:allow_lazy_load) }
+    end
+
+    # @param [Symbol] max_column the name of the column of which to calculate the maxiumum
+    # @param [Array<Symbol>] group_by_columns the names of the columns by which to group
+    def max_group_by(max_column, group_by_columns, &extra_criteria_block)
+      maximums_base_query = extra_criteria_block ? extra_criteria_block.call(self) : self
+      maximums = maximums_base_query.select_group(*group_by_columns).select_append(Sequel.function(:max, max_column).as(:max_value))
+
+      max_join = group_by_columns.each_with_object({ Sequel[:maximums][:max_value] => max_column }) do | column_name, joins |
+        joins[Sequel[:maximums][column_name]] = column_name
+      end
+
+      join(maximums, max_join, table_alias: :maximums)
+    end
+
+    def select_for_subquery column
+      if mysql? #stoopid mysql doesn't allow you to modify datasets with subqueries
+        column_name = column.respond_to?(:alias) ? column.alias : column
+        select(column).collect{ | it | it[column_name] }
+      else
+        select(column)
+      end
+    end
+
+    def no_columns_selected?
+      opts[:select].nil?
+    end
+
+    def order_ignore_case column_name = :name
+      order(Sequel.function(:lower, column_name))
+    end
+
+    def order_append_ignore_case column_name = :name
+      order_append(Sequel.function(:lower, column_name))
+    end
+  end
+end
+
+module Sequel
+  # For matching identifying names based on the :use_case_sensitive_resource_names config setting.
+  # This has been used inconsistently, and in the next major version, support for case insensitive names will be dropped.
+  def self.name_like(column_name, value)
+    if PactBroker.configuration.use_case_sensitive_resource_names
+      if PactBroker::Dataset::Helpers.mysql?
+        # sigh, mysql, this is the only way to perform a case sensitive search
+        Sequel.like(column_name, PactBroker::Dataset::Helpers.escape_wildcards(value), { case_insensitive: false })
+      else
+        { column_name => value }
+      end
+    else
+      Sequel.like(column_name, PactBroker::Dataset::Helpers.escape_wildcards(value), { case_insensitive: true })
+    end
+  end
+end

data/lib/pact_broker/db/data_migrations/set_contract_data_updated_at_for_integrations.rb

@@ -0,0 +1,47 @@
+# Populate the newly created contract_data_updated_at date in the integrations table
+# using the latest created_at date from the pact_publications or verifications tables.
+module PactBroker
+  module DB
+    module DataMigrations
+      class SetContractDataUpdatedAtForIntegrations
+        def self.call(connection)
+          join = {
+            Sequel[:integrations][:consumer_id] => Sequel[:target][:consumer_id],
+            Sequel[:integrations][:provider_id] => Sequel[:target][:provider_id]
+          }
+
+          max_created_at_for_each_integration = integrations_max_created_at(connection).from_self(alias: :target).select(:created_at).where(join)
+
+          connection[:integrations]
+            .where(contract_data_updated_at: nil)
+            .update(contract_data_updated_at:  max_created_at_for_each_integration)
+        end
+
+        # @return [Sequel::Dataset] the overall max created_at from the union of the pact_publications and verifications tables,
+        # for each integration keyed by consumer_id/provider_id
+        def self.integrations_max_created_at(connection)
+          pact_publication_max_created_at(connection)
+            .union(verification_max_created_at(connection))
+            .select_group(:consumer_id, :provider_id)
+            .select_append{ max(:created_at).as(:created_at) }
+        end
+
+        # @return [Sequel::Dataset] the max created_at from the pact_publications table
+        # for each integration keyed by consumer_id/provider_id
+        def self.pact_publication_max_created_at(connection)
+          connection[:pact_publications]
+            .select_group(:consumer_id, :provider_id)
+            .select_append{ max(:created_at).as(:created_at) }
+        end
+
+        # @return [Sequel::Dataset] the max created_at from the verifications table
+        # for each integration keyed by consumer_id/provider_id
+        def self.verification_max_created_at(connection)
+          connection[:verifications]
+            .select_group(:consumer_id, :provider_id)
+            .select_append{ max(:created_at).as(:created_at) }
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/db/migrate_data.rb

@@ -29,6 +29,7 @@ module PactBroker
         DataMigrations::CreateBranches.call(database_connection)
         DataMigrations::MigrateIntegrations.call(database_connection)
         DataMigrations::MigratePactVersionProviderTagSuccessfulVerifications.call(database_connection)
+        DataMigrations::SetContractDataUpdatedAtForIntegrations.call(database_connection)
       end
     end
   end

data/lib/pact_broker/db/models.rb

@@ -17,7 +17,7 @@ require "pact_broker/deployments/released_version"
 require "pact_broker/versions/branch"
 require "pact_broker/versions/branch_version"
 require "pact_broker/versions/branch_head"
-require "pact_broker/matrix/quick_row"
+require "pact_broker/matrix/matrix_row"
 require "pact_broker/matrix/every_row"
 
 module PactBroker

data/lib/pact_broker/deployments/currently_deployed_version_id.rb

@@ -1,5 +1,4 @@
-require "sequel"
-require "pact_broker/repositories/helpers"
+require "pact_broker/dataset"
 
 module PactBroker
   module Deployments
@@ -8,9 +7,7 @@ module PactBroker
 
       plugin :upsert, identifying_columns: [:pacticipant_id, :environment_id, :target_for_index]
 
-      dataset_module do
-        include PactBroker::Repositories::Helpers
-      end
+      dataset_module(PactBroker::Dataset)
     end
   end
 end

data/lib/pact_broker/deployments/deployed_version.rb

@@ -1,4 +1,4 @@
-require "pact_broker/repositories/helpers"
+require "pact_broker/dataset"
 require "pact_broker/deployments/currently_deployed_version_id"
 
 module PactBroker
@@ -15,7 +15,7 @@ module PactBroker
       plugin :insert_ignore, identifying_columns: [:pacticipant_id, :version_id, :environment_id, :target_for_index]
 
       dataset_module do
-        include PactBroker::Repositories::Helpers
+        include PactBroker::Dataset
 
         def user_created
           where(auto_created: false)
@@ -50,7 +50,7 @@ module PactBroker
         end
 
         def for_pacticipant_name(pacticipant_name)
-          where(pacticipant_id: db[:pacticipants].select(:id).where(name_like(:name, pacticipant_name)))
+          where(pacticipant_id: db[:pacticipants].select(:id).where(Sequel.name_like(:name, pacticipant_name)))
         end
 
         def for_version_and_environment(version, environment)

data/lib/pact_broker/deployments/environment.rb

@@ -1,7 +1,5 @@
-require "sequel"
 require "sequel/plugins/serialization"
 
-
 module PactBroker
   module Deployments
     class Environment < Sequel::Model

data/lib/pact_broker/deployments/released_version.rb

@@ -1,5 +1,4 @@
-require "sequel"
-require "pact_broker/repositories/helpers"
+require "pact_broker/dataset"
 
 module PactBroker
   module Deployments
@@ -14,7 +13,7 @@ module PactBroker
       plugin :insert_ignore, identifying_columns: [:version_id, :environment_id]
 
       dataset_module do
-        include PactBroker::Repositories::Helpers
+        include PactBroker::Dataset
 
         def currently_supported
           where(support_ended_at: nil)
@@ -25,11 +24,11 @@ module PactBroker
         end
 
         def for_pacticipant_name(pacticipant_name)
-          where(pacticipant_id: db[:pacticipants].select(:id).where(name_like(:name, pacticipant_name)))
+          where(pacticipant_id: db[:pacticipants].select(:id).where(Sequel.name_like(:name, pacticipant_name)))
         end
 
         def for_pacticipant_version_number(pacticipant_version_number)
-          where(version_id: db[:versions].select(:id).where(name_like(:number, pacticipant_version_number)))
+          where(version_id: db[:versions].select(:id).where(Sequel.name_like(:number, pacticipant_version_number)))
         end
 
         def for_version_and_environment(version, environment)

data/lib/pact_broker/doc/views/index/pacticipant-branch.markdown

@@ -0,0 +1,25 @@
+# Pacticipant branch
+
+Allowed methods: `GET`, `DELETE`
+
+Path: `/pacticipants/{pacticipant}/branches/{branch}`
+
+Get or delete a pacticipant branch.
+
+## Create
+
+Branches cannot be created via the resource URL. They are created automatically when publishing contracts.
+
+## Get
+
+### Example
+
+    curl http://broker/pacticipants/Bar/branches/main -H "Accept: application/hal+json"
+
+## Delete
+
+Deletes a pacticipant branch. Does NOT delete the associated pacticipant versions.
+
+Send a `DELETE` request to the branch resource.
+
+    curl -XDELETE http://broker/pacticipants/Bar/branches/main

data/lib/pact_broker/domain/label.rb

@@ -1,4 +1,4 @@
-require "pact_broker/db"
+require "pact_broker/dataset"
 
 module PactBroker
   module Domain
@@ -6,15 +6,18 @@ module PactBroker
       set_primary_key([:name, :pacticipant_id])
       unrestrict_primary_key
 
+      plugin :timestamps, update_on_create: true
+
       associate(:many_to_one, :pacticipant, :class => "PactBroker::Domain::Pacticipant", :key => :pacticipant_id, :primary_key => :id)
 
       def <=> other
         name <=> other.name
       end
 
+      dataset_module do
+        include PactBroker::Dataset
+      end
     end
-
-    Label.plugin :timestamps, update_on_create: true
   end
 end
 

data/lib/pact_broker/domain/pact.rb

@@ -1,4 +1,3 @@
-require "pact_broker/db"
 require "pact_broker/json"
 require "pact_broker/pacts/content"
 
@@ -23,10 +22,16 @@ module PactBroker
         :revision_number,
         :pact_version_sha,
         :head_tag_names
-      attr_writer :consumer, :latest_verification
+
+      attr_writer :consumer,
+                  :latest_verification,
+                  :consumer_version_tag_names,
+                  :consumer_version_branch_names
 
       def initialize attributes = {}
         @latest_verification = UnsetAttribute.new
+        @consumer_version_tag_names = UnsetAttribute.new
+        @consumer_version_branch_names = UnsetAttribute.new
         attributes.each_pair do | key, value |
           self.send(key.to_s + "=", value)
         end
@@ -45,11 +50,11 @@ module PactBroker
       end
 
       def consumer_version_tag_names
-        consumer_version.tags.collect(&:name)
+        get_attribute_if_set :consumer_version_tag_names
       end
 
-      def latest_consumer_version_tag_names= latest_consumer_version_tag_names
-        @latest_consumer_version_tag_names = latest_consumer_version_tag_names
+      def consumer_version_branch_names
+        get_attribute_if_set :consumer_version_branch_names
       end
 
       def latest_verification