pact_broker 2.97.0 → 2.100.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a4c440061063f19b90c35a0d680f6d2a9802df42e3b4fc4b93031a6e8efb72
-  data.tar.gz: 7e4acbf7aab9709d30db431a1fc2cee5048934f17170b76f5788ad9db9115e72
+  metadata.gz: f22862d2054c07b06fb947f8a1f710dab261ae6ac1207e6a15adebb07dc488db
+  data.tar.gz: 5cc63160ad026673f194af54237080aeb6eb8ab4f9ac93cbe5cd71b63727d60e
 SHA512:
-  metadata.gz: c06b5cc6227a1141d5e5ccd02701096b4987d26860baf8836431317a26f7809fddefb41c355115bd485a39f8f44eee94884f164c36b7c8bbfacbaf0e62bd1e49
-  data.tar.gz: 0c55019fbfb51cdb54bdc23896164a17621b927fed18eb5807cf5c4392723ec052baaff6aeabf61ed887e910eccd18afde0b7511349b2475b5cd3ec42ca4d4f6
+  metadata.gz: 8b6c0cefc1e4847ed53627f0b2aae7cfd5be46e351ce1969f21b80f5f8899990cca3f612d9ab14a82d58c0521b91fb5f5a820f4c7d9e72f17fbc391f1583daff
+  data.tar.gz: 4c1c3fa1a8e983718f1f841c8b17088678c6f4ada22c36b3ededb71a46c2bf004712c4716a8af33c17e068c88b88a6b69f219a286549841c20fa8c79ae41a214

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+<a name="v2.100.0"></a>
+### v2.100.0 (2022-05-20)
+
+#### Features
+
+* check for potential duplicate pacticipants in publish contracts endpoint (#558)	 ([ed714f03](/../../commit/ed714f03))
+* add support for "can i merge" matrix query	 ([bb108ed2](/../../commit/bb108ed2))
+* remove inefficient skynet query for tags	 ([bdc2599c](/../../commit/bdc2599c))
+* update text for matrix version description when no version is in an enviroment	 ([3eb5581d](/../../commit/3eb5581d))
+
+* **pacts for verification**
+  * update wip and pending descriptions for wip pacts	 ([b06d4477](/../../commit/b06d4477))
+
+* **matrix**
+  * add support for selectors specified by branch and environment name when reporting that a version does not exist	 ([07ff8044](/../../commit/07ff8044))
+
+#### Bug Fixes
+
+* **matrix**
+  * identify the correct failed version when a selector resolves to multiple versions	 ([11e7dc1c](/../../commit/11e7dc1c))
+
+<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)
+
+#### Features
+
+* support debug logging of entire request and response	 ([42eb4a17](/../../commit/42eb4a17))
+
 <a name="v2.97.0"></a>
 ### v2.97.0 (2022-03-29)
 

data/docs/CONFIGURATION.md

@@ -53,6 +53,18 @@ While the default is `file` for the Ruby application, it is set to `stdout` on t
 **Default:** `file`<br/>
 **Allowed values:** `stdout`, `file`<br/>
 
+### http_debug_logging_enabled
+
+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/>
+**YAML configuration key name:** `http_debug_logging_enabled`<br/>
+**Default:** `false`<br/>
+**Allowed values:** `true`, `false`<br/>
+
 ### hide_pactflow_messages
 
 Set to `true` to hide the messages in the logs about Pactflow
@@ -145,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
@@ -422,8 +434,6 @@ chain in PEM format, indented by 2 more characters.
 When setting the path, the full path to the certificate file in PEM format must be specified. When using Docker, you must ensure the
 certificate file is [mounted into the container](https://docs.docker.com/storage/volumes/).
 
-*NOTE: USING ENVIRONMENT VARIABLES TO SET THE WEBHOOK CERTIFICATES IS NOT SUPPORTED.*
-
 YAML Example:
 
 ```yaml
@@ -436,11 +446,24 @@ webhook_certificates:
       jHT1Ty2CglM=
       -----END CERTIFICATE-----
   - description: "An example self signed certificate with a path"
-    path: /full/path/to/the/cert.pem
+    path: "/full/path/to/the/cert.pem"
+
+```
 
+Environment variable example:
+
+```shell
+PACT_BROKER_WEBHOOK_CERTIFICATES__0__LABEL="An example self signed certificate with content"
+PACT_BROKER_WEBHOOK_CERTIFICATES__0__CONTENT="-----BEGIN CERTIFICATE-----
+      MIIDZDCCAkygAwIBAgIBATANBgkqhkiG9w0BAQsFADBCMRMwEQYKCZImiZPyLGQB
+      <REST OF CERTIFICATE>
+      jHT1Ty2CglM=
+      -----END CERTIFICATE-----"
+PACT_BROKER_WEBHOOK_CERTIFICATES__1__LABEL="An example self signed certificate with a path"
+PACT_BROKER_WEBHOOK_CERTIFICATES__1__PATH="/full/path/to/the/cert.pem"
 ```
 
-**Supported versions:** From v2.90.0<br/>
+**Supported versions:** From v2.90.0 for YAML and 2.97.0 for environment variables.<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_CERTIFICATES`<br/>
 **YAML configuration key name:** `webhook_certificates`<br/>
 
@@ -632,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/decorators/reason_decorator.rb

@@ -30,7 +30,7 @@ module PactBroker
           when PactBroker::Matrix::PactNotVerifiedByRequiredProviderVersion
             "There is no verified pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description}"
           when PactBroker::Matrix::SpecifiedVersionDoesNotExist
-            version_does_not_exist_description(reason.selector)
+            reason.selector.version_does_not_exist_description
           when PactBroker::Matrix::VerificationFailed
             "The verification for the pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description} failed"
           when PactBroker::Matrix::NoDependenciesMissing
@@ -53,20 +53,6 @@ module PactBroker
           end
         end
 
-        def version_does_not_exist_description selector
-          if selector.version_does_not_exist?
-            if selector.tag
-              "No version with tag #{selector.tag} exists for #{selector.pacticipant_name}"
-            elsif selector.pacticipant_version_number
-              "No pacts or verifications have been published for version #{selector.pacticipant_version_number} of #{selector.pacticipant_name}"
-            else
-              "No pacts or verifications have been published for #{selector.pacticipant_name}"
-            end
-          else
-            ""
-          end
-        end
-
         # TODO move this somewhere else
         def interaction_description(interaction)
           if interaction["providerState"] && interaction["providerState"] != ""

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/deployed_version.rb

@@ -58,11 +58,17 @@ module PactBroker
         end
 
         def policy_name
-          :'versions::version'
+          :'versions::deployed_version'
+        end
+
+        def policy_record_context
+          {
+            pacticipant: deployed_version&.pacticipant
+          }
         end
 
         def policy_record
-          deployed_version&.version
+          deployed_version&.environment
         end
 
         private

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

@@ -40,11 +40,7 @@ module PactBroker
         end
 
         def policy_name
-          :'versions::deployed_version'
-        end
-
-        def policy_record
-          environment
+          :'versions::deployed_versions'
         end
 
         private

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/pacticipant_resource_methods.rb

@@ -1,7 +1,6 @@
 module PactBroker
   module Api
     module Resources
-
       module PacticipantResourceMethods
 
         def potential_duplicate_pacticipants? pacticipant_names

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/publish_contracts.rb

@@ -100,7 +100,7 @@ module PactBroker
         end
 
         def conflict_notices
-          @conflict_notices ||= contract_service.conflict_notices(parsed_contracts)
+          @conflict_notices ||= contract_service.conflict_notices(parsed_contracts, base_url: base_url)
         end
 
         def base64_decode(content)

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

@@ -48,11 +48,17 @@ module PactBroker
         end
 
         def policy_name
-          :'versions::version'
+          :'versions::released_version'
+        end
+
+        def policy_record_context
+          {
+            pacticipant: released_version&.pacticipant
+          }
         end
 
         def policy_record
-          released_version&.version
+          released_version&.environment
         end
 
         private

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

@@ -45,7 +45,7 @@ module PactBroker
         end
 
         def policy_name
-          :'versions::released_version'
+          :'versions::released_versions'
         end
 
         def policy_record

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/app.rb

@@ -29,6 +29,7 @@ require "pact_broker/api/middleware/configuration"
 require "pact_broker/api/middleware/basic_auth"
 require "pact_broker/config/basic_auth_configuration"
 require "pact_broker/api/authorization/resource_access_policy"
+require "pact_broker/api/middleware/http_debug_logs"
 
 module PactBroker
 
@@ -174,6 +175,7 @@ module PactBroker
     end
 
     def configure_middleware
+      @app_builder.use PactBroker::Api::Middleware::HttpDebugLogs if configuration.http_debug_logging_enabled
       configure_basic_auth
       configure_rack_protection
       @app_builder.use Rack::PactBroker::InvalidUriProtection

data/lib/pact_broker/config/runtime_configuration.rb

@@ -39,7 +39,8 @@ module PactBroker
         log_format: nil,
         warning_error_class_names: ["Sequel::ForeignKeyConstraintViolation"],
         hide_pactflow_messages: false,
-        log_configuration_on_startup: true
+        log_configuration_on_startup: true,
+        http_debug_logging_enabled: false
       )
 
       on_load :validate_logging_attributes!
@@ -70,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/contracts/contract_to_publish.rb

@@ -14,6 +14,10 @@ module PactBroker
       def merge?
         on_conflict == "merge"
       end
+
+      def pacticipant_names
+        [consumer_name, provider_name]
+      end
     end
   end
 end

data/lib/pact_broker/contracts/contracts_to_publish.rb

@@ -6,6 +6,10 @@ module PactBroker
         new(pacticipant_name, pacticipant_version_number, tags, branch, build_url, contracts)
       end
       # rubocop: enable Metrics/ParameterLists
+
+      def pacticipant_names
+        contracts.flat_map(&:pacticipant_names).uniq
+      end
     end
   end
 end

data/lib/pact_broker/contracts/service.rb

@@ -43,19 +43,26 @@ module PactBroker
         )
       end
 
-      def conflict_notices(parsed_contracts)
+      def conflict_notices(parsed_contracts, base_url: )
         notices = []
+        add_pact_conflict_notices(notices, parsed_contracts)
+        add_pacticipant_conflict_notices(notices, parsed_contracts, base_url)
+        notices
+      end
+
+      def add_pact_conflict_notices(notices, parsed_contracts)
         parsed_contracts.contracts.collect do | contract_to_publish |
           pact_params = create_pact_params(parsed_contracts, contract_to_publish)
           existing_pact = pact_service.find_pact(pact_params)
           if existing_pact && pact_service.disallowed_modification?(existing_pact, contract_to_publish.decoded_content)
-            add_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_pact.json_content, contract_to_publish.decoded_content)
+            add_pact_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_pact.json_content, contract_to_publish.decoded_content)
           end
         end
-        notices
       end
 
-      def add_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_json_content, new_json_content)
+      private :add_pact_conflict_notices
+
+      def add_pact_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_json_content, new_json_content)
         message_params = {
           consumer_name: contract_to_publish.provider_name,
           consumer_version_number: parsed_contracts.pacticipant_version_number,
@@ -65,7 +72,18 @@ module PactBroker
         notices << Notice.info(PactBroker::Pacts::CreateFormattedDiff.call(new_json_content, existing_json_content))
       end
 
-      private :add_conflict_notice
+      private :add_pact_conflict_notice
+
+      def add_pacticipant_conflict_notices(notices, parsed_contracts, base_url)
+        if PactBroker.configuration.check_for_potential_duplicate_pacticipant_names
+          duplicate_pacticipant_messages = pacticipant_service.messages_for_potential_duplicate_pacticipants(parsed_contracts.pacticipant_names, base_url)
+          duplicate_pacticipant_messages.each do | message_text |
+            notices << Notice.error(message_text)
+          end
+        end
+      end
+
+      private :add_pacticipant_conflict_notices
 
       def create_version(parsed_contracts)
         version_params = {

data/lib/pact_broker/domain/tag.rb

@@ -39,53 +39,28 @@ module PactBroker
         end
 
         def latest_tags
-          self_join = {
-            Sequel[:tags][:pacticipant_id] => Sequel[:tags_2][:pacticipant_id],
-            Sequel[:tags][:name] => Sequel[:tags_2][:name]
-          }
-
-          PactBroker::Domain::Tag
+          Tag
             .select_all_qualified
-            .left_join(:tags, self_join, { table_alias: :tags_2 }) do
-              Sequel[:tags_2][:version_order] > Sequel[:tags][:version_order]
-            end
-            .where(Sequel[:tags_2][:name] => nil)
+            .max_group_by(:version_order, [:pacticipant_id, :name])
         end
 
         # Does NOT care about whether or not there is a pact publication
         # for the version
         def latest_tags_for_pacticipant_ids(pacticipant_ids)
-          self_join = {
-            Sequel[:tags][:pacticipant_id] => Sequel[:tags_2][:pacticipant_id],
-            Sequel[:tags][:name] => Sequel[:tags_2][:name],
-            Sequel[:tags_2][:pacticipant_id] => pacticipant_ids,
-          }
-
           Tag
             .select_all_qualified
-            .left_join(:tags, self_join, { table_alias: :tags_2 }) do
-              Sequel[:tags_2][:version_order] > Sequel[:tags][:version_order]
+            .max_group_by(:version_order, [:pacticipant_id, :name]) do | ds |
+              ds.where(Sequel[:tags][:pacticipant_id] => pacticipant_ids)
             end
-            .where(Sequel[:tags_2][:name] => nil)
-            .where(Sequel[:tags][:pacticipant_id] => pacticipant_ids)
         end
 
         def latest_tags_for_pacticipant_ids_and_tag_names(pacticipant_ids, tag_names)
-          self_join = {
-            Sequel[:tags][:pacticipant_id] => Sequel[:tags_2][:pacticipant_id],
-            Sequel[:tags][:name] => Sequel[:tags_2][:name],
-            Sequel[:tags_2][:pacticipant_id] => pacticipant_ids,
-            Sequel[:tags_2][:name] => tag_names
-          }
-
           Tag
             .select_all_qualified
-            .left_join(:tags, self_join, { table_alias: :tags_2 }) do
-              Sequel[:tags_2][:version_order] > Sequel[:tags][:version_order]
+            .max_group_by(:version_order, [:pacticipant_id, :name]) do | ds |
+              ds.where(Sequel[:tags][:name] => tag_names)
+                .where(Sequel[:tags][:pacticipant_id] => pacticipant_ids)
             end
-            .where(Sequel[:tags_2][:name] => nil)
-            .where(Sequel[:tags][:pacticipant_id] => pacticipant_ids)
-            .where(Sequel[:tags][:name] => tag_names)
         end
 
         # ignores tags that don't have a pact publication
@@ -110,6 +85,7 @@ module PactBroker
             .join(lp, versions_pact_publications_join)
         end
 
+        # TODO convert this to use max and join
         def head_tags_for_pact_publication(pact_publication)
           Tag.where(version_id: pact_publication.consumer_version_id).all.select do | tag |
             tag_pp_join = {