Skip to main content

In-Memory Runtimes

In-Memory Runtime​

The in-memory runtime is built on top of cats-effect and enables workflows to run without persistence. This runtime is ideal for:

  • Testing workflows.
  • Scenarios where workflows can be terminated or restarted from scratch without the need for state recovery.

Example​

Here is an example of using the in-memory runtime:

import MyWorkflowCtx.*
val workflow: WIO.Initial                               = ???
val knockerUpperAgent: KnockerUpper.Agent[MyWorkflowId] = ???
val runtime: InMemoryRuntime[Ctx, MyWorkflowId]         = InMemoryRuntime.default(workflow, InitialState(), knockerUpperAgent)
val wfInstance: IO[InMemoryWorkflowInstance[Ctx]]       = runtime.createInstance(??? : MyWorkflowId)

Unsafe In-Memory Runtime​

The unsafe in-memory runtime is an alternative implementation that:

  • Is not thread-safe.
  • Is built with vanilla Scala, making it lightweight and simple.

Example​

Here is an example of using the unsafe in-memory runtime:

import MyWorkflowCtx.*
val workflow: WIO.Initial                         = ???
val runtime: InMemorySyncRuntime[Ctx, Unit]       = InMemorySyncRuntime.default(workflow, InitialState())
val wfInstance: InMemorySyncWorkflowInstance[Ctx] = runtime.createInstance(())