Module: Temporalio::Workflow::Unsafe

Defined in:
lib/temporalio/workflow.rb

Overview

Unsafe module contains only-in-workflow methods that are considered unsafe. These should not be used unless the consequences are understood.

Class Method Summary collapse

Class Method Details

.durable_scheduler_disabled ⇒ Object

Run a block of code with the durable/deterministic workflow Fiber scheduler off. This means fallback to default fiber scheduler and no workflow helpers will be available in the block. This is usually only needed in advanced situations where a third party library does something like use “Timeout” in a way that shouldn’t be made durable.

If this is invoked outside of a workflow, it just runs the block.

This implies illegal_call_tracing_disabled.



578
579
580
581
582
583
584
 
# File 'lib/temporalio/workflow.rb', line 578

def self.durable_scheduler_disabled(&)
  if Workflow.in_workflow?
    Workflow._current.durable_scheduler_disabled(&)
  else
    yield
  end
end

.illegal_call_tracing_disabled { ... } ⇒ Object

Run a block of code with illegal call tracing disabled. Users should be cautious about using this as it can often signify unsafe code.

If this is invoked outside of a workflow, it just runs the block.

Yields:

  • Block to run with call tracing disabled

Returns:

  • (Object) —

    Result of the block.



549
550
551
552
553
554
555
 
# File 'lib/temporalio/workflow.rb', line 549

def self.illegal_call_tracing_disabled(&)
  if Workflow.in_workflow?
    Workflow._current.illegal_call_tracing_disabled(&)
  else
    yield
  end
end

.io_enabled ⇒ Object

Run a block of code with IO enabled. Specifically this allows the ‘io_wait` call of the fiber scheduler to work. Users should be cautious about using this as it can often signify unsafe code. Note, this is often only applicable to network code as file IO and most process-based IO does not go through scheduler `io_wait`.

If this is invoked outside of a workflow, it just runs the block.



562
563
564
565
566
567
568
 
# File 'lib/temporalio/workflow.rb', line 562

def self.io_enabled(&)
  if Workflow.in_workflow?
    Workflow._current.io_enabled(&)
  else
    yield
  end
end

.replaying? ⇒ Boolean

Returns True if the workflow is replaying, false otherwise. Most code should not check this value.

Returns:

  • (Boolean) —

    True if the workflow is replaying, false otherwise. Most code should not check this value.



537
538
539
 
# File 'lib/temporalio/workflow.rb', line 537

def self.replaying?
  Workflow._current.replaying?
end