@procedures/mark 0.17.2 → 0.17.3

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @procedures/mark
 
+## 0.17.3
+
+### Patch Changes
+
+- 636f098: New: the procedures host answers the health probes of its service (CLI-9, decision D5). The probes come from `probeHandler()` and `probeServer()` of `@mark1russell7/service/http`. This change is additive, thus it is a PATCH of the client group (decision D13).
+  
+  - Each listener of `createProcedureHost()` answers `GET /_probes/startup`, `/_probes/readiness` and `/_probes/liveness` from the health of the service. The answer is 200, or 503 with `Retry-After` during the startup and the shutdown. `/_probes/readiness/<controller>` gives the readiness of one controller.
+  - The probes need no token and pass no browser check. They give only the status. They mount before the faces, thus a probe path never reaches a procedure. Each other path goes to the faces with the token and the browser checks, as before.
+  - A listener does not answer the report of the service (`/_probes/report`), because it names the checks and the dependencies. The procedure `host.health` gives the details with the token.
+  - The probes of a listener stop when the intake stops. Thus the listener still closes at the stop of the intake, and a new connection is refused, as before. `probes: { until: "close transports" }` keeps the listener open through the drain: the probes answer 503, and each other request gets 503 with `Retry-After`.
+  - The new option `probes` of `createProcedureHost()`: `{ prefix, until }` changes the prefix and the last stage, and `false` turns the probes off. `HOST_PROBE_PREFIX` is `/_probes`. `host.info.probes()` gives the base URL of the probes on each listener.
+  - The new option `probes` of `runProcedureHost()`: `{ port, host, prefix, retryAfter }` declares a probe server on a port of its own (`svc.healthServer(probeServer(...))`). It starts first and closes last, thus its probes answer through the whole drain. It also answers `/report`. The listeners of the host then answer no probes, unless the host options give `probes`. `probes()` of the result gives the base URL of each place that answers the probes.
+  - The new flag `--probe-port <port>` of `procedure-server`, `mark serve` and `mark --server` gives the probe server, on the address of `--host`. `mark` refuses it without `--server` before a command, as it refuses `--port`. The startup prints the URL of the probes.
+  
+  Deprecated: at the timeout of 15 s, `server.start` gives `success: true` with the message "still loading" while the process still starts. From the next MINOR of the client group, a start that is not ready at the timeout gives `success: false`, with the PID of the process that still starts. Read the readiness probe or `mark server status` for the state.
+  
+  The site, MiniMongo, Graph and jarvis: no change. A host with a listener now also answers the paths under `/_probes`. Before, these paths got 404.
+- Updated dependencies [636f098]
+  - @procedures/peer@0.17.3
+  - @procedures/server@0.17.3
+  - @procedures/lib@0.17.3
+  - @procedures/mcp-dev-tools@0.17.3
+  - @procedures/client@0.17.3
+  - @procedures/cli-run@0.17.3
+  - @procedures/pnpm@0.17.3
+  - @procedures/procedure@0.17.3
+  - @procedures/shell@0.17.3
+  - @procedures/vitest@0.17.3
+
 ## 0.17.2
 
 ### Patch Changes

package/README.md

@@ -130,9 +130,9 @@ The package provides a `mark` binary for command-line usage.
 
 ```bash
 mark [global options] <path...> [positional...] [--options]
-mark serve [--procedures pkgs] [--port N] [--token T | --no-token] [--expose patterns] [--events topics] [--fs-root folder]
+mark serve [--procedures pkgs] [--port N] [--token T | --no-token] [--expose patterns] [--events topics] [--fs-root folder] [--probe-port N]
 mark mcp [--bundles list] [--tool-timeout ms] [--read-only] [--http port] [--fs-root folder] [--debug]
-mark --server [--port N] [--host H] [--transport http|websocket|both] [--events topics]
+mark --server [--port N] [--host H] [--transport http|websocket|both] [--events topics] [--probe-port N]
 mark -i
 mark --fs-root <folder> <command | --server | -i | serve | mcp>
 ```
@@ -167,6 +167,19 @@ mark --server --transport both --events "orders.*"
 mark serve --procedures ./my-procedures.js --events orders.created --events audit.created
 ```
 
+#### The health probes of the hosts
+
+`mark --server` and `mark serve` answer the probes of their service (CLI-9, decision D5). The probes give only the status, and they need no token.
+
+- By default, each listener answers `GET /_probes/startup`, `/_probes/readiness` and `/_probes/liveness`. The answer is 200, or 503 with `Retry-After`. The probes stop when the listener closes at the stop of the intake.
+- `--probe-port <port>` moves the probes to a port of their own, on the address of `--host`: `/startup`, `/readiness`, `/liveness` and `/report`. The listeners then answer no probes.
+- The startup prints the URL of the probes.
+
+```bash
+curl http://127.0.0.1:3000/_probes/readiness
+mark --server --probe-port 9090
+```
+
 #### The root of the files
 
 `--fs-root <folder>` confines each procedure to the folder (roadmap R33). Each procedure keeps its paths in the folder, or `mark` refuses it. It applies to each mode and host of `mark`: