temporalio 0.0.1 → 0.1.0

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/activity_inbound.rb

@@ -0,0 +1,22 @@
+module Temporalio
+  module Interceptor
+    # A mixin for implementing inbound Activity interceptors.
+    module ActivityInbound
+      class ExecuteActivityInput < Struct.new(
+        :activity,
+        :args,
+        :headers,
+        keyword_init: true,
+      ); end
+
+      # Interceptor for {Temporalio::Activity#execute}.
+      #
+      # @param input [ExecuteActivityInput]
+      #
+      # @return [any] Activity execution result
+      def execute_activity(input)
+        yield(input)
+      end
+    end
+  end
+end

data/lib/temporalio/interceptor/activity_outbound.rb

@@ -0,0 +1,24 @@
+module Temporalio
+  module Interceptor
+    # A mixin for implementing outbound Activity interceptors.
+    module ActivityOutbound
+      # Interceptor for {Temporalio::Activity::Context#info}.
+      #
+      # @yieldreturn Temporalio::Activity::Info
+      #
+      # @return [Temporalio::Activity::Info]
+      def activity_info
+        yield
+      end
+
+      # Interceptor for {Temporalio::Activity::Context#heartbeat}.
+      #
+      # @yieldparam Array[untyped]
+      #
+      # @param details [any] A list of details supplied with the heartbeat.
+      def heartbeat(*details)
+        yield(*details)
+      end
+    end
+  end
+end

data/lib/{temporal → temporalio}/interceptor/chain.rb

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

data/lib/{temporal → temporalio}/interceptor/client.rb

@@ -1,6 +1,7 @@
-module Temporal
+module Temporalio
   module Interceptor
-    class Client
+    # A mixin for implementing Client side interceptors.
+    module Client
       class StartWorkflowInput < Struct.new(
         :workflow,
         :args,
@@ -74,26 +75,50 @@ module Temporal
         keyword_init: true,
       ); end
 
+      # Interceptor for {Temporalio::Client#start_workflow}.
+      #
+      # @param input [StartWorkflowInput]
+      #
+      # @return [Temporalio::Client::WorkflowHandle] A handle to interact with the workflow.
       def start_workflow(input)
         yield(input)
       end
 
+      # Interceptor for {Temporalio::Client::WorkflowHandle#describe}.
+      #
+      # @param input [DescribeWorkflowInput]
+      #
+      # @return [Temporalio::Workflow::ExecutionInfo] Information about the workflow.
       def describe_workflow(input)
         yield(input)
       end
 
+      # Interceptor for {Temporalio::Client::WorkflowHandle#query}.
+      #
+      # @param input [QueryWorkflowInput]
+      #
+      # @return [any] Query result
       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

data/lib/temporalio/interceptor.rb

@@ -0,0 +1,22 @@
+require 'temporalio/interceptor/activity_inbound'
+require 'temporalio/interceptor/activity_outbound'
+
+module Temporalio
+  module Interceptor
+    # NOTE: Using #each_with_object here and below instead of a simple #select because RBS can't
+    #       reconcile that resulting array only has WorkflowInbound or WorkflowOutbound in it.
+    def self.filter(interceptors, type)
+      interceptor_class =
+        case type
+        when :activity_inbound
+          Temporalio::Interceptor::ActivityInbound
+        when :activity_outbound
+          Temporalio::Interceptor::ActivityOutbound
+        end
+
+      interceptors.each_with_object([]) do |i, result|
+        result << i if i.is_a?(interceptor_class)
+      end
+    end
+  end
+end

data/lib/{temporal → temporalio}/payload_codec/base.rb

@@ -1,4 +1,4 @@
-module Temporal
+module Temporalio
   module PayloadCodec
     # @abstract Use this Interface for implementing your payload codecs.
     #
@@ -6,10 +6,10 @@ module Temporal
     class Base
       # Encode the given payloads.
       #
-      # @param _payloads [Array<Temporal::Api::Common::V1::Payload>] Payloads to encode.
+      # @param _payloads [Array<Temporalio::Api::Common::V1::Payload>] Payloads to encode.
       #   This value should not be mutated.
       #
-      # @return [Array<Temporal::Api::Common::V1::Payload>] Encoded payloads. Note, this does not
+      # @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)
@@ -18,10 +18,10 @@ module Temporal
 
       # Decode the given payloads.
       #
-      # @param _payloads [Array<Temporal::Api::Common::V1::Payload>] Payloads to decode. This value
+      # @param _payloads [Array<Temporalio::Api::Common::V1::Payload>] Payloads to decode. This value
       #   should not be mutated.
       #
-      # @return [Array<Temporal::Api::Common::V1::Payload>] Decoded payloads. Note, this does not
+      # @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)

data/lib/{temporal → temporalio}/payload_converter/base.rb

@@ -1,4 +1,4 @@
-module Temporal
+module Temporalio
   module PayloadConverter
     # @abstract Use this Interface for implementing your payload converter.
     class Base
@@ -6,14 +6,14 @@ module Temporal
       #
       # @param _data [any] Ruby value to be converted.
       #
-      # @return [Temporal::Api::Common::V1::Payload]
+      # @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 [Temporal::Api::Common::V1::Payload] Proto Payload to be converted.
+      # @param _payload [Temporalio::Api::Common::V1::Payload] Proto Payload to be converted.
       #
       # @return [any]
       def from_payload(_payload)

data/lib/{temporal → temporalio}/payload_converter/bytes.rb

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

data/lib/{temporal → temporalio}/payload_converter/composite.rb

@@ -1,12 +1,14 @@
-require 'temporal/payload_converter/base'
-require 'temporal/errors'
+require 'temporalio/payload_converter/base'
+require 'temporalio/errors'
 
-module Temporal
+module Temporalio
   module PayloadConverter
+    # A payload converter for combining multiple payload converters together.
     class Composite < Base
-      class ConverterNotFound < Temporal::Error; end
-      class EncodingNotSet < Temporal::Error; end
+      class ConverterNotFound < Temporalio::Error; end
+      class EncodingNotSet < Temporalio::Error; end
 
+      # @param converters [Array<Temporalio::PayloadConverter::Base>] List of converters
       def initialize(*converters)
         super()
 

data/lib/{temporal → temporalio}/payload_converter/encoding_base.rb

@@ -1,9 +1,9 @@
 require 'temporal/api/common/v1/message_pb'
 
-module Temporal
+module Temporalio
   module PayloadConverter
     # @abstract Use this Interface for implementing an encoding payload converter.
-    #   This is used as a converter for the {Temporal::PayloadConverter::Composite}.
+    #   This is used as a converter for the {Temporalio::PayloadConverter::Composite}.
     class EncodingBase
       # A mime-type for the converter's encoding.
       #
@@ -16,7 +16,7 @@ module Temporal
       #
       # @param _data [any] Ruby value to be converted.
       #
-      # @return [Temporal::Api::Common::V1::Payload, nil] Return `nil` if the received value is not
+      # @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'
@@ -24,7 +24,7 @@ module Temporal
 
       # Convert a proto Payload to a Ruby value.
       #
-      # @param _payload [Temporal::Api::Common::V1::Payload] Proto Payload to be converted.
+      # @param _payload [Temporalio::Api::Common::V1::Payload] Proto Payload to be converted.
       #
       # @return [any]
       def from_payload(_payload)

data/lib/{temporal → temporalio}/payload_converter/json.rb

@@ -1,8 +1,9 @@
 require 'json/ext'
-require 'temporal/payload_converter/encoding_base'
+require 'temporalio/payload_converter/encoding_base'
 
-module Temporal
+module Temporalio
   module PayloadConverter
+    # A payload converter for encoding/decoding JSON data.
     class JSON < EncodingBase
       ENCODING = 'json/plain'.freeze
 
@@ -15,7 +16,7 @@ module Temporal
       end
 
       def to_payload(data)
-        Temporal::Api::Common::V1::Payload.new(
+        Temporalio::Api::Common::V1::Payload.new(
           metadata: { 'encoding' => ENCODING },
           data: ::JSON.generate(data).b,
         )

data/lib/{temporal → temporalio}/payload_converter/nil.rb

@@ -1,7 +1,8 @@
-require 'temporal/payload_converter/encoding_base'
+require 'temporalio/payload_converter/encoding_base'
 
-module Temporal
+module Temporalio
   module PayloadConverter
+    # A payload converter for encoding/decoding nils.
     class Nil < EncodingBase
       ENCODING = 'binary/null'.freeze
 
@@ -16,7 +17,7 @@ module Temporal
       def to_payload(data)
         return nil unless data.nil?
 
-        Temporal::Api::Common::V1::Payload.new(
+        Temporalio::Api::Common::V1::Payload.new(
           metadata: { 'encoding' => ENCODING },
         )
       end

data/lib/temporalio/payload_converter.rb

@@ -0,0 +1,14 @@
+require 'temporalio/payload_converter/bytes'
+require 'temporalio/payload_converter/composite'
+require 'temporalio/payload_converter/json'
+require 'temporalio/payload_converter/nil'
+
+module Temporalio
+  module PayloadConverter
+    DEFAULT = Temporalio::PayloadConverter::Composite.new(
+      Temporalio::PayloadConverter::Nil.new,
+      Temporalio::PayloadConverter::Bytes.new,
+      Temporalio::PayloadConverter::JSON.new,
+    )
+  end
+end

data/lib/{temporal → temporalio}/retry_policy.rb

@@ -1,12 +1,12 @@
 require 'temporal/api/common/v1/message_pb'
-require 'temporal/errors'
+require 'temporalio/errors'
 
-module Temporal
+module Temporalio
   # Options for retrying workflows and activities.
   #
   # @see https://docs.temporal.io/application-development/features/#workflow-retry-policy
   class RetryPolicy
-    class Invalid < Temporal::Error; end
+    class Invalid < Temporalio::Error; end
 
     # @return [Integer] Backoff interval for the first retry.
     attr_reader :initial_interval
@@ -24,13 +24,23 @@ module Temporal
     # @return [Array<String>] List of error types that are not retryable.
     attr_reader :non_retriable_errors
 
+    def self.from_proto(proto)
+      new(
+        initial_interval: proto.initial_interval&.to_f&.round || 0,
+        backoff: proto.backoff_coefficient&.to_f || 0.0,
+        max_interval: proto.maximum_interval&.to_f&.round || 0,
+        max_attempts: proto.maximum_attempts || 1,
+        non_retriable_errors: proto.non_retryable_error_types || [],
+      ).freeze
+    end
+
     # @param initial_interval [Integer] Backoff interval (in seconds) for the first retry.
     # @param backoff [Float] Coefficient to multiply previous backoff interval by to get new
     #   interval.
     # @param max_interval [Integer] Maximum backoff interval between retries. Default 100x
     #   {#initial_interval}.
     # @param max_attempts [Integer] Maximum number of attempts. If 0, there is no maximum.
-    # @param non_retriable_errors [Array<String>] List of error types that are not retryable.
+    # @param non_retriable_errors [Array<Class, String>] List of error types that are not retryable.
     def initialize(
       initial_interval: 1,
       backoff: 2.0,
@@ -42,7 +52,7 @@ module Temporal
       @backoff = backoff
       @max_interval = max_interval
       @max_attempts = max_attempts
-      @non_retriable_errors = non_retriable_errors
+      @non_retriable_errors = non_retriable_errors.map(&:to_s).compact
     end
 
     def validate!
@@ -70,12 +80,12 @@ module Temporal
     end
 
     def to_proto
-      Temporal::Api::Common::V1::RetryPolicy.new(
+      Temporalio::Api::Common::V1::RetryPolicy.new(
         initial_interval: Google::Protobuf::Duration.new(seconds: initial_interval),
         backoff_coefficient: backoff,
         maximum_interval: max_interval ? Google::Protobuf::Duration.new(seconds: max_interval) : nil,
         maximum_attempts: max_attempts,
-        non_retryable_error_types: non_retriable_errors.map(&:name).compact,
+        non_retryable_error_types: non_retriable_errors,
       )
     end
   end

data/lib/{temporal → temporalio}/retry_state.rb

@@ -1,4 +1,4 @@
-module Temporal
+module Temporalio
   # Current retry state of the workflow/activity during error.
   module RetryState
     STATES = [

data/lib/temporalio/runtime.rb

@@ -0,0 +1,25 @@
+require 'singleton'
+require 'temporalio/bridge'
+require 'temporalio/worker/reactor'
+
+module Temporalio
+  # @api private
+  class Runtime
+    include Singleton
+
+    attr_reader :core_runtime, :reactor
+
+    def initialize
+      @core_runtime = Temporalio::Bridge::Runtime.init
+      @reactor = Temporalio::Worker::Reactor.new
+    end
+
+    def ensure_callback_loop
+      return if @thread
+
+      @thread = Thread.new do
+        core_runtime.run_callback_loop
+      end
+    end
+  end
+end

data/lib/temporalio/testing/time_skipping_handle.rb

@@ -0,0 +1,32 @@
+require 'forwardable'
+
+module Temporalio
+  module Testing
+    class TimeSkippingHandle
+      extend Forwardable
+
+      # Proxy all the WorkflowHandle calls to the original handle except for :result
+      def_delegators :handle, :id, :run_id, :result_run_id, :first_execution_run_id, :describe,
+                     :cancel, :query, :signal, :terminate
+
+      def initialize(handle, env)
+        @handle = handle
+        @env = env
+      end
+
+      def result(follow_runs: true, rpc_metadata: {}, rpc_timeout: nil)
+        env.with_time_skipping do
+          handle.result(
+            follow_runs: follow_runs,
+            rpc_metadata: rpc_metadata,
+            rpc_timeout: rpc_timeout,
+          )
+        end
+      end
+
+      private
+
+      attr_reader :handle, :env
+    end
+  end
+end

data/lib/temporalio/testing/time_skipping_interceptor.rb

@@ -0,0 +1,23 @@
+require 'temporalio/interceptor/client'
+require 'temporalio/testing/time_skipping_handle'
+
+module Temporalio
+  module Testing
+    class TimeSkippingInterceptor
+      include Temporalio::Interceptor::Client
+
+      def initialize(env)
+        @env = env
+      end
+
+      def start_workflow(input)
+        handle = yield(input)
+        Temporalio::Testing::TimeSkippingHandle.new(handle, env)
+      end
+
+      private
+
+      attr_reader :env
+    end
+  end
+end

data/lib/temporalio/testing/workflow_environment.rb

@@ -0,0 +1,112 @@
+require 'google/protobuf/well_known_types'
+require 'temporalio/client'
+require 'temporalio/testing/time_skipping_interceptor'
+
+module Temporalio
+  module Testing
+    # Workflow environment for testing workflows.
+    #
+    # Most developers will want to use the {Temporalio::Testing.start_time_skipping_environment} to
+    # start a test server process that automatically skips time as needed. Alternatively,
+    # {Temporalio::Testing.start_local_environment} may be used for a full, local Temporal server
+    # with more features.
+    #
+    # @note Unless using the above mentioned methods with an explicit block, you will need to call
+    # {#shutdown} after you're finished with this environment.
+    class WorkflowEnvironment
+      # @return [Temporalio::Connection] A connection to this environment.
+      attr_reader :connection
+
+      # @return [String] A namespace for this environment.
+      attr_reader :namespace
+
+      # @api private
+      def initialize(server, connection, namespace)
+        @server = server
+        @connection = connection
+        @namespace = namespace
+      end
+
+      # A default client to be used with this environment.
+      #
+      # @return [Temporalio::Client] A default client.
+      def client
+        @client ||= begin
+          # TODO: Add a workflow interceptor for interpreting assertion error
+          interceptors = [TimeSkippingInterceptor.new(self)]
+          Temporalio::Client.new(connection, namespace, interceptors: interceptors)
+        end
+      end
+
+      # Sleep in this environment.
+      #
+      # This awaits a regular {Kernel.sleep} in regular environments, or manually skips time in
+      # time-skipping environments.
+      #
+      # @param duration [Integer] Amount of time to sleep.
+      def sleep(duration)
+        return Kernel.sleep(duration) unless supports_time_skipping?
+
+        request = Temporalio::Api::TestService::V1::SleepRequest.new(
+          duration: Google::Protobuf::Duration.new(seconds: duration),
+        )
+        connection.test_service.unlock_time_skipping_with_sleep(request)
+
+        nil
+      end
+
+      # Get the current time known to this environment.
+      #
+      # For non-time-skipping environments this is simply the system time. For time-skipping
+      # environments this is whatever time has been skipped to.
+      #
+      # @return [Time]
+      def current_time
+        return Time.now unless supports_time_skipping?
+
+        connection.test_service.get_current_time&.time&.to_time
+      end
+
+      # Whether this environment supports time skipping.
+      #
+      # @return [Boolean]
+      def supports_time_skipping?
+        server.has_test_service?
+      end
+
+      # Shut down this environment.
+      def shutdown
+        server.shutdown
+      end
+
+      # Unlock time skipping.
+      #
+      # This will have no effect in an environment that does not support time-skipping (e.g.
+      # Temporalite).
+      #
+      # @yield A block to be called once time skipping has been unlocked.
+      #
+      # @return [any] The return value of the block.
+      def with_time_skipping
+        return yield unless supports_time_skipping?
+
+        begin
+          # Unlock to start time skipping, lock again to stop it
+          connection.test_service.unlock_time_skipping(
+            Temporalio::Api::TestService::V1::UnlockTimeSkippingRequest.new,
+          )
+
+          yield
+        ensure
+          connection.test_service.lock_time_skipping(
+            Temporalio::Api::TestService::V1::LockTimeSkippingRequest.new,
+          )
+        end
+      end
+
+      private
+
+      attr_reader :server
+    end
+  end
+end