pact_broker 2.64.0 → 2.68.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fee7d96bde4fc04adb41fe041a124e81c9b371336f9308f92c918a2fb4ca914
-  data.tar.gz: 3706e5b3a8fbf6db31c748658a1b0f22713f872889757844c9506250b2cefa54
+  metadata.gz: d1076b8629f5570c2304ec89fc169be77c2b6f54aaf832ceec91d5a939806f97
+  data.tar.gz: 28c09fcdf4d7abc16f367b8c6aaebfd3f3baaa68850ae5809aefb33d92bae8fa
 SHA512:
-  metadata.gz: d1a1046845fb3832062d675ebfa1d49e0fa62ac6ea8acb8edb6c706b53e66888b72a243bc16e94842b89b4b349adf3ac22c3f35f043a75538f9dea7f3d28122a
-  data.tar.gz: fdad352fd207e05717eb127ec0ad0c35de8465b4dfed9a6cdcf862bc5d6f169bf15975a932c8cd355716b90ba3291552fadc35aab1768710179f330592fd5166
+  metadata.gz: 6fd730f1c2500942f680f66c4f526b138e71fd6f27a194b85fc280f9f1d959d6ecf79e88cb4aa685d451373cc9c3ac80714751a7d3658ec75c00f874925a8a39
+  data.tar.gz: 4327534a89cbaae5d76a86bb36aeb220668fd41805837923188e4ae1bfe2e3968d416b4c26338c6b80cc911552bb3f41db2ac0feef4a0bf70470820d1f780136

data/CHANGELOG.md

@@ -1,3 +1,63 @@
+<a name="v2.68.1"></a>
+### v2.68.1 (2020-10-24)
+
+#### Bug Fixes
+
+* set default User-Agent header in webhook requests	 ([caa71f9b](/../../commit/caa71f9b))
+
+<a name="v2.68.0"></a>
+### v2.68.0 (2020-10-23)
+
+#### Features
+
+* use a sequence for the version order on postgres	 ([da497a76](/../../commit/da497a76))
+* only cascade apps for 404s (not 405s)	 ([4e1b3083](/../../commit/4e1b3083))
+* use a sequence for the verification number on postgres	 ([b8f029ee](/../../commit/b8f029ee))
+* optimise query to find latest verification for pact	 ([db17ef5a](/../../commit/db17ef5a))
+
+<a name="v2.67.0"></a>
+### v2.67.0 (2020-10-16)
+
+#### Features
+
+* **wip pacts**
+  * if a pact was successfully verified because it was included as a WIP pact, keep it as WIP	 ([16cae55d](/../../commit/16cae55d))
+  * add 'wip' column to verification results	 ([34f98592](/../../commit/34f98592))
+
+#### Bug Fixes
+
+* typo when rendering created webhook for old webhooks path	 ([1e6a06a0](/../../commit/1e6a06a0))
+* include can-i-deploy badge in is_badge_path? logic	 ([31ea5f34](/../../commit/31ea5f34))
+
+* **pacts for verification**
+  * gracefully log empty request body	 ([0e48d13a](/../../commit/0e48d13a))
+
+* **can-i-deploy**
+  * gracefully handle pacticipant not found	 ([f6903b23](/../../commit/f6903b23))
+
+<a name="v2.66.0"></a>
+### v2.66.0 (2020-10-01)
+
+#### Features
+
+* paginate pacticipant versions	 ([f489ba7b](/../../commit/f489ba7b))
+
+* **webhooks**
+  * add event name to group by clause when selecting latest triggered webhooks	 ([134f12c8](/../../commit/134f12c8))
+
+#### Bug Fixes
+
+* maintain latest and tag params when submitting page after following link from can-i-deploy debug logs	 ([6e2f1a85](/../../commit/6e2f1a85))
+
+<a name="v2.65.0"></a>
+### v2.65.0 (2020-09-25)
+
+#### Features
+
+* **pacts for verification**
+  * allow API to be disabled by setting PACT_BROKER_FEATURES=disable_pacts_for_verification	 ([bab116b3](/../../commit/bab116b3))
+  * update wording for inclusion notice when selector has a consumer specified	 ([61370d1f](/../../commit/61370d1f))
+
 <a name="v2.64.0"></a>
 ### v2.64.0 (2020-09-25)
 

data/Gemfile

@@ -25,6 +25,7 @@ group :test do
   gem 'timecop', '~> 0.9'
   gem 'faraday', '~>0.15'
   gem 'docker-api', '~>1.34'
+  gem 'approvals', '>=0.0.1', '<1.0.0'
 end
 
 if ENV['INSTALL_MYSQL'] == "true"

data/db/ddl_statements/latest_triggered_webhooks.rb

@@ -0,0 +1,66 @@
+# These views find the latest triggered webhook for each webhook/consumer/provider
+# by finding the latest execution date for each webhook
+# then taking the row with the max ID in case there there are two
+# triggered webhooks for the same UUID and same creation date
+# Not sure if this is strictly necessary to do the extra step, but better to be
+# safe than sorry.
+# I probably could just take the max ID for each webhook/consumer/provider, but
+# something in my head says that
+# relying on the primary key for order is not a good idea, even though
+# according to the SQL it should be fine.
+def latest_triggered_webhook_creation_dates_v2
+  "select webhook_uuid, consumer_id, provider_id, max(created_at) as latest_triggered_webhook_created_at
+  from triggered_webhooks
+  group by webhook_uuid, consumer_id, provider_id"
+end
+
+# Ignore ltwcd.latest_triggered_webhook_created_at, it's there because postgres doesn't allow you to modify
+# the names and types of columns in a view
+def latest_triggered_webhook_ids_v2
+  "select tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at, max(tw.id) as latest_triggered_webhook_id
+  from latest_triggered_webhook_creation_dates ltwcd
+  inner join triggered_webhooks tw
+  on tw.consumer_id = ltwcd.consumer_id
+  and tw.provider_id = ltwcd.provider_id
+  and tw.webhook_uuid = ltwcd.webhook_uuid
+  and tw.created_at = ltwcd.latest_triggered_webhook_created_at
+  group by tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at"
+end
+
+def latest_triggered_webhooks_v2
+  "select tw.*
+  from triggered_webhooks tw
+  inner join latest_triggered_webhook_ids ltwi
+  on tw.consumer_id = ltwi.consumer_id
+  and tw.provider_id = ltwi.provider_id
+  and tw.webhook_uuid = ltwi.webhook_uuid
+  and tw.id = ltwi.latest_triggered_webhook_id"
+end
+
+# use explicit columns - can't drop event_name in 20200922_add_event_to_triggered_webhook.rb
+# if tw.* is used because you can't remove columns from a view in postgres
+def latest_triggered_webhooks_v3_rollback(is_postgres)
+  if is_postgres
+    "select tw.id, tw.trigger_uuid, tw.trigger_type, tw.pact_publication_id, tw.webhook_id, tw.webhook_uuid, tw.consumer_id, tw.provider_id, tw.status, tw.created_at, tw.updated_at, tw.verification_id, ''::text as event_name
+    from triggered_webhooks tw
+    inner join latest_triggered_webhook_ids ltwi
+    on tw.consumer_id = ltwi.consumer_id
+    and tw.provider_id = ltwi.provider_id
+    and tw.webhook_uuid = ltwi.webhook_uuid
+    and tw.id = ltwi.latest_triggered_webhook_id"
+  else
+    latest_triggered_webhooks_v2
+  end
+end
+
+##### v3
+
+# screw dates, just use IDs.
+def latest_triggered_webhooks_v3
+  "select tw.id, tw.trigger_uuid, tw.trigger_type, tw.pact_publication_id, tw.webhook_id, tw.webhook_uuid, tw.consumer_id, tw.provider_id, tw.status, tw.created_at, tw.updated_at, tw.verification_id, tw.event_name
+  from triggered_webhooks tw
+  inner join (select max(id) as max_id
+    from triggered_webhooks
+    group by webhook_uuid, consumer_id, provider_id, event_name) latest_ids
+  on latest_ids.max_id = tw.id"
+end

data/db/migrations/20180119_update_latest_triggered_webhooks.rb

@@ -1,44 +1,10 @@
+require_relative '../ddl_statements/latest_triggered_webhooks'
+
 Sequel.migration do
   up do
-    # These views find the latest triggered webhook for each webhook/consumer/provider
-    # by finding the latest execution date for each webhook
-    # then taking the row with the max ID in case there there are two
-    # triggered webhooks for the same UUID and same creation date
-    # Not sure if this is strictly necessary to do the extra step, but better to be
-    # safe than sorry.
-    # I probably could just take the max ID for each webhook/consumer/provider, but
-    # something in my head says that
-    # relying on the primary key for order is not a good idea, even though
-    # according to the SQL it should be fine.
-
-    create_or_replace_view(:latest_triggered_webhook_creation_dates,
-      "select webhook_uuid, consumer_id, provider_id, max(created_at) as latest_triggered_webhook_created_at
-      from triggered_webhooks
-      group by webhook_uuid, consumer_id, provider_id"
-    )
-
-    # Ignore ltwcd.latest_triggered_webhook_created_at, it's there because postgres doesn't allow you to modify
-    # the names and types of columns in a view
-    create_or_replace_view(:latest_triggered_webhook_ids,
-      "select tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at, max(tw.id) as latest_triggered_webhook_id
-      from latest_triggered_webhook_creation_dates ltwcd
-      inner join triggered_webhooks tw
-      on tw.consumer_id = ltwcd.consumer_id
-      and tw.provider_id = ltwcd.provider_id
-      and tw.webhook_uuid = ltwcd.webhook_uuid
-      and tw.created_at = ltwcd.latest_triggered_webhook_created_at
-      group by tw.webhook_uuid, tw.consumer_id, tw.provider_id, ltwcd.latest_triggered_webhook_created_at"
-    )
-
-    create_or_replace_view(:latest_triggered_webhooks,
-      "select tw.*
-      from triggered_webhooks tw
-      inner join latest_triggered_webhook_ids ltwi
-      on tw.consumer_id = ltwi.consumer_id
-      and tw.provider_id = ltwi.provider_id
-      and tw.webhook_uuid = ltwi.webhook_uuid
-      and tw.id = ltwi.latest_triggered_webhook_id"
-    )
+    create_or_replace_view(:latest_triggered_webhook_creation_dates, latest_triggered_webhook_creation_dates_v2)
+    create_or_replace_view(:latest_triggered_webhook_ids, latest_triggered_webhook_ids_v2)
+    create_or_replace_view(:latest_triggered_webhooks, latest_triggered_webhooks_v2)
   end
 
   down do

data/db/migrations/20200930_update_latest_triggered_webhooks.rb

@@ -0,0 +1,15 @@
+require_relative '../ddl_statements/latest_triggered_webhooks'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  up do
+    # TODO
+    # drop_view(:latest_triggered_webhook_ids)
+    # drop_view(:latest_triggered_webhook_creation_dates)
+    create_or_replace_view(:latest_triggered_webhooks, latest_triggered_webhooks_v3)
+  end
+
+  down do
+    create_or_replace_view(:latest_triggered_webhooks, latest_triggered_webhooks_v3_rollback(PactBroker::MigrationHelper.postgres?))
+  end
+end

data/db/migrations/20201006_add_wip_to_verification.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:verifications, :wip, TrueClass, default: false, null: false)
+  end
+end

data/db/migrations/20201023_create_verification_number_sequence.rb

@@ -0,0 +1,20 @@
+require_relative 'migration_helper'
+
+Sequel.migration do
+  up do
+    if PactBroker::MigrationHelper.postgres?
+      row = from(:verification_sequence_number).select(:value).limit(1).first
+      start = row ? row[:value] + 100 : 1
+      run("CREATE SEQUENCE verification_number_sequence START WITH #{start}")
+    end
+  end
+
+  down do
+    if PactBroker::MigrationHelper.postgres?
+      nextval = execute("SELECT nextval('verification_number_sequence') as val") { |v| v.first["val"].to_i }
+      # Add a safety margin!
+      from(:verification_sequence_number).update(value: nextval + 100)
+      run("DROP SEQUENCE verification_number_sequence")
+    end
+  end
+end

data/db/migrations/20201024_create_version_order_sequence.rb

@@ -0,0 +1,20 @@
+require_relative 'migration_helper'
+
+Sequel.migration do
+  up do
+    if PactBroker::MigrationHelper.postgres?
+      row = from(:version_sequence_number).select(:value).limit(1).first
+      start = row ? row[:value] + 100 : 1
+      run("CREATE SEQUENCE version_order_sequence START WITH #{start}")
+    end
+  end
+
+  down do
+    if PactBroker::MigrationHelper.postgres?
+      nextval = execute("SELECT nextval('version_order_sequence') as val") { |v| v.first["val"].to_i }
+      # Add a safety margin!
+      from(:version_sequence_number).update(value: nextval + 100)
+      run("DROP SEQUENCE version_order_sequence")
+    end
+  end
+end

data/db/migrations/migration_helper.rb

@@ -4,7 +4,7 @@ module PactBroker
     extend self
 
     def large_text_type
-      if adapter == 'postgres'
+      if postgres?
         :text
       else
         # Assume mysql
@@ -13,11 +13,19 @@ module PactBroker
     end
 
     def with_mysql
-      if adapter =~ /mysql/
+      if mysql?
         yield
       end
     end
 
+    def mysql?
+      adapter =~ /mysql/
+    end
+
+    def postgres?
+      adapter == 'postgres'
+    end
+
     def adapter
       Sequel::Model.db.adapter_scheme.to_s
     end

data/docker-compose-issue-repro.yml

@@ -0,0 +1,18 @@
+version: "3"
+
+services:
+  pact-broker:
+    build:
+      context: .
+      dockerfile: issue-reproduction/Dockerfile-pact-broker
+    ports:
+      - "9292:9292"
+    command: bundle exec rackup -p 9292 -o 0.0.0.0
+
+  repro-issue:
+    build:
+      context: .
+      dockerfile: issue-reproduction/Dockerfile-pact-broker
+    depends_on:
+      - pact-broker
+    command: dockerize -wait http://pact-broker:9292 -timeout 30s /home/script/reproduce-issue.rb

data/issue-reproduction/Dockerfile-pact-broker

@@ -0,0 +1,42 @@
+FROM ruby:2.5.3-alpine
+
+RUN apk update \
+    && apk --no-cache add \
+      "build-base>=0.5" \
+      "bash>=4.4" \
+      "ca-certificates>=20190108" \
+      "git>=2.20" \
+      "postgresql-dev>=11.3" \
+      "sqlite-dev>=3.28" \
+      "sqlite>=3.28" \
+      "tzdata>=2019" \
+      "mariadb-dev>=10.3" \
+    && rm -rf /var/cache/apk/*
+
+RUN apk add --no-cache openssl less
+
+ENV DOCKERIZE_VERSION v0.6.1
+RUN wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && tar -C /usr/local/bin -xzvf dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz \
+    && rm dockerize-alpine-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+
+
+WORKDIR /home
+
+COPY Gemfile /home/Gemfile
+COPY pact_broker.gemspec /home/pact_broker.gemspec
+COPY lib/pact_broker/version.rb /home/lib/pact_broker/version.rb
+COPY .gitignore /home/.gitignore
+
+RUN gem install bundler -v '~>2.0.0' \
+    && bundle install --jobs 3 --retry 3
+
+COPY lib /home/lib
+COPY db /home/db
+COPY public /home/public
+COPY tasks /home/tasks
+COPY config.ru /home/config.ru
+COPY Rakefile /home/Rakefile
+COPY script  /home/script
+
+RUN ls /home

data/lib/db.rb

@@ -27,7 +27,9 @@ module DB
   def self.connect db_credentials
     # Keep this conifiguration in sync with lib/pact_broker/app.rb#configure_database_connection
     Sequel.datetime_class = DateTime
-    # logger = Logger.new($stdout)
+    if ENV['DEBUG'] == 'true'
+      logger = Logger.new($stdout)
+    end
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool, :encoding => 'utf8'))
     con.extension(:connection_validator)
     con.extension(:pagination)
@@ -58,6 +60,10 @@ module DB
     !!(PACT_BROKER_DB.adapter_scheme.to_s =~ /mysql/)
   end
 
+  def self.postgres?
+    !!(PACT_BROKER_DB.adapter_scheme.to_s == "postgres")
+  end
+
   PACT_BROKER_DB ||= connection_for_env ENV.fetch('RACK_ENV')
 
   def self.health_check

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

@@ -2,14 +2,14 @@ module PactBroker
   module Api
     module Decorators
       class DecoratorContext < Hash
-
-        attr_reader :base_url, :resource_url, :resource_title, :env
+        attr_reader :base_url, :resource_url, :resource_title, :env, :query_string
 
         def initialize base_url, resource_url, env, options = {}
           @base_url = self[:base_url] = base_url
           @resource_url = self[:resource_url] = resource_url
           @resource_title = self[:resource_title] = options[:resource_title]
           @env = self[:env] = env
+          @query_string = self[:query_string] = (env['QUERY_STRING'] && !env['QUERY_STRING'].empty? ? env['QUERY_STRING'] : nil)
           merge!(options)
         end
 

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

@@ -0,0 +1,34 @@
+require 'roar/decorator'
+require 'roar/json/hal'
+
+module PactBroker
+  module Api
+    module Decorators
+      module PaginationLinks
+        include Roar::JSON::HAL
+        include Roar::JSON::HAL::Links
+
+        link :next do | context |
+          if represented.respond_to?(:current_page) &&
+              represented.respond_to?(:page_count) &&
+              represented.current_page < represented.page_count
+            {
+              href: context[:resource_url] + "?pageSize=#{represented.page_size}&pageNumber=#{represented.current_page + 1}",
+              title: "Next page"
+            }
+
+          end
+        end
+
+        link :previous do | context |
+          if represented.respond_to?(:first_page?) && !represented.first_page?
+            {
+              href: context[:resource_url] + "?pageSize=#{represented.page_size}&pageNumber=#{represented.current_page - 1}",
+              title: "Previous page"
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,14 +20,16 @@ module PactBroker
             getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
 
           def notices(user_options)
-            pact_url = pact_version_url(represented, user_options[:base_url])
+            metadata = represented.wip ? { wip: true } : nil
+            pact_url = pact_version_url_with_metadata(represented, metadata, user_options[:base_url])
             PactBroker::Pacts::BuildVerifiablePactNotices.call(represented, pact_url, user_options)
           end
         end
 
         link :self do | user_options |
+          metadata = represented.wip ? { wip: true } : nil
           {
-            href: pact_version_url(represented, user_options[:base_url]),
+            href: pact_version_url_with_metadata(represented, metadata, user_options[:base_url]),
             name: represented.name
           }
         end