pact_broker 2.119.0 → 2.120.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e28c13c74efb9e4cd894da6d14e18a28ea6d15c3240f4defc2b2fe246d1fafb0
-  data.tar.gz: 6194f39dd67344eed51782de55bea6d95ee937716bd59afbe8b6ee2cfe473b08
+  metadata.gz: ac9a9b4f3ed5b352518c0d50229fa8348042ff711c25f099bd1b8d8e02dab7b4
+  data.tar.gz: 71567e868b7e8dd466acb52911e69656a15a80a9dc73d7435afe8cb34e6fbc9b
 SHA512:
-  metadata.gz: 40138782cf26259e00e0f2417d9243f5066f4b6dd77ad076869f12f47adcfb7f4a85481e4b9f3cff4ba9ba9bf03881bbb69e71fa7b269bd868a472ed74c2b91e
-  data.tar.gz: 056be7ffcb8273b41d7e1292307b495a6277b71248b685515185f0239b477aa8fb6ff6646ef9ac22e86cfb87aa10bfe969ff93a1868ef10e1e81a3ae793f381a
+  metadata.gz: b36c2d3066419de3ab741c0ed9333a50acf2b1ee0e1af39f36cb04b3457ba9f48859aca60925f832a52f8c12465e27a7249a0687ceba9dd4389edad51f53d6a4
+  data.tar.gz: ff6ab08cf0c0b513a1f04239376839d7643563a8c57ed991e1e623e0ca20adf42acdb4679735a6add5b96d9de337776f7f5ed45ac059419c3f44b284bb7b1718

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+<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)
 

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/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

@@ -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/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/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

data/lib/pact_broker/db/clean.rb

@@ -2,6 +2,7 @@ require "sequel"
 require "pact_broker/project_root"
 require "pact_broker/logging"
 require "pact_broker/db/clean/selector"
+require "pact_broker/db/clean/branch_selector"
 
 module PactBroker
   module DB
@@ -130,6 +131,9 @@ module PactBroker
         delete_orphan_tags
         delete_orphan_versions
 
+        deleted_counts[:stale_branches] = delete_stale_branches
+        kept_counts[:stale_branches] = db[:branches].count
+
         { kept: kept_counts, deleted: deleted_counts }
       end
 
@@ -180,6 +184,47 @@ module PactBroker
         db[:versions].where(id: referenced_version_ids).invert.delete
       end
 
+      def delete_stale_branches
+        return 0 unless keep_branches && !keep_branches.empty?
+
+        db[:branches].where(id: stale_branch_ids_to_delete.from_self.select(:id)).delete
+      end
+
+      def stale_branch_ids_to_delete
+        db[:branches]
+          .select(Sequel[:branches][:id])
+          .left_outer_join(stale_branch_ids_to_keep, { Sequel[:branches][:id] => Sequel[:keep_branches][:id] }, table_alias: :keep_branches)
+          .where(Sequel[:keep_branches][:id] => nil)
+      end
+
+      def stale_branch_ids_to_keep
+        queries = [main_branch_ids_to_keep]
+
+        keep_branches.each do | selector |
+          if selector.max_age
+            cutoff = Date.today - selector.max_age
+            queries << db[:branches].where { updated_at >= cutoff }.select(:id)
+          end
+          if selector.branch
+            queries << db[:branches].where(name: Array(selector.branch)).select(:id)
+          end
+        end
+
+        queries.reduce(:union)
+      end
+
+      def main_branch_ids_to_keep
+        db[:branches]
+          .join(:pacticipants, id: Sequel[:branches][:pacticipant_id])
+          .exclude(Sequel[:pacticipants][:main_branch] => nil)
+          .where(Sequel[:branches][:name] => Sequel[:pacticipants][:main_branch])
+          .select(Sequel[:branches][:id])
+      end
+
+      def keep_branches
+        @keep_branches ||= options[:keep_branches]&.collect { | selector_hash | BranchSelector.from_hash(selector_hash.to_hash) }
+      end
+
       def delete_overwritten_verifications
         verification_ids = db[:verifications].select(:id).where(id: db[:latest_verification_id_for_pact_version_and_provider_version].select(:verification_id)).invert
         deleted_counts = { verification_results: verification_ids.count }

data/lib/pact_broker/db/clean_incremental.rb

@@ -2,6 +2,7 @@ require "pact_broker/logging"
 require "pact_broker/matrix/unresolved_selector"
 require "pact_broker/date_helper"
 require "pact_broker/db/clean/selector"
+require "pact_broker/db/clean/branch_selector"
 
 module PactBroker
   module DB
@@ -14,7 +15,10 @@ module PactBroker
         PactBroker::DB::Clean::Selector.new(released: true),
         PactBroker::DB::Clean::Selector.new(max_age: 90)
       ]
-      TABLES = [:versions, :pact_publications, :pact_versions, :verifications, :triggered_webhooks, :webhook_executions]
+      DEFAULT_KEEP_BRANCH_SELECTORS = [
+        PactBroker::DB::Clean::BranchSelector.new(max_age: 90)
+      ]
+      TABLES = [:versions, :pact_publications, :pact_versions, :verifications, :triggered_webhooks, :webhook_executions, :branches]
 
       def self.call database_connection, options = {}
         new(database_connection, options).call
@@ -44,6 +48,7 @@ module PactBroker
           before_counts = current_counts
           PactBroker::Domain::Version.where(id: versions_to_delete.from_self.select_map(:id)).delete
           delete_orphan_pact_versions
+          delete_stale_branches
           after_counts = current_counts
 
           TABLES.each_with_object({}) do | table_name, comparison_counts |
@@ -68,10 +73,22 @@ module PactBroker
                   end
       end
 
+      def keep_branches
+        @keep_branches ||= if options.key?(:keep_branches)
+                             options[:keep_branches]&.collect { | selector_hash | PactBroker::DB::Clean::BranchSelector.from_hash(selector_hash.to_hash) }
+                           else
+                             DEFAULT_KEEP_BRANCH_SELECTORS
+                           end
+      end
+
       def limit
         options[:limit] || 1000
       end
 
+      def branch_limit
+        options[:branch_limit] || limit
+      end
+
       def versions_to_delete(columns = [:id])
         fully_qualified_columns = columns.collect { |col| Sequel[:versions][col] }
         PactBroker::Domain::Version
@@ -96,6 +113,47 @@ module PactBroker
         options[:dry_run]
       end
 
+      def delete_stale_branches
+        return unless keep_branches && !keep_branches.empty?
+
+        # A direct subquery here fails in MySQL, so wrap the dataset in a
+        # derived table with `from_self` before selecting the ids for deletion.
+        PactBroker::Versions::Branch.where(id: stale_branch_ids_to_delete.from_self.select(:id)).delete
+      end
+
+      def stale_branch_ids_to_delete
+        PactBroker::Versions::Branch
+          .select(Sequel[:branches][:id])
+          .left_outer_join(stale_branch_ids_to_keep, { Sequel[:branches][:id] => Sequel[:keep_branches][:id] }, table_alias: :keep_branches)
+          .where(Sequel[:keep_branches][:id] => nil)
+          .limit(branch_limit)
+      end
+
+      def stale_branch_ids_to_keep
+        # Always keep main branches for each pacticipant
+        queries = [main_branch_ids_to_keep]
+
+        keep_branches.each do | selector |
+          if selector.max_age
+            cutoff = Date.today - selector.max_age
+            queries << PactBroker::Versions::Branch.where { updated_at >= cutoff }.select(Sequel[:branches][:id])
+          end
+          if selector.branch
+            queries << PactBroker::Versions::Branch.where(name: Array(selector.branch)).select(Sequel[:branches][:id])
+          end
+        end
+
+        queries.reduce(&:union)
+      end
+
+      def main_branch_ids_to_keep
+        PactBroker::Versions::Branch
+          .join(:pacticipants, id: Sequel[:branches][:pacticipant_id])
+          .exclude(Sequel[:pacticipants][:main_branch] => nil)
+          .where(Sequel[:branches][:name] => Sequel[:pacticipants][:main_branch])
+          .select(Sequel[:branches][:id])
+      end
+
       def delete_orphan_pact_versions
         db[:pact_versions].where(id: orphan_pact_versions).delete
       rescue Sequel::DatabaseError => e
@@ -142,19 +200,29 @@ module PactBroker
           }
         end
 
+        {
+          "counts" => dry_run_counts(kept_per_selector),
+          "versionSummary" => pacticipant_results
+        }
+      end
+
+      def dry_run_counts(kept_per_selector)
         total_versions_count = PactBroker::Domain::Version.count
         versions_to_keep_count = version_ids_to_keep.count
         versions_to_delete_count = versions_to_delete.count
 
+        total_branches_count = PactBroker::Versions::Branch.count
+        branches_to_delete_count = keep_branches && !keep_branches.empty? ? stale_branch_ids_to_delete.count : 0
+
         {
-          "counts" => {
-            "totalVersions" => total_versions_count,
-            "versionsToDelete" => versions_to_delete_count,
-            "versionsNotToKeep" => total_versions_count - versions_to_keep_count,
-            "versionsToKeep" => versions_to_keep_count,
-            "versionsToKeepBySelector" => kept_per_selector,
-          },
-          "versionSummary" => pacticipant_results
+          "totalVersions" => total_versions_count,
+          "versionsToDelete" => versions_to_delete_count,
+          "versionsNotToKeep" => total_versions_count - versions_to_keep_count,
+          "versionsToKeep" => versions_to_keep_count,
+          "versionsToKeepBySelector" => kept_per_selector,
+          "totalBranches" => total_branches_count,
+          "branchesToDelete" => branches_to_delete_count,
+          "branchesToKeep" => total_branches_count - branches_to_delete_count
         }
       end
 

data/lib/pact_broker/deployments/released_version_service.rb

@@ -46,6 +46,20 @@ module PactBroker
           .single_record
       end
 
+      def self.find_released_versions_for_version(version)
+        scope_for(ReleasedVersion)
+          .where(version_id: version.id)
+          .eager(:environment)
+          .all
+      end
+
+      def self.find_released_versions_for_versions(versions_array)
+        scope_for(ReleasedVersion)
+          .where(version_id: versions_array.map(&:id))
+          .eager(:environment)
+          .to_hash_groups(:version_id)
+      end
+
       def self.record_version_support_ended(released_version)
         released_version.record_support_ended
       end

data/lib/pact_broker/matrix/parse_can_i_deploy_query.rb

@@ -26,6 +26,11 @@ module PactBroker
 
         if params[:environment].is_a?(String)
           options[:environment_name] = params[:environment]
+          # Multiple versions of an integrated application can be simultaneously released to an
+          # environment (record-release), or deployed to it on different targets (record-deployment).
+          # "cvp" collapses these down to the latest provider version, hiding incompatible versions
+          # that are still live. "cvpv" evaluates every co-resident version independently. See issue #903.
+          options[:latestby] = "cvpv"
         end
 
         if params[:ignore].is_a?(Array)

data/lib/pact_broker/pacticipants/repository.rb

@@ -41,7 +41,7 @@ module PactBroker
         return [] if query.empty?
 
         query = query.select_all_qualified
-        query = query.filter(:name, options[:query_string]) if options[:query_string]
+        query = query.filter(Sequel[:pacticipants][:name], options[:query_string]) if options[:query_string]
         query = query.label(options[:label_name]) if options[:label_name]
         query.order_ignore_case(Sequel[:pacticipants][:name]).eager(*eager_load_associations).all_with_pagination_options(pagination_options)
       end

data/lib/pact_broker/tasks/clean_task.rb

@@ -10,7 +10,9 @@ module PactBroker
 
       attr_accessor :database_connection
       attr_reader :keep_version_selectors
+      attr_reader :keep_branch_selectors
       attr_accessor :version_deletion_limit
+      attr_accessor :branch_deletion_limit
       attr_accessor :logger
       attr_accessor :dry_run
       attr_accessor :use_lock # allow disabling of postgres lock if it is causing problems
@@ -21,6 +23,7 @@ module PactBroker
         @dry_run = false
         @use_lock = true
         @keep_version_selectors = PactBroker::DB::CleanIncremental::DEFAULT_KEEP_SELECTORS
+        @keep_branch_selectors = PactBroker::DB::CleanIncremental::DEFAULT_KEEP_BRANCH_SELECTORS
         rake_task(&block)
       end
 
@@ -31,10 +34,17 @@ module PactBroker
         end
       end
 
+      def keep_branch_selectors=(keep_branch_selectors)
+        require "pact_broker/db/clean/branch_selector"
+        @keep_branch_selectors = keep_branch_selectors.nil? ? nil : [*keep_branch_selectors].collect do | hash |
+          PactBroker::DB::Clean::BranchSelector.from_hash(hash)
+        end
+      end
+
       def rake_task &block
         namespace :pact_broker do
           namespace :db do
-            desc "Clean unnecessary pacts and verifications from database"
+            desc "Clean unnecessary pacts, verifications and stale branches from database"
             task :clean do | _t, _args |
               instance_eval(&block)
 
@@ -61,10 +71,14 @@ module PactBroker
           output "Deleting oldest #{version_deletion_limit} versions, keeping versions that match the configured selectors", keep_version_selectors.collect(&:to_hash)
         end
 
+        output_keep_branch_selectors
+
         start_time = Time.now
         results = PactBroker::DB::CleanIncremental.call(database_connection,
           keep: keep_version_selectors,
+          keep_branches: keep_branch_selectors,
           limit: version_deletion_limit,
+          branch_limit: branch_deletion_limit,
           logger: logger,
           dry_run: dry_run
         )
@@ -109,6 +123,14 @@ module PactBroker
         logger ? logger.info("#{prefix}#{string}", payload) : puts("#{prefix}#{string} #{payload.to_json}")
       end
 
+      def output_keep_branch_selectors
+        if keep_branch_selectors.nil? || keep_branch_selectors.empty?
+          output "Stale branch cleanup is disabled (no keep_branch_selectors configured)"
+        else
+          output "Deleting stale branches that do not match the configured selectors (main branches are always kept)", keep_branch_selectors.collect(&:to_hash)
+        end
+      end
+
       def add_defaults_to_keep_selectors
         if keep_version_selectors.none?(&:currently_deployed?)
           selector = PactBroker::DB::Clean::Selector.new(deployed: true)

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.119.0"
+  VERSION = "2.120.0"
 end

data/lib/pact_broker/versions/branch_repository.rb

@@ -13,7 +13,7 @@ module PactBroker
         query = scope_for(Branch).where(pacticipant_id: pacticipant.id).select_all_qualified
         query = query.filter(:name, filter_options[:query_string]) if filter_options[:query_string]
         query
-          .order(Sequel.desc(:created_at), Sequel.desc(:id))
+          .order(Sequel.desc(:updated_at), Sequel.desc(:id))
           .eager(*eager_load_associations)
           .all_with_pagination_options(pagination_options)
       end

data/lib/pact_broker/versions/branch_service.rb

@@ -21,7 +21,7 @@ module PactBroker
         # @return [Array<PactBroker::Contracts::Notice>]
         def branch_deletion_notices(pacticipant, exclude:)
           count = branch_repository.count_branches_to_delete(pacticipant, exclude: exclude)
-          remaining = branch_repository.remaining_branches_after_future_deletion(pacticipant, exclude: exclude).sort_by(&:created_at).collect(&:name).join(", ")
+          remaining = branch_repository.remaining_branches_after_future_deletion(pacticipant, exclude: exclude).sort_by(&:updated_at).collect(&:name).join(", ")
           [PactBroker::Contracts::Notice.success(message("messages.branch.bulk_delete", count: count, pacticipant_name: pacticipant.name, remaining: remaining))]
         end
       end

data/lib/pact_broker/versions/branch_version_repository.rb

@@ -34,6 +34,7 @@ module PactBroker
             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
+          branch.update(updated_at: Sequel.datetime_class.now)
           pacticipant_service.maybe_set_main_branch(version.pacticipant, branch_name)
           branch_version
         end

data/pact_broker.gemspec

@@ -49,17 +49,17 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
 
-  gem.add_runtime_dependency "json", "~> 2.3"
+  gem.add_runtime_dependency "json", ">= 2.19.9"
   gem.add_runtime_dependency "psych", "~> 5.0"
   gem.add_runtime_dependency "roar", "~> 1.1"
   gem.add_runtime_dependency "dry-validation", "~> 1.8"
   gem.add_runtime_dependency "reform", "~> 2.6"
   gem.add_runtime_dependency "sequel", "~> 5.90"
-  gem.add_runtime_dependency "webmachine", ">= 2.0.0.beta", "< 3.0"
+  gem.add_runtime_dependency "webmachine", "~> 2.0"
   gem.add_runtime_dependency "semver2", "~> 3.4.2"
   gem.add_runtime_dependency "rack", "~> 3.2"
-  gem.add_runtime_dependency "redcarpet", ">= 3.5.1", "~>3.5"
-  gem.add_runtime_dependency "pact-support" , ">= 1.21.2", "~> 1.21"
+  gem.add_runtime_dependency "redcarpet", "~> 3.5"
+  gem.add_runtime_dependency "pact-support", "~> 1.21"
   gem.add_runtime_dependency "haml", "~>5.0"
   gem.add_runtime_dependency "sucker_punch", "~>3.0"
   gem.add_runtime_dependency "rack-protection", "~> 4.1"
@@ -74,6 +74,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "mutex_m", "~> 0.3" # until as-notifications -> webmachine requires it
   gem.add_runtime_dependency "csv", "~> 3.0" # lib/pact_broker/api/decorators/relationships_csv_decorator.rb
   # dropped in ruby 3.5 stdlib
-  gem.add_runtime_dependency "ostruct", "~> 0.5" 
+  gem.add_runtime_dependency "ostruct", "~> 0.5"
+  gem.add_runtime_dependency "json_schemer", "~> 2.5"
   gem.add_development_dependency "pstore", "~> 0.1" # until webmachine requires it
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.119.0
+  version: 2.120.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -15,16 +15,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.19.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.19.9
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -99,22 +99,16 @@ dependencies:
   name: webmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0.beta
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0.beta
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: semver2
   requirement: !ruby/object:Gem::Requirement
@@ -147,9 +141,6 @@ dependencies:
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
@@ -157,9 +148,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
@@ -167,9 +155,6 @@ dependencies:
   name: pact-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.21.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
@@ -177,9 +162,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.21.2
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
@@ -365,6 +347,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: pstore
   requirement: !ruby/object:Gem::Requirement
@@ -836,6 +832,7 @@ files:
 - lib/pact_broker/db.rb
 - lib/pact_broker/db/advisory_lock.rb
 - lib/pact_broker/db/clean.rb
+- lib/pact_broker/db/clean/branch_selector.rb
 - lib/pact_broker/db/clean/selector.rb
 - lib/pact_broker/db/clean_incremental.rb
 - lib/pact_broker/db/data_migrations/create_branches.rb
@@ -1295,7 +1292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: See description
 test_files: []