sbmt-pact 0.12.0

data/lib/sbmt/pact/consumer/grpc_interaction_builder.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require "pact/ffi/sync_message_consumer"
+require "pact/ffi/plugin_consumer"
+require "pact/ffi/logger"
+
+module Sbmt
+  module Pact
+    module Consumer
+      class GrpcInteractionBuilder
+        DESCRIPTION_PREFIX = "grpc: "
+        CONTENT_TYPE = "application/protobuf"
+        GRPC_CONTENT_TYPE = "application/grpc"
+        PROTOBUF_PLUGIN_NAME = "protobuf"
+        PROTOBUF_PLUGIN_VERSION = "0.4.0"
+
+        class PluginInitError < Sbmt::Pact::FfiError; end
+
+        # https://docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_using_plugin.html
+        INIT_PLUGIN_ERRORS = {
+          1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
+          2 => {reason: :plugin_load_failed, status: 2, description: "Failed to load the plugin"},
+          3 => {reason: :invalid_handle, status: 3, description: "Pact Handle is not valid"}
+        }.freeze
+
+        # https://docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_interaction_contents.html
+        CREATE_INTERACTION_ERRORS = {
+          1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
+          2 => {reason: :mock_server_already_running, status: 2, description: "The mock server has already been started"},
+          3 => {reason: :invalid_handle, status: 3, description: "The interaction handle is invalid"},
+          4 => {reason: :invalid_content_type, status: 4, description: "The content type is not valid"},
+          5 => {reason: :invalid_contents, status: 5, description: "The contents JSON is not valid JSON"},
+          6 => {reason: :plugin_error, status: 6, description: "The plugin returned an error"}
+        }.freeze
+
+        class CreateInteractionError < Sbmt::Pact::FfiError; end
+
+        class InteractionMismatchesError < Sbmt::Pact::Error; end
+
+        class InteractionBuilderError < Sbmt::Pact::Error; end
+
+        def initialize(pact_config, description: nil)
+          @pact_config = pact_config
+          @description = description || ""
+
+          @proto_path = nil
+          @proto_include_dirs = []
+          @service_name = nil
+          @method_name = nil
+          @request = nil
+          @response = nil
+          @response_meta = nil
+          @provider_state_meta = nil
+        end
+
+        def with_service(proto_path, method, include_dirs = [])
+          raise InteractionBuilderError.new("invalid grpc method: cannot be blank") if method.blank?
+
+          service_name, method_name = method.split("/") || []
+          raise InteractionBuilderError.new("invalid grpc method: #{method}, should be like service/SomeMethod") if service_name.blank? || method_name.blank?
+
+          absolute_path = File.expand_path(proto_path)
+          raise InteractionBuilderError.new("proto file #{proto_path} does not exist") unless File.exist?(absolute_path)
+
+          @proto_path = absolute_path
+          @service_name = service_name
+          @method_name = method_name
+          @proto_include_dirs = include_dirs.map { |dir| File.expand_path(dir) }
+
+          self
+        end
+
+        def given(provider_state, metadata = {})
+          @provider_state_meta = {provider_state => metadata}
+          self
+        end
+
+        def upon_receiving(description)
+          @description = description
+          self
+        end
+
+        def with_request(req_hash)
+          @request = InteractionContents.plugin(req_hash)
+          self
+        end
+
+        def with_response(resp_hash)
+          @response = InteractionContents.plugin(resp_hash)
+          self
+        end
+
+        def with_response_meta(meta_hash)
+          @response_meta = InteractionContents.plugin(meta_hash)
+          self
+        end
+
+        def interaction_json
+          result = {
+            "pact:proto": @proto_path,
+            "pact:proto-service": "#{@service_name}/#{@method_name}",
+            "pact:content-type": CONTENT_TYPE,
+            request: @request
+          }
+
+          result["pact:protobuf-config"] = {additionalIncludes: @proto_include_dirs} if @proto_include_dirs.present?
+
+          result[:response] = @response if @response.is_a?(Hash)
+          result[:responseMetadata] = @response_meta if @response_meta.is_a?(Hash)
+
+          JSON.dump(result)
+        end
+
+        def validate!
+          raise InteractionBuilderError.new("uninitialized service params, use #with_service to configure") if @proto_path.blank? || @service_name.blank? || @method_name.blank?
+          raise InteractionBuilderError.new("invalid request format, should be a hash") unless @request.is_a?(Hash)
+          raise InteractionBuilderError.new("invalid response format, should be a hash") unless @response.is_a?(Hash) || @response_meta.is_a?(Hash)
+        end
+
+        def execute(&block)
+          raise InteractionBuilderError.new("interaction is designed to be used one-time only") if defined?(@used)
+
+          validate!
+
+          pact_handle = init_pact
+          init_plugin!(pact_handle)
+
+          message_pact = PactFfi::SyncMessageConsumer.new_interaction(pact_handle, description)
+          @provider_state_meta&.each_pair do |provider_state, meta|
+            if meta.present?
+              meta.each_pair { |k, v| PactFfi.given_with_param(message_pact, provider_state, k.to_s, v.to_s) }
+            else
+              PactFfi.given(message_pact, provider_state)
+            end
+          end
+
+          result = PactFfi::PluginConsumer.interaction_contents(message_pact, 0, GRPC_CONTENT_TYPE, interaction_json)
+          if CREATE_INTERACTION_ERRORS[result].present?
+            error = CREATE_INTERACTION_ERRORS[result]
+            raise CreateInteractionError.new("There was an error while trying to add interaction \"#{description}\"", error[:reason], error[:status])
+          end
+
+          mock_server = MockServer.create_for_grpc!(pact: pact_handle, host: @pact_config.mock_host, port: @pact_config.mock_port)
+
+          yield(message_pact, mock_server)
+
+          if mock_server.matched?
+            mock_server.write_pacts!(@pact_config.pact_dir)
+          else
+            msg = mismatches_error_msg(mock_server)
+            raise InteractionMismatchesError.new(msg)
+          end
+        ensure
+          @used = true
+          mock_server&.cleanup
+          PactFfi::PluginConsumer.cleanup_plugins(pact_handle)
+          PactFfi.free_pact_handle(pact_handle)
+        end
+
+        private
+
+        def mismatches_error_msg(mock_server)
+          rspec_example_desc = RSpec.current_example&.full_description
+          return "interaction for #{@service_name}/#{@method_name} has mismatches: #{mock_server.mismatches}" if rspec_example_desc.blank?
+
+          "#{rspec_example_desc} has mismatches: #{mock_server.mismatches}"
+        end
+
+        def init_pact
+          handle = PactFfi.new_pact(@pact_config.consumer_name, @pact_config.provider_name)
+          PactFfi.with_specification(handle, PactFfi::FfiSpecificationVersion["SPECIFICATION_VERSION_V4"])
+          PactFfi.with_pact_metadata(handle, "sbmt-pact", "pact-ffi", PactFfi.version)
+
+          Sbmt::Pact::Native::Logger.log_to_stdout(@pact_config.log_level)
+
+          handle
+        end
+
+        def init_plugin!(pact_handle)
+          result = PactFfi::PluginConsumer.using_plugin(pact_handle, PROTOBUF_PLUGIN_NAME, PROTOBUF_PLUGIN_VERSION)
+          return result if INIT_PLUGIN_ERRORS[result].blank?
+
+          error = INIT_PLUGIN_ERRORS[result]
+          raise PluginInitError.new("There was an error while trying to initialize plugin #{PROTOBUF_PLUGIN_NAME}/#{PROTOBUF_PLUGIN_VERSION}", error[:reason], error[:status])
+        end
+
+        def description
+          "#{DESCRIPTION_PREFIX}#{@description}"
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/pact/consumer/http_interaction_builder.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "pact/ffi/sync_message_consumer"
+require "pact/ffi/plugin_consumer"
+require "pact/ffi/logger"
+
+module Sbmt
+  module Pact
+    module Consumer
+      class HttpInteractionBuilder
+        DESCRIPTION_PREFIX = "http: "
+
+        # https://docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_interaction_contents.html
+        CREATE_INTERACTION_ERRORS = {
+          1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
+          2 => {reason: :mock_server_already_running, status: 2, description: "The mock server has already been started"},
+          3 => {reason: :invalid_handle, status: 3, description: "The interaction handle is invalid"},
+          4 => {reason: :invalid_content_type, status: 4, description: "The content type is not valid"},
+          5 => {reason: :invalid_contents, status: 5, description: "The contents JSON is not valid JSON"},
+          6 => {reason: :plugin_error, status: 6, description: "The plugin returned an error"}
+        }.freeze
+
+        class CreateInteractionError < Sbmt::Pact::FfiError; end
+
+        class InteractionMismatchesError < Sbmt::Pact::Error; end
+
+        class InteractionBuilderError < Sbmt::Pact::Error; end
+
+        class << self
+          def create_finalizer(pact_handle)
+            proc { PactFfi.free_pact_handle(pact_handle) }
+          end
+        end
+
+        def initialize(pact_config, description: nil)
+          @pact_config = pact_config
+          @description = description || ""
+
+          @pact_handle = init_pact
+          @pact_interaction = PactFfi.new_interaction(pact_handle, full_description)
+
+          ObjectSpace.define_finalizer(self, self.class.create_finalizer(pact_interaction))
+        end
+
+        def given(provider_state, metadata = {})
+          if metadata.present?
+            PactFfi.given_with_params(pact_interaction, provider_state, JSON.dump(metadata))
+          else
+            PactFfi.given(pact_interaction, provider_state)
+          end
+
+          self
+        end
+
+        def upon_receiving(description)
+          @description = description
+          PactFfi.upon_receiving(pact_interaction, full_description)
+          self
+        end
+
+        def with_request(method, path, query: {}, headers: {}, body: nil)
+          interaction_part = PactFfi::FfiInteractionPart["INTERACTION_PART_REQUEST"]
+          PactFfi.with_request(pact_interaction, method.to_s, format_value(path))
+
+          InteractionContents.basic(query).each_pair do |key, value_item|
+            PactFfi.with_query_parameter_v2(pact_interaction, key.to_s, 0, format_value(value_item))
+          end
+
+          InteractionContents.basic(headers).each_pair do |key, value_item|
+            PactFfi.with_header_v2(pact_interaction, interaction_part, key.to_s, 0, format_value(value_item))
+          end
+
+          if body
+            PactFfi.with_body(pact_interaction, interaction_part, "application/json", format_value(InteractionContents.basic(body)))
+          end
+
+          self
+        end
+
+        def with_response(status, headers: {}, body: nil)
+          interaction_part = PactFfi::FfiInteractionPart["INTERACTION_PART_RESPONSE"]
+          PactFfi.response_status(pact_interaction, status)
+
+          InteractionContents.basic(headers).each_pair do |key, value_item|
+            PactFfi.with_header_v2(pact_interaction, interaction_part, key.to_s, 0, format_value(value_item))
+          end
+
+          if body
+            PactFfi.with_body(pact_interaction, interaction_part, "application/json", format_value(InteractionContents.basic(body)))
+          end
+
+          self
+        end
+
+        def execute(&block)
+          raise InteractionBuilderError.new("interaction is designed to be used one-time only") if defined?(@used)
+
+          mock_server = MockServer.create_for_http!(
+            pact: pact_handle, host: pact_config.mock_host, port: pact_config.mock_port
+          )
+
+          yield(mock_server)
+
+          if mock_server.matched?
+            mock_server.write_pacts!(pact_config.pact_dir)
+          else
+            msg = mismatches_error_msg(mock_server)
+            raise InteractionMismatchesError.new(msg)
+          end
+        ensure
+          @used = true
+          mock_server&.cleanup
+        end
+
+        private
+
+        attr_reader :pact_handle, :pact_interaction, :pact_config
+
+        def mismatches_error_msg(mock_server)
+          rspec_example_desc = RSpec.current_example&.full_description
+
+          "#{rspec_example_desc} has mismatches: #{mock_server.mismatches}"
+        end
+
+        def init_pact
+          handle = PactFfi.new_pact(pact_config.consumer_name, pact_config.provider_name)
+          PactFfi.with_specification(handle, PactFfi::FfiSpecificationVersion["SPECIFICATION_VERSION_V4"])
+          PactFfi.with_pact_metadata(handle, "sbmt-pact", "pact-ffi", PactFfi.version)
+
+          Sbmt::Pact::Native::Logger.log_to_stdout(pact_config.log_level)
+
+          handle
+        end
+
+        def format_value(obj)
+          return obj if obj.is_a?(String)
+
+          return JSON.dump({value: obj}) if obj.is_a?(Array)
+
+          JSON.dump(obj)
+        end
+
+        def full_description
+          "#{DESCRIPTION_PREFIX}#{@description}"
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/pact/consumer/interaction_contents.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sbmt
+  module Pact
+    module Consumer
+      class InteractionContents < Hash
+        BASIC_FORMAT = :basic
+        PLUGIN_FORMAT = :plugin
+
+        attr_reader :format
+
+        def self.basic(contents_hash)
+          new(contents_hash, BASIC_FORMAT)
+        end
+
+        def self.plugin(contents_hash)
+          new(contents_hash, PLUGIN_FORMAT)
+        end
+
+        def initialize(contents_hash, format)
+          init_hash(contents_hash, format).each_pair { |k, v| self[k] = v }
+          @format = format
+        end
+
+        private
+
+        def serialize(hash, format)
+          # serialize recursively
+          hash.each_pair do |key, value|
+            next serialize(value, format) if value.is_a?(Hash)
+            next hash[key] = value.map { |v| serialize(v, format) } if value.is_a?(Array)
+            if value.is_a?(Sbmt::Pact::Matchers::Base)
+              hash[key] = value.as_basic if format == :basic
+              hash[key] = value.as_plugin if format == :plugin
+            end
+          end
+
+          hash
+        end
+
+        def init_hash(hash, format)
+          serialize(hash.deep_dup, format)
+        end
+      end
+    end
+  end
+end

data/lib/sbmt/pact/consumer/message_interaction_builder.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require "pact/ffi/message_consumer"
+require "pact/ffi/plugin_consumer"
+require "pact/ffi/logger"
+
+module Sbmt
+  module Pact
+    module Consumer
+      class MessageInteractionBuilder
+        DESCRIPTION_PREFIX = "async: "
+        META_CONTENT_TYPE_HEADER = "contentType"
+
+        JSON_CONTENT_TYPE = "application/json"
+        PROTO_CONTENT_TYPE = "application/protobuf"
+
+        PROTOBUF_PLUGIN_NAME = "protobuf"
+        PROTOBUF_PLUGIN_VERSION = "0.4.0"
+
+        # https://docs.rs/pact_ffi/latest/pact_ffi/mock_server/handles/fn.pactffi_write_message_pact_file.html
+        WRITE_PACT_FILE_ERRORS = {
+          1 => {reason: :file_not_accessible, status: 1, description: "The pact file was not able to be written"},
+          2 => {reason: :internal_error, status: 2, description: "The message pact for the given handle was not found"}
+        }.freeze
+
+        class PluginInitError < Sbmt::Pact::FfiError; end
+
+        # https://docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_using_plugin.html
+        INIT_PLUGIN_ERRORS = {
+          1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
+          2 => {reason: :plugin_load_failed, status: 2, description: "Failed to load the plugin"},
+          3 => {reason: :invalid_handle, status: 3, description: "Pact Handle is not valid"}
+        }.freeze
+
+        # https://docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_interaction_contents.html
+        CREATE_INTERACTION_ERRORS = {
+          1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
+          2 => {reason: :mock_server_already_running, status: 2, description: "The mock server has already been started"},
+          3 => {reason: :invalid_handle, status: 3, description: "The interaction handle is invalid"},
+          4 => {reason: :invalid_content_type, status: 4, description: "The content type is not valid"},
+          5 => {reason: :invalid_contents, status: 5, description: "The contents JSON is not valid JSON"},
+          6 => {reason: :plugin_error, status: 6, description: "The plugin returned an error"}
+        }.freeze
+
+        class CreateInteractionError < Sbmt::Pact::FfiError; end
+
+        class InteractionMismatchesError < Sbmt::Pact::Error; end
+
+        class InteractionBuilderError < Sbmt::Pact::Error; end
+
+        def initialize(pact_config, description: nil)
+          @pact_config = pact_config
+          @description = description
+
+          @json_contents = nil
+          @proto_contents = nil
+          @proto_path = nil
+          @proto_message_class = nil
+          @proto_include_dirs = []
+          @meta = {}
+          @headers = {}
+          @provider_state_meta = nil
+        end
+
+        def given(provider_state, metadata = {})
+          @provider_state_meta = {provider_state => metadata}
+          self
+        end
+
+        def upon_receiving(description)
+          @description = description
+          self
+        end
+
+        def with_json_contents(contents_hash)
+          @json_contents = InteractionContents.basic(contents_hash)
+          self
+        end
+
+        def with_proto_class(proto_path, message_class_name, include_dirs = [])
+          absolute_path = File.expand_path(proto_path)
+          raise InteractionBuilderError.new("proto file #{proto_path} does not exist") unless File.exist?(absolute_path)
+
+          @proto_path = absolute_path
+          @proto_message_class = message_class_name
+          @proto_include_dirs = include_dirs.map { |dir| File.expand_path(dir) }
+          self
+        end
+
+        def with_proto_contents(contents_hash)
+          @proto_contents = InteractionContents.plugin(contents_hash)
+          self
+        end
+
+        def with_metadata(meta_hash)
+          @meta = InteractionContents.basic(meta_hash)
+          self
+        end
+
+        def with_headers(headers_hash)
+          @headers = InteractionContents.basic(headers_hash)
+          self
+        end
+
+        def with_header(key, value)
+          @headers[key] = value
+          self
+        end
+
+        def validate!
+          if proto_interaction?
+            raise InteractionBuilderError.new("proto_path / proto_message are not defined, please set ones with #with_proto_message") if @proto_contents.blank? || @proto_message_class.blank?
+            raise InteractionBuilderError.new("invalid request format, should be a hash") unless @proto_contents.is_a?(Hash)
+          else
+            raise InteractionBuilderError.new("invalid request format, should be a hash") unless @json_contents.is_a?(Hash)
+          end
+          raise InteractionBuilderError.new("description is required for message interactions, please set one with #upon_receiving") if @description.blank?
+        end
+
+        def execute(&block)
+          raise InteractionBuilderError.new("interaction is designed to be used one-time only") if defined?(@used)
+
+          validate!
+          pact_handle = init_pact
+          init_plugin!(pact_handle) if proto_interaction?
+
+          message_pact = PactFfi::MessageConsumer.new_message_interaction(pact_handle, description)
+
+          configure_interaction!(message_pact)
+
+          # strip out matchers and get raw payload/metadata
+          payload, metadata = fetch_reified_message(pact_handle)
+          configure_provider_state(message_pact, metadata)
+
+          yield(payload, metadata)
+
+          write_pacts!(pact_handle, @pact_config.pact_dir)
+        ensure
+          @used = true
+          PactFfi::MessageConsumer.free_handle(message_pact)
+          PactFfi.free_pact_handle(pact_handle)
+        end
+
+        def build_interaction_json
+          return JSON.dump(@json_contents) unless proto_interaction?
+
+          contents = {
+            "pact:proto": @proto_path,
+            "pact:message-type": @proto_message_class,
+            "pact:content-type": PROTO_CONTENT_TYPE
+          }.merge(@proto_contents)
+
+          contents["pact:protobuf-config"] = {additionalIncludes: @proto_include_dirs} if @proto_include_dirs.present?
+
+          JSON.dump(contents)
+        end
+
+        private
+
+        def write_pacts!(handle, dir)
+          result = PactFfi.write_message_pact_file(handle, @pact_config.pact_dir, false)
+          return result if WRITE_PACT_FILE_ERRORS[result].blank?
+
+          error = WRITE_PACT_FILE_ERRORS[result]
+          raise WritePactsError.new("There was an error while trying to write pact file to #{dir}", error[:reason], error[:status])
+        end
+
+        def init_pact
+          handle = PactFfi::MessageConsumer.new_message_pact(@pact_config.consumer_name, @pact_config.provider_name)
+          PactFfi.with_specification(handle, PactFfi::FfiSpecificationVersion["SPECIFICATION_VERSION_V4"])
+          PactFfi.with_pact_metadata(handle, "sbmt-pact", "pact-ffi", PactFfi.version)
+
+          Sbmt::Pact::Native::Logger.log_to_stdout(@pact_config.log_level)
+
+          handle
+        end
+
+        def fetch_reified_message(pact_handle)
+          iterator = PactFfi::MessageConsumer.pact_handle_get_message_iter(pact_handle)
+          raise InteractionBuilderError.new("cannot get message iterator: internal error") if iterator.blank?
+
+          message_handle = PactFfi.pact_message_iter_next(iterator)
+          raise InteractionBuilderError.new("cannot get message from iterator: no messages") if message_handle.blank?
+
+          contents = fetch_reified_message_body(message_handle)
+          meta = fetch_reified_message_headers(message_handle)
+
+          [contents, meta.compact]
+        ensure
+          PactFfi.pact_message_iter_delete(iterator) if iterator.present?
+        end
+
+        def fetch_reified_message_headers(message_handle)
+          meta = {"headers" => {}}
+
+          meta[META_CONTENT_TYPE_HEADER] = PactFfi.message_find_metadata(message_handle, META_CONTENT_TYPE_HEADER)
+
+          @meta.each_key do |key|
+            meta[key.to_s] = PactFfi.message_find_metadata(message_handle, key.to_s)
+          end
+
+          @headers.each_key do |key|
+            meta["headers"][key.to_s] = PactFfi.message_find_metadata(message_handle, key.to_s)
+          end
+
+          meta
+        end
+
+        def configure_provider_state(message_pact, reified_metadata)
+          content_type = reified_metadata[META_CONTENT_TYPE_HEADER]
+          @provider_state_meta&.each_pair do |provider_state, meta|
+            if meta.present?
+              meta.each_pair { |k, v| PactFfi.given_with_param(message_pact, provider_state, k.to_s, v.to_s) }
+              PactFfi.given_with_param(message_pact, provider_state, META_CONTENT_TYPE_HEADER, content_type.to_s) if content_type
+            elsif content_type.present?
+              PactFfi.given_with_param(message_pact, provider_state, META_CONTENT_TYPE_HEADER, content_type.to_s)
+            else
+              PactFfi.given(message_pact, provider_state)
+            end
+          end
+        end
+
+        def fetch_reified_message_body(message_handle)
+          if proto_interaction?
+            len = PactFfi::MessageConsumer.get_contents_length(message_handle)
+            ptr = PactFfi::MessageConsumer.get_contents_bin(message_handle)
+            return nil if ptr.blank? || len == 0
+
+            return String.new(ptr.read_string_length(len))
+          end
+
+          contents = PactFfi::MessageConsumer.get_contents(message_handle)
+          return nil if contents.blank?
+
+          JSON.parse(contents)
+        end
+
+        def configure_interaction!(message_pact)
+          interaction_json = build_interaction_json
+
+          if proto_interaction?
+            result = PactFfi::PluginConsumer.interaction_contents(message_pact, 0, PROTO_CONTENT_TYPE, interaction_json)
+            if CREATE_INTERACTION_ERRORS[result].present?
+              error = CREATE_INTERACTION_ERRORS[result]
+              raise CreateInteractionError.new("There was an error while trying to add interaction \"#{description}\"", error[:reason], error[:status])
+            end
+          else
+            result = PactFfi.with_body(message_pact, 0, JSON_CONTENT_TYPE, interaction_json)
+            unless result
+              raise InteractionMismatchesError.new("There was an error while trying to add message interaction contents \"#{description}\"")
+            end
+          end
+
+          # meta should be configured last to avoid resetting after body is set
+          InteractionContents.basic(@meta.merge(@headers)).each_pair do |key, value|
+            PactFfi::MessageConsumer.with_metadata_v2(message_pact, key.to_s, JSON.dump(value))
+          end
+        end
+
+        def description
+          "#{DESCRIPTION_PREFIX}#{@description}"
+        end
+
+        def init_plugin!(pact_handle)
+          result = PactFfi::PluginConsumer.using_plugin(pact_handle, PROTOBUF_PLUGIN_NAME, PROTOBUF_PLUGIN_VERSION)
+          return result if INIT_PLUGIN_ERRORS[result].blank?
+
+          error = INIT_PLUGIN_ERRORS[result]
+          raise PluginInitError.new("There was an error while trying to initialize plugin #{PROTOBUF_PLUGIN_NAME}/#{PROTOBUF_PLUGIN_VERSION}", error[:reason], error[:status])
+        end
+
+        def serialize_metadata(metadata_hash)
+          metadata = metadata_hash.deep_dup
+          serialize_as!(metadata, :basic)
+
+          metadata
+        end
+
+        def proto_interaction?
+          @proto_contents.present?
+        end
+      end
+    end
+  end
+end