@hardfin/cli 0.1.0-dev.25 → 0.1.0-dev.27

package/README.md

@@ -310,6 +310,7 @@ hardfin status --offline     # no network calls at all
 | `credential`          | Whether you are signed in, where the refresh token is kept, and when it was issued and last renewed                    |
 | `authorizationServer` | Whether discovery worked, and every endpoint it named                                                                  |
 | `api`                 | Whether the API accepted the credential, when the access token expires, and its scopes                                 |
+| `telemetry`           | Whether defects are reported, the setting that decided it, and where reports go                                        |
 
 Nothing secret is printed. An API key and a refresh token are each reported as a
 `sha256:` fingerprint, which identifies a credential across two machines without disclosing
@@ -319,6 +320,35 @@ it.
 the server reported one falls back to Hardfin's 90-day rule, and `refreshExpiryIsEstimated`
 says which of the two you are looking at.
 
+## Error reports
+
+When the CLI fails because of a defect in the CLI itself, it reports the error to the Hardfin
+team through Sentry. It then tells you it did, with a reference to quote.
+
+Only defects are reported. None of these are:
+
+- an error the API answered, including a 500, which the server records itself
+- a network failure, or a server that cannot be reached
+- a mistake on the command line or in a settings file
+- being signed out, or a sign in that was cancelled or refused
+- the machine refusing a file, such as a full disk or a missing permission
+
+A report carries the error, its stack trace, and what `hardfin status` would print at that
+moment. The command is named, and its flags are listed by name without their values.
+
+A report never carries tokens, API keys, argument or flag values, request or response bodies,
+people's or organizations' names, your hostname, or your home directory. A person and an
+organization appear only as their Hardfin keys.
+
+| To                                                | Set                                        |
+| ------------------------------------------------- | ------------------------------------------ |
+| Stop reporting                                    | `DO_NOT_TRACK=1`, or `HARDFIN_TELEMETRY=0` |
+| Report from a checkout, which does not by default | `HARDFIN_TELEMETRY=1`                      |
+| Send reports to another Sentry project            | `HARDFIN_SENTRY_DSN`                       |
+
+`hardfin status` shows which of these is in effect. `hardfin __crash` fails on purpose, to
+check that a report arrives.
+
 ## Local configuration
 
 A local build reaches a local server without editing code. Four layers supply the same

package/dist/cli.js

@@ -6,11 +6,31 @@ process.stdout.on("error", (error) => {
 	if (error.code === "EPIPE") process.exit(0);
 	throw error;
 });
-const answer = await toQuickAnswer(process.argv.slice(2));
-if (answer === void 0) {
-	const { toCli } = await import("./program-b3uLLsYy.js");
-	await toCli().parseAsync(process.argv);
-} else process.stdout.write(`${answer}\n`);
+let isCrashing = false;
+process.on("uncaughtException", (error) => void toCrash(error));
+process.on("unhandledRejection", (error) => void toCrash(error));
+try {
+	const answer = await toQuickAnswer(process.argv.slice(2));
+	if (answer === void 0) {
+		const { toCli, wasReportAttempted } = await import("./program-C3SGdPbf.js");
+		await toCli().parseAsync(process.argv);
+		if (wasReportAttempted()) process.exit();
+	} else process.stdout.write(`${answer}\n`);
+} catch (error) {
+	await toCrash(error);
+}
+/** toCrash ends the process for an error nothing caught, once it has been reported. */
+async function toCrash(error) {
+	if (isCrashing) return;
+	isCrashing = true;
+	process.stderr.write(`error: ${error instanceof Error ? error.message : String(error)}\n`);
+	try {
+		const { toReported } = await import("./program-C3SGdPbf.js");
+		await toReported(error, false, void 0, "fatal");
+	} finally {
+		process.exit(1);
+	}
+}
 /**
 * toQuickAnswer answers a completion script without loading zod or the commands, which is
 * most of what a start costs, because a Tab starts the CLI every time.

package/dist/completion-tree.json

@@ -2565,6 +2565,15 @@
         }
       ],
       "subcommands": []
+    },
+    {
+      "name": "__crash",
+      "summary": "Fail on purpose, to check that defects are reported",
+      "hidden": true,
+      "runs": true,
+      "flags": [],
+      "arguments": [],
+      "subcommands": []
     }
   ]
 }