pact_broker 2.112.0 → 2.113.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7da30c01ac5c3b656df24282a63fe7d18e42d83ed7ffdda14d3919481497f39
-  data.tar.gz: 71c525bd8ac9ed56c8d15f3f2d6c274a32c925be65e75f889d351033d759c400
+  metadata.gz: 7f58c954e3864629cd056224198acfe87df68d7a38ff2a098bf1c7e78541a8d1
+  data.tar.gz: 6f59e94416775c9beb054cd7ef0ca77e055505e99864a8cc0c0dd4c8a0bf3f9b
 SHA512:
-  metadata.gz: 95f5eed3bcda08ad27274d0bf858ea78319455ca45f783b0cd21a3709ee1ac3a1956325713466b8f1438cda86f83f51a35cccb875c81f864d2f53b054f7c0807
-  data.tar.gz: e51971781ce0679309cd60a8bb0eb281b2fc9a01872db91a4cd6f3f00b575805e7b5244d2b0f4d68a699140799e8cf50fca9940ddd72c77b207ca749de468fda
+  metadata.gz: d64bab2b42d053d80a63c797e2a3ee84f2731a8eee85368a31bb1d70a102ef38df362feb7ef9151b2890307944123e0a0ec04acb82e1c7d956f88c12d6935116
+  data.tar.gz: 8c46ee348ffad72bad86d132873e1d812c70585b570d8e63c7b71187dfd653afa1eea795f804b8fb2d2ed3fe1f7d372996ff4eb598fcc17a775cd214be5cb236

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+<a name="v2.113.0"></a>
+### v2.113.0 (2025-02-13)
+
+#### Features
+
+* aggregated provider state endpoint (#734)	 ([108d11a7](/../../commit/108d11a7))
+* add more logging to data migrations	 ([9482d44d](/../../commit/9482d44d))
+
+#### Bug Fixes
+
+* make sure last_action_date always returns a DateTime object	 ([d60c264e](/../../commit/d60c264e))
+
 <a name="v2.112.0"></a>
 ### v2.112.0 (2024-09-09)
 

data/Gemfile

@@ -3,15 +3,17 @@ source "https://rubygems.org"
 gemspec
 
 
-gem "rake", "~>12.3.3"
+gem "rake", "~>13.0"
 gem "sqlite3", ">=2.0.0"
 gem "conventional-changelog", "~>1.3"
 gem "bump", "~> 0.5"
+gem "padrino-core", ">= 0.14.3", "~> 0.14", require: false
+gem "sinatra", "~> 3.0", require: false
 
 group :development do
   gem "pry-byebug"
-  gem "rubocop", "~>1.1"
-  gem "rubocop-performance", "~> 1.11"
+  gem "rubocop", "~>1.7"
+  gem "rubocop-performance", "~> 1.23"
   gem "sequel-annotate", "~>1.3"
   gem "yard", "~> 0.9"
 end
@@ -21,7 +23,6 @@ group :test do
   gem "pact", "~>1.14"
   gem "rspec-pact-matchers", "~>0.1"
   gem "bundler-audit", "~>0.4"
-  gem "fakefs", "~>0.4"
   gem "webmock", "~>3.9"
   gem "rspec", "~>3.0"
   gem "rspec-its", "~>1.2"

data/docs/developer/business_domain_models.md

@@ -0,0 +1,9 @@
+# Business Domain Models
+
+Sorry this is so scarce. I'm in a hurry, and this is better than nothing.
+
+![Pact Publication](./images/domain-model-of-pact-publication.png)
+
+![Pact Publication with verification](./images/domain-model-of-pact-publication-with-verification.png)
+
+![Technically more correct but harder to understand diagram](./images/domain-model-of-pact-publication-with-verification-technically-more-correct-but-harder-to-understand.png)

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

@@ -0,0 +1,19 @@
+require "pact_broker/api/decorators/base_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class ProviderStateDecorator < BaseDecorator
+        camelize_property_names
+
+        property :name
+        property :params
+
+      end
+
+      class ProviderStatesDecorator < BaseDecorator
+        collection :providerStates, getter: -> (context) { context[:represented].sort_by(&:name) }, :extend => PactBroker::Api::Decorators::ProviderStateDecorator
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/decorators/provider_states_decorator"
+
+module PactBroker
+  module Api
+    module Resources
+      class ProviderStates < BaseResource
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        def resource_exists?
+          !!provider
+        end
+
+        def to_json
+          decorator_class(:provider_states_decorator).new(provider_states).to_json(decorator_options)
+        end
+
+        def policy_name
+          :'pacts::pacts'
+        end
+
+        private
+
+        # attr_reader :provider_states
+
+        def provider_states
+          @provider_states ||= provider_state_service.list_provider_states(provider)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api.rb

@@ -44,6 +44,11 @@ module PactBroker
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "version", :consumer_version_number, "diff", "version", :comparison_consumer_version], Api::Resources::PactContentDiff, {resource_name: "pact_version_diff_by_consumer_version"}
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "pact-version", :pact_version_sha, "diff", "pact-version", :comparison_pact_version_sha], Api::Resources::PactContentDiff, {resource_name: "pact_version_diff_by_pact_version_sha"}
 
+        # Provider states
+
+        add ["pacts", "provider", :provider_name, "provider-states"], Api::Resources::ProviderStates, { resource_name: "provider_states" }
+
+
         # Verifications
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "pact-version", :pact_version_sha, "verification-results"], Api::Resources::Verifications, {resource_name: "verification_results"}
         add ["pacts", "provider", :provider_name, "consumer", :consumer_name, "pact-version", :pact_version_sha, "metadata", :metadata, "verification-results"], Api::Resources::Verifications, {resource_name: "verification_results"}

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

@@ -4,6 +4,8 @@ module PactBroker
   module DB
     module DataMigrations
       class SetInteractionsCounts
+        # This was never included in PactBroker::DB::MigrateData::MIGRATIONS
+
         def self.call(connection)
           self_join = {
             Sequel[:pact_publications][:consumer_id] => Sequel[:pp2][:consumer_id],

data/lib/pact_broker/db/migrate_data.rb

@@ -13,23 +13,35 @@ end
 module PactBroker
   module DB
     class MigrateData
+      include PactBroker::Logging
+
+      MIGRATIONS = [
+          DataMigrations::SetPacticipantIdsForVerifications,
+          DataMigrations::SetConsumerIdsForPactPublications,
+          DataMigrations::SetLatestVersionSequenceValue,
+          DataMigrations::SetWebhooksEnabled,
+          DataMigrations::DeleteDeprecatedWebhookExecutions,
+          DataMigrations::SetCreatedAtForLatestPactPublications,
+          DataMigrations::SetCreatedAtForLatestVerifications,
+          DataMigrations::SetExtraColumnsForTags,
+          DataMigrations::SetPacticipantDisplayName,
+          DataMigrations::SetWebhookUuid,
+          DataMigrations::SetConsumerVersionOrderForPactPublications,
+          DataMigrations::CreateBranches,
+          DataMigrations::MigrateIntegrations,
+          DataMigrations::MigratePactVersionProviderTagSuccessfulVerifications,
+          DataMigrations::SetContractDataUpdatedAtForIntegrations
+      ].freeze
+
+      def self.registered_migrations
+        MIGRATIONS
+      end
+
       def self.call database_connection, _options = {}
-        DataMigrations::SetPacticipantIdsForVerifications.call(database_connection)
-        DataMigrations::SetConsumerIdsForPactPublications.call(database_connection)
-        DataMigrations::SetLatestVersionSequenceValue.call(database_connection)
-        DataMigrations::SetWebhooksEnabled.call(database_connection)
-        DataMigrations::DeleteDeprecatedWebhookExecutions.call(database_connection)
-        DataMigrations::SetCreatedAtForLatestPactPublications.call(database_connection)
-        DataMigrations::SetCreatedAtForLatestVerifications.call(database_connection)
-        DataMigrations::SetExtraColumnsForTags.call(database_connection)
-        DataMigrations::SetPacticipantDisplayName.call(database_connection)
-        DataMigrations::SetWebhookUuid.call(database_connection)
-        DataMigrations::SetConsumerVersionOrderForPactPublications.call(database_connection)
-        DataMigrations::SetExtraColumnsForTags.call(database_connection)
-        DataMigrations::CreateBranches.call(database_connection)
-        DataMigrations::MigrateIntegrations.call(database_connection)
-        DataMigrations::MigratePactVersionProviderTagSuccessfulVerifications.call(database_connection)
-        DataMigrations::SetContractDataUpdatedAtForIntegrations.call(database_connection)
+        registered_migrations.each do | migration |
+          logger.debug "Running data migration #{migration.to_s.split("::").last.gsub(/([a-z\d])([A-Z])/, '\1 \2').split.join("-")}"
+          migration.call(database_connection)
+        end
       end
     end
   end

data/lib/pact_broker/doc/views/pact/provider-states.markdown

@@ -0,0 +1,28 @@
+# Provider States - Aggregated view by provider
+
+Allowed methods: `GET`
+
+Path: `/pacts/provider/{provider}/provider-states`
+
+This resource returns a aggregated de-duplicated list of all provider states for a given provider.
+
+Provider states are collected from the latest pact on the main branch for any dependant consumers.
+
+Example response
+
+```json
+{
+    "providerStates": [
+        {
+            "name": "an error occurs retrieving an alligator"
+        },
+        {
+            "name": "there is an alligator named Mary"
+        },
+        {
+            "name": "there is not an alligator named Mary"
+        }
+    ]
+}
+```
+

data/lib/pact_broker/matrix/matrix_row_instance_methods.rb

@@ -129,7 +129,13 @@ module PactBroker
       end
 
       def last_action_date
-        return_or_raise_if_not_set(:last_action_date)
+        date = return_or_raise_if_not_set(:last_action_date)
+
+        if date.class == String
+          DateTime.parse(date)
+        else
+          date
+        end
       end
 
       def has_verification?

data/lib/pact_broker/pacticipants/repository.rb

@@ -37,7 +37,10 @@ module PactBroker
       end
 
       def find(options = {}, pagination_options = {}, eager_load_associations = [])
-        query = scope_for(PactBroker::Domain::Pacticipant).select_all_qualified
+        query = scope_for(PactBroker::Domain::Pacticipant)
+        return [] if query.empty?
+
+        query = query.select_all_qualified
         query = query.filter(:name, options[:query_string]) if options[:query_string]
         query = query.label(options[:label_name]) if options[:label_name]
         query.order_ignore_case(Sequel[:pacticipants][:name]).eager(*eager_load_associations).all_with_pagination_options(pagination_options)

data/lib/pact_broker/pacts/content.rb

@@ -5,7 +5,10 @@ require "pact_broker/hash_refinements"
 
 module PactBroker
   module Pacts
+    ProviderState = Struct.new(:name, :params)
     class Content
+
+
       include GenerateInteractionSha
       using PactBroker::HashRefinements
 
@@ -33,9 +36,21 @@ module PactBroker
         Content.from_hash(SortContent.call(pact_hash))
       end
 
+      def provider_states
+        messages_and_or_interactions_or_empty_array.flat_map do | interaction |
+          if interaction["providerState"].is_a?(String)
+            [ProviderState.new(interaction["providerState"])]
+          elsif interaction["providerStates"].is_a?(Array)
+            interaction["providerStates"].collect do | provider_state |
+              ProviderState.new(provider_state["name"], provider_state["params"])
+            end
+          end
+        end.compact
+      end
+
       def interactions_missing_test_results
-        return [] unless messages_or_interactions
-        messages_or_interactions.reject do | interaction |
+        return [] unless messages_and_or_interactions
+        messages_and_or_interactions.reject do | interaction |
           interaction["tests"]&.any?
         end
       end
@@ -90,7 +105,7 @@ module PactBroker
       end
 
       def interaction_ids
-        messages_or_interaction_or_empty_array.collect do | interaction |
+        messages_and_or_interactions_or_empty_array.collect do | interaction |
           interaction["_id"]
         end.compact
       end
@@ -116,12 +131,14 @@ module PactBroker
         pact_hash.is_a?(Hash) && pact_hash["interactions"].is_a?(Array) ? pact_hash["interactions"] : nil
       end
 
-      def messages_or_interactions
-        messages || interactions
+      def messages_and_or_interactions
+        if messages || interactions
+          (messages || []) + (interactions || [])
+        end
       end
 
-      def messages_or_interaction_or_empty_array
-        messages_or_interactions || []
+      def messages_and_or_interactions_or_empty_array
+        messages_and_or_interactions || []
       end
 
       def pact_specification_version

data/lib/pact_broker/pacts/provider_state_service.rb

@@ -0,0 +1,22 @@
+require "pact_broker/services"
+require "pact_broker/pacts/selectors"
+require "pact_broker/pacts/pact_publication"
+require "pact_broker/repositories"
+
+
+module PactBroker
+  module Pacts
+    class ProviderStateService
+      # extend self
+      extend PactBroker::Services
+      extend PactBroker::Repositories::Scopes
+
+      def self.list_provider_states(provider)
+        query = scope_for(PactPublication).eager_for_domain_with_content.for_provider_and_consumer_version_selector(provider, PactBroker::Pacts::Selector.latest_for_main_branch)
+        query.all.flat_map do | pact_publication |
+          pact_publication.to_domain.content_object.provider_states
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/selector.rb

@@ -155,6 +155,10 @@ module PactBroker
         new(latest: true, branch: branch)
       end
 
+      def self.latest_for_main_branch
+        new(latest: true, main_branch: true)
+      end
+
       def self.latest_for_tag_with_fallback(tag, fallback_tag)
         new(latest: true, tag: tag, fallback_tag: fallback_tag)
       end

data/lib/pact_broker/pacts/selectors.rb

@@ -27,6 +27,10 @@ module PactBroker
         Selectors.new([Selector.latest_for_branch(branch)])
       end
 
+      def self.create_for_latest_from_main_branch
+        Selectors.new([Selector.latest_for_main_branch])
+      end
+
       def self.create_for_overall_latest
         Selectors.new([Selector.overall_latest])
       end

data/lib/pact_broker/services.rb

@@ -93,6 +93,10 @@ module PactBroker
       get_service(:branch_service)
     end
 
+    def provider_state_service
+      get_service(:provider_state_service)
+    end
+
     # rubocop: disable Metrics/MethodLength
     def register_default_services
       register_service(:index_service) do
@@ -194,6 +198,11 @@ module PactBroker
         require "pact_broker/versions/branch_service"
         PactBroker::Versions::BranchService
       end
+
+      register_service(:provider_state_service) do
+        require "pact_broker/pacts/provider_state_service"
+        PactBroker::Pacts::ProviderStateService
+      end
     end
     # rubocop: enable Metrics/MethodLength
   end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.112.0"
+  VERSION = "2.113.0"
 end

data/lib/sequel/extensions/pg_advisory_lock.rb

@@ -3,6 +3,7 @@
 # locks to be registered because different threads running the same code
 # should not cause a Sequel::Error to be raised.
 # Also, I wanted it to use Concurrent::Hash for multi-threaded environments.
+# Made minor change in begin ensure block in with_advisory_lock method.
 
 require "sequel"
 require "zlib"
@@ -57,10 +58,9 @@ module Sequel
           synchronize do
             if get(Sequel.function(lock_function, *function_params))
               begin
-                result = yield
+                yield
               ensure
                 get(Sequel.function(UNLOCK_FUNCTION, *function_params))
-                result
               end
             end
           end

data/pact_broker.gemspec

@@ -60,9 +60,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "semver2", "~> 3.4.2"
   gem.add_runtime_dependency "rack", ">= 2.2.3", "~> 2.2" # TODO update to 3
   gem.add_runtime_dependency "redcarpet", ">= 3.5.1", "~>3.5"
-  gem.add_runtime_dependency "pact-support" , "~> 1.16", ">= 1.16.4"
-  gem.add_runtime_dependency "padrino-core", ">= 0.14.3", "~> 0.14"
-  gem.add_runtime_dependency "sinatra", "~> 3.0"
+  gem.add_runtime_dependency "pact-support" , ">= 1.21.2", "~> 1.21"
   gem.add_runtime_dependency "haml", "~>5.0"
   gem.add_runtime_dependency "sucker_punch", "~>3.0"
   gem.add_runtime_dependency "rack-protection", "~> 3.0"

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.112.0
+  version: 2.113.0
 platform: ruby
 authors:
 - Bethany Skurrie
 - Sergei Matheson
 - Warner Godfrey
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -186,58 +185,24 @@ dependencies:
         version: '3.5'
 - !ruby/object:Gem::Dependency
   name: pact-support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.16.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.16.4
-- !ruby/object:Gem::Dependency
-  name: padrino-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.3
+        version: 1.21.2
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+        version: 1.21.2
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -582,6 +547,7 @@ files:
 - docs/api/PACTICIPANTS.md
 - docs/api/PAGINATION.md
 - docs/api/WEBHOOKS.md
+- docs/developer/business_domain_models.md
 - docs/developer/design_pattern_for_eager_loading_collections.md
 - docs/developer/matrix.md
 - docs/developer/rack.md
@@ -672,6 +638,7 @@ files:
 - lib/pact_broker/api/decorators/pacts_for_verification_query_decorator.rb
 - lib/pact_broker/api/decorators/pagination_links.rb
 - lib/pact_broker/api/decorators/provider_pacts_decorator.rb
+- lib/pact_broker/api/decorators/provider_states_decorator.rb
 - lib/pact_broker/api/decorators/publish_contract_decorator.rb
 - lib/pact_broker/api/decorators/publish_contracts_decorator.rb
 - lib/pact_broker/api/decorators/publish_contracts_results_decorator.rb
@@ -774,6 +741,7 @@ files:
 - lib/pact_broker/api/resources/previous_distinct_pact_version.rb
 - lib/pact_broker/api/resources/provider_pacts.rb
 - lib/pact_broker/api/resources/provider_pacts_for_verification.rb
+- lib/pact_broker/api/resources/provider_states.rb
 - lib/pact_broker/api/resources/publish_contracts.rb
 - lib/pact_broker/api/resources/relationships.rb
 - lib/pact_broker/api/resources/released_version.rb
@@ -899,6 +867,7 @@ files:
 - 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/provider-states.markdown
 - lib/pact_broker/doc/views/pact/publish-verification-results.markdown
 - lib/pact_broker/doc/views/pact/tag-prod-version.markdown
 - lib/pact_broker/doc/views/pact/tag-version.markdown
@@ -1000,6 +969,7 @@ files:
 - lib/pact_broker/pacts/pacts_for_verification_repository.rb
 - lib/pact_broker/pacts/parse.rb
 - lib/pact_broker/pacts/placeholder_pact.rb
+- lib/pact_broker/pacts/provider_state_service.rb
 - lib/pact_broker/pacts/repository.rb
 - lib/pact_broker/pacts/selected_pact.rb
 - lib/pact_broker/pacts/selector.rb
@@ -1254,7 +1224,6 @@ homepage: https://github.com/pact-foundation/pact_broker
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -1269,8 +1238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: See description
 test_files: []