Skip to content

Services: State diagram #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aomarks merged 2 commits into from
Oct 22, 2022
Merged

Services: State diagram #475

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4077fac
Services state diagram
aomarks Oct 22, 2022
20010b4
Document the lifetime of a ServiceScriptExecution
aomarks Oct 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions src/execution/service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,69 @@ import type {Result} from '../error.js';

/**
* Execution for a {@link ServiceScriptConfig}.
*
* Note that this class represents a service _bound to one particular execution_
* of the script graph. In non-watch mode (`npm run ...`), there will be one
* instance of this class per service. In watch mode (`npm run --watch ...`),
* there will be one instance of this class per service _per watch iteration_,
* and the underlying child process will be transfered between instances of this
* class whenever possible to avoid restarts.
*
* ```
* ┌─────────┐
* ╭─◄─ abort ────┤ INITIAL │
* │ └────┬────┘
* │ │
* ▼ execute
* │ │
* │ ┌───────▼────────┐
* ├─◄─ abort ─┤ FINGERPRINTING ├──── depExecErr ────►───╮
* │ └───────┬────────┘ │
* │ │ │
* ▼ fingerprinted │
* │ │ │
* │ ┌─────▼─────┐ │
* ├─◄─ abort ───┤ UNSTARTED │ │
* │ └─────┬─────┘ ▼
* │ │ │
* │ start │
* │ │ ╭─╮ │
* │ │ │ start │
* │ ┌────▼──▼─┴┐ │
* │ ╭◄─ abort ┤ STARTING ├─── startErr or ────►──────┤
* │ │ └────┬────┬┘ depServiceStartErr │
* ▼ │ │ │ │
* │ │ │ ▼ │
* │ │ │ ╰─── depServiceExit ──►──╮ │
* │ │ started │ │
* │ ▼ │ ╭─╮ ▼ │
* │ │ │ │ start │ │
* │ │ ┌────▼─▼─┴┐ │ │
* │ ├◄─ abort ┤ STARTED ├── exit ─────────────►──│───┤
* │ │ └────┬─┬─┬┘ │ │
* │ │ │ │ ╰─── detach ──╮ │ │
* │ │ │ ▼ │ │ │
* │ │ │ ╰───── depServiceExit ───►──┤ │
* │ │ │ │ │ │
* │ │ allConsumersDone │ │ │
* │ ▼ (unless directly invoked) │ │ │
* │ │ │ ▼ ▼ ▼
* ▼ │ │ ╭─╮ │ │ │
* │ │ │ │ start │ │ │
* │ │ ┌────▼──▼─┴┐ │ │ │
* │ ╰─────────► STOPPING ◄─────────────◄─────────╯ │
* │ └┬─▲─┬─────┘ │ │
* │ abort │ │ │ │
* │ ╰─╯ │ │ │
* │ exit │ │
* │ │ ╭─╮ │ │ ╭─╮
* │ │ │ start │ │ │ start
Comment thread
justinfagnani marked this conversation as resolved.
* │ ┌────▼─▼─┴┐ ┌────▼─────┐ ┌───▼─▼─┴┐
* ╰──────────────► STOPPED │ │ DETACHED │ │ FAILED │
* └┬─▲──────┘ └┬─▲───────┘ └┬─▲─────┘
* abort │ *all* │ abort │
* ╰─╯ ╰─╯ ╰─╯
* ```
*/
export class ServiceScriptExecution extends BaseExecutionWithCommand<ServiceScriptConfig> {
private readonly _terminated = new Deferred<Result<void, Failure>>();
Expand Down