pact_broker 2.40.0 → 2.41.0

data/lib/pact_broker/domain/pact.rb

@@ -6,12 +6,21 @@ This class most accurately represents a PactPublication
 =end
 
 module PactBroker
-
   module Domain
     class Pact
-
       # The ID is the pact_publication ID
-      attr_accessor :id, :provider, :consumer_version, :consumer, :created_at, :json_content, :consumer_version_number, :revision_number, :pact_version_sha, :latest_verification, :head_tag_names
+      attr_accessor :id,
+        :provider,
+        :consumer_version,
+        :consumer,
+        :created_at,
+        :json_content,
+        :consumer_version_number,
+        :revision_number,
+        :pact_version_sha,
+        :latest_verification,
+        :head_tag_names
+
       def initialize attributes
         attributes.each_pair do | key, value |
           self.send(key.to_s + "=", value)
@@ -80,6 +89,5 @@ module PactBroker
         db_model.pact_version
       end
     end
-
   end
 end

data/lib/pact_broker/domain/version.rb

@@ -1,6 +1,7 @@
 require 'pact_broker/db'
 require 'pact_broker/domain/order_versions'
 require 'pact_broker/repositories/helpers'
+require 'pact_broker/tags/tag_with_latest_flag'
 
 module PactBroker
   module Domain
@@ -9,6 +10,7 @@ module PactBroker
       one_to_many :pact_publications, order: :revision_number, class: "PactBroker::Pacts::PactPublication", key: :consumer_version_id
       associate(:many_to_one, :pacticipant, :class => "PactBroker::Domain::Pacticipant", :key => :pacticipant_id, :primary_key => :id)
       one_to_many :tags, :reciprocal => :version, order: :created_at
+      one_to_many :tags_with_latest_flag, class: "PactBroker::Tags::TagWithLatestFlag", key: :version_id, primary_key: :id
 
       dataset_module do
         include PactBroker::Repositories::Helpers

data/lib/pact_broker/hash_refinements.rb

@@ -1,6 +1,11 @@
+require 'pact_broker/string_refinements'
+
 module PactBroker
   module HashRefinements
+
     refine Hash do
+      using PactBroker::StringRefinements
+
       def deep_merge(other_hash, &block)
         block_actual = Proc.new {|key, oldval, newval|
             newval = block.call(key, oldval, newval) if block_given?
@@ -8,6 +13,49 @@ module PactBroker
         }
         merge(other_hash, &block_actual)
       end
+
+      def symbolize_keys
+        symbolize_keys_private(self)
+      end
+
+      def snakecase_keys
+        snakecase_keys_private(self)
+      end
+
+      private
+
+      def snakecase_keys_private(params)
+        case params
+        when Hash
+          params.inject({}) do |result, (key, value)|
+            snake_key = case key
+            when String then key.snakecase
+            when Symbol then key.to_s.snakecase.to_sym
+            else
+              key
+            end
+            result.merge(snake_key => snakecase_keys_private(value))
+          end
+        when Array
+          params.collect { |value| snakecase_keys_private(value) }
+        else
+          params
+        end
+
+      end
+
+      def symbolize_keys_private(params)
+        case params
+        when Hash
+          params.inject({}) do |result, (key, value)|
+            result.merge(key.to_sym => symbolize_keys_private(value))
+          end
+        when Array
+          params.collect { |value| symbolize_keys_private(value) }
+        else
+          params
+        end
+      end
     end
   end
 end

data/lib/pact_broker/index/page.rb

@@ -0,0 +1,12 @@
+module PactBroker
+  module Index
+    class Page < Array
+      attr_reader :pagination_record_count
+
+      def initialize(array, pagination_record_count)
+        super(array)
+        @pagination_record_count = pagination_record_count
+      end
+    end
+  end
+end

data/lib/pact_broker/index/service.rb

@@ -3,21 +3,40 @@ require 'pact_broker/logging'
 require 'pact_broker/domain/index_item'
 require 'pact_broker/matrix/head_row'
 require 'pact_broker/matrix/aggregated_row'
+require 'pact_broker/repositories/helpers'
+require 'pact_broker/index/page'
 
 module PactBroker
-
   module Index
     class Service
-
       extend PactBroker::Repositories
       extend PactBroker::Services
       extend PactBroker::Logging
 
+      COLS = [:id, :consumer_name, :provider_name, :consumer_version_order]
+      LATEST_PPS = Sequel::Model.db[:latest_pact_publications].select(*COLS)
+      LATEST_TAGGED_PPS = Sequel::Model.db[:latest_tagged_pact_publications].select(*COLS)
+      HEAD_PP_ORDER_COLUMNS = [
+          Sequel.asc(Sequel.function(:lower, :consumer_name)),
+          Sequel.desc(:consumer_version_order),
+          Sequel.asc(Sequel.function(:lower, :provider_name))
+        ].freeze
+      DEFAULT_PAGE_SIZE = 30
+      DEFAULT_PAGE_NUMBER = 1
+
       # This method provides data for both the OSS server side rendered index (with and without tags)
       # and the Pactflow UI. It really needs to be broken into to separate methods, as it's getting too messy
       # supporting both
 
       def self.find_index_items options = {}
+        if options[:optimised]
+          find_index_items_optimised(options)
+        else
+          find_index_items_original(options)
+        end
+      end
+
+      def self.find_index_items_original options = {}
         rows = PactBroker::Matrix::HeadRow
           .select_all_qualified
           .eager(:latest_triggered_webhooks)
@@ -38,10 +57,7 @@ module PactBroker
         end
         rows = rows.all.group_by(&:pact_publication_id).values.collect{ | rows| Matrix::AggregatedRow.new(rows) }
 
-
-
         rows.sort.collect do | row |
-          # TODO simplify. Do we really need 3 layers of abstraction?
           PactBroker::Domain::IndexItem.create(
             row.consumer,
             row.provider,
@@ -56,31 +72,150 @@ module PactBroker
         end
       end
 
+      def self.find_index_items_optimised options = {}
+        latest_verifications_for_cv_tags = latest_verifications_for_consumer_version_tags(options)
+        latest_pact_publication_ids = latest_pact_publications.select(:id).all.collect{ |h| h[:id] }
+
+        # We only need to know if a webhook exists for an integration, not what its properties are
+        webhooks = PactBroker::Webhooks::Webhook.select(:consumer_id, :provider_id).distinct.all
+
+        pact_publication_ids = head_pact_publication_ids(options)
+        pagination_record_count = pact_publication_ids.pagination_record_count
+
+        pact_publications = PactBroker::Pacts::PactPublication
+          .where(id: pact_publication_ids)
+          .select_all_qualified
+          .eager(:consumer)
+          .eager(:provider)
+          .eager(:pact_version)
+          .eager(integration: [{latest_verification: :provider_version}, :latest_triggered_webhooks])
+          .eager(:consumer_version)
+          .eager(latest_verification: { provider_version: :tags_with_latest_flag })
+          .eager(:head_pact_tags)
+
+        index_items = pact_publications.all.collect do | pact_publication |
+          is_overall_latest_for_integration = latest_pact_publication_ids.include?(pact_publication.id)
+          latest_verification = latest_verification_for_pseudo_branch(pact_publication, is_overall_latest_for_integration, latest_verifications_for_cv_tags, options[:tags])
+          webhook = webhooks.find{ |webhook| webhook.is_for?(pact_publication.integration) }
+
+          PactBroker::Domain::IndexItem.create(
+            pact_publication.consumer,
+            pact_publication.provider,
+            pact_publication.to_domain_lightweight,
+            is_overall_latest_for_integration,
+            latest_verification,
+            webhook ? [webhook]: [],
+            pact_publication.integration.latest_triggered_webhooks,
+            consumer_version_tags(pact_publication, options[:tags]),
+            options[:tags] && latest_verification ? latest_verification.provider_version.tags_with_latest_flag.select(&:latest?) : []
+          )
+        end.sort
+
+        Page.new(index_items, pagination_record_count)
+      end
+
+      # Worst. Code. Ever.
+      #
+      def self.latest_verification_for_pseudo_branch(pact_publication, is_overall_latest, latest_verifications_for_cv_tags, tags_option)
+        if tags_option == true
+          latest_verifications_for_cv_tags
+            .select{ | v | v.consumer_id == pact_publication.consumer_id && v.provider_id == pact_publication.provider_id && pact_publication.head_pact_tags.collect(&:name).include?(v.consumer_version_tag_name) }
+            .sort{ |v1, v2| v1.id <=> v2.id }.last || (is_overall_latest && pact_publication.integration.latest_verification)
+        elsif tags_option.is_a?(Array)
+          latest_verifications_for_cv_tags
+          .select{ | v | v.consumer_id == pact_publication.consumer_id && v.provider_id == pact_publication.provider_id && pact_publication.head_pact_tags.collect(&:name).include?(v.consumer_version_tag_name) && tags_option.include?(v.consumer_version_tag_name) }
+          .sort{ |v1, v2| v1.id <=> v2.id }.last  || (is_overall_latest && pact_publication.integration.latest_verification)
+        else
+          pact_publication.integration.latest_verification
+        end
+      end
+
+      def self.consumer_version_tags(pact_publication, tags_option)
+        if tags_option == true
+          pact_publication.head_pact_tags.collect(&:name)
+        elsif tags_option.is_a?(Array)
+          pact_publication.head_pact_tags.collect(&:name) & tags_option
+        else
+          []
+        end
+      end
+
       def self.find_index_items_for_api(consumer_name: nil, provider_name: nil, **ignored)
-        rows = PactBroker::Matrix::HeadRow
-          .eager(:consumer_version_tags)
-          .eager(:provider_version_tags)
+        latest_pact_publication_ids = latest_pact_publications.select(:id).all.collect{ |h| h[:id] }
+        pact_publication_ids = head_pact_publication_ids(consumer_name: consumer_name, provider_name: provider_name, tags: true)
+
+        pact_publications = PactBroker::Pacts::PactPublication
+          .where(id: pact_publication_ids)
           .select_all_qualified
+          .eager(:consumer)
+          .eager(:provider)
+          .eager(:pact_version)
+          .eager(:consumer_version)
+          .eager(latest_verification: { provider_version: :tags_with_latest_flag })
+          .eager(:head_pact_tags)
 
-        rows = rows.consumer(consumer_name) if consumer_name
-        rows = rows.provider(provider_name) if provider_name
 
-        rows = rows.all.group_by(&:pact_publication_id).values.collect{ | rows| Matrix::AggregatedRow.new(rows) }
+        pact_publications.all.collect do | pact_publication |
+
+          is_overall_latest_for_integration = latest_pact_publication_ids.include?(pact_publication.id)
 
-        rows.sort.collect do | row |
-          # TODO separate this model from IndexItem
-          # webhook status not currently displayed in Pactflow UI, so don't query for it.
           PactBroker::Domain::IndexItem.create(
-            row.consumer,
-            row.provider,
-            row.pact,
-            row.overall_latest?,
-            row.latest_verification_for_pact_version,
+            pact_publication.consumer,
+            pact_publication.provider,
+            pact_publication.to_domain_lightweight,
+            is_overall_latest_for_integration,
+            pact_publication.latest_verification,
             [],
             [],
-            row.consumer_head_tag_names,
-            row.provider_version_tags.select(&:latest?)
+            pact_publication.head_pact_tags.collect(&:name),
+            pact_publication.latest_verification ? pact_publication.latest_verification.provider_version.tags_with_latest_flag.select(&:latest?) : []
           )
+        end.sort
+      end
+
+      def self.latest_pact_publications
+        db[:latest_pact_publications]
+      end
+
+      def self.db
+        PactBroker::Pacts::PactPublication.db
+      end
+
+      def self.head_pact_publication_ids(options = {})
+        query = if options[:tags].is_a?(Array)
+          LATEST_PPS.union(LATEST_TAGGED_PPS.where(tag_name: options[:tags]))
+        elsif options[:tags]
+          LATEST_PPS.union(LATEST_TAGGED_PPS)
+        else
+          LATEST_PPS
+        end
+
+        if options[:consumer_name]
+          query = query.where(PactBroker::Repositories::Helpers.name_like(:consumer_name, options[:consumer_name]))
+        end
+
+        if options[:provider_name]
+          query = query.where(PactBroker::Repositories::Helpers.name_like(:provider_name, options[:provider_name]))
+        end
+
+        query.order(*HEAD_PP_ORDER_COLUMNS)
+          .paginate(options[:page_number] || DEFAULT_PAGE_NUMBER, options[:page_size] || DEFAULT_PAGE_SIZE)
+          .select(:id)
+      end
+
+      def self.latest_verifications_for_consumer_version_tags(options)
+        # server side rendered index page with tags[]=a&tags=[]b
+        if options[:tags].is_a?(Array)
+          PactBroker::Verifications::LatestVerificationForConsumerVersionTag
+            .eager(:provider_version)
+            .where(consumer_version_tag_name: options[:tags])
+            .all
+        elsif options[:tags] # server side rendered index page with tags=true
+          PactBroker::Verifications::LatestVerificationForConsumerVersionTag
+            .eager(:provider_version)
+            .all
+        else
+          nil # should not be used
         end
       end
     end

data/lib/pact_broker/integrations/integration.rb

@@ -1,6 +1,8 @@
 require 'pact_broker/db'
 require 'pact_broker/verifications/pseudo_branch_status'
 require 'pact_broker/domain/verification'
+require 'pact_broker/webhooks/latest_triggered_webhook'
+require 'pact_broker/webhooks/webhook'
 
 module PactBroker
   module Integrations
@@ -9,6 +11,26 @@ module PactBroker
       associate(:many_to_one, :provider, :class => "PactBroker::Domain::Pacticipant", :key => :provider_id, :primary_key => :id)
       associate(:one_to_one, :latest_pact, :class => "PactBroker::Pacts::LatestPactPublications", key: [:consumer_id, :provider_id], primary_key: [:consumer_id, :provider_id])
       associate(:one_to_one, :latest_verification, :class => "PactBroker::Verifications::LatestVerificationForConsumerAndProvider", key: [:consumer_id, :provider_id], primary_key: [:consumer_id, :provider_id])
+      associate(:one_to_many, :latest_triggered_webhooks, :class => "PactBroker::Webhooks::LatestTriggeredWebhook", key: [:consumer_id, :provider_id], primary_key: [:consumer_id, :provider_id])
+
+      # When viewing the index, every webhook in the database will match at least one of the rows, so
+      # it makes sense to load the entire table and match each webhook to the appropriate row.
+      # This will only work when using eager loading. The keys are just blanked out to avoid errors.
+      # I don't understand how they work at all.
+      # It would be nice to do this declaratively.
+      many_to_many :webhooks, class: "PactBroker::Webhooks::Webhook", :left_key => [], left_primary_key: [], :eager_loader=>(proc do |eo_opts|
+        eo_opts[:rows].each do |row|
+          row.associations[:webhooks] = []
+        end
+
+        PactBroker::Webhooks::Webhook.each do | webhook |
+          eo_opts[:rows].each do | row |
+            if webhook.is_for?(row)
+              row.associations[:webhooks] << webhook
+            end
+          end
+        end
+      end)
 
       def verification_status_for_latest_pact
         @verification_status_for_latest_pact ||= PactBroker::Verifications::PseudoBranchStatus.new(latest_pact, latest_pact&.latest_verification)

data/lib/pact_broker/locale/en.yml

@@ -13,6 +13,8 @@ en:
   pact_broker:
     messages:
       response_body_hidden: For security purposes, the response details are not logged. To enable response logging, configure the webhook_host_whitelist property. See /doc/webhooks#whitelist for more information.
+      matrix:
+        pre_verified: This pact was "pre-verified" as it has identical content to a previously verified pact.
       webhooks:
         parameters:
           pactbroker:

data/lib/pact_broker/logging.rb

@@ -1,4 +1,3 @@
-require 'pathname'
 require 'semantic_logger'
 
 module PactBroker

data/lib/pact_broker/matrix/aggregated_row.rb

@@ -33,7 +33,7 @@ module PactBroker
         @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
+            end.compact.sort_by(&:id).last
 
           if !verification && overall_latest?
             overall_latest_verification
@@ -45,9 +45,7 @@ module PactBroker
 
       def latest_verification_for_pact_version
         @latest_verificaton_for_pact_version ||= begin
-          matrix_rows.collect do | row|
-            row.verification
-          end.compact.sort{ |v1, v2| v1.id <=> v2.id }.last
+          matrix_rows.collect(&:verification).compact.sort_by(&:id).last
         end
       end
 
@@ -61,7 +59,7 @@ module PactBroker
 
       private
 
-      attr_reader :matrix_rows
+      attr_reader :matrix_rows, :first_row
 
       def latest_verification_for_consumer_version_tag row
         row.latest_verification_for_consumer_version_tag if row.consumer_version_tag_name
@@ -72,10 +70,6 @@ module PactBroker
         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

data/lib/pact_broker/matrix/deployment_status_summary.rb

@@ -17,7 +17,7 @@ module PactBroker
 
       def counts
         {
-          success: rows.count{ |row| row.success },
+          success: rows.count(&:success),
           failed: rows.count { |row| row.success == false },
           unknown: required_integrations_without_a_row.count + rows.count { |row| row.success.nil? }
         }
@@ -27,7 +27,7 @@ module PactBroker
         return false if specified_selectors_that_do_not_exist.any?
         return nil if rows.any?{ |row| row.success.nil? }
         return nil if required_integrations_without_a_row.any?
-        rows.all?{ |row| row.success } # true if rows is empty
+        rows.all?(&:success) # true if rows is empty
       end
 
       def reasons
@@ -72,7 +72,7 @@ module PactBroker
       end
 
       def success_messages
-        if rows.all?{ |row| row.success } && required_integrations_without_a_row.empty?
+        if rows.all?(&:success) && required_integrations_without_a_row.empty?
           if rows.any?
             [Successful.new]
           else
@@ -113,7 +113,7 @@ module PactBroker
 
       def missing_reasons
         required_integrations_without_a_row.collect do | integration |
-            pact_not_verified_by_required_provider_version(integration)
+          pact_not_verified_by_required_provider_version(integration)
         end.flatten
       end
 
@@ -141,7 +141,7 @@ module PactBroker
 
       def selector_for(pacticipant_name)
         resolved_selectors.find{ | s| s.pacticipant_name == pacticipant_name } ||
-        dummy_selectors.find{ | s| s.pacticipant_name == pacticipant_name }
+          dummy_selectors.find{ | s| s.pacticipant_name == pacticipant_name }
       end
 
       def selectors_for(row)