pact_broker 2.19.1 → 2.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1619d6f62ce6aaa00ca73eca6b1cdf76ee0305
-  data.tar.gz: c8fc20b4a52499d6bc259a4937d463c1a902567e
+  metadata.gz: 6596910c63bcfb8363e958de4bb4bb698df0613e
+  data.tar.gz: 929b0ac8d06300c3a6226f4afb3af099f97c7476
 SHA512:
-  metadata.gz: 1a8ad6a1480b3a288c11e66f4473ba5af7890fe6ccab8f5ff81f69054dd0df7dc47d24ffc3e77b1888a202b5c9d73ef118794a9c8def6acce31e25590962f89c
-  data.tar.gz: c7270ddcf9932fc5579263dbb0149de7b1e3da15f8e69be217f4b2ddbc47182b409b0fcb0fc3b2d232922b854caae41eb47f2fc08d4ec9ae84d5773b3152751e
+  metadata.gz: aaf62c676cffcc46679e3cba55afd4234d74208577869803d76e670805b314d7e8a742525de8d3599aafa5f5769d50b62b76ee8464796766c42c92dc73807b36
+  data.tar.gz: 3cb076e57dcb8f23450ddd50e1b8f92f4161f79fd4541799296a5fdc0ed4671e13d1ba409eb0dfeff60c41cc86cc3472a304fb6e1068b6219a2359b3365799e7

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="v2.19.2"></a>
+### v2.19.2 (2018-05-29)
+
+
+#### Features
+
+* load latest verification for consumer/provider via relationship rather than repository	 ([13b7c6e](/../../commit/13b7c6e))
+* include more columns in latest_verifications_for_consumer_version_tags to avoid having to do extra queries for pact_versions and provider_versions	 ([e366af4](/../../commit/e366af4))
+* optimise queries for index page with tags	 ([524e08d](/../../commit/524e08d))
+* create view for latest verifications for consumer version tags	 ([eb67511](/../../commit/eb67511))
+* log pact content as debug instead of info when publishing	 ([d116157](/../../commit/d116157))
+* allow pact equality to be based only on the content that affects verification results	 ([bf8130f](/../../commit/bf8130f))
+
+
+#### Bug Fixes
+
+* temporarily redact webhook response body from UI for security purposes	 ([becf20c](/../../commit/becf20c))
+* handle race condition causing unique constraint violation when creating pacticipant versions	 ([6c75ebd](/../../commit/6c75ebd))
+
+
 <a name="v2.19.1"></a>
 ### v2.19.1 (2018-05-18)
 

data/README.md

@@ -4,7 +4,6 @@
  [![Code Climate](https://codeclimate.com/github/pact-foundation/pact_broker/badges/gpa.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)
  [![Test Coverage](https://codeclimate.com/github/pact-foundation/pact_broker/badges/coverage.svg)](https://codeclimate.com/github/pact-foundation/pact_broker/coverage)
  [![Issue Count](https://codeclimate.com/github/pact-foundation/pact_broker/badges/issue_count.svg)](https://codeclimate.com/github/pact-foundation/pact_broker)
- [![Dependency Status](https://gemnasium.com/badges/github.com/pact-foundation/pact_broker.svg)](https://gemnasium.com/github.com/pact-foundation/pact_broker)
 
 The Pact Broker is an application for sharing for consumer driven contracts and verification results. It is optimised for use with "pacts" (contracts created by the [Pact][pact-docs] framework), but can be used for any type of contract that can be serialized to JSON.
 

data/db/migrations/000002_create_versions_table.rb

@@ -6,7 +6,7 @@ Sequel.migration do
       String :number
       String :repository_ref
       foreign_key :pacticipant_id, :pacticipants, :null=>false
-      index [:pacticipant_id, :number], :unique=>true
+      index [:pacticipant_id, :number], :unique => true
     end
   end
 

data/db/migrations/20180311_optimise_head_matrix.rb

@@ -16,6 +16,7 @@ Sequel.migration do
     )
 
     # Add provider_version_order to original definition
+    # The most recent verification for each pact version
     v = :verifications
     create_or_replace_view(:latest_verifications,
       from(v)

data/db/migrations/20180523_create_latest_verifications_for_consumer_version_tags.rb

@@ -0,0 +1,50 @@
+Sequel.migration do
+  up do
+    # The latest verification id for each consumer version tag
+    create_view(:latest_verification_ids_for_consumer_version_tags,
+      "select
+        pv.pacticipant_id as provider_id,
+        lpp.consumer_id,
+        t.name as consumer_version_tag_name,
+        max(v.id) as latest_verification_id
+      from verifications v
+      join latest_pact_publications_by_consumer_versions lpp
+        on v.pact_version_id = lpp.pact_version_id
+      join tags t
+        on lpp.consumer_version_id = t.version_id
+      join versions pv
+        on v.provider_version_id = pv.id
+      group by pv.pacticipant_id, lpp.consumer_id, t.name")
+
+    # The most recent verification for each consumer/consumer version tag/provider
+    latest_verifications = from(:verifications)
+      .select(
+        Sequel[:lv][:consumer_id],
+        Sequel[:lv][:provider_id],
+        Sequel[:lv][:consumer_version_tag_name],
+        Sequel[:pv][:sha].as(:pact_version_sha),
+        Sequel[:prv][:number].as(:provider_version_number),
+        Sequel[:prv][:order].as(:provider_version_order),
+        )
+      .select_append{ verifications.* }
+      .join(:latest_verification_ids_for_consumer_version_tags,
+        {
+          Sequel[:verifications][:id] => Sequel[:lv][:latest_verification_id],
+        }, { table_alias: :lv })
+      .join(:versions,
+        {
+          Sequel[:verifications][:provider_version_id] => Sequel[:prv][:id]
+        }, { table_alias: :prv })
+      .join(:pact_versions,
+        {
+          Sequel[:verifications][:pact_version_id] => Sequel[:pv][:id]
+        }, { table_alias: :pv })
+
+    create_or_replace_view(:latest_verifications_for_consumer_version_tags, latest_verifications)
+  end
+
+  down do
+    drop_view(:latest_verifications_for_consumer_version_tags)
+    drop_view(:latest_verification_ids_for_consumer_version_tags)
+  end
+end

data/db/migrations/20180524_create_latest_verifications_for_consumer_and_provider.rb

@@ -0,0 +1,46 @@
+Sequel.migration do
+  up do
+    # The latest verification id for each consumer version tag
+    create_view(:latest_verification_ids_for_consumer_and_provider,
+      "select
+        pv.pacticipant_id as provider_id,
+        lpp.consumer_id,
+        max(v.id) as latest_verification_id
+      from verifications v
+      join latest_pact_publications_by_consumer_versions lpp
+        on v.pact_version_id = lpp.pact_version_id
+      join versions pv
+        on v.provider_version_id = pv.id
+      group by pv.pacticipant_id, lpp.consumer_id")
+
+    # The most recent verification for each consumer/consumer version tag/provider
+    latest_verifications = from(:verifications)
+      .select(
+        Sequel[:lv][:consumer_id],
+        Sequel[:lv][:provider_id],
+        Sequel[:pv][:sha].as(:pact_version_sha),
+        Sequel[:prv][:number].as(:provider_version_number),
+        Sequel[:prv][:order].as(:provider_version_order),
+        )
+      .select_append{ verifications.* }
+      .join(:latest_verification_ids_for_consumer_and_provider,
+        {
+          Sequel[:verifications][:id] => Sequel[:lv][:latest_verification_id],
+        }, { table_alias: :lv })
+      .join(:versions,
+        {
+          Sequel[:verifications][:provider_version_id] => Sequel[:prv][:id]
+        }, { table_alias: :prv })
+      .join(:pact_versions,
+        {
+          Sequel[:verifications][:pact_version_id] => Sequel[:pv][:id]
+        }, { table_alias: :pv })
+
+    create_or_replace_view(:latest_verifications_for_consumer_and_provider, latest_verifications)
+  end
+
+  down do
+    drop_view(:latest_verifications_for_consumer_and_provider)
+    drop_view(:latest_verification_ids_for_consumer_and_provider)
+  end
+end

data/lib/pact_broker/api/decorators/webhook_execution_result_decorator.rb

@@ -34,11 +34,15 @@ module PactBroker
               represented.body
             end
           end
-
         end
 
-        property :error, :extend => ErrorDecorator
-        property :response, :extend => HTTPResponseDecorator
+        property :message, exec_context: :decorator
+        # property :error, :extend => ErrorDecorator
+        # property :response, :extend => HTTPResponseDecorator
+
+        def message
+          "Webhook response has been redacted temporarily for security purposes. Please see the Pact Broker application logs for the response body."
+        end
 
         link :webhook do | options |
           {

data/lib/pact_broker/configuration.rb

@@ -27,13 +27,14 @@ module PactBroker
     ]
 
     attr_accessor :log_dir, :database_connection, :auto_migrate_db, :use_hal_browser, :html_pact_renderer
-    attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser
+    attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser, :sha_generator
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_accessor :check_for_potential_duplicate_pacticipant_names
     attr_accessor :semver_formats
     attr_accessor :enable_public_badge_access, :shields_io_base_url
     attr_accessor :webhook_retry_schedule
     attr_accessor :disable_ssl_verification
+    attr_accessor :base_equality_only_on_content_that_affects_verification_results
     attr_reader :api_error_reporters
     attr_writer :logger
 
@@ -51,6 +52,8 @@ module PactBroker
 
     def self.default_configuration
       require 'pact_broker/versions/parse_semantic_version'
+      require 'pact_broker/pacts/generate_sha'
+
       config = Configuration.new
       config.log_dir = File.expand_path("./log")
       config.auto_migrate_db = true
@@ -62,6 +65,8 @@ module PactBroker
       config.use_case_sensitive_resource_names = true
       config.html_pact_renderer = default_html_pact_render
       config.version_parser = PactBroker::Versions::ParseSemanticVersion
+      config.sha_generator = PactBroker::Pacts::GenerateSha
+      config.base_equality_only_on_content_that_affects_verification_results = false
       # Not recommended to set this to true unless there is no way to
       # consistently extract an orderable object from the consumer application version number.
       config.order_versions_by_date = false

data/lib/pact_broker/domain/webhook_request.rb

@@ -114,18 +114,19 @@ module PactBroker
         execution_logger.info(" ")
         logger.info "Received response for webhook #{uuid} status=#{response.code}"
         execution_logger.info "HTTP/#{response.http_version} #{response.code} #{response.message}"
-        response.each_header do | header |
-          execution_logger.info "#{header.split("-").collect(&:capitalize).join('-')}: #{response[header]}"
-        end
+        #response.each_header do | header |
+        #  execution_logger.info "#{header.split("-").collect(&:capitalize).join('-')}: #{response[header]}"
+        #end
         logger.debug "body=#{response.body}"
-        safe_body = nil
-        if response.body
-          safe_body = response.body.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-          if response.body != safe_body
-            execution_logger.debug "Note that invalid UTF-8 byte sequences were removed from response body before saving the logs"
-          end
-        end
-        execution_logger.info safe_body
+        # safe_body = nil
+        # if response.body
+        #   safe_body = response.body.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
+        #   if response.body != safe_body
+        #     execution_logger.debug "Note that invalid UTF-8 byte sequences were removed from response body before saving the logs"
+        #   end
+        # end
+        #execution_logger.info safe_body
+        execution_logger.info "Webhook response has been redacted temporarily for security purposes. Please see the Pact Broker application logs for the response body."
       end
 
       def log_completion_message options, execution_logger, success

data/lib/pact_broker/index/service.rb

@@ -1,8 +1,8 @@
 require 'pact_broker/repositories'
 require 'pact_broker/logging'
 require 'pact_broker/domain/index_item'
-require 'pact_broker/matrix/latest_row'
 require 'pact_broker/matrix/head_row'
+require 'pact_broker/matrix/aggregated_row'
 
 module PactBroker
 
@@ -14,107 +14,37 @@ module PactBroker
       extend PactBroker::Logging
 
       def self.find_index_items options = {}
-        rows = []
-        overall_latest_publication_ids = nil
-
         rows = PactBroker::Matrix::HeadRow
           .select_all_qualified
           .eager(:latest_triggered_webhooks)
           .eager(:webhooks)
-          .order(:consumer_name, :provider_name)
-          .eager(:consumer_version_tags)
-          .eager(:provider_version_tags)
 
         if !options[:tags]
-          rows = rows.where(consumer_version_tag_name: nil).all
-          overall_latest_publication_ids = rows.collect(&:pact_publication_id)
-        end
-
-        if options[:tags]
+          rows = rows.where(consumer_version_tag_name: nil)
+        else
           if options[:tags].is_a?(Array)
             rows = rows.where(consumer_version_tag_name: options[:tags]).or(consumer_version_tag_name: nil)
           end
-
-          rows = rows.all
-          overall_latest_publication_ids = rows.select{|r| !r[:consumer_version_tag_name] }.collect(&:pact_publication_id).uniq
-
-          # Smoosh all the rows with matching pact publications together
-          # and collect their consumer_head_tag_names
-          rows = rows
-            .group_by(&:pact_publication_id)
-            .values
-            .collect{|group| [group.last, group.collect{|r| r[:consumer_version_tag_name]}.compact] }
-            .collect{ |(row, tag_names)| row.consumer_head_tag_names = tag_names; row }
+          rows = rows.eager(:consumer_version_tags)
+                .eager(:provider_version_tags)
+                .eager(:latest_verification_for_consumer_version_tag)
         end
+        rows = rows.all.group_by(&:pact_publication_id).values.collect{ | rows| Matrix::AggregatedRow.new(rows) }
 
-        index_items = []
-        rows.sort.each do | row |
-          tag_names = []
-          if options[:tags]
-            tag_names = row.consumer_version_tags.collect(&:name)
-          end
-
-          overall_latest = overall_latest_publication_ids.include?(row.pact_publication_id)
-          latest_verification = if overall_latest
-            verification_repository.find_latest_verification_for row.consumer_name, row.provider_name
-          else
-            tag_names.collect do | tag_name |
-              verification_repository.find_latest_verification_for row.consumer_name, row.provider_name, tag_name
-            end.compact.sort do | v1, v2 |
-              # Some provider versions have nil orders, not sure why
-              # Sort by execution_date instead of order
-              v1.execution_date <=> v2.execution_date
-            end.last
-          end
-
-          index_items << PactBroker::Domain::IndexItem.create(
+        rows.sort.collect do | row |
+          # TODO simplify. Do we really need 3 layers of abstraction?
+          PactBroker::Domain::IndexItem.create(
             row.consumer,
             row.provider,
             row.pact,
-            overall_latest,
-            latest_verification,
+            row.overall_latest?,
+            row.latest_verification,
             row.webhooks,
             row.latest_triggered_webhooks,
-            row.consumer_head_tag_names,
-            row.provider_version_tags.select(&:latest?)
+            options[:tags] ? row.consumer_head_tag_names : [],
+            options[:tags] ? row.provider_version_tags.select(&:latest?) : []
           )
         end
-
-        index_items
-      end
-
-      def self.tags_for(pact, options)
-        if options[:tags] == true
-          tag_service.find_all_tag_names_for_pacticipant(pact.consumer_name)
-        elsif options[:tags].is_a?(Array)
-          options[:tags]
-        else
-          []
-        end
-      end
-
-      def self.build_index_item_rows(pact, tags)
-        index_items = [build_latest_pact_index_item(pact, tags)]
-        tags.each do | tag |
-          index_items << build_index_item_for_tagged_pact(pact, tag)
-        end
-        index_items.compact
-      end
-
-      def self.build_latest_pact_index_item pact, tags
-        latest_verification = verification_service.find_latest_verification_for(pact.consumer, pact.provider)
-        webhooks = webhook_service.find_by_consumer_and_provider pact.consumer, pact.provider
-        triggered_webhooks = webhook_service.find_latest_triggered_webhooks pact.consumer, pact.provider
-        tag_names = pact.consumer_version_tag_names.select{ |name| tags.include?(name) }
-        PactBroker::Domain::IndexItem.create pact.consumer, pact.provider, pact, true, latest_verification, webhooks, triggered_webhooks, tag_names
-      end
-
-      def self.build_index_item_for_tagged_pact latest_pact, tag
-        pact = pact_service.find_latest_pact consumer_name: latest_pact.consumer_name, provider_name: latest_pact.provider_name, tag: tag
-        return nil unless pact
-        return nil if pact.id == latest_pact.id
-        verification = verification_repository.find_latest_verification_for pact.consumer_name, pact.provider_name, tag
-        PactBroker::Domain::IndexItem.create pact.consumer, pact.provider, pact, false, verification, [], [], [tag]
       end
     end
   end

data/lib/pact_broker/matrix/aggregated_row.rb

@@ -0,0 +1,71 @@
+require 'pact_broker/verifications/repository'
+
+# A collection of matrix rows with the same pact publication id
+# It's basically a normalised view of a denormalised view :(
+# A pact publication may be the overall latest, and/or the latest for a tag
+module PactBroker
+  module Matrix
+    class AggregatedRow
+      extend Forwardable
+
+      delegate [:consumer, :consumer_name, :consumer_version, :consumer_version_number, :consumer_version_order, :consumer_version_tags] => :first_row
+      delegate [:provider, :provider_name, :provider_version, :provider_version_number, :provider_version_order, :provider_version_tags] => :first_row
+      delegate [:pact, :pact_version, :pact_revision_number, :webhooks, :latest_triggered_webhooks, :'<=>'] => :first_row
+      delegate [:verification_id, :verification] => :first_row
+
+      def initialize matrix_rows
+        @matrix_rows = matrix_rows
+        @first_row = matrix_rows.first
+      end
+
+      def overall_latest?
+        !!matrix_rows.find{ | row| row.consumer_version_tag_name.nil? }
+      end
+
+      # If this comes back nil, it won't be "cached", but it's a reasonably
+      # quick query, so it's probably ok.
+      def latest_verification
+        @latest_verification ||= begin
+          verification = matrix_rows.collect do | row|
+              row.verification || latest_verification_for_consumer_version_tag(row)
+            end.compact.sort{ |v1, v2| v1.id <=> v2.id }.last
+
+          if !verification && overall_latest?
+            overall_latest_verification
+          else
+            verification
+          end
+        end
+      end
+
+      # The list of tag names for which this pact publication is the most recent with that tag
+      # There could, however, be a later consumer version that does't have a pact (perhaps because it was deleted)
+      # that has the same tag.
+      # TODO show a warning when the data is "corrupted" as above.
+      def consumer_head_tag_names
+        matrix_rows.collect(&:consumer_version_tag_name).compact
+      end
+
+      private
+
+      attr_reader :matrix_rows
+
+      def latest_verification_for_consumer_version_tag row
+        row.latest_verification_for_consumer_version_tag if row.consumer_version_tag_name
+      end
+
+      def overall_latest_verification
+        # not eager loaded because it shouldn't be called that often
+        first_row.latest_verification_for_consumer_and_provider
+      end
+
+      def first_row
+        @first_row
+      end
+
+      def consumer_version_tag_names
+        matrix_rows.collect(&:consumer_version_tag_name)
+      end
+    end
+  end
+end