mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-16 07:13:29 +00:00
fix(env-check): mark APNs allOrNone and render the satisfying anyOf alternative
Two W10 QA findings on the v1.4.42 env-check wave, both tied to the v1.4.40 AP-2 silent-disable scenario this script was conceived to catch: 1. SD-H1 — the APNs group in `scripts/env-manifest.json` shipped without `allOrNone: true`, so the synthetic `<all-or-none>` required row never fired. An operator setting three of four `APNS_*` vars and leaving `APNS_KEY` / `APNS_KEY_FILE` empty would see exit 0 and green-light the deploy — exactly the v1.4.40 paper-cut the wave was meant to prevent. Adds the flag. 2. CR-H2 — the renderer printed `[OK] APNS_KEY` even when only `APNS_KEY_FILE` was set. An operator grepping the env block for `APNS_KEY` would find nothing and file a ghost issue. The `CheckResult` now carries `satisfiedBy`, populated to the matched alternative when it differs from the primary; the renderer prints `[OK] APNS_KEY (satisfied by APNS_KEY_FILE)`. Tests pin both fixes — the AP-2 scenario synthetic-row trip (16 → 19 passing), and the `satisfiedBy` branch coverage on the anyOf match path.
This commit is contained in:
1 parent
cb0a3b29f2
commit
8aa7d6fafb
3 files changed
+66
-3
No files matched your search
@@ -66,6 +66,7 @@ const SAMPLE_MANIFEST = {
|
||||
name: "APNs",
|
||||
description: "iOS push",
|
||||
required: false,
|
||||
allOrNone: true,
|
||||
variables: [
|
||||
{ name: "APNS_KEY_ID", purpose: "key id" },
|
||||
{ name: "APNS_TEAM_ID", purpose: "team id" },
|
||||
@@ -134,6 +135,34 @@ describe("checkEnv — anyOf alternatives", () => {
|
||||
expect(apnsKey.present).toBe(true);
|
||||
});
|
||||
|
||||
it("records satisfiedBy when an anyOf alternative satisfies the row", () => {
|
||||
// The label `[OK] APNS_KEY` was misleading pre-v1.4.42 — an operator
|
||||
// who saw it would grep for `APNS_KEY` in the env block and find
|
||||
// nothing, file a ghost issue. `satisfiedBy` lets the renderer
|
||||
// surface the alternative that actually matched.
|
||||
const out = checkEnv(SAMPLE_MANIFEST, {
|
||||
DATABASE_URL: "x",
|
||||
ENCRYPTION_KEY: "y",
|
||||
APNS_KEY_ID: "abc",
|
||||
APNS_TEAM_ID: "def",
|
||||
APNS_KEY_FILE: "/secrets/apns.p8",
|
||||
});
|
||||
const apnsKey = out.find((r) => r.variable === "APNS_KEY")!;
|
||||
expect(apnsKey.satisfiedBy).toBe("APNS_KEY_FILE");
|
||||
});
|
||||
|
||||
it("leaves satisfiedBy undefined when the primary name is the one set", () => {
|
||||
const out = checkEnv(SAMPLE_MANIFEST, {
|
||||
DATABASE_URL: "x",
|
||||
ENCRYPTION_KEY: "y",
|
||||
APNS_KEY_ID: "abc",
|
||||
APNS_TEAM_ID: "def",
|
||||
APNS_KEY: "-----BEGIN PRIVATE KEY-----...",
|
||||
});
|
||||
const apnsKey = out.find((r) => r.variable === "APNS_KEY")!;
|
||||
expect(apnsKey.satisfiedBy).toBeUndefined();
|
||||
});
|
||||
|
||||
it("treats APNS_KEY as satisfied when APNS_KEY is set (the 12-factor variant)", () => {
|
||||
const out = checkEnv(SAMPLE_MANIFEST, {
|
||||
DATABASE_URL: "x",
|
||||
@@ -191,6 +220,25 @@ describe("checkEnv — all-or-none groups", () => {
|
||||
});
|
||||
expect(out.find((r) => r.variable === "<all-or-none>")).toBeUndefined();
|
||||
});
|
||||
|
||||
it("catches the v1.4.40 AP-2 scenario — 3 of 4 APNS_* set, key missing", () => {
|
||||
// Direct regression pin for the gap the env-check wave was conceived
|
||||
// to close. Pre-v1.4.42 the APNs group lacked `allOrNone: true` so
|
||||
// this exact env-block shape exited 0 and silently disabled APNs.
|
||||
const out = checkEnv(SAMPLE_MANIFEST, {
|
||||
DATABASE_URL: "x",
|
||||
ENCRYPTION_KEY: "y",
|
||||
APNS_KEY_ID: "abc",
|
||||
APNS_TEAM_ID: "def",
|
||||
// APNS_KEY / APNS_KEY_FILE deliberately absent
|
||||
});
|
||||
const synth = out.find(
|
||||
(r) => r.group === "APNs" && r.variable === "<all-or-none>",
|
||||
)!;
|
||||
expect(synth).toBeDefined();
|
||||
expect(synth.required).toBe(true);
|
||||
expect(synth.note).toContain("2/3");
|
||||
});
|
||||
});
|
||||
|
||||
describe("checkEnv — optional groups (informational)", () => {
|
||||
|
||||
Reference in new issue
Block a user