pact_broker 2.77.0 → 2.80.0

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

@@ -1,10 +1,9 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/webhooks/triggered_webhook'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/webhooks/triggered_webhook"
 
 module PactBroker
   module Api
     module Resources
-
       class TriggeredWebhookLogs < BaseResource
 
         def content_types_provided
@@ -21,20 +20,29 @@ module PactBroker
 
         def to_text
           # Too simple to bother putting into a service
-          triggered_webhook.webhook_executions.collect(&:logs).join("\n")
+          if webhook_executions.any?
+            webhook_executions.collect(&:logs).join("\n")
+          else
+            "Webhook has not executed yet. Please retry in a few seconds."
+          end
         end
 
         def policy_name
           :'webhooks::webhook'
         end
 
+        def policy_record
+          triggered_webhook&.webhook
+        end
+
         private
 
+        def webhook_executions
+          @webhook_executions ||= triggered_webhook.webhook_executions
+        end
+
         def triggered_webhook
-          @triggered_webhook ||= begin
-            criteria = { webhook_uuid: identifier_from_path[:uuid], trigger_uuid: identifier_from_path[:trigger_uuid] }
-            PactBroker::Webhooks::TriggeredWebhook.where(criteria).single_record
-          end
+          @triggered_webhook ||= PactBroker::Webhooks::TriggeredWebhook.find(uuid: identifier_from_path[:uuid])
         end
       end
     end

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

@@ -1,9 +1,9 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/configuration'
-require 'pact_broker/domain/verification'
-require 'pact_broker/api/contracts/verification_contract'
-require 'pact_broker/api/decorators/verification_decorator'
-require 'pact_broker/api/decorators/extended_verification_decorator'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/configuration"
+require "pact_broker/domain/verification"
+require "pact_broker/api/contracts/verification_contract"
+require "pact_broker/api/decorators/verification_decorator"
+require "pact_broker/api/decorators/extended_verification_decorator"
 
 module PactBroker
   module Api
@@ -24,9 +24,11 @@ module PactBroker
         end
 
         def resource_exists?
-          if identifier_from_path[:verification_number] == "all"
+          if verification_number == "all"
             set_json_error_message("To see all the verifications for a pact, use the Matrix page")
             false
+          elsif !verification_number_is_integer?
+            false
           else
             !!verification
           end
@@ -66,6 +68,14 @@ module PactBroker
         def extended_decorator_for model
           decorator_class(:extended_verification_decorator).new(model)
         end
+
+        def verification_number
+          identifier_from_path[:verification_number]
+        end
+
+        def verification_number_is_integer?
+          verification_number =~ /^\d+$/
+        end
       end
     end
   end

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

@@ -1,5 +1,5 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/api/decorators/triggered_webhooks_decorator'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/decorators/triggered_webhooks_decorator"
 
 module PactBroker
   module Api
@@ -22,7 +22,11 @@ module PactBroker
         end
 
         def policy_name
-          :'webhooks::triggered_webhooks'
+          :'verifications::verification'
+        end
+
+        def policy_record
+          verification
         end
 
         private

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

@@ -1,10 +1,10 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/configuration'
-require 'pact_broker/domain/verification'
-require 'pact_broker/api/contracts/verification_contract'
-require 'pact_broker/api/decorators/verification_decorator'
-require 'pact_broker/api/resources/webhook_execution_methods'
-require 'pact_broker/api/resources/metadata_resource_methods'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/configuration"
+require "pact_broker/domain/verification"
+require "pact_broker/api/contracts/verification_contract"
+require "pact_broker/api/decorators/verification_decorator"
+require "pact_broker/api/resources/webhook_execution_methods"
+require "pact_broker/api/resources/metadata_resource_methods"
 
 module PactBroker
   module Api
@@ -50,8 +50,10 @@ module PactBroker
         end
 
         def from_json
-          verification = verification_service.create(next_verification_number, verification_params, pact, event_context, webhook_options)
-          response.body = decorator_for(verification).to_json(decorator_options)
+          handle_webhook_events do
+            verification = verification_service.create(next_verification_number, verification_params, pact, event_context)
+            response.body = decorator_for(verification).to_json(decorator_options)
+          end
           true
         end
 
@@ -78,22 +80,15 @@ module PactBroker
         end
 
         def wip?
-          metadata[:wip] == 'true'
+          metadata[:wip] == "true"
         end
 
         def event_context
           metadata
         end
 
-        def webhook_options
-          {
-            database_connector: database_connector,
-            webhook_execution_configuration: webhook_execution_configuration
-          }
-        end
-
         def verification_params
-          params(symbolize_names: false).merge('wip' => wip?)
+          params(symbolize_names: false).merge("wip" => wip?)
         end
       end
     end

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

@@ -1,6 +1,6 @@
-require 'pact_broker/services'
-require 'pact_broker/api/decorators/version_decorator'
-require 'pact_broker/api/resources/base_resource'
+require "pact_broker/services"
+require "pact_broker/api/decorators/version_decorator"
+require "pact_broker/api/resources/base_resource"
 
 module PactBroker
   module Api
@@ -11,11 +11,22 @@ module PactBroker
         end
 
         def content_types_accepted
-          [["application/json", :from_json]]
+          [
+            ["application/json", :from_json],
+            ["application/merge-patch+json", :from_merge_patch_json]
+          ]
         end
 
         def allowed_methods
-          ["GET", "PUT", "DELETE", "OPTIONS"]
+          ["GET", "PUT", "PATCH", "DELETE", "OPTIONS"]
+        end
+
+        def is_conflict?
+          if (errors = version_service.conflict_errors(version, parsed_version, resource_url)).any?
+            set_json_validation_error_messages(errors)
+          else
+            false
+          end
         end
 
         def resource_exists?
@@ -23,15 +34,27 @@ module PactBroker
         end
 
         def from_json
-          response_code = version ? 200 : 201
-          parsed_version = Decorators::VersionDecorator.new(PactBroker::Domain::Version.new).from_json(request_body)
-          @version = version_service.create_or_update(pacticipant_name, pacticipant_version_number, parsed_version)
-          response.body = to_json
-          response_code
+          if request.really_put?
+            handle_request do
+              version_service.create_or_overwrite(pacticipant_name, pacticipant_version_number, parsed_version)
+            end
+          else
+            415
+          end
+        end
+
+        def from_merge_patch_json
+          if request.patch?
+            handle_request do
+              version_service.create_or_update(pacticipant_name, pacticipant_version_number, parsed_version)
+            end
+          else
+            415
+          end
         end
 
         def to_json
-          decorator_class(:version_decorator).new(version).to_json(decorator_options)
+          decorator_class(:version_decorator).new(version).to_json(decorator_options(environments: environments))
         end
 
         def delete_resource
@@ -45,6 +68,21 @@ module PactBroker
 
         private
 
+        def handle_request
+          response_code = version ? 200 : 201
+          @version = yield
+          response.body = to_json
+          response_code
+        end
+
+        def parsed_version
+          @parsed_version ||= Decorators::VersionDecorator.new(OpenStruct.new).from_json(request_body)
+        end
+
+        def environments
+          @environments ||= environment_service.find_for_pacticipant(version.pacticipant)
+        end
+
         def version
           @version ||= version_service.find_by_pacticipant_name_and_number(identifier_from_path)
         end

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

@@ -1,6 +1,6 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/configuration'
-require 'pact_broker/api/decorators/versions_decorator'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/configuration"
+require "pact_broker/api/decorators/versions_decorator"
 
 module PactBroker
   module Api
@@ -31,10 +31,10 @@ module PactBroker
         end
 
         def pagination_options
-          if request.query['pageNumber'] || request.query['pageSize']
+          if request.query["pageNumber"] || request.query["pageSize"]
             {
-              page_number: request.query['pageNumber']&.to_i || 1,
-              page_size: request.query['pageSize']&.to_i || 100
+              page_number: request.query["pageNumber"]&.to_i || 1,
+              page_size: request.query["pageSize"]&.to_i || 100
             }
           else
             nil

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

@@ -1,7 +1,7 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/services'
-require 'pact_broker/api/decorators/webhook_decorator'
-require 'pact_broker/api/resources/webhook_resource_methods'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/services"
+require "pact_broker/api/decorators/webhook_decorator"
+require "pact_broker/api/resources/webhook_resource_methods"
 
 module PactBroker
   module Api
@@ -23,11 +23,7 @@ module PactBroker
         end
 
         def resource_exists?
-          !!resource_object
-        end
-
-        def resource_object
-          webhook
+          !!webhook
         end
 
         def malformed_request?
@@ -61,6 +57,18 @@ module PactBroker
           :'webhooks::webhook'
         end
 
+        def action
+          if request.put?
+            webhook ? :update : :create
+          else
+            super
+          end
+        end
+
+        def policy_record
+          webhook || parsed_webhook
+        end
+
         private
 
         def webhook

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

@@ -1,10 +1,10 @@
-require 'pact_broker/api/resources/base_resource'
-require 'pact_broker/services'
-require 'pact_broker/api/decorators/webhook_execution_result_decorator'
-require 'pact_broker/api/resources/webhook_resource_methods'
-require 'pact_broker/constants'
-require 'pact_broker/webhooks/execution_configuration'
-require 'pact_broker/api/resources/webhook_execution_methods'
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/services"
+require "pact_broker/api/decorators/webhook_execution_result_decorator"
+require "pact_broker/api/resources/webhook_resource_methods"
+require "pact_broker/constants"
+require "pact_broker/webhooks/execution_configuration"
+require "pact_broker/api/resources/webhook_execution_methods"
 
 module PactBroker
   module Api
@@ -26,18 +26,14 @@ module PactBroker
         end
 
         def process_post
-          webhook_execution_result = webhook_service.test_execution(webhook, webhook_execution_configuration.webhook_context, webhook_execution_configuration)
-          response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
+          webhook_execution_result = webhook_trigger_service.test_execution(webhook, webhook_execution_configuration.webhook_context, webhook_execution_configuration)
+          response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
           response.body = post_response_body(webhook_execution_result)
           true
         end
 
         def resource_exists?
-          !!resource_object
-        end
-
-        def resource_object
-          webhook
+          !!webhook
         end
 
         def malformed_request?
@@ -52,6 +48,14 @@ module PactBroker
           :'webhooks::webhook'
         end
 
+        def action
+          :execute
+        end
+
+        def policy_record
+          webhook
+        end
+
         private
 
         def post_response_body webhook_execution_result

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

@@ -1,3 +1,6 @@
+require "pact_broker/webhooks/event_listener"
+require "pact_broker/events/subscriber"
+
 module PactBroker
   module Api
     module Resources
@@ -5,6 +8,34 @@ module PactBroker
         def webhook_execution_configuration
           application_context.webhook_execution_configuration_creator.call(self)
         end
+
+        def webhook_options
+          {
+            database_connector: database_connector,
+            webhook_execution_configuration: webhook_execution_configuration
+          }
+        end
+
+        def webhook_event_listener
+          @webhook_event_listener ||= PactBroker::Webhooks::EventListener.new(webhook_options)
+        end
+
+        def handle_webhook_events
+          PactBroker::Events.subscribe(webhook_event_listener) do
+            yield
+          end
+        end
+
+        def schedule_triggered_webhooks
+          webhook_event_listener.schedule_triggered_webhooks
+        end
+
+        def finish_request
+          if response.code < 400
+            schedule_triggered_webhooks
+          end
+          super
+        end
       end
     end
   end

data/lib/pact_broker/app.rb

@@ -1,24 +1,24 @@
-require 'pact_broker/configuration'
-require 'pact_broker/db'
-require 'pact_broker/project_root'
-require 'pact_broker/logging/default_formatter'
-require 'pact_broker/policies'
-require 'rack-protection'
-require 'rack/hal_browser'
-require 'rack/pact_broker/set_base_url'
-require 'rack/pact_broker/add_pact_broker_version_header'
-require 'rack/pact_broker/convert_file_extension_to_accept_header'
-require 'rack/pact_broker/database_transaction'
-require 'rack/pact_broker/invalid_uri_protection'
-require 'rack/pact_broker/ui_request_filter'
-require 'rack/pact_broker/ui_authentication'
-require 'rack/pact_broker/configurable_make_it_later'
-require 'rack/pact_broker/no_auth'
-require 'rack/pact_broker/convert_404_to_hal'
-require 'rack/pact_broker/reset_thread_data'
-require 'rack/pact_broker/add_vary_header'
-require 'rack/pact_broker/use_when'
-require 'sucker_punch'
+require "pact_broker/configuration"
+require "pact_broker/db"
+require "pact_broker/project_root"
+require "pact_broker/logging/default_formatter"
+require "pact_broker/policies"
+require "rack-protection"
+require "rack/hal_browser"
+require "rack/pact_broker/set_base_url"
+require "rack/pact_broker/add_pact_broker_version_header"
+require "rack/pact_broker/convert_file_extension_to_accept_header"
+require "rack/pact_broker/database_transaction"
+require "rack/pact_broker/invalid_uri_protection"
+require "rack/pact_broker/ui_request_filter"
+require "rack/pact_broker/ui_authentication"
+require "rack/pact_broker/configurable_make_it_later"
+require "rack/pact_broker/no_auth"
+require "rack/pact_broker/convert_404_to_hal"
+require "rack/pact_broker/reset_thread_data"
+require "rack/pact_broker/add_vary_header"
+require "rack/pact_broker/use_when"
+require "sucker_punch"
 
 module PactBroker
 
@@ -28,13 +28,13 @@ module PactBroker
 
     attr_accessor :configuration
 
-    def initialize &block
+    def initialize
       @app_builder = ::Rack::Builder.new
       @cascade_apps = []
       @make_it_later_api_auth = ::Rack::PactBroker::ConfigurableMakeItLater.new(Rack::PactBroker::NoAuth)
       @make_it_later_ui_auth = ::Rack::PactBroker::ConfigurableMakeItLater.new(Rack::PactBroker::NoAuth)
       # Can only be required after database connection has been made because the decorators rely on the Sequel models
-      @create_pact_broker_api_block = ->() { require 'pact_broker/api'; PactBroker::API }
+      @create_pact_broker_api_block = ->() { require "pact_broker/api"; PactBroker::API }
       @configuration = PactBroker.configuration
       yield configuration
       post_configure
@@ -50,7 +50,7 @@ module PactBroker
     # the middleware with the app, and run it manually.
     # eg run MyMiddleware.new(app)
     def use *args, &block
-      @app_builder.use *args, &block
+      @app_builder.use(*args, &block)
     end
 
     # private API, not sure if this will continue to be supported
@@ -85,7 +85,7 @@ module PactBroker
 
     def post_configure
       configure_logger
-      SuckerPunch.logger = configuration.custom_logger || SemanticLogger['SuckerPunch']
+      SuckerPunch.logger = configuration.custom_logger || SemanticLogger["SuckerPunch"]
       configure_database_connection
       configure_sucker_punch
     end
@@ -112,12 +112,12 @@ module PactBroker
         logger.info "Skipping data migrations"
       end
 
-      require 'pact_broker/webhooks/service'
+      require "pact_broker/webhooks/service"
       PactBroker::Webhooks::Service.fail_retrying_triggered_webhooks
     end
 
     def load_configuration_from_database
-      require 'pact_broker/config/load'
+      require "pact_broker/config/load"
       PactBroker::Config::Load.call(configuration)
     end
 
@@ -126,9 +126,11 @@ module PactBroker
       PactBroker::DB.connection = configuration.database_connection
       PactBroker::DB.connection.timezone = :utc
       PactBroker::DB.connection.extend_datasets do
+        # rubocop: disable Lint/NestedMethodDefinition
         def any?
           !empty?
         end
+        # rubocop: enable Lint/NestedMethodDefinition
       end
       PactBroker::DB.validate_connection_config if configuration.validate_database_connection_config
       PactBroker::DB.set_mysql_strict_mode_if_mysql
@@ -147,7 +149,7 @@ module PactBroker
         configuration.example_data_seeder.call
         logger.info "Marking seed as done"
         configuration.seed_example_data = false
-        require 'pact_broker/config/save'
+        require "pact_broker/config/save"
         PactBroker::Config::Save.call(configuration, [:seed_example_data])
       else
         logger.info "Not seeding example data"
@@ -174,8 +176,8 @@ module PactBroker
       if configuration.use_rack_protection
         @app_builder.use Rack::Protection, except: [:path_traversal, :remote_token, :session_hijacking, :http_origin]
 
-        is_hal_browser = ->(env) { env['PATH_INFO'] == '/hal-browser/browser.html' }
-        not_hal_browser = ->(env) { env['PATH_INFO'] != '/hal-browser/browser.html' }
+        is_hal_browser = ->(env) { env["PATH_INFO"] == "/hal-browser/browser.html" }
+        not_hal_browser = ->(env) { env["PATH_INFO"] != "/hal-browser/browser.html" }
 
         @app_builder.use_when not_hal_browser,
           Rack::Protection::ContentSecurityPolicy, configuration.content_security_policy
@@ -188,10 +190,10 @@ module PactBroker
       @app_builder.use Rack::PactBroker::AddPactBrokerVersionHeader
       @app_builder.use Rack::PactBroker::AddVaryHeader
       @app_builder.use Rack::Static, :urls => ["/stylesheets", "/css", "/fonts", "/js", "/javascripts", "/images"], :root => PactBroker.project_root.join("public")
-      @app_builder.use Rack::Static, :urls => ["/favicon.ico"], :root => PactBroker.project_root.join("public/images"), header_rules: [[:all, {'Content-Type' => 'image/x-icon'}]]
+      @app_builder.use Rack::Static, :urls => ["/favicon.ico"], :root => PactBroker.project_root.join("public/images"), header_rules: [[:all, {"Content-Type" => "image/x-icon"}]]
       @app_builder.use Rack::PactBroker::ConvertFileExtensionToAcceptHeader
       # Rack::PactBroker::SetBaseUrl needs to be before the Rack::PactBroker::HalBrowserRedirect
-      @app_builder.use Rack::PactBroker::SetBaseUrl, configuration.base_url
+      @app_builder.use Rack::PactBroker::SetBaseUrl, configuration.base_urls
 
       if configuration.use_hal_browser
         logger.info "Mounting HAL browser"
@@ -203,7 +205,7 @@ module PactBroker
 
     def build_ui
       logger.info "Mounting UI"
-      require 'pact_broker/ui'
+      require "pact_broker/ui"
       ui_apps = [PactBroker::UI::App.new]
       ui_apps.unshift(@custom_ui) if @custom_ui
       builder = ::Rack::Builder.new
@@ -227,7 +229,7 @@ module PactBroker
     end
 
     def build_diagnostic
-      require 'pact_broker/diagnostic/app'
+      require "pact_broker/diagnostic/app"
       builder = ::Rack::Builder.new
       builder.use @make_it_later_api_auth
       builder.run PactBroker::Diagnostic::App.new
@@ -260,7 +262,7 @@ module PactBroker
     end
 
     def print_startup_message
-      if ENV['PACT_BROKER_HIDE_PACTFLOW_MESSAGES'] != 'true'
+      if ENV["PACT_BROKER_HIDE_PACTFLOW_MESSAGES"] != "true"
         logger.info "\n\n#{'*' * 80}\n\nWant someone to manage your Pact Broker for you? 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
     end