@ninhache/probe 0.1.1 → 0.1.2

package/README.md

@@ -1,5 +1,10 @@
 # probe
 
+[![npm](https://img.shields.io/npm/v/@ninhache/probe)](https://www.npmjs.com/package/@ninhache/probe)
+[![Homebrew](https://img.shields.io/badge/homebrew-ninhache%2Ftap-orange)](https://github.com/Ninhache/homebrew-tap)
+[![CI](https://github.com/Ninhache/probe/actions/workflows/ci.yml/badge.svg)](https://github.com/Ninhache/probe/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/npm/l/@ninhache/probe)](LICENSE)
+
 Declare your project's local services once. Check they are up with one command, or with `make check`.
 
 ```console
@@ -63,6 +68,9 @@ services:
 | `path`   | `/`         | Path requested with `GET`              |
 | `expect` | any 2xx     | Expected status, or a list of statuses |
 
+Redirects are followed and the final status is judged, unless `expect` contains a 3xx: then the first response
+is judged as is.
+
 Files in `.probe/`:
 
 - `config.yml`: services. Commit it.
@@ -85,7 +93,8 @@ never touched.
 Targets: `help`, `check`, `status` and one `check-<name>` per service. The block uses `probe` when it is in
 your `PATH`, else `npx -y @ninhache/probe@latest`. It works with GNU Make 3.81 (the macOS default).
 
-Edited the block by hand? `probe status` says so, `probe sync` restores it.
+Edited the block by hand? `probe status` says so and `probe add` / `probe rm` leave it alone. `probe sync`
+restores it.
 
 ## Migrations
 
@@ -125,7 +134,7 @@ make check PROBE="node ../../dist/cli.js"
 Release: bump `version` in `package.json`, merge, then push a `v<version>` tag. The Release workflow publishes
 to npm through trusted publishing: no token, the package trusts this repo's `release.yml` (set on npmjs.com,
 package Settings, Trusted Publisher). It then opens a PR on `ninhache/homebrew-tap` with the new `url` and
-`sha256` (secret `HOMEBREW_TAP_TOKEN`): merge it once the tap's CI is green.
+`sha256` (secret `HOMEBREW_TAP_TOKEN`), which merges itself once the tap's CI is green.
 
 ## License
 

package/dist/cli.js

@@ -292,7 +292,7 @@ async function writeLock(paths, lock) {
 }
 
 // src/version.ts
-var CLI_VERSION = true ? "0.1.1" : "0.0.0-dev";
+var CLI_VERSION = true ? "0.1.2" : "0.0.0-dev";
 
 // src/makefile/generator.ts
 import { createHash } from "crypto";
@@ -408,8 +408,15 @@ function rawServices(loaded) {
   return loaded.raw.services ?? {};
 }
 async function saveServices(loaded, services) {
+  const edited = await blockState(loaded.paths, loaded.config) === "modified";
   const saved = await saveConfig(loaded, { ...loaded.raw, services });
-  await syncMakefile(saved.paths, saved.config);
+  if (!edited) {
+    await syncMakefile(saved.paths, saved.config);
+    return;
+  }
+  console.error(
+    "probe: the Makefile block was edited by hand, left as is. Run `probe sync` to regenerate it."
+  );
 }
 
 // src/commands/add.ts
@@ -470,6 +477,9 @@ function isExpected(expect, status) {
   if (expect === void 0) return status >= 200 && status < 300;
   return Array.isArray(expect) ? expect.includes(status) : expect === status;
 }
+function expectsRedirect(expect) {
+  return [expect ?? []].flat().some((status) => status >= 300 && status < 400);
+}
 function describeExpected(expect) {
   if (expect === void 0) return "2xx";
   return Array.isArray(expect) ? expect.join(" or ") : String(expect);
@@ -491,7 +501,11 @@ var httpChecker = {
     const started = performance.now();
     const elapsed = () => Math.round(performance.now() - started);
     try {
-      const response = await fetch(target, { signal: AbortSignal.timeout(timeoutMs) });
+      const response = await fetch(target, {
+        signal: AbortSignal.timeout(timeoutMs),
+        // Following a redirect hides its status: an expected 3xx could never match.
+        redirect: expectsRedirect(service.expect) ? "manual" : "follow"
+      });
       const latencyMs = elapsed();
       await response.body?.cancel();
       const { status } = response;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninhache/probe",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Health checks for your local dev services, from the CLI or a generated Makefile",
   "license": "MIT",
   "author": "Ninhache",