pact_broker 2.82.0 → 2.85.1

data/lib/pact_broker/versions/branch_version_repository.rb

@@ -0,0 +1,34 @@
+module PactBroker
+  module Versions
+    class BranchVersionRepository
+      include PactBroker::Services
+
+      def add_branch(version, branch_name, auto_created: false)
+        branch = find_or_create_branch(version.pacticipant, branch_name)
+        branch_version = version.branch_version_for_branch(branch)
+        if branch_version
+          branch_version.update(updated_at: Sequel.datetime_class.now)
+        else
+          branch_version = PactBroker::Versions::BranchVersion.new(version: version, branch: branch, auto_created: auto_created).insert_ignore
+          PactBroker::Versions::BranchHead.new(branch: branch, branch_version: branch_version).upsert
+        end
+        pacticipant_service.maybe_set_main_branch(version.pacticipant, branch_name)
+        branch_version
+      end
+
+      private
+
+      def find_or_create_branch(pacticipant, branch_name)
+        find_branch(pacticipant, branch_name) || create_branch(pacticipant, branch_name)
+      end
+
+      def find_branch(pacticipant, branch_name)
+        PactBroker::Versions::Branch.where(pacticipant: pacticipant, name: branch_name).single_record
+      end
+
+      def create_branch(pacticipant, branch_name)
+        PactBroker::Versions::Branch.new(pacticipant: pacticipant, name: branch_name).insert_ignore
+      end
+    end
+  end
+end

data/lib/pact_broker/versions/eager_loaders.rb

@@ -1,48 +1,6 @@
 module PactBroker
   module Versions
     module EagerLoaders
-      class LatestVersionForBranch
-        def self.call(eo, **_other)
-          initialize_association(eo[:rows])
-          populate_associations(eo[:rows])
-        end
-
-        def self.initialize_association(versions)
-          versions.each{|version| version.associations[:latest_version_for_branch] = nil }
-        end
-
-        def self.populate_associations(versions)
-          group_by_pacticipant_id(versions).each do | pacticipant, participant_versions |
-            populate_associations_by_pacticipant(pacticipant, participant_versions)
-          end
-        end
-
-        def self.group_by_pacticipant_id(versions)
-          versions.to_a.group_by(&:pacticipant_id)
-        end
-
-        def self.populate_associations_by_pacticipant(pacticipant_id, versions)
-          latest_versions_for_branches = latest_versions_for_pacticipant_branches(
-            pacticipant_id,
-            versions.collect(&:branch).uniq.compact,
-            versions.first.class
-          )
-          self.populate_versions_with_branches(versions, latest_versions_for_branches)
-        end
-
-        def self.populate_versions_with_branches(versions, latest_versions_for_branches)
-          versions.select(&:branch).each do | version |
-            version.associations[:latest_version_for_branch] = latest_versions_for_branches[[version.pacticipant_id, version.branch]]
-          end
-        end
-
-        def self.latest_versions_for_pacticipant_branches(pacticipant_id, branches, version_class)
-          version_class.latest_versions_for_pacticipant_branches(pacticipant_id, branches).each_with_object({}) do | row, hash |
-            hash[[row.pacticipant_id, row.branch]] = row
-          end
-        end
-      end
-
       class LatestVersionForPacticipant
         def self.call(eo, **_other)
           populate_associations(eo[:rows])

data/lib/pact_broker/versions/repository.rb

@@ -2,6 +2,9 @@ require "sequel"
 require "pact_broker/logging"
 require "pact_broker/domain/version"
 require "pact_broker/tags/repository"
+require "pact_broker/versions/branch"
+require "pact_broker/versions/branch_version"
+require "pact_broker/versions/branch_head"
 
 module PactBroker
   module Versions
@@ -49,22 +52,29 @@ module PactBroker
       end
 
       # There may be a race condition if two simultaneous requests come in to create the same version
-      def create args
+      def create(args)
         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
-        }
+          updated_at: Sequel.datetime_class.now,
+          build_url: args[:build_url]
+        }.compact
 
-        PactBroker::Domain::Version.new(version_params).upsert
+
+        version = PactBroker::Domain::Version.new(version_params).upsert
+        # branch can't be set from CRUD on the version resource, but it's convenient to be able
+        # to make a version with a branch for internal code.
+        branch_version_repository.add_branch(version, args[:branch]) if args[:branch]
+        version
       end
 
       def create_or_update(pacticipant, version_number, open_struct_version)
         saved_version = PactBroker::Domain::Version.where(pacticipant_id: pacticipant.id, number: version_number).single_record
         params = open_struct_version.to_h
         tags = params.delete(:tags)
+        branch_name = params.delete(:branch)
         if saved_version
           saved_version.update(params)
         else
@@ -74,10 +84,11 @@ module PactBroker
             params.merge(
               pacticipant_id: pacticipant.id,
               number: version_number
-            )
+            ).compact
           ).upsert
         end
 
+        branch_version_repository.add_branch(saved_version, branch_name) if branch_name
         replace_tags(saved_version, tags) if tags
         saved_version
       end
@@ -86,8 +97,7 @@ module PactBroker
         saved_version = PactBroker::Domain::Version.new(
           number: version_number,
           pacticipant: pacticipant,
-          build_url: open_struct_version.build_url,
-          branch: open_struct_version.branch
+          build_url: open_struct_version.build_url
         ).upsert
 
         if open_struct_version.tags
@@ -112,7 +122,15 @@ module PactBroker
       end
 
       def delete_by_id version_ids
+        branches = Versions::Branch.where(id: Versions::BranchHead.select(:branch_id).where(version_id: version_ids)).all # these will be deleted
         Domain::Version.where(id: version_ids).delete
+        branches.each do | branch |
+          new_head_branch_version = Versions::BranchVersion.find_latest_for_branch(branch)
+          if new_head_branch_version
+            PactBroker::Versions::BranchHead.new(branch: branch, branch_version: new_head_branch_version).upsert
+          end
+        end
+        nil
       end
 
       def delete_orphan_versions consumer, provider
@@ -129,11 +147,6 @@ module PactBroker
         PactBroker::Domain::Version.select_all_qualified.for_selector(selector).all
       end
 
-      def set_branch_if_unset(version, branch)
-        version.update(branch: branch) if version.branch.nil?
-        version
-      end
-
       def find_latest_version_from_main_branch(pacticipant)
         if pacticipant.main_branch
           latest_from_main_branch = PactBroker::Domain::Version

data/lib/pact_broker/versions/service.rb

@@ -10,23 +10,6 @@ module PactBroker
       extend PactBroker::Services
       include PactBroker::Logging
 
-      def self.conflict_errors(_existing_version, _open_struct_version, _version_url)
-        # This validation is causing problems in the PF build when branches are merged
-        # TODO remove this properly when re-doing the version -> branch relationship
-        {}
-        # if existing_version&.branch && open_struct_version.to_h.key?(:branch) && existing_version.branch != open_struct_version.branch
-        #   message_params = {
-        #     old_branch: existing_version&.branch,
-        #     new_branch: open_struct_version.branch,
-        #     version_url: version_url
-        #   }
-        #   error_message = message("errors.validation.cannot_modify_version_branch", message_params)
-        #   { branch: [error_message] }
-        # else
-        #   {}
-        # end
-      end
-
       def self.find_latest_by_pacticpant_name params
         version_repository.find_latest_by_pacticpant_name params.fetch(:pacticipant_name)
       end
@@ -42,14 +25,12 @@ module PactBroker
       def self.create_or_overwrite(pacticipant_name, version_number, version)
         pacticipant = pacticipant_repository.find_by_name_or_create(pacticipant_name)
         version = version_repository.create_or_overwrite(pacticipant, version_number, version)
-        pacticipant_service.maybe_set_main_branch(pacticipant, version.branch)
         version
       end
 
       def self.create_or_update(pacticipant_name, version_number, version)
         pacticipant = pacticipant_repository.find_by_name_or_create(pacticipant_name)
         version = version_repository.create_or_update(pacticipant, version_number, version)
-        pacticipant_service.maybe_set_main_branch(pacticipant, version.branch)
         version
       end
 
@@ -66,9 +47,9 @@ module PactBroker
       end
 
       def self.maybe_set_version_branch_from_tag(version, tag_name)
-        if use_tag_as_branch?(version) && !version.branch
-          logger.info "Setting #{version.pacticipant.name} version #{version.number} branch to '#{tag_name}' from first tag (because use_first_tag_as_branch=true)"
-          version_repository.set_branch_if_unset(version, tag_name)
+        if use_tag_as_branch?(version) && version.branch_versions.empty?
+          logger.info "Adding #{version.pacticipant.name} version #{version.number} to branch '#{tag_name}' (from first tag, because use_first_tag_as_branch=true)"
+          branch_version_repository.add_branch(version, tag_name, auto_created: true)
         end
       end
 

data/lib/pact_broker/webhooks/event_listener.rb

@@ -51,12 +51,12 @@ module PactBroker
 
       def log_detected_event
         event = detected_events.last
-        logger.info "Event detected", payload: { event_name: event.name, event_comment: event.comment }
+        logger.debug "Event detected", payload: { event_name: event.name, event_comment: event.comment }
         if event.triggered_webhooks&.any?
-          triggered_webhook_descriptions = event.triggered_webhooks.collect{ |tw| { webhook_uuid: tw.webhook_uuid, triggered_webhook_uuid: tw.uuid, webhook_description: tw.webhook.description } }
+          triggered_webhook_descriptions = event.triggered_webhooks.collect{ |tw| { event_name: event.name, webhook_uuid: tw.webhook_uuid, triggered_webhook_uuid: tw.uuid, webhook_description: tw.webhook.description } }
           logger.info "Triggered webhooks for #{event.name}", payload: { triggered_webhooks: triggered_webhook_descriptions }
         else
-          logger.info "No enabled webhooks found for event #{event.name}"
+          logger.debug "No enabled webhooks found for event #{event.name}"
         end
       end
 

data/lib/pact_broker/webhooks/execution_configuration.rb

@@ -25,14 +25,30 @@ module PactBroker
         with_updated_attribute(logging_options: { failure_log_message: value })
       end
 
+      def with_retry_schedule(value)
+        with_updated_attribute(retry_schedule: value)
+      end
+
+      def with_http_success_codes(value)
+        with_updated_attribute(http_success_codes: value)
+      end
+
       def with_webhook_context(value)
         with_updated_attribute(webhook_context: value)
       end
 
+      def with_user_agent(value)
+        with_updated_attribute(user_agent: value)
+      end
+
       def webhook_context
         self[:webhook_context]
       end
 
+      def retry_schedule
+        self[:retry_schedule]
+      end
+
       def [](key)
         params[key]
       end

data/lib/pact_broker/webhooks/execution_configuration_creator.rb

@@ -7,6 +7,9 @@ module PactBroker
       def self.call(resource)
         PactBroker::Webhooks::ExecutionConfiguration.new
           .with_show_response(PactBroker.configuration.show_webhook_response?)
+          .with_retry_schedule(PactBroker.configuration.webhook_retry_schedule)
+          .with_http_success_codes(PactBroker.configuration.webhook_http_code_success)
+          .with_user_agent(PactBroker.configuration.user_agent)
           .with_webhook_context(base_url: resource.base_url)
       end
     end

data/lib/pact_broker/webhooks/job.rb

@@ -104,7 +104,7 @@ module PactBroker
       end
 
       def retry_schedule
-        PactBroker.configuration.webhook_retry_schedule
+        data[:webhook_execution_configuration].retry_schedule
       end
     end
   end

data/lib/pact_broker/webhooks/pact_and_verification_parameters.rb

@@ -14,6 +14,7 @@ module PactBroker
       GITHUB_VERIFICATION_STATUS = "pactbroker.githubVerificationStatus"
       BITBUCKET_VERIFICATION_STATUS = "pactbroker.bitbucketVerificationStatus"
       AZURE_DEV_OPS_VERIFICATION_STATUS = "pactbroker.azureDevOpsVerificationStatus"
+      GITLAB_VERIFICATION_STATUS = "pactbroker.gitlabVerificationStatus"
       CONSUMER_LABELS = "pactbroker.consumerLabels"
       PROVIDER_LABELS = "pactbroker.providerLabels"
       EVENT_NAME = "pactbroker.eventName"
@@ -33,6 +34,7 @@ module PactBroker
         GITHUB_VERIFICATION_STATUS,
         BITBUCKET_VERIFICATION_STATUS,
         AZURE_DEV_OPS_VERIFICATION_STATUS,
+        GITLAB_VERIFICATION_STATUS,
         CONSUMER_LABELS,
         PROVIDER_LABELS,
         EVENT_NAME,
@@ -46,13 +48,12 @@ module PactBroker
         @base_url = webhook_context.fetch(:base_url)
       end
 
-      # rubocop: disable Metrics/CyclomaticComplexity
       def to_hash
         @hash ||= {
           PACT_URL => pact ? PactBroker::Api::PactBrokerUrls.pact_version_url_with_webhook_metadata(pact, base_url) : "",
           VERIFICATION_RESULT_URL => verification_url,
           CONSUMER_VERSION_NUMBER => consumer_version_number,
-          PROVIDER_VERSION_NUMBER => verification ? verification.provider_version_number : "",
+          PROVIDER_VERSION_NUMBER => provider_version_number,
           PROVIDER_VERSION_TAGS => provider_version_tags,
           PROVIDER_VERSION_BRANCH => provider_version_branch,
           CONSUMER_VERSION_TAGS => consumer_version_tags,
@@ -62,13 +63,13 @@ module PactBroker
           GITHUB_VERIFICATION_STATUS => github_verification_status,
           BITBUCKET_VERIFICATION_STATUS => bitbucket_verification_status,
           AZURE_DEV_OPS_VERIFICATION_STATUS => azure_dev_ops_verification_status,
+          GITLAB_VERIFICATION_STATUS => gitlab_verification_status,
           CONSUMER_LABELS => pacticipant_labels(pact && pact.consumer),
           PROVIDER_LABELS => pacticipant_labels(pact && pact.provider),
           EVENT_NAME => event_name,
           CURRENTLY_DEPLOYED_PROVIDER_VERSION_NUMBER => currently_deployed_provider_version_number
         }
       end
-      # rubocop: enable Metrics/CyclomaticComplexity
 
       private
 
@@ -98,6 +99,14 @@ module PactBroker
         end
       end
 
+      def gitlab_verification_status
+        if verification
+          verification.success ? "success" : "failed"
+        else
+          "pending"
+        end
+      end
+
       def verification_url
         if verification
           PactBroker::Api::PactBrokerUrls.verification_url(verification, base_url)
@@ -146,6 +155,14 @@ module PactBroker
         end
       end
 
+      def provider_version_number
+        if webhook_context[:provider_version_number]
+          webhook_context[:provider_version_number]
+        else
+          verification ? verification.provider_version_number : ""
+        end
+      end
+
       def provider_version_branch
         if webhook_context[:provider_version_branch]
           webhook_context[:provider_version_branch]

data/lib/pact_broker/webhooks/trigger_service.rb

@@ -31,8 +31,8 @@ module PactBroker
       end
 
       def execute_triggered_webhook_now triggered_webhook, webhook_execution_configuration_hash
-        webhook_execution_result = triggered_webhook.execute webhook_execution_configuration_hash
-        webhook_repository.create_execution triggered_webhook, webhook_execution_result
+        webhook_execution_result = triggered_webhook.execute(webhook_execution_configuration_hash)
+        webhook_repository.create_execution(triggered_webhook, webhook_execution_result)
         webhook_execution_result
       end
 

data/lib/pact_broker/webhooks/webhook_execution_result.rb

@@ -6,20 +6,16 @@ module PactBroker
     class WebhookExecutionResult
       attr_reader :request, :response, :logs, :error
 
-      def initialize(request, response, logs, error = nil)
+      def initialize(request, response, success, logs, error = nil)
         @request = PactBroker::Webhooks::HttpRequestWithRedactedHeaders.new(request)
         @response = response ? PactBroker::Webhooks::HttpResponseWithUtf8SafeBody.new(response) : nil
+        @success = success
         @logs = logs
         @error = error
       end
 
       def success?
-        if response
-          # Response HTTP Code must be in success list otherwise it is false
-          PactBroker.configuration.webhook_http_code_success.include? response.code.to_i
-        else
-          false
-        end
+        @success
       end
     end
   end

data/lib/pact_broker/webhooks/webhook_request_logger.rb

@@ -29,15 +29,17 @@ module PactBroker
         @options = options
       end
 
-      def log(uuid, webhook_request, http_response, error, webhook_context)
+      # rubocop: disable Metrics/ParameterLists
+      def log(uuid, webhook_request, http_response, success, error, webhook_context)
         safe_response = http_response ? HttpResponseWithUtf8SafeBody.new(http_response) : nil
         log_webhook_context(webhook_context)
         log_request(webhook_request)
         log_response(uuid, safe_response, webhook_context[:base_url]) if safe_response
         log_error(uuid, error, webhook_context[:base_url]) if error
-        log_completion_message(success?(safe_response))
+        log_completion_message(success)
         log_stream.string
       end
+      # rubocop: enable Metrics/ParameterLists
 
       private
 
@@ -115,16 +117,6 @@ module PactBroker
           execution_logger.error "Error executing webhook #{uuid}. #{response_body_hidden_message(base_url)}"
         end
       end
-
-      def success?(response)
-        if response
-          # Response HTTP Code must be in success list otherwise it is false
-          PactBroker.configuration.webhook_http_code_success.include? response.code.to_i
-        else
-          false
-        end
-      end
-
     end
   end
 end