pact_broker 2.72.0 → 2.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f848cc7a613de4d084d69d97bf1b835c1d1bb130eec3c4c968800e348daf95bf
-  data.tar.gz: 1cbbbd2832eb98cd3904bba8aff8d909a95663c70abe7ad710473e46b3fb3e7c
+  metadata.gz: 1bc95def65b82d8d938fa3b245bb6f306092d8d00572778f8b3f8ae377479fd0
+  data.tar.gz: 2790ca52a1db8ba01ca02ef24b6816482a4fdf38a925e8eb737d998ff2ff1213
 SHA512:
-  metadata.gz: 2200189e21700c21b67e1f8abc85574c3ed9367287568ce7dab4f808cd81ae01a80acd60fe3309cb134cd4466d2c243244429073d4e3af53b6b009bc58848782
-  data.tar.gz: c304534b3125112f4bd2bead0509e7e711face5f0e84ec88594cae1eb6e14a1618a4e61884ffbb0f66dbd813c4e5d4ebd61867ce276120a471a6a77f4c1e6e61
+  metadata.gz: 9d2740784d48edea10528d9b3a1db0ec6f89d5474c2b7b3c4c4077a7b1d57c714f7f902066e7e76cf921ab5b51e8cc58b6d3146a2a752c3535394c87e7457831
+  data.tar.gz: 5fb6688a830ecd05bf7eb8985d651f0a406a5bfe348e29287b93328bb2cf9f36013fda31394e3499ee058c10e54c326366f59567dc3d5eadf02507d9512787f6

data/.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
       - uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
-      - run: "bundle install"
+      - run: "gem install bundler && bundle install"
         env:
           INSTALL_PG: "true"
       - run: "bundle exec rake"

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+<a name="v2.73.0"></a>
+### v2.73.0 (2020-12-16)
+
+#### Features
+
+* **wip**
+  * permenently enable feature that keeps pacts as WIP when verified via the URL from a webhook triggered by pact publication	 ([70071373](/../../commit/70071373))
+
+* allow error causes to be configured to log at warning level	 ([3a7bf5ea](/../../commit/3a7bf5ea))
+* add self relations for tags in matrix resource	 ([727cee99](/../../commit/727cee99))
+* add self relation to tags in extended pact and verification resources	 ([a560ce6d](/../../commit/a560ce6d))
+
+* **metrics**
+  * timeout matrix count	 ([43091b57](/../../commit/43091b57))
+
+#### Bug Fixes
+
+* url encode tag name in tag URL	 ([80df832d](/../../commit/80df832d))
+
 <a name="v2.72.0"></a>
 ### v2.72.0 (2020-12-02)
 

data/lib/db.rb

@@ -33,6 +33,7 @@ module DB
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.extension(:pagination)
+    con.extension(:statement_timeout)
     con.extend_datasets do
       def any?
         !empty?

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/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

@@ -201,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/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/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

data/lib/pact_broker/metrics/service.rb

@@ -1,3 +1,4 @@
+require 'pact_broker/configuration'
 require 'pact_broker/pacts/pact_publication'
 require 'pact_broker/pacts/pact_version'
 require 'pact_broker/domain/pacticipant'
@@ -66,7 +67,7 @@ module PactBroker
             count: PactBroker::Webhooks::Execution.count
           },
           matrix: {
-            count: PactBroker::Matrix::Row.count
+            count: matrix_count
           }
         }
       end
@@ -87,6 +88,16 @@ module PactBroker
           order by 1"
           PactBroker::Pacts::PactPublication.db[query].all.each_with_object({}) { |row, hash| hash[row[:number_of_verifications]] = row[:pact_version_count] }
       end
+
+      def matrix_count
+        begin
+          PactBroker::Matrix::Row.db.with_statement_timeout(PactBroker.configuration.metrics_sql_statement_timeout) do
+            PactBroker::Matrix::Row.count
+          end
+        rescue Sequel::DatabaseError => e
+          -1
+        end
+      end
     end
   end
 end

data/lib/pact_broker/pacts/metadata.rb

@@ -1,5 +1,3 @@
-require 'pact_broker/feature_toggle'
-
 module PactBroker
   module Pacts
     module Metadata
@@ -33,7 +31,7 @@ module PactBroker
           consumer_version_number: pact.consumer_version_number,
           consumer_version_tags: pact.consumer_version_tag_names
         }
-        metadata[:wip] = "true" if PactBroker.feature_enabled?(:experimental_webhook_wip)
+        metadata[:wip] = "true"
         metadata
       end
     end

data/lib/pact_broker/tags/tag_with_latest_flag.rb

@@ -5,6 +5,8 @@ module PactBroker
   module Tags
     # The tag associated with the latest verification for a given tag
     class TagWithLatestFlag < Sequel::Model(:tags_with_latest_flag)
+      associate(:many_to_one, :version, :class => "PactBroker::Domain::Version", :key => :version_id, :primary_key => :id)
+
       dataset_module do
         include PactBroker::Repositories::Helpers
       end

data/lib/pact_broker/test/http_test_data_builder.rb

@@ -77,7 +77,7 @@ module PactBroker
           consumerVersionSelectors: consumer_version_selectors,
           includePendingStatus: enable_pending,
           includeWipPactsSince: include_wip_pacts_since
-        }
+        }.compact
         puts body.to_yaml
         puts ""
         @pacts_for_verification_response = client.post("/pacts/provider/#{encode(provider)}/for-verification", body)

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.72.0'
+  VERSION = '2.73.0'
 end

data/lib/sequel/extensions/statement_timeout.rb

@@ -0,0 +1,22 @@
+module Sequel
+  module StatementTimeout
+    def with_statement_timeout(timeout_seconds = 20)
+      # Might not have postgres class loaded, use class name
+      if self.class.name == "Sequel::Postgres::Database"
+          # Don't want to use a transaction because this will often be a read and a transaction is unnecessary.
+          # Also, when using it for clean, want to control the transactions outside this.
+          current_statement_timeout = execute("show statement_timeout") { |r| r.first.values.first }
+          run("SET statement_timeout = '#{timeout_seconds}s'")
+          begin
+            yield
+          ensure
+            run("SET statement_timeout = '#{current_statement_timeout}'")
+          end
+      else
+        yield
+      end
+    end
+  end
+
+  Database.register_extension(:statement_timeout){|db| db.extend(StatementTimeout) }
+end

data/script/reproduce-issue-starting-up.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << "#{Dir.pwd}/lib"
+
+begin
+
+  require 'pact_broker/test/http_test_data_builder'
+  base_url = ENV['PACT_BROKER_BASE_URL'] || 'http://localhost:9292'
+
+  td = PactBroker::Test::HttpTestDataBuilder.new(base_url, { })
+  td.delete_integration(consumer: "MyConsumer", provider: "MyProvider")
+    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
+    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
+    .publish_pact(consumer: "MyConsumer", consumer_version: "1", provider: "MyProvider", content_id: "111", tag: "feature/a")
+    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
+    .get_pacts_for_verification(
+      enable_pending: true,
+      provider_version_tag: "main",
+      include_wip_pacts_since: "2020-01-01",
+      consumer_version_selectors: [{ tag: "main", latest: true }])
+    .verify_pact(
+      index: 0,
+      provider_version_tag: "main",
+      provider_version: "1",
+      success: false
+    )
+    .get_pacts_for_verification(
+      enable_pending: true,
+      provider_version_tag: "main",
+      include_wip_pacts_since: "2020-01-01",
+      consumer_version_selectors: [{ tag: "main", latest: true }])
+    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
+    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
+    .deploy_to_prod(pacticipant: "MyProvider", version: "1")
+    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
+    .deploy_to_prod(pacticipant: "MyConsumer", version: "1")
+
+rescue StandardError => e
+  puts "#{e.class} #{e.message}"
+  puts e.backtrace
+  exit 1
+end
+

data/script/reproduce-issue.rb

@@ -9,31 +9,11 @@ begin
 
   td = PactBroker::Test::HttpTestDataBuilder.new(base_url, { })
   td.delete_integration(consumer: "MyConsumer", provider: "MyProvider")
-    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
-    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
-    .publish_pact(consumer: "MyConsumer", consumer_version: "1", provider: "MyProvider", content_id: "111", tag: "feature/a")
-    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
+    .publish_pact(consumer: "MyConsumer", consumer_version: "1", provider: "MyProvider", content_id: "111", tag: "main")
     .get_pacts_for_verification(
-      enable_pending: true,
       provider_version_tag: "main",
-      include_wip_pacts_since: "2020-01-01",
       consumer_version_selectors: [{ tag: "main", latest: true }])
-    .verify_pact(
-      index: 0,
-      provider_version_tag: "main",
-      provider_version: "1",
-      success: false
-    )
-    .get_pacts_for_verification(
-      enable_pending: true,
-      provider_version_tag: "main",
-      include_wip_pacts_since: "2020-01-01",
-      consumer_version_selectors: [{ tag: "main", latest: true }])
-    .can_i_deploy(pacticipant: "MyProvider", version: "1", to: "prod")
-    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
-    .deploy_to_prod(pacticipant: "MyProvider", version: "1")
-    .can_i_deploy(pacticipant: "MyConsumer", version: "1", to: "prod")
-    .deploy_to_prod(pacticipant: "MyConsumer", version: "1")
+
 
 rescue StandardError => e
   puts "#{e.class} #{e.message}"

data/spec/lib/pact_broker/api/decorators/extended_pact_decorator_spec.rb

@@ -46,6 +46,7 @@ module PactBroker
           expect(subject[:_embedded][:tags].first).to include name: 'prod', latest: true
           # Can't seem to stub the verification_publication_url method on the TagDecorator
           expect(subject[:_embedded][:tags].first[:_links][:'pb:latest-pact'][:href]).to eq "http://example.org/pacts/provider/A%20Provider/consumer/A%20Consumer/latest/prod"
+          expect(subject[:_embedded][:tags].first[:_links][:self][:href]).to eq "http://example.org/pacticipants/A%20Consumer/versions/1234/tags/prod"
         end
 
         it "includes the pact contents under the contract key" do

data/spec/lib/pact_broker/api/decorators/matrix_decorator_spec.rb

@@ -66,8 +66,12 @@ module PactBroker
                 tags: [
                   {
                     name: 'prod',
-                    latest: true
-
+                    latest: true,
+                    _links: {
+                      self: {
+                        href: 'http://example.org/pacticipants/Consumer/versions/1.0.0/tags/prod'
+                      }
+                    }
                   }
                 ]
               }
@@ -92,10 +96,14 @@ module PactBroker
                 tags: [
                   {
                     name: 'master',
-                    latest: false
+                    latest: false,
+                    _links: {
+                      self: {
+                        href: 'http://example.org/pacticipants/Provider/versions/4.5.6/tags/master'
+                      }
+                    }
                   }
                 ]
-
               }
             }
           end
@@ -123,15 +131,19 @@ module PactBroker
             }
           end
 
+          let(:consumer_version) { double("consumer version", number: "1.0.0", pacticipant: double("consumer", name: "Consumer")) }
+
           let(:consumer_version_tags) do
             [
-              double('tag', name: 'prod', latest?: true)
+              double("tag", name: "prod", latest?: true, version: consumer_version)
             ]
           end
 
+          let(:provider_version) { double("provider version", number: "4.5.6", pacticipant: double("provider", name: "Provider")) }
+
           let(:provider_version_tags) do
             [
-              double('tag', name: 'master', latest?: false)
+              double("tag", name: "master", latest?: false, version: provider_version)
             ]
           end
 
@@ -158,11 +170,11 @@ module PactBroker
           let(:parsed_json) { JSON.parse(json, symbolize_names: true) }
 
           it "includes the consumer details" do
-            expect(parsed_json[:matrix][0][:consumer]).to eq consumer_hash
+            expect(parsed_json[:matrix][0][:consumer]).to match_pact consumer_hash
           end
 
           it "includes the provider details" do
-            expect(parsed_json[:matrix][0][:provider]).to eq provider_hash
+            expect(parsed_json[:matrix][0][:provider]).to match_pact provider_hash
           end
 
           it "includes the verification details" do

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -36,6 +36,7 @@ module PactBroker
           pacticipant: consumer,
           number: "2/4")
       end
+      let(:tag) { double('tag', name: "feat/foo", version: version) }
 
       matcher :match_route_in_api do |api|
         match do |url|
@@ -168,6 +169,13 @@ module PactBroker
 
         it { is_expected.to eq "http://example.org/matrix/provider/Bar%2FBar/latest/meep/consumer/Foo%2FFoo/latest/bar/badge.svg" }
       end
+
+      describe "tag_url" do
+        subject { PactBrokerUrls.tag_url(base_url, tag) }
+
+        it { is_expected.to match_route_in_api(PactBroker::API) }
+        it { is_expected.to eq "http://example.org/pacticipants/Foo%2FFoo/versions/2%2F4/tags/feat%2Ffoo" }
+      end
     end
   end
 end

data/spec/lib/pact_broker/api/resources/error_handler_spec.rb

@@ -53,6 +53,22 @@ module PactBroker
             end
           end
 
+          context "when the error cause class is in the warning_error_classes list" do
+            class TestCauseError < StandardError; end
+
+            before do
+              allow(PactBroker.configuration).to receive(:warning_error_classes).and_return([TestCauseError])
+              allow(error).to receive(:cause).and_return(TestCauseError.new)
+            end
+
+            let(:error) { StandardError.new("message") }
+
+            it "logs at warn so as not to wake everyone up in the middle of the night" do
+              expect(logger).to receive(:warn).with(/bYWfnyWPlf/, error)
+              subject
+            end
+          end
+
           context "when the error is not reportable and not a warning level" do
             let(:error) { PactBroker::Error.new('foo') }
 

data/spec/lib/pact_broker/pacts/selected_pact_spec.rb

@@ -0,0 +1,23 @@
+require 'pact_broker/pacts/selected_pact'
+
+module PactBroker
+  module Pacts
+    describe SelectedPact do
+      describe ".merge" do
+        let(:pact_1) { double("pact 1", consumer_version_number: "1", consumer_version: double("version", order: 1)) }
+        let(:selectors_1) { Selectors.new([Selector.overall_latest]) }
+        let(:selected_pact_1) { SelectedPact.new(pact_1, selectors_1) }
+
+        let(:pact_2) { double("pact 2", consumer_version_number: "2", consumer_version: double("version", order: 2)) }
+        let(:selectors_2) { Selectors.new([Selector.latest_for_tag("foo")]) }
+        let(:selected_pact_2) { SelectedPact.new(pact_2, selectors_2) }
+
+        subject { SelectedPact.merge([selected_pact_1, selected_pact_2]) }
+
+        it "merges them" do
+          expect(subject.selectors).to eq Selectors.new([Selector.overall_latest, Selector.latest_for_tag("foo")])
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.72.0
+  version: 2.73.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -965,6 +965,7 @@ files:
 - lib/rack/pact_broker/ui_authentication.rb
 - lib/rack/pact_broker/ui_request_filter.rb
 - lib/rack/pact_broker/use_when.rb
+- lib/sequel/extensions/statement_timeout.rb
 - lib/sequel/plugins/insert_ignore.rb
 - lib/sequel/plugins/upsert.rb
 - lib/webmachine/rack_adapter_monkey_patch.rb
@@ -1055,6 +1056,7 @@ files:
 - script/recreate-test-database.sh
 - script/release-via-github-action.sh
 - script/release.sh
+- script/reproduce-issue-starting-up.rb
 - script/reproduce-issue.rb
 - script/restart.sh
 - script/run-with-ssl.rb
@@ -1299,6 +1301,7 @@ files:
 - spec/lib/pact_broker/pacts/repository_find_for_verification_spec.rb
 - spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb
 - spec/lib/pact_broker/pacts/repository_spec.rb
+- spec/lib/pact_broker/pacts/selected_pact_spec.rb
 - spec/lib/pact_broker/pacts/selector_spec.rb
 - spec/lib/pact_broker/pacts/selectors_spec.rb
 - spec/lib/pact_broker/pacts/service_find_for_verification_spec.rb
@@ -1460,7 +1463,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.1
 signing_key: 
 specification_version: 4
 summary: See description
@@ -1697,6 +1700,7 @@ test_files:
 - spec/lib/pact_broker/pacts/repository_find_for_verification_spec.rb
 - spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb
 - spec/lib/pact_broker/pacts/repository_spec.rb
+- spec/lib/pact_broker/pacts/selected_pact_spec.rb
 - spec/lib/pact_broker/pacts/selector_spec.rb
 - spec/lib/pact_broker/pacts/selectors_spec.rb
 - spec/lib/pact_broker/pacts/service_find_for_verification_spec.rb