pact_broker 2.115.0 → 2.117.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d60c3b6a432bf6499e5167d6c1b06a6799ef58fb3cf5464000ebe6712352653
-  data.tar.gz: e8b326e736249b6de4cf47baca16f0551e4a45de24d61a9839ba91b077577959
+  metadata.gz: 66a321653a387b5b79c1929494938563e608901abf69bdf97c99062e6b97570d
+  data.tar.gz: b3b33dee60c7a5cdf1ad8471929821ad4f5c8ee07c9c8e54d147c0cc590b7492
 SHA512:
-  metadata.gz: b1973fc6c1f1b44ab6fa5ea7c7986cb588f7e69cd6bc3a25c5abca52675c5cfeb453c1ee2db261ebeb4d53ffdf5d6d7e4985010c7a89dc8a162521f13728af3e
-  data.tar.gz: 06c0d372bc3f97fa958d74e064033d89e3dd096a835290c44c59fa7b7331deeb2b50653b5b4be23f194db933250520696feba15b8e24bac5ef3669ca53f52289
+  metadata.gz: afb8062161928832aa645ca3f9b611e7d5969a7ee23de3987f3c4eda24f0efe4bfd0a393894225ac1836e4da4bee4d05fe3d3ada1f898292e3269ca8259e8675
+  data.tar.gz: 80da5823d947745d6c165bd744693886e8e744f32bbe218bd2fe61b328b0bcd95712c8f7140cdc6ce73db6293e3c6ebfdb3ed5d229a704b6299c188806d95b9e

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+<a name="v2.117.0"></a>
+### v2.117.0 (2025-10-28)
+
+#### Features
+
+* add provider pacts by branch endpoints	 ([0ccff2ec](/../../commit/0ccff2ec))
+* PACT-4511/updated matrix decorator to return app instance for an env if present (#838)	 ([8bc24e72](/../../commit/8bc24e72))
+* support provider states by branch/env	 ([f4db396f](/../../commit/f4db396f))
+
+#### Bug Fixes
+
+* update hal relations for provider pacts	 ([b6e8e8e3](/../../commit/b6e8e8e3))
+* drop pact-support pin	 ([3c7eb4c5](/../../commit/3c7eb4c5))
+* fixed the text fixtures (#826)	 ([28035c27](/../../commit/28035c27))
+
+* **test**
+  * update expectation of webhook_certificates source format dependant on rb version	 ([5364c1b1](/../../commit/5364c1b1))
+
+* **deps**
+  * add mutex_m/csv/ostruct/pstore	 ([075d2522](/../../commit/075d2522))
+
+<a name="v2.116.0"></a>
+### v2.116.0 (2025-07-04)
+
+#### Features
+
+* render sync messages	 ([c0ad9f5b](/../../commit/c0ad9f5b))
+* render async messages mixed v4 and v3	 ([d727d950](/../../commit/d727d950))
+* add deployed-environments to pacticipant response and tag versions (#804)	 ([d8c7ee65](/../../commit/d8c7ee65))
+* show deployed-environments in branch versions response (#803)	 ([cc346010](/../../commit/cc346010))
+* add tag_versions endpoint	 ([42bf5203](/../../commit/42bf5203))
+* added deployed-environments to `/parcticipants/$name/versions` abd (#801)	 ([af66f6a3](/../../commit/af66f6a3))
+
+#### Bug Fixes
+
+* rubocop errors	 ([e311422c](/../../commit/e311422c))
+* refactored long consumer_contract method	 ([7d8af4d5](/../../commit/7d8af4d5))
+* remove unsupported Pact::Term from test example	 ([1a4056bd](/../../commit/1a4056bd))
+* rename interaction_async.erb filename	 ([77ddcb59](/../../commit/77ddcb59))
+* refactored the query to filter out duplicate integration rows (#806)	 ([7bff0f0d](/../../commit/7bff0f0d))
+
 <a name="v2.115.0"></a>
 ### v2.115.0 (2025-03-17)
 

data/Gemfile

@@ -3,12 +3,13 @@ source "https://rubygems.org"
 gemspec
 
 
-gem "rake", "~>13.0"
+gem "rake", "~> 13.3"
 gem "sqlite3", ">=2.0.0"
 gem "conventional-changelog", "~>1.3"
 gem "bump", "~> 0.5"
 gem "padrino-core", ">= 0.16.0.pre3", require: false
 gem "rackup", "~> 2.2"
+gem "thor", "~> 1.4" # thor is secondary dependency but bumping here to avoid CVEs
 
 group :development do
   gem "pry-byebug"
@@ -33,11 +34,11 @@ group :test do
   gem "approvals", ">=0.0.24", "<1.0.0"
   gem "tzinfo", "~>2.0"
   gem "faraday-retry", "~>2.0"
-  gem "openapi_first", ">= 2.3", "< 3"
+  gem "openapi_first", "~>2.0"
 end
 
 group :pg, optional: true do
-  gem "pg", "~>1.2"
+  gem "pg", "~>1.6"
 end
 
 group :mysql, optional: true do

data/lib/pact/doc/interaction_view_model.rb

@@ -70,7 +70,12 @@ module Pact
       end
 
       def request
-        fix_json_formatting JSON.pretty_generate(clean_request)
+        the_clean_request = clean_request
+        if the_clean_request == "ASYNC_REQUEST"
+          "ASYNC_REQUEST"
+        else  
+          fix_json_formatting JSON.pretty_generate(clean_request)
+        end
       end
 
       def response
@@ -82,14 +87,29 @@ module Pact
       attr_reader :interaction, :consumer_contract
 
       def clean_request
-        reified_request = Reification.from_term(interaction.request)
-        ordered_clean_hash(reified_request).tap do | hash |
-          hash[:body] = reified_request[:body] if reified_request[:body]
+        reified = Reification.from_term(interaction.request)
+        return "ASYNC_REQUEST" if reified[:method] == "FAKE_ASYNC_METHOD"
+
+        ordered = ordered_clean_hash(reified).tap do |h|
+          h[:body] = reified[:body] if reified[:body]
         end
+
+        return ordered[:body].to_h.slice("contents", "metadata") if ordered[:method] == "FAKE_SYNC_METHOD"
+
+        ordered
       end
 
       def clean_response
-        ordered_clean_hash Reification.from_term(interaction.response)
+        raw = Reification.from_term(interaction.response)
+
+        case raw[:status]
+        when "FAKE_ASYNC_METHOD"
+          raw[:body] || {}
+        when "FAKE_SYNC_METHOD"
+          Array(raw.dig(:body, "contents")).map { |item| item.slice("contents", "metadata") }
+        else
+          ordered_clean_hash(raw)
+        end
       end
 
       # Remove empty body and headers hashes from response, and empty headers from request,

data/lib/pact/doc/markdown/interaction_async.erb

@@ -0,0 +1,10 @@
+<a name="<%= interaction.id %>"></a><% formatted_provider_states = h(interaction.formatted_provider_states mark_bold: true) %>
+<%= if !formatted_provider_states.empty?
+  "Given #{formatted_provider_states}"
+   end
+%>
+
+<%= h(interaction.provider_name) %> will **asyncronously** send **<%= h(interaction.description) %>**:
+```json
+<%= interaction.response %>
+```

data/lib/pact/doc/markdown/interaction_renderer.rb

@@ -19,7 +19,11 @@ module Pact
         end
 
         def render_full_interaction
-          render("/interaction.erb")
+          if interaction.request == "ASYNC_REQUEST"
+            render("/interaction_async.erb")
+          else
+            render("/interaction.erb")
+          end
         end
 
         def render template_file

data/lib/pact_broker/api/contracts/dry_validation_errors_formatter.rb

@@ -41,6 +41,9 @@ module PactBroker
             add_error(errors_hash, error.path.first, "#{error.path.last} #{error.text} (at index #{error.path[1]})")
           elsif error_path_classes == [Symbol, Integer]
             add_error(errors_hash, error.path.first, "#{error.text} (at index #{error.path[1]})")
+          elsif error_path_classes == [Symbol, Symbol, Integer]
+            # this should be refactored to dynamically handle patterns instead of hardcoding the patterns
+            add_error(errors_hash, error.path.first, "#{error.path[1]} #{error.text} (at index #{error.path[2]})")
           else
             # Don't have any usecases for this - will deal with it when it happens
             raise PactBroker::Error, "Cannot currently format an error message with path classes #{error_path_classes}"

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

@@ -36,6 +36,13 @@ module PactBroker
             href: group_url(represented.consumer.name, options.fetch(:base_url))
           }
         end
+
+        link "pb:delete_integration" do | options |
+          {
+            title: "Delete the integration between #{represented.consumer.name} and #{represented.provider.name}",
+            href: integration_url(represented.consumer.name, represented.provider.name, options.fetch(:base_url))
+          }
+        end
       end
     end
   end

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

@@ -43,6 +43,17 @@ module PactBroker
           pacticipant_branches_url(represented, options[:base_url])
         end
 
+        links :'pb:deployed-environments' do | context |
+          context[:deployed_versions]&.collect do | deployed_version |
+            {
+              title: "Version deployed to #{deployed_version.environment.display_name}",
+              name: deployed_version.environment.display_name,
+              href: deployed_version_url(deployed_version, context.fetch(:base_url)),
+              currently_deployed: deployed_version.currently_deployed
+            }
+          end
+        end
+
         link :'pb:version' do | options |
           {
             title: "Get, create or delete a pacticipant version",

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

@@ -73,6 +73,22 @@ module PactBroker
           end
         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]
+          deployed_versions&.collect do | deployed_version |
+            {
+              title: "Version deployed to #{deployed_version.environment.display_name}",
+              name: deployed_version.environment.display_name,
+              href: deployed_version_url(deployed_version, context.fetch(:base_url)),
+              currently_deployed: deployed_version.currently_deployed
+            }.tap do |hash|
+              hash[:application_instance] = deployed_version.application_instance unless deployed_version.application_instance.nil?
+            end
+          end
+        end
+
         links :'pb:record-deployment' do | context |
           context[:environments]&.collect do | environment |
             {

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -414,6 +414,10 @@ module PactBroker
         end
       end
 
+      def tag_versions_url(tag, base_url = "")
+        "#{pacticipant_url(base_url, tag.pacticipant)}/tags/#{tag.name}/versions"
+      end
+
       private
 
       def representable_pact pact

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -195,12 +195,66 @@ module PactBroker
         end
 
         def consumer_contract
-          Pact::ConsumerContract.from_json(@json_content)
+          pact_object = JSON.parse(@json_content, quirks_mode: true)
+          convert_v3_messages_to_interactions(pact_object)
+
+          pact_object["interactions"]&.each do |interaction|
+            add_dummy_html_request_response_to_asynchronous_message(interaction)
+            add_dummy_html_request_response_to_synchronous_message(interaction)
+          end
+
+          new_json_content = pact_object.to_json  
+
+          Pact::ConsumerContract.from_json(new_json_content)
         rescue => e
           logger.info "Could not parse the following content to a Pact due to #{e.class} #{e.message}, showing raw content instead: #{@json_content}"
           raise NotAPactError
         end
 
+        def convert_v3_messages_to_interactions(pact_object)
+          return unless pact_object.key?("messages")
+
+          logger.warn "Detected a v3 Pact, converting 'messages' to 'interactions'."
+          pact_object["interactions"] = pact_object.delete("messages")
+        end        
+
+        def add_dummy_html_request_response_to_asynchronous_message(interaction)
+          if !interaction["request"] || !interaction["response"]
+            logger.warn "Interaction '#{interaction['description']}' does not have a request or response, adding dummy request and response so that they can be parsed and appear on the UI."
+          end
+
+          interaction["request"] ||= {
+            method: "FAKE_ASYNC_METHOD",
+            path: interaction["description"]
+          }
+
+          unless interaction.key?("response")
+            interaction["response"] = {
+              status: "FAKE_ASYNC_METHOD",
+              body: {
+                contents: interaction.delete("contents"),
+                metadata: interaction.delete("metadata")
+              }
+            }
+          end      
+        end
+
+        def add_dummy_html_request_response_to_synchronous_message(interaction)
+          if interaction["type"] == "Synchronous/Messages"
+            interaction["request"] = {
+              method: "FAKE_SYNC_METHOD",
+              path: interaction["description"],
+              body: interaction.delete("request"),
+            }
+            interaction["response"] = {
+              status: "FAKE_SYNC_METHOD",
+              body: {
+                contents: interaction.delete("response"),
+              }              
+            }              
+          end    
+        end
+
         def h string
           Rack::Utils.escape_html(string)
         end

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

@@ -27,13 +27,17 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(resource_title: resource_title)))
+          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(resource_title: resource_title, deployed_versions: deployed_versions)))
         end
 
         def versions
           @versions ||= version_service.find_pacticipant_versions_in_reverse_order(pacticipant_name, { branch_name: identifier_from_path[:branch_name] }, pagination_options, decorator_class(:versions_decorator).eager_load_associations)
         end
 
+        def deployed_versions
+          @deployed_versions ||= deployed_version_service.find_deployed_versions_for_versions(versions)
+        end
+
         def policy_name
           :'versions::versions'
         end

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

@@ -49,6 +49,54 @@ module PactBroker
               title: "All versions of a pact for a given consumer, provider and consumer version tag",
               templated: false
             },
+            "pb:branch-pact-versions" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/consumer/{consumer}/branch/{branch}",
+              title: "All versions of pacts for a provider, for a named consumers branch",
+              templated: true
+            },
+            "pb:latest-branch-pact-versions" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/consumer/{consumer}/branch/{branch}/latest",
+              title: "Latest version of pact for a provider, for a named consumers branch",
+              templated: true
+            },
+            "pb:main-branch-pact-versions" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/consumer/{consumer}/branch",
+              title: "All versions of pacts for a provider, for a named consumers main branch",
+              templated: true
+            },
+            "pb:latest-main-branch-pact-versions" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/consumer/{consumer}/branch/latest",
+              title: "Latest version of pact for a provider, for a named consumers main branch",
+              templated: true
+            },
+            "pb:provider-pacts-with-main-branch" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/branch",
+              title: "All pacts for a provider, for any consumers main branch",
+              templated: true
+            },
+            "pb:provider-pacts-with-branch" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/branch/{branch}",
+              title: "All pacts for a provider, for any consumers named branch",
+              templated: true
+            },
+            "pb:latest-provider-pacts-with-main-branch" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/branch/latest",
+              title: "Latest pact for a provider, for any consumers main branch",
+              templated: true
+            },
+            "pb:latest-provider-pacts-with-branch" =>
+            {
+              href: base_url + "/pacts/provider/{provider}/branch/{branch}/latest",
+              title: "Latest pacts for a provider, for any consumers named branch",
+              templated: true
+            },
             "pb:pacticipants" =>
             {
               href: base_url + "/pacticipants",

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

@@ -0,0 +1,26 @@
+require "pact_broker/api/resources/provider_pacts"
+require "pact_broker/configuration"
+require "pact_broker/api/decorators/provider_pacts_decorator"
+
+module PactBroker
+  module Api
+    module Resources
+      class LatestProviderPactsForBranch < ProviderPacts
+        private
+
+        def pacts
+          pact_service.find_latest_pacts_for_provider_by_consumer_branch(
+          provider_name, 
+          branch_name: identifier_from_path[:branch_name], 
+          main_branch: identifier_from_path[:branch_name].nil?,
+          )
+        end
+
+        def resource_title
+          suffix = identifier_from_path[:branch_name] ? " with consumer version branch '#{identifier_from_path[:branch_name]}'" : ""
+          "Latest pact versions for the provider #{identifier_from_path[:provider_name]}#{suffix}#{!!identifier_from_path[:main_branch] ? ' for main branch' : ''}"
+        end
+      end
+    end
+  end
+end

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

@@ -14,13 +14,27 @@ module PactBroker
         end
 
         def allowed_methods
-          ["DELETE", "OPTIONS"]
+          ["GET", "DELETE", "OPTIONS"]
         end
 
         def resource_exists?
           consumer && provider
         end
 
+        def to_json
+          decorator_class(:pact_versions_decorator).new(pacts).to_json(**decorator_options(identifier_from_path))
+        end
+
+        def pacts
+          @pacts ||= pact_service.find_pacts_for_provider_and_consumer_by_consumer_branch(
+            provider_name,
+            consumer_name,
+            branch_name: identifier_from_path[:branch_name],
+            main_branch: identifier_from_path[:branch_name].nil?,
+            latest: identifier_from_path[:resource_name] == "latest_pact_publications_for_main_branch" || identifier_from_path[:resource_name] == "latest_pact_publications_for_branch"
+          )
+        end
+
         def delete_resource
           pact_service.delete_all_pact_publications_between consumer_name, and: provider_name, branch_name: identifier_from_path[:branch_name]
           set_post_deletion_response

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

@@ -71,7 +71,12 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pacticipant_decorator).new(pacticipant).to_json(**decorator_options)
+          decorator_class(:pacticipant_decorator).new(pacticipant)
+            .to_json(**decorator_options(deployed_versions: deployed_versions))
+        end
+
+        def deployed_versions
+          @deployed_versions ||= deployed_version_service.find_all_deployed_versions_for_pacticipant(pacticipant)
         end
 
         def parsed_pacticipant(pacticipant)

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

@@ -0,0 +1,47 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/configuration"
+require "pact_broker/api/decorators/provider_pacts_decorator"
+
+module PactBroker
+  module Api
+    module Resources
+      class ProviderPactsForConsumerBranch < BaseResource
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        def resource_exists?
+          !!provider
+        end
+
+        def policy_name
+          :'pacts::provider_pacts'
+        end
+
+        def to_json
+          decorator_class(:provider_pacts_decorator).new(pacts).to_json(**decorator_options(identifier_from_path.merge(title: resource_title)))
+        end
+
+        private
+
+        def pacts
+          pact_service.find_pacts_for_provider_by_consumer_branch(
+          provider_name, 
+          branch_name: identifier_from_path[:branch_name], 
+          main_branch: identifier_from_path[:branch_name].nil?,
+          )
+        end
+
+        def resource_title
+          suffix = identifier_from_path[:branch_name] ? " with consumer version branch '#{identifier_from_path[:branch_name]}'" : ""
+          "All pact versions for the provider #{identifier_from_path[:provider_name]}#{suffix}#{!!identifier_from_path[:main_branch] ? ' for main branch' : ''}"
+        end
+      end
+    end
+  end
+end

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

@@ -25,12 +25,18 @@ module PactBroker
           :'pacts::pact'
         end
 
-        private
+        def environment_uuid
+          identifier_from_path[:environment_uuid]
+        end
 
-        # attr_reader :provider_states
+        def branch_name
+          identifier_from_path[:branch_name]
+        end
+
+        private
 
         def provider_states
-          @provider_states ||= provider_state_service.list_provider_states(provider)
+          @provider_states ||= provider_state_service.list_provider_states(provider, branch_name, environment_uuid)
         end
       end
     end

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

@@ -0,0 +1,58 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/decorators/versions_decorator"
+require "pact_broker/api/resources/pagination_methods"
+
+module PactBroker
+  module Api
+    module Resources
+      class TagVersions < BaseResource
+        include PactBroker::Api::Resources::PaginationMethods
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        def malformed_request?
+          super || request.get? && validation_errors_for_schema?(schema, request.query)
+        end
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def policy_name
+          :'versions::versions'
+        end
+
+        def resource_exists?
+          !tags.empty?
+        end
+
+        def to_json
+          decorator_class(:versions_decorator).new(tag_versions)
+            .to_json(**decorator_options(deployed_versions: deployed_versions))
+        end
+
+        private
+
+        def deployed_versions
+          @deployed_versions ||= deployed_version_service.find_deployed_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
+
+        def tags
+          @tags ||= tag_service.find_all_by_pacticipant_name_and_tag(**identifier_from_path.slice(:pacticipant_name, :tag_name))
+        end
+
+        def schema
+          if request.get?
+            PactBroker::Api::Contracts::PaginationQueryParamsSchema
+          end
+        end
+      end
+    end
+  end
+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))
+          decorator_class(:version_decorator).new(version).to_json(**decorator_options(environments: environments, deployed_versions: deployed_versions))
         end
 
         def delete_resource
@@ -83,6 +83,10 @@ module PactBroker
           @environments ||= environment_service.find_for_pacticipant(version.pacticipant)
         end
 
+        def deployed_versions
+          @deployed_versions ||= deployed_version_service.find_deployed_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,13 +27,17 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path))
+          decorator_class(:versions_decorator).new(versions).to_json(**decorator_options(identifier_from_path.merge(deployed_versions: deployed_versions)))
         end
 
         def versions
           @versions ||= version_service.find_pacticipant_versions_in_reverse_order(pacticipant_name, {}, pagination_options, decorator_class(:versions_decorator).eager_load_associations)
         end
 
+        def deployed_versions
+          @deployed_versions ||= deployed_version_service.find_deployed_versions_for_versions(versions)
+        end
+
         def policy_name
           :'versions::versions'
         end