pact_broker 2.118.0 → 2.120.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5c79b9a890f8984e3e2975740672d1b6c4810a88f750202692144d54b006b2
-  data.tar.gz: 4fb8df1387017108768afd83f9117cab1a4cf274ce9f4a66a0701ca848474b5d
+  metadata.gz: ac9a9b4f3ed5b352518c0d50229fa8348042ff711c25f099bd1b8d8e02dab7b4
+  data.tar.gz: 71567e868b7e8dd466acb52911e69656a15a80a9dc73d7435afe8cb34e6fbc9b
 SHA512:
-  metadata.gz: f1916525083f39001b263ddcd4d41867dec84b640f76b1ce8cd5b8e50c8341ef7e340a6c3f85d129ca56db79984fba48b1e348751ebb19adf5400cbdeaea3808
-  data.tar.gz: e7d66f051526f19300d62bf772082324ba8774c03341380b9de219d7ce0b6113776124a4d88a66adaf1eade5b61667a38877036e76f3f29eb83bbfdbecc98410
+  metadata.gz: b36c2d3066419de3ab741c0ed9333a50acf2b1ee0e1af39f36cb04b3457ba9f48859aca60925f832a52f8c12465e27a7249a0687ceba9dd4389edad51f53d6a4
+  data.tar.gz: ff6ab08cf0c0b513a1f04239376839d7643563a8c57ed991e1e623e0ca20adf42acdb4679735a6add5b96d9de337776f7f5ed45ac059419c3f44b284bb7b1718

data/CHANGELOG.md

@@ -1,3 +1,52 @@
+<a name="v2.120.0"></a>
+### v2.120.0 (2026-07-14)
+
+#### Features
+
+* expose released environments on branch/tag version list endpoints (#969)	 ([bea68a7d](/../../commit/bea68a7d))
+* expose released environments on version API (#963)	 ([d6f7f17b](/../../commit/d6f7f17b))
+* return more webhooks attributes in logs decorator (#961)	 ([4e2d1b13](/../../commit/4e2d1b13))
+* paginate pacticipants_for_label	 ([088ff444](/../../commit/088ff444))
+* add limit to stale branch delete (#933)	 ([406c20f3](/../../commit/406c20f3))
+* change branch sort order, most recently updated first (#929)	 ([b5215a39](/../../commit/b5215a39))
+
+* **clean**
+  * expose branch_deletion_limit on CleanTask (#938)	 ([540afa3d](/../../commit/540afa3d))
+  * add stale branch lifecycle and automated cleanup (#912)	 ([1ba6354f](/../../commit/1ba6354f))
+
+* **PACT-6253**
+  * add json_schemer as explicit gem dependency (#916)	 ([dc8910ce](/../../commit/dc8910ce))
+
+#### Bug Fixes
+
+* **spec**
+  * rebuild success-after-latestby fixture with distinct provider versions	 ([778d25d2](/../../commit/778d25d2))
+  * rebuild latestby filtering fixtures to genuinely pin the ordering contract	 ([9276aa79](/../../commit/9276aa79))
+
+* broken SQL in pacticipants_for_label resource (#944)	 ([bf37cdfc](/../../commit/bf37cdfc))
+* use cvpv when checking can-i-deploy against an environment (#903) (#934)	 ([7163652d](/../../commit/7163652d))
+* remove deadcode, improve testing with UTC (#924)	 ([76c2407a](/../../commit/76c2407a))
+* join with pacticipant when query main branch (#921)	 ([3dae89be](/../../commit/3dae89be))
+
+<a name="v2.119.0"></a>
+### v2.119.0 (2026-04-02)
+
+#### Features
+
+* support customising webhook requests	 ([d20a8274](/../../commit/d20a8274))
+* Optimize WIP Query Performance to Prevent Timeouts on Large Datasets (#902)	 ([711ac3c6](/../../commit/711ac3c6))
+
+#### Bug Fixes
+
+* add missing import and small improvement to batch delete (#899)	 ([2e83d012](/../../commit/2e83d012))
+* new unit test failure	 ([6c39e927](/../../commit/6c39e927))
+* avoid N+1 cascade	 ([681d98d9](/../../commit/681d98d9))
+* dont create index for mysql	 ([1ec72cc8](/../../commit/1ec72cc8))
+* Pacticipant API returning undeployed versions in pacticipant deployed-environments endpoint (#889)	 ([e217d3ba](/../../commit/e217d3ba))
+
+* **PACT-5504**
+  * use batch delete to speed up deletion	 ([e908035a](/../../commit/e908035a))
+
 <a name="v2.118.0"></a>
 ### v2.118.0 (2026-01-02)
 

data/Gemfile

@@ -21,6 +21,8 @@ end
 
 group :test do
   gem "simplecov", :require => false
+  gem "simplecov-cobertura", :require => false
+  gem "rspec_junit_formatter", :require => false
   if ENV["X_PACT_DEVELOPMENT"] == "true"
     gem "pact", path: "../pact-ruby"
     gem "pact-ffi", path: "../pact-ruby-ffi"

data/README.md

@@ -170,7 +170,7 @@ Please read the [UPGRADING.md](UPGRADING.md) documentation before upgrading your
 
 The Pact Broker follows the [semantic versioning](https://semver.org/) scheme.
 
-[decouple]: https://www.rea-group.com/blog/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/
+[decouple]: https://docs.pact.io/pact_broker/can_i_deploy
 [pact]: https://github.com/pact-foundation/pact-ruby
 [nerf]: https://github.com/pact-foundation/pact_broker/wiki/pact-broker-ci-nerf-gun
 [different-teams]: https://github.com/pact-foundation/pact-ruby/wiki/Using-pact-where-the-consumer-team-is-different-from-the-provider-team

data/db/migrations/000015_create_pact_version_content.rb

@@ -5,7 +5,7 @@ Sequel.migration do
   change do
     create_table(:pact_version_contents, charset: "utf8") do
       String :sha, primary_key: true, null: false, primary_key_constraint_name: "pk_pact_version_contents"
-      String :content, type: PactBroker::MigrationHelper.large_text_type
+      column :content, PactBroker::MigrationHelper.large_text_type
       DateTime :created_at, null: false
       DateTime :updated_at, null: false
     end

data/db/migrations/000023_create_pact_versions_table.rb

@@ -7,7 +7,7 @@ Sequel.migration do
       foreign_key :consumer_id, :pacticipants
       foreign_key :provider_id, :pacticipants
       String :sha, null: false
-      String :content, type: PactBroker::MigrationHelper.large_text_type
+      column :content, PactBroker::MigrationHelper.large_text_type
       index [:consumer_id, :provider_id, :sha], unique: true, name: "unq_pvc_con_prov_sha"
       DateTime :created_at, null: false
     end

data/db/migrations/000033_create_config_table.rb

@@ -6,7 +6,7 @@ Sequel.migration do
       primary_key :id
       String :name, null: false
       String :type, null: false
-      String :value, type: PactBroker::MigrationHelper.large_text_type
+      column :value, PactBroker::MigrationHelper.large_text_type
       DateTime :created_at, null: false
       DateTime :updated_at, null: false
       index [:name], unique: true, name: "unq_config_name"

data/db/migrations/000036_create_webhook_execution.rb

@@ -9,7 +9,7 @@ Sequel.migration do
       foreign_key :consumer_id, :pacticipants, null: false
       foreign_key :provider_id, :pacticipants, null: false
       Boolean :success, null: false
-      String :logs, type: PactBroker::MigrationHelper.large_text_type
+      column :logs, PactBroker::MigrationHelper.large_text_type
       DateTime :created_at, null: false
     end
   end

data/db/migrations/20180108_create_certificates_table.rb

@@ -6,7 +6,7 @@ Sequel.migration do
       primary_key :id
       String :uuid, null: false, unique: true, unique_constraint_name: "uq_certificate_uuid"
       String :description, null: true
-      String :content, null: false, type: PactBroker::MigrationHelper.large_text_type
+      column :content, PactBroker::MigrationHelper.large_text_type, null: false
       DateTime :created_at, null: false
       DateTime :updated_at, null: false
     end

data/db/migrations/20251106_add_branch_versions_version_id_branch_name_index.rb

@@ -0,0 +1,21 @@
+require_relative "migration_helper"
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:branch_versions) do
+        add_index([:version_id, :branch_name], name: "branch_versions_version_id_branch_name_idx")
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:branch_versions) do
+        drop_index([:version_id, :branch_name], name: "branch_versions_version_id_branch_name_idx")
+      end
+    end
+  end
+end

data/db/migrations/20260119_add_index_on_consumer_id_provider_id_to_pact_versions.rb

@@ -0,0 +1,20 @@
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:pact_versions) do
+        add_index :consumer_id, name: :pact_versions_consumer_id_index
+        add_index :provider_id, name: :pact_versions_provider_id_index
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:pact_versions) do
+        drop_index :consumer_id, name: :pact_versions_consumer_id_index
+        drop_index :provider_id, name: :pact_versions_provider_id_index
+      end
+    end
+  end
+end
+

data/db/migrations/20260123_drop_branch_versions_branch_name_index.rb

@@ -0,0 +1,17 @@
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:branch_versions) do
+        drop_index([:branch_name], name: "branch_versions_branch_name_index")
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:branch_versions) do
+        add_index([:branch_name], name: "branch_versions_branch_name_index")
+      end
+    end
+  end
+end

data/db/migrations/20260210_add_index_on_pact_version_id_to_latest_pact_publication.rb

@@ -0,0 +1,22 @@
+require_relative "migration_helper"
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:latest_pact_publication_ids_for_consumer_versions) do
+        add_index :pact_version_id, name: :latest_pp_ids_for_cons_ver_pact_version_id_index
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:latest_pact_publication_ids_for_consumer_versions) do
+        drop_index :pact_version_id, name: :latest_pp_ids_for_cons_ver_pact_version_id_index
+      end
+    end
+  end
+end
+

data/db/migrations/20260217_add_wip_query_optimization_indexes.rb

@@ -0,0 +1,31 @@
+require_relative "migration_helper"
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  no_transaction if PactBroker::MigrationHelper.postgres?
+
+  up do
+    if !mysql?
+      alter_table(:pact_publications) do
+        add_index([:provider_id, :created_at], name: "idx_pp_provider_created", concurrently: postgres?)
+      end
+
+      alter_table(:verifications) do
+        add_index([:provider_id, :provider_version_id, :success, :wip, :pact_version_id], name: "idx_verifications_provider_lookup", concurrently: postgres?)
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:pact_publications) do
+        drop_index([:provider_id, :created_at], name: "idx_pp_provider_created")
+      end
+
+      alter_table(:verifications) do
+        drop_index([:provider_id, :provider_version_id, :success, :wip, :pact_version_id], name: "idx_verifications_provider_lookup")
+      end
+    end
+  end
+end

data/db/migrations/migration_helper.rb

@@ -10,7 +10,7 @@ module PactBroker
     end
 
     def large_text_type
-      if postgres?
+      if postgres? || sqlite?
         :text
       else
         # Assume mysql
@@ -32,6 +32,10 @@ module PactBroker
       adapter =~ /postgres/
     end
 
+    def sqlite?
+      adapter =~ /sqlite/
+    end
+
     def adapter
       Sequel::Model.db.adapter_scheme.to_s
     end

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

@@ -11,6 +11,10 @@ module PactBroker
         end
 
 
+        property :event_name, as: :eventName
+        property :consumer_name, as: :consumerName
+        property :provider_name, as: :providerName
+
         nested :triggeredWebhook, embedded: true do
           property :uuid
         end

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

@@ -25,7 +25,7 @@ module PactBroker
         def self.eager_load_associations
           [
             :pacticipant,
-            :pact_publications,
+            { pact_publications: [:consumer, :provider, { pact_version: :latest_verification }, :tags, :head_pact_publications_for_tags] },
             { branch_versions: [:version, :branch_head, { branch: :pacticipant }] },
             { tags: :head_tag }
           ]
@@ -74,9 +74,12 @@ module PactBroker
         end
 
         links :'pb:deployed-environments' do | context |
-          # I couldn't another way to check if call is from a collection or a single item 🤷‍♂️
-          # Also not sure why the heck .to_a?(Hash) doesn't work, I mean what...
-          deployed_versions = context[:deployed_versions].class.to_s == "Hash" ? context[:deployed_versions][represented.id] : context[:deployed_versions]
+          # NB: use fully-qualified ::Hash. The tins gem shadows the bare `Hash`
+          # constant in this scope, so `is_a?(Hash)` returns false even for a real
+          # Hash (this is the collection-vs-single-item branch: the collection
+          # resource passes a version_id-keyed Hash, the single resource an Array).
+          deployed_versions = context.dig(:deployed_versions)
+          deployed_versions = deployed_versions[represented.id] if deployed_versions.is_a?(::Hash)
           deployed_versions&.collect do | deployed_version |
             {
               title: "Version deployed to #{deployed_version.environment.display_name}",
@@ -89,6 +92,23 @@ module PactBroker
           end
         end
 
+        links :'pb:released-environments' do | context |
+          # NB: use fully-qualified ::Hash. The tins gem shadows the bare `Hash`
+          # constant in this scope, so `is_a?(Hash)` returns false even for a real
+          # Hash (this is the collection-vs-single-item branch: the collection
+          # resource passes a version_id-keyed Hash, the single resource an Array).
+          released_versions = context.dig(:released_versions)
+          released_versions = released_versions[represented.id] if released_versions.is_a?(::Hash)
+          released_versions&.collect do | released_version |
+            {
+              title: "Version released to #{released_version.environment.display_name}",
+              name: released_version.environment.display_name,
+              href: released_version_url(released_version, context.fetch(:base_url)),
+              currently_supported: released_version.currently_supported
+            }
+          end
+        end
+
         links :'pb:record-deployment' do | context |
           context[:environments]&.collect do | environment |
             {

data/lib/pact_broker/api/resources/branch_versions.rb

@@ -27,7 +27,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(resource_title: resource_title, deployed_versions: deployed_versions)))
+          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(resource_title: resource_title, deployed_versions: deployed_versions, released_versions: released_versions)))
         end
 
         def versions
@@ -38,6 +38,10 @@ module PactBroker
           @deployed_versions ||= deployed_version_service.find_deployed_versions_for_versions(versions)
         end
 
+        def released_versions
+          @released_versions ||= released_version_service.find_released_versions_for_versions(versions)
+        end
+
         def policy_name
           :'versions::versions'
         end

data/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_branch_to_environment.rb

@@ -37,8 +37,11 @@ module PactBroker
         end
 
         def options
+          # "cvpv" (not "cvp") so that every version of an integrated application that is currently
+          # released/deployed to the environment is evaluated independently, rather than collapsing
+          # to just the latest provider version (which hides still-live incompatible versions). See issue #903.
           @options ||=  {
-                          latestby: "cvp",
+                          latestby: "cvpv",
                           environment_name: identifier_from_path[:environment_name]
                         }
         end

data/lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_branch_to_environment_badge.rb

@@ -1,4 +1,5 @@
 require "pact_broker/api/resources/can_i_deploy_pacticipant_version_by_branch_to_environment"
+require "pact_broker/api/resources/badge_methods"
 
 module PactBroker
   module Api

data/lib/pact_broker/api/resources/clean.rb

@@ -1,5 +1,6 @@
 require "pact_broker/api/resources/base_resource"
 require "pact_broker/db/clean"
+require "pact_broker/db/clean/branch_selector"
 require "pact_broker/matrix/unresolved_selector"
 
 # Not exposed yet as we'd need to support administrator auth first
@@ -22,7 +23,14 @@ module PactBroker
               PactBroker::DB::Clean::Selector.new(hash)
             end
 
-            result = PactBroker::DB::Clean.call(Sequel::Model.db, { keep: keep_selectors })
+            keep_branch_selectors = (params[:keep_branches] || []).collect do | hash |
+              PactBroker::DB::Clean::BranchSelector.from_hash(hash)
+            end
+
+            result = PactBroker::DB::Clean.call(Sequel::Model.db, {
+              keep: keep_selectors,
+              keep_branches: keep_branch_selectors.empty? ? nil : keep_branch_selectors
+            })
             response.body = result.to_json
           else
             415

data/lib/pact_broker/api/resources/pacticipants_for_label.rb

@@ -1,10 +1,12 @@
 require "pact_broker/api/resources/base_resource"
 require "pact_broker/api/decorators/pacticipants_decorator"
+require "pact_broker/api/resources/pagination_methods"
 
 module PactBroker
   module Api
     module Resources
       class PacticipantsForLabel < BaseResource
+        include PaginationMethods
 
         def content_types_provided
           [["application/hal+json", :to_json]]
@@ -14,8 +16,18 @@ module PactBroker
           ["GET", "OPTIONS"]
         end
 
+        def malformed_request?
+          if super
+            true
+          elsif request.get? && validation_errors_for_schema?(schema, request.query)
+            true
+          else
+            false
+          end
+        end
+
         def to_json
-          generate_json(pacticipant_service.find identifier_from_path )
+          generate_json(pacticipant_service.find_all_pacticipants(filter_options, pagination_options, eager_load_associations))
         end
 
         def generate_json pacticipants
@@ -25,6 +37,22 @@ module PactBroker
         def policy_name
           :'pacticipants::pacticipants'
         end
+
+        private
+
+        def schema
+          PactBroker::Api::Contracts::PaginationQueryParamsSchema
+        end
+
+        def eager_load_associations
+          decorator_class(:pacticipants_decorator).eager_load_associations
+        end
+
+        def filter_options
+          options = { label_name: identifier_from_path[:label_name] }
+          options[:query_string] = request.query["q"] if request.query.has_key?("q")
+          options
+        end
       end
     end
   end

data/lib/pact_broker/api/resources/provider_pacts_for_verification.rb

@@ -94,7 +94,7 @@ module PactBroker
         end
 
         def log_request
-          logger.info "Fetching pacts for verification by #{provider_name}", provider_name: provider_name, params: query
+          logger.debug "Fetching pacts for verification by #{provider_name}", provider_name: provider_name, params: query
         end
 
         def nested_query

data/lib/pact_broker/api/resources/tag_versions.rb

@@ -30,7 +30,7 @@ module PactBroker
 
         def to_json
           decorator_class(:versions_decorator).new(tag_versions)
-            .to_json(**decorator_options(deployed_versions: deployed_versions))
+            .to_json(**decorator_options(deployed_versions: deployed_versions, released_versions: released_versions))
         end
 
         private
@@ -39,6 +39,10 @@ module PactBroker
           @deployed_versions ||= deployed_version_service.find_deployed_versions_for_versions(tag_versions)
         end
 
+        def released_versions
+          @released_versions ||= released_version_service.find_released_versions_for_versions(tag_versions)
+        end
+
         def tag_versions
           @versions ||= version_service.find_by_ids_in_reverse_order(@tags.select_map(:version_id), pagination_options, decorator_class(:versions_decorator).eager_load_associations)
         end

data/lib/pact_broker/api/resources/version.rb

@@ -54,7 +54,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:version_decorator).new(version).to_json(**decorator_options(environments: environments, deployed_versions: deployed_versions))
+          decorator_class(:version_decorator).new(version).to_json(**decorator_options(environments: environments, deployed_versions: deployed_versions, released_versions: released_versions))
         end
 
         def delete_resource
@@ -87,6 +87,10 @@ module PactBroker
           @deployed_versions ||= deployed_version_service.find_deployed_versions_for_version(version)
         end
 
+        def released_versions
+          @released_versions ||= released_version_service.find_released_versions_for_version(version)
+        end
+
         def version
           @version ||= version_service.find_by_pacticipant_name_and_number(identifier_from_path)
         end

data/lib/pact_broker/api/resources/versions.rb

@@ -27,7 +27,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(deployed_versions: deployed_versions)))
+          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(deployed_versions: deployed_versions, released_versions: released_versions)))
         end
 
         def versions
@@ -38,6 +38,10 @@ module PactBroker
           @deployed_versions ||= deployed_version_service.find_deployed_versions_for_versions(versions)
         end
 
+        def released_versions
+          @released_versions ||= released_version_service.find_released_versions_for_versions(versions)
+        end
+
         def policy_name
           :'versions::versions'
         end

data/lib/pact_broker/configuration.rb

@@ -201,6 +201,32 @@ module PactBroker
       webhook_host_whitelist&.any?
     end
 
+    def dynamic_wip_window_enabled?
+      ENV["PACT_BROKER_DYNAMIC_WIP_WINDOW"]&.downcase == "true"
+    end
+
+    # Maximum lookback window (days) to query for unverified pacts. Prevents timeout on large datasets.
+    def max_wip_lookback_days
+      ENV["PACT_BROKER_MAX_WIP_LOOKBACK_DAYS"]&.to_i || 14
+    end
+
+    # Minimum WIP window (days) to ensure recent pacts are always included, even if P80 is very low.
+    def min_wip_window_days
+      ENV["PACT_BROKER_MIN_WIP_WINDOW_DAYS"]&.to_i || 7
+    end
+
+    # Lookback window (days) for checking if a pact was verified by another branch before this branch was created.
+    # Uses verification execution_date to find recent branch activity, avoiding false negatives when old
+    # version numbers are reused across branches.
+    def verified_by_other_branch_before_this_branch_look_back
+      ENV["PACT_BROKER_VERIFIED_BY_OTHER_BRANCH_LOOKBACK_DAYS"]&.to_i || 30
+    end
+
+    # Default WIP window (days) used when dynamic calculation fails or no unverified pacts exist.
+    def default_wip_window_days
+      ENV["PACT_BROKER_DEFAULT_WIP_WINDOW_DAYS"]&.to_i || 7
+    end
+
     def enable_badge_resources= enable_badge_resources
       puts "Pact Broker configuration property `enable_badge_resources` is deprecated. Please use `enable_public_badge_access`"
       self.enable_public_badge_access = enable_badge_resources

data/lib/pact_broker/db/clean/branch_selector.rb

@@ -0,0 +1,40 @@
+require "pact_broker/hash_refinements"
+
+module PactBroker
+  module DB
+    class Clean
+      class BranchSelector
+        using PactBroker::HashRefinements
+
+        ATTRIBUTES = [:max_age, :branch]
+
+        attr_accessor(*ATTRIBUTES)
+
+        def initialize(attributes = {})
+          attributes.each do | (name, value) |
+            instance_variable_set("@#{name}", value) if respond_to?(name)
+          end
+          @source_hash = attributes[:source_hash]
+        end
+
+        def self.from_hash(hash)
+          standard_hash = hash.symbolize_keys.snakecase_keys
+          new_hash = standard_hash.slice(*ATTRIBUTES)
+          new_hash[:source_hash] = hash
+          new(new_hash.compact)
+        end
+
+        def to_hash
+          ATTRIBUTES.each_with_object({}) do | key, hash |
+            hash[key] = send(key)
+          end.compact
+        end
+        alias_method :to_h, :to_hash
+
+        def to_json(_opts = nil)
+          (@source_hash || to_hash).to_json
+        end
+      end
+    end
+  end
+end