feat: added has_messages column to pact_versions table (#880)

* feat: added has_messages column to pact_versions table
* Added Interactins::Types to detect message types in interactions
* Updated code to save has_messages correctly
* Added database migrations for adding the column, backfilling the
  column in a batched manner to avoid issues

Jira Ticket: [PACT-5319]

* test: fix failing tests

Jira Ticket: [PACT-5319]

* chore: match the conten length

Jira Ticket: [PACT-5319]

---------

Co-authored-by: Phanindra Srungavarapu <[email protected]>

Author: pahnin

db/migrations/20251202_add_has_messages_column_to_pact_versions.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    alter_table(:pact_versions) do
+      add_column(:has_messages, TrueClass, default: false, null: false)
+    end
+  end
+end

db/migrations/20251202_populate_has_messages_in_pact_versions.rb

@@ -0,0 +1,29 @@
+require "pact_broker/pacts/content"
+require "pact_broker/pacts/interactions/types"
+
+Sequel.migration do
+  up do
+    batch_size = 500
+    offset = 0
+
+    loop do
+      rows = from(:pact_versions).order(:id).limit(batch_size).offset(offset).all
+      break if rows.empty?
+
+      rows.each do |row|
+        content = PactBroker::Pacts::Content.from_json(row[:content])
+        has_messages = PactBroker::Pacts::Interactions::Types.for(content).has_messages?
+
+        from(:pact_versions)
+          .where(id: row[:id])
+          .update(has_messages: has_messages)
+      end
+
+      offset += batch_size
+    end
+  end
+
+  down do
+
+  end
+end

lib/pact_broker/pacts/interactions/types.rb

@@ -0,0 +1,44 @@
+module PactBroker
+  module Pacts
+    module Interactions
+      class Types
+        # Pact Spec v4+ message interaction types
+        MESSAGE_TYPES = [
+          "Asynchronous/Messages",
+          "Synchronous/Messages"
+        ].freeze
+
+        def initialize(content)
+          @content = content
+        end
+
+        def self.for(content)
+          new(content)
+        end
+
+        def has_messages?
+          if spec_version < 4.0
+            # Pre-v4: messages in "messages" key
+            content.messages&.any? || false
+          else
+            # V4+: messages are typed interactions
+            content.interactions&.any? { |i| message_interaction?(i) } || false
+          end
+        end
+
+        private
+
+        attr_reader :content
+
+        def message_interaction?(interaction)
+          interaction.is_a?(Hash) &&
+            MESSAGE_TYPES.include?(interaction["type"])
+        end
+
+        def spec_version
+          content.pact_specification_version.to_f
+        end
+      end
+    end
+  end
+end

lib/pact_broker/pacts/repository.rb

@@ -14,6 +14,7 @@
 require "pact_broker/feature_toggle"
 require "pact_broker/pacts/pacts_for_verification_repository"
 require "pact_broker/pacts/content"
+require "pact_broker/pacts/interactions/types"
 require "pact_broker/policies"
 
 module PactBroker
@@ -394,14 +395,16 @@ def find_or_create_pact_version consumer_id, provider_id, pact_version_sha, json
       end
 
       def create_pact_version consumer_id, provider_id, sha, json_content
+        content = Content.from_json(json_content)
         PactBroker::Pacts::PactVersion.new(
           consumer_id: consumer_id,
           provider_id: provider_id,
           sha: sha,
           content: json_content,
           created_at: Sequel.datetime_class.now,
-          interactions_count: Content.from_json(json_content).interactions&.count || 0,
-          messages_count: Content.from_json(json_content).messages&.count || 0
+          interactions_count: content.interactions&.count || 0,
+          messages_count: content.messages&.count || 0,
+          has_messages: Interactions::Types.for(content).has_messages?
         ).upsert
       end
 

lib/pact_broker/test/test_data_builder.rb

@@ -456,6 +456,9 @@ def create_verification parameters = {}
         parameters = default_parameters.merge(parameters)
         parameters.delete(:provider_version)
         verification = PactBroker::Domain::Verification.new(parameters)
+        if pact.nil?
+          @pact = find_pact(@consumer.name, @consumer_version.number, @provider.name)
+        end
         pact_version = PactBroker::Pacts::Repository.new.find_pact_version(@consumer, @provider, pact.pact_version_sha)
         @provider_version = version_repository.find_by_pacticipant_id_and_number_or_create(provider.id, provider_version_number)
         branch_version = PactBroker::Versions::BranchVersionRepository.new.add_branch(@provider_version, branch) if branch
@@ -714,13 +717,16 @@ def set_created_at_if_set created_at, table_name, selector, date_column_name = :
       def default_json_content
         {
           "consumer" => {
-             "name" => consumer.name
-           },
-           "provider" => {
-             "name" => provider.name
-           },
-           "interactions" => [],
-           "random" => rand
+            "name" => consumer.name
+          },
+          "provider" => {
+            "name" => provider.name
+          },
+          "interactions" => [],
+          "metadata" => {
+            "pactSpecification": { "version": "4.0" }
+          },
+          "random" => rand
          }.to_json
       end
 

spec/fixtures/approvals/get_provider_pacts_for_verification.received.json

@@ -0,0 +1,59 @@
+{
+  "request": {
+    "path": "/pacts/provider/Provider/for-verification",
+    "headers": {
+      "Content-Type": "application/json",
+      "Accept": "application/hal+json"
+    },
+    "body": {
+      "consumerVersionSelectors": [
+        {
+          "tag": "prod",
+          "latest": true
+        }
+      ],
+      "includePendingStatus": false,
+      "providerVersionTags": [
+        "main"
+      ]
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "content-type": "application/hal+json;charset=utf-8",
+      "content-length": "840",
+      "date": "<date>",
+      "server": "Webmachine-Ruby/2.0.1 Rack/3.2"
+    },
+    "body": {
+      "_embedded": {
+        "pacts": [
+          {
+            "shortDescription": "latest with tag prod",
+            "verificationProperties": {
+              "notices": [
+                {
+                  "when": "before_verification",
+                  "text": "The pact at http://example.org/pacts/provider/Provider/consumer/Consumer%202/pact-version/0f22f551a422b027066db7635cad8bd8a59ac869 is being verified because the pact content belongs to the consumer version matching the following criterion:\n    * latest version tagged 'prod' (4.5.6)"
+                }
+              ]
+            },
+            "_links": {
+              "self": {
+                "href": "http://example.org/pacts/provider/Provider/consumer/Consumer%202/pact-version/0f22f551a422b027066db7635cad8bd8a59ac869/metadata/cyU1QiU1RCU1QnQlNUQ9cHJvZCZzJTVCJTVEJTVCbCU1RD10cnVlJnMlNUIlNUQlNUJjdiU1RD0y",
+                "name": "Pact between Consumer 2 (4.5.6) and Provider"
+              }
+            }
+          }
+        ]
+      },
+      "_links": {
+        "self": {
+          "href": "http://example.org/pacts/provider/Provider/for-verification",
+          "title": "Pacts to be verified"
+        }
+      }
+    }
+  }
+}

spec/fixtures/pact_with_http_and_async_interactions_v4.json

@@ -0,0 +1,72 @@
+{
+  "consumer": { "name": "Foo" },
+  "interactions": [
+    {
+      "_id": "5d6f8d633693c2391ba8fff297444b3ef1ccd00b",
+      "contents": {
+        "content": { "id": 1, "name": "drover", "type": "bulldog" },
+        "contentType": "application/json",
+        "encoded": false
+      },
+      "description": "a request for a dog",
+      "matchingRules": {
+        "body": {
+          "$.id": { "combine": "AND", "matchers": [{ "match": "type" }] },
+          "$.name": { "combine": "AND", "matchers": [{ "match": "type" }] },
+          "$.type": {
+            "combine": "AND",
+            "matchers": [{ "match": "regex", "regex": "^(bulldog|sheepdog)$" }]
+          }
+        }
+      },
+      "metadata": { "queue": "animals" },
+      "pending": false,
+      "providerStates": [{ "name": "a dog named drover" }],
+      "type": "Asynchronous/Messages"
+    },
+    {
+      "_id": "a2cac63edba504277c1063f36620549785d78981",
+      "description": "a request to get a product",
+      "pending": false,
+      "providerStates": [{ "name": "a product with ID 10 exists" }],
+      "request": {
+        "headers": { "Authorization": ["Bearer 2019-01-14T11:34:18.045Z"] },
+        "matchingRules": {
+          "header": {
+            "$.Authorization[0]": {
+              "combine": "AND",
+              "matchers": [{ "match": "type" }]
+            }
+          }
+        },
+        "method": "GET",
+        "path": "/product/10"
+      },
+      "response": {
+        "body": {
+          "content": {
+            "id": "10",
+            "name": "28 Degrees",
+            "type": "CREDIT_CARD"
+          },
+          "contentType": "application/json",
+          "encoded": false
+        },
+        "headers": { "Content-Type": ["application/json; charset=utf-8"] },
+        "matchingRules": {
+          "body": {
+            "$": { "combine": "AND", "matchers": [{ "match": "type" }] }
+          }
+        },
+        "status": 200
+      },
+      "type": "Synchronous/HTTP"
+    }
+  ],
+  "metadata": {
+    "pact-js": { "version": "15.0.1" },
+    "pactRust": { "ffi": "0.4.22", "models": "1.3.7" },
+    "pactSpecification": { "version": "4.0" }
+  },
+  "provider": { "name": "Bar" }
+}

spec/lib/pact_broker/pacts/content_spec.rb

@@ -486,4 +486,4 @@ module Pacts
       end
     end
   end
-end
+end