pact_broker 2.49.0 → 2.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b99bf5d9f68ee92e651f20ad2595feb55060c1720a816179f1e143d7db4dea4
-  data.tar.gz: 174f33323d8ecb66ec0640705273b2629b4203812f1fa4f3d68a5c997db40328
+  metadata.gz: a34b4517981e902118bd7d55699749de020a12e5afcb68d3baed70b65cabe7f4
+  data.tar.gz: 6033d7d9a3cd1d5c767447c5d378e0709a1498cd1fb8b4d62a59288faef34b6a
 SHA512:
-  metadata.gz: 51835924b04c884319fcc89dcc729a572645ad490245d94eb77e3b7fd58df244d4980aaeb8363f10af52fae7ea8eeeb8a96096b4f6f8f711fc86ebbc30d097e9
-  data.tar.gz: d9a90fecfc31add0cfb0104eae721d55e2fb695823bbd151d12f4c9f8fdb1581ced85f679be6e489a05882bc9b04c3f448e97495e538afc98d8623ce08746050
+  metadata.gz: '0087b549fee835fc3923fb0c1d50d53aa583661350386ab5033324de56227c308ad01a8f31d6f3d1a173dc877fcb778237faa0dcb96cd23603f868b42f7ed3e8'
+  data.tar.gz: dff10d2c54611d5f92b65de17cc61d249adc7b6d0f08fc4af3432fb48c04e4d36ce5b1e3d459bd49048a885e0cc027f5364455ec8cd9229264b572e9ff72698a

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="v2.50.0"></a>
+### v2.50.0 (2020-02-27)
+
+
+#### Features
+
+* **deps**
+  * upgrade to pact-support 1.14.1	 ([47c23b7d](/../../commit/47c23b7d))
+
+* **ui**
+  * display repository URL on the pacticipant relationships page	 ([5d285e95](/../../commit/5d285e95))
+
+* expose configuration option to allow missing migrations files on startup	 ([58dea9ab](/../../commit/58dea9ab))
+* add rake task to clean overwritten pact publications and verifications	 ([942dfbd0](/../../commit/942dfbd0))
+* include tag and consumer version number in metadata parameter of verification creation URL when verifying latest pact for a tag	 ([3b59e824](/../../commit/3b59e824))
+
+* **pact**
+  * add relation to view matrix rows for the consumer version	 ([13cb20b1](/../../commit/13cb20b1))
+
+
 <a name="v2.49.0"></a>
 ### v2.49.0 (2020-02-13)
 

data/lib/pact_broker/api/decorators/pact_decorator.rb

@@ -159,6 +159,13 @@ module PactBroker
           }
         end
 
+        link :'pb:matrix-for-consumer-version' do | options |
+          {
+            title: "View matrix rows for the consumer version to which this pact belongs",
+            href: matrix_for_pacticipant_version_url(represented.consumer_version, options.fetch(:base_url))
+          }
+        end
+
         curies do | options |
           [{
             name: :pb,

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -1,9 +1,11 @@
 require 'erb'
+require 'pact_broker/pacts/metadata'
 
 module PactBroker
   module Api
     module PactBrokerUrls
 
+      include PactBroker::Pacts::Metadata
       # TODO make base_url the last and optional argument for all methods, defaulting to ''
 
       extend self
@@ -59,13 +61,14 @@ module PactBroker
       end
 
       def build_webhook_metadata(pact)
-        Base64.strict_encode64(Rack::Utils.build_nested_query(
-          consumer_version_number: pact.consumer_version_number,
-          consumer_version_tags: pact.consumer_version_tag_names
-        ))
+        encode_webhook_metadata(build_metadata_for_webhook_triggered_by_pact_publication(pact))
       end
 
-      def parse_webhook_metadata(metadata)
+      def encode_webhook_metadata(metadata)
+        Base64.strict_encode64(Rack::Utils.build_nested_query(metadata))
+      end
+
+      def decode_webhook_metadata(metadata)
         if metadata
           Rack::Utils.parse_nested_query(Base64.strict_decode64(metadata)).each_with_object({}) do | (k, v), new_hash |
             new_hash[k.to_sym] = v
@@ -250,6 +253,14 @@ module PactBroker
         "/matrix/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}"
       end
 
+      def matrix_for_pacticipant_version_url(version, base_url = '')
+        query = {
+          q: [{ pacticipant: version.pacticipant.name, version: version.number }],
+          latestby: 'cvpv'
+        }
+        "#{base_url}/matrix?#{Rack::Utils.build_nested_query(query)}"
+      end
+
       def matrix_url_from_params params, base_url = ''
         matrix_url(params.fetch(:consumer_name), params.fetch(:provider_name), base_url)
       end

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -137,7 +137,7 @@ module PactBroker
         end
 
         def matrix_url
-          PactBroker::Api::PactBrokerUrls.matrix_url_from_params({ consumer_name: @pact.consumer.name, provider_name: @pact.provider.name }, base_url)
+          PactBroker::Api::PactBrokerUrls.matrix_for_pacticipant_version_url(@pact.consumer_version, base_url)
         end
 
         def latest_pact_url

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

@@ -1,6 +1,7 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/configuration'
 require 'pact_broker/api/decorators/extended_pact_decorator'
+require 'pact_broker/pacts/metadata'
 
 module PactBroker
   module Api
@@ -25,11 +26,11 @@ module PactBroker
 
         def to_json
           response.headers['X-Pact-Consumer-Version'] = pact.consumer_version_number
-          PactBroker::Api::Decorators::PactDecorator.new(pact).to_json(user_options: { base_url: base_url })
+          PactBroker::Api::Decorators::PactDecorator.new(pact).to_json(user_options: decorator_context(metadata: metadata))
         end
 
         def to_extended_json
-          PactBroker::Api::Decorators::ExtendedPactDecorator.new(pact).to_json(user_options: decorator_context(metadata: identifier_from_path[:metadata]))
+          PactBroker::Api::Decorators::ExtendedPactDecorator.new(pact).to_json(user_options: decorator_context(metadata: metadata))
         end
 
         def to_html
@@ -44,6 +45,9 @@ module PactBroker
           @pact ||= pact_service.find_latest_pact(identifier_from_path)
         end
 
+        def metadata
+          @metadata ||= encode_webhook_metadata(PactBroker::Pacts::Metadata.build_metadata_for_latest_pact(pact, identifier_from_path))
+        end
       end
     end
   end

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

@@ -36,15 +36,15 @@ module PactBroker
         end
 
         def to_json
-          PactBroker::Api::Decorators::MatrixDecorator.new(lines).to_json(user_options: { base_url: base_url })
+          PactBroker::Api::Decorators::MatrixDecorator.new(results).to_json(user_options: { base_url: base_url })
         end
 
         def to_text
-          PactBroker::Api::Decorators::MatrixTextDecorator.new(lines).to_text(user_options: { base_url: base_url })
+          PactBroker::Api::Decorators::MatrixTextDecorator.new(results).to_text(user_options: { base_url: base_url })
         end
 
-        def lines
-          @lines ||= matrix_service.find(selectors, options)
+        def results
+          @results ||= matrix_service.find(selectors, options)
         end
       end
     end

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

@@ -24,13 +24,16 @@ module PactBroker
         end
 
         def to_json
-          lines = matrix_service.find_for_consumer_and_provider(identifier_from_path, options)
-          PactBroker::Api::Decorators::MatrixDecorator.new(lines).to_json(user_options: { base_url: base_url })
+          PactBroker::Api::Decorators::MatrixDecorator.new(results).to_json(user_options: { base_url: base_url })
         end
 
         private
 
         attr_reader :options
+
+        def results
+          @results ||= matrix_service.find_for_consumer_and_provider(identifier_from_path, options)
+        end
       end
     end
   end

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

@@ -72,7 +72,7 @@ module PactBroker
         end
 
         def metadata
-          PactBrokerUrls.parse_webhook_metadata(identifier_from_path[:metadata])
+          PactBrokerUrls.decode_webhook_metadata(identifier_from_path[:metadata])
         end
 
         def webhook_options

data/lib/pact_broker/app.rb

@@ -83,7 +83,7 @@ module PactBroker
     def prepare_database
       if configuration.auto_migrate_db
         logger.info "Migrating database"
-        PactBroker::DB.run_migrations configuration.database_connection
+        PactBroker::DB.run_migrations configuration.database_connection, allow_missing_migration_files: configuration.allow_missing_migration_files
       else
         logger.info "Skipping database migrations"
       end

data/lib/pact_broker/configuration.rb

@@ -34,7 +34,7 @@ module PactBroker
       :badge_provider_mode
     ]
 
-    attr_accessor :base_url, :log_dir, :database_connection, :auto_migrate_db, :auto_migrate_db_data, :example_data_seeder, :seed_example_data, :use_hal_browser, :html_pact_renderer, :use_rack_protection
+    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
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser, :sha_generator
     attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_accessor :check_for_potential_duplicate_pacticipant_names
@@ -64,6 +64,7 @@ module PactBroker
       config.log_dir = File.expand_path("./log")
       config.auto_migrate_db = true
       config.auto_migrate_db_data = true
+      config.allow_missing_migration_files = false
       config.use_rack_protection = true
       config.use_hal_browser = true
       config.validate_database_connection_config = true

data/lib/pact_broker/db/data_migrations/delete_deprecated_webhook_executions.rb

@@ -0,0 +1,21 @@
+require 'pact_broker/db/data_migrations/helpers'
+
+module PactBroker
+  module DB
+    module DataMigrations
+      class DeleteDeprecatedWebhookExecutions
+        extend Helpers
+
+        def self.call(connection)
+          if columns_exist?(connection)
+            connection[:webhook_executions].where(triggered_webhook_id: nil).delete
+          end
+        end
+
+        def self.columns_exist?(connection)
+          column_exists?(connection, :webhook_executions, :triggered_webhook_id)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/db/data_migrations/set_consumer_ids_for_pact_publications.rb

@@ -1,3 +1,5 @@
+require 'pact_broker/db/data_migrations/helpers'
+
 module PactBroker
   module DB
     module DataMigrations

data/lib/pact_broker/db/data_migrations/set_latest_version_sequence_value.rb

@@ -1,3 +1,5 @@
+require 'pact_broker/db/data_migrations/helpers'
+
 module PactBroker
   module DB
     module DataMigrations

data/lib/pact_broker/db/data_migrations/set_pacticipant_ids_for_verifications.rb

@@ -1,3 +1,5 @@
+require 'pact_broker/db/data_migrations/helpers'
+
 module PactBroker
   module DB
     module DataMigrations

data/lib/pact_broker/db/delete_overwritten_data.rb

@@ -0,0 +1,76 @@
+require 'date'
+require 'sequel'
+
+module PactBroker
+  module DB
+    class DeleteOverwrittenData
+      def self.call database_connection, options = {}
+        new(database_connection, options).call
+      end
+
+      def initialize database_connection, options = {}
+        @db = database_connection
+        @options = options
+        @before = options[:before] || DateTime.now
+      end
+
+      def call
+        deleted_counts = {}
+        kept_counts = {}
+
+
+        deleted_counts.merge!(delete_overwritten_pact_publications)
+        deleted_counts.merge!(delete_overwritten_verifications)
+        deleted_counts.merge!(delete_orphan_pact_versions)
+
+        kept_counts[:pact_publications] = db[:pact_publications].count
+        kept_counts[:verification_results] = db[:verifications].count
+        kept_counts[:pact_versions] = db[:pact_versions].count
+
+
+        { deleted: deleted_counts, kept: kept_counts }
+      end
+
+      private
+
+      attr_reader :db, :options, :before
+
+      def delete_webhook_data(triggered_webhook_ids)
+        db[:webhook_executions].where(triggered_webhook_id: triggered_webhook_ids).delete
+        db[:triggered_webhooks].where(id: triggered_webhook_ids).delete
+      end
+
+      def delete_orphan_pact_versions
+        referenced_pact_version_ids = db[:pact_publications].select(:pact_version_id).union(db[:verifications].select(:pact_version_id))
+        pact_version_ids_to_delete = db[:pact_versions].where(id: referenced_pact_version_ids).invert
+        deleted_counts = { pact_versions: pact_version_ids_to_delete.count }
+        pact_version_ids_to_delete.delete
+        deleted_counts
+      end
+
+      def delete_overwritten_pact_publications
+        pact_publication_ids_to_delete = db[:pact_publications]
+          .select(:id)
+          .where(id: db[:latest_pact_publication_ids_for_consumer_versions].select(:pact_publication_id))
+          .invert
+          .where(Sequel.lit('created_at < ?', before))
+
+        deleted_counts = { pact_publications: pact_publication_ids_to_delete.count }
+        delete_webhook_data(db[:triggered_webhooks].where(pact_publication_id: pact_publication_ids_to_delete).select(:id))
+        pact_publication_ids_to_delete.delete
+        deleted_counts
+      end
+
+      def delete_overwritten_verifications
+        verification_ids = db[:verifications].select(:id)
+          .where(id: db[:latest_verification_id_for_pact_version_and_provider_version].select(:verification_id))
+          .invert
+          .where(Sequel.lit('created_at < ?', before))
+        deleted_counts = { verification_results: verification_ids.count }
+        delete_webhook_data(db[:triggered_webhooks].where(verification_id: verification_ids).select(:id))
+        verification_ids.delete
+        deleted_counts
+      end
+    end
+  end
+end

data/lib/pact_broker/db/migrate_data.rb

@@ -18,6 +18,7 @@ module PactBroker
         DataMigrations::SetConsumerIdsForPactPublications.call(database_connection)
         DataMigrations::SetLatestVersionSequenceValue.call(database_connection)
         DataMigrations::SetWebhooksEnabled.call(database_connection)
+        DataMigrations::DeleteDeprecatedWebhookExecutions.call(database_connection)
       end
     end
   end

data/lib/pact_broker/doc/views/pact/all-pact-versions.markdown

@@ -1,6 +1,7 @@
 # All versions of a pact between a given consumer and provider
 
 Allowed methods: `GET`, `DELETE`
+
 Path: `/pacts/provider/{provider}/consumer/{consumer}/versions`
 
 This resource returns a history of all the versions of the given pact between a consumer and provider.

data/lib/pact_broker/doc/views/pact/latest-pact-version.markdown

@@ -1,6 +1,6 @@
 # Latest pact version
 
-Allowed methods: GET
+Allowed methods: `GET`
 
 The latest pact between this consumer and provider.
 

data/lib/pact_broker/doc/views/pact/matrix-for-consumer-version.markdown

@@ -0,0 +1,7 @@
+# Matrix for consumer version
+
+Allowed methods: `GET`
+
+Path: `/matrix?q[][pacticipant]={consumer}&q[][version]={consumerVersion}&latestby=cvpv`
+
+View the matrix rows that involve the consumer version for which this pact was published.

data/lib/pact_broker/pacts/metadata.rb

@@ -0,0 +1,37 @@
+module PactBroker
+  module Pacts
+    module Metadata
+      extend self
+
+      # When verifying a pact at /.../latest/TAG, this stores the
+      # tag and the current consumer version number in the
+      # metadata parameter of the URL for publishing the verification results.
+      # This is part of ensuring that verification results webhooks
+      # go back to the correct consumer version number (eg for git statuses)
+      def build_metadata_for_latest_pact(pact, selection_parameters)
+        if selection_parameters[:tag]
+          {
+            consumer_version_tags: selection_parameters[:tag],
+            consumer_version_number: pact.consumer_version_number
+          }
+        else
+          {
+            consumer_version_number: pact.consumer_version_number
+          }
+        end
+      end
+
+      # When a pact is published, and a webhook is triggered, this stores
+      # the current tags and consumer version number in the metadata parameter of the
+      # pact version URL that is made available in the webhook template
+      # parameters. This is part of ensuring that verification results webhooks
+      # go back to the correct consumer version number (eg for git statuses)
+      def build_metadata_for_webhook_triggered_by_pact_publication(pact)
+        {
+          consumer_version_number: pact.consumer_version_number,
+          consumer_version_tags: pact.consumer_version_tag_names
+        }
+      end
+    end
+  end
+end

data/lib/pact_broker/tasks.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/tasks/migration_task'
 require 'pact_broker/tasks/data_migration_task'
+require 'pact_broker/tasks/delete_overwritten_data_task'
 require 'pact_broker/tasks/version_task'
 require 'pact_broker/tasks/clean_task'

data/lib/pact_broker/tasks/delete_overwritten_data_task.rb

@@ -0,0 +1,37 @@
+module PactBroker
+  module DB
+    class DeleteOverwrittenDataTask < ::Rake::TaskLib
+      attr_accessor :database_connection
+      attr_accessor :age_in_days
+
+      def initialize &block
+        rake_task &block
+      end
+
+      def rake_task &block
+        namespace :pact_broker do
+          namespace :db do
+            desc "Delete overwritten pacts and verifications from database"
+            task :delete_overwritten_data do | t, args |
+              require 'pact_broker/db/delete_overwritten_data'
+              require 'yaml'
+
+              instance_eval(&block)
+              options = {}
+
+              if age_in_days
+                options[:before] = (Date.today - age_in_days.to_i).to_datetime
+                $stdout.puts "Deleting overwritten pact publications and verifications older than #{age_in_days} days"
+              else
+                $stdout.puts "Deleting overwritten pact publications and verifications"
+              end
+
+              report = PactBroker::DB::DeleteOverwrittenData.call(database_connection, options)
+              $stdout.puts report.to_yaml
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/test/test_data_builder.rb

@@ -111,7 +111,7 @@ module PactBroker
 
       def create_pacticipant pacticipant_name, params = {}
         params.delete(:comment)
-        @pacticipant = PactBroker::Domain::Pacticipant.create({ :name => pacticipant_name }.merge(params))
+        @pacticipant = PactBroker::Domain::Pacticipant.create({ :name => pacticipant_name, repository_url: "https://github.com/example-organization/#{pacticipant_name}" }.merge(params))
         self
       end
 
@@ -307,19 +307,6 @@ module PactBroker
         self
       end
 
-      def create_deprecated_webhook_execution params = {}
-        params.delete(:comment)
-        create_webhook_execution params
-        Sequel::Model.db[:webhook_executions].where(id: webhook_execution.id).update(
-          triggered_webhook_id: nil,
-          consumer_id: consumer.id,
-          provider_id: provider.id,
-          webhook_id: PactBroker::Webhooks::Webhook.find(uuid: webhook.uuid).id,
-          pact_publication_id: pact.id
-        )
-        self
-      end
-
       def create_verification parameters = {}
         parameters.delete(:comment)
         tag_names = [parameters.delete(:tag_names), parameters.delete(:tag_name)].flatten.compact

data/lib/pact_broker/ui/controllers/groups.rb

@@ -10,10 +10,13 @@ module PactBroker
         include PactBroker::Services
 
         get ":name" do
+          pacticipant = pacticipant_service.find_pacticipant_by_name(params[:name])
           erb :'groups/show.html', {
-            locals: {
-              csv_path: "/groups/#{params[:name]}.csv",
-              pacticipant_name: params[:name]}
+              locals: {
+                csv_path: "/groups/#{params[:name]}.csv",
+                pacticipant_name: params[:name],
+                repository_url: pacticipant&.repository_url
+              }
             }, {
               layout: 'layouts/main'
             }

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

@@ -1,3 +1,5 @@
+<% require 'sanitize' %>
+
 <!DOCTYPE html>
 <html lang="en">
 <head>
@@ -30,6 +32,19 @@ body{
 </head>
 <body>
 <h1>Network graph of <%= pacticipant_name %> relationships</h1>
+
+<% if repository_url %>
+<p>Repository URL:
+
+<%
+repository_link = "<a href='#{repository_url}'>#{escape_html(repository_url)}</a>"
+%>
+
+<%= Sanitize.fragment(repository_link, Sanitize::Config::BASIC) %>
+
+<% end %>
+
+
 <script type="text/javascript">
 var windowWidth, windowHeight, svg;
 

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.49.0'
+  VERSION = '2.50.0'
 end

data/lib/pact_broker/webhooks/execution.rb

@@ -13,6 +13,8 @@ module PactBroker
         Sequel[:webhook_executions][:created_at])
       )
 
+      plugin :timestamps
+
       dataset_module do
         include PactBroker::Repositories::Helpers
       end
@@ -25,16 +27,6 @@ module PactBroker
         comp
       end
     end
-
-    # For a brief time, the code was released with a direct relationship between
-    # webhook and execution. Need to make sure any existing data is handled properly.
-    class DeprecatedExecution < Sequel::Model(:webhook_executions)
-      associate(:many_to_one, :provider, :class => "PactBroker::Domain::Pacticipant", :key => :provider_id, :primary_key => :id)
-      associate(:many_to_one, :consumer, :class => "PactBroker::Domain::Pacticipant", :key => :consumer_id, :primary_key => :id)
-    end
-
-    Execution.plugin :timestamps
-
   end
 end
 

data/lib/pact_broker/webhooks/repository.rb

@@ -136,9 +136,6 @@ module PactBroker
       end
 
       def delete_executions_by_pacticipant pacticipants
-        # TODO this relationship no longer exists, deprecate in next version
-        DeprecatedExecution.where(consumer: pacticipants).delete
-        DeprecatedExecution.where(provider: pacticipants).delete
         execution_ids = Execution
           .join(:triggered_webhooks, {id: :triggered_webhook_id})
           .where(Sequel.or(
@@ -151,7 +148,6 @@ module PactBroker
       def delete_triggered_webhooks_by_webhook_uuid uuid
         triggered_webhook_ids = TriggeredWebhook.where(webhook: Webhook.where(uuid: uuid)).select_for_subquery(:id)
         delete_triggered_webhooks_and_executions(triggered_webhook_ids)
-        DeprecatedExecution.where(webhook_id: Webhook.where(uuid: uuid).select_for_subquery(:id)).delete
       end
 
       def delete_triggered_webhooks_by_version_id version_id
@@ -166,7 +162,6 @@ module PactBroker
       def delete_triggered_webhooks_by_pact_publication_ids pact_publication_ids
         triggered_webhook_ids = TriggeredWebhook.where(pact_publication_id: pact_publication_ids).select_for_subquery(:id)
         delete_triggered_webhooks_and_executions(triggered_webhook_ids)
-        DeprecatedExecution.where(pact_publication_id: pact_publication_ids).delete
       end
 
       def find_latest_triggered_webhooks_for_pact pact

data/lib/pact_broker/webhooks/service.rb

@@ -14,7 +14,6 @@ require 'pact_broker/hash_refinements'
 require 'pact_broker/webhooks/execution_configuration'
 require 'pact_broker/messages'
 require 'pact_broker/webhooks/pact_and_verification_parameters'
-require 'reform/contract/errors'
 
 module PactBroker
   module Webhooks

data/pact_broker.gemspec

@@ -53,7 +53,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'semver2', '~> 3.4.2'
   gem.add_runtime_dependency 'rack', '>= 2.0.8', '~>2.0'
   gem.add_runtime_dependency 'redcarpet', '>=3.3.2', '~>3.3'
-  gem.add_runtime_dependency 'pact-support', '~> 1.12', '>= 1.12.1'
+  gem.add_runtime_dependency 'pact-support', '~> 1.14', '>= 1.14.1'
   gem.add_runtime_dependency 'padrino-core', '>= 0.14.3', '~> 0.14'
   gem.add_runtime_dependency 'sinatra', '>= 2.0.8.1', '< 3.0'
   gem.add_runtime_dependency 'haml', '~>5.0'
@@ -63,6 +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_development_dependency 'pact', '~>1.14'
   gem.add_development_dependency 'rspec-pact-matchers', '~>0.1'

data/spec/features/delete_pact_spec.rb

@@ -12,7 +12,6 @@ describe "Deleting a pact" do
         .create_pact_with_hierarchy("A Consumer", "1.2.3", "A Provider")
         .create_webhook
         .create_triggered_webhook
-        .create_deprecated_webhook_execution
     end
 
     it "deletes the pact" do

data/spec/features/delete_webhook_spec.rb

@@ -10,7 +10,6 @@ describe "Delete a webhook" do
       .create_pact
       .create_webhook
       .create_triggered_webhook
-      .create_deprecated_webhook_execution
       .and_return(:webhook)
   end
 

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

@@ -27,6 +27,11 @@ module PactBroker
           pact_version_sha: "1234",
           number: "1")
       end
+      let(:version) do
+        double('version',
+          pacticipant: consumer,
+          number: "2")
+      end
 
       matcher :match_route_in_api do |api|
         match do |url|
@@ -102,14 +107,14 @@ module PactBroker
         end
 
         it "builds the webhook metadata" do
-          expect(PactBrokerUrls.parse_webhook_metadata(PactBrokerUrls.build_webhook_metadata(pact))).to eq (expected_metadata)
+          expect(PactBrokerUrls.decode_webhook_metadata(PactBrokerUrls.build_webhook_metadata(pact))).to eq (expected_metadata)
         end
       end
 
-      describe "parse_webhook_metadata" do
+      describe "decode_webhook_metadata" do
         context "when the metadata is nil" do
           it "returns an empty hash" do
-            expect(PactBrokerUrls.parse_webhook_metadata(nil)).to eq({})
+            expect(PactBrokerUrls.decode_webhook_metadata(nil)).to eq({})
           end
         end
       end
@@ -127,6 +132,12 @@ module PactBroker
           it { is_expected.to eq "http://example.org/pacts/provider/Bar%2FBar/consumer/Foo%2FFoo/version/123%2F456/verification-results/latest" }
         end
       end
+
+      describe "matrix_for_pacticipant_version_url" do
+        subject { PactBrokerUrls.matrix_for_pacticipant_version_url(version, base_url) }
+
+        it { is_expected.to eq "http://example.org/matrix?q[][pacticipant]=Foo%2FFoo&q[][version]=2&latestby=cvpv" }
+      end
     end
   end
 end

data/spec/lib/pact_broker/api/renderers/html_pact_renderer_spec.rb

@@ -12,6 +12,7 @@ module PactBroker
           ENV['TZ'] = "Australia/Melbourne"
           PactBroker.configuration.enable_public_badge_access = true
           allow(PactBroker::Api::PactBrokerUrls).to receive(:pact_url).with('http://base', pact).and_return(pact_url)
+          allow(PactBroker::Api::PactBrokerUrls).to receive(:matrix_for_pacticipant_version_url).with(consumer_version, 'http://base').and_return(matrix_url)
           allow_any_instance_of(HtmlPactRenderer).to receive(:logger).and_return(logger)
 
           Timecop.freeze(created_at + 3)
@@ -24,10 +25,22 @@ module PactBroker
 
         let(:consumer) { double('consumer', name: 'Consumer')}
         let(:provider) { double('provider', name: 'Provider')}
+        let(:consumer_version) { double('consumer version') }
         let(:created_at) { DateTime.new(2014, 02, 27) }
         let(:json_content) { load_fixture('renderer_pact.json') }
-        let(:pact) { double('pact', json_content: json_content, consumer_version_number: '1.2.3', consumer: consumer, provider: provider, consumer_version_tag_names: ['prod', 'master'], created_at: created_at)}
+        let(:pact) do
+          double('pact',
+            json_content: json_content,
+            consumer_version_number: '1.2.3',
+            consumer: consumer,
+            provider: provider,
+            consumer_version_tag_names: ['prod', 'master'],
+            created_at: created_at,
+            consumer_version: consumer_version
+            )
+        end
         let(:pact_url) { '/pact/url' }
+        let(:matrix_url) { '/matrix/url' }
         let(:options) do
           {
             base_url: 'http://base',
@@ -64,6 +77,10 @@ module PactBroker
             expect(subject).to include "[![Consumer/Provider Pact Status](http://badge)](http://base)"
           end
 
+          it "includes the matrix URL" do
+            expect(subject).to include matrix_url
+          end
+
           context "when enable_public_badge_access is false" do
             before do
               PactBroker.configuration.enable_public_badge_access = false
@@ -99,7 +116,6 @@ module PactBroker
             end
           end
         end
-
       end
     end
   end

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

@@ -3,32 +3,27 @@ require 'pact_broker/api/resources/latest_pact'
 require 'rack/test'
 
 module PactBroker::Api
-
   module Resources
-
     describe LatestPact do
-
       include Rack::Test::Methods
-
-      let(:app) { PactBroker::API }
-
       describe "GET" do
-
         context "Accept: text/html" do
 
-          let(:path) { "/pacts/provider/provider_name/consumer/consumer_name/latest" }
+          let(:path) { "/pacts/provider/provider_name/consumer/consumer_name/latest/prod" }
           let(:json_content) { 'json_content' }
-          let(:pact) { double("pact", json_content: json_content)}
+          let(:pact) { double("pact", json_content: json_content, consumer_version_number: '1') }
           let(:html) { 'html' }
           let(:pact_id_params) { {provider_name: "provider_name", consumer_name: "consumer_name"} }
           let(:html_options) { { base_url: 'http://example.org', badge_url: "http://example.org#{path}/badge.svg" } }
+          let(:metadata) { double('metadata') }
+          let(:accept) { "text/html" }
 
           before do
             allow(PactBroker::Pacts::Service).to receive(:find_latest_pact).and_return(pact)
             allow(PactBroker.configuration.html_pact_renderer).to receive(:call).and_return(html)
           end
 
-          subject { get path ,{}, {'HTTP_ACCEPT' => "text/html"} }
+          subject { get(path, nil, 'HTTP_ACCEPT' => accept) }
 
           it "find the pact" do
             expect(PactBroker::Pacts::Service).to receive(:find_latest_pact).with(hash_including(pact_id_params))
@@ -36,10 +31,11 @@ module PactBroker::Api
           end
 
           it "uses the configured HTML renderer" do
-            expect(PactBroker.configuration.html_pact_renderer).to receive(:call).with(pact, html_options)
+            expect(PactBroker.configuration.html_pact_renderer).to receive(:call).with(pact, hash_including(html_options))
             subject
           end
 
+
           it "returns a HTML body" do
             subject
             expect(last_response.body).to eq html
@@ -50,10 +46,34 @@ module PactBroker::Api
             expect(last_response.headers['Content-Type']).to eq 'text/html;charset=utf-8'
           end
 
+          context "when Accept is application/hal+json" do
+            let(:accept) { "application/hal+json" }
+            let(:decorator) { instance_double(PactBroker::Api::Decorators::PactDecorator, to_json: pact_json)}
+            let(:pact_json) { { some: 'json' }.to_json }
+
+            before do
+              allow(PactBroker::Api::Decorators::PactDecorator).to receive(:new).and_return(decorator)
+              allow(PactBroker::Pacts::Metadata).to receive(:build_metadata_for_latest_pact).and_return(metadata)
+              allow_any_instance_of(LatestPact).to receive(:encode_webhook_metadata).and_return('encoded metadata')
+            end
+
+            it "builds the metadata" do
+              expect(PactBroker::Pacts::Metadata).to receive(:build_metadata_for_latest_pact).with(pact, hash_including(tag: 'prod'))
+              subject
+            end
+
+            it "encodes the metadata" do
+              expect_any_instance_of(LatestPact).to receive(:encode_webhook_metadata).with(metadata)
+              subject
+            end
+
+            it "renders the pact in JSON" do
+              expect(decorator).to receive(:to_json).with(user_options: hash_including(metadata: 'encoded metadata'))
+              expect(subject.body).to eq pact_json
+            end
+          end
         end
       end
-
     end
   end
-
 end

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

@@ -24,7 +24,7 @@ module PactBroker
           before do
             allow(PactBroker::Verifications::Service).to receive(:create).and_return(verification)
             allow(PactBroker::Verifications::Service).to receive(:errors).and_return(double(:errors, messages: ['errors'], empty?: errors_empty))
-            allow(PactBrokerUrls).to receive(:parse_webhook_metadata).and_return(parsed_metadata)
+            allow(PactBrokerUrls).to receive(:decode_webhook_metadata).and_return(parsed_metadata)
             allow_any_instance_of(Verifications).to receive(:webhook_execution_configuration).and_return(webhook_execution_configuration)
             allow(webhook_execution_configuration).to receive(:with_webhook_context).and_return(webhook_execution_configuration)
           end
@@ -65,7 +65,7 @@ module PactBroker
             end
 
             it "parses the webhook metadata" do
-              expect(PactBrokerUrls).to receive(:parse_webhook_metadata).with("abcd")
+              expect(PactBrokerUrls).to receive(:decode_webhook_metadata).with("abcd")
               subject
             end
 

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

@@ -27,7 +27,6 @@ module PactBroker
             .create_webhook
             .create_triggered_webhook
             .create_webhook_execution
-            .create_deprecated_webhook_execution
             .create_verification(provider_version: "30")
             .create_verification_webhook
             .create_triggered_webhook

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

@@ -0,0 +1,101 @@
+require 'pact_broker/db/delete_overwritten_data'
+
+module PactBroker
+  module DB
+    describe DeleteOverwrittenData, pending: IS_MYSQL do
+      describe ".call" do
+        let(:db) { PactBroker::DB.connection }
+        subject { DeleteOverwrittenData.call(db, before: before_date) }
+        let(:before_date) { nil }
+
+        context "when a pact is overwritten" do
+          let!(:pact_to_delete) { td.create_everything_for_an_integration.and_return(:pact) }
+          let!(:pact_to_keep) { td.revise_pact.and_return(:pact) }
+
+
+          it "deletes the overwritten pact" do
+            expect { subject }.to change{ db[:pact_publications].where(id: pact_to_delete.id).count }.by(-1)
+          end
+
+          it "does not delete the most recent pact" do
+            expect { subject }.to_not change{ db[:pact_publications].where(id: pact_to_keep.id).count }
+          end
+
+          it "returns a report" do
+            expect(subject[:deleted][:pact_publications]).to eq 1
+            expect(subject[:kept][:pact_publications]).to eq 1
+          end
+        end
+
+        context "when a pact has multiple verifications" do
+          let!(:verification_to_delete) do
+            td.create_pact_with_hierarchy
+              .create_verification(provider_version: "1", success: false)
+              .and_return(:verification)
+          end
+
+          let!(:verification_to_keep) { td.create_verification(provider_version: "1", number: 2, success: true).and_return(:verification) }
+
+          it "deletes the overwritten verification" do
+            expect { subject }.to change{ db[:verifications].where(id: verification_to_delete.id).count }.by(-1)
+          end
+
+          it "does not delete the most recent verification" do
+            expect { subject }.to_not change{ db[:verifications].where(id: verification_to_keep.id).count }
+          end
+
+          it "returns a report" do
+            expect(subject[:deleted][:verification_results]).to eq 1
+            expect(subject[:kept][:verification_results]).to eq 1
+          end
+        end
+
+        context "when a pact version is orphaned" do
+          before do
+            td.create_pact_with_verification.comment("this one will still have the verification, so can't be deleted")
+              .revise_pact.comment("this one can be deleted")
+              .revise_pact.comment("this one will still have a pact publication, so can't be deleted")
+          end
+
+          it "is deleted" do
+            expect { subject }.to change{ db[:pact_versions].count }.by(-1)
+          end
+
+          it "returns a report" do
+            expect(subject[:deleted][:pact_versions]).to eq 1
+            expect(subject[:kept][:pact_versions]).to eq 2
+          end
+        end
+
+        context "when the pact publication is created after the before date" do
+          before do
+            td.set_now(before_date + 1)
+              .create_pact_with_hierarchy
+              .revise_pact
+          end
+
+          let(:before_date) { DateTime.new(2010, 2, 5) }
+
+          it "doesn't delete the data" do
+            expect { subject }.to_not change { db[:pact_publications].count }
+          end
+        end
+
+        context "when the verification is created after the before date" do
+          before do
+            td.set_now(before_date + 1)
+              .create_pact_with_hierarchy
+              .create_verification(provider_version: "1", success: false)
+              .create_verification(provider_version: "1", success: true, number: 2)
+          end
+
+          let(:before_date) { DateTime.new(2010, 2, 5) }
+
+          it "doesn't delete the data" do
+            expect { subject }.to_not change { db[:verifications].count }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/pacticipants/service_spec.rb

@@ -127,7 +127,7 @@ module PactBroker
             .create_pact
             .create_webhook
             .create_triggered_webhook
-            .create_deprecated_webhook_execution
+            .create_webhook_execution
             .create_verification
         end
 

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

@@ -135,7 +135,6 @@ module PactBroker
             .create_webhook
             .create_triggered_webhook
             .create_webhook_execution
-            .create_deprecated_webhook_execution
             .revise_pact
         end
 

data/spec/lib/pact_broker/webhooks/repository_spec.rb

@@ -469,11 +469,9 @@ module PactBroker
             .create_pact
             .create_webhook
             .create_triggered_webhook
-            .create_deprecated_webhook_execution
             .create_webhook_execution
             .create_webhook
             .create_triggered_webhook
-            .create_deprecated_webhook_execution
             .create_webhook_execution
         end
         let(:webhook_id) { Webhook.find(uuid: td.webhook.uuid).id }
@@ -492,16 +490,10 @@ module PactBroker
             }
         end
 
-        it "deletes the related deprecated webhook executions" do
-          expect { subject }.to change {
-              DeprecatedExecution.count
-            }.by(-2)
-        end
-
         it "deletes the related webhook executions" do
           expect { subject }.to change {
               Execution.count
-            }.by(-2)
+            }.by(-1)
         end
       end
 
@@ -534,29 +526,6 @@ module PactBroker
               .to change { Execution.count }.by(0)
           end
         end
-
-        context "with deprecated executions (before the triggered webhook table was introduced)" do
-          before do
-            Sequel::Model.db[:webhook_executions].update(triggered_webhook_id: nil, consumer_id: td.consumer.id, provider_id: td.provider.id)
-            TriggeredWebhook.select_all.delete
-          end
-
-          it "deletes the execution by consumer" do
-            expect { Repository.new.delete_executions_by_pacticipant td.consumer }
-              .to change { Execution.count }.by(-1)
-          end
-
-          it "deletes the execution by provider" do
-            expect { Repository.new.delete_executions_by_pacticipant td.provider }
-              .to change { Execution.count }.by(-1)
-          end
-
-          it "does not delete executions for non related pacticipants" do
-            another_consumer = td.create_consumer.and_return(:consumer)
-            expect { Repository.new.delete_executions_by_pacticipant another_consumer }
-              .to change { Execution.count }.by(0)
-          end
-        end
       end
 
       describe "find_latest_triggered_webhooks" do
@@ -707,7 +676,6 @@ module PactBroker
             .create_webhook
             .create_triggered_webhook
             .create_webhook_execution
-            .create_deprecated_webhook_execution
         end
 
         subject { Repository.new.delete_triggered_webhooks_by_pact_publication_ids [td.pact.id] }
@@ -723,12 +691,6 @@ module PactBroker
             Execution.exclude(triggered_webhook_id: nil).count
           }.by(-1)
         end
-
-        it "deletes the deprecated webhook_execution" do
-          expect { subject }.to change {
-            Execution.exclude(consumer_id: nil).count
-          }.by(-1)
-        end
       end
 
       describe "delete_triggered_webhooks_by_version_id" do

data/spec/lib/pact_broker/webhooks/service_spec.rb

@@ -51,7 +51,6 @@ module PactBroker
           td.create_pact_with_hierarchy
             .create_webhook
             .create_triggered_webhook
-            .create_deprecated_webhook_execution
         end
 
         subject { Service.delete_by_uuid td.webhook.uuid }

data/spec/service_consumers/provider_states_for_pact_broker_client.rb

@@ -235,4 +235,13 @@ Pact.provider_states_for "Pact Broker Client" do
           .create_pact
     end
   end
+
+  provider_state "a webhook with the uuid 696c5f93-1b7f-44bc-8d03-59440fcaa9a0 exists" do
+    set_up do
+      TestDataBuilder.new
+          .create_consumer("Condor")
+          .create_provider("Pricing Service")
+          .create_webhook(uuid: "696c5f93-1b7f-44bc-8d03-59440fcaa9a0")
+    end
+  end
 end

data/tasks/test_db.rake

@@ -23,3 +23,10 @@ PactBroker::DB::CleanTask.new do | task |
   require 'db'
   task.database_connection = DB::PACT_BROKER_DB
 end
+
+PactBroker::DB::DeleteOverwrittenDataTask.new do | task |
+  ENV['RACK_ENV'] ||= 'test'
+  require 'db'
+  task.database_connection = DB::PACT_BROKER_DB
+  task.age_in_days = 7
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.49.0
+  version: 2.50.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -176,20 +176,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.14.1
 - !ruby/object:Gem::Dependency
   name: padrino-core
   requirement: !ruby/object:Gem::Requirement
@@ -334,6 +334,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: pact
   requirement: !ruby/object:Gem::Requirement
@@ -934,12 +948,14 @@ files:
 - lib/pact_broker/date_helper.rb
 - lib/pact_broker/db.rb
 - lib/pact_broker/db/clean.rb
+- lib/pact_broker/db/data_migrations/delete_deprecated_webhook_executions.rb
 - lib/pact_broker/db/data_migrations/helpers.rb
 - lib/pact_broker/db/data_migrations/migrate_webhook_headers.rb
 - lib/pact_broker/db/data_migrations/set_consumer_ids_for_pact_publications.rb
 - lib/pact_broker/db/data_migrations/set_latest_version_sequence_value.rb
 - lib/pact_broker/db/data_migrations/set_pacticipant_ids_for_verifications.rb
 - lib/pact_broker/db/data_migrations/set_webhooks_enabled.rb
+- lib/pact_broker/db/delete_overwritten_data.rb
 - lib/pact_broker/db/log_quietener.rb
 - lib/pact_broker/db/migrate.rb
 - lib/pact_broker/db/migrate_data.rb
@@ -980,6 +996,7 @@ files:
 - lib/pact_broker/doc/views/pact/diff-previous-distinct.markdown
 - lib/pact_broker/doc/views/pact/diff.markdown
 - lib/pact_broker/doc/views/pact/latest-pact-version.markdown
+- lib/pact_broker/doc/views/pact/matrix-for-consumer-version.markdown
 - lib/pact_broker/doc/views/pact/pact-webhooks.markdown
 - lib/pact_broker/doc/views/pact/publish-verification-results.markdown
 - lib/pact_broker/doc/views/pact/tag-prod-version.markdown
@@ -1051,6 +1068,7 @@ files:
 - lib/pact_broker/pacts/latest_pact_publications_by_consumer_version.rb
 - lib/pact_broker/pacts/latest_tagged_pact_publications.rb
 - lib/pact_broker/pacts/merger.rb
+- lib/pact_broker/pacts/metadata.rb
 - lib/pact_broker/pacts/order_hash_keys.rb
 - lib/pact_broker/pacts/pact_params.rb
 - lib/pact_broker/pacts/pact_publication.rb
@@ -1079,6 +1097,7 @@ files:
 - lib/pact_broker/tasks.rb
 - lib/pact_broker/tasks/clean_task.rb
 - lib/pact_broker/tasks/data_migration_task.rb
+- lib/pact_broker/tasks/delete_overwritten_data_task.rb
 - lib/pact_broker/tasks/migration_task.rb
 - lib/pact_broker/tasks/version_task.rb
 - lib/pact_broker/test/test_data_builder.rb
@@ -1413,6 +1432,7 @@ files:
 - spec/lib/pact_broker/db/data_migrations/migrate_webhook_headers_spec.rb
 - spec/lib/pact_broker/db/data_migrations/set_consumer_ids_for_pact_publications_spec.rb
 - spec/lib/pact_broker/db/data_migrations/set_latest_version_sequence_value_spec.rb
+- spec/lib/pact_broker/db/delete_overwritten_data_spec.rb
 - spec/lib/pact_broker/db/log_quietener_spec.rb
 - spec/lib/pact_broker/db/validate_encoding_spec.rb
 - spec/lib/pact_broker/diagnostic/resources/dependencies_spec.rb
@@ -1792,6 +1812,7 @@ test_files:
 - spec/lib/pact_broker/db/data_migrations/migrate_webhook_headers_spec.rb
 - spec/lib/pact_broker/db/data_migrations/set_consumer_ids_for_pact_publications_spec.rb
 - spec/lib/pact_broker/db/data_migrations/set_latest_version_sequence_value_spec.rb
+- spec/lib/pact_broker/db/delete_overwritten_data_spec.rb
 - spec/lib/pact_broker/db/log_quietener_spec.rb
 - spec/lib/pact_broker/db/validate_encoding_spec.rb
 - spec/lib/pact_broker/diagnostic/resources/dependencies_spec.rb