pact_broker 2.57.0 → 2.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1de4cab3f4fb99ade4806255fb8e1ea1745429fdac8302154d092c99c36c7d76
-  data.tar.gz: 910569291d130d66d73b3a557a983ba4563a70ae7d3c581ad9ebc770958ea56e
+  metadata.gz: e9b3ca0a02cb3eb39138704d804ed6a9997aa044cf0729059175d24acf02794f
+  data.tar.gz: 619a828a1ab0f7b1d5677525c5d52b82ec785455a19c0603ce18a3981be81eb7
 SHA512:
-  metadata.gz: 2df74e9cbdfa705a1221f4422fb9dc18e33106b25a68b9b2013f649e8d35ad015b344251d2aacd7e9b22d73d50435eb3cdc2e773843de0b49792859e5daa83c6
-  data.tar.gz: 2f5255f3ba8292bd2df960db95c40b86196872c49f3080afb8cdb398dd96b22022bd6bd28ca73a221881322112fa9f9da6bf9d1b870dba6a59cd286bfb45fbeb
+  metadata.gz: 80e5a6272e05b35ff82a5a08fc26cb8acc2729d64b969f3764dbd1bb6be4ed168722d884ca635fe85dc58946c085dc60d65b1d4c95cc0fc8d9437a9f8aaa3356
+  data.tar.gz: d094ef10bf315a635afd6c6ef52148ac25c2e03afafcbb5e53b411c4ff2e676fd01d9db45414be4354054396547ae182b4991beadf6e6f0de63045cb38b2ccde

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+<a name="v2.58.0"></a>
+### v2.58.0 (2020-06-19)
+
+
+#### Features
+
+* log foreign key constraint errors as warn as 99% of the time they are transitory and unreproducible and should not cause alarms to be raised	 ([71fd0270](/../../commit/71fd0270))
+* use structured logs for logging errors	 ([1e097b37](/../../commit/1e097b37))
+
+
+#### Bug Fixes
+
+* fix: update sanitize gem for CVE-2020-4054	 ([2af4bf9d](/../../commit/2af4bf9d))
+* do not parse the provider version as a semantic version when order_versions_by_date is true	 ([bf30024f](/../../commit/bf30024f))
+
+
 <a name="v2.57.0"></a>
 ### v2.57.0 (2020-06-16)
 

data/example/config.ru

@@ -8,7 +8,7 @@ ENV['RACK_ENV'] ||= 'production'
 
 # Create a real database, and set the credentials for it here
 # It is highly recommended to set the encoding to utf8
-DATABASE_CREDENTIALS = {adapter: "sqlite", database: "pact_broker_database.sqlite3", :encoding => 'utf8'}
+DATABASE_CREDENTIALS = { adapter: "sqlite", database: "pact_broker_database.sqlite3", :encoding => 'utf8', sql_log_level: :debug }
 
 # For postgres:
 #

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

@@ -25,6 +25,8 @@ module PactBroker
             end
 
             def valid_version_number?(value)
+              return true if PactBroker.configuration.order_versions_by_date
+
               parsed_version_number = PactBroker.configuration.version_parser.call(value)
               !!parsed_version_number
             end

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

@@ -8,13 +8,16 @@ module PactBroker
 
         include PactBroker::Logging
 
+        WARNING_ERROR_CLASSES = [Sequel::ForeignKeyConstraintViolation]
+
         def self.call e, request, response
           error_reference = generate_error_reference
-          if reportable?(e)
+          if log_as_warning?(e)
+            logger.warn("Error reference #{error_reference}", e)
+          elsif reportable?(e)
             log_error(e, "Error reference #{error_reference}")
             report(e, error_reference, request)
-          else
-            logger.info "Error reference #{error_reference} - #{e.class} #{e.message}\n#{e.backtrace.join("\n")}"
+            logger.info("Error reference #{error_reference}", e)
           end
           response.body = response_body_hash(e, error_reference).to_json
         end
@@ -27,6 +30,10 @@ module PactBroker
           !e.is_a?(PactBroker::Error) && !e.is_a?(JSON::GeneratorError)
         end
 
+        def self.log_as_warning?(e)
+          WARNING_ERROR_CLASSES.any? { |clazz| e.is_a?(clazz) }
+        end
+
         def self.display_message(e, error_reference)
           if PactBroker.configuration.show_backtrace_in_error_response?
             e.message || obfuscated_error_message(error_reference)

data/lib/pact_broker/db/log_quietener.rb

@@ -9,13 +9,11 @@ require 'delegate'
 module PactBroker
   module DB
     class LogQuietener < SimpleDelegator
-      def info *args
-        __getobj__().debug(*args)
-      end
-
       def error *args
         if error_is_about_table_not_existing?(args)
           __getobj__().debug(*reassure_people_that_this_is_expected(args))
+        elsif foreign_key_error?(args)
+          __getobj__().warn(*args)
         else
           __getobj__().error(*args)
         end
@@ -28,6 +26,11 @@ module PactBroker
             args.first.include?("no such view"))
       end
 
+      # Foreign key exceptions are almost always transitory and unreproducible by this stage
+      def foreign_key_error?(args)
+        args.first.is_a?(String) && args.first.downcase.include?("foreign key")
+      end
+
       def reassure_people_that_this_is_expected(args)
         message = args.shift
         message = message + " Don't panic. This happens when Sequel doesn't know if a table/view exists or not."

data/lib/pact_broker/hash_refinements.rb

@@ -18,6 +18,10 @@ module PactBroker
         symbolize_keys_private(self)
       end
 
+      def stringify_keys
+        stringify_keys_private(self)
+      end
+
       def snakecase_keys
         snakecase_keys_private(self)
       end
@@ -26,6 +30,10 @@ module PactBroker
         keys.each_with_object(Hash.new) { |k, hash| hash[k] = self[k] if has_key?(k) }
       end
 
+      def camelcase_keys
+        camelcase_keys_private(self)
+      end
+
       private
 
       def snakecase_keys_private(params)
@@ -45,7 +53,25 @@ module PactBroker
         else
           params
         end
+      end
 
+      def camelcase_keys_private(params)
+        case params
+        when Hash
+          params.inject({}) do |result, (key, value)|
+            snake_key = case key
+            when String then key.camelcase
+            when Symbol then key.to_s.camelcase.to_sym
+            else
+              key
+            end
+            result.merge(snake_key => camelcase_keys_private(value))
+          end
+        when Array
+          params.collect { |value| camelcase_keys_private(value) }
+        else
+          params
+        end
       end
 
       def symbolize_keys_private(params)
@@ -60,6 +86,19 @@ module PactBroker
           params
         end
       end
+
+      def stringify_keys_private(params)
+        case params
+        when Hash
+          params.inject({}) do |result, (key, value)|
+            result.merge(key.to_s => symbolize_keys_private(value))
+          end
+        when Array
+          params.collect { |value| symbolize_keys_private(value) }
+        else
+          params
+        end
+      end
     end
   end
 end

data/lib/pact_broker/logging.rb

@@ -31,9 +31,17 @@ module PactBroker
     end
 
     def log_error e, description = nil
-      message = "#{e.class} #{e.message}\n#{e.backtrace.join("\n")}"
-      message = "#{description} - #{message}" if description
-      logger.error message
+      if logger.instance_of?(SemanticLogger::Logger)
+        if description
+          logger.error(description, e)
+        else
+          logger.error(e)
+        end
+      else
+        message = "#{e.class} #{e.message}\n#{e.backtrace.join("\n")}"
+        message = "#{description} - #{message}" if description
+        logger.error message
+      end
       if ENV['PACT_BROKER_HIDE_PACTFLOW_MESSAGES'] != 'true'
         logger.info "\n\n#{'*' * 80}\n\nPrefer it was someone else's job to deal with this error? Check out https://pactflow.io/oss for a hardened, fully supported SaaS version of the Pact Broker with an improved UI  + more.\n\n#{'*' * 80}\n"
       end

data/lib/pact_broker/logging/default_formatter.rb

@@ -9,7 +9,9 @@ module PactBroker
       end
 
       def call(log, output)
-        @formatter.call(log.level.upcase, log.time, nil, log.message)
+        self.log    = log
+        self.logger = logger
+        @formatter.call(log.level.upcase, log.time, nil, [tags, named_tags, duration, message, payload, exception].compact.join(" "))
       end
     end
   end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.57.0'
+  VERSION = '2.58.0'
 end

data/pact_broker.gemspec

@@ -51,7 +51,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'sequel', '~> 5.28'
   gem.add_runtime_dependency 'webmachine', '1.5.0'
   gem.add_runtime_dependency 'semver2', '~> 3.4.2'
-  gem.add_runtime_dependency 'rack', '~> 2.2', '>= 2.2.3'
+  gem.add_runtime_dependency 'rack', '>= 2.2.3', '~> 2.2'
   gem.add_runtime_dependency 'redcarpet', '>=3.3.2', '~>3.3'
   gem.add_runtime_dependency 'pact-support', '~> 1.14', '>= 1.14.1'
   gem.add_runtime_dependency 'padrino-core', '>= 0.14.3', '~> 0.14'
@@ -63,7 +63,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'dry-logic', '0.4.2' # Later version cases ArgumentError: wrong number of arguments
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'semantic_logger', '~> 4.3'
-  gem.add_runtime_dependency 'sanitize', '~> 5.1'
+  gem.add_runtime_dependency 'sanitize', '>= 5.2.1', '~> 5.2'
 
   gem.add_development_dependency 'pact', '~>1.14'
   gem.add_development_dependency 'rspec-pact-matchers', '~>0.1'

data/spec/lib/pact_broker/api/contracts/verification_contract_spec.rb

@@ -15,6 +15,7 @@ module PactBroker
         let(:success) { true }
         let(:provider_version) { "4.5.6" }
         let(:build_url) { 'http://foo' }
+        let(:order_versions_by_date) { false }
 
         def modify hash, options
           hash.delete(options.fetch(:without))
@@ -24,6 +25,7 @@ module PactBroker
         describe "errors" do
 
           before do
+            allow(PactBroker.configuration).to receive(:order_versions_by_date).and_return(order_versions_by_date)
             subject.validate(params)
           end
 
@@ -85,10 +87,22 @@ module PactBroker
             end
           end
 
-          context "when the providerApplicationVersion is not a semantic version" do
-            let(:provider_version) { "#" }
-            it "has an error" do
-              expect(subject.errors[:provider_version]).to include(match("#.*cannot be parsed"))
+          context "when order_versions_by_date is true" do
+            let(:order_versions_by_date) { true }
+
+            context "when the providerApplicationVersion is not a semantic version" do
+              let(:provider_version) { "#" }
+              its(:errors) { is_expected.to be_empty }
+            end
+          end
+
+          context "when order_versions_by_date is false" do
+            context "when the providerApplicationVersion is not a semantic version" do
+              let(:provider_version) { "#" }
+
+              it "has an error" do
+                expect(subject.errors[:provider_version]).to include(match("#.*cannot be parsed"))
+              end
             end
           end
         end

data/spec/lib/pact_broker/db/log_quietener_spec.rb

@@ -23,6 +23,16 @@ module PactBroker
           end
         end
 
+        context "when the error is a foreign key constraint violation" do
+          before do
+            subject.error("SQLite3::ConstraintException: FOREIGN KEY constraint failed: delete from pacticipants where id = 1")
+          end
+
+          it "logs the message at warn level" do
+            expect(logs.string).to include "WARN -- :"
+          end
+        end
+
         context "when the error is NOT for a table or view that does not exist" do
           before do
             subject.error("foo bar")

data/spec/lib/pact_broker/hash_refinements_spec.rb

@@ -12,6 +12,30 @@ module PactBroker
       expect(a.deep_merge(b)).to eq expected
     end
 
+    describe "camelcase_keys" do
+      let(:hash_1) do
+        {
+          "foo_bar" => {
+            :meep_moop => "blahBlah",
+            "beepBoop" => ""
+          }
+        }
+      end
+
+      let(:expected) do
+        {
+          "fooBar" => {
+            :meepMoop => "blahBlah",
+            "beepBoop" => ""
+          }
+        }
+      end
+
+      it "camel cases the keys" do
+        expect(hash_1.camelcase_keys).to eq expected
+      end
+    end
+
     describe "snakecase_keys" do
       let(:hash_1) do
         {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.57.0
+  version: 2.58.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -340,14 +340,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
 - !ruby/object:Gem::Dependency
   name: pact
   requirement: !ruby/object:Gem::Requirement