pact_broker 2.68.1 → 2.73.0

data/lib/pact/doc/interaction_view_model.rb

@@ -8,6 +8,8 @@ module Pact
 
       include Pact::ActiveSupportSupport
 
+      MARKDOWN_BOLD_CHARACTERS = '**'
+
       def initialize interaction, consumer_contract
         @interaction = interaction
         @consumer_contract = consumer_contract
@@ -52,6 +54,16 @@ module Pact
         markdown_escape apply_capitals(@interaction.provider_state.strip, start_of_sentence)
       end
 
+      def formatted_provider_states mark_bold: false
+        bold_marker = mark_bold ? MARKDOWN_BOLD_CHARACTERS : ''
+
+        (@interaction.provider_states || []).map do |ps| 
+          "#{bold_marker}" \
+          "#{markdown_escape(apply_capitals(ps.name.strip, false))}" \
+          "#{bold_marker}"
+        end.join(' and ')
+      end
+
       def description start_of_sentence = false
         return '' unless @interaction.description
         markdown_escape apply_capitals(@interaction.description.strip, start_of_sentence)

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

@@ -1,6 +1,6 @@
-<a name="<%= interaction.id %>"></a>
-<%= if interaction.has_provider_state?
-  "Given **#{h(interaction.provider_state)}**, upon receiving"
+<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}, upon receiving"
    else
   "Upon receiving"
    end

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

@@ -13,7 +13,8 @@ module Pact
         end
 
         def render_summary
-          suffix = interaction.has_provider_state? ? " given #{h(interaction.provider_state)}" : ""
+          formatted_provider_states = h(interaction.formatted_provider_states)
+          suffix = formatted_provider_states.empty? ? "" : " given #{formatted_provider_states}"
           "* [#{h(interaction.description(true))}](##{interaction.id})#{suffix}\n\n"
         end
 

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

@@ -11,6 +11,14 @@ module PactBroker
           property :name
           property :latest, getter: ->(_) { true }
 
+          link :self do | options |
+            {
+              title: 'Tag',
+              name: represented.name,
+              href: tag_url(options[:base_url], represented)
+            }
+          end
+
           link "pb:latest-pact" do | opts |
             {
               name: "The latest pact with the tag #{represented.name}",
@@ -33,7 +41,7 @@ module PactBroker
 
         def head_tags
           represented.head_tag_names.collect do | tag_name |
-            OpenStruct.new(name: tag_name, pact: represented)
+            OpenStruct.new(name: tag_name, pact: represented, version: represented.consumer_version)
           end
         end
       end

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

@@ -7,6 +7,14 @@ module PactBroker
         class TagDecorator < BaseDecorator
           property :name
           property :latest?, as: :latest
+
+          link :self do | options |
+            {
+              title: 'Tag',
+              name: represented.name,
+              href: tag_url(options[:base_url], represented)
+            }
+          end
         end
 
         collection :provider_version_tags, as: :tags, embedded: true, extend: TagDecorator

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

@@ -76,7 +76,7 @@ module PactBroker
                   href: version_url(base_url, consumer_version)
                 }
               },
-              tags: tags(line.consumer_version_tags)
+              tags: tags(line.consumer_version_tags, base_url)
             },
             _links: {
               self: {
@@ -86,11 +86,16 @@ module PactBroker
           }
         end
 
-        def tags(tags)
+        def tags(tags, base_url)
           tags.collect do | tag |
             {
               name: tag.name,
-              latest: tag.latest?
+              latest: tag.latest?,
+              _links: {
+                self: {
+                  href: tag_url(base_url, tag)
+                }
+              }
             }
           end
         end
@@ -114,7 +119,7 @@ module PactBroker
                   href: version_url(base_url, provider_version)
                 }
               },
-              tags: tags(line.provider_version_tags)
+              tags: tags(line.provider_version_tags, base_url)
             }
           end
 

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

@@ -50,6 +50,14 @@ module PactBroker
           }
         end
 
+        link :'pb:pact-version' do | options |
+          {
+            title: "Pact content version permalink",
+            name: represented.pact_version_sha,
+            href: pact_version_url(represented, options.fetch(:base_url))
+          }
+        end
+
         link :'pb:latest-pact-version' do | options |
           {
             title: "Latest version of this pact",

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

@@ -3,11 +3,8 @@ require_relative 'pact_pacticipant_decorator'
 require_relative 'timestamps'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class TagDecorator < BaseDecorator
 
         property :name

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -75,7 +75,7 @@ module PactBroker
       end
 
       def decode_pact_metadata(metadata)
-        if metadata
+        if metadata && metadata != ''
           begin
             Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
               new_hash[k.to_sym] = v
@@ -116,6 +116,10 @@ module PactBroker
         "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/versions"
       end
 
+      def tagged_pact_versions_url consumer_name, provider_name, tag, base_url = ""
+        "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/tag/#{url_encode(tag)}"
+      end
+
       def integration_url consumer_name, provider_name, base_url = ""
         "#{base_url}/integrations/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
       end
@@ -197,7 +201,7 @@ module PactBroker
       end
 
       def tag_url base_url, tag
-        "#{tags_url(base_url, tag.version)}/#{tag.name}"
+        "#{tags_url(base_url, tag.version)}/#{url_encode(tag.name)}"
       end
 
       def templated_tag_url_for_pacticipant pacticipant_name, base_url = ""

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

@@ -0,0 +1,36 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/db/clean'
+require 'pact_broker/matrix/unresolved_selector'
+
+module PactBroker
+  module Api
+    module Resources
+      class Clean < BaseResource
+        def content_types_accepted
+          [["application/json"]]
+        end
+
+        def content_types_provided
+          [["application/hal+json"]]
+        end
+
+        def allowed_methods
+          ["POST", "OPTIONS"]
+        end
+
+        def process_post
+          keep_selectors = (params[:keep] || []).collect do | hash |
+            PactBroker::Matrix::UnresolvedSelector.new(hash)
+          end
+
+          result = PactBroker::DB::Clean.call(Sequel::Model.db, { keep: keep_selectors })
+          response.body = result.to_json
+        end
+
+        def policy_name
+          :'integrations::clean'
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module PactBroker
         end
 
         def self.log_as_warning?(e)
-          PactBroker.configuration.warning_error_classes.any? { |clazz| e.is_a?(clazz) }
+          PactBroker.configuration.warning_error_classes.any? { |clazz| e.is_a?(clazz) || e.cause&.is_a?(clazz) }
         end
 
         def self.display_message(e, obfuscated_message)

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

@@ -18,7 +18,11 @@ module PactBroker
         end
 
         def to_csv
-          PactBroker::Api::Decorators::RelationshipsCsvDecorator.new(group).to_csv
+          if group
+            PactBroker::Api::Decorators::RelationshipsCsvDecorator.new(group).to_csv
+          else
+            ""
+          end
         end
 
         def policy_name

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

@@ -0,0 +1,23 @@
+require 'pact_broker/hash_refinements'
+
+module PactBroker
+  module Api
+    module Resources
+      module MetadataResourceMethods
+        using PactBroker::HashRefinements
+
+        def pact_params
+          @pact_params ||= PactBroker::Pacts::PactParams.from_request(request, maybe_params_with_consumer_version_number.merge(path_info))
+        end
+
+        def maybe_params_with_consumer_version_number
+          metadata.slice(:consumer_version_number)
+        end
+
+        def metadata
+          @metadata ||= PactBrokerUrls.decode_pact_metadata(identifier_from_path[:metadata])
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ require 'pact_broker/pacts/pact_params'
 require 'pact_broker/api/contracts/put_pact_params_contract'
 require 'pact_broker/webhooks/execution_configuration'
 require 'pact_broker/api/resources/webhook_execution_methods'
+require 'pact_broker/api/resources/pact_resource_methods'
 
 module PactBroker
   module Api
@@ -15,6 +16,7 @@ module PactBroker
       class Pact < BaseResource
         include PacticipantResourceMethods
         include WebhookExecutionMethods
+        include PactResourceMethods
 
         def content_types_provided
           [
@@ -110,19 +112,6 @@ module PactBroker
           @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
         end
 
-        def set_post_deletion_response
-          latest_pact = pact_service.find_latest_pact(pact_params)
-          response_body = { "_links" => { index: { href: base_url } } }
-          if latest_pact
-            response_body["_links"]["pb:latest-pact-version"] = {
-              href: latest_pact_url(base_url, latest_pact),
-              title: "Latest pact"
-            }
-          end
-          response.body = response_body.to_json
-          response.headers["Content-Type" => "application/hal+json;charset=utf-8"]
-        end
-
         def webhook_options
           {
             database_connector: database_connector,

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

@@ -15,7 +15,7 @@ module PactBroker
         end
 
         def resource_exists?
-          consumer && provider
+          pact
         end
 
         def to_text

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

@@ -0,0 +1,23 @@
+module PactBroker
+  module Api
+    module Resources
+      module PactResourceMethods
+        def set_post_deletion_response
+          latest_pact = pact_service.find_latest_pact(
+            consumer_name: pact_params[:consumer_name],
+            provider_name: pact_params[:provider_name]
+          )
+          response_body = { "_links" => { index: { href: base_url } } }
+          if latest_pact
+            response_body["_links"]["pb:latest-pact-version"] = {
+              href: latest_pact_url(base_url, latest_pact),
+              title: "Latest pact"
+            }
+          end
+          response.body = response_body.to_json
+          response.headers["Content-Type" => "application/hal+json;charset=utf-8"]
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,12 @@
 require 'pact_broker/api/resources/pact'
+require 'pact_broker/api/resources/metadata_resource_methods'
 
 module PactBroker
   module Api
     module Resources
       class PactVersion < Pact
+        include MetadataResourceMethods
+
         def allowed_methods
           ["GET", "OPTIONS"]
         end

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

@@ -1,11 +1,14 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/configuration'
 require 'pact_broker/api/decorators/tagged_pact_versions_decorator'
+require 'pact_broker/api/resources/pact_resource_methods'
 
 module PactBroker
   module Api
     module Resources
       class TaggedPactVersions < BaseResource
+        include PactResourceMethods
+
         def content_types_provided
           [["application/hal+json", :to_json]]
         end
@@ -24,6 +27,7 @@ module PactBroker
 
         def delete_resource
           pact_service.delete_all_pact_publications_between consumer_name, and: provider_name, tag: identifier_from_path[:tag]
+          set_post_deletion_response
           true
         end
 

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

@@ -4,12 +4,14 @@ require 'pact_broker/domain/verification'
 require 'pact_broker/api/contracts/verification_contract'
 require 'pact_broker/api/decorators/verification_decorator'
 require 'pact_broker/api/resources/webhook_execution_methods'
+require 'pact_broker/api/resources/metadata_resource_methods'
 
 module PactBroker
   module Api
     module Resources
       class Verifications < BaseResource
         include WebhookExecutionMethods
+        include MetadataResourceMethods
 
         def content_types_accepted
           [["application/json", :from_json]]
@@ -75,10 +77,6 @@ module PactBroker
           PactBroker::Api::Decorators::VerificationDecorator.new(model)
         end
 
-        def metadata
-          PactBrokerUrls.decode_pact_metadata(identifier_from_path[:metadata])
-        end
-
         def wip?
           metadata[:wip] == 'true'
         end

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

@@ -51,7 +51,7 @@ module PactBroker
         end
 
         def policy_name
-          :'webhooks::webhooks'
+          request.post? ? :'webhooks::webhook' : :'webhooks::webhooks'
         end
 
         private

data/lib/pact_broker/app.rb

@@ -126,6 +126,7 @@ module PactBroker
       PactBroker::DB.validate_connection_config if configuration.validate_database_connection_config
       PactBroker::DB.set_mysql_strict_mode_if_mysql
       PactBroker::DB.connection.extension(:pagination)
+      PactBroker::DB.connection.extension(:statement_timeout)
 
       Sequel.datetime_class = DateTime
       Sequel.database_timezone = :utc # Store all dates in UTC, assume any date without a TZ is UTC

data/lib/pact_broker/configuration.rb

@@ -38,7 +38,8 @@ module PactBroker
       :log_dir,
       :allow_missing_migration_files,
       :auto_migrate_db_data,
-      :use_rack_protection
+      :use_rack_protection,
+      :metrics_sql_statement_timeout
     ]
 
     attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :allow_missing_migration_files, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
@@ -57,6 +58,7 @@ module PactBroker
     attr_reader :api_error_reporters
     attr_reader :custom_logger
     attr_accessor :policy_builder, :policy_scope_builder, :base_resource_class_factory
+    attr_accessor :metrics_sql_statement_timeout
 
     alias_method :policy_finder=, :policy_builder=
     alias_method :policy_scope_finder=, :policy_scope_builder=
@@ -125,7 +127,8 @@ module PactBroker
         require 'pact_broker/api/resources/default_base_resource'
         PactBroker::Api::Resources::DefaultBaseResource
       }
-      config.warning_error_class_names = ['Sequel::ForeignKeyConstraintViolation']
+      config.warning_error_class_names = ['Sequel::ForeignKeyConstraintViolation', 'PG::QueryCanceled']
+      config.metrics_sql_statement_timeout = 30
       config
     end
 
@@ -247,8 +250,13 @@ module PactBroker
 
     def warning_error_classes
       warning_error_class_names.collect do | class_name |
-        Object.const_get(class_name)
-      end
+        begin
+          Object.const_get(class_name)
+        rescue NameError => e
+          logger.warn("Class #{class_name} couldn't be loaded as a warning error class (#{e.class} - #{e.message}). Ignoring.")
+          nil
+        end
+      end.compact
     end
 
     private