[Feature] Allow configuring payload converter, codecs and failure converter on the client (#59)

Author: antstorm

lib/temporal/client.rb

@@ -1,10 +1,12 @@
 require 'json'
 require 'securerandom'
 require 'socket'
-require 'temporal/errors'
-require 'temporal/data_converter'
-require 'temporal/client/workflow_handle'
 require 'temporal/client/implementation'
+require 'temporal/client/workflow_handle'
+require 'temporal/data_converter'
+require 'temporal/errors'
+require 'temporal/failure_converter'
+require 'temporal/payload_converter'
 require 'temporal/workflow/id_reuse_policy'
 
 module Temporal
@@ -18,9 +20,31 @@ class Client
     # @param namespace [String] Namespace to use for client calls.
     # @param interceptors [Array<Temporal::Interceptor::Client>] List of interceptors for
     #   intercepting client calls. Executed in their original order.
-    def initialize(connection, namespace, interceptors: [])
+    # @param payload_converter [Temporal::PayloadConverter::Base] A custom payload converter for
+    #   converting Ruby values to/from protos. See {Temporal::PayloadConverter::Base} for the
+    #   interface definition.
+    # @param payload_codecs [Array<Temporal::PayloadCodec::Base>] A list of payload codecs to
+    #   transform payload protos. See {Temporal::PayloadCodec::Base} for the interface definition.
+    # @param failure_converter [Temporal::FailureConverter::Base] A custom failure converter for
+    #   converting Exceptions to/from protos. See {Temporal::FailureConverter::Base} for the
+    #   interface definition.
+    #
+    # @see https://docs.temporal.io/concepts/what-is-a-data-converter for more information on
+    #   payload converters and codecs.
+    def initialize(
+      connection,
+      namespace,
+      interceptors: [],
+      payload_converter: Temporal::PayloadConverter::DEFAULT,
+      payload_codecs: [],
+      failure_converter: Temporal::FailureConverter::DEFAULT
+    )
       @namespace = namespace
-      data_converter = DataConverter.new
+      data_converter = DataConverter.new(
+        payload_converter: payload_converter,
+        payload_codecs: payload_codecs,
+        failure_converter: failure_converter,
+      )
       @implementation = Client::Implementation.new(connection, namespace, data_converter, interceptors)
     end
 

lib/temporal/data_converter.rb

@@ -1,17 +1,11 @@
 require 'temporal/api/common/v1/message_pb'
 require 'temporal/errors'
-require 'temporal/payload_converter'
-require 'temporal/failure_converter'
 
 module Temporal
   class DataConverter
     class MissingPayload < Temporal::Error; end
 
-    def initialize(
-      payload_converter: Temporal::PayloadConverter::DEFAULT,
-      payload_codecs: [],
-      failure_converter: Temporal::FailureConverter::DEFAULT
-    )
+    def initialize(payload_converter:, payload_codecs:, failure_converter:)
       @payload_converter = payload_converter
       @payload_codecs = payload_codecs
       @failure_converter = failure_converter

sig/temporal/client.rbs

@@ -5,7 +5,10 @@ module Temporal
     def initialize: (
       Temporal::Connection connection,
       String | Symbol namespace,
-      ?interceptors: Array[Temporal::Interceptor::Client]
+      ?interceptors: Array[Temporal::Interceptor::Client],
+      ?payload_converter: Temporal::PayloadConverter::_PayloadConverter,
+      ?payload_codecs: Array[Temporal::PayloadCodec::_PayloadCodec],
+      ?failure_converter: Temporal::FailureConverter::_FailureConverter
     ) -> void
     def start_workflow: (
       String workflow,

sig/temporal/data_converter.rbs

@@ -4,9 +4,9 @@ module Temporal
     end
 
     def initialize: (
-      ?payload_converter: Temporal::PayloadConverter::_PayloadConverter,
-      ?payload_codecs: Array[Temporal::PayloadCodec::_PayloadCodec],
-      ?failure_converter: Temporal::FailureConverter::_FailureConverter,
+      payload_converter: Temporal::PayloadConverter::_PayloadConverter,
+      payload_codecs: Array[Temporal::PayloadCodec::_PayloadCodec],
+      failure_converter: Temporal::FailureConverter::_FailureConverter,
     ) -> void
     def to_payloads: (Array[untyped]? data) -> Temporal::Api::Common::V1::Payloads?
     def to_payload_map: (Hash[String | Symbol, untyped] data) -> Hash[String, Temporal::Api::Common::V1::Payload]

spec/unit/temporal/client/implementation_spec.rb

@@ -6,13 +6,21 @@
 require 'temporal/connection'
 require 'temporal/data_converter'
 require 'temporal/errors'
+require 'temporal/failure_converter'
+require 'temporal/payload_converter'
 
 describe Temporal::Client::Implementation do
   subject { described_class.new(connection, namespace, converter, interceptors) }
 
   let(:connection) { instance_double(Temporal::Connection) }
   let(:namespace) { 'test-namespace' }
-  let(:converter) { Temporal::DataConverter.new }
+  let(:converter) do
+    Temporal::DataConverter.new(
+      payload_converter: Temporal::PayloadConverter::DEFAULT,
+      payload_codecs: [],
+      failure_converter: Temporal::FailureConverter::DEFAULT,
+    )
+  end
   let(:interceptors) { [] }
   let(:id) { SecureRandom.uuid }
   let(:run_id) { SecureRandom.uuid }

spec/unit/temporal/client_spec.rb

@@ -4,6 +4,9 @@
 require 'temporal/client/workflow_handle'
 require 'temporal/connection'
 require 'temporal/data_converter'
+require 'temporal/failure_converter'
+require 'temporal/payload_codec/base'
+require 'temporal/payload_converter'
 require 'temporal/retry_policy'
 
 describe Temporal::Client do
@@ -24,6 +27,57 @@
       .and_return(client_impl)
   end
 
+  describe '#initialize' do
+    before { allow(Temporal::DataConverter).to receive(:new).and_call_original }
+
+    context 'with a custom payload converter' do
+      let(:payload_converter) { instance_double(Temporal::PayloadConverter::Base) }
+
+      it 'passes it to a data converter' do
+        described_class.new(connection, namespace, payload_converter: payload_converter)
+
+        expect(Temporal::DataConverter).to have_received(:new).with(
+          payload_converter: payload_converter,
+          payload_codecs: [],
+          failure_converter: Temporal::FailureConverter::DEFAULT,
+        )
+      end
+    end
+
+    context 'with custom payload codecs' do
+      let(:payload_codecs) do
+        [
+          instance_double(Temporal::PayloadCodec::Base),
+          instance_double(Temporal::PayloadCodec::Base),
+        ]
+      end
+
+      it 'passes it to a data converter' do
+        described_class.new(connection, namespace, payload_codecs: payload_codecs)
+
+        expect(Temporal::DataConverter).to have_received(:new).with(
+          payload_converter: Temporal::PayloadConverter::DEFAULT,
+          payload_codecs: payload_codecs,
+          failure_converter: Temporal::FailureConverter::DEFAULT,
+        )
+      end
+    end
+
+    context 'with a custom failure converter' do
+      let(:failure_converter) { instance_double(Temporal::FailureConverter::Base) }
+
+      it 'passes it to a data converter' do
+        described_class.new(connection, namespace, failure_converter: failure_converter)
+
+        expect(Temporal::DataConverter).to have_received(:new).with(
+          payload_converter: Temporal::PayloadConverter::DEFAULT,
+          payload_codecs: [],
+          failure_converter: failure_converter,
+        )
+      end
+    end
+  end
+
   describe '#start_workflow' do
     let(:handle) do
       Temporal::Client::WorkflowHandle.new(

spec/unit/temporal/workflow/execution_info_spec.rb

@@ -1,13 +1,21 @@
 require 'securerandom'
 require 'temporal/api/workflowservice/v1/request_response_pb'
 require 'temporal/data_converter'
+require 'temporal/failure_converter'
+require 'temporal/payload_converter'
 require 'temporal/workflow/execution_info'
 require 'temporal/workflow/execution_status'
 
 describe Temporal::Workflow::ExecutionInfo do
   subject { described_class.from_raw(proto, converter) }
 
-  let(:converter) { Temporal::DataConverter.new }
+  let(:converter) do
+    Temporal::DataConverter.new(
+      payload_converter: Temporal::PayloadConverter::DEFAULT,
+      payload_codecs: [],
+      failure_converter: Temporal::FailureConverter::DEFAULT,
+    )
+  end
   let(:id) { SecureRandom.uuid }
   let(:run_id) { SecureRandom.uuid }
   let(:time_now) { Time.now }