temporalio 0.6.0 → 1.0.0

data/README.md

@@ -17,15 +17,6 @@ Also see:
 
 **NOTE: This README is for the current branch and not necessarily what's released on RubyGems.**
 
-⚠️ UNDER ACTIVE DEVELOPMENT
-
-This SDK is under active development and has not released a stable version yet. APIs may change in incompatible ways
-until the SDK is marked stable.
-
-During this time, we are requesting any/all feedback from early adopters. We welcome all forms of suggestions or
-opinions. Please communicate with us on [Slack](https://t.mp/slack) in the `#ruby-sdk` channel or via email at
-`sdk@temporal.io`.
-
 ---
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -1246,8 +1237,8 @@ when an activity class is referenced in a workflow before it has been explicitly
 > Temporalio::Workflow::Unsafe.illegal_call_tracing_disabled block.
 
 This comes from `bootsnap` via `zeitwork` because it is lazily loading a class/module at workflow runtime. It is not
-good to lazily load code durnig a workflow run because it can be side effecting. Workflows and the classes they
-reference should not be eagerly loaded.
+good to lazily load code during a workflow run because it can be side effecting. Workflows and the classes they
+reference should be eagerly loaded.
 
 To resolve this, either always eagerly load (e.g. `config.eager_load = true`) or explicitly `require` what is used by a
 workflow at the top of the file.

data/ext/Cargo.toml

@@ -10,14 +10,16 @@ publish = false
 crate-type = ["cdylib"]
 
 [dependencies]
+async-trait = "0.1"
 futures = "0.3"
+log = "0.4"
 magnus = "0.7"
 parking_lot = "0.12"
 prost = "0.13"
 rb-sys = "0.9"
 temporal-client = { version = "0.1.0", path = "./sdk-core/client" }
 temporal-sdk-core = { version = "0.1.0", path = "./sdk-core/core", features = ["ephemeral-server"] }
-temporal-sdk-core-api = { version = "0.1.0", path = "./sdk-core/core-api" }
+temporal-sdk-core-api = { version = "0.1.0", path = "./sdk-core/core-api", features = ["envconfig"] }
 temporal-sdk-core-protos = { version = "0.1.0", path = "./sdk-core/sdk-core-protos" }
 tokio = "1.37"
 tokio-stream = "0.1"

data/lib/temporalio/activity/info.rb

@@ -13,6 +13,7 @@ module Temporalio
       :heartbeat_timeout,
       :local?,
       :priority,
+      :retry_policy,
       :raw_heartbeat_details,
       :schedule_to_close_timeout,
       :scheduled_time,
@@ -42,6 +43,10 @@ module Temporalio
     #   @return [Boolean] Whether the activity is a local activity or not.
     # @!attribute priority
     #   @return [Priority] The priority of this activity.
+    # @!attribute retry_policy
+    #   @return [RetryPolicy, nil] Retry policy for the activity. Note that the server may have set a different policy
+    #     than the one provided when scheduling the activity. If the value is None, it means the server didn't send
+    #     information about retry policy (e.g. due to old server version), but it may still be defined server-side.
     # @!attribute raw_heartbeat_details
     #   @return [Array<Converter::RawValue>] Raw details from the last heartbeat of the last attempt. Can use
     #     {heartbeat_details} to get lazily-converted values.

data/lib/temporalio/cancellation.rb

@@ -167,8 +167,8 @@ module Temporalio
       to_return.values
     end
 
-    def canceled_mutex_synchronize(&)
-      Workflow::Unsafe.illegal_call_tracing_disabled { @canceled_mutex.synchronize(&) }
+    def canceled_mutex_synchronize(&block)
+      Workflow::Unsafe.illegal_call_tracing_disabled { @canceled_mutex.synchronize(&block) }
     end
   end
 end

data/lib/temporalio/client/async_activity_handle.rb

@@ -29,6 +29,7 @@ module Temporalio
       # @param details [Array<Object>] Details of the heartbeat.
       # @param detail_hints [Array<Object>, nil] Converter hints for the details.
       # @param rpc_options [RPCOptions, nil] Advanced RPC options.
+      # @raise [Error::AsyncActivityCanceledError] If the activity was canceled, paused, and/or reset.
       def heartbeat(*details, detail_hints: nil, rpc_options: nil)
         @client._impl.heartbeat_async_activity(Interceptor::HeartbeatAsyncActivityInput.new(
                                                  task_token_or_id_reference:,

data/lib/temporalio/env_config.rb

@@ -0,0 +1,343 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'temporalio/internal/bridge'
+
+module Temporalio
+  # Environment and file-based configuration for Temporal clients
+  #
+  # WARNING: Experimental API.
+  module EnvConfig
+    # This module provides utilities to load Temporal client configuration from TOML files
+    # and environment variables.
+
+    # TLS configuration as specified as part of client configuration
+    #
+    # @!attribute [r] disabled
+    #   @return [Boolean, nil] If true, TLS is explicitly disabled; if nil, not specified
+    # @!attribute [r] server_name
+    #   @return [String, nil] SNI override
+    # @!attribute [r] server_root_ca_cert
+    #   @return [Pathname, String, nil] Server CA certificate source
+    # @!attribute [r] client_cert
+    #   @return [Pathname, String, nil] Client certificate source
+    # @!attribute [r] client_private_key
+    #   @return [Pathname, String, nil] Client key source
+    ClientConfigTLS = Data.define(:disabled, :server_name, :server_root_ca_cert, :client_cert, :client_private_key)
+
+    # TLS configuration for Temporal client connections.
+    #
+    # This class provides methods for creating, serializing, and converting
+    # TLS configuration objects used by Temporal clients.
+    class ClientConfigTLS
+      # Create a ClientConfigTLS from a hash
+      # @param hash [Hash, nil] Hash representation
+      # @return [ClientConfigTLS, nil] The TLS configuration or nil if hash is nil/empty
+      def self.from_h(hash)
+        return nil if hash.nil? || hash.empty?
+
+        new(
+          disabled: hash[:disabled],
+          server_name: hash[:server_name],
+          server_root_ca_cert: hash_to_source(hash[:server_ca_cert]),
+          client_cert: hash_to_source(hash[:client_cert]),
+          client_private_key: hash_to_source(hash[:client_key])
+        )
+      end
+
+      # Set default values
+      def initialize(disabled: nil, server_name: nil, server_root_ca_cert: nil, client_cert: nil,
+                     client_private_key: nil)
+        super
+      end
+
+      # Convert to a hash that can be used for TOML serialization
+      # @return [Hash] Dictionary representation
+      def to_h
+        {
+          disabled:,
+          server_name:,
+          server_ca_cert: server_root_ca_cert ? source_to_hash(server_root_ca_cert) : nil,
+          client_cert: client_cert ? source_to_hash(client_cert) : nil,
+          client_key: client_private_key ? source_to_hash(client_private_key) : nil
+        }.compact
+      end
+
+      # Create a TLS configuration for use with connections
+      # @return [Connection::TLSOptions, false] TLS options or false if disabled
+      def to_client_tls_options
+        return false if disabled
+
+        Client::Connection::TLSOptions.new(
+          domain: server_name,
+          server_root_ca_cert: read_source(server_root_ca_cert),
+          client_cert: read_source(client_cert),
+          client_private_key: read_source(client_private_key)
+        )
+      end
+
+      private
+
+      class << self
+        private
+
+        # Convert hash to source object (Pathname or String)
+        def hash_to_source(hash)
+          return nil if hash.nil?
+
+          # Always expect a hash with path or data
+          if hash[:path]
+            Pathname.new(hash[:path])
+          elsif hash[:data]
+            hash[:data]
+          end
+        end
+      end
+
+      def source_to_hash(source)
+        case source
+        when Pathname
+          { path: source.to_s }
+        when String
+          # String is always treated as data content
+          { data: source }
+        when nil
+          nil
+        else
+          raise TypeError, "Source must be Pathname, String, or nil, got #{source.class}"
+        end
+      end
+
+      def read_source(source)
+        case source
+        when Pathname
+          File.read(source.to_s)
+        when String
+          # String is always treated as raw data content
+          source
+        when nil
+          nil
+        else
+          raise TypeError, "Source must be Pathname, String, or nil, got #{source.class}"
+        end
+      end
+    end
+
+    # Represents a client configuration profile.
+    #
+    # This class holds the configuration as loaded from a file or environment.
+    # See #to_client_connect_options to transform the profile to a connect config hash.
+    #
+    # @!attribute [r] address
+    #   @return [String, nil] Client address
+    # @!attribute [r] namespace
+    #   @return [String, nil] Client namespace
+    # @!attribute [r] api_key
+    #   @return [String, nil] Client API key
+    # @!attribute [r] tls
+    #   @return [Boolean, ClientConfigTLS, nil] TLS configuration
+    # @!attribute [r] grpc_meta
+    #   @return [Hash] gRPC metadata
+    ClientConfigProfile = Data.define(:address, :namespace, :api_key, :tls, :grpc_meta)
+
+    # A client configuration profile loaded from environment and files.
+    #
+    # This class represents a complete client configuration profile that can be
+    # loaded from TOML files and environment variables, and converted to client
+    # connection options.
+    class ClientConfigProfile
+      # Create a ClientConfigProfile from a hash
+      # @param hash [Hash] Hash representation
+      # @return [ClientConfigProfile] The client profile
+      def self.from_h(hash)
+        new(
+          address: hash[:address],
+          namespace: hash[:namespace],
+          api_key: hash[:api_key],
+          tls: ClientConfigTLS.from_h(hash[:tls]),
+          grpc_meta: hash[:grpc_meta] || {}
+        )
+      end
+
+      # Load a single client profile from given sources, applying env overrides.
+      #
+      # @param profile [String, nil] Profile to load from the config
+      # @param config_source [Pathname, String, nil] Configuration source -
+      #   Pathname for file path, String for TOML content
+      # @param disable_file [Boolean] If true, file loading is disabled
+      # @param disable_env [Boolean] If true, environment variable loading and overriding is disabled
+      # @param config_file_strict [Boolean] If true, will error on unrecognized keys
+      # @param override_env_vars [Hash, nil] Environment variables to use for loading and overrides
+      # @return [ClientConfigProfile] The client configuration profile
+      def self.load(
+        profile: nil,
+        config_source: nil,
+        disable_file: false,
+        disable_env: false,
+        config_file_strict: false,
+        override_env_vars: nil
+      )
+        path, data = EnvConfig._source_to_path_and_data(config_source)
+
+        raw_profile = Internal::Bridge::EnvConfig.load_client_connect_config(
+          profile,
+          path,
+          data,
+          disable_file,
+          disable_env,
+          config_file_strict,
+          override_env_vars || {}
+        )
+
+        from_h(raw_profile)
+      end
+
+      # Create a ClientConfigProfile instance with defaults
+      def initialize(address: nil, namespace: nil, api_key: nil, tls: nil, grpc_meta: {})
+        super
+      end
+
+      # Convert to a hash that can be used for TOML serialization
+      # @return [Hash] Dictionary representation
+      def to_h
+        {
+          address: address,
+          namespace: namespace,
+          api_key: api_key,
+          tls: tls&.to_h&.then { |tls_hash| tls_hash.empty? ? nil : tls_hash }, # steep:ignore
+          grpc_meta: grpc_meta && grpc_meta.empty? ? nil : grpc_meta
+        }.compact
+      end
+
+      # Create a client connect config from this profile
+      # @return [Array] Tuple of [positional_args, keyword_args] that can be splatted to Client.connect
+      def to_client_connect_options
+        positional_args = [address, namespace].compact
+        tls_value = false
+        if tls
+          tls_value = tls.to_client_tls_options
+        elsif api_key
+          tls_value = true
+        end
+
+        keyword_args = {
+          api_key: api_key,
+          rpc_metadata: (grpc_meta if grpc_meta && !grpc_meta.empty?),
+          tls: tls_value
+        }.compact
+
+        [positional_args, keyword_args]
+      end
+    end
+
+    # Client configuration loaded from TOML and environment variables.
+    #
+    # This contains a mapping of profile names to client profiles.
+    #
+    # @!attribute [r] profiles
+    #   @return [Hash<String, ClientConfigProfile>] Map of profile name to its corresponding ClientConfigProfile
+    ClientConfig = Data.define(:profiles)
+
+    # Container for multiple client configuration profiles.
+    #
+    # This class holds a collection of named client profiles loaded from
+    # configuration sources and provides methods for profile management
+    # and client connection configuration.
+    class ClientConfig
+      # Create a ClientConfig from a hash
+      # @param hash [Hash] Hash representation
+      # @return [ClientConfig] The client configuration
+      def self.from_h(hash)
+        profiles = hash.transform_values do |profile_hash|
+          ClientConfigProfile.from_h(profile_hash)
+        end
+        new(profiles: profiles)
+      end
+
+      # Load all client profiles from given sources.
+      #
+      # This does not apply environment variable overrides to the profiles, it
+      # only uses an environment variable to find the default config file path
+      # (TEMPORAL_CONFIG_FILE).
+      #
+      # @param config_source [Pathname, String, nil] Configuration source
+      # @param config_file_strict [Boolean] If true, will error on unrecognized keys
+      # @param override_env_vars [Hash, nil] Environment variables to use
+      # @return [ClientConfig] The client configuration
+      def self.load(
+        config_source: nil,
+        config_file_strict: false,
+        override_env_vars: nil
+      )
+        path, data = EnvConfig._source_to_path_and_data(config_source)
+
+        loaded_profiles = Internal::Bridge::EnvConfig.load_client_config(
+          path,
+          data,
+          config_file_strict,
+          override_env_vars || {}
+        )
+
+        from_h(loaded_profiles)
+      end
+
+      # Load a single client profile and convert to connect config
+      #
+      # This is a convenience function that combines loading a profile and
+      # converting it to a connect config hash.
+      #
+      # @param profile [String, nil] The profile to load from the config
+      # @param config_source [Pathname, String, nil] Configuration source
+      # @param disable_file [Boolean] If true, file loading is disabled
+      # @param disable_env [Boolean] If true, environment variable loading and overriding is disabled
+      # @param config_file_strict [Boolean] If true, will error on unrecognized keys
+      # @param override_env_vars [Hash, nil] Environment variables to use for loading and overrides
+      # @return [Array] Tuple of [positional_args, keyword_args] that can be splatted to Client.connect
+      def self.load_client_connect_options(
+        profile: nil,
+        config_source: nil,
+        disable_file: false,
+        disable_env: false,
+        config_file_strict: false,
+        override_env_vars: nil
+      )
+        prof = ClientConfigProfile.load(
+          profile: profile,
+          config_source: config_source,
+          disable_file: disable_file,
+          disable_env: disable_env,
+          config_file_strict: config_file_strict,
+          override_env_vars: override_env_vars
+        )
+        prof.to_client_connect_options
+      end
+
+      # Create a ClientConfig instance with defaults
+      def initialize(profiles: {})
+        super
+      end
+
+      # Convert to a hash that can be used for TOML serialization
+      # @return [Hash] Dictionary representation
+      def to_h
+        profiles.transform_values(&:to_h)
+      end
+    end
+
+    # @param source [Pathname, String, nil] Configuration source
+    # @return [Array<String?, String?>] Tuple of [path, data]
+    # @!visibility private
+    def self._source_to_path_and_data(source)
+      case source
+      when Pathname
+        [source.to_s, nil]
+      when String
+        [nil, source]
+      when nil
+        [nil, nil]
+      else
+        raise TypeError, "Must be Pathname, String, or nil, got #{source.class}"
+      end
+    end
+  end
+end

data/lib/temporalio/error.rb

@@ -97,9 +97,13 @@ module Temporalio
 
     # Error that occurs when an async activity handle tries to heartbeat and the activity is marked as canceled.
     class AsyncActivityCanceledError < Error
+      # @return [Activity::CancellationDetails]
+      attr_reader :details
+
       # @!visibility private
-      def initialize
+      def initialize(details)
         super('Activity canceled')
+        @details = details
       end
     end
 

data/lib/temporalio/internal/bridge/worker.rb

@@ -40,6 +40,7 @@ module Temporalio
         TunerSlotSupplierOptions = Struct.new(
           :fixed_size,
           :resource_based,
+          :custom,
           keyword_init: true
         )
 
@@ -103,6 +104,55 @@ module Temporalio
           # TODO(cretz): Log error on this somehow?
           async_complete_activity_task(proto.to_proto, queue)
         end
+
+        class CustomSlotSupplier
+          def initialize(slot_supplier:, thread_pool:)
+            @slot_supplier = slot_supplier
+            @thread_pool = thread_pool
+          end
+
+          def reserve_slot(context, cancellation, &block)
+            run_user_code do
+              @slot_supplier.reserve_slot(context, cancellation) { |v| block.call(v) }
+            rescue Exception => e # rubocop:disable Lint/RescueException
+              block.call(e)
+            end
+          end
+
+          def try_reserve_slot(context, &block)
+            run_user_code do
+              block.call(@slot_supplier.try_reserve_slot(context))
+            rescue Exception => e # rubocop:disable Lint/RescueException
+              block.call(e)
+            end
+          end
+
+          def mark_slot_used(context, &block)
+            run_user_code do
+              block.call(@slot_supplier.mark_slot_used(context))
+            rescue Exception => e # rubocop:disable Lint/RescueException
+              block.call(e)
+            end
+          end
+
+          def release_slot(context, &block)
+            run_user_code do
+              block.call(@slot_supplier.release_slot(context))
+            rescue Exception => e # rubocop:disable Lint/RescueException
+              block.call(e)
+            end
+          end
+
+          private
+
+          def run_user_code(&)
+            if @thread_pool
+              @thread_pool.execute(&)
+            else
+              yield
+            end
+          end
+        end
       end
     end
   end

data/lib/temporalio/internal/client/implementation.rb

@@ -2,6 +2,7 @@
 
 require 'google/protobuf/well_known_types'
 require 'securerandom'
+require 'temporalio/activity'
 require 'temporalio/api'
 require 'temporalio/client/activity_id_reference'
 require 'temporalio/client/async_activity_handle'
@@ -829,9 +830,13 @@ module Temporalio
                      rpc_options: Implementation.with_default_rpc_options(input.rpc_options)
                    )
                  end
-          raise Error::AsyncActivityCanceledError if resp.cancel_requested
+          return unless resp.cancel_requested || resp.activity_paused || resp.activity_reset
 
-          nil
+          raise Error::AsyncActivityCanceledError, Activity::CancellationDetails.new(
+            cancel_requested: resp.cancel_requested,
+            paused: resp.activity_paused,
+            reset: resp.activity_reset
+          )
         end
 
         def complete_async_activity(input)

data/lib/temporalio/internal/worker/activity_worker.rb

@@ -185,6 +185,7 @@ module Temporalio
               payloads = codec.decode(payloads) if codec
               payloads.map { |p| Temporalio::Converters::RawValue.new(p) }
             end,
+            retry_policy: (RetryPolicy._from_proto(start.retry_policy) if start.retry_policy),
             schedule_to_close_timeout: Internal::ProtoUtils.duration_to_seconds(start.schedule_to_close_timeout),
             scheduled_time: Internal::ProtoUtils.timestamp_to_time(start.scheduled_time) || raise, # Never nil
             start_to_close_timeout: Internal::ProtoUtils.duration_to_seconds(start.start_to_close_timeout),

data/lib/temporalio/internal/worker/workflow_instance/context.rb

@@ -130,6 +130,7 @@ module Temporalio
           def execute_local_activity(
             activity,
             *args,
+            summary:,
             schedule_to_close_timeout:,
             schedule_to_start_timeout:,
             start_to_close_timeout:,
@@ -157,6 +158,7 @@ module Temporalio
               Temporalio::Worker::Interceptor::Workflow::ExecuteLocalActivityInput.new(
                 activity:,
                 args:,
+                summary:,
                 schedule_to_close_timeout:,
                 schedule_to_start_timeout:,
                 start_to_close_timeout:,

data/lib/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rb

@@ -84,7 +84,7 @@ module Temporalio
                 when :all
                   ''
                 when Temporalio::Worker::IllegalWorkflowCallValidator
-                  disable do
+                  disable_temporarily do
                     vals.block.call(Temporalio::Worker::IllegalWorkflowCallValidator::CallInfo.new(
                                       class_name:, method_name: tp.callee_id, trace_point: tp
                                     ))
@@ -98,7 +98,7 @@ module Temporalio
                   when true
                     ''
                   when Temporalio::Worker::IllegalWorkflowCallValidator
-                    disable do
+                    disable_temporarily do
                       per_method.block.call(Temporalio::Worker::IllegalWorkflowCallValidator::CallInfo.new(
                                               class_name:, method_name: tp.callee_id, trace_point: tp
                                             ))
@@ -118,8 +118,11 @@ module Temporalio
           end
 
           def enable(&block)
-            # We've seen leaking issues in Ruby 3.2 where the TracePoint inadvertently remains enabled even for threads
-            # that it was not started on. So we will check the thread ourselves.
+            # This is not reentrant and not expected to be called as such. We've seen leaking issues in Ruby 3.2 where
+            # the TracePoint inadvertently remains enabled even for threads that it was not started on. So we will check
+            # the thread ourselves. We also use the "enabled thread" concept for disabling checks too, see
+            # disable_temporarily for more details.
+
             @enabled_thread = Thread.current
             @tracepoint.enable do
               block.call
@@ -128,13 +131,17 @@ module Temporalio
             end
           end
 
-          def disable(&block)
+          def disable_temporarily(&)
+            # An earlier version of this used @tracepoint.disable, but in some versions of Ruby, the observed behavior
+            # is confusingly not reentrant or at least not predictable. Therefore, instead of calling
+            # @tracepoint.disable, we are just unsetting the enabled thread. This means the tracer is still running, but
+            # no checks are performed. This is effectively a no-op if tracing was never enabled.
+
             previous_thread = @enabled_thread
-            @tracepoint.disable do
-              block.call
-            ensure
-              @enabled_thread = previous_thread
-            end
+            @enabled_thread = nil
+            yield
+          ensure
+            @enabled_thread = previous_thread
           end
         end
       end

data/lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb

@@ -114,14 +114,15 @@ module Temporalio
                     local_retry_threshold: ProtoUtils.seconds_to_duration(input.local_retry_threshold),
                     attempt: do_backoff&.attempt || 0,
                     original_schedule_time: do_backoff&.original_schedule_time
-                  )
+                  ),
+                  user_metadata: ProtoUtils.to_user_metadata(input.summary, nil, @instance.payload_converter)
                 )
               )
               seq
             end
           end
 
-          def execute_activity_with_local_backoffs(local:, cancellation:, result_hint:, &)
+          def execute_activity_with_local_backoffs(local:, cancellation:, result_hint:, &block)
             # We do not even want to schedule if the cancellation is already cancelled. We choose to use canceled
             # failure instead of wrapping in activity failure which is similar to what other SDKs do, with the accepted
             # tradeoff that it makes rescue more difficult (hence the presence of Error.canceled? helper).
@@ -130,7 +131,7 @@ module Temporalio
             # This has to be done in a loop for local activity backoff
             last_local_backoff = nil
             loop do
-              result = execute_activity_once(local:, cancellation:, last_local_backoff:, result_hint:, &)
+              result = execute_activity_once(local:, cancellation:, last_local_backoff:, result_hint:, &block)
               return result unless result.is_a?(Bridge::Api::ActivityResult::DoBackoff)
 
               # @type var result: untyped
@@ -142,9 +143,9 @@ module Temporalio
           end
 
           # If this doesn't raise, it returns success | DoBackoff
-          def execute_activity_once(local:, cancellation:, last_local_backoff:, result_hint:, &)
+          def execute_activity_once(local:, cancellation:, last_local_backoff:, result_hint:, &block)
             # Add to pending activities (removed by the resolver)
-            seq = yield last_local_backoff
+            seq = block.call(last_local_backoff)
             @instance.pending_activities[seq] = Fiber.current
 
             # Add cancellation hook