pact_broker 2.123.0 → 2.124.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e464517845e4046dd28826ab16b367d5080b69cb535f9a9d5901feda4f262bd8
-  data.tar.gz: 9959dfb3c78a5e3940a94306133b1e92244a2531cd275f2fb7353c98faa153a8
+  metadata.gz: 3a0262f7dd8bce1f0c350ce3ec9b2b6920e8e36ec672bc34c327cd24adfaaf6a
+  data.tar.gz: b3a306b5074d7370d6693f4c5d4219a0c4a069a304035226eff502d6bd9ed3f6
 SHA512:
-  metadata.gz: cfdf7a02904a49f475cc615a0a097eaa6b2a3d438df70e3523eae4fe29d7eb7052bc211a07bf70446d6ae76941309bc98846c155285d9ce1efae85718d39e94a
-  data.tar.gz: b8dd289895ecf228815e1532d607e15ce7ffd5d41b4ff43f141b2944239aec2f415152189fc73b9aa1725cb4d1dd1ab7a231563bdb0cf576ed4afa53d9067f65
+  metadata.gz: 6d363ce226b34c06e1cf6659d876c4699900598c6df64d9f5bc8c06a5a4b3d514431f4873307d71189fcfd5cd992f8caf582b26af92d2c5bc36cc61ad50a4a17
+  data.tar.gz: dcbce49bf421fb8f0294aba8bdf22be64d49e23f74a671531d9bf802717aefdbc58b154b4bfcc02a84e7fcd00709626e898a492f07c7cdd10e30b3d894398f38

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [2.124.0] _2026-11-11_
+
+### 🚀 Features
+
+-   _(matrix)_ Add matrix_max_limit to cap the matrix query limit
+
+### 🐛 Bug Fixes
+
+-   _(matrix)_ Support an environment in a selector alongside a version or latest
+
 ## [2.123.0] _2026-11-11_
 
 ### 🚀 Features

data/docs/CONFIGURATION.md

@@ -703,6 +703,18 @@ and at large numbers, the graph will not render due to browser performance issue
 **Default:** `150`<br/>
 **Allowed values:** A positive integer<br/>
 
+### matrix_max_limit
+
+The maximum value accepted for the `limit` parameter of a matrix query (`/matrix`).
+A request with a larger `limit` is rejected with a 400 response. Very large limits can cause expensive database queries.
+When not set, there is no maximum. A matrix query without a `limit` uses a limit of 100,
+so the value must be 100 or greater, or the Pact Broker will not start.
+
+**Environment variable name:** `PACT_BROKER_MATRIX_MAX_LIMIT`<br/>
+**YAML configuration key name:** `matrix_max_limit`<br/>
+**Default:** No maximum<br/>
+**Allowed values:** An integer of 100 or greater<br/>
+
 <br/>
 
 ## Miscellaneous

data/lib/pact_broker/config/runtime_configuration.rb

@@ -20,6 +20,7 @@ require "pact_broker/config/runtime_configuration_basic_auth_methods"
 require "pact_broker/string_refinements"
 require "pact_broker/hash_refinements"
 require "pact_broker/error"
+require "pact_broker/matrix/parse_query"
 
 module PactBroker
   module Config
@@ -97,9 +98,12 @@ module PactBroker
         semver_formats: ["%M.%m.%p%s%d", "%M.%m", "%M"],
         seed_example_data: true,
         network_diagram_max_pacticipants: 150,
+        matrix_max_limit: nil,
         features: {}
       )
 
+      on_load :validate_matrix_max_limit!
+
       def self.getter_and_setter_method_names
         extra_methods = [
           :warning_error_classes,
@@ -114,6 +118,7 @@ module PactBroker
       coerce_types(
         features: COERCE_FEATURES,
         network_diagram_max_pacticipants: :integer,
+        matrix_max_limit: :integer,
         webhook_certificates: COERCE_WEBHOOKS
       )
       sensitive_values(:database_url, :database_password)
@@ -226,6 +231,16 @@ module PactBroker
         end
       end
 
+      # A matrix query without a limit gets the default limit, so a lower matrix_max_limit
+      # would reject every request that does not set one.
+      # An empty or non-numeric value is coerced to 0, so it is rejected here too.
+      def validate_matrix_max_limit!
+        default_limit = PactBroker::Matrix::ParseQuery::DEFAULT_LIMIT
+        if matrix_max_limit && matrix_max_limit < default_limit
+          raise_validation_error("matrix_max_limit must be at least the default matrix limit (#{default_limit}), or not set")
+        end
+      end
+
       def raise_validation_error(msg)
         raise PactBroker::ConfigurationError, msg
       end

data/lib/pact_broker/domain/version.rb

@@ -85,20 +85,24 @@ module PactBroker
           # end
         end
 
+        # Filters on a UNION of version ids so the versions dataset stays unwrapped for later criteria.
+        # An OR of two IN subqueries is equivalent, but cannot use the versions primary key index.
         def currently_in_environment(environment_name, pacticipant_name)
-          currently_deployed_to_environment(environment_name, pacticipant_name).union(currently_supported_in_environment(environment_name, pacticipant_name))
+          version_ids = version_ids_currently_deployed_to_environment(environment_name, pacticipant_name)
+                          .union(version_ids_currently_supported_in_environment(environment_name, pacticipant_name), from_self: false)
+          where(Sequel[:versions][:id] => version_ids)
         end
 
-        def currently_deployed_to_environment(environment_name, pacticipant_name)
+        def version_ids_currently_deployed_to_environment(environment_name, pacticipant_name)
           deployed_version_query = PactBroker::Deployments::DeployedVersion.currently_deployed.for_environment_name(environment_name)
           deployed_version_query = deployed_version_query.for_pacticipant_name(pacticipant_name) if pacticipant_name
-          where(id: deployed_version_query.select(:version_id))
+          deployed_version_query.select(:version_id)
         end
 
-        def currently_supported_in_environment(environment_name, pacticipant_name)
+        def version_ids_currently_supported_in_environment(environment_name, pacticipant_name)
           supported_version_query = PactBroker::Deployments::ReleasedVersion.currently_supported.for_environment_name(environment_name)
           supported_version_query = supported_version_query.for_pacticipant_name(pacticipant_name) if pacticipant_name
-          where(id: supported_version_query.select(:version_id))
+          supported_version_query.select(:version_id)
         end
 
         def currently_deployed

data/lib/pact_broker/locale/en.yml

@@ -97,6 +97,7 @@ en:
         cannot_set_currently_deployed_true: The currentlyDeployed property cannot be set back to true. Please record a new deployment.
         cannot_set_currently_supported_true: The currentlySupported property cannot be set back to true. Please record a new deployment.
         invalid_limit: The limit must be 1 or greater.
+        matrix_limit_exceeds_maximum: "The limit must be %{max_limit} or less."
         pacts_for_verification_selector_fallback_tag: "fallbackTag can only be set if latest is true"
         pacts_for_verification_selector_matching_branch_requires_provider_version_branch: the providerVersionBranch must be specified when the selector matchingBranch=true is used
         pacts_for_verification_selector_tag_and_branch_disallowed: "cannot specify both a tag and a branch"

data/lib/pact_broker/matrix/parse_query.rb

@@ -4,6 +4,8 @@ require "pact_broker/matrix/unresolved_selector"
 module PactBroker
   module Matrix
     class ParseQuery
+      DEFAULT_LIMIT = 100
+
       # rubocop: disable Metrics/CyclomaticComplexity
       # rubocop: disable Metrics/MethodLength
       def self.call query
@@ -34,7 +36,7 @@ module PactBroker
         if params.key?("limit") && params["limit"] != ""
           options[:limit] = params["limit"]
         else
-          options[:limit] = "100"
+          options[:limit] = DEFAULT_LIMIT.to_s
         end
 
         if params.key?("latest") && params["latest"] != ""

data/lib/pact_broker/matrix/service.rb

@@ -140,6 +140,11 @@ module PactBroker
           error_messages << message("errors.validation.invalid_limit")
         end
 
+        max_limit = PactBroker.configuration.matrix_max_limit
+        if max_limit && options[:limit] && options[:limit].to_i > max_limit
+          error_messages << message("errors.validation.matrix_limit_exceeds_maximum", max_limit: max_limit)
+        end
+
         error_messages
       end
       # rubocop: enable Metrics/CyclomaticComplexity

data/lib/pact_broker/ui/controllers/can_i_deploy.rb

@@ -18,7 +18,7 @@ module PactBroker
         get "/:pacticipant_name/latest-version/:tag/can-i-deploy/to/:environment_tag" do
           # selector and options must be in sync with lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag_badge.rb
           selectors = [ PactBroker::Matrix::UnresolvedSelector.new(pacticipant_name: params[:pacticipant_name], latest: true, tag: params[:tag]) ]
-          options = { latestby: "cvp", limit: 100, tag: params[:to] }
+          options = { latestby: "cvp", limit: PactBroker::Matrix::ParseQuery::DEFAULT_LIMIT, tag: params[:to] }
           result = matrix_service.find(selectors, options)
           lines = PactBroker::UI::ViewModels::MatrixLines.new(result, base_url: base_url)
           locals = {

data/lib/pact_broker/ui/controllers/matrix.rb

@@ -17,7 +17,7 @@ module PactBroker
 
         get "/" do
           selectors = [OpenStruct.new, OpenStruct.new]
-          options = { limit: 100, latestby: nil }
+          options = { limit: PactBroker::Matrix::ParseQuery::DEFAULT_LIMIT, latestby: nil }
           locals = {
             lines: [],
             selectors: create_selector_objects(selectors),
@@ -50,7 +50,7 @@ module PactBroker
                         PactBroker::Matrix::UnresolvedSelector.new(pacticipant_name: params[:consumer_name]),
                         PactBroker::Matrix::UnresolvedSelector.new(pacticipant_name: params[:provider_name])
                       ]
-          options = { latestby: "cvpv", limit: 100 }
+          options = { latestby: "cvpv", limit: PactBroker::Matrix::ParseQuery::DEFAULT_LIMIT }
           lines = matrix_service.find(selectors, options)
           lines = PactBroker::UI::ViewModels::MatrixLines.new(lines, base_url: base_url)
           locals =  {

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.123.0"
+  VERSION = "2.124.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.123.0
+  version: 2.124.0
 platform: ruby
 authors:
 - Bethany Skurrie