Compare commits

..

1 Commits

Author SHA1 Message Date
Flea Flicker 5f01df819e fix(GRO-2299): redact googleMapsApiKey from PATCH /api/admin/settings response
CI / Test (pull_request) Successful in 24s
CI / Lint & Typecheck (pull_request) Successful in 27s
CI / Build & Push Docker Images (pull_request) Successful in 1m18s
The PATCH handler returned the full businessSettings row via .returning(),
echoing the encrypted googleMapsApiKey ciphertext back to the caller. Wrap the
return in the existing redactSettings() helper (after a !updated guard) so
redaction is applied symmetrically with the GET projection (GRO-2294).

- src/routes/settings.ts: guard + redactSettings(updated) on PATCH return
- src/__tests__/settings.test.ts: assert PATCH omits googleMapsApiKey
  (existing-row and auto-create-then-update branches)
- UAT_PLAYBOOK.md §13 TC-API-13.2: assert PATCH response omits the secret

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-09 06:50:20 +00:00
4 changed files with 48 additions and 149 deletions
+1 -1
View File
@@ -21,7 +21,7 @@
"wait-for-db": "node ./scripts/wait-for-db.mjs", "wait-for-db": "node ./scripts/wait-for-db.mjs",
"migrate": "node ./scripts/wait-for-db.mjs && drizzle-kit migrate", "migrate": "node ./scripts/wait-for-db.mjs && drizzle-kit migrate",
"seed": "node ./scripts/wait-for-db.mjs && tsx src/seed.ts", "seed": "node ./scripts/wait-for-db.mjs && tsx src/seed.ts",
"reset": "node ./scripts/wait-for-db.mjs && tsx src/reset.ts", "reset": "node ./scripts/wait-for-db.mjs && tsx src/reset.ts && drizzle-kit migrate && tsx src/seed.ts",
"studio": "drizzle-kit studio", "studio": "drizzle-kit studio",
"typecheck": "tsc --noEmit" "typecheck": "tsc --noEmit"
}, },
+39 -114
View File
@@ -1,52 +1,13 @@
/** /**
* reset.ts — Drop all application tables, re-run migrations, and re-seed. * reset.ts — Drop all application tables and re-run migrations + seed.
* *
* Intended for local development only. Never run against production. * Intended for local development only. Never run against production.
* *
* Usage: * Usage:
* DATABASE_URL=postgres://... npx tsx packages/db/src/reset.ts * DATABASE_URL=postgres://... npx tsx packages/db/src/reset.ts
*
* GRO-2139: the entire drop→migrate→seed chain runs inside a single
* Postgres advisory lock (SEED_ADVISORY_LOCK_KEY) so a concurrent
* `seed.ts` (e.g. the dev `seed-test-data-*` Job being recreated at
* the top of the hour) cannot interleave between `reset.ts` (DROP)
* and `seed.ts` (TRUNCATE+insert) and collide on `invoices_pkey`.
*
* Why this matters: `seed.ts` derives every primary key from a single
* shared Mulberry32 PRNG seeded with 42 (see `createPrng(42)` and
* `uuid()` in seed.ts). Two concurrent same-profile seeders therefore
* emit *identical* ids for the same logical row, and any moment
* between a concurrent `seed.ts` TRUNCATE and INSERT is exactly the
* window in which the second seeder's INSERT can hit a pkey already
* taken by the first. Pre-GRO-2123 this raced unconditionally;
* GRO-2123 added the advisory lock around `runSeedBody` but left
* `reset.ts` and `drizzle-kit migrate` outside the lock. This script
* now wraps the *whole* chain in the same lock: `withSeedAdvisoryLock`
* pins the lock to one reserved session and the DROP → migrate → seed
* work runs on the rest of the pool, so the lock guarantees mutual
* exclusion against any concurrent seeder for the entire chain.
*
* See: groombook/infra `apps/base/reset-cronjob.yaml` (CronJob) and
* `apps/base/seed-job.yaml` (one-shot Job) — both invoke the same
* `seed.ts` code path on the same database in `groombook-dev`.
*/ */
import postgres from "postgres";
import { drizzle } from "drizzle-orm/postgres-js";
import { migrate } from "drizzle-orm/postgres-js/migrator";
import { fileURLToPath } from "node:url";
import { dirname, resolve } from "node:path";
import * as schema from "./schema.js";
import {
SEED_ADVISORY_LOCK_KEY,
withSeedAdvisoryLock,
getProfile,
runSeedBody,
profiles,
} from "./seed.js";
const __filename = fileURLToPath(import.meta.url); import postgres from "postgres";
const __dirname = dirname(__filename);
const MIGRATIONS_FOLDER = resolve(__dirname, "../migrations");
async function reset() { async function reset() {
const url = process.env.DATABASE_URL; const url = process.env.DATABASE_URL;
@@ -55,88 +16,52 @@ async function reset() {
process.exit(1); process.exit(1);
} }
if ( if (process.env.NODE_ENV === "production" && process.env.ALLOW_RESET !== "true") {
process.env.NODE_ENV === "production" && console.error("[FATAL] db:reset must not be run in production without ALLOW_RESET=true.");
process.env.ALLOW_RESET !== "true"
) {
console.error(
"[FATAL] db:reset must not be run in production without ALLOW_RESET=true.",
);
process.exit(1); process.exit(1);
} }
// Pool sizing is load-bearing here. `withSeedAdvisoryLock` does const client = postgres(url, { max: 1 });
// `pool.reserve()` to pin the advisory lock to one dedicated session
// (a session-level lock released on a *different* pooled connection is
// a no-op), and the DROP / migrate / seed work then runs on the
// *remaining* pooled connections. The lock provides mutual exclusion
// across processes regardless of how many connections the work uses —
// it does NOT require the work to share the lock's session.
//
// Therefore `max` must be ≥ 2: 1 reserved for the lock + ≥1 free for
// the work. `max: 1` would let `reserve()` consume the only connection
// and every query inside the callback would block forever waiting for
// a connection that never frees (connection-starvation deadlock). We
// use `max: 6` to match `seed()`'s headroom (1 reserved + 5 work).
const client = postgres(url, { max: 6 });
const db = drizzle(client, { schema });
try { console.log("Dropping all application tables...\n");
await withSeedAdvisoryLock(client, async () => {
console.log("Dropping all application tables...\n");
// Drop dependencies (tables) first // Drop in dependency order (children before parents)
await client` await client`
DO $$ DECLARE DO $$ DECLARE
r RECORD; r RECORD;
BEGIN BEGIN
FOR r IN ( FOR r IN (
SELECT tablename FROM pg_tables SELECT tablename FROM pg_tables
WHERE schemaname = 'public' WHERE schemaname = 'public'
) LOOP ) LOOP
EXECUTE 'DROP TABLE IF EXISTS public.' || quote_ident(r.tablename) || ' CASCADE'; EXECUTE 'DROP TABLE IF EXISTS public.' || quote_ident(r.tablename) || ' CASCADE';
END LOOP; END LOOP;
END $$; END $$;
`; `;
// Drop custom enums // Drop custom enums
await client` await client`
DO $$ DECLARE DO $$ DECLARE
r RECORD; r RECORD;
BEGIN BEGIN
FOR r IN ( FOR r IN (
SELECT typname FROM pg_type SELECT typname FROM pg_type
WHERE typtype = 'e' AND typnamespace = ( WHERE typtype = 'e' AND typnamespace = (
SELECT oid FROM pg_namespace WHERE nspname = 'public' SELECT oid FROM pg_namespace WHERE nspname = 'public'
) )
) LOOP ) LOOP
EXECUTE 'DROP TYPE IF EXISTS ' || quote_ident(r.typname) || ' CASCADE'; EXECUTE 'DROP TYPE IF EXISTS ' || quote_ident(r.typname) || ' CASCADE';
END LOOP; END LOOP;
END $$; END $$;
`; `;
// Drop the drizzle migrations tracking table // Drop the drizzle migrations tracking table
await client`DROP TABLE IF EXISTS drizzle.__drizzle_migrations CASCADE`; await client`DROP TABLE IF EXISTS drizzle.__drizzle_migrations CASCADE`;
await client`DROP SCHEMA IF EXISTS drizzle CASCADE`; await client`DROP SCHEMA IF EXISTS drizzle CASCADE`;
console.log("✓ All tables and enums dropped\n"); console.log("✓ All tables and enums dropped\n");
console.log("Running migrations..."); await client.end();
await migrate(db, { migrationsFolder: MIGRATIONS_FOLDER });
console.log("✓ Migrations applied\n");
console.log("Seeding database...");
const profile = getProfile();
const cfg = profiles[profile];
await runSeedBody(client, db, profile, cfg);
});
console.log(
`\n✓ Reset complete (advisory lock key=0x${SEED_ADVISORY_LOCK_KEY.toString(16)})`,
);
} finally {
await client.end();
}
} }
reset().catch((err) => { reset().catch((err) => {
+6 -8
View File
@@ -24,9 +24,9 @@ import type { MedicalAlert } from "@groombook/types";
// ── Seed profile configuration ───────────────────────────────────────────── // ── Seed profile configuration ─────────────────────────────────────────────
export type SeedProfile = "dev" | "uat" | "demo"; type SeedProfile = "dev" | "uat" | "demo";
export interface ProfileConfig { interface ProfileConfig {
staffCount: { manager: number; receptionist: number; groomer: number; bather: number }; staffCount: { manager: number; receptionist: number; groomer: number; bather: number };
clientCount: number; clientCount: number;
appointmentsBackDays: number; appointmentsBackDays: number;
@@ -35,7 +35,7 @@ export interface ProfileConfig {
includeUatClients: boolean; includeUatClients: boolean;
} }
export const profiles: Record<SeedProfile, ProfileConfig> = { const profiles: Record<SeedProfile, ProfileConfig> = {
dev: { dev: {
staffCount: { manager: 1, receptionist: 1, groomer: 2, bather: 0 }, staffCount: { manager: 1, receptionist: 1, groomer: 2, bather: 0 },
clientCount: 100, clientCount: 100,
@@ -70,8 +70,6 @@ function getProfile(): SeedProfile {
return "uat"; return "uat";
} }
export { getProfile };
// ── Deterministic PRNG (Mulberry32) ────────────────────────────────────────── // ── Deterministic PRNG (Mulberry32) ──────────────────────────────────────────
/** /**
@@ -1196,7 +1194,7 @@ async function seedKnownUsers() {
// from runbooks without ambiguity and binds to the single-argument // from runbooks without ambiguity and binds to the single-argument
// `pg_advisory_lock(int)` form, which postgres-js serializes as a plain // `pg_advisory_lock(int)` form, which postgres-js serializes as a plain
// number (no bigint type plumbing required). // number (no bigint type plumbing required).
export const SEED_ADVISORY_LOCK_KEY = 0x47524f4f; // "GROO" in ASCII — arbitrary, stable const SEED_ADVISORY_LOCK_KEY = 0x47524f4f; // "GROO" in ASCII — arbitrary, stable
/** /**
* Reserve a dedicated connection from `pool`, take the seed advisory lock * Reserve a dedicated connection from `pool`, take the seed advisory lock
@@ -1209,7 +1207,7 @@ export const SEED_ADVISORY_LOCK_KEY = 0x47524f4f; // "GROO" in ASCII — arbitra
* for the lock and release it from the same reserved connection. The * for the lock and release it from the same reserved connection. The
* seed work itself still runs on the pooled connections. * seed work itself still runs on the pooled connections.
*/ */
export async function withSeedAdvisoryLock<T>( async function withSeedAdvisoryLock<T>(
pool: ReturnType<typeof postgres>, pool: ReturnType<typeof postgres>,
fn: () => Promise<T>, fn: () => Promise<T>,
): Promise<T> { ): Promise<T> {
@@ -1267,7 +1265,7 @@ async function seed() {
await client.end(); await client.end();
} }
export async function runSeedBody( async function runSeedBody(
client: ReturnType<typeof postgres>, client: ReturnType<typeof postgres>,
db: ReturnType<typeof drizzle>, db: ReturnType<typeof drizzle>,
profile: SeedProfile, profile: SeedProfile,
+2 -26
View File
@@ -57,23 +57,6 @@ const createPetSchema = z.object({
customFields: z.record(z.string(), z.string()).optional(), customFields: z.record(z.string(), z.string()).optional(),
petSizeCategory: z.enum(["small", "medium", "large", "extra_large"]).optional(), petSizeCategory: z.enum(["small", "medium", "large", "extra_large"]).optional(),
coatType: z.enum(["short", "medium", "long", "double", "wire", "silky", "curly", "hairless"]).optional(), coatType: z.enum(["short", "medium", "long", "double", "wire", "silky", "curly", "hairless"]).optional(),
// Extended pet profile fields (api/#39, GRO-1178).
// GRO-2172: these were missing from the schema, causing POST/PATCH to
// silently drop them even though migrations 0034/0036 and seed data
// populate them. GRO-1472 was the original UAT regression.
temperamentScore: z.number().int().min(1).max(5).optional(),
temperamentFlags: z.array(z.string().max(100)).max(20).optional(),
medicalAlerts: z
.array(
z.object({
type: z.string().max(100),
description: z.string().max(1000),
severity: z.enum(["low", "medium", "high"]),
})
)
.max(50)
.optional(),
preferredCuts: z.array(z.string().max(200)).max(20).optional(),
}); });
const updatePetSchema = createPetSchema.partial().omit({ clientId: true }); const updatePetSchema = createPetSchema.partial().omit({ clientId: true });
@@ -350,8 +333,7 @@ petsRouter.get("/:id/profile-summary", async (c) => {
petsRouter.post("/", zValidator("json", createPetSchema), async (c) => { petsRouter.post("/", zValidator("json", createPetSchema), async (c) => {
const db = getDb(); const db = getDb();
const { weightKg, dateOfBirth, customFields, medicalAlerts, ...rest } = const { weightKg, dateOfBirth, customFields, ...rest } = c.req.valid("json");
c.req.valid("json");
const [row] = await db const [row] = await db
.insert(pets) .insert(pets)
.values({ .values({
@@ -359,10 +341,6 @@ petsRouter.post("/", zValidator("json", createPetSchema), async (c) => {
weightKg: weightKg?.toString(), weightKg: weightKg?.toString(),
dateOfBirth: dateOfBirth ? new Date(dateOfBirth) : undefined, dateOfBirth: dateOfBirth ? new Date(dateOfBirth) : undefined,
customFields: customFields ?? {}, customFields: customFields ?? {},
// GRO-2172: medicalAlerts shape from the API request is
// { type, description, severity } — the @groombook/types MedicalAlert
// has an optional server-generated `id`, so cast for the jsonb column.
medicalAlerts: medicalAlerts as never,
}) })
.returning(); .returning();
return c.json(row, 201); return c.json(row, 201);
@@ -373,8 +351,7 @@ petsRouter.patch(
zValidator("json", updatePetSchema), zValidator("json", updatePetSchema),
async (c) => { async (c) => {
const db = getDb(); const db = getDb();
const { weightKg, dateOfBirth, customFields, medicalAlerts, ...rest } = const { weightKg, dateOfBirth, customFields, ...rest } = c.req.valid("json");
c.req.valid("json");
const [row] = await db const [row] = await db
.update(pets) .update(pets)
.set({ .set({
@@ -382,7 +359,6 @@ petsRouter.patch(
weightKg: weightKg?.toString(), weightKg: weightKg?.toString(),
dateOfBirth: dateOfBirth ? new Date(dateOfBirth) : undefined, dateOfBirth: dateOfBirth ? new Date(dateOfBirth) : undefined,
...(customFields !== undefined ? { customFields } : {}), ...(customFields !== undefined ? { customFields } : {}),
medicalAlerts: medicalAlerts as never,
updatedAt: new Date(), updatedAt: new Date(),
}) })
.where(eq(pets.id, c.req.param("id"))) .where(eq(pets.id, c.req.param("id")))