pact_broker 2.19.1 → 2.19.2

data/lib/pact_broker/matrix/head_row.rb

@@ -7,6 +7,29 @@ module PactBroker
     class HeadRow < Row
       set_dataset(:materialized_head_matrix)
 
+      # one_to_one :latest_verification_for_consumer_version_tag,
+      #   :class => "PactBroker::Verifications::LatestVerificationForConsumerVersionTag",
+      #   primary_key: [:provider_id, :consumer_id, :consumer_version_tag_name], key: [:provider_id, :consumer_id, :consumer_version_tag_name]
+
+      # Loading the latest_verification_for_consumer_version_tag objects this way is quicker than
+      # doing it using an inbult relation with primary_key/key, if we are loading the relation for
+      # the entire HeadRow table
+      # Using the inbuilt relation puts constraints on the columns that are not necessary and slow
+      # the query down.
+      # This relation relies on consumer_version_tags already being loaded
+      one_to_one :latest_verification_for_consumer_version_tag, :class => "PactBroker::Verifications::LatestVerificationForConsumerVersionTag", primary_keys: [], key: [], :eager_loader=>(proc do |eo_opts|
+        tag_to_row = eo_opts[:rows].each_with_object({}) { | row, map | map[[row.provider_id, row.consumer_id, row.consumer_version_tag_name]] = row }
+        eo_opts[:rows].each{|row| row.associations[:latest_verification_for_consumer_version_tag] = nil}
+
+        # Need the all then the each to ensure the eager loading works
+        PactBroker::Verifications::LatestVerificationForConsumerVersionTag.each do | verification |
+          key = [verification.provider_id, verification.consumer_id, verification.consumer_version_tag_name]
+          if tag_to_row[key]
+            tag_to_row[key].associations[:latest_verification_for_consumer_version_tag] = verification
+          end
+        end
+      end)
+
       dataset_module do
         include PactBroker::Repositories::Helpers
         include PactBroker::Logging

data/lib/pact_broker/matrix/repository.rb

@@ -1,6 +1,5 @@
 require 'pact_broker/repositories/helpers'
 require 'pact_broker/matrix/row'
-require 'pact_broker/matrix/latest_row'
 require 'pact_broker/matrix/head_row'
 require 'pact_broker/error'
 

data/lib/pact_broker/matrix/row.rb

@@ -2,9 +2,12 @@ require 'pact_broker/repositories/helpers'
 require 'pact_broker/webhooks/latest_triggered_webhook'
 require 'pact_broker/tags/tag_with_latest_flag'
 require 'pact_broker/logging'
+require 'pact_broker/verifications/latest_verification_for_consumer_version_tag'
+require 'pact_broker/verifications/latest_verification_for_consumer_and_provider'
 
 module PactBroker
   module Matrix
+
     class Row < Sequel::Model(:materialized_matrix)
 
       # Used when using table_print to output query results
@@ -15,6 +18,10 @@ module PactBroker
       associate(:one_to_many, :consumer_version_tags, :class => "PactBroker::Tags::TagWithLatestFlag", primary_key: :consumer_version_id, key: :version_id)
       associate(:one_to_many, :provider_version_tags, :class => "PactBroker::Tags::TagWithLatestFlag", primary_key: :provider_version_id, key: :version_id)
 
+      many_to_one :latest_verification_for_consumer_and_provider,
+        :class => "PactBroker::Verifications::LatestVerificationForConsumerAndProvider",
+        primary_key: [:provider_id, :consumer_id], key: [:provider_id, :consumer_id]
+
       dataset_module do
         include PactBroker::Repositories::Helpers
         include PactBroker::Logging
@@ -111,20 +118,6 @@ module PactBroker
         end
       end
 
-      # tags for which this pact publication is the latest of that tag
-      # this is set in the code rather than the database
-      def consumer_head_tag_names
-        @consumer_head_tag_names ||= []
-      end
-
-      def consumer_head_tag_names= consumer_head_tag_names
-        @consumer_head_tag_names = consumer_head_tag_names
-      end
-
-      # def latest_triggered_webhooks
-      #   @latest_triggered_webhooks ||= []
-      # end
-
       def summary
         "#{consumer_name}#{consumer_version_number} #{provider_name}#{provider_version_number || '?'} (r#{pact_revision_number}n#{verification_number || '?'})"
       end
@@ -138,17 +131,18 @@ module PactBroker
       end
 
       def consumer_version
-        @consumer_version ||= OpenStruct.new(number: consumer_version_number, id: consumer_version_id, pacticipant: consumer)
+        @consumer_version ||= OpenStruct.new(number: consumer_version_number, order: consumer_version_order, id: consumer_version_id, pacticipant: consumer)
       end
 
       def provider_version
         if provider_version_number
-          @provider_version ||= OpenStruct.new(number: provider_version_number, id: provider_version_id, pacticipant: provider)
+          @provider_version ||= OpenStruct.new(number: provider_version_number, order: provider_version_order, id: provider_version_id, pacticipant: provider)
         end
       end
 
       def pact
-        @pact ||= OpenStruct.new(consumer: consumer,
+        @pact ||= OpenStruct.new(
+          consumer: consumer,
           provider: provider,
           consumer_version: consumer_version,
           consumer_version_number: consumer_version_number,
@@ -158,7 +152,7 @@ module PactBroker
         )
       end
 
-      def latest_verification
+      def verification
         if verification_executed_at
           @latest_verification ||= OpenStruct.new(
             id: verification_id,
@@ -167,10 +161,12 @@ module PactBroker
             execution_date: verification_executed_at,
             created_at: verification_executed_at,
             provider_version_number: provider_version_number,
+            provider_version_order: provider_version_order,
             build_url: verification_build_url,
             provider_version: provider_version,
             consumer_name: consumer_name,
-            provider_name: provider_name
+            provider_name: provider_name,
+            pact_version_sha: pact_version_sha
           )
         end
       end
@@ -187,7 +183,6 @@ module PactBroker
         ]
 
         comparisons.find{|c| c != 0 } || 0
-
       end
 
       def compare_name_asc name1, name2

data/lib/pact_broker/pacts/content.rb

@@ -0,0 +1,66 @@
+require 'pact_broker/pacts/parse'
+require 'pact_broker/pacts/sort_content'
+
+module PactBroker
+  module Pacts
+    class Content
+
+      def initialize pact_hash
+        @pact_hash = pact_hash
+      end
+
+      def self.from_json json_content
+        new(Parse.call(json_content))
+      end
+
+      def self.from_hash pact_hash
+        new(pact_hash)
+      end
+
+      def to_hash
+        pact_hash
+      end
+
+      def to_json
+        pact_hash.to_json
+      end
+
+      def sort
+        Content.from_hash(SortContent.call(pact_hash))
+      end
+
+      # Half thinking this belongs in GenerateSha
+      def content_that_affects_verification_results
+        if interactions || messages
+          cont = {}
+          cont['interactions'] = interactions if interactions
+          cont['messages'] = messages if messages
+          cont['pact_specification_version'] = pact_specification_version if pact_specification_version
+          cont
+        else
+          pact_hash
+        end
+      end
+
+      def messages
+        pact_hash.is_a?(Hash) ? pact_hash['messages'] : nil
+      end
+
+      def interactions
+        pact_hash.is_a?(Hash) ? pact_hash['interactions'] : nil
+      end
+
+      def pact_specification_version
+        maybe_pact_specification_version_1 = pact_hash['metadata']['pactSpecification']['version'] rescue nil
+        maybe_pact_specification_version_2 = pact_hash['metadata']['pact-specification']['version'] rescue nil
+        maybe_pact_specification_version_3 = pact_hash['metadata'] && pact_hash['metadata']['pactSpecificationVersion'] rescue nil
+        maybe_pact_specification_version_1 || maybe_pact_specification_version_2 || maybe_pact_specification_version_3
+      end
+
+      private
+
+      attr_reader :pact_hash
+
+    end
+  end
+end

data/lib/pact_broker/pacts/create_formatted_diff.rb

@@ -14,7 +14,6 @@ module PactBroker
         difference = diff(previous_pact_hash, pact_hash)
         Pact::Matchers::UnixDiffFormatter.call(difference, colour: false, include_explanation: false)
       end
-
     end
   end
 end

data/lib/pact_broker/pacts/diff.rb

@@ -1,7 +1,8 @@
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/date_helper'
 require 'pact_broker/pacts/create_formatted_diff'
-require 'pact_broker/pacts/sort_verifiable_content'
+require 'pact_broker/pacts/sort_content'
+require 'pact_broker/pacts/parse'
 require 'pact_broker/repositories'
 require 'yaml'
 
@@ -110,7 +111,7 @@ module PactBroker
           if options[:raw]
             json_content
           else
-            PactBroker::Pacts::SortVerifiableContent.call(json_content)
+            SortContent.call(Parse.call(json_content)).to_json
           end
         end
       end

data/lib/pact_broker/pacts/generate_sha.rb

@@ -0,0 +1,24 @@
+require 'digest/sha1'
+require 'pact_broker/configuration'
+require 'pact_broker/pacts/sort_content'
+require 'pact_broker/pacts/parse'
+require 'pact_broker/pacts/content'
+
+module PactBroker
+  module Pacts
+    class GenerateSha
+      def self.call json_content, options = {}
+        content_for_sha = if PactBroker.configuration.base_equality_only_on_content_that_affects_verification_results
+          extract_verifiable_content_for_sha(json_content)
+        else
+          json_content
+        end
+        Digest::SHA1.hexdigest(content_for_sha)
+      end
+
+      def self.extract_verifiable_content_for_sha json_content
+        Content.from_json(json_content).sort.content_that_affects_verification_results.to_json
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/parse.rb

@@ -0,0 +1,11 @@
+require 'pact_broker/json'
+
+module PactBroker
+  module Pacts
+    class Parse
+      def self.call(json)
+        JSON.parse(json, PACT_PARSING_OPTIONS)
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/repository.rb

@@ -1,7 +1,7 @@
-require 'digest/sha1'
 require 'sequel'
 require 'ostruct'
 require 'pact_broker/logging'
+require 'pact_broker/pacts/generate_sha'
 require 'pact_broker/pacts/pact_publication'
 require 'pact_broker/pacts/all_pact_publications'
 require 'pact_broker/pacts/latest_pact_publications_by_consumer_version'
@@ -9,6 +9,7 @@ require 'pact_broker/pacts/latest_pact_publications'
 require 'pact_broker/pacts/latest_tagged_pact_publications'
 require 'pact/shared/json_differ'
 require 'pact_broker/domain'
+require 'pact_broker/pacts/parse'
 
 module PactBroker
   module Pacts
@@ -197,16 +198,15 @@ module PactBroker
       end
 
       def find_or_create_pact_version consumer_id, provider_id, json_content
-        sha = Digest::SHA1.hexdigest(json_content)
+        sha = PactBroker.configuration.sha_generator.call(json_content)
         PactVersion.find(sha: sha, consumer_id: consumer_id, provider_id: provider_id) || create_pact_version(consumer_id, provider_id, sha, json_content)
       end
 
       def create_pact_version consumer_id, provider_id, sha, json_content
-        PactBroker.logger.debug("Creating new PactVersion for sha #{sha}")
+        logger.debug("Creating new pact version for sha #{sha}")
         pact_version = PactVersion.new(consumer_id: consumer_id, provider_id: provider_id, sha: sha, content: json_content)
         pact_version.save
       end
-
     end
   end
 end

data/lib/pact_broker/pacts/service.rb

@@ -102,7 +102,8 @@ module PactBroker
       private
 
       def update_pact params, existing_pact
-        logger.info "Updating existing pact version with params #{params}"
+        logger.info "Updating existing pact publication with params #{params.reject{ |k, v| k == :json_content}}"
+        logger.debug "Content #{params[:json_content]}"
         updated_pact = pact_repository.update existing_pact.id, params
 
         if existing_pact.json_content != updated_pact.json_content
@@ -113,7 +114,8 @@ module PactBroker
       end
 
       def create_pact params, version, provider
-        logger.info "Creating new pact version with params #{params}"
+        logger.info "Creating new pact publication with params #{params.reject{ |k, v| k == :json_content}}"
+        logger.debug "Content #{params[:json_content]}"
         pact = pact_repository.create json_content: params[:json_content], version_id: version.id, provider_id: provider.id, consumer_id: version.pacticipant_id
         trigger_webhooks pact
         pact

data/lib/pact_broker/pacts/sort_content.rb

@@ -0,0 +1,54 @@
+require 'pact_broker/json'
+
+module PactBroker
+  module Pacts
+    class SortContent
+      def self.call pact_hash
+        key = verifiable_content_key_for(pact_hash)
+
+        if key
+          content = pact_hash[key]
+          sorted_pact_hash = order_object(pact_hash)
+          sorted_pact_hash[key] = order_verifiable_content(content)
+          sorted_pact_hash
+        else
+          pact_hash
+        end
+      end
+
+      def self.verifiable_content_key_for pact_hash
+        if pact_hash['interactions']
+          'interactions'
+        elsif pact_hash['messages']
+          'messages'
+        else
+          nil
+        end
+      end
+
+
+      def self.order_verifiable_content array
+        array_with_ordered_hashes = order_object(array)
+        array_with_ordered_hashes.sort{|a, b| a.to_json <=> b.to_json }
+      end
+
+      def self.order_object thing
+        case thing
+          when Hash then order_hash(thing)
+          when Array then order_child_array(thing)
+        else thing
+        end
+      end
+
+      def self.order_child_array array
+        array.collect{|thing| order_object(thing) }
+      end
+
+      def self.order_hash hash
+        hash.keys.sort.each_with_object({}) do | key, new_hash |
+          new_hash[key] = order_object(hash[key])
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/verifications/latest_verification_for_consumer_and_provider.rb

@@ -0,0 +1,26 @@
+require 'pact_broker/domain/verification'
+
+module PactBroker
+  module Verifications
+
+    include PactBroker::Repositories::Helpers
+
+    class LatestVerificationForConsumerAndProvider < PactBroker::Domain::Verification
+      set_dataset(:latest_verifications_for_consumer_and_provider)
+
+      # Don't need to load the pact_version as we do in the superclass,
+      # as pact_version_sha is included in the view for convenience
+      def pact_version_sha
+        values[:pact_version_sha]
+      end
+
+      def provider_version_number
+        values[:provider_version_number]
+      end
+
+      def provider_version_order
+        values[:provider_version_order]
+      end
+    end
+  end
+end

data/lib/pact_broker/verifications/latest_verification_for_consumer_version_tag.rb

@@ -0,0 +1,23 @@
+require 'pact_broker/domain/verification'
+
+module PactBroker
+  module Verifications
+    class LatestVerificationForConsumerVersionTag < PactBroker::Domain::Verification
+      set_dataset(:latest_verifications_for_consumer_version_tags)
+
+      # Don't need to load the pact_version as we do in the superclass,
+      # as pact_version_sha is included in the view for convenience
+      def pact_version_sha
+        values[:pact_version_sha]
+      end
+
+      def provider_version_number
+        values[:provider_version_number]
+      end
+
+      def provider_version_order
+        values[:provider_version_order]
+      end
+    end
+  end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.19.1'
+  VERSION = '2.19.2'
 end

data/lib/pact_broker/versions/repository.rb

@@ -51,10 +51,19 @@ module PactBroker
           .single_record
       end
 
+      # There may be a race condition if two simultaneous requests come in to create the same version
       def create args
-        PactBroker.logger.info "Creating version #{args[:number]} for pacticipant_id=#{args[:pacticipant_id]}"
-        version = PactBroker::Domain::Version.new(number: args[:number], pacticipant_id: args[:pacticipant_id]).save
-        PactBroker::Domain::Version.find(id: version.id) # Need to reload with populated order
+        PactBroker.logger.info "Upserting version #{args[:number]} for pacticipant_id=#{args[:pacticipant_id]}"
+        version_params = {
+          number: args[:number],
+          pacticipant_id: args[:pacticipant_id],
+          created_at: Sequel.datetime_class.now,
+          updated_at: Sequel.datetime_class.now
+        }
+        id = PactBroker::Domain::Version.db[:versions].insert_ignore.insert(version_params)
+        version = PactBroker::Domain::Version.find(number: args[:number], pacticipant_id: args[:pacticipant_id])
+        PactBroker::Domain::OrderVersions.(version)
+        version.refresh # reload with the populated order
       end
 
       def find_by_pacticipant_id_and_number_or_create pacticipant_id, number