pact_broker 2.97.0 → 2.98.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a4c440061063f19b90c35a0d680f6d2a9802df42e3b4fc4b93031a6e8efb72
-  data.tar.gz: 7e4acbf7aab9709d30db431a1fc2cee5048934f17170b76f5788ad9db9115e72
+  metadata.gz: d9aac85ace2c0ba5eaacc6fe462dbe4fc3d7623414f13a9bf351bc70d7a8b37f
+  data.tar.gz: 8bae3685f8b675c447aa986c0629875dad4e5e5e614411dea6ca75d77ed0918d
 SHA512:
-  metadata.gz: c06b5cc6227a1141d5e5ccd02701096b4987d26860baf8836431317a26f7809fddefb41c355115bd485a39f8f44eee94884f164c36b7c8bbfacbaf0e62bd1e49
-  data.tar.gz: 0c55019fbfb51cdb54bdc23896164a17621b927fed18eb5807cf5c4392723ec052baaff6aeabf61ed887e910eccd18afde0b7511349b2475b5cd3ec42ca4d4f6
+  metadata.gz: d2249bef385597430fa0f9c296a4b83e489a71dc027b681f60c57e82efe6805403ae9054d996afeb2a65c20fa7f363e868dd754b4a589249c7a639e86b616c9d
+  data.tar.gz: 60605b088a39d895374fc10028525b012b7d3a33579ade4f9f3c9119b014fbbf7857a18bb2f09147c65059d35f37a0858fcd126a408ba010dbd1c82ccc7e7788

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+<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,17 @@ 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.
+
+**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
@@ -422,8 +433,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 +445,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"
 
 ```
 
-**Supported versions:** From v2.90.0<br/>
+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 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/>
 

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!

data/lib/pact_broker/version.rb

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

metadata

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