temporalio 0.0.0 → 0.0.2

data/lib/temporalio/failure_converter/basic.rb

@@ -0,0 +1,319 @@
+require 'temporal/api/common/v1/message_pb'
+require 'temporal/api/failure/v1/message_pb'
+require 'temporalio/error/failure'
+require 'temporalio/failure_converter/base'
+require 'temporalio/retry_state'
+require 'temporalio/timeout_type'
+
+module Temporalio
+  module FailureConverter
+    # A default implementation of a FailureConverter.
+    #
+    # Use {Temporalio::DataConverter} for the set of helper method for interaction with converters.
+    #
+    # @api private
+    class Basic < Base
+      def initialize(encode_common_attributes: false)
+        super()
+
+        @encode_common_attributes = encode_common_attributes
+      end
+
+      def to_failure(error, payload_converter)
+        return error.raw if error.is_a?(Temporalio::Error::Failure) && error.raw
+
+        failure =
+          case error
+          when Temporalio::Error::ApplicationError
+            to_application_failure(error, payload_converter)
+          when Temporalio::Error::TimeoutError
+            to_timeout_failure(error, payload_converter)
+          when Temporalio::Error::CancelledError
+            to_cancelled_failure(error, payload_converter)
+          when Temporalio::Error::TerminatedError
+            to_terminated_failure(error, payload_converter)
+          when Temporalio::Error::ServerError
+            to_server_failure(error, payload_converter)
+          when Temporalio::Error::ResetWorkflowError
+            to_reset_workflow_failure(error, payload_converter)
+          when Temporalio::Error::ActivityError
+            to_activity_failure(error, payload_converter)
+          when Temporalio::Error::ChildWorkflowError
+            to_child_workflow_execution_failure(error, payload_converter)
+          else
+            to_generic_failure(error, payload_converter)
+          end
+
+        failure.message = error.message
+        failure.stack_trace = error.backtrace&.join("\n") || ''
+        # RBS: StandardError fallback is only needed to satisfy steep - https://github.com/soutaro/steep/issues/477
+        failure.cause = to_failure(error.cause || StandardError.new, payload_converter) if error.cause
+
+        if encode_common_attributes?
+          failure.encoded_attributes = payload_converter.to_payload(
+            'message' => failure.message,
+            'stack_trace' => failure.stack_trace,
+          )
+          failure.message = 'Encoded failure'
+          failure.stack_trace = ''
+        end
+
+        failure
+      end
+
+      def from_failure(failure, payload_converter)
+        failure = apply_from_encoded_attributes(failure, payload_converter)
+        cause = failure.cause ? from_failure(failure.cause, payload_converter) : nil
+
+        error =
+          if failure.application_failure_info
+            from_application_failure(failure, failure.application_failure_info, cause, payload_converter)
+          elsif failure.timeout_failure_info
+            from_timeout_failure(failure, failure.timeout_failure_info, cause, payload_converter)
+          elsif failure.canceled_failure_info
+            from_cancelled_failure(failure, failure.canceled_failure_info, cause, payload_converter)
+          elsif failure.terminated_failure_info
+            from_terminated_failure(failure, failure.terminated_failure_info, cause, payload_converter)
+          elsif failure.server_failure_info
+            from_server_failure(failure, failure.server_failure_info, cause, payload_converter)
+          elsif failure.reset_workflow_failure_info
+            from_reset_workflow_failure(failure, failure.reset_workflow_failure_info, cause, payload_converter)
+          elsif failure.activity_failure_info
+            from_activity_failure(failure, failure.activity_failure_info, cause, payload_converter)
+          elsif failure.child_workflow_execution_failure_info
+            from_child_workflow_execution_failure(
+              failure,
+              failure.child_workflow_execution_failure_info,
+              cause,
+              payload_converter,
+            )
+          else
+            from_generic_failure(failure, cause, payload_converter)
+          end
+
+        unless failure.stack_trace.empty?
+          error.set_backtrace(failure.stack_trace.split("\n"))
+        end
+
+        error
+      end
+
+      private
+
+      def encode_common_attributes?
+        @encode_common_attributes
+      end
+
+      def to_payloads(data, payload_converter)
+        return if data.nil? || Array(data).empty?
+
+        payloads = Array(data).map { |value| payload_converter.to_payload(value) }
+        Temporalio::Api::Common::V1::Payloads.new(payloads: payloads)
+      end
+
+      def from_payloads(payloads, payload_converter)
+        return [] unless payloads
+
+        payloads.payloads.map { |payload| payload_converter.from_payload(payload) }
+      end
+
+      def apply_from_encoded_attributes(failure, payload_converter)
+        return failure unless failure.encoded_attributes
+
+        attributes = payload_converter.from_payload(failure.encoded_attributes)
+        return failure unless attributes.is_a?(Hash)
+
+        failure = failure.dup
+        if attributes['message'].is_a?(String)
+          failure.message = attributes['message']
+        end
+
+        if attributes['stack_trace'].is_a?(String)
+          failure.stack_trace = attributes['stack_trace']
+        end
+
+        failure
+      end
+
+      def to_application_failure(error, payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          application_failure_info: Temporalio::Api::Failure::V1::ApplicationFailureInfo.new(
+            type: error.type,
+            non_retryable: error.non_retryable,
+            details: to_payloads(error.details, payload_converter),
+          ),
+        )
+      end
+
+      def to_timeout_failure(error, payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          timeout_failure_info: Temporalio::Api::Failure::V1::TimeoutFailureInfo.new(
+            timeout_type: Temporalio::TimeoutType.to_raw(error.type),
+            last_heartbeat_details: to_payloads(error.last_heartbeat_details, payload_converter),
+          ),
+        )
+      end
+
+      def to_cancelled_failure(error, payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          canceled_failure_info: Temporalio::Api::Failure::V1::CanceledFailureInfo.new(
+            details: to_payloads(error.details, payload_converter),
+          ),
+        )
+      end
+
+      def to_terminated_failure(_error, _payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          terminated_failure_info: Temporalio::Api::Failure::V1::TerminatedFailureInfo.new,
+        )
+      end
+
+      def to_server_failure(error, _payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          server_failure_info: Temporalio::Api::Failure::V1::ServerFailureInfo.new(
+            non_retryable: error.non_retryable,
+          ),
+        )
+      end
+
+      def to_reset_workflow_failure(error, payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          reset_workflow_failure_info: Temporalio::Api::Failure::V1::ResetWorkflowFailureInfo.new(
+            last_heartbeat_details: to_payloads(error.last_heartbeat_details, payload_converter),
+          ),
+        )
+      end
+
+      def to_activity_failure(error, _payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          activity_failure_info: Temporalio::Api::Failure::V1::ActivityFailureInfo.new(
+            scheduled_event_id: error.scheduled_event_id,
+            started_event_id: error.started_event_id,
+            identity: error.identity,
+            activity_type: Temporalio::Api::Common::V1::ActivityType.new(name: error.activity_name || ''),
+            activity_id: error.activity_id,
+            retry_state: Temporalio::RetryState.to_raw(error.retry_state),
+          ),
+        )
+      end
+
+      def to_child_workflow_execution_failure(error, _payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          child_workflow_execution_failure_info:
+            Temporalio::Api::Failure::V1::ChildWorkflowExecutionFailureInfo.new(
+              namespace: error.namespace,
+              workflow_execution: Temporalio::Api::Common::V1::WorkflowExecution.new(
+                workflow_id: error.workflow_id || '',
+                run_id: error.run_id || '',
+              ),
+              workflow_type: Temporalio::Api::Common::V1::WorkflowType.new(name: error.workflow_name || ''),
+              initiated_event_id: error.initiated_event_id,
+              started_event_id: error.started_event_id,
+              retry_state: Temporalio::RetryState.to_raw(error.retry_state),
+            ),
+        )
+      end
+
+      def to_generic_failure(error, _payload_converter)
+        Temporalio::Api::Failure::V1::Failure.new(
+          application_failure_info: Temporalio::Api::Failure::V1::ApplicationFailureInfo.new(
+            type: error.class.name,
+          ),
+        )
+      end
+
+      def from_application_failure(failure, failure_info, cause, payload_converter)
+        Temporalio::Error::ApplicationError.new(
+          failure.message || 'Application error',
+          type: failure_info.type,
+          details: from_payloads(failure_info.details, payload_converter),
+          non_retryable: failure_info.non_retryable,
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_timeout_failure(failure, failure_info, cause, payload_converter)
+        Temporalio::Error::TimeoutError.new(
+          failure.message || 'Timeout',
+          type: Temporalio::TimeoutType.from_raw(failure_info.timeout_type),
+          last_heartbeat_details: from_payloads(failure_info.last_heartbeat_details, payload_converter),
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_cancelled_failure(failure, failure_info, cause, payload_converter)
+        Temporalio::Error::CancelledError.new(
+          failure.message || 'Cancelled',
+          details: from_payloads(failure_info.details, payload_converter),
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_terminated_failure(failure, _failure_info, cause, _payload_converter)
+        Temporalio::Error::TerminatedError.new(
+          failure.message || 'Terminated',
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_server_failure(failure, failure_info, cause, _payload_converter)
+        Temporalio::Error::ServerError.new(
+          failure.message || 'Server error',
+          non_retryable: failure_info.non_retryable,
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_reset_workflow_failure(failure, failure_info, cause, payload_converter)
+        Temporalio::Error::ResetWorkflowError.new(
+          failure.message || 'Reset workflow error',
+          last_heartbeat_details: from_payloads(failure_info.last_heartbeat_details, payload_converter),
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_activity_failure(failure, failure_info, cause, _payload_converter)
+        Temporalio::Error::ActivityError.new(
+          failure.message || 'Activity error',
+          scheduled_event_id: failure_info.scheduled_event_id,
+          started_event_id: failure_info.started_event_id,
+          identity: failure_info.identity,
+          activity_name: failure_info.activity_type&.name,
+          activity_id: failure_info.activity_id,
+          retry_state: Temporalio::RetryState.from_raw(failure_info.retry_state),
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_child_workflow_execution_failure(failure, failure_info, cause, _payload_converter)
+        Temporalio::Error::ChildWorkflowError.new(
+          failure.message || 'Child workflow error',
+          namespace: failure_info.namespace,
+          workflow_id: failure_info.workflow_execution&.workflow_id,
+          run_id: failure_info.workflow_execution&.run_id,
+          workflow_name: failure_info.workflow_type&.name,
+          initiated_event_id: failure_info.initiated_event_id,
+          started_event_id: failure_info.started_event_id,
+          retry_state: Temporalio::RetryState.from_raw(failure_info.retry_state),
+          raw: failure,
+          cause: cause,
+        )
+      end
+
+      def from_generic_failure(failure, cause, _payload_converter)
+        Temporalio::Error::Failure.new(
+          failure.message || 'Failure error',
+          raw: failure,
+          cause: cause,
+        )
+      end
+    end
+  end
+end

data/lib/temporalio/failure_converter.rb

@@ -0,0 +1,7 @@
+require 'temporalio/failure_converter/basic'
+
+module Temporalio
+  module FailureConverter
+    DEFAULT = Temporalio::FailureConverter::Basic.new
+  end
+end

data/lib/temporalio/interceptor/chain.rb

@@ -0,0 +1,28 @@
+module Temporalio
+  module Interceptor
+    # @api private
+    class Chain
+      def initialize(interceptors = [])
+        @interceptors = interceptors
+      end
+
+      def invoke(method, input)
+        chain = interceptors.dup
+
+        traverse_chain = lambda do |i|
+          if chain.empty?
+            yield(i)
+          else
+            chain.shift.public_send(method, i, &traverse_chain)
+          end
+        end
+
+        traverse_chain.call(input)
+      end
+
+      private
+
+      attr_reader :interceptors
+    end
+  end
+end

data/lib/temporalio/interceptor/client.rb

@@ -0,0 +1,123 @@
+module Temporalio
+  module Interceptor
+    # Base class for implementing Client side interceptors.
+    #
+    # @abstract
+    class Client
+      class StartWorkflowInput < Struct.new(
+        :workflow,
+        :args,
+        :id,
+        :task_queue,
+        :execution_timeout,
+        :run_timeout,
+        :task_timeout,
+        :id_reuse_policy,
+        :retry_policy,
+        :cron_schedule,
+        :memo,
+        :search_attributes,
+        :headers,
+        :start_signal,
+        :start_signal_args,
+        :rpc_metadata,
+        :rpc_timeout,
+        keyword_init: true,
+      ); end
+
+      class DescribeWorkflowInput < Struct.new(
+        :id,
+        :run_id,
+        :rpc_metadata,
+        :rpc_timeout,
+        keyword_init: true,
+      ); end
+
+      class QueryWorkflowInput < Struct.new(
+        :id,
+        :run_id,
+        :query,
+        :args,
+        :reject_condition,
+        :headers,
+        :rpc_metadata,
+        :rpc_timeout,
+        keyword_init: true,
+      ); end
+
+      class SignalWorkflowInput < Struct.new(
+        :id,
+        :run_id,
+        :signal,
+        :args,
+        :headers,
+        :rpc_metadata,
+        :rpc_timeout,
+        keyword_init: true,
+      ); end
+
+      class CancelWorkflowInput < Struct.new(
+        :id,
+        :run_id,
+        :first_execution_run_id,
+        :reason,
+        :rpc_metadata,
+        :rpc_timeout,
+        keyword_init: true,
+      ); end
+
+      class TerminateWorkflowInput < Struct.new(
+        :id,
+        :run_id,
+        :first_execution_run_id,
+        :reason,
+        :args,
+        :rpc_metadata,
+        :rpc_timeout,
+        keyword_init: true,
+      ); end
+
+      # Interceptor for {Temporalio::Client#start_workflow}.
+      #
+      # @param input [StartWorkflowInput]
+      def start_workflow(input)
+        yield(input)
+      end
+
+      # Interceptor for {Temporalio::Client::WorkflowHandle#describe}.
+      #
+      # @param input [DescribeWorkflowInput]
+      def describe_workflow(input)
+        yield(input)
+      end
+
+      # Interceptor for {Temporalio::Client::WorkflowHandle#query}.
+      #
+      # @param input [QueryWorkflowInput]
+      def query_workflow(input)
+        yield(input)
+      end
+
+      # Interceptor for {Temporalio::Client::WorkflowHandle#signal}.
+      #
+      # @param input [SignalWorkflowInput]
+      def signal_workflow(input)
+        yield(input)
+      end
+
+      # Interceptor for {Temporalio::Client::WorkflowHandle#cancel}.
+      #
+      # @param input [CancelWorkflowInput]
+      def cancel_workflow(input)
+        yield(input)
+      end
+
+      # Interceptor for {Temporalio::Client::WorkflowHandle#terminate}.
+      #
+      # @param input [TerminateWorkflowInput]
+      def terminate_workflow(input)
+        yield(input)
+      end
+    end
+  end
+end

data/lib/temporalio/payload_codec/base.rb

@@ -0,0 +1,32 @@
+module Temporalio
+  module PayloadCodec
+    # @abstract Use this Interface for implementing your payload codecs.
+    #
+    # Codec for encoding/decoding to/from bytes. Commonly used for compression or encryption.
+    class Base
+      # Encode the given payloads.
+      #
+      # @param _payloads [Array<Temporalio::Api::Common::V1::Payload>] Payloads to encode.
+      #   This value should not be mutated.
+      #
+      # @return [Array<Temporalio::Api::Common::V1::Payload>] Encoded payloads. Note, this does not
+      #   have to be the same number as payloads given, but must be at least one and cannot be more
+      #   than was given.
+      def encode(_payloads)
+        raise NoMethodError, 'must implement #encode'
+      end
+
+      # Decode the given payloads.
+      #
+      # @param _payloads [Array<Temporalio::Api::Common::V1::Payload>] Payloads to decode. This value
+      #   should not be mutated.
+      #
+      # @return [Array<Temporalio::Api::Common::V1::Payload>] Decoded payloads. Note, this does not
+      #   have to be the same number as payloads given, but must be at least one and cannot be more
+      #   than was given.
+      def decode(_payloads)
+        raise NoMethodError, 'must implement #decode'
+      end
+    end
+  end
+end

data/lib/temporalio/payload_converter/base.rb

@@ -0,0 +1,24 @@
+module Temporalio
+  module PayloadConverter
+    # @abstract Use this Interface for implementing your payload converter.
+    class Base
+      # Convert a Ruby value to a proto Payload.
+      #
+      # @param _data [any] Ruby value to be converted.
+      #
+      # @return [Temporalio::Api::Common::V1::Payload]
+      def to_payload(_data)
+        raise NoMethodError, 'must implement #to_payload'
+      end
+
+      # Convert a proto Payload to a Ruby value.
+      #
+      # @param _payload [Temporalio::Api::Common::V1::Payload] Proto Payload to be converted.
+      #
+      # @return [any]
+      def from_payload(_payload)
+        raise NoMethodError, 'must implement #from_payload'
+      end
+    end
+  end
+end

data/lib/temporalio/payload_converter/bytes.rb

@@ -0,0 +1,27 @@
+require 'temporalio/payload_converter/encoding_base'
+
+module Temporalio
+  module PayloadConverter
+    # A payload converter for encoding/decoding byte strings.
+    class Bytes < EncodingBase
+      ENCODING = 'binary/plain'.freeze
+
+      def encoding
+        ENCODING
+      end
+
+      def from_payload(payload)
+        payload.data
+      end
+
+      def to_payload(data)
+        return nil unless data.is_a?(String) && data.encoding == Encoding::ASCII_8BIT
+
+        Temporalio::Api::Common::V1::Payload.new(
+          metadata: { 'encoding' => ENCODING },
+          data: data,
+        )
+      end
+    end
+  end
+end

data/lib/temporalio/payload_converter/composite.rb

@@ -0,0 +1,49 @@
+require 'temporalio/payload_converter/base'
+require 'temporalio/errors'
+
+module Temporalio
+  module PayloadConverter
+    # A payload converter for combining multiple payload converters together.
+    class Composite < Base
+      class ConverterNotFound < Temporalio::Error; end
+      class EncodingNotSet < Temporalio::Error; end
+
+      # @param converters [Array<Temporalio::PayloadConverter::Base>] List of converters
+      def initialize(*converters)
+        super()
+
+        @converters = converters.each_with_object({}) do |converter, result|
+          result[converter.encoding] = converter
+          result
+        end
+      end
+
+      def to_payload(data)
+        converters.each_value do |converter|
+          payload = converter.to_payload(data)
+          return payload unless payload.nil?
+        end
+
+        available = converters.values.map(&:class).join(', ')
+        raise ConverterNotFound, "Available converters (#{available}) could not convert data"
+      end
+
+      def from_payload(payload)
+        encoding = payload.metadata['encoding']
+        raise EncodingNotSet, 'Missing payload encoding' unless encoding
+
+        converter = converters[encoding]
+        unless converter
+          available = converters.keys.join(', ')
+          raise ConverterNotFound, "Missing converter for encoding '#{encoding}' (available: #{available})"
+        end
+
+        converter.from_payload(payload)
+      end
+
+      private
+
+      attr_reader :converters
+    end
+  end
+end

data/lib/temporalio/payload_converter/encoding_base.rb

@@ -0,0 +1,35 @@
+require 'temporal/api/common/v1/message_pb'
+
+module Temporalio
+  module PayloadConverter
+    # @abstract Use this Interface for implementing an encoding payload converter.
+    #   This is used as a converter for the {Temporalio::PayloadConverter::Composite}.
+    class EncodingBase
+      # A mime-type for the converter's encoding.
+      #
+      # @return [String]
+      def encoding
+        raise NoMethodError, 'must implement #encoding'
+      end
+
+      # Convert a Ruby value to a proto Payload.
+      #
+      # @param _data [any] Ruby value to be converted.
+      #
+      # @return [Temporalio::Api::Common::V1::Payload, nil] Return `nil` if the received value is not
+      #   supported by this converter.
+      def to_payload(_data)
+        raise NoMethodError, 'must implement #to_payload'
+      end
+
+      # Convert a proto Payload to a Ruby value.
+      #
+      # @param _payload [Temporalio::Api::Common::V1::Payload] Proto Payload to be converted.
+      #
+      # @return [any]
+      def from_payload(_payload)
+        raise NoMethodError, 'must implement #from_payload'
+      end
+    end
+  end
+end

data/lib/temporalio/payload_converter/json.rb

@@ -0,0 +1,26 @@
+require 'json/ext'
+require 'temporalio/payload_converter/encoding_base'
+
+module Temporalio
+  module PayloadConverter
+    # A payload converter for encoding/decoding JSON data.
+    class JSON < EncodingBase
+      ENCODING = 'json/plain'.freeze
+
+      def encoding
+        ENCODING
+      end
+
+      def from_payload(payload)
+        ::JSON.parse(payload.data, create_additions: true)
+      end
+
+      def to_payload(data)
+        Temporalio::Api::Common::V1::Payload.new(
+          metadata: { 'encoding' => ENCODING },
+          data: ::JSON.generate(data).b,
+        )
+      end
+    end
+  end
+end