clara-temporalio 0.4.3-x86_64-linux

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'temporalio/workflow'
+
+module Temporalio
+  module Internal
+    module Worker
+      class WorkflowInstance
+        # Class that installs {::TracePoint} to disallow illegal calls.
+        class IllegalCallTracer
+          def self.frozen_validated_illegal_calls(illegal_calls)
+            illegal_calls.to_h do |key, val|
+              raise TypeError, 'Invalid illegal call map, top-level key must be a String' unless key.is_a?(String)
+
+              # @type var fixed_val: :all | Hash[Symbol, bool]
+              fixed_val = case val
+                          when Array
+                            val.to_h do |sub_val|
+                              unless sub_val.is_a?(Symbol)
+                                raise TypeError,
+                                      'Invalid illegal call map, each value must be a Symbol'
+                              end
+
+                              [sub_val, true]
+                            end.freeze
+                          when :all
+                            :all
+                          else
+                            raise TypeError, 'Invalid illegal call map, top-level value must be an Array or :all'
+                          end
+
+              [key.frozen? ? key : key.dup.freeze, fixed_val]
+            end.freeze
+          end
+
+          # Illegal calls are Hash[String, :all | Hash[Symbol, Bool]]
+          def initialize(illegal_calls)
+            @tracepoint = TracePoint.new(:call, :c_call) do |tp|
+              # Manual check for proper thread since we have seen issues in Ruby 3.2 where it leaks
+              next unless Thread.current == @enabled_thread
+
+              cls = tp.defined_class
+              next unless cls.is_a?(Module)
+
+              # Extract the class name from the defined class. This is more difficult than it seems because you have to
+              # resolve the attached object of the singleton class. But in older Ruby (at least <= 3.1), the singleton
+              # class of things like `Date` does not have `attached_object` so you have to fall back in these rare cases
+              # to parsing the string output. Reaching the string parsing component is rare, so this should not have
+              # significant performance impact.
+              cls_name = if cls.singleton_class?
+                           if cls.respond_to?(:attached_object)
+                             cls = cls.attached_object # steep:ignore
+                             next unless cls.is_a?(Module)
+
+                             cls.name.to_s
+                           else
+                             cls.to_s.delete_prefix('#<Class:').delete_suffix('>')
+                           end
+                         else
+                           cls.name.to_s
+                         end
+
+              # Check if the call is considered illegal
+              vals = illegal_calls[cls_name]
+              if vals == :all || vals&.[](tp.callee_id) # steep:ignore
+                raise Workflow::NondeterminismError,
+                      "Cannot access #{cls_name} #{tp.callee_id} from inside a " \
+                      'workflow. If this is known to be safe, the code can be run in ' \
+                      'a Temporalio::Workflow::Unsafe.illegal_call_tracing_disabled block.'
+              end
+            end
+          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.
+            @enabled_thread = Thread.current
+            @tracepoint.enable do
+              block.call
+            ensure
+              @enabled_thread = nil
+            end
+          end
+
+          def disable(&block)
+            previous_thread = @enabled_thread
+            @tracepoint.disable do
+              block.call
+            ensure
+              @enabled_thread = previous_thread
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'temporalio/internal/worker/workflow_instance'
+require 'temporalio/worker/interceptor'
+require 'temporalio/workflow'
+
+module Temporalio
+  module Internal
+    module Worker
+      class WorkflowInstance
+        # Root implementation of the inbound interceptor.
+        class InboundImplementation < Temporalio::Worker::Interceptor::Workflow::Inbound
+          def initialize(instance)
+            super(nil) # steep:ignore
+            @instance = instance
+          end
+
+          def init(outbound)
+            @instance.context._outbound = outbound
+          end
+
+          def execute(input)
+            @instance.instance.execute(*input.args)
+          end
+
+          def handle_signal(input)
+            invoke_handler(input.signal, input)
+          end
+
+          def handle_query(input)
+            invoke_handler(input.query, input)
+          end
+
+          def validate_update(input)
+            invoke_handler(input.update, input, to_invoke: input.definition.validator_to_invoke)
+          end
+
+          def handle_update(input)
+            invoke_handler(input.update, input)
+          end
+
+          private
+
+          def invoke_handler(name, input, to_invoke: input.definition.to_invoke)
+            args = input.args
+            # Add name as first param if dynamic
+            args = [name] + args if input.definition.name.nil?
+            # Assume symbol or proc
+            case to_invoke
+            when Symbol
+              @instance.instance.send(to_invoke, *args)
+            when Proc
+              to_invoke.call(*args)
+            else
+              raise "Unrecognized invocation type #{to_invoke.class}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,404 @@
+# frozen_string_literal: true
+
+require 'temporalio/activity/definition'
+require 'temporalio/cancellation'
+require 'temporalio/error'
+require 'temporalio/internal/bridge/api'
+require 'temporalio/internal/proto_utils'
+require 'temporalio/internal/worker/workflow_instance'
+require 'temporalio/worker/interceptor'
+require 'temporalio/workflow'
+require 'temporalio/workflow/child_workflow_handle'
+
+module Temporalio
+  module Internal
+    module Worker
+      class WorkflowInstance
+        # Root implementation of the outbound interceptor.
+        class OutboundImplementation < Temporalio::Worker::Interceptor::Workflow::Outbound
+          def initialize(instance)
+            super(nil) # steep:ignore
+            @instance = instance
+            @activity_counter = 0
+            @timer_counter = 0
+            @child_counter = 0
+            @external_signal_counter = 0
+            @external_cancel_counter = 0
+          end
+
+          def cancel_external_workflow(input)
+            # Add command
+            seq = (@external_cancel_counter += 1)
+            cmd = Bridge::Api::WorkflowCommands::RequestCancelExternalWorkflowExecution.new(
+              seq:,
+              workflow_execution: Bridge::Api::Common::NamespacedWorkflowExecution.new(
+                namespace: @instance.info.namespace,
+                workflow_id: input.id,
+                run_id: input.run_id
+              )
+            )
+            @instance.add_command(
+              Bridge::Api::WorkflowCommands::WorkflowCommand.new(request_cancel_external_workflow_execution: cmd)
+            )
+            @instance.pending_external_cancels[seq] = Fiber.current
+
+            # Wait
+            resolution = Fiber.yield
+
+            # Raise if resolution has failure
+            return unless resolution.failure
+
+            raise @instance.failure_converter.from_failure(resolution.failure, @instance.payload_converter)
+          end
+
+          def execute_activity(input)
+            if input.schedule_to_close_timeout.nil? && input.start_to_close_timeout.nil?
+              raise ArgumentError, 'Activity must have schedule_to_close_timeout or start_to_close_timeout'
+            end
+
+            execute_activity_with_local_backoffs(local: false, cancellation: input.cancellation) do
+              seq = (@activity_counter += 1)
+              @instance.add_command(
+                Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                  schedule_activity: Bridge::Api::WorkflowCommands::ScheduleActivity.new(
+                    seq:,
+                    activity_id: input.activity_id || seq.to_s,
+                    activity_type: input.activity,
+                    task_queue: input.task_queue,
+                    headers: ProtoUtils.headers_to_proto_hash(input.headers, @instance.payload_converter),
+                    arguments: ProtoUtils.convert_to_payload_array(@instance.payload_converter, input.args),
+                    schedule_to_close_timeout: ProtoUtils.seconds_to_duration(input.schedule_to_close_timeout),
+                    schedule_to_start_timeout: ProtoUtils.seconds_to_duration(input.schedule_to_start_timeout),
+                    start_to_close_timeout: ProtoUtils.seconds_to_duration(input.start_to_close_timeout),
+                    heartbeat_timeout: ProtoUtils.seconds_to_duration(input.heartbeat_timeout),
+                    retry_policy: input.retry_policy&._to_proto,
+                    cancellation_type: input.cancellation_type,
+                    do_not_eagerly_execute: input.disable_eager_execution,
+                    priority: input.priority._to_proto
+                  ),
+                  user_metadata: ProtoUtils.to_user_metadata(input.summary, nil, @instance.payload_converter)
+                )
+              )
+              seq
+            end
+          end
+
+          def execute_local_activity(input)
+            if input.schedule_to_close_timeout.nil? && input.start_to_close_timeout.nil?
+              raise ArgumentError, 'Activity must have schedule_to_close_timeout or start_to_close_timeout'
+            end
+
+            @instance.assert_valid_local_activity.call(input.activity)
+
+            execute_activity_with_local_backoffs(local: true, cancellation: input.cancellation) do |do_backoff|
+              seq = (@activity_counter += 1)
+              @instance.add_command(
+                Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                  schedule_local_activity: Bridge::Api::WorkflowCommands::ScheduleLocalActivity.new(
+                    seq:,
+                    activity_id: input.activity_id || seq.to_s,
+                    activity_type: input.activity,
+                    headers: ProtoUtils.headers_to_proto_hash(input.headers, @instance.payload_converter),
+                    arguments: ProtoUtils.convert_to_payload_array(@instance.payload_converter, input.args),
+                    schedule_to_close_timeout: ProtoUtils.seconds_to_duration(input.schedule_to_close_timeout),
+                    schedule_to_start_timeout: ProtoUtils.seconds_to_duration(input.schedule_to_start_timeout),
+                    start_to_close_timeout: ProtoUtils.seconds_to_duration(input.start_to_close_timeout),
+                    retry_policy: input.retry_policy&._to_proto,
+                    cancellation_type: input.cancellation_type,
+                    local_retry_threshold: ProtoUtils.seconds_to_duration(input.local_retry_threshold),
+                    attempt: do_backoff&.attempt || 0,
+                    original_schedule_time: do_backoff&.original_schedule_time
+                  )
+                )
+              )
+              seq
+            end
+          end
+
+          def execute_activity_with_local_backoffs(local:, cancellation:, &)
+            # 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).
+            raise Error::CanceledError, 'Activity canceled before scheduled' if cancellation.canceled?
+
+            # 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:, &)
+              return result unless result.is_a?(Bridge::Api::ActivityResult::DoBackoff)
+
+              # @type var result: untyped
+              last_local_backoff = result
+              # Have to sleep the amount of the backoff, which can be canceled with the same cancellation
+              # TODO(cretz): What should this cancellation raise?
+              Workflow.sleep(ProtoUtils.duration_to_seconds(result.backoff_duration), cancellation:)
+            end
+          end
+
+          # If this doesn't raise, it returns success | DoBackoff
+          def execute_activity_once(local:, cancellation:, last_local_backoff:, &)
+            # Add to pending activities (removed by the resolver)
+            seq = yield last_local_backoff
+            @instance.pending_activities[seq] = Fiber.current
+
+            # Add cancellation hook
+            cancel_callback_key = cancellation.add_cancel_callback do
+              # Only if the activity is present still
+              if @instance.pending_activities.include?(seq)
+                if local
+                  @instance.add_command(
+                    Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                      request_cancel_local_activity: Bridge::Api::WorkflowCommands::RequestCancelLocalActivity.new(seq:)
+                    )
+                  )
+                else
+                  @instance.add_command(
+                    Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                      request_cancel_activity: Bridge::Api::WorkflowCommands::RequestCancelActivity.new(seq:)
+                    )
+                  )
+                end
+              end
+            end
+
+            # Wait
+            resolution = Fiber.yield
+
+            # Remove cancellation callback
+            cancellation.remove_cancel_callback(cancel_callback_key)
+
+            case resolution.status
+            when :completed
+              @instance.payload_converter.from_payload(resolution.completed.result)
+            when :failed
+              raise @instance.failure_converter.from_failure(resolution.failed.failure, @instance.payload_converter)
+            when :cancelled
+              raise @instance.failure_converter.from_failure(resolution.cancelled.failure, @instance.payload_converter)
+            when :backoff
+              resolution.backoff
+            else
+              raise "Unrecognized resolution status: #{resolution.status}"
+            end
+          end
+
+          def initialize_continue_as_new_error(input)
+            # Do nothing
+          end
+
+          def signal_child_workflow(input)
+            _signal_external_workflow(
+              id: input.id,
+              run_id: nil,
+              child: true,
+              signal: input.signal,
+              args: input.args,
+              cancellation: input.cancellation,
+              headers: input.headers
+            )
+          end
+
+          def signal_external_workflow(input)
+            _signal_external_workflow(
+              id: input.id,
+              run_id: input.run_id,
+              child: false,
+              signal: input.signal,
+              args: input.args,
+              cancellation: input.cancellation,
+              headers: input.headers
+            )
+          end
+
+          def _signal_external_workflow(id:, run_id:, child:, signal:, args:, cancellation:, headers:)
+            raise Error::CanceledError, 'Signal canceled before scheduled' if cancellation.canceled?
+
+            # Add command
+            seq = (@external_signal_counter += 1)
+            cmd = Bridge::Api::WorkflowCommands::SignalExternalWorkflowExecution.new(
+              seq:,
+              signal_name: signal,
+              args: ProtoUtils.convert_to_payload_array(@instance.payload_converter, args),
+              headers: ProtoUtils.headers_to_proto_hash(headers, @instance.payload_converter)
+            )
+            if child
+              cmd.child_workflow_id = id
+            else
+              cmd.workflow_execution = Bridge::Api::Common::NamespacedWorkflowExecution.new(
+                namespace: @instance.info.namespace,
+                workflow_id: id,
+                run_id:
+              )
+            end
+            @instance.add_command(
+              Bridge::Api::WorkflowCommands::WorkflowCommand.new(signal_external_workflow_execution: cmd)
+            )
+            @instance.pending_external_signals[seq] = Fiber.current
+
+            # Add a cancellation callback
+            cancel_callback_key = cancellation.add_cancel_callback do
+              # Add the command but do not raise, we will let resolution do that
+              @instance.add_command(
+                Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                  cancel_signal_workflow: Bridge::Api::WorkflowCommands::CancelSignalWorkflow.new(seq:)
+                )
+              )
+            end
+
+            # Wait
+            resolution = Fiber.yield
+
+            # Remove cancellation callback
+            cancellation.remove_cancel_callback(cancel_callback_key)
+
+            # Raise if resolution has failure
+            return unless resolution.failure
+
+            raise @instance.failure_converter.from_failure(resolution.failure, @instance.payload_converter)
+          end
+
+          def sleep(input)
+            # If already cancelled, raise as such
+            if input.cancellation.canceled?
+              raise Error::CanceledError,
+                    input.cancellation.canceled_reason || 'Timer canceled before started'
+            end
+
+            # Disallow negative durations
+            raise ArgumentError, 'Sleep duration cannot be less than 0' if input.duration&.negative?
+
+            # If the duration is infinite, just wait for cancellation
+            if input.duration.nil?
+              input.cancellation.wait
+              raise Error::CanceledError, input.cancellation.canceled_reason || 'Timer canceled'
+            end
+
+            # If duration is zero, we make it one millisecond. It was decided a 0 duration still makes a timer to ensure
+            # determinism if a timer's duration is altered from non-zero to zero or vice versa.
+            duration = input.duration
+            duration = 0.001 if duration.zero?
+
+            # Add command
+            seq = (@timer_counter += 1)
+            @instance.add_command(
+              Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                start_timer: Bridge::Api::WorkflowCommands::StartTimer.new(
+                  seq:,
+                  start_to_fire_timeout: ProtoUtils.seconds_to_duration(duration)
+                ),
+                user_metadata: ProtoUtils.to_user_metadata(input.summary, nil, @instance.payload_converter)
+              )
+            )
+            @instance.pending_timers[seq] = Fiber.current
+
+            # Add a cancellation callback
+            cancel_callback_key = input.cancellation.add_cancel_callback do
+              # Only if the timer is still present
+              fiber = @instance.pending_timers.delete(seq)
+              if fiber
+                # Add the command for cancel then raise
+                @instance.add_command(
+                  Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                    cancel_timer: Bridge::Api::WorkflowCommands::CancelTimer.new(seq:)
+                  )
+                )
+                if fiber.alive?
+                  fiber.raise(Error::CanceledError.new(input.cancellation.canceled_reason || 'Timer canceled'))
+                end
+              end
+            end
+
+            # Wait
+            Fiber.yield
+
+            # Remove cancellation callback (only needed on success)
+            input.cancellation.remove_cancel_callback(cancel_callback_key)
+          end
+
+          def start_child_workflow(input)
+            raise Error::CanceledError, 'Child canceled before scheduled' if input.cancellation.canceled?
+
+            # Add the command
+            seq = (@child_counter += 1)
+            @instance.add_command(
+              Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                start_child_workflow_execution: Bridge::Api::WorkflowCommands::StartChildWorkflowExecution.new(
+                  seq:,
+                  namespace: @instance.info.namespace,
+                  workflow_id: input.id,
+                  workflow_type: input.workflow,
+                  task_queue: input.task_queue,
+                  input: ProtoUtils.convert_to_payload_array(@instance.payload_converter, input.args),
+                  workflow_execution_timeout: ProtoUtils.seconds_to_duration(input.execution_timeout),
+                  workflow_run_timeout: ProtoUtils.seconds_to_duration(input.run_timeout),
+                  workflow_task_timeout: ProtoUtils.seconds_to_duration(input.task_timeout),
+                  parent_close_policy: input.parent_close_policy,
+                  workflow_id_reuse_policy: input.id_reuse_policy,
+                  retry_policy: input.retry_policy&._to_proto,
+                  cron_schedule: input.cron_schedule,
+                  headers: ProtoUtils.headers_to_proto_hash(input.headers, @instance.payload_converter),
+                  memo: ProtoUtils.memo_to_proto_hash(input.memo, @instance.payload_converter),
+                  search_attributes: input.search_attributes&._to_proto_hash,
+                  cancellation_type: input.cancellation_type,
+                  priority: input.priority._to_proto
+                ),
+                user_metadata: ProtoUtils.to_user_metadata(
+                  input.static_summary, input.static_details, @instance.payload_converter
+                )
+              )
+            )
+
+            # Set as pending start and register cancel callback
+            @instance.pending_child_workflow_starts[seq] = Fiber.current
+            cancel_callback_key = input.cancellation.add_cancel_callback do
+              # Send cancel if in start or pending
+              if @instance.pending_child_workflow_starts.include?(seq) ||
+                 @instance.pending_child_workflows.include?(seq)
+                @instance.add_command(
+                  Bridge::Api::WorkflowCommands::WorkflowCommand.new(
+                    cancel_child_workflow_execution: Bridge::Api::WorkflowCommands::CancelChildWorkflowExecution.new(
+                      child_workflow_seq: seq
+                    )
+                  )
+                )
+              end
+            end
+
+            # Wait for start
+            resolution = Fiber.yield
+
+            case resolution.status
+            when :succeeded
+              # Create handle, passing along the cancel callback key, and set it as pending
+              handle = ChildWorkflowHandle.new(
+                id: input.id,
+                first_execution_run_id: resolution.succeeded.run_id,
+                instance: @instance,
+                cancellation: input.cancellation,
+                cancel_callback_key:
+              )
+              @instance.pending_child_workflows[seq] = handle
+              handle
+            when :failed
+              # Remove cancel callback and handle failure
+              input.cancellation.remove_cancel_callback(cancel_callback_key)
+              if resolution.failed.cause == :START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS
+                raise Error::WorkflowAlreadyStartedError.new(
+                  workflow_id: resolution.failed.workflow_id,
+                  workflow_type: resolution.failed.workflow_type,
+                  run_id: nil
+                )
+              end
+              raise "Unknown child start fail cause: #{resolution.failed.cause}"
+            when :cancelled
+              # Remove cancel callback and handle cancel
+              input.cancellation.remove_cancel_callback(cancel_callback_key)
+              raise @instance.failure_converter.from_failure(resolution.cancelled.failure, @instance.payload_converter)
+            else
+              raise "Unknown resolution status: #{resolution.status}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'temporalio/scoped_logger'
+require 'temporalio/workflow'
+
+module Temporalio
+  module Internal
+    module Worker
+      class WorkflowInstance
+        # Wrapper for a scoped logger that does not log on replay.
+        class ReplaySafeLogger < ScopedLogger
+          def initialize(logger:, instance:)
+            @instance = instance
+            @replay_safety_disabled = false
+            super(logger)
+          end
+
+          def replay_safety_disabled(&)
+            @replay_safety_disabled = true
+            yield
+          ensure
+            @replay_safety_disabled = false
+          end
+
+          def add(...)
+            if !@replay_safety_disabled && Temporalio::Workflow.in_workflow? && Temporalio::Workflow::Unsafe.replaying?
+              return true
+            end
+
+            # Disable illegal call tracing for the log call
+            @instance.illegal_call_tracing_disabled { super }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'temporalio/scoped_logger'
+
+module Temporalio
+  module Internal
+    module Worker
+      class WorkflowInstance
+        # Wrapper for a metric that does not log on replay.
+        class ReplaySafeMetric < SimpleDelegator
+          def record(value, additional_attributes: nil)
+            return if Temporalio::Workflow.in_workflow? && Temporalio::Workflow::Unsafe.replaying?
+
+            super
+          end
+
+          def with_additional_attributes(additional_attributes)
+            ReplaySafeMetric.new(super)
+          end
+
+          class Meter < SimpleDelegator
+            def create_metric(
+              metric_type,
+              name,
+              description: nil,
+              unit: nil,
+              value_type: :integer
+            )
+              ReplaySafeMetric.new(super)
+            end
+
+            def with_additional_attributes(additional_attributes)
+              Meter.new(super)
+            end
+          end
+        end
+      end
+    end
+  end
+end