pact_broker 2.98.0 → 2.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9aac85ace2c0ba5eaacc6fe462dbe4fc3d7623414f13a9bf351bc70d7a8b37f
-  data.tar.gz: 8bae3685f8b675c447aa986c0629875dad4e5e5e614411dea6ca75d77ed0918d
+  metadata.gz: edd8be1bf717f3b98618f1f585146efa701f4833a9c2d8ba05eb395278bd435c
+  data.tar.gz: 36c07bdd448edd40e623c0976ec65df4c2512ddf73ce400512e27d08f7a086d8
 SHA512:
-  metadata.gz: d2249bef385597430fa0f9c296a4b83e489a71dc027b681f60c57e82efe6805403ae9054d996afeb2a65c20fa7f363e868dd754b4a589249c7a639e86b616c9d
-  data.tar.gz: 60605b088a39d895374fc10028525b012b7d3a33579ade4f9f3c9119b014fbbf7857a18bb2f09147c65059d35f37a0858fcd126a408ba010dbd1c82ccc7e7788
+  metadata.gz: 023ae6605034518c73da217fff6be8c6888bd7d56abcbf11895f18ec3eab9e32775ec574381473e626e1bca75bc3b132fd30fd755157e980d3e16dea9c125f4f
+  data.tar.gz: 67d5dcb38a78a5e590ec961826951e32c4e391ad13eea43fbf57faa48de2c20212397cdb116b93c975ecdb576e7790112e6db16b43ba5c866af4c074c0370cd3

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+<a name="v2.99.0"></a>
+### v2.99.0 (2022-05-13)
+
+#### Features
+
+* remove disable_use_branch_heads_for_latest_branch_pacts feature toggle	 ([5c6f1766](/../../commit/5c6f1766))
+* remove new_wip_calculation feature toggle	 ([add6cb08](/../../commit/add6cb08))
+* timeout long running pact content diff requests (#555)	 ([88abb2cf](/../../commit/88abb2cf))
+* change sql_log_level default from debug to none	 ([9f7aed46](/../../commit/9f7aed46))
+
+#### Bug Fixes
+
+* **ui**
+  * fix unescaped pacticipant name and main branch in details and network pages	 ([b8b1d306](/../../commit/b8b1d306))
+
+* return a 400 when invalid JSON is used to create a version	 ([9af2cfaf](/../../commit/9af2cfaf))
+* only log API requests/responses, not web assets, when http_debug_logging_enabled is true	 ([1f232c08](/../../commit/1f232c08))
+
+* **matrix**
+  * fix performance issue when querying matrix with one selector	 ([3a08d128](/../../commit/3a08d128))
+
+* **pacts for verification**
+  * return the pacts for the branch heads when using the branch selector	 ([6dac495e](/../../commit/6dac495e))
+
 <a name="v2.98.0"></a>
 ### v2.98.0 (2022-03-29)
 

data/docs/CONFIGURATION.md

@@ -57,6 +57,7 @@ While the default is `file` for the Ruby application, it is set to `stdout` on t
 
 Enable this setting to print the entire request and response to the logs at debug level. Used for troubleshooting issues.
 Do not leave this on permanently, as it will have performance and security issues.
+Ensure the application [`log_level`](#log_level) is set to `debug` when this setting is enabled.
 
 **Supported versions:** From v2.98.0<br/>
 **Environment variable name:** `PACT_BROKER_HTTP_DEBUG_LOGGING_ENABLED`<br/>
@@ -156,7 +157,7 @@ To disable noisy SQL query logging when the application `log_level` is set to `d
 
 **Environment variable name:** `PACT_BROKER_SQL_LOG_LEVEL`<br/>
 **YAML configuration key name:** `sql_log_level`<br/>
-**Default:** `debug`<br/>
+**Default:** From 2.99+, the default is `none`. In previous versions, the default is `debug`.<br/>
 **Allowed values:** `none`, `debug`, `info`, `warn`, `error`, `fatal`<br/>
 
 ### sql_log_warn_duration
@@ -654,6 +655,15 @@ with a unique version number.
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://docs.pact.io/versioning<br/>
 
+### pact_content_diff_timeout
+
+The maximum amount of time in seconds to attempt to generate the diff between two pacts before aborting the request. This is required due to performance issues in the underlying diff generation code.
+
+**Supported versions:** From 2.99.0<br/>
+**Environment variable name:** `PACT_BROKER_PACT_CONTENT_DIFF_TIMEOUT`<br/>
+**YAML configuration key name:** `pact_content_diff_timeout`<br/>
+**Default:** `15`<br/>
+
 <br/>
 
 ## Miscellaneous

data/lib/pact_broker/api/middleware/http_debug_logs.rb

@@ -1,10 +1,12 @@
 require "pact_broker/logging"
+require "rack/pact_broker/request_target"
 
 module PactBroker
   module Api
     module Middleware
       class HttpDebugLogs
         include PactBroker::Logging
+        include Rack::PactBroker::RequestTarget
 
         EXCLUDE_HEADERS = ["puma.", "rack.", "pactbroker."]
         RACK_SESSION = "rack.session"
@@ -15,13 +17,17 @@ module PactBroker
         end
 
         def call(env)
-          env_to_log = env.reject { | header, _ | header.start_with?(*EXCLUDE_HEADERS) }
-          env_to_log["rack.session"] = env["rack.session"].to_hash if env["rack.session"]
-          env_to_log["rack.input"] = request_body(env) if env["rack.input"]
-          logger.debug("env", payload: env_to_log)
-          status, headers, body = @app.call(env)
-          logger.debug("response", payload: { "status" => status, "headers" => headers, "body" => body })
-          [status, headers, body]
+          if request_for_api?(env)
+            env_to_log = env.reject { | header, _ | header.start_with?(*EXCLUDE_HEADERS) }
+            env_to_log["rack.session"] = env["rack.session"].to_hash if env["rack.session"]
+            env_to_log["rack.input"] = request_body(env) if env["rack.input"]
+            logger.debug("env", payload: env_to_log)
+            status, headers, body = @app.call(env)
+            logger.debug("response", payload: { "status" => status, "headers" => headers, "body" => body })
+            [status, headers, body]
+          else
+            @app.call(env)
+          end
         end
 
         def request_body(env)

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

@@ -152,6 +152,10 @@ module PactBroker
           @request_body ||= request.body.to_s
         end
 
+        def any_request_body?
+          request_body && request_body.size > 0
+        end
+
         def consumer_name
           identifier_from_path[:consumer_name]
         end

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

@@ -22,7 +22,7 @@ module PactBroker
         end
 
         def policy_name
-          :'pacts::pacts'
+          :'pacts::latest_pacts'
         end
       end
     end

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

@@ -94,14 +94,6 @@ module PactBroker
           :'pacts::pact'
         end
 
-        def policy_pacticipant
-          if resource_exists?
-            consumer
-          else
-            nil
-          end
-        end
-
         private
 
         def pact

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

@@ -1,6 +1,7 @@
 require "pact_broker/api/resources/base_resource"
 require "pact_broker/pacts/pact_params"
 require "pact_broker/pacts/diff"
+require "timeout"
 
 module PactBroker
   module Api
@@ -19,8 +20,12 @@ module PactBroker
         end
 
         def to_text
-          output = PactBroker::Pacts::Diff.new.process pact_params.merge(base_url: base_url), comparison_pact_params, raw: false
-          response.body = output
+          Timeout::timeout(PactBroker.configuration.pact_content_diff_timeout) do
+            output = PactBroker::Pacts::Diff.new.process pact_params.merge(base_url: base_url), comparison_pact_params, raw: false
+            response.body = output
+          end
+        rescue Timeout::Error
+          408
         end
 
         def pact

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

@@ -32,11 +32,7 @@ module PactBroker
         end
 
         def policy_name
-          :'pacts::pacts'
-        end
-
-        def policy_pacticipant
-          consumer
+          :'pacts::pact_versions'
         end
       end
     end

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

@@ -28,11 +28,7 @@ module PactBroker
         end
 
         def policy_name
-          :'pacts::pacts'
-        end
-
-        def policy_pacticipant
-          consumer
+          :'pacts::pact_versions'
         end
       end
     end

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

@@ -20,7 +20,7 @@ module PactBroker
         end
 
         def policy_name
-          :'pacts::pacts'
+          :'pacts::provider_pacts'
         end
 
         def to_json

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

@@ -36,11 +36,7 @@ module PactBroker
         end
 
         def policy_name
-          :'pacts::pacts'
-        end
-
-        def policy_pacticipant
-          consumer
+          :'pacts::pact_versions'
         end
       end
     end

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

@@ -54,10 +54,6 @@ module PactBroker
           :'verifications::verification'
         end
 
-        def policy_pacticipant
-          provider
-        end
-
         private
 
         def verification

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

@@ -62,10 +62,6 @@ module PactBroker
           :'verifications::verifications'
         end
 
-        def policy_pacticipant
-          provider
-        end
-
         private
 
         def pact

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

@@ -25,6 +25,14 @@ module PactBroker
           !!version
         end
 
+        def malformed_request?
+          if request.put? && any_request_body?
+            invalid_json?
+          else
+            false
+          end
+        end
+
         def from_json
           if request.really_put?
             handle_request do

data/lib/pact_broker/config/runtime_configuration.rb

@@ -71,7 +71,8 @@ module PactBroker
         badge_provider_mode: :redirect,
         enable_public_badge_access: false,
         shields_io_base_url: "https://img.shields.io",
-        use_case_sensitive_resource_names: true
+        use_case_sensitive_resource_names: true,
+        pact_content_diff_timeout: 15
       )
 
       # domain attributes

data/lib/pact_broker/config/runtime_configuration_database_methods.rb

@@ -16,7 +16,7 @@ module PactBroker
             database_port: nil,
             database_url: nil,
             database_sslmode: nil,
-            sql_log_level: :debug,
+            sql_log_level: :none,
             sql_log_warn_duration: 5,
             sql_enable_caller_logging: false,
             database_max_connections: nil,

data/lib/pact_broker/matrix/every_row.rb

@@ -17,15 +17,19 @@ module PactBroker
         Sequel[:p][:created_at].as(:consumer_version_created_at),
         Sequel[:p][:id].as(:pact_order)
       ]
+
       VERIFICATION_COLUMNS = [
         Sequel[:v][:id].as(:verification_id),
         Sequel[:v][:provider_version_id],
         Sequel[:v][:created_at].as(:provider_version_created_at)
       ]
 
+      JOINED_VERIFICATION_COLUMNS = [:id, :pact_version_id, :provider_id, :provider_version_id, :created_at]
+
       ALL_COLUMNS = PACT_COLUMNS + VERIFICATION_COLUMNS
 
       SELECT_ALL_COLUMN_ARGS = [:select_all_columns] + ALL_COLUMNS
+
       dataset_module do
         select(*SELECT_ALL_COLUMN_ARGS)
 
@@ -33,9 +37,23 @@ module PactBroker
           left_outer_join(:verifications, P_V_JOIN, { table_alias: :v } )
         end
 
+        def inner_join_verifications
+          join(:verifications, P_V_JOIN, { table_alias: :v } )
+        end
+
+        def inner_join_verifications_matching_one_selector_provider_or_provider_version(query_ids)
+          verifications = db[:verifications]
+            .select(*JOINED_VERIFICATION_COLUMNS)
+            .where {
+              QueryBuilder.provider_or_provider_version_matches(query_ids)
+            }
+
+          join(verifications, P_V_JOIN, { table_alias: :v } )
+        end
+
         def verifications_for(query_ids)
           db[:verifications]
-            .select(:id, :pact_version_id, :provider_id, :provider_version_id, :created_at)
+            .select(*JOINED_VERIFICATION_COLUMNS)
             .where {
               Sequel.&(
                 QueryBuilder.consumer_in_pacticipant_ids(query_ids),

data/lib/pact_broker/matrix/integration.rb

@@ -1,9 +1,9 @@
-
 # Represents the integration relationship between a consumer and a provider in the context
 # of a matrix or can-i-deploy query.
-# If the required flag is set, then one of the pacticipants (consumers) specified in the HTTP query
-# requires the provider. It would not be required if a provider was specified, and it had an
-# integration with a consumer.
+# If the required flag is set, then one of the pacticipants specified in the matrix query
+# is a consumer and it requires the provider to be already deployed. An integration would not be required if a provider
+# was specified, and it had an integration with a consumer, but that consumer wasn't deployed yet.
+#
 
 module PactBroker
   module Matrix
@@ -11,7 +11,7 @@ module PactBroker
 
       attr_reader :consumer_name, :consumer_id, :provider_name, :provider_id
 
-      def initialize consumer_id, consumer_name, provider_id, provider_name, required
+      def initialize(consumer_id, consumer_name, provider_id, provider_name, required)
         @consumer_id = consumer_id
         @consumer_name = consumer_name
         @provider_id = provider_id

data/lib/pact_broker/matrix/quick_row.rb

@@ -11,6 +11,14 @@ require "pact_broker/pacts/pact_publication"
 require "pact_broker/tags/tag_with_latest_flag"
 require "pact_broker/matrix/query_ids"
 
+# The PactBroker::Matrix::QuickRow represents a row in the table that is created when
+# the consumer versions are joined to the provider versions via the pacts and verifications tables,
+# aka "The Matrix". The difference between this class and the EveryRow class is that
+# the EveryRow class includes results for overridden pact verisons and verifications (used only when there is no latestby
+# set in the matrix query), where as the QuickRow class does not.
+# It is called the QuickRow because the initial implementation was called the Row, and this is an optimised
+# version. It needs to be renamed back to Row now that the old Row class has been deleted.
+
 # The difference between `join_verifications_for` and `join_verifications` is that
 # the left outer join is done on a pre-filtered dataset in `join_verifications_for`,
 # so that we get a row with null verification fields for a pact that has been verified
@@ -19,6 +27,7 @@ require "pact_broker/matrix/query_ids"
 
 module PactBroker
   module Matrix
+    # TODO rename this to just Row
     # rubocop: disable Metrics/ClassLength
     class QuickRow < Sequel::Model(Sequel.as(:latest_pact_publication_ids_for_consumer_versions, :p))
 
@@ -45,6 +54,15 @@ module PactBroker
         Sequel[:v][:verification_id],
         Sequel[:v][:created_at].as(:provider_version_created_at)
       ]
+
+      JOINED_VERIFICATION_COLUMNS = [
+        :verification_id,
+        :provider_version_id,
+        :pact_version_id,
+        :provider_id,
+        :created_at
+      ]
+
       LAST_ACTION_DATE = Sequel.lit("CASE WHEN (provider_version_created_at IS NOT NULL AND provider_version_created_at > consumer_version_created_at) THEN provider_version_created_at ELSE consumer_version_created_at END").as(:last_action_date)
 
       ALL_COLUMNS = PACT_COLUMNS + VERIFICATION_COLUMNS
@@ -146,10 +164,15 @@ module PactBroker
         # When we have one selector, we need to join ALL the verifications to find out
         # what integrations exist
         def matching_one_selector(selectors)
-          join_verifications
+          query_ids = QueryIds.from_selectors(selectors)
+          rows_where_selector_matches_consumer_cols = join_verifications
             .where {
-              QueryBuilder.consumer_or_consumer_version_or_provider_or_provider_or_provider_version_match(QueryIds.from_selectors(selectors), :p, :v)
+              QueryBuilder.consumer_or_consumer_version_matches(query_ids, :p)
             }
+
+          rows_where_selector_matches_provider_cols = inner_join_verifications_matching_one_selector_provider_or_provider_version(query_ids)
+
+          rows_where_selector_matches_consumer_cols.union(rows_where_selector_matches_provider_cols)
         end
 
         def pacticipant_ids_matching_one_selector_optimised(selectors)
@@ -229,9 +252,19 @@ module PactBroker
           left_outer_join(verifications_for(query_ids), LP_LV_JOIN, { table_alias: :v } )
         end
 
+        def inner_join_verifications_matching_one_selector_provider_or_provider_version(query_ids)
+          verifications = db[LV]
+            .select(*JOINED_VERIFICATION_COLUMNS)
+            .where {
+              QueryBuilder.provider_or_provider_version_matches(query_ids)
+            }
+
+          join(verifications, LP_LV_JOIN, { table_alias: :v } )
+        end
+
         def verifications_for(query_ids)
           db[LV]
-            .select(:verification_id, :provider_version_id, :pact_version_id, :provider_id, :created_at)
+            .select(*JOINED_VERIFICATION_COLUMNS)
             .where {
               Sequel.&(
                 QueryBuilder.consumer_in_pacticipant_ids(query_ids),

data/lib/pact_broker/matrix/repository.rb

@@ -123,6 +123,8 @@ module PactBroker
         end
       end
 
+      # Why does the consumer equivalent of this method use the QuickRow distinct_integrations_for_selector_as_consumer
+      # while this method uses the Integration?
       def integrations_where_specified_selector_is_provider(resolved_specified_selectors)
         integrations_involving_specified_providers = PactBroker::Integrations::Integration
                                                       .where(provider_id: resolved_specified_selectors.collect(&:pacticipant_id))

data/lib/pact_broker/pacts/create_formatted_diff.rb

@@ -19,6 +19,7 @@ module PactBroker
         end
 
         difference = diff(previous_pact_hash, pact_hash)
+
         Pact::Matchers::UnixDiffFormatter.call(difference, colour: false, include_explanation: false)
       end
     end

data/lib/pact_broker/pacts/eager_loaders.rb

@@ -32,7 +32,10 @@ module PactBroker
 
           pact_publications.each do | pact_publication |
             pact_publication.consumer_version_tags.collect(&:name).sort.each do | tag_name |
-              pact_publication.associations[:head_pact_publications_for_tags] << head_pact_publications_by_tag[tag_name]
+              # Not sure how this can ever be nil, but a PF error suggests that it has happend. Maybe a timing issue?
+              if head_pact_publications_by_tag[tag_name]
+                pact_publication.associations[:head_pact_publications_for_tags] << head_pact_publications_by_tag[tag_name]
+              end
             end
           end
         end

data/lib/pact_broker/pacts/pact_publication_dataset_module.rb

@@ -111,7 +111,32 @@ module PactBroker
           .limit(1)
       end
 
+      # Return the pacts (if they exist) for the branch heads.
+      # This uses the new logic of finding the branch head and returning any associated pacts,
+      # rather than the old logic of returning the pact for the latest version
+      # on the branch that had a pact.
+      def for_branch_heads(branch_name)
+        branch_head_join = {
+          Sequel[:pact_publications][:consumer_version_id] => Sequel[:branch_heads][:version_id],
+        }
+
+        base_query = self
+        if no_columns_selected?
+          base_query = base_query.select_all_qualified.select_append(Sequel[:branch_heads][:branch_name].as(:branch_name))
+        end
+
+        base_query
+          .join(:branch_heads, branch_head_join) do
+            name_like(Sequel[:branch_heads][:branch_name], branch_name)
+          end
+          .remove_overridden_revisions_from_complete_query
+      end
+
       def latest_for_consumer_branch(branch_name)
+        for_branch_heads(branch_name)
+      end
+
+      def old_latest_for_consumer_branch(branch_name)
         branch_versions_join = {
           Sequel[:pact_publications][:consumer_version_id] => Sequel[:branch_versions][:version_id]
         }

data/lib/pact_broker/pacts/pact_publication_wip_dataset_module.rb

@@ -47,21 +47,6 @@ module PactBroker
       end
 
       def successfully_verified_by_provider_another_tag_before_this_tag_first_created(provider_id, provider_tag)
-        return new_successfully_verified_by_provider_another_tag_before_this_tag_first_created(provider_id, provider_tag) if PactBroker.feature_enabled?(:new_wip_calculation)
-
-        first_tag_with_name = PactBroker::Domain::Tag.where(pacticipant_id: provider_id, name: provider_tag).order(:created_at).first
-        from_self(alias: :pp)
-          .select(Sequel[:pp].*)
-          .where(Sequel[:pp][:provider_id] => provider_id)
-          .join_successful_non_wip_verifications_for_provider_id(provider_id)
-          .join_provider_version_tags do
-            Sequel.lit("provider_tags.name != ?", provider_tag)
-          end
-          .verified_before_creation_date_of(first_tag_with_name)
-          .distinct
-      end
-
-      def new_successfully_verified_by_provider_another_tag_before_this_tag_first_created(provider_id, provider_tag)
         first_tag_with_name = PactBroker::Domain::Tag.where(pacticipant_id: provider_id, name: provider_tag).order(:created_at).first
 
         pact_version_provider_tag_verifications_join = {

data/lib/pact_broker/test/http_test_data_builder.rb

@@ -57,6 +57,8 @@ module PactBroker
 
       def create_version(pacticipant:, version:, branch: nil)
         if branch
+          puts "Adding #{pacticipant} version #{version} to branch #{branch}"
+          puts ""
           client.put("pacticipants/#{encode(pacticipant)}/branches/#{encode(branch)}/versions/#{encode(version)}", {}).tap { |response| check_for_error(response) }
         else
           client.put("pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}").tap { |response| check_for_error(response) }
@@ -80,7 +82,7 @@ module PactBroker
           available_environments = version_body["_links"]["pb:record-deployment"].collect{ | relation | relation["name"]}.join
           puts "Environment with name #{environment_name} not found. Available environments: #{available_environments}"
         else
-          client.post(environment_relation["href"], { replacedPreviousDeployedVersion: true }).tap { |response| check_for_error(response) }
+          client.post(environment_relation["href"]).tap { |response| check_for_error(response) }
         end
 
         separate
@@ -91,7 +93,7 @@ module PactBroker
         puts "Recording release of #{pacticipant} version #{version} to #{environment_name}"
         version_body = client.get("/pacticipants/#{encode(pacticipant)}/versions/#{encode(version)}").tap { |response| check_for_error(response) }.body
         environment_relation = version_body["_links"]["pb:record-release"].find { |relation| relation["name"] == environment_name }
-        client.post(environment_relation["href"], { replacedPreviousDeployedVersion: true }).tap { |response| check_for_error(response) }
+        client.post(environment_relation["href"]).tap { |response| check_for_error(response) }
         separate
         self
       end

data/lib/pact_broker/ui/views/groups/show.html.erb

@@ -6,7 +6,7 @@
 <html lang="en">
 <head>
 <meta charset="utf-8">
-<title><%= pacticipant_name %></title>
+<title><%= escape_html(pacticipant_name) %></title>
 <link rel='shortcut icon' href='<%= base_url %>/favicon.ico' type='image/x-icon'/>
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="description" content="">
@@ -69,7 +69,7 @@ svg{
         Main branch:
       </div>
       <div class="col col-md-6">
-        <%= pacticipant.main_branch %>
+        <%= escape_html(pacticipant.main_branch) %>
       </div>
     </div>
     <div class="row">

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.98.0"
+  VERSION = "2.99.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.98.0
+  version: 2.99.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -1222,7 +1222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: See description