Erlang/OTP-style supervision trees for Effect. A supervisor starts its children in order, restarts the ones that fail, and stops them in reverse order. The children run as operating-system processes, socket connections or effect/cluster entities, and a conformance suite checks that each of those media behaves as the spec says.
| Package | What it is | README |
|---|---|---|
@systemfsoftware/effect-daemon-spec |
The supervision core: strategies, restart intensity, dynamic children and health latches, as a pure typed fold. | README |
@systemfsoftware/effect-daemon-process |
A medium that runs each child as an operating-system process. | README |
@systemfsoftware/effect-daemon-socket |
A medium that supervises long-lived socket connections. | README |
@systemfsoftware/effect-daemon-cluster |
A medium over effect/cluster: entities and single-owner singletons. |
README |
@systemfsoftware/effect-daemon-conformance |
Checks a medium of your own against the spec with scripted child lifecycles. | README |
pnpm add @systemfsoftware/effect-daemon-spec @systemfsoftware/conformance-spec effectAdd the medium you supervise children with (effect-daemon-process, effect-daemon-socket or effect-daemon-cluster), and effect-daemon-conformance to prove a medium of your own.
A child is an Effect. A bare Effect counts as started as soon as it runs; a function of ready counts as started when it calls ready, for example once a server is listening.
import { Supervisor } from '@systemfsoftware/effect-daemon-spec'
import { Effect, Layer } from 'effect'
const database = Effect.andThen(Effect.log('database connected'), Effect.never)
const httpServer = (ready: Effect.Effect<void>) =>
Effect.gen(function*() {
yield* Effect.log('listening on :8080')
yield* ready
return yield* Effect.never
})
const app = Supervisor.make('app').pipe(
Supervisor.strategy('rest_for_one'),
Supervisor.intensity(3, 5_000),
Supervisor.children([
Supervisor.ChildSpecs.make('database', database),
Supervisor.ChildSpecs.make('http', httpServer),
]),
)
Layer.launch(app.layer).pipe(Effect.runFork)If the database fails, rest_for_one stops the HTTP server, restarts the database and starts the server again. A fourth restart within five seconds stops both children and terminates the supervisor. The spec package README covers every strategy, child option and trace entry.
Development setup and contribution workflow are in CONTRIBUTING.md.
Apache-2.0. Each package ships its own LICENSE file; see the spec package's.