Class: Temporalio::Internal::Worker::WorkflowInstance::OutboundImplementation

Inherits:
Worker::Interceptor::Workflow::Outbound show all
Defined in:
lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb

Overview

Root implementation of the outbound interceptor.

Instance Attribute Summary

Attributes inherited from Worker::Interceptor::Workflow::Outbound

#next_interceptor

Instance Method Summary collapse

Constructor Details

#initialize(instance) ⇒ OutboundImplementation

Returns a new instance of OutboundImplementation.



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 20

def initialize(instance)
  super(nil) # steep:ignore
  @instance = instance
  @activity_counter = 0
  @timer_counter = 0
  @child_counter = 0
  @nexus_operation_counter = 0
  @external_signal_counter = 0
  @external_cancel_counter = 0
end

Instance Method Details

#_signal_external_workflow(id:, run_id:, child:, signal:, args:, cancellation:, arg_hints:, headers:) ⇒ Object

Raises:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 231

def _signal_external_workflow(id:, run_id:, child:, signal:, args:, cancellation:, arg_hints:, 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, hints: arg_hints),
    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 = begin
    Fiber.yield
  ensure
    # Remove pending and cancel callback
    @instance.pending_external_signals.delete(seq)
    cancellation.remove_cancel_callback(cancel_callback_key)
  end

  # Raise if resolution has failure
  return unless resolution.failure

  raise @instance.failure_converter.from_failure(resolution.failure, @instance.payload_converter)
end

#cancel_external_workflow(input) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 31

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 = begin
    Fiber.yield
  ensure
    # Remove pending
    @instance.pending_external_cancels.delete(seq)
  end

  # Raise if resolution has failure
  return unless resolution.failure

  raise @instance.failure_converter.from_failure(resolution.failure, @instance.payload_converter)
end

#execute_activity(input) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 61

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,
                                       result_hint: input.result_hint) 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, hints: input.arg_hints
          ),
          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

#execute_activity_once(local:, cancellation:, last_local_backoff:, result_hint:, &block) ⇒ Object

If this doesn’t raise, it returns success | DoBackoff



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 153

def execute_activity_once(local:, cancellation:, last_local_backoff:, result_hint:, &block)
  # Add to pending activities (removed by the resolver)
  seq = block.call(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 = begin
    Fiber.yield
  ensure
    # Remove pending and cancel callback
    @instance.pending_activities.delete(seq)
    cancellation.remove_cancel_callback(cancel_callback_key)
  end

  case resolution.status
  when :completed
    @instance.payload_converter.from_payload(resolution.completed.result, hint: result_hint)
  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

#execute_activity_with_local_backoffs(local:, cancellation:, result_hint:, &block) ⇒ Object

Raises:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 132

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).
  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:, result_hint:, &block)
    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

#execute_local_activity(input) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 96

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,
                                       result_hint: input.result_hint) 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, hints: input.arg_hints
          ),
          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
        ),
        user_metadata: ProtoUtils.to_user_metadata(input.summary, nil, @instance.payload_converter)
      )
    )
    seq
  end
end

#initialize_continue_as_new_error(input) ⇒ Object 



201
202
203
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 201

def initialize_continue_as_new_error(input)
  # Do nothing
end

#signal_child_workflow(input) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 205

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,
    arg_hints: input.arg_hints,
    headers: input.headers
  )
end

#signal_external_workflow(input) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 218

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,
    arg_hints: input.arg_hints,
    headers: input.headers
  )
end

#sleep(input) ⇒ Object

Raises:

  • (ArgumentError) 


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 281

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
  begin
    Fiber.yield
  ensure
    # Remove pending
    @instance.pending_timers.delete(seq)
  end

  # Remove cancellation callback (only needed on success)
  input.cancellation.remove_cancel_callback(cancel_callback_key)
end

#start_child_workflow(input) ⇒ Object

Raises:



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 344

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,
                                                   hints: input.arg_hints),
        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 = begin
    Fiber.yield
  ensure
    # Remove pending
    @instance.pending_child_workflow_starts.delete(seq)
  end

  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:,
      result_hint: input.result_hint
    )
    @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

#start_nexus_operation(input) ⇒ Object

Raises:



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/temporalio/internal/worker/workflow_instance/outbound_implementation.rb', line 435

def start_nexus_operation(input)
  raise Error::CanceledError, 'Nexus operation canceled before scheduled' if input.cancellation.canceled?

  # Add the command
  seq = (@nexus_operation_counter += 1)
  @instance.add_command(
    Bridge::Api::WorkflowCommands::WorkflowCommand.new(
      schedule_nexus_operation: Bridge::Api::WorkflowCommands::ScheduleNexusOperation.new(
        seq:,
        endpoint: input.endpoint,
        service: input.service,
        operation: input.operation,
        input: @instance.payload_converter.to_payload(input.arg, hint: input.arg_hint),
        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),
        nexus_header: input.headers,
        cancellation_type: input.cancellation_type
      ),
      user_metadata: ProtoUtils.to_user_metadata(input.summary, nil, @instance.payload_converter)
    )
  )

  # Set as pending start
  @instance.pending_nexus_operation_starts[seq] = Fiber.current

  # Register cancel callback
  cancel_callback_key = input.cancellation.add_cancel_callback do
    # Send cancel if in start or pending
    if @instance.pending_nexus_operation_starts.include?(seq) ||
       @instance.pending_nexus_operations.include?(seq)
      @instance.add_command(
        Bridge::Api::WorkflowCommands::WorkflowCommand.new(
          request_cancel_nexus_operation: Bridge::Api::WorkflowCommands::RequestCancelNexusOperation.new(
            seq:
          )
        )
      )
    end
  end

  # Wait for start resolution
  resolution = begin
    Fiber.yield
  ensure
    # Remove pending start
    @instance.pending_nexus_operation_starts.delete(seq)
  end

  # Handle start failure
  if resolution.failed
    input.cancellation.remove_cancel_callback(cancel_callback_key)
    raise @instance.failure_converter.from_failure(resolution.failed, @instance.payload_converter)
  end

  # Create handle and add to pending operations (result will come via resolve_nexus_operation)
  handle = NexusOperationHandle.new(
    operation_token: resolution.operation_token,
    instance: @instance,
    cancellation: input.cancellation,
    cancel_callback_key:,
    result_hint: input.result_hint
  )
  @instance.pending_nexus_operations[seq] = handle

  handle
end