temporalio 0.0.1 → 0.1.0

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

@@ -1,12 +1,12 @@
-require 'temporal/interceptor/client'
-require 'temporal/workflow/query_reject_condition'
+require 'temporalio/interceptor/client'
+require 'temporalio/workflow/query_reject_condition'
 
-module Temporal
+module Temporalio
   class Client
     # Handle for interacting with a workflow.
     #
-    # This is usually created via {Temporal::Client#workflow_handle} or returned
-    # from {Temporal::Client#start_workflow}.
+    # This is usually created via {Temporalio::Client#workflow_handle} or returned
+    # from {Temporalio::Client#start_workflow}.
     class WorkflowHandle
       # @return [String] ID for the workflow.
       attr_reader :id
@@ -14,10 +14,10 @@ module Temporal
       # Run ID used for {#signal} and {#query} calls if present to ensure the query or signal happen
       # on this exact run.
       #
-      # This is only set on handles created via {Temporal::Client#workflow_handle} with a `run_id`
-      # parameter. {Temporal::Client#start_workflow} does not set this value.
+      # This is only set on handles created via {Temporalio::Client#workflow_handle} with a `run_id`
+      # parameter. {Temporalio::Client#start_workflow} does not set this value.
       #
-      # This cannot be mutated. If a different run ID is needed, {Temporal::Client#workflow_handle}
+      # This cannot be mutated. If a different run ID is needed, {Temporalio::Client#workflow_handle}
       # must be used instead.
       #
       # @return [String]
@@ -26,11 +26,11 @@ module Temporal
       # Run ID used for {#result} calls if present to ensure result is for a workflow starting from
       # this run.
       #
-      # When this handle is created via {Temporal::Client#workflow_handle}, this is the same as
-      # `:run_id`. When this handle is created via {Temporal::Client#start_workflow}, this value
+      # When this handle is created via {Temporalio::Client#workflow_handle}, this is the same as
+      # `:run_id`. When this handle is created via {Temporalio::Client#start_workflow}, this value
       # will be the resulting run ID.
       #
-      # This cannot be mutated. If a different run ID is needed, {Temporal::Client#workflow_handle}
+      # This cannot be mutated. If a different run ID is needed, {Temporalio::Client#workflow_handle}
       # must be used instead.
       #
       # @return [String]
@@ -39,12 +39,12 @@ module Temporal
       # Run ID used for {#cancel} and {#terminate} calls if present to ensure the cancel and
       # terminate happen for a workflow ID started with this run ID.
       #
-      # This can be set when using {Temporal::Client#workflow_handle}. When
-      # {Temporal::Client#start_workflow} is called without a start signal, this is set to the
+      # This can be set when using {Temporalio::Client#workflow_handle}. When
+      # {Temporalio::Client#start_workflow} is called without a start signal, this is set to the
       # resulting run.
       #
       # This cannot be mutated. If a different first execution run ID is needed,
-      # {Temporal::Client#workflow_handle} must be used instead.
+      # {Temporalio::Client#workflow_handle} must be used instead.
       #
       # @return [String]
       attr_reader :first_execution_run_id
@@ -60,7 +60,7 @@ module Temporal
       # Wait for result of the workflow.
       #
       # This will use {#result_run_id} if present to base the result on. To use another run ID,
-      # a new handle must be created via {Temporal::Client#workflow_handle}.
+      # a new handle must be created via {Temporalio::Client#workflow_handle}.
       #
       # @param follow_runs [Bool] If true (default), workflow runs will be continually fetched,
       #   until the most recent one is found. If false, the first result is used.
@@ -71,8 +71,8 @@ module Temporal
       #
       # @return [any] Result of the workflow after being converted by the data converter.
       #
-      # @raise [Temporal::Error::WorkflowFailure] Workflow failed, was cancelled, was terminated, or
-      #   timed out. Use the {Temporal::Error::WorkflowFailure#cause} to see the underlying reason.
+      # @raise [Temporalio::Error::WorkflowFailure] Workflow failed, was cancelled, was terminated, or
+      #   timed out. Use the {Temporalio::Error::WorkflowFailure#cause} to see the underlying reason.
       # @raise [StandardError] Other possible failures during result fetching.
       def result(follow_runs: true, rpc_metadata: {}, rpc_timeout: nil)
         client_impl.await_workflow_result(id, result_run_id, follow_runs, rpc_metadata, rpc_timeout)
@@ -81,9 +81,9 @@ module Temporal
       # Get workflow details.
       #
       # This will get details for {#run_id} if present. To use a different run ID, create a new
-      # handle with via {Temporal::Client#workflow_handle}.
+      # handle with via {Temporalio::Client#workflow_handle}.
       #
-      # @note Handles created as a result of {Temporal::Client#start_workflow} will describe the
+      # @note Handles created as a result of {Temporalio::Client#start_workflow} will describe the
       #   latest workflow with the same workflow ID even if it is unrelated to the started workflow.
       #
       # @param rpc_metadata [Hash<String, String>] Headers used on the RPC call.
@@ -91,9 +91,9 @@ module Temporal
       # @param rpc_timeout [Integer] Optional RPC deadline to set for each RPC call. Note, this is
       #   the timeout for each history RPC call not this overall function.
       #
-      # @return [Temporal::Workflow::ExecutionInfo] Workflow details.
+      # @return [Temporalio::Workflow::ExecutionInfo] Workflow details.
       #
-      # @raise [Temporal::Error::RPCError] Workflow details could not be fetched.
+      # @raise [Temporalio::Error::RPCError] Workflow details could not be fetched.
       def describe(rpc_metadata: {}, rpc_timeout: nil)
         input = Interceptor::Client::DescribeWorkflowInput.new(
           id: id,
@@ -109,9 +109,9 @@ module Temporal
       #
       # This will issue a cancellation for {#run_id} if present. This call will make sure to use the
       # run chain starting from {#first_execution_run_id} if present. To create handles with these
-      # values, use {Temporal::Client#workflow_handle}.
+      # values, use {Temporalio::Client#workflow_handle}.
       #
-      # @note Handles created as a result of {Temporal::Client#start_workflow} with a start signal
+      # @note Handles created as a result of {Temporalio::Client#start_workflow} with a start signal
       #   will cancel the latest workflow with the same workflow ID even if it is unrelated to the
       #   started workflow.
       #
@@ -120,7 +120,7 @@ module Temporal
       #   Keys here override client-level RPC metadata keys.
       # @param rpc_timeout [Integer] Optional RPC deadline to set for each RPC call.
       #
-      # @raise [Temporal::Error::RPCError] Workflow could not be cancelled.
+      # @raise [Temporalio::Error::RPCError] Workflow could not be cancelled.
       def cancel(reason = nil, rpc_metadata: {}, rpc_timeout: nil)
         input = Interceptor::Client::CancelWorkflowInput.new(
           id: id,
@@ -137,23 +137,23 @@ module Temporal
       # Query the workflow.
       #
       # This will query for {#run_id} if present. To use a different run ID, create a new handle
-      # with via {Temporal::Client#workflow_handle}.
+      # with via {Temporalio::Client#workflow_handle}.
       #
-      # @note Handles created as a result of {Temporal::Client#start_workflow} will query the latest
+      # @note Handles created as a result of {Temporalio::Client#start_workflow} will query the latest
       #   workflow with the same workflow ID even if it is unrelated to the started workflow.
       #
       # @param query [String, Symbol] Query function or name on the workflow.
       # @param args [any] Arguments to the query.
       # @param reject_condition [Symbol] Condition for rejecting the query. Refer to
-      #   {Temporal::Workflow::QueryRejectCondition} for the list of allowed values.
+      #   {Temporalio::Workflow::QueryRejectCondition} for the list of allowed values.
       # @param rpc_metadata [Hash<String, String>] Headers used on the RPC call.
       #   Keys here override client-level RPC metadata keys.
       # @param rpc_timeout [Integer] Optional RPC deadline to set for each RPC call.
       #
       # @return [any] Result of the query.
       #
-      # @raise [Temporal::Error] A query reject condition was satisfied.
-      # @raise [Temporal::Error::RPCError] Workflow details could not be fetched.
+      # @raise [Temporalio::Error] A query reject condition was satisfied.
+      # @raise [Temporalio::Error::RPCError] Workflow details could not be fetched.
       def query(
         query,
         *args,
@@ -178,9 +178,9 @@ module Temporal
       # Send a signal to the workflow.
       #
       # This will signal for {#run_id} if present. To use a different run ID, create a new handle
-      # with via {Temporal::Client#workflow_handle}.
+      # with via {Temporalio::Client#workflow_handle}.
       #
-      # @note Handles created as a result of {Temporal::Client#start_workflow} will signal the
+      # @note Handles created as a result of {Temporalio::Client#start_workflow} will signal the
       #   latest workflow with the same workflow ID even if it is unrelated to the started workflow.
       #
       # @param signal [String, Symbol] Signal function or name on the workflow.
@@ -189,7 +189,7 @@ module Temporal
       #   Keys here override client-level RPC metadata keys.
       # @param rpc_timeout [Integer] Optional RPC deadline to set for each RPC call.
       #
-      # @return [Temporal::Error::RPCError] Workflow could not be signalled.
+      # @return [Temporalio::Error::RPCError] Workflow could not be signalled.
       def signal(signal, *args, rpc_metadata: {}, rpc_timeout: nil)
         input = Interceptor::Client::SignalWorkflowInput.new(
           id: id,
@@ -208,9 +208,9 @@ module Temporal
       #
       # This will issue a termination for {#run_id} if present. This call will make sure to use the
       # run chain starting from {#first_execution_run_id} if present. To create handles with these
-      # values, use {Temporal::Client#workflow_handle}.
+      # values, use {Temporalio::Client#workflow_handle}.
 
-      # @note Handles created as a result of {Temporal::Client#start_workflow} with a start signal
+      # @note Handles created as a result of {Temporalio::Client#start_workflow} with a start signal
       #   will terminate the latest workflow with the same workflow ID even if it is unrelated to
       #   the started workflow.
       #
@@ -220,7 +220,7 @@ module Temporal
       #   Keys here override client-level RPC metadata keys.
       # @param rpc_timeout [Integer] Optional RPC deadline to set for each RPC call.
       #
-      # @raise [Temporal::Error::RPCError] Workflow could not be terminated.
+      # @raise [Temporalio::Error::RPCError] Workflow could not be terminated.
       def terminate(reason = nil, args = nil, rpc_metadata: {}, rpc_timeout: nil)
         input = Interceptor::Client::TerminateWorkflowInput.new(
           id: id,

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

@@ -1,33 +1,27 @@
 require 'json'
 require 'securerandom'
 require 'socket'
-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'
+require 'temporalio/client/implementation'
+require 'temporalio/client/workflow_handle'
+require 'temporalio/data_converter'
+require 'temporalio/errors'
+require 'temporalio/failure_converter'
+require 'temporalio/payload_converter'
+require 'temporalio/workflow/id_reuse_policy'
 
-module Temporal
+module Temporalio
   class Client
     # @return [String] Namespace used for client calls.
     attr_reader :namespace
 
     # Create a Temporal client from a connection.
     #
-    # @param connection [Temporal::Connection] A connection to the Temporal server.
+    # @param connection [Temporalio::Connection] A connection to the Temporal server.
     # @param namespace [String] Namespace to use for client calls.
-    # @param interceptors [Array<Temporal::Interceptor::Client>] List of interceptors for
+    # @param interceptors [Array<Temporalio::Interceptor::Client>] List of interceptors for
     #   intercepting client calls. Executed in their original order.
-    # @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.
+    # @param data_converter [Temporalio::DataConverter] Data converter to use for all data conversions
+    #   to/from payloads.
     #
     # @see https://docs.temporal.io/concepts/what-is-a-data-converter for more information on
     #   payload converters and codecs.
@@ -35,16 +29,9 @@ module Temporal
       connection,
       namespace,
       interceptors: [],
-      payload_converter: Temporal::PayloadConverter::DEFAULT,
-      payload_codecs: [],
-      failure_converter: Temporal::FailureConverter::DEFAULT
+      data_converter: Temporalio::DataConverter.new
     )
       @namespace = namespace
-      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
 
@@ -59,9 +46,9 @@ module Temporal
     # @param run_timeout [Integer] Timeout of a single workflow run.
     # @param task_timeout [Integer] Timeout of a single workflow task.
     # @param id_reuse_policy [Symbol] How already-existing IDs are treated. Refer to
-    #   {Temporal::Workflow::IDReusePolicy} for the list of allowed values.
-    # @param retry_policy [Temporal::RetryPolicy] Retry policy for the workflow.
-    #   See {Temporal::RetryPolicy}.
+    #   {Temporalio::Workflow::IDReusePolicy} for the list of allowed values.
+    # @param retry_policy [Temporalio::RetryPolicy] Retry policy for the workflow.
+    #   See {Temporalio::RetryPolicy}.
     # @param cron_schedule [String] See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job.
     # @param memo [Hash<String, any>] Memo for the workflow.
     # @param search_attributes [Hash<String, any>] Search attributes for the workflow.
@@ -73,9 +60,9 @@ module Temporal
     #   client-level RPC metadata keys.
     # @param rpc_timeout [Integer] Optional RPC deadline to set for the RPC call.
     #
-    # @return [Temporal::Client::WorkflowHandle] A workflow handle to the started/existing workflow.
+    # @return [Temporalio::Client::WorkflowHandle] A workflow handle to the started/existing workflow.
     #
-    # @raise [Temporal::Error::RPCError] Workflow could not be started.
+    # @raise [Temporalio::Error::RPCError] Workflow could not be started.
     def start_workflow( # rubocop:disable Metrics/ParameterLists
       workflow,
       *args,
@@ -126,7 +113,7 @@ module Temporal
     #   in a chain. Workflows are chained when using continue-as-new, retries (as permitted by the
     #   retry policy) or cron executions.
     #
-    # @return [Temporal::Client::WorkflowHandle] The workflow handle.
+    # @return [Temporalio::Client::WorkflowHandle] The workflow handle.
     def workflow_handle(id, run_id: nil, first_execution_run_id: nil)
       WorkflowHandle.new(
         implementation,

data/lib/temporalio/connection/retry_config.rb

@@ -0,0 +1,44 @@
+module Temporalio
+  class Connection
+    class RetryConfig
+      # Initial backoff interval.
+      # @default 100
+      attr_reader :initial_interval_millis
+
+      # Randomization jitter to add.
+      # @default 0.2
+      attr_reader :randomization_factor
+
+      # Backoff multiplier.
+      # @default 1.5
+      attr_reader :multiplier
+
+      # Maximum backoff interval.
+      # @default 5000
+      attr_reader :max_interval_millis
+
+      # Maximum total time (optional).
+      attr_reader :max_elapsed_time_millis
+
+      # Maximum number of retries.
+      # @default 10
+      attr_reader :max_retries
+
+      def initialize(
+        initial_interval_millis: nil,
+        randomization_factor: nil,
+        multiplier: nil,
+        max_interval_millis: nil,
+        max_elapsed_time_millis: nil,
+        max_retries: nil
+      )
+        @initial_interval_millis = initial_interval_millis || 100
+        @randomization_factor = randomization_factor || 0.2
+        @multiplier = multiplier || 1.5
+        @max_interval_millis = max_interval_millis || 5_000
+        @max_elapsed_time_millis = max_elapsed_time_millis
+        @max_retries = max_retries || 10
+      end
+    end
+  end
+end

data/lib/temporalio/connection/service.rb

@@ -0,0 +1,20 @@
+module Temporalio
+  class Connection
+    # @abstract A superclass for defining services to interact with the Temporal API
+    class Service
+      # @api private
+      def initialize(core_connection, service)
+        @core_connection = core_connection
+        @service = service
+      end
+
+      private
+
+      attr_reader :core_connection, :service
+
+      def call(rpc, bytes, metadata, timeout)
+        core_connection.call(rpc, service, bytes, metadata, timeout)
+      end
+    end
+  end
+end

data/lib/temporalio/connection/test_service.rb

@@ -0,0 +1,92 @@
+require 'temporal/api/testservice/v1/request_response_pb'
+require 'temporalio/connection/service'
+
+module Temporalio
+  class Connection
+    # A class for making TestService RPCs
+    #
+    # This is normally accessed via {Temoralio::Connection#test_service}.
+    class TestService < Service
+      # @api private
+      def initialize(core_connection)
+        super(core_connection, :test_service)
+      end
+
+      # @param request [Temporalio::Api::TestService::V1::LockTimeSkippingRequest]
+      # @param metadata [Hash<String, String>] Headers used on the RPC call.
+      #   Keys here override client-level RPC metadata keys.
+      # @param timeout [Integer] Optional RPC deadline to set for each RPC call.
+      #
+      # @return [Temporalio::Api::TestService::V1::LockTimeSkippingResponse]
+      def lock_time_skipping(request, metadata: {}, timeout: nil)
+        encoded = Temporalio::Api::TestService::V1::LockTimeSkippingRequest.encode(request)
+        response = call(:lock_time_skipping, encoded, metadata, timeout)
+
+        Temporalio::Api::TestService::V1::LockTimeSkippingResponse.decode(response)
+      end
+
+      # @param request [Temporalio::Api::TestService::V1::UnlockTimeSkippingRequest]
+      # @param metadata [Hash<String, String>] Headers used on the RPC call.
+      #   Keys here override client-level RPC metadata keys.
+      # @param timeout [Integer] Optional RPC deadline to set for each RPC call.
+      #
+      # @return [Temporalio::Api::TestService::V1::UnlockTimeSkippingResponse]
+      def unlock_time_skipping(request, metadata: {}, timeout: nil)
+        encoded = Temporalio::Api::TestService::V1::UnlockTimeSkippingRequest.encode(request)
+        response = call(:unlock_time_skipping, encoded, metadata, timeout)
+
+        Temporalio::Api::TestService::V1::UnlockTimeSkippingResponse.decode(response)
+      end
+
+      # @param request [Temporalio::Api::TestService::V1::SleepRequest]
+      # @param metadata [Hash<String, String>] Headers used on the RPC call.
+      #   Keys here override client-level RPC metadata keys.
+      # @param timeout [Integer] Optional RPC deadline to set for each RPC call.
+      #
+      # @return [Temporalio::Api::TestService::V1::SleepResponse]
+      def sleep(request, metadata: {}, timeout: nil)
+        encoded = Temporalio::Api::TestService::V1::SleepRequest.encode(request)
+        response = call(:sleep, encoded, metadata, timeout)
+
+        Temporalio::Api::TestService::V1::SleepResponse.decode(response)
+      end
+
+      # @param request [Temporalio::Api::TestService::V1::SleepUntilRequest]
+      # @param metadata [Hash<String, String>] Headers used on the RPC call.
+      #   Keys here override client-level RPC metadata keys.
+      # @param timeout [Integer] Optional RPC deadline to set for each RPC call.
+      #
+      # @return [Temporalio::Api::TestService::V1::SleepResponse]
+      def sleep_until(request, metadata: {}, timeout: nil)
+        encoded = Temporalio::Api::TestService::V1::SleepUntilRequest.encode(request)
+        response = call(:sleep_until, encoded, metadata, timeout)
+
+        Temporalio::Api::TestService::V1::SleepResponse.decode(response)
+      end
+
+      # @param request [Temporalio::Api::TestService::V1::SleepRequest]
+      # @param metadata [Hash<String, String>] Headers used on the RPC call.
+      #   Keys here override client-level RPC metadata keys.
+      # @param timeout [Integer] Optional RPC deadline to set for each RPC call.
+      #
+      # @return [Temporalio::Api::TestService::V1::SleepResponse]
+      def unlock_time_skipping_with_sleep(request, metadata: {}, timeout: nil)
+        encoded = Temporalio::Api::TestService::V1::SleepRequest.encode(request)
+        response = call(:unlock_time_skipping_with_sleep, encoded, metadata, timeout)
+
+        Temporalio::Api::TestService::V1::SleepResponse.decode(response)
+      end
+
+      # @param metadata [Hash<String, String>] Headers used on the RPC call.
+      #   Keys here override client-level RPC metadata keys.
+      # @param timeout [Integer] Optional RPC deadline to set for each RPC call.
+      #
+      # @return [Temporalio::Api::TestService::V1::GetCurrentTimeResponse]
+      def get_current_time(metadata: {}, timeout: nil)
+        response = call(:get_current_time, '', metadata, timeout)
+
+        Temporalio::Api::TestService::V1::GetCurrentTimeResponse.decode(response)
+      end
+    end
+  end
+end

data/lib/temporalio/connection/tls_options.rb

@@ -0,0 +1,51 @@
+module Temporalio
+  class Connection
+    class TlsOptions
+      # Root CA certificate used by the server. If not set, the server's certificate will be
+      # validated against the operating system's root certificates.
+      #
+      # Leave unset for Temporal Cloud.
+      attr_reader :server_root_ca_cert
+
+      # Client certificate used to authenticate with the server. If set, a corresponding
+      # `client_private_key` must be provided.
+      #
+      # @default do not use client side authentication.
+      attr_reader :client_cert
+
+      # Client private key used to authenticate with the server. Required if `client_cert` is set.
+      attr_reader :client_private_key
+
+      # Overrides the target name used for validation of the server SSL certificate. If not
+      # specified, the server certificate will be checked against the host part of the connection
+      # target address. This _should_ be used for testing only.
+      #
+      # Leave unset for Temporal Cloud.
+      #
+      # @default Validate the server certificate against the host part of the connection target address.
+      attr_reader :server_name_override
+
+      # @param [String?] server_root_ca_cert Root CA certificate used by the server.
+      # @param [String?] client_cert Client certificate used to authenticate with the server.
+      # @param [String?] client_private_key Client private key used to authenticate with the server.
+      # @param [String?] server_name_override Overrides the target name used for validation of the
+      #                  server SSL certificate.
+      # @raise [ArgumentError] if `client_cert` and `client_private_key` are not both set or both unset
+      def initialize(
+        server_root_ca_cert: nil,
+        client_cert: nil,
+        client_private_key: nil,
+        server_name_override: nil
+      )
+        if (client_cert && !client_private_key) || (!client_cert && client_private_key)
+          raise ArgumentError, 'client_cert and client_private_key must be either both set or both unset'
+        end
+
+        @server_root_ca_cert = server_root_ca_cert
+        @client_cert = client_cert
+        @client_private_key = client_private_key
+        @server_name_override = server_name_override
+      end
+    end
+  end
+end