@usine/engine/step-executor

Classes

StepExecution

The saved Event, effective task and Agent, and Step being tried in one Attempt.

Extends

• Schema.Class

Constructors

Constructor

new StepExecution(…args): StepExecution

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

StepExecution

Properties

agent

readonly agent: Agent

attempt

readonly attempt: Attempt

event

readonly event: Event

parentModel

readonly parentModel: Option<string & Brand<"ModelId">>

reattach

readonly reattach: boolean

The Attempt was open when the orchestrator stopped and its parent task is still live: execution reattaches to it instead of starting it.

repository

readonly repository: string & Brand<"RepositoryName">

resume

readonly resume: Option<SalvagePushed>

The newest pushed salvage of an earlier Attempt of this Run, which this Attempt’s checkout resumes from.

revision

readonly revision: string & Brand<"RepositoryRevision">

run

readonly run: Run

step

readonly step: Step

task

readonly task: string & Brand<"AttemptTask">

---

StepExecutor

Runs one Attempt on a Worker: reserve capacity, execute the step, interrupt on cancel.

Extends

• Context.ServiceClass

Properties

Service

readonly Service: object

The service’s operations: what yield* StepExecutor returns.

execute

readonly execute: (execution, io) => Effect.Effect<StepResult, AttemptFailure>

Runs the reserved Attempt, or reattaches to it when execution.reattach is set, recording channel activity through io, and waits for its result.

Parameters

Parameter	Type
execution	StepExecution
io	Sink

Returns

Effect.Effect<StepResult, AttemptFailure>

interrupt

readonly interrupt: (attemptId) => Effect.Effect<void, AttemptFailure>

Requests that the identified Attempt stop its current work.

Parameters

Parameter	Type
attemptId	AttemptId

Returns

Effect.Effect<void, AttemptFailure>

intervene

readonly intervene: (attemptId, intervention) => Effect.Effect<void, AttemptFailure>

Sends a nonterminal operator action to a live session in the identified Attempt.

Parameters

Parameter	Type
attemptId	AttemptId
intervention	Intervention

Returns

Effect.Effect<void, AttemptFailure>

isLive

readonly isLive: (attemptId) => Effect.Effect<boolean, AttemptFailure>

Whether the Attempt’s parent task outlived an orchestrator restart, so its Run reattaches it instead of opening the next Attempt: the task still runs, or it finished and its result still has to be collected from the Worker.

Parameters

Parameter	Type
attemptId	AttemptId

Returns

Effect.Effect<boolean, AttemptFailure>

outcome

readonly outcome: (attemptId) => Effect.Effect<Option.Option<Result.Result<StepResult, AttemptFailure>>, AttemptFailure>

The result an open Attempt’s parent task stored before an orchestrator restart, which its Run never recorded. The Run finishes the Attempt with it instead of failing it as interrupted; none when nothing was stored.

Parameters

Parameter	Type
attemptId	AttemptId

Returns

Effect.Effect<Option.Option<Result.Result<StepResult, AttemptFailure>>, AttemptFailure>

recover

readonly recover: <E>(attempt, record) => Effect.Effect<void, E | AttemptFailure>

Reconciles an old checkout before new Attempts start; records its salvage before releasing any work.

Type Parameters

Type Parameter
E

Parameters

Parameter	Type
attempt	AttemptRecovery
record	(salvage) => Effect.Effect<void, E>

Returns

Effect.Effect<void, E | AttemptFailure>

reserve

readonly reserve: (submission) => Effect.Effect<WorkerLease, AttemptFailure>

Waits for Worker capacity; the returned lease must be released after execution or cancellation.

Parameters

Parameter	Type
submission	Submission

Returns

Effect.Effect<WorkerLease, AttemptFailure>

Interfaces

WorkerLease

A reservation of one Worker’s capacity for the length of an Attempt. Call release when the Attempt ends.

Properties

release

readonly release: Effect<void>

worker

readonly worker: string & Brand<"WorkerName">