Skip to main content

Interface: CreateTestHarnessOptions

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:96

Properties​

aiLogger?​

optional aiLogger?: InMemoryAICallLogger

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:112

AI call logger. Defaults to a fresh InMemoryAICallLogger.

blobStore?​

optional blobStore?: InMemoryBlobStore

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:110

Blob store. Defaults to an InMemoryBlobStore.

clock?​

optional clock?: FakeClock

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:106

Fake clock to use. Defaults to a fresh FakeClock.

eventSink?​

optional eventSink?: EventSink

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:118

Event sink override; otherwise a CollectingEventSink.

idleAdvanceMs?​

optional idleAdvanceMs?: number

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:137

How far to advance the clock when nothing is runnable and no suspended stage declares a nextPollAt. Defaults to one second.

jobHeartbeatIntervalMs?​

optional jobHeartbeatIntervalMs?: number

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:132

Real-time interval of the job lease heartbeat tick() runs under, in milliseconds. The heartbeat is what aborts ctx.abortSignal after cancel(), and it runs on the wall clock (not the fake one), so the default is short — 10 ms — so a body can await the abort. Raise it for a test that must not see heartbeat dispatches.

maxTicks?​

optional maxTicks?: number

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:122

Guard for run(). Defaults to 100.

mockAi?​

optional mockAi?: MockAIHelperFactory

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:114

Mock AI factory. Defaults to createMockAIHelperFactory().

plugins?​

optional plugins?: PluginDefinition<"step:signalled" | "workflow:created" | "workflow:started" | "workflow:completed" | "workflow:failed" | "workflow:cancelled" | "workflow:suspended" | "stage:started" | "stage:completed" | "stage:suspended" | "stage:failed" | "stage:retrying" | "stage:progress" | "annotation:created">[]

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:120

Plugins wired through a plugin runner. Ignored when eventSink is set.

services?​

optional services?: Partial<KernelServices>

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:104

Kernel services. aiLogger and ai default to the harness's InMemoryAICallLogger and createMockAIHelperFactory(); anything you pass wins.

spillThresholdBytes?​

optional spillThresholdBytes?: number

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:124

Forwarded to createKernel's spillThresholdBytes.

stepLedger?​

optional stepLedger?: StepLedger

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:108

Step ledger. Defaults to an InMemoryStepLedger on the harness clock.

workerId?​

optional workerId?: string

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:116

Worker id used for run.claimPending and the job queue.

workflows?​

optional workflows?: Workflow<any, any, { }>[]

Defined in: packages/workflow-engine/src/testing/create-test-harness.ts:98

Workflows registered with the kernel.