Compare commits

...

55 Commits

Author SHA1 Message Date
Flea Flicker 7c6346c799 docs(uat): add TC-API-3.30 schema-safe reset verification (GRO-2722)
CI / Lint & Typecheck (pull_request) Successful in 21s
CI / Test (pull_request) Successful in 23s
CI / Build & Push Docker Images (pull_request) Successful in 1m12s
UAT_PLAYBOOK.md §3 — new test case TC-API-3.30:
trigger reset-demo-data CronJob manually, confirm job succeeds,
public tables/enums and drizzle schema survive, demo data reseeded,
/api/readyz stays 200.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-16 13:14:40 +00:00
Flea Flicker 7af16ee4e6 fix(db): replace DROP-based reset with TRUNCATE RESTART IDENTITY CASCADE
GRO-2722: packages/db/src/reset.ts and apps/api/src/db/reset.ts no longer
emit any DROP TABLE / DROP TYPE / DROP SCHEMA / DROP DATABASE DDL. The four
destructive DO-blocks are replaced with a single:

  TRUNCATE <all public tables> RESTART IDENTITY CASCADE

Table names are enumerated dynamically via pg_tables WHERE schemaname='public'
so new tables are picked up automatically. The drizzle schema and
__drizzle_migrations table are untouched (different schema), keeping
drizzle-kit migrate a no-op on an already-migrated DB.

Preserves: production guard (NODE_ENV=production && ALLOW_RESET!='true'),
advisory lock, migrations (drizzle-kit migrate), and seed (runSeedBody).

Fixes the GRO-2678 prod outage root cause.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-16 13:13:29 +00:00
Flea Flicker 413849f066 fix(auth): add /api/readyz to auth bypass list (GRO-2692)
CI / Lint & Typecheck (push) Successful in 19s
CI / Test (push) Successful in 21s
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 20s
CI / Build & Push Docker Images (pull_request) Successful in 26s
CI / Build & Push Docker Images (push) Successful in 49s
CI passed (run #4322). Self-merging Phase 1 per SDLC gate.
2026-08-09 10:15:45 +00:00
Flea Flicker 9227cf4883 fix(api): add /api/readyz to authMiddleware bypass (GRO-2687 UAT fix)
CI / Test (push) Successful in 19s
CI / Lint & Typecheck (push) Successful in 24s
CI / Lint & Typecheck (pull_request) Successful in 20s
CI / Test (pull_request) Successful in 25s
CI / Build & Push Docker Images (push) Successful in 58s
CI / Build & Push Docker Images (pull_request) Successful in 29s
2026-08-09 09:54:35 +00:00
Flea Flicker 7dfa1ad830 fix(auth): add /api/readyz to auth middleware bypass list (GRO-2692)
CI / Lint & Typecheck (pull_request) Successful in 24s
CI / Test (pull_request) Successful in 35s
CI / Build & Push Docker Images (pull_request) Successful in 1m19s
/api/readyz is a public monitoring endpoint like /api/health.
app.basePath("/api") + api.use("*", authMiddleware) applies to all
/api/* paths regardless of route registration order (GRO-2692 UAT
failure: Hono basePath middleware bypass).

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-09 09:53:19 +00:00
Flea Flicker 8f5a069e77 fix(api): add /api/readyz to authMiddleware bypass list (GRO-2687)
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 21s
CI / Build & Push Docker Images (pull_request) Successful in 55s
/api/readyz was returning 401 Unauthorized in UAT (GRO-2692 Shedward
regression). The authMiddleware for /api/* did not whitelist /api/readyz,
causing every unauthenticated probe request to be rejected.

Add /api/readyz to the bypass condition alongside /api/auth/* and
/api/health. Add readyz-auth-bypass.test.ts confirming the route passes
through the middleware without auth and that non-whitelisted paths still
block (503 when auth not configured).

Closes GRO-2692 regression (UAT fail).
2026-08-09 09:52:37 +00:00
Flea Flicker 07717afd01 revert(api): remove /health/ready — superseded by /api/readyz (GRO-2689)
CI / Lint & Typecheck (push) Successful in 19s
CI / Test (push) Successful in 21s
CI / Build & Push Docker Images (push) Successful in 43s
2026-08-09 09:50:43 +00:00
Flea Flicker d8f6981be1 revert(api): remove /health/ready — superseded by /api/readyz (GRO-2689)
CI / Lint & Typecheck (pull_request) Successful in 18s
CI / Test (pull_request) Successful in 25s
CI / Build & Push Docker Images (pull_request) Successful in 53s
CTO architectural ruling (PR #235 review): K8s readiness/liveness probes
must remain DB-less to prevent transient DB blips from cycling pods. The
/api/readyz endpoint (GRO-2687) is the canonical DB-health signal for the
monitoring layer and satisfies the GRO-2678 detection-gap requirement.

Removes:
- GET /health/ready route from src/index.ts
- src/__tests__/health-ready.test.ts

Refs GRO-2689, GRO-2687, GRO-2678
2026-08-09 09:48:10 +00:00
Flea Flicker d7bb314087 feat(api): add DB-touching /health/ready readiness probe (GRO-2678)
CI / Lint & Typecheck (push) Successful in 19s
CI / Test (push) Successful in 21s
CI / Build & Push Docker Images (push) Successful in 34s
CI / Build & Push Docker Images (pull_request) Successful in 23s
CI / Lint & Typecheck (pull_request) Successful in 20s
CI / Test (pull_request) Successful in 21s
2026-08-09 09:26:17 +00:00
Flea Flicker 7679fada0a feat(api): add DB-touching /health/ready readiness probe (GRO-2678)
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 21s
CI / Build & Push Docker Images (pull_request) Successful in 3m25s
Register GET /health/ready before the /api/* auth middleware so it is
public and reachable by K8s readinessProbe on port 3000 without auth.
On success → 200 {"status":"ready"}; on any DB/schema failure → 503
{"status":"degraded"}. Logs the pg error code; never leaks SQL in body.
A dropped schema (42P01) surfaces as non-200, closing the /health mask
that allowed the GRO-2678 incident to go undetected for ~43h.

Add health-ready.test.ts covering the 200 success path, 503 on schema
drop (42P01), and 503 on connection error; all assert no SQL leakage.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-09 09:21:56 +00:00
Flea Flicker a164c24e8e feat(api): add DB-touching /api/readyz so schema loss cannot hide behind /health (GRO-2678)
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 21s
CI / Build & Push Docker Images (pull_request) Successful in 31s
CI / Lint & Typecheck (push) Successful in 20s
CI / Test (push) Successful in 22s
CI / Build & Push Docker Images (push) Successful in 34s
2026-08-09 09:11:35 +00:00
Flea Flicker 6148ae6439 ci: retrigger after seed-image registry push flake
CI / Lint & Typecheck (pull_request) Successful in 17s
CI / Test (pull_request) Successful in 19s
CI / Build & Push Docker Images (pull_request) Successful in 46s
Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-09 09:10:10 +00:00
Flea Flicker f54a13fc8a feat(api): add DB-touching /api/readyz so schema loss cannot hide behind /health (GRO-2678)
CI / Test (pull_request) Failing after 30s
CI / Lint & Typecheck (pull_request) Successful in 2m31s
CI / Build & Push Docker Images (pull_request) Has been skipped
- Register GET /api/readyz after /api/health in src/index.ts (before authMiddleware)
- Runs `getDb().select({id: staff.id}).from(staff).limit(1)` inside try/catch
- Success → 200 {"status":"ready"}; failure → 503 {"status":"degraded","check":"db"}
- Raw driver error is console.error'd but never leaked to the response body
- /health and /api/health are unchanged (K8s probes remain DB-less per CTO decision)
- New unit tests: mock getDb to resolve → assert 200/ready; throw → assert 503/degraded
- Updated UAT_PLAYBOOK.md §4.0 with TC-API-0.2 and TC-API-0.3

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-09 09:02:39 +00:00
Flea Flicker f7f90a71fc fix(GRO-2672): use drizzle-kit migrate in reset.ts to bypass HWM bug
CI / Lint & Typecheck (push) Successful in 20s
CI / Test (push) Successful in 21s
CI / Build & Push Docker Images (push) Successful in 37s
CI / Test (pull_request) Successful in 20s
CI / Lint & Typecheck (pull_request) Successful in 37s
CI / Build & Push Docker Images (pull_request) Successful in 42s
drizzle-orm's migrate() has a high-water-mark (HWM) bug: on a fresh DB,
migration 0000 sets the watermark to 2026-03-17. Migrations 0001, 0003,
0010, 0011 have stale 2025-era `when` timestamps and are silently
skipped. Migration 0003 (recurring_series) is the blocker — its skip
leaves `recurring_series`, `appointments.series_id`, and
`appointments.series_index` missing. A downstream migration inside
migrate()'s single Postgres transaction then fails, rolling back
everything including 0000's `staff` and `services` tables.

Replace the drizzle-orm migrate() call with `pnpm exec drizzle-kit
migrate` (hash-based). drizzle-kit applies every unhashed migration
regardless of `when` ordering, matching the K8s migrate Job exactly.
2026-08-06 09:14:55 +00:00
Flea Flicker f1b0a53520 test(GRO-2652): stub fetch in auth tests to fix OIDC discovery timeout flake
CI / Lint & Typecheck (push) Successful in 19s
CI / Test (push) Successful in 22s
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 20s
CI / Build & Push Docker Images (pull_request) Successful in 52s
CI / Build & Push Docker Images (push) Successful in 1m45s
AbortSignal.timeout(5000) in initAuth's discovery fetch races with
vitest's 5000ms default test timeout, causing intermittent failures on CI push
runs. Stub fetch to return ok:false instantly so tests complete in <1s.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 10:04:31 +00:00
Flea Flicker f32e9a6889 fix(GRO-2652): reset authInitPromise on failure so retry loop actually retries
CI / Lint & Typecheck (push) Successful in 20s
CI / Test (push) Failing after 21s
CI / Build & Push Docker Images (push) Has been skipped
CI / Lint & Typecheck (pull_request) Successful in 18s
CI / Test (pull_request) Failing after 25s
CI / Build & Push Docker Images (pull_request) Has been skipped
Merging Phase 1 fix — CI all green (lint, test, build all success). Resolves QA's retry-memoization concern from PR #223 review.
2026-08-05 10:00:12 +00:00
Flea Flicker a1b27b5501 fix(GRO-2652): reset authInitPromise on failure so retry loop actually retries
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 21s
CI / Build & Push Docker Images (pull_request) Successful in 53s
Previously the initAuth() function set authInitPromise to the async IIFE's
Promise but never cleared it on rejection. The index.ts retry loop called
initAuth() up to 10 times, but on attempt 2+ the check
`if (authInitPromise) { await authInitPromise; return; }` would immediately
re-throw the original rejection without performing a real retry.

Fix: wrap the final `await authInitPromise` in try/catch and reset
authInitPromise = null on error. This allows the index.ts retry loop to
create a fresh attempt on each call after a failure.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 09:52:31 +00:00
Flea Flicker ae0ce3824f fix(GRO-2652): reset authInitPromise on failure so retry loop actually retries
CI / Lint & Typecheck (pull_request) Failing after 10s
CI / Test (pull_request) Failing after 24s
CI / Build & Push Docker Images (pull_request) Has been skipped
Previously the initAuth() function set authInitPromise to the async IIFE's
Promise but never cleared it on rejection. The index.ts retry loop called
initAuth() up to 10 times, but on attempt 2+ the check
`if (authInitPromise) { await authInitPromise; return; }` would immediately
re-throw the original rejection without performing a real retry.

Fix: wrap the final `await authInitPromise` in try/catch and reset
authInitPromise = null on error. This allows the index.ts retry loop to
create a fresh attempt on each call after a failure.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 09:44:12 +00:00
Flea Flicker f98c5ccaf7 fix(GRO-2652): restore ci.yml from double-base64 corruption + UAT_PLAYBOOK §4.20 clients-from-auth
CI / Lint & Typecheck (push) Successful in 21s
CI / Test (pull_request) Successful in 21s
CI / Lint & Typecheck (pull_request) Successful in 34s
CI / Test (push) Failing after 40s
CI / Build & Push Docker Images (push) Has been skipped
CI / Build & Push Docker Images (pull_request) Successful in 27s
2026-08-05 09:29:16 +00:00
Flea Flicker 61f23e47f1 docs(GRO-2359): add UAT_PLAYBOOK §4.20 clients-from-auth test cases
CI / Lint & Typecheck (pull_request) Successful in 19s
CI / Test (pull_request) Successful in 21s
CI / Build & Push Docker Images (pull_request) Successful in 1m9s
Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 09:20:03 +00:00
Flea Flicker ab5f08e4c0 fix(GRO-2652): restore ci.yml from double-base64 corruption; fix outpuds typo
Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 09:19:55 +00:00
gb_flea 5accf73363 ci: trigger CI for dev branch (PR-223 dev→uat) 2026-08-05 09:04:17 +00:00
Flea Flicker 299a157561 fix(GRO-2652): boot ECONNRESET resilience — retry-with-backoff in initAuth, server-first startup
Merges feature/GRO-2652-boot-econnreset-resilience into dev. CI passed (run #440). Fixes PROD CrashLoopBackOff caused by bare top-level await initAuth() + unhandled ECONNRESET in auth_provider_config DB query.
2026-08-05 09:01:12 +00:00
gb_flea af1af5c211 ci: trigger CI run for ignore-error=true cache-to fix 2026-08-05 08:56:30 +00:00
Flea Flicker 713e8bf415 ci: add ignore-error=true to all cache-to targets
Gitea OCI registry sporadically rejects cache blob writes with
"error writing layer blob: unknown" — this fails the build step
even though the image itself was pushed successfully. Adding
ignore-error=true makes cache write failures non-fatal so the
build proceeds regardless of registry-side cache issues.

Fixes recurring CI failure on Build and push Seed image step.
2026-08-05 08:54:00 +00:00
Flea Flicker 8d42bfffc9 test(GRO-2652): add boot resilience UAT test cases (TC-API-19.x)
CI / Test (pull_request) Successful in 25s
CI / Lint & Typecheck (pull_request) Successful in 28s
CI / Build & Push Docker Images (pull_request) Successful in 56s
New section 4.19 verifies:
- /health available before initAuth completes
- auth routes return 503 (not crash) during init retry window
- pod restart count stays stable after deploy
- retry log lines emitted correctly
- auth recovers after transient DB hiccup

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 08:22:00 +00:00
Flea Flicker 095efb1cca fix(GRO-2652): start server before initAuth; retry auth init on ECONNRESET
Previously: await initAuth() was a top-level ESM await. Any boot-time
ECONNRESET from Postgres propagated as an uncaught module-evaluation
error and killed the process before the server even started.

Now:
- serve() starts immediately so /health and public routes are available
- initAuth() runs in a retry loop (up to 10 attempts, exponential
  500 ms → 30 s); a permanent failure degrades to 503 on auth routes
  (existing catch-to-503 in authRouter) rather than crashing the pod

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 08:21:14 +00:00
Flea Flicker 632dadd064 fix(GRO-2652): retry DB query in initAuth on transient ECONNRESET
The auth_provider_config DB query at boot has no error handling;
a transient ECONNRESET causes authInitPromise to reject, propagating
to the top-level await initAuth() and crashing the process (exit 1).

Add up to 5 retry attempts with exponential backoff (1 s, 2 s, 4 s, 8 s)
so a single connection reset does not abort initialization.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-08-05 08:17:31 +00:00
Flea Flicker dace2c4e66 fix(GRO-2586): enforce trusted-origins allowlist on Better Auth CORS responses (#219)
CI / Lint & Typecheck (push) Successful in 19s
CI / Test (push) Successful in 21s
CI / Build & Push Docker Images (push) Successful in 1m4s
fix(GRO-2586): enforce trusted-origins allowlist on Better Auth CORS responses

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-26 13:35:59 +00:00
Flea Flicker c01e4acf0a feat(GRO-2425): split CORS_ORIGIN on commas for multiple trusted auth origins (#216)
CI / Test (push) Successful in 30s
CI / Lint & Typecheck (push) Successful in 45s
CI / Build & Push Docker Images (push) Successful in 1m10s
CI / Test (pull_request) Successful in 25s
CI / Lint & Typecheck (pull_request) Failing after 12m18s
CI / Build & Push Docker Images (pull_request) Has been skipped
feat(GRO-2425): split CORS_ORIGIN on commas for multiple trusted auth origins

Co-authored-by: Flea Flicker <flea@groombook.dev>
Co-committed-by: Flea Flicker <flea@groombook.dev>
2026-06-18 00:46:29 +00:00
Flea Flicker 10b78d810d Merge pull request 'feat(GRO-2359): add POST /api/portal/clients-from-auth for OOBE' (#212) from feature/2357-p2-portal-clients-from-auth into dev
CI / Test (push) Successful in 26s
CI / Lint & Typecheck (push) Successful in 32s
CI / Build & Push Docker Images (push) Successful in 41s
GRO-2359 (api): feat(GRO-2359): add POST /api/portal/clients-from-auth for OOBE (#212)
2026-06-11 16:34:34 +00:00
Flea Flicker cdeebec021 feat(GRO-2359): add POST /api/portal/clients-from-auth for OOBE (web)
CI / Test (pull_request) Successful in 29s
CI / Lint & Typecheck (pull_request) Successful in 41s
CI / Build & Push Docker Images (pull_request) Successful in 1m40s
The OOBE flow on the web portal calls this endpoint to create a fresh
`clients` row bound to the Better Auth user's email when the SSO
bridge returns 404. Returns 201 on success, 409 if a client with that
email already exists (portal-selection case), 401/503 on auth issues,
400 on invalid body.

The OOBE success path navigates the user back to `/` and lets the
existing `session-from-auth` re-bridge; the new client is now
resolvable by email, so the bridge mints a real portal session.

Tests cover: 401 (no session), 400 (zod), 201 + persisted values
(name trimmed, optional fields normalized to null), 409 (existing
client or unique-constraint race), 503 (auth not configured).

Paired with the web PR on `feature/2357-p2-sso-to-oobe-routing`.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-11 16:17:16 +00:00
Flea Flicker 1d6b906202 Merge pull request 'fix(GRO-2342): portal waitlist card populates service {id, name}' (#208) from feat/GRO-2342-portal-waitlist-servicename into dev
CI / Test (push) Successful in 28s
CI / Lint & Typecheck (push) Successful in 29s
CI / Build & Push Docker Images (push) Successful in 33s
2026-06-10 09:13:55 +00:00
Flea Flicker 277f459237 fix(GRO-2342): portal waitlist card populates service {id, name}
CI / Test (pull_request) Successful in 26s
CI / Lint & Typecheck (pull_request) Successful in 29s
CI / Build & Push Docker Images (pull_request) Successful in 1m15s
Cosmetic follow-up to GRO-2319 (Phase 4 review by CTO). The synthetic
waitlist card on GET /portal/appointments returned service: {id} only,
so the portal fell back to the literal 'Service' label. CMPO spec did
not call for a service name on the waitlist card, but populating the
real name is non-urgent and closes the cosmetic gap.

- src/routes/portal.ts: include a services SELECT (in addition to
  pets and staff) covering both appointment and waitlist serviceIds.
  serviceMap feeds a service.name lookup. The synthetic waitlist
  card's service object is now {id, name} — same shape the
  appointments join returns — so the portal renders the real name.
  The appointments join also gains a name (consistent shape, no
  regression for the existing path).
- src/__tests__/portal.test.ts: mock the services table and assert
  service: {id, name} on both the synthetic waitlist card and the
  appointment card.
- UAT_PLAYBOOK.md: TC-API-8.20 covering the waitlist card service
  name (TC-API-8.19 retained verbatim for the original GRO-2319
  surfacing contract).

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-10 09:11:08 +00:00
Flea Flicker ef18ed7376 feat(GRO-2319): surface active waitlist entries on portal appointments + seed (#204)
CI / Test (push) Successful in 28s
CI / Lint & Typecheck (push) Successful in 33s
CI / Build & Push Docker Images (push) Successful in 45s
2026-06-09 10:41:08 +00:00
Flea Flicker d61607f4c5 feat(seed): seed upcoming appointments across statuses for UAT portal customer (GRO-2311) (#201)
CI / Test (push) Successful in 31s
CI / Lint & Typecheck (push) Successful in 2m35s
CI / Build & Push Docker Images (push) Successful in 1m25s
2026-06-09 09:53:04 +00:00
Flea Flicker 2853ce73a5 GRO-2172: add missing extended pet fields to create/update schemas (#199)
CI / Lint & Typecheck (push) Successful in 1m13s
CI / Test (push) Successful in 2m31s
CI / Build & Push Docker Images (push) Successful in 35s
2026-06-09 08:56:22 +00:00
Flea Flicker 1e0747324d fix(GRO-2139): serialize reset→migrate→seed under the seed advisory lock (#160)
CI / Test (push) Successful in 24s
CI / Lint & Typecheck (push) Successful in 37s
CI / Build & Push Docker Images (push) Successful in 36s
Serialize the entire db:reset chain (DROP → migrate → seed) inside one withSeedAdvisoryLock callback so a concurrent same-PRNG seeder cannot interleave and collide on invoices_pkey. Pool sized max:6 (1 reserved for the lock + work headroom) to avoid the connection-starvation deadlock the CTO caught. Verified with three end-to-end live db:reset runs against a throwaway Postgres.

cc @cpfarhood
2026-06-09 08:44:58 +00:00
Flea Flicker b4b48f7b50 fix(GRO-2299): redact googleMapsApiKey from PATCH /api/admin/settings response (#195)
CI / Test (push) Successful in 26s
CI / Lint & Typecheck (push) Successful in 30s
CI / Build & Push Docker Images (push) Successful in 38s
2026-06-09 06:52:48 +00:00
Flea Flicker fe412933ea GRO-2294: Route Optimization security hardening (geocode-batch limit cap + redact settings secret) (#193)
CI / Test (push) Successful in 27s
CI / Lint & Typecheck (push) Successful in 35s
CI / Build & Push Docker Images (push) Successful in 38s
2026-06-09 06:17:42 +00:00
Flea Flicker cd2f60e282 feat(GRO-2157): navigation export endpoints (Phase 2.3) (#190)
CI / Test (push) Successful in 24s
CI / Lint & Typecheck (push) Successful in 40s
CI / Build & Push Docker Images (push) Successful in 26s
2026-06-09 00:16:42 +00:00
Flea Flicker 6702086c7b fix(GRO-2235): return 409 on duplicate portal waitlist submit (#189)
CI / Test (push) Failing after 14m19s
CI / Lint & Typecheck (push) Failing after 14m19s
CI / Build & Push Docker Images (push) Has been skipped
2026-06-08 23:50:21 +00:00
Flea Flicker 27e6674b9a feat(GRO-2225): UAT seed route cohort + receptionist credential (#187)
CI / Test (push) Successful in 30s
CI / Lint & Typecheck (push) Successful in 32s
CI / Build & Push Docker Images (push) Successful in 45s
2026-06-08 23:15:51 +00:00
Flea Flicker aabedc8152 fix(GRO-2234): bounded sliding expiration for SSO portal sessions (#183)
CI / Test (push) Successful in 28s
CI / Lint & Typecheck (push) Successful in 29s
CI / Build & Push Docker Images (push) Successful in 38s
2026-06-08 18:55:43 +00:00
Flea Flicker ca62fb8ef6 feat(GRO-2156): travel buffer + reorder endpoint (Phase 2.2) (#180)
CI / Test (push) Successful in 27s
CI / Lint & Typecheck (push) Successful in 30s
CI / Lint & Typecheck (pull_request) Successful in 25s
CI / Test (pull_request) Successful in 24s
CI / Build & Push Docker Images (push) Successful in 43s
CI / Build & Push Docker Images (pull_request) Successful in 27s
2026-06-08 18:07:54 +00:00
Flea Flicker 29c42e3130 fix(portal): validate waitlist preferredTime/preferredDate, return 400 on bad input (GRO-2211) (#179)
CI / Test (pull_request) Successful in 26s
CI / Test (push) Successful in 29s
CI / Lint & Typecheck (pull_request) Successful in 31s
CI / Lint & Typecheck (push) Successful in 34s
CI / Build & Push Docker Images (pull_request) Failing after 13s
CI / Build & Push Docker Images (push) Successful in 48s
2026-06-08 17:19:39 +00:00
Flea Flicker b842237425 fix(portal): GRO-2203 validate petId as UUID before PATCH lookup (500→404) (#177)
CI / Lint & Typecheck (push) Successful in 29s
CI / Test (push) Successful in 29s
CI / Lint & Typecheck (pull_request) Failing after 2s
CI / Test (pull_request) Successful in 25s
CI / Build & Push Docker Images (pull_request) Has been skipped
CI / Build & Push Docker Images (push) Successful in 47s
2026-06-08 17:03:44 +00:00
Flea Flicker d0c0b1b646 feat(GRO-2155): route CRUD + optimization endpoint (Phase 2.1) (#175)
CI / Test (push) Successful in 25s
CI / Lint & Typecheck (push) Successful in 28s
CI / Test (pull_request) Successful in 24s
CI / Build & Push Docker Images (push) Successful in 35s
CI / Lint & Typecheck (pull_request) Successful in 26s
CI / Build & Push Docker Images (pull_request) Successful in 25s
2026-06-08 13:57:07 +00:00
Flea Flicker b9fc688769 fix(db): wait for/retry DB DNS resolution before drizzle-kit migrate (GRO-2163) (#161)
CI / Test (push) Successful in 28s
CI / Lint & Typecheck (push) Successful in 31s
CI / Build & Push Docker Images (push) Successful in 47s
2026-06-08 13:37:30 +00:00
Flea Flicker 14d7889ec0 fix(portal): drop writable photoKey from PATCH /portal/pets — S3 key-hijack (GRO-2187/GRO-2198) (#172)
CI / Test (push) Successful in 24s
CI / Lint & Typecheck (push) Successful in 26s
CI / Build & Push Docker Images (push) Successful in 29s
CI / Lint & Typecheck (pull_request) Successful in 24s
CI / Test (pull_request) Successful in 30s
CI / Build & Push Docker Images (pull_request) Successful in 44s
2026-06-08 12:39:02 +00:00
Flea Flicker 582c376df9 feat(GRO-2154): geocoding endpoints + auto-geocode on client mutations (#170)
CI / Test (push) Successful in 28s
CI / Test (pull_request) Successful in 23s
CI / Lint & Typecheck (pull_request) Successful in 26s
CI / Build & Push Docker Images (pull_request) Successful in 25s
CI / Lint & Typecheck (push) Failing after 14m33s
CI / Build & Push Docker Images (push) Has been skipped
2026-06-08 11:45:08 +00:00
Flea Flicker eec198a661 fix(ci): GRO-2197 api lint/typecheck/test run root scripts (de-false-green) (#169)
CI / Test (push) Successful in 25s
CI / Lint & Typecheck (push) Successful in 30s
CI / Build & Push Docker Images (push) Successful in 3m23s
2026-06-08 11:09:33 +00:00
Flea Flicker 04b235c861 Merge pull request 'feat(GRO-2153): abstracted geocoding service (Nominatim + Google)' (#167) from feat/gro-2153-geocoding-service-dev into dev
CI / Test (push) Failing after 13m50s
CI / Lint & Typecheck (push) Failing after 13m50s
CI / Build & Push Docker Images (push) Has been skipped
CI / Test (pull_request) Successful in 11s
CI / Lint & Typecheck (pull_request) Successful in 16s
CI / Build & Push Docker Images (pull_request) Successful in 3m45s
2026-06-08 09:40:52 +00:00
Flea Flicker 21fb1b30d2 ci: retrigger build (registry layer-pull hang on prior run)
CI / Test (pull_request) Failing after 14m1s
CI / Lint & Typecheck (pull_request) Failing after 14m1s
CI / Build & Push Docker Images (pull_request) Has been skipped
Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-08 09:40:42 +00:00
Flea Flicker 2fa6e3d87b feat(GRO-2153): abstracted geocoding service (Nominatim + Google)
CI / Test (pull_request) Successful in 13s
CI / Lint & Typecheck (pull_request) Successful in 20s
CI / Build & Push Docker Images (pull_request) Failing after 27m22s
Phase 1.2 of Route Optimization. Adds a provider-agnostic geocoding
service layer in the deployed src/ tree:

- GeocodingProvider interface + GeocodeResult type
- NominatimGeocodingProvider (default, free, self-hostable) with an
  internal rate limiter enforcing the 1 req/sec Nominatim usage policy
- GoogleGeocodingProvider (optional fallback) keyed by the encrypted
  businessSettings.googleMapsApiKey (decrypted via decryptSecret) or
  GOOGLE_MAPS_API_KEY env fallback
- resolveGeocodingProvider() selecting on businessSettings.routeOptimizationProvider,
  with safe fallback to Nominatim when google is configured but no usable key
- geocodeBatch() throttled batch utility (honors provider rate limit,
  captures per-item errors, optional progress callback)
- 20 unit tests covering both providers, selection, throttle spacing, and batch

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-06-08 09:01:36 +00:00
41 changed files with 5451 additions and 161 deletions
+8 -7
View File
@@ -33,11 +33,11 @@ jobs:
- name: Typecheck
run: |
pnpm --filter @groombook/api typecheck
pnpm run typecheck
pnpm --filter @groombook/db typecheck
- name: Lint
run: pnpm --filter @groombook/api lint
run: pnpm run lint
test:
name: Test
@@ -58,7 +58,7 @@ jobs:
run: pnpm install --frozen-lockfile
- name: Run tests
run: pnpm --filter @groombook/api test
run: pnpm run test
docker:
name: Build & Push Docker Images
@@ -102,7 +102,7 @@ jobs:
git.farh.net/groombook/api:${{ steps.version.outputs.tag }}
${{ github.ref == 'refs/heads/main' && 'git.farh.net/groombook/api:latest' || '' }}
cache-from: type=registry,ref=git.farh.net/groombook/cache:api
cache-to: type=registry,ref=git.farh.net/groombook/cache:api,mode=max
cache-to: type=registry,ref=git.farh.net/groombook/cache:api,mode=max,ignore-error=true
- name: Build and push Migrate image
uses: docker/build-push-action@v6
@@ -116,7 +116,7 @@ jobs:
git.farh.net/groombook/migrate:${{ steps.version.outputs.tag }}
${{ github.ref == 'refs/heads/main' && 'git.farh.net/groombook/migrate:latest' || '' }}
cache-from: type=registry,ref=git.farh.net/groombook/cache:migrate
cache-to: type=registry,ref=git.farh.net/groombook/cache:migrate,mode=max
cache-to: type=registry,ref=git.farh.net/groombook/cache:migrate,mode=max,ignore-error=true
- name: Smoke test migrate image (blackhole npmjs.org)
run: |
@@ -141,7 +141,7 @@ jobs:
git.farh.net/groombook/seed:${{ steps.version.outputs.tag }}
${{ github.ref == 'refs/heads/main' && 'git.farh.net/groombook/seed:latest' || '' }}
cache-from: type=registry,ref=git.farh.net/groombook/cache:seed
cache-to: type=registry,ref=git.farh.net/groombook/cache:seed,mode=max
cache-to: type=registry,ref=git.farh.net/groombook/cache:seed,mode=max,ignore-error=true
- name: Build and push Reset image
uses: docker/build-push-action@v6
@@ -155,7 +155,7 @@ jobs:
git.farh.net/groombook/reset:${{ steps.version.outputs.tag }}
${{ github.ref == 'refs/heads/main' && 'git.farh.net/groombook/reset:latest' || '' }}
cache-from: type=registry,ref=git.farh.net/groombook/cache:reset
cache-to: type=registry,ref=git.farh.net/groombook/cache:reset,mode=max
cache-to: type=registry,ref=git.farh.net/groombook/cache:reset,mode=max,ignore-error=true
- name: Smoke test seed image (blackhole npmjs.org)
run: |
@@ -185,3 +185,4 @@ jobs:
"$IMAGE" \
sh -c 'set -e; test "$(which pnpm)" = "/usr/local/bin/pnpm"; echo "HOME=$HOME"; pnpm --version'
echo "reset image: pnpm resolves to /usr/local/bin/pnpm, HOME=/tmp, runs offline ✓"
+11
View File
@@ -0,0 +1,11 @@
{
"mcpServers": {
"gitea": {
"type": "http",
"url": "https://git-mcp.farh.net/mcp",
"headers": {
"Authorization": "Bearer ${GITEA_TOKEN}"
}
}
}
}
+138 -2
View File
@@ -65,8 +65,11 @@ Expected: one row, `role = 'groomer'`. If zero rows return, the request hit the
| # | Scenario | Steps | Expected |
|---|----------|-------|----------|
| TC-API-0.1 | Unauthenticated health check | GET /api/health | 200 OK, `{"status":"ok"}` |
| TC-API-0.2 | DB-touching readiness check — healthy (GRO-2678) | GET /api/readyz | 200 OK, `{"status":"ready"}` |
| TC-API-0.3 | DB-touching readiness check — response body safe | GET /api/readyz and inspect body | Body contains only `status` and (on error) `check` fields — no raw SQL, driver messages, or stack traces |
> **Note (GRO-1544):** Health endpoint registered on `api` basePath before auth middleware at `/api/health`. The old path `/health` was incorrect (routed to web pod via HTTPRoute `/*` rule).
> **Note (GRO-2678):** `/api/readyz` is a separate DB-touching endpoint for monitoring. It is intentionally NOT used for K8s liveness/readiness probes — those remain DB-less to avoid pod cycling on transient DB blips.
### 4.1 Authentication
@@ -108,6 +111,11 @@ Expected: one row, `role = 'groomer'`. If zero rows return, the request hit the
| TC-API-1.24 | Complete setup creates super user | POST /api/setup with business name (after TC-API-1.23) | First user becomes super user, setup completes | Setup errors, 403 on admin endpoints |
| TC-API-1.25 | Super user accesses admin features | After TC-API-1.24, GET /api/staff/me and verify isSuperUser: true | isSuperUser: true, admin endpoints accessible | 403 on admin, isSuperUser: false |
| TC-API-1.26 | Auto-provision skipped during OOBE | During fresh setup (needsSetup: true), complete OIDC login — verify no duplicate staff record created before setup completes | No duplicate staff, OOBE completes successfully | Duplicate staff record, 403 before setup, auto-provision interferes with OOBE |
| TC-API-1.27 | Multi-origin CORS — demo host sign-in | `POST /api/auth/sign-in/social` with `callbackURL=https://demo.groombook.dev` | 200 OK, no origin-mismatch error | 400/403 "Origin mismatch" |
| TC-API-1.28 | Multi-origin CORS — farh.net host sign-in | `POST /api/auth/sign-in/social` with `callbackURL=https://groombook.farh.net` | 200 OK, no origin-mismatch error | 400/403 "Origin mismatch" |
| TC-API-1.29 | CORS — untrusted origin blocked (GRO-2586) | POST /api/auth/sign-in/social with `Origin: https://evil.example.com` header | Response has **no** `Access-Control-Allow-Origin` header — attacker origin is not reflected | `Access-Control-Allow-Origin: https://evil.example.com` present in response |
| TC-API-1.30 | CORS — trusted origin allowed (GRO-2586) | POST /api/auth/sign-in/social with `Origin: https://uat.groombook.dev` header | `Access-Control-Allow-Origin: https://uat.groombook.dev` + `Access-Control-Allow-Credentials: true` | CORS header absent or trusted origin rejected |
| TC-API-1.31 | CORS — untrusted preflight blocked (GRO-2586) | `curl -i -X OPTIONS https://uat.groombook.dev/api/auth/sign-in/social -H 'Origin: https://evil.example.com' -H 'Access-Control-Request-Method: POST'` | Response has **no** `Access-Control-Allow-Origin: https://evil.example.com` | Preflight reflects attacker origin |
### 4.2 Client Management
@@ -120,6 +128,25 @@ Expected: one row, `role = 'groomer'`. If zero rows return, the request hit the
| TC-API-2.5 | Disable client | PATCH /api/clients/{id} with status: "disabled" | 200 OK, client marked as disabled |
| TC-API-2.6 | Delete client | DELETE /api/clients/{id}?confirm=true | 200 OK, client deleted (if no appointments) |
#### Client Geocoding — Route Optimization (GRO-2154, Phase 1.3)
Geocoding turns a client's street address into `latitude`/`longitude` + `geocodedAt`. Provider is driven by `businessSettings.routeOptimizationProvider` (default Nominatim/OpenStreetMap, 1 req/sec; optional Google fallback). All explicit geocode endpoints are **manager-only**.
| # | Scenario | Steps | Expected |
|---|----------|-------|----------|
| TC-API-2.7 | Geocode single client (success) | As **manager**, `POST /api/clients/{id}/geocode` for a client with a valid, real address (e.g. a seed client) | 200 OK; body `{ status: "geocoded", latitude, longitude, geocodedAt, formattedAddress, provider }`. Subsequent `GET /api/clients/{id}` shows the same non-null `latitude`/`longitude`/`geocodedAt` persisted |
| TC-API-2.8 | Geocode single client — no address | As manager, `POST /api/clients/{id}/geocode` for a client whose `address` is null/blank | 422; `{ status: "no_address", message: "...no address on file..." }` (clear, actionable) |
| TC-API-2.9 | Geocode single client — unresolvable/ambiguous address | As manager, set a nonsense address (e.g. `"asdkjhqweoui 99999"`) then `POST /api/clients/{id}/geocode` | 422; `{ status: "unresolved", message: "Address could not be resolved..." }` so groomers/managers know to correct it |
| TC-API-2.10 | Geocode single client — not found | As manager, `POST /api/clients/00000000-0000-0000-0000-000000000000/geocode` | 404 `{ error: "Not found" }` |
| TC-API-2.11 | Geocode endpoint is manager-only | As **groomer** or **receptionist**, `POST /api/clients/{id}/geocode` | 403 Forbidden (role not permitted) |
| TC-API-2.12 | Batch geocode un-geocoded clients | As manager, `POST /api/clients/geocode-batch?limit=10` on a DB with un-geocoded clients | 200 OK; body `{ provider, processed, geocoded, unresolved, errors, remaining, outcomes[] }`. `processed` ≤ 10; `remaining` reflects un-geocoded clients beyond this batch. Re-run while `remaining > 0` to finish (throttled to provider rate limit) |
| TC-API-2.13 | Batch geocode — invalid limit | As manager, `POST /api/clients/geocode-batch?limit=0` (or non-numeric) | 400 `{ error: "limit must be a positive integer" }` |
| TC-API-2.13a | Batch geocode — `?limit` cap enforced (GRO-2294) | As manager, `POST /api/clients/geocode-batch?limit=100000` on a DB with un-geocoded clients | 200 OK; the request is **clamped to the documented max of 500**`processed` ≤ 500 (never the raw 100000). A fractional `?limit` (e.g. `49.9`) is floored to `49`. Confirms a manager cannot hold one synchronous request open / accrue unbounded Google API cost via an oversized limit |
| TC-API-2.14 | Batch geocode — manager-only | As groomer/receptionist, `POST /api/clients/geocode-batch` | 403 Forbidden |
| TC-API-2.15 | Auto-geocode on create | As manager/receptionist, `POST /api/clients` with a valid `address` | 201 Created; response includes a `geocoding` object (`status: "geocoded"` for a resolvable address) and the persisted client carries `latitude`/`longitude`/`geocodedAt`. Creating without an address succeeds with no `geocoding` field |
| TC-API-2.16 | Auto-geocode on address update | As manager/receptionist, `PATCH /api/clients/{id}` changing `address` to a new valid value | 200 OK; response includes a `geocoding` object and refreshed coordinates. Patching unrelated fields (e.g. `name`) does NOT re-geocode (no `geocoding` field) |
| TC-API-2.17 | Clearing address drops coordinates | As manager/receptionist, `PATCH /api/clients/{id}` with `address: ""` | 200 OK; `latitude`/`longitude`/`geocodedAt` reset to null (no stale pin) |
### 4.3 Pet Management
| # | Scenario | Steps | Expected |
@@ -147,6 +174,8 @@ Expected: one row, `role = 'groomer'`. If zero rows return, the request hit the
| TC-API-3.19b | Get pet profile summary — customer cross-tenant blocked (GRO-2013) | Sign in as `uat-customer@groombook.dev`; reuse the customer's sessionId from TC-API-3.19a; `GET /api/pets/{otherClientPetId}/profile-summary` for a pet owned by a different client (`c0000002-...` or any non-customer pet) | 403 Forbidden (owner-bypass requires session.clientId === pet.clientId) |
| TC-API-3.19c | Get pet profile summary — customer without portal session header | Same as TC-API-3.19a but omit the `X-Impersonation-Session-Id` header | 403 Forbidden (no owner-bypass without valid portal session) |
| TC-API-3.19d | Get pet profile summary — owner-bypass writes audit row (GRO-2063) | Same setup as TC-API-3.19a (sign in as `uat-customer@groombook.dev`, establish a portal session for the customer's own clientId, call `GET /api/pets/{ownPetId}/profile-summary` with `X-Impersonation-Session-Id: {sessionId}` and a 200 OK response). Then call `GET /api/impersonation/sessions/{sessionId}/audit-log` and confirm there is exactly one entry with `action === "read_profile_summary"`, `pageVisited` matching the profile-summary path, and `metadata` containing `petId` and `actorStaffId` for the customer. Repeat TC-API-3.19b (cross-tenant attempt) and confirm NO new `read_profile_summary` row was written for the cross-tenant attempt. | 200 OK on the profile-summary call AND an audit log entry is present with the correct shape (defense-in-depth audit row; bypass attempts against other clients must NOT log) |
| TC-UAT-2 | Groomer accesses linked pet profile summary (GRO-2100) | Sign in as `uat-groomer@groombook.dev`; `GET /api/pets/c0000001-0000-0000-0000-000000000002/profile-summary` (UAT Pup Alpha — linked via deterministic completed appointment `a0000001-0000-0000-0000-000000000001`, service `b0000001-…-0001` "Bath & Brush", `startTime` ~7 days ago) | 200 OK, `recentGroomingHistory[]` non-empty (>=1 entry), `visitCount >= 1`, `upcomingAppointment` null (the seeded appointment is in the past) |
| TC-UAT-3 | Groomer blocked from unlinked pet profile summary (GRO-2100) | Sign in as `uat-groomer@groombook.dev`; `GET /api/pets/c0000001-0000-0000-0000-000000000003/profile-summary` (UAT Pup Beta — intentionally UNLINKED; no appointment row references this pet's clientId+groomerId combo) | 403 Forbidden (RBAC `groomer` role lacks the appointment-linkage grant for this pet). NOTE: if 404 is returned instead of 403, file a separate RBAC defect (not against the seed) — see GRO-2100 verification note |
| TC-API-3.29 | Get pet profile summary — unknown UUID returns 404 (GRO-2014) | GET /api/pets/00000000-0000-0000-0000-000000000001/profile-summary while authenticated (any role) | 404 Not Found with body `{"error":"Not found"}` (was empty-body 500 in GRO-2014) |
| TC-API-3.30 | Get pet profile summary — malformed UUID returns 404 (GRO-2014) | GET /api/pets/not-a-uuid/profile-summary while authenticated | 404 Not Found with body `{"error":"Not found"}` (was empty-body 500 in GRO-2014 — Postgres uuid cast failure) |
| TC-API-3.31 | Get pet profile summary — never empty-body 500 (GRO-2014) | GET /api/pets/{anyId}/profile-summary across the test sweep | No response has status 500 with an empty body. Any 500 must include a JSON body `{"error":"Internal Server Error"}` |
@@ -167,6 +196,7 @@ Expected: one row, `role = 'groomer'`. If zero rows return, the request hit the
| TC-API-3.27 | Verify coat_type enum has all seed values | After UAT seed completes, inspect the coat_type enum on the UAT DB — it must contain: short, medium, long, double, wire, silky, curly, hairless | UAT seed jobs (`reset-demo-data`, `seed-test-data`) complete 1/1 with no `enum_in` error; coat_type includes all 8 values used by seed.ts `coatTypePool` |
| TC-API-3.28 | Verify pet_size_category enum has all seed values | After UAT seed completes, inspect the pet_size_category enum on the UAT DB — it must contain: small, medium, large, extra_large | UAT seed jobs (`reset-demo-data`, `seed-test-data`) complete 1/1 with no `enum_in` error; pet_size_category includes all 4 values used by seed.ts `petSizeCategoryPool` (regression for GRO-1999, mirrors TC-API-3.27) |
| TC-API-3.29 | Verify `reset-demo-data` CronJob does not fail with FK 23503 on `invoice_tip_splits` (GRO-2123) | Trigger the CronJob manually: `kubectl create job --from=cronjob/reset-demo-data verify-gro2123 -n groombook-uat`. Wait for pod to terminate. Inspect logs: `kubectl logs -n groombook-uat -l job-name=verify-gro2123` | Pod reaches `Completed` state; logs show `✓ Acquired seed advisory lock` and `✓ Released seed advisory lock` from `seed.ts`; no `PostgresError: … violates foreign key constraint "invoice_tip_splits_invoice_id_invoices_id_fk"` (code 23503); final counts unchanged (500 clients, ~4000 invoices) |
| TC-API-3.30 | Verify `reset-demo-data` CronJob is schema-safe — TRUNCATE only, no DDL drops (GRO-2722) | 1. Trigger: `kubectl -n groombook-uat create job --from=cronjob/reset-demo-data reset-verify-$(date +%s) --dry-run=client -o name \| xargs kubectl -n groombook-uat apply -f -` or simply `kubectl -n groombook-uat create job --from=cronjob/reset-demo-data reset-verify-$(date +%s)`. 2. Wait for job completion: `kubectl -n groombook-uat wait job/reset-verify-<ts> --for=condition=complete --timeout=300s`. 3. Check logs: `kubectl -n groombook-uat logs job/reset-verify-<ts>`. 4. Verify schema survival: `kubectl -n groombook-uat exec deploy/api -- psql $DATABASE_URL -c "\dt public.*"` and `kubectl -n groombook-uat exec deploy/api -- psql $DATABASE_URL -c "\dt drizzle.*"`. 5. Verify readyz: `curl -s https://uat.groombook.dev/api/readyz` | Job reaches `Completed` (exit 0); logs show `✓ All public tables truncated, sequences reset` — no `DROP TABLE`/`DROP TYPE`/`DROP SCHEMA` in output; all `public.*` tables still present after reset; `drizzle.__drizzle_migrations` still populated (row count unchanged); `https://uat.groombook.dev/api/readyz` returns HTTP 200; demo data reseeded (500 clients visible via GET /api/clients) |
### 4.4 Appointment Scheduling
@@ -263,6 +293,11 @@ This means:
| TC-API-8.13 | Portal pet update — owner success + persistence (GRO-2187, fixes [GRO-1480](/GRO/issues/GRO-1480) §5.23) | With a portal session for the pet's owner, `PATCH /api/portal/pets/{petId}` with body `{ "name": "...", "breed": "...", "weightKg": 18.25, "healthAlerts": "...", "coatType": "double", "petSizeCategory": "xlarge", "preferredCuts": ["teddy bear"], "medicalAlerts": [{"type":"allergy","description":"oatmeal","severity":"medium"}] }` | 200 OK; response reflects the update with `petSizeCategory: "extra_large"` (web `xlarge` → DB `extra_large`). A follow-up `GET /api/portal/pets` shows the persisted values |
| TC-API-8.14 | Portal pet update — non-owner blocked (GRO-2187) | `PATCH /api/portal/pets/{petId}` for a pet owned by a different client, using another client's portal session | 403 Forbidden (or 404 if pet id is unknown); no mutation persisted |
| TC-API-8.15 | Portal pet update — invalid enum rejected (GRO-2187) | `PATCH /api/portal/pets/{petId}` with `coatType: "fluffy"` or `petSizeCategory: "gigantic"` | 422 Unprocessable Entity; pet unchanged |
| TC-API-8.16 | Portal pet update — malformed (non-UUID) petId returns 404 (GRO-2203) | With a valid portal session, `PATCH /api/portal/pets/not-a-uuid` with header `X-Impersonation-Session-Id` and body `{"coatType":"short"}` | 404 Not Found with body `{"error":"Not found"}` (was an unhandled 500 from the Postgres uuid cast in GRO-2203; mirrors the GRO-2014 guard). No mutation persisted |
| TC-API-8.17 | SSO portal session slides on activity (GRO-2234) | Establish a portal session (TC-API-8.8). Note the returned `sessionId`. Make any authenticated portal call (e.g. `GET /api/portal/me`) several times spaced over ≥1 minute, each with `X-Impersonation-Session-Id: {sessionId}`. | Every call returns 200; the session's `expiresAt` is extended (slid forward to ~30 min from each request) so the session stays valid during continuous use — it does NOT lapse mid-session. SSO-bridge sessions mint with a 30-min idle TTL bounded by an 8h absolute cap from `startedAt`. |
| TC-API-8.18 | Slow-wizard Book New submit succeeds (GRO-2234) | Establish a portal session (TC-API-8.8). Wait >2 minutes while making at least one intervening authenticated portal call (mimicking the multi-step Book New wizard: pet/service/groomer/date GETs). Then `POST /api/portal/waitlist` with a valid pet+service payload and the same `X-Impersonation-Session-Id`. | 201 Created — the deliberately-paced wizard no longer 401s on submit because activity slid the session forward. (Regression guard for the GRO-2234 "session TTL too short → 401" defect.) |
| TC-API-8.19 | Portal appointments surface active waitlist entries (GRO-2319) | As `uat-customer@groombook.dev`, establish a portal session, then `GET /api/portal/appointments`. | 200 OK. In addition to the customer's appointments, the response includes the seeded ACTIVE waitlist entry as a synthetic card: `status: "waitlisted"`, `id` prefixed `waitlist:`, `confirmationStatus: null`, a non-null derived `startTime` (from the entry's preferred date/time), and the entry's `pet`. Cancelled/notified/expired waitlist entries are NOT surfaced. |
| TC-API-8.20 | Portal waitlist card populates service {id, name} (GRO-2342) | As `uat-customer@groombook.dev`, establish a portal session, then `GET /api/portal/appointments`. | 200 OK. The synthetic `waitlisted` card returned for the active waitlist entry has `service: {id: "<serviceId>", name: "<serviceName>"}` (full service record, not just `{id}`), matching the shape the appointments join returns. The portal Upcoming list therefore renders the actual service name in place of the fallback "Service" label. |
### 4.9 Waitlist
@@ -308,8 +343,8 @@ This means:
| # | Scenario | Steps | Expected |
|---|----------|-------|----------|
| TC-API-13.1 | Get business settings | GET /api/admin/settings | 200 OK, business settings returned |
| TC-API-13.2 | Update business settings | PATCH /api/admin/settings with updated values | 200 OK, settings updated |
| TC-API-13.1 | Get business settings | GET /api/admin/settings | 200 OK, business settings returned. Response body **must NOT include `googleMapsApiKey`** — the encrypted secret is redacted from the projection (GRO-2294, defense-in-depth); non-secret fields (`businessName`, colors, `routeOptimizationProvider`, etc.) are still present |
| TC-API-13.2 | Update business settings | PATCH /api/admin/settings with updated values | 200 OK, settings updated. Response body **must NOT include `googleMapsApiKey`** — the encrypted secret is redacted from the PATCH response symmetrically with the GET projection (GRO-2299, defense-in-depth); non-secret updated fields are still returned |
| TC-API-13.3 | Upload logo | POST /api/admin/settings/logo/upload with file | 200 OK, logo uploaded and stored |
| TC-API-13.4 | View logo | GET /api/admin/settings/logo | 200 OK, logo image returned |
| TC-API-13.5 | Delete logo | DELETE /api/admin/settings/logo | 200 OK, logo removed |
@@ -340,6 +375,106 @@ This means:
| TC-API-15.6 | Reject missing required fields | POST /api/admin/buffer-rules with service only | 400 Bad Request, species and sizeCategory required |
| TC-API-15.7 | Booking uses buffer | Book appointment for pet with sizeCategory; verify duration reflects buffer | 201 Created, appointment duration includes buffer time |
### 4.16 Route Optimization — Route CRUD + Optimize (GRO-2155, Phase 2.1)
A groomer's daily route is one row per `(staffId, routeDate)` in `groomer_routes`, with ordered `route_stops`. `POST /api/routes/optimize` pulls the day's non-cancelled appointments whose client is geocoded (GRO-2154), orders them (Google Directions `optimizeWaypoints` when a key is configured in `businessSettings.googleMapsApiKey`, else an offline nearest-neighbor heuristic), and persists `stopOrder`, `travelMinsFromPrev`, `travelDistanceKmFromPrev` plus route `totalTravelMins`/`totalDistanceKm`/`optimizedAt`. **Auth: manager (any groomer's route) or groomer (own route only); receptionists have no access.**
**Pre-condition (GRO-2225 — zero-touch; no manual PATCH/geocoding needed).** A fresh UAT reset+seed now provisions a deterministic route cohort, so §4.16 runs directly against seed data:
- **Groomer:** `uat-groomer@groombook.dev` (staffId `00000000-0000-0000-0000-000000000004`). Resolve its id via `GET /api/staff` or sign in as the groomer and omit `staffId`.
- **Date:** `2026-09-15` (fixed). On this date the groomer has **12** confirmed appointments: **10 pre-geocoded** clients clustered in the Seattle metro (multi-stop route) + **2 intentionally un-geocoded** clients (exercise the skip-and-surface path, TC-API-16.4). Cohort clients are named `Route Demo — …` (emails `route-client-NN@uat.groombook.dev`).
- **Receptionist (TC-API-16.9 403):** sign in as `uat-receptionist@groombook.dev` (password from the `seed-uat-passwords` secret, key `SEED_UAT_RECEPTIONIST_PASSWORD`) — a standing receptionist login; no hand-built session required.
| # | Scenario | Steps | Expected |
|---|----------|-------|----------|
| TC-API-16.1 | Fetch daily route (auto-create draft) | As **manager**, `GET /api/routes/daily?staffId={groomerId}&date=YYYY-MM-DD` for a date with no existing route | 200 OK; body `{ route, stops }`. `route.status` is `"draft"`, `route.staffId`/`routeDate` match, `stops` is `[]`. Re-calling returns the same route row (no duplicate) |
| TC-API-16.2 | Optimize a multi-stop day | As manager, with ≥2 geocoded appointments for the groomer on the date, `POST /api/routes/optimize` body `{ "staffId": "{groomerId}", "date": "YYYY-MM-DD" }` | 200 OK; `route.status: "optimized"`, `optimizedAt` set, `totalTravelMins`/`totalDistanceKm` populated. `stops` ordered by `stopOrder` (1..N); first stop has `travelMinsFromPrev: null`, the rest positive. `provider` is `"nearest_neighbor"` (no Google key in UAT). The first stop carries `bufferMins: 0` (no predecessor); every later stop carries `bufferMins` = `businessSettings.defaultTravelBufferMins` (default 15). Response also includes `hasConflicts` / `conflictCount` and each stop a `conflict` object (GRO-2156, see §4.17) |
| TC-API-16.3 | Re-optimize replaces prior order | As manager, run TC-API-16.2 twice | Second call returns 200; stops fully replaced (no duplicate `route_stops`, `stopOrder` still contiguous 1..N), `optimizedAt` refreshed |
| TC-API-16.4 | Skips un-geocoded appointments | As manager, optimize a day where one appointment's client has no coordinates | 200 OK; that appointment is absent from `stops` and listed under `skipped[]` with `reason: "client address is not geocoded"`; a corresponding entry appears in `warnings[]` |
| TC-API-16.5 | Empty / single-stop day | As manager, optimize a date with 0 (or 1) geocoded appointments | 200 OK; `route.status: "optimized"`, `totalTravelMins: 0`, `totalDistanceKm: "0.00"`. For 1 stop, `stops` has one entry with `travelMinsFromPrev: null` |
| TC-API-16.6 | >25 stops chunked with warning | As manager, optimize a day with >25 geocoded appointments | 200 OK; `chunked: true`, `subRouteCount ≥ 2`, a `warnings[]` entry mentions sub-routes; all appointments appear exactly once with contiguous `stopOrder` |
| TC-API-16.7 | Groomer reads own route | As **groomer**, `GET /api/routes/daily?date=YYYY-MM-DD` (omit staffId, or pass own id) | 200 OK; route resolves to the groomer's own `staffId` |
| TC-API-16.8 | Groomer cannot access another's route | As groomer, `GET /api/routes/daily?staffId={otherGroomerId}&date=...` or `POST /api/routes/optimize` with another `staffId` | 403 Forbidden (`groomers may only access their own route`) |
| TC-API-16.9 | Receptionist denied | As **receptionist**, `GET /api/routes/daily?...` or `POST /api/routes/optimize` | 403 Forbidden (role not permitted) |
| TC-API-16.10 | Manager must supply staffId | As manager, `POST /api/routes/optimize` body `{ "date": "YYYY-MM-DD" }` (no staffId) | 400 `{ error: "staffId is required" }` |
| TC-API-16.11 | Invalid date rejected | `GET /api/routes/daily?staffId=...&date=06-08-2026` (wrong format) | 400 validation error (`date must be YYYY-MM-DD`) |
### 4.17 Route Optimization — Travel Buffer + Reorder (GRO-2156, Phase 2.2)
Builds on §4.16. After optimization each consecutive leg carries a travel `bufferMins` (= `businessSettings.defaultTravelBufferMins`, default 15; the first stop is `0`). The API derives a per-stop **`conflict`** object at read time on `GET /api/routes/daily`, `POST /api/routes/optimize`, and `PATCH /api/routes/:routeId/reorder`:
- `conflict.scheduleGapMins` — minutes between the previous appointment's `endTime` and this appointment's `startTime` (null for the first stop)
- `conflict.requiredGapMins``travelMinsFromPrev + bufferMins` (null for the first stop)
- `conflict.shortfallMins``requiredGapMins scheduleGapMins` (positive ⇒ tight)
- `conflict.hasConflict` — true when `shortfallMins > 0` ("tight schedule"); appointments are **never auto-moved**, only flagged
`PATCH /api/routes/:routeId/reorder` accepts `{ "stopOrder": ["<routeStopId>", …] }` (every current stop id, exactly once, first-to-last), persists the new `stopOrder`, re-estimates each leg's travel offline for the new adjacency, re-applies buffers, recomputes route totals, and returns the route with refreshed conflict flags. **Auth: manager (any route) or groomer (own route only).**
| ID | Scenario | Steps | Expected |
|----|----------|-------|----------|
| TC-API-17.1 | Conflict flags on optimize | As manager, optimize a day with ≥2 geocoded appointments whose times are close together | 200 OK; top-level `hasConflicts` (bool) + `conflictCount` (int). First stop `conflict.hasConflict:false` with null gap fields. A later stop whose `scheduleGapMins < travelMinsFromPrev + bufferMins` has `conflict.hasConflict:true` and positive `shortfallMins` |
| TC-API-17.2 | No false conflict on a roomy schedule | Optimize a day where appointment gaps comfortably exceed travel + buffer | 200 OK; `hasConflicts:false`, `conflictCount:0`, every `conflict.shortfallMins ≤ 0` |
| TC-API-17.3 | Reorder persists new order | As manager, take an optimized route, `PATCH /api/routes/{routeId}/reorder` with the stop ids in a new order | 200 OK; `stops` returned in the requested order with contiguous `stopOrder` 1..N; first stop `travelMinsFromPrev:null`/`bufferMins:0`, others recomputed; `route.totalTravelMins`/`totalDistanceKm` updated |
| TC-API-17.4 | Reorder re-flags conflicts | Reorder so a far-apart pair becomes adjacent | 200 OK; `conflict` flags recomputed for the new adjacency (`hasConflicts`/`conflictCount` reflect the new order) |
| TC-API-17.5 | Reorder validation — wrong stop set | `PATCH …/reorder` with a missing, extra, duplicate, or unknown stop id | 400 with an explanatory `error` (e.g. "must list every stop exactly once", "unknown stop id", "duplicate stop id") |
| TC-API-17.6 | Reorder unknown route | `PATCH /api/routes/{randomUuid}/reorder` with any body | 404 `{ error: "Route not found" }` |
| TC-API-17.7 | Reorder invalid routeId | `PATCH /api/routes/not-a-uuid/reorder` | 400 `{ error: "routeId must be a UUID" }` |
| TC-API-17.8 | Groomer cannot reorder another's route | As groomer, reorder a route owned by a different groomer | 403 Forbidden (`groomers may only access their own route`) |
### 4.18 Route Optimization — Navigation Export (GRO-2157, Phase 2.3)
Builds on §4.16/§4.17. Two read-only endpoints turn an optimized route into a native-navigation deep-link URL the frontend opens on the groomer's phone:
- `GET /api/routes/:routeId/export/google-maps` → Google Maps URLs API link (`https://www.google.com/maps/dir/?api=1&travelmode=driving&origin=…&destination=…&waypoints=…`)
- `GET /api/routes/:routeId/export/apple-maps` → Apple Maps URL scheme (`maps://?saddr=…&daddr=<first>+to:<next>…&dirflg=d`)
Both use the stops' stored `latitude`/`longitude` in `stopOrder`: **origin = first stop, destination = last stop, the rest are ordered intermediate waypoints**. Each response body is `{ platform, url, stopCount, waypointCount }` where `waypointCount` = stops minus origin and destination. Waypoint limits are validated per platform: **Google Maps ≤ 9**, **Apple Maps ≤ 15** intermediate waypoints; over-limit routes return 400. **Auth: manager (any route) or groomer (own route only); receptionists have no access.**
| ID | Scenario | Steps | Expected |
|----|----------|-------|----------|
| TC-API-18.1 | Google Maps export of a multi-stop route | As manager, optimize a multi-stop day (§4.16), then `GET /api/routes/{routeId}/export/google-maps` | 200 OK; `platform:"google-maps"`, `url` starts `https://www.google.com/maps/dir/?api=1`, contains `travelmode=driving`, `origin`/`destination` are the first/last stop coords, `waypoints` lists the middle stops in order (pipe-separated). `stopCount` = total stops, `waypointCount` = `stopCount 2` |
| TC-API-18.2 | Apple Maps export of a multi-stop route | As manager, `GET /api/routes/{routeId}/export/apple-maps` for the same route | 200 OK; `platform:"apple-maps"`, `url` starts `maps://?saddr=`, `daddr` chains the remaining stops with `+to:`, ends `&dirflg=d`; `stopCount`/`waypointCount` as above |
| TC-API-18.3 | Single-stop route | Export a route (google-maps and apple-maps) that has exactly one stop | 200 OK; `waypointCount:0`. Google url has `destination` and no `waypoints=`; Apple url is `maps://?daddr=<coord>&dirflg=d` (no `saddr`) |
| TC-API-18.4 | Empty route rejected | Export a route with no stops (a fresh `draft` route) | 400 `{ error: "route has no stops to export" }` |
| TC-API-18.5 | Google waypoint limit | Export (google-maps) a route with >11 stops (>9 intermediate waypoints) | 400 with an `error` mentioning Google Maps' limit of 9 |
| TC-API-18.6 | Apple waypoint limit | Export (apple-maps) a route with >17 stops (>15 intermediate waypoints) | 400 with an `error` mentioning Apple Maps' limit of 15 |
| TC-API-18.7 | Unknown route | `GET /api/routes/{randomUuid}/export/google-maps` | 404 `{ error: "Route not found" }` |
| TC-API-18.8 | Invalid routeId | `GET /api/routes/not-a-uuid/export/apple-maps` | 400 `{ error: "routeId must be a UUID" }` |
| TC-API-18.9 | Groomer exports own route | As **groomer**, export a route owned by self | 200 OK; deep-link returned |
| TC-API-18.10 | Groomer cannot export another's route | As groomer, export a route owned by a different groomer | 403 Forbidden (`groomers may only access their own route`) |
| TC-API-18.11 | Receptionist denied | As **receptionist**, export any route | 403 Forbidden (role not permitted) |
### 4.19 Boot Resilience — ECONNRESET Recovery (GRO-2652)
Verifies the API process does not crash on transient boot-time DB connection resets and that auth routes degrade gracefully until initialization succeeds.
| TC | Test Case | Steps | Expected Result |
|----|-----------|-------|-----------------|
| TC-API-19.1 | Health endpoint available before auth init | 1. Deploy the image (or restart the api pod)<br>2. `GET /health` immediately (within first 2 s of pod start) | 200 `{"status":"ok"}` — server accepts requests before `initAuth()` completes |
| TC-API-19.2 | Auth routes return 503 when auth not yet initialized | 1. Temporarily set `OIDC_ISSUER` to an unreachable host so `initAuth()` keeps retrying<br>2. `POST /api/auth/sign-in/email` during the retry window | 503 `{"error":"Authentication not configured"}` — process stays alive, does not exit |
| TC-API-19.3 | Pod does not crash on first-attempt DB reset | 1. Review pod restart count after normal deployment<br>2. Confirm `kubectl get pod -n groombook` shows `RESTARTS: 0` (or same as before deploy) for the new pod | No new restarts — ECONNRESET causes retry, not process exit |
| TC-API-19.4 | DB query retry log lines visible | After deploy, `kubectl logs -n groombook <api-pod>` | If any DB retry occurred, log lines matching `[auth] DB query attempt N failed` are present; on clean boot no retry lines appear |
| TC-API-19.5 | Auth init retry log lines visible | When auth init fails and retries, check pod logs | Log lines matching `[auth] initAuth attempt N failed` present; process continues; no `process.exit` |
| TC-API-19.6 | Auth succeeds after transient DB hiccup | 1. Allow pod to retry until DB is available<br>2. `POST /api/auth/sign-in/email` with valid credentials after init succeeds | 200 with session cookie — auth recovers without pod restart |
| TC-API-19.7 | Normal sign-in still works end-to-end | Follow TC-WEB-SSO-3 (SSO sign-in) on UAT | Successful sign-in, staff list visible — no regression from resilience changes |
| TC-API-19.8 | Public routes unaffected during auth retry | While auth is retrying (TC-API-19.2 setup), `GET /api/branding` | 200 with branding data — public routes bypass auth and serve normally |
### 4.20 Portal OOBE — Create Client from Auth (GRO-2359)
Verifies the `POST /api/portal/clients-from-auth` endpoint that creates a new `clients` row for a first-time SSO user (out-of-box-experience registration). This endpoint requires a valid Better Auth session but does NOT require a portal session; it is the pre-portal step in the new-user OOBE flow.
| TC | Test Case | Steps | Expected Result |
|----|-----------|-------|-----------------|
| TC-API-20.1 | Successful client creation | 1. Sign in via SSO to obtain a Better Auth session<br>2. `POST /api/portal/clients-from-auth` with `{ "name": "Test User" }` | 201 `{ "id": "<uuid>", "name": "Test User", "email": "<sso-email>" }` — new `clients` row created |
| TC-API-20.2 | All optional fields accepted | `POST /api/portal/clients-from-auth` with `{ "name": "Test User", "phone": "555-1234", "address": "1 Main St", "notes": "VIP" }` (authenticated) | 201 with `id`, `name`, `email`; row in DB has all four fields |
| TC-API-20.3 | Invalid body — missing name | `POST /api/portal/clients-from-auth` with `{}` (authenticated) | 400 (Zod validation failure); no row created |
| TC-API-20.4 | Invalid body — empty name | `POST /api/portal/clients-from-auth` with `{ "name": "" }` (authenticated) | 400 — name must be at least 1 character |
| TC-API-20.5 | No session — 401 | `POST /api/portal/clients-from-auth` with a valid body but **no** Better Auth session cookie | 401 `{ "error": "Unauthorized" }` |
| TC-API-20.6 | Existing email — 409 | 1. Create a client row whose email matches the signed-in SSO user's email<br>2. `POST /api/portal/clients-from-auth` as that user | 409 `{ "error": "A customer record with this email already exists" }` — no duplicate row |
| TC-API-20.7 | Auth not configured — 503 | Temporarily disable auth (e.g., point `OIDC_ISSUER` to an invalid host) so `getAuth()` throws<br>2. `POST /api/portal/clients-from-auth` | 503 `{ "error": "Authentication not configured" }` — graceful degradation |
| TC-API-20.8 | Concurrent insert race — 409 | Simulate two near-simultaneous requests from the same SSO user (before any row exists) | At most one request returns 201; the other returns 409 — no duplicate row, no 500 |
## Pass/Fail Criteria
**Pass:**
@@ -361,3 +496,4 @@ This means:
## Update Policy
Any PR that changes user-facing behaviour MUST update this file. Test cases must be added, modified, or removed to reflect the new behaviour. The PR description must reference which playbook section was updated (e.g., "Updated UAT_PLAYBOOK.md §4.4 — new appointment rescheduling flow").
+5
View File
@@ -69,9 +69,14 @@ describe("auth init", () => {
beforeEach(() => {
dbSelectResult = [];
vi.clearAllMocks();
// Stub fetch so OIDC discovery requests resolve instantly during tests.
// Without this, AbortSignal.timeout(5000) in auth.ts races with vitest's
// 5000ms default test timeout and causes flaky failures.
vi.stubGlobal("fetch", vi.fn().mockResolvedValue({ ok: false, status: 503 }));
});
afterEach(() => {
vi.unstubAllGlobals();
process.env = { ...originalEnv };
});
+30 -36
View File
@@ -1,10 +1,17 @@
/**
* reset.ts — Drop all application tables and re-run migrations + seed.
* reset.ts — Truncate all public tables and restart identity sequences.
*
* Intended for local development only. Never run against production.
* Schema-safe: never issues destructive DDL against any schema.
* The drizzle schema and __drizzle_migrations table are preserved so
* drizzle-kit migrate remains a no-op on an already-migrated DB.
*
* NOTE: this file is NOT the deployed reset entrypoint — the reset image
* builds from packages/db and runs `pnpm --filter @groombook/db reset`.
* apps/api db:reset delegates there too (see apps/api/package.json).
* Keep in sync with packages/db/src/reset.ts (GRO-2722).
*
* Usage:
* DATABASE_URL=postgres://... npx tsx packages/db/src/reset.ts
* DATABASE_URL=postgres://... npx tsx apps/api/src/db/reset.ts
*/
import postgres from "postgres";
@@ -23,43 +30,30 @@ async function reset() {
const client = postgres(url, { max: 1 });
console.log("Dropping all application tables...\n");
console.log("Truncating all public tables...\n");
// Drop in dependency order (children before parents)
await client`
DO $$ DECLARE
r RECORD;
BEGIN
FOR r IN (
SELECT tablename FROM pg_tables
WHERE schemaname = 'public'
) LOOP
EXECUTE 'DROP TABLE IF EXISTS public.' || quote_ident(r.tablename) || ' CASCADE';
END LOOP;
END $$;
// Enumerate all base tables in the public schema dynamically, then
// issue a single TRUNCATE with RESTART IDENTITY CASCADE so FK cycles
// are not a problem. The drizzle schema and __drizzle_migrations are
// intentionally excluded (different schema) so drizzle-kit migrate
// stays a no-op on an already-migrated DB.
const tables = await client<{ tablename: string }[]>`
SELECT tablename FROM pg_tables
WHERE schemaname = 'public'
`;
// Drop custom enums
await client`
DO $$ DECLARE
r RECORD;
BEGIN
FOR r IN (
SELECT typname FROM pg_type
WHERE typtype = 'e' AND typnamespace = (
SELECT oid FROM pg_namespace WHERE nspname = 'public'
)
) LOOP
EXECUTE 'DROP TYPE IF EXISTS ' || quote_ident(r.typname) || ' CASCADE';
END LOOP;
END $$;
`;
if (tables.length > 0) {
// Double-quote each identifier (escaping embedded quotes) to handle
// any table name safely without a pg-specific quote_ident helper.
const tableList = tables
.map((t) => `"${t.tablename.replace(/"/g, '""')}"`)
.join(", ");
await client.unsafe(
`TRUNCATE ${tableList} RESTART IDENTITY CASCADE`,
);
}
// Drop the drizzle migrations tracking table
await client`DROP TABLE IF EXISTS drizzle.__drizzle_migrations CASCADE`;
await client`DROP SCHEMA IF EXISTS drizzle CASCADE`;
console.log("✓ All tables and enums dropped\n");
console.log("✓ All public tables truncated, sequences reset\n");
await client.end();
}
+4 -3
View File
@@ -18,9 +18,10 @@
"scripts": {
"build": "tsc --project .",
"generate": "drizzle-kit generate",
"migrate": "drizzle-kit migrate",
"seed": "tsx src/seed.ts",
"reset": "tsx src/reset.ts && drizzle-kit migrate && tsx src/seed.ts",
"wait-for-db": "node ./scripts/wait-for-db.mjs",
"migrate": "node ./scripts/wait-for-db.mjs && drizzle-kit migrate",
"seed": "node ./scripts/wait-for-db.mjs && tsx src/seed.ts",
"reset": "node ./scripts/wait-for-db.mjs && tsx src/reset.ts",
"studio": "drizzle-kit studio",
"typecheck": "tsc --noEmit"
},
+104
View File
@@ -0,0 +1,104 @@
#!/usr/bin/env node
// wait-for-db.mjs
//
// GRO-2163: wait for / retry DNS resolution of the database hostname derived
// from DATABASE_URL before invoking `drizzle-kit migrate`. The first attempt
// of a fresh migrate-schema pod occasionally hits a transient CoreDNS miss
// (EAI_AGAIN) on `groombook-postgres-rw.<ns>.svc`; with backoffLimit: 2 the
// retry pod usually wins, but three unlucky attempts in a row trips
// BackoffLimitExceeded. Resolving once here, with backoff, removes the dice
// roll at the source so the first attempt reliably succeeds.
//
// Mirrors the belt-and-braces pattern used in GRO-1985 (no Corepack
// download fallback): we don't try to outsmart CoreDNS, we just don't ask
// drizzle-kit to do the very first DNS lookup of a freshly-scheduled pod.
//
// Configuration (env):
// WAIT_FOR_DB_MAX_ATTEMPTS default 12 (~30s of total wait at default backoff)
// WAIT_FOR_DB_BASE_DELAY_MS default 500
// WAIT_FOR_DB_MAX_DELAY_MS default 5000
// WAIT_FOR_DB_SKIP default unset; set to "1" to skip (debug only)
//
// On success: exit 0. On exhaustion: exit 1 so the Job's backoff is
// preserved (we don't want to silently mask a real outage by giving up
// after 30s and letting drizzle-kit fail with a less-actionable error).
import { setTimeout as delay } from "node:timers/promises";
import dns from "node:dns/promises";
const MAX_ATTEMPTS = Number(process.env.WAIT_FOR_DB_MAX_ATTEMPTS ?? 12);
const BASE_DELAY_MS = Number(process.env.WAIT_FOR_DB_BASE_DELAY_MS ?? 500);
const MAX_DELAY_MS = Number(process.env.WAIT_FOR_DB_MAX_DELAY_MS ?? 5000);
function parseHost(databaseUrl) {
try {
return new URL(databaseUrl).hostname || null;
} catch {
return null;
}
}
async function resolveOnce(host) {
const start = Date.now();
const result = await dns.lookup(host);
return { address: result.address, ms: Date.now() - start };
}
async function main() {
if (process.env.WAIT_FOR_DB_SKIP === "1") {
console.log("[wait-for-db] WAIT_FOR_DB_SKIP=1, skipping");
return;
}
const databaseUrl = process.env.DATABASE_URL;
if (!databaseUrl) {
// Don't gate the migrate on a misconfigured env — let drizzle-kit fail
// loudly with its own clear error.
console.warn("[wait-for-db] DATABASE_URL not set; skipping");
return;
}
const host = parseHost(databaseUrl);
if (!host) {
console.warn(`[wait-for-db] could not parse hostname from DATABASE_URL; skipping`);
return;
}
console.log(
`[wait-for-db] host=${host} max_attempts=${MAX_ATTEMPTS} ` +
`base_delay_ms=${BASE_DELAY_MS} max_delay_ms=${MAX_DELAY_MS}`,
);
for (let attempt = 1; attempt <= MAX_ATTEMPTS; attempt++) {
try {
const { address, ms } = await resolveOnce(host);
console.log(`[wait-for-db] ok attempt=${attempt} host=${host} -> ${address} (${ms}ms)`);
return;
} catch (err) {
const code = err?.code ?? "UNKNOWN";
const transient = code === "EAI_AGAIN" || code === "ENOTFOUND" || code === "EAI_NODATA";
if (!transient) {
// Hard error (e.g. invalid hostname): surface and let drizzle-kit fail
// with a real error rather than spinning.
console.error(`[wait-for-db] non-transient DNS error attempt=${attempt} code=${code}: ${err.message}`);
process.exit(1);
}
if (attempt === MAX_ATTEMPTS) {
console.error(
`[wait-for-db] exhausted attempts=${MAX_ATTEMPTS} host=${host} last_code=${code}; exiting 1`,
);
process.exit(1);
}
const backoff = Math.min(
MAX_DELAY_MS,
BASE_DELAY_MS * 2 ** (attempt - 1) + Math.floor(Math.random() * BASE_DELAY_MS),
);
console.log(
`[wait-for-db] transient attempt=${attempt} code=${code} retry_in_ms=${backoff}`,
);
await delay(backoff);
}
}
}
main().catch((err) => {
console.error(`[wait-for-db] fatal: ${err?.message ?? err}`);
process.exit(1);
});
+112 -40
View File
@@ -1,13 +1,54 @@
/**
* reset.ts — Drop all application tables and re-run migrations + seed.
* reset.ts — Truncate all public tables and restart identity sequences.
*
* Intended for local development only. Never run against production.
* Schema-safe: never issues destructive DDL against any schema.
* The drizzle schema and __drizzle_migrations table are preserved so
* drizzle-kit migrate remains a no-op on an already-migrated DB.
*
* Usage:
* DATABASE_URL=postgres://... npx tsx packages/db/src/reset.ts
* GRO-2139: the entire truncate→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` (TRUNCATE)
* 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 TRUNCATE → migrate → seed
* work runs on the rest of the pool, so the lock guarantees mutual
* exclusion against any concurrent seeder for the entire chain.
*
* For a full local schema teardown (nuke tables, enums, drizzle schema)
* use `pnpm --filter @groombook/db db:nuke` instead — never change this
* script to be destructive (GRO-2722 / GRO-2678 prod incident).
*
* 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 { execSync } from "node:child_process";
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);
const __dirname = dirname(__filename);
async function reset() {
const url = process.env.DATABASE_URL;
@@ -16,52 +57,83 @@ async function reset() {
process.exit(1);
}
if (process.env.NODE_ENV === "production" && process.env.ALLOW_RESET !== "true") {
console.error("[FATAL] db:reset must not be run in production without ALLOW_RESET=true.");
if (
process.env.NODE_ENV === "production" &&
process.env.ALLOW_RESET !== "true"
) {
console.error(
"[FATAL] db:reset must not be run in production without ALLOW_RESET=true.",
);
process.exit(1);
}
const client = postgres(url, { max: 1 });
// Pool sizing is load-bearing here. `withSeedAdvisoryLock` does
// `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 TRUNCATE / 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 });
console.log("Dropping all application tables...\n");
try {
await withSeedAdvisoryLock(client, async () => {
console.log("Truncating all public tables...\n");
// Drop in dependency order (children before parents)
await client`
DO $$ DECLARE
r RECORD;
BEGIN
FOR r IN (
// Enumerate all base tables in the public schema dynamically, then
// issue a single TRUNCATE with RESTART IDENTITY CASCADE so FK cycles
// are not a problem. The drizzle schema and __drizzle_migrations are
// intentionally excluded (different schema) so drizzle-kit migrate
// stays a no-op on an already-migrated DB.
const tables = await client<{ tablename: string }[]>`
SELECT tablename FROM pg_tables
WHERE schemaname = 'public'
) LOOP
EXECUTE 'DROP TABLE IF EXISTS public.' || quote_ident(r.tablename) || ' CASCADE';
END LOOP;
END $$;
`;
`;
// Drop custom enums
await client`
DO $$ DECLARE
r RECORD;
BEGIN
FOR r IN (
SELECT typname FROM pg_type
WHERE typtype = 'e' AND typnamespace = (
SELECT oid FROM pg_namespace WHERE nspname = 'public'
)
) LOOP
EXECUTE 'DROP TYPE IF EXISTS ' || quote_ident(r.typname) || ' CASCADE';
END LOOP;
END $$;
`;
if (tables.length > 0) {
// Double-quote each identifier (escaping embedded quotes) to handle
// any table name safely without a pg-specific quote_ident helper.
const tableList = tables
.map((t) => `"${t.tablename.replace(/"/g, '""')}"`)
.join(", ");
await client.unsafe(
`TRUNCATE ${tableList} RESTART IDENTITY CASCADE`,
);
}
// Drop the drizzle migrations tracking table
await client`DROP TABLE IF EXISTS drizzle.__drizzle_migrations CASCADE`;
await client`DROP SCHEMA IF EXISTS drizzle CASCADE`;
console.log("✓ All public tables truncated, sequences reset\n");
console.log("✓ All tables and enums dropped\n");
console.log("Running migrations...");
// GRO-2672: drizzle-orm's migrate() has a high-water-mark bug that skips
// migrations with stale `when` timestamps (0001, 0003, 0010, 0011). Use
// drizzle-kit instead -- it applies migrations by hash, matching the K8s
// migrate Job behaviour exactly.
execSync("pnpm exec drizzle-kit migrate", {
stdio: "inherit",
env: { ...process.env },
cwd: resolve(__dirname, ".."),
});
console.log("✓ Migrations applied\n");
await client.end();
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) => {
+428 -6
View File
@@ -24,9 +24,9 @@ import type { MedicalAlert } from "@groombook/types";
// ── Seed profile configuration ─────────────────────────────────────────────
type SeedProfile = "dev" | "uat" | "demo";
export type SeedProfile = "dev" | "uat" | "demo";
interface ProfileConfig {
export interface ProfileConfig {
staffCount: { manager: number; receptionist: number; groomer: number; bather: number };
clientCount: number;
appointmentsBackDays: number;
@@ -35,7 +35,7 @@ interface ProfileConfig {
includeUatClients: boolean;
}
const profiles: Record<SeedProfile, ProfileConfig> = {
export const profiles: Record<SeedProfile, ProfileConfig> = {
dev: {
staffCount: { manager: 1, receptionist: 1, groomer: 2, bather: 0 },
clientCount: 100,
@@ -70,6 +70,8 @@ function getProfile(): SeedProfile {
return "uat";
}
export { getProfile };
// ── Deterministic PRNG (Mulberry32) ──────────────────────────────────────────
/**
@@ -456,6 +458,36 @@ async function seedUatStaffAccounts(
}
}
// ── Staff: UAT Receptionist (GRO-2225) ──────────────────────────────────────
// Standing receptionist staff record so the route-optimization 403 path
// (TC-API-16.9: receptionist GET/POST /api/routes → 403) is reproducible
// without a hand-built session. The matching Better-Auth credential is
// provisioned below from SEED_UAT_RECEPTIONIST_PASSWORD. Created here (gated
// on the password env) so the credential loop's staff-link step finds it.
if (process.env.SEED_UAT_RECEPTIONIST_PASSWORD) {
const UAT_RECEPTIONIST_STAFF_ID = "00000000-0000-0000-0000-000000000099";
const [existingReceptionist] = await db
.select()
.from(schema.staff)
.where(eq(schema.staff.email, "uat-receptionist@groombook.dev"))
.limit(1);
if (existingReceptionist) {
console.log(`✓ Staff 'UAT Receptionist' already exists — skipping`);
} else {
await db.insert(schema.staff).values({
id: UAT_RECEPTIONIST_STAFF_ID,
name: "UAT Receptionist",
email: "uat-receptionist@groombook.dev",
oidcSub: "uat-receptionist@groombook.dev",
role: "receptionist",
isSuperUser: false,
active: true,
});
console.log(`✓ Created staff 'UAT Receptionist' (uat-receptionist@groombook.dev)`);
}
}
// ── Staff: UAT Groomer Personas (SEED_UAT_GROOMER_EMAILS + SEED_UAT_GROOMER_NAMES) ──
const groomerEmails = process.env.SEED_UAT_GROOMER_EMAILS?.split(",").map((e) => e.trim()).filter(Boolean) ?? [];
const groomerNames = process.env.SEED_UAT_GROOMER_NAMES?.split(",").map((n) => n.trim()).filter(Boolean) ?? [];
@@ -495,6 +527,8 @@ async function seedUatStaffAccounts(
{ email: "uat-groomer@groombook.dev", name: "UAT Staff Groomer", passwordEnv: "SEED_UAT_GROOMER_PASSWORD", staffEmail: "uat-groomer@groombook.dev" },
{ email: "uat-customer@groombook.dev", name: "UAT Customer", passwordEnv: "SEED_UAT_CUSTOMER_PASSWORD", staffEmail: null },
{ email: "uat-tester@groombook.dev", name: "UAT Tester", passwordEnv: "SEED_UAT_TESTER_PASSWORD", staffEmail: "uat-tester@groombook.dev" },
// GRO-2225: standing receptionist login for the route-optimization 403 path (TC-API-16.9).
{ email: "uat-receptionist@groombook.dev", name: "UAT Receptionist", passwordEnv: "SEED_UAT_RECEPTIONIST_PASSWORD", staffEmail: "uat-receptionist@groombook.dev" },
];
for (const acct of uatPasswordAccounts) {
@@ -798,6 +832,381 @@ async function seedUatGroomerLinkage(
);
}
// ── GRO-2311 / GRO-2313: portal customer StatusBadge coverage ────────────────
/**
* GRO-2311 / GRO-2313: give the UAT portal customer (`uat-customer@groombook.dev`)
* a deterministic spread of appointments so the customer-portal StatusBadge
* palette can be LIVE-observed (not just code-verified against the bundle).
*
* `appointment_status` enum is (`scheduled, confirmed, in_progress, completed,
* cancelled, no_show`) — the portal's <StatusBadge> renders `appointment.status`
* verbatim. `pending` and `waitlisted` are NOT valid appointment statuses, so
* GRO-2319 derives them in the portal: `pending` from an upcoming appointment's
* `confirmationStatus` (the `scheduled` row below carries `pending`), and
* `waitlisted` from an ACTIVE `waitlist_entries` row (seeded at the end of this
* function) which `GET /api/portal/appointments` surfaces as a synthetic card.
* The `no_show`→`no-show` badge-key fix is the web side of GRO-2319.
*
* - confirmed → future startTime → renders as an Upcoming card (Confirmed badge)
* - scheduled → future startTime → renders as an Upcoming card (Scheduled badge)
* - cancelled → past startTime → Past tab (isUpcoming excludes cancelled)
* - no_show → past startTime → Past tab (raw `no_show` label until GRO-2319)
*
* The existing GRO-2100 `completed` appointment (a0000001-…-0001) is left
* untouched (AC #4), so Completed is also covered.
*
* Idempotent: each appointment uses a fixed UUID and is upserted with
* onConflictDoNothing, so the hourly reset-demo-data CronJob (which TRUNCATEs
* then re-seeds) and non-truncating dev re-seeds never dup-key
* (see GRO-2033 for the dup-key class).
*/
async function seedUatCustomerPortalAppointments(
db: ReturnType<typeof drizzle>,
customerClientId: string | null,
): Promise<void> {
const LINKED_PET_ID = "c0000001-0000-0000-0000-000000000002"; // UAT Pup Alpha
// Skip silently outside the UAT persona profile (e.g. a dev/test seed that
// never created the UAT Customer client).
if (!customerClientId) {
return;
}
// The customer's pet must exist (pets are NOT truncated on reset, so this is
// stable). Defensive: bail cleanly if the persona pet is absent.
const [linkedPet] = await db
.select({ id: schema.pets.id })
.from(schema.pets)
.where(eq(schema.pets.id, LINKED_PET_ID))
.limit(1);
if (!linkedPet) {
console.warn(`⚠ GRO-2311: UAT Pup Alpha (${LINKED_PET_ID}) not found — skipping portal appointment seed`);
return;
}
// Stable "Bath & Brush" service; fall back to any active service.
const BATH_AND_BRUSH_ID = "b0000001-0000-0000-0000-000000000001";
const [bathService] = await db
.select({ id: schema.services.id })
.from(schema.services)
.where(eq(schema.services.id, BATH_AND_BRUSH_ID))
.limit(1);
let serviceId: string;
if (bathService) {
serviceId = bathService.id;
} else {
const [fallback] = await db
.select({ id: schema.services.id })
.from(schema.services)
.where(eq(schema.services.active, true))
.limit(1);
if (!fallback) {
console.warn(`⚠ GRO-2311: no active services found — skipping portal appointment seed`);
return;
}
serviceId = fallback.id;
}
// Attach the UAT groomer when present (nicer "with <groomer>" card); else null
// ("First Available"). Either way these are the customer's own appointments —
// no new groomer↔pet linkage invariant is created (uses the already-linked
// Pup Alpha), so GRO-1987 TC-UAT-3 (403 on the UNLINKED Pup Beta) is unaffected.
const [uatGroomerStaff] = await db
.select({ id: schema.staff.id })
.from(schema.staff)
.where(eq(schema.staff.email, "uat-groomer@groombook.dev"))
.limit(1);
const staffId = uatGroomerStaff?.id ?? null;
// Anchor all times to local wall-clock so future/past holds regardless of the
// hourly reset cadence.
const at = (deltaDays: number, hour: number): Date => {
const d = new Date();
d.setDate(d.getDate() + deltaDays);
d.setHours(hour, 0, 0, 0);
return d;
};
const DURATION_MS = 45 * 60 * 1000;
const rows = [
{
id: "a0000001-0000-0000-0000-000000000002",
status: "confirmed" as const,
start: at(3, 10),
confirmationStatus: "confirmed",
confirmedAt: new Date(),
cancelledAt: null as Date | null,
notes: "GRO-2311: upcoming confirmed appointment for portal StatusBadge coverage.",
},
{
id: "a0000001-0000-0000-0000-000000000003",
status: "scheduled" as const,
start: at(5, 14),
confirmationStatus: "pending",
confirmedAt: null as Date | null,
cancelledAt: null as Date | null,
notes: "GRO-2311: upcoming scheduled appointment for portal StatusBadge coverage.",
},
{
id: "a0000001-0000-0000-0000-000000000004",
status: "cancelled" as const,
start: at(-3, 11),
confirmationStatus: "cancelled",
confirmedAt: null as Date | null,
cancelledAt: new Date(),
notes: "GRO-2311: cancelled appointment (Past tab) for portal StatusBadge coverage.",
},
{
id: "a0000001-0000-0000-0000-000000000005",
status: "no_show" as const,
start: at(-10, 9),
confirmationStatus: "confirmed",
confirmedAt: null as Date | null,
cancelledAt: null as Date | null,
notes: "GRO-2311: no_show appointment (Past tab) for portal StatusBadge coverage.",
},
];
await db
.insert(schema.appointments)
.values(
rows.map((r) => ({
id: r.id,
clientId: customerClientId,
petId: LINKED_PET_ID,
serviceId,
staffId,
batherStaffId: null,
status: r.status,
startTime: r.start,
endTime: new Date(r.start.getTime() + DURATION_MS),
notes: r.notes,
priceCents: null,
confirmationStatus: r.confirmationStatus,
confirmedAt: r.confirmedAt,
cancelledAt: r.cancelledAt,
})),
)
.onConflictDoNothing({ target: schema.appointments.id });
console.log(
`✓ GRO-2311: seeded ${rows.length} portal StatusBadge appointments (confirmed/scheduled/cancelled/no_show) for UAT customer`,
);
// GRO-2319 item 2: seed one ACTIVE waitlist entry so the portal's `waitlisted`
// card (surfaced by GET /api/portal/appointments) is live-observable. Unlike
// appointments, `waitlist_entries` is NOT truncated on the hourly reset, so we
// upsert by fixed id and REFRESH the preferred date to a future-relative value
// each reset — otherwise the date would go stale and the card would drop out of
// the Upcoming list. (The seeded `scheduled` appointment above already carries
// `confirmationStatus: "pending"`, which drives the live Pending badge.)
const WAITLIST_ENTRY_ID = "e0000001-0000-0000-0000-000000000001";
const pad2 = (n: number): string => String(n).padStart(2, "0");
const wlStart = at(7, 13); // 7 days out, 1pm — comfortably "upcoming"
const wlPreferredDate = `${wlStart.getFullYear()}-${pad2(wlStart.getMonth() + 1)}-${pad2(wlStart.getDate())}`;
const wlPreferredTime = `${pad2(wlStart.getHours())}:00:00`;
await db
.insert(schema.waitlistEntries)
.values({
id: WAITLIST_ENTRY_ID,
clientId: customerClientId,
petId: LINKED_PET_ID,
serviceId,
preferredDate: wlPreferredDate,
preferredTime: wlPreferredTime,
status: "active",
})
.onConflictDoUpdate({
target: schema.waitlistEntries.id,
set: {
preferredDate: wlPreferredDate,
preferredTime: wlPreferredTime,
status: "active",
updatedAt: new Date(),
},
});
console.log(
`✓ GRO-2319: seeded 1 active waitlist entry (${wlPreferredDate} ${wlPreferredTime}) for UAT customer portal Waitlisted card`,
);
}
// ── GRO-2225: deterministic route-optimization cohort ────────────────────────
/**
* GRO-2225: seed a deterministic, pre-geocoded client cohort + a fixed-date set
* of appointments for the UAT groomer so the route-optimization endpoints
* (`GET /api/routes/daily`, `POST /api/routes/optimize`, UAT §4.16
* TC-API-16.1…16.11) are exercisable with ZERO manual PATCHing.
*
* Design (no live geocoder — UAT has no Google Maps key, provider is
* nearest_neighbor; coordinates are hand-picked fixtures clustered in the
* Seattle metro):
* - All appointments are on a FIXED calendar date (ROUTE_DATE) and assigned to
* the UAT groomer (`uat-groomer@groombook.dev`). The optimize endpoint pulls
* non-cancelled appointments in [date 00:00Z, +24h) joined to client coords.
* - 10 clients carry deterministic lat/lng → a multi-stop optimized route.
* - 2 clients are intentionally left UN-geocoded so the "skipped + surfaced"
* path (TC-API-16.5) stays reproducible.
*
* Idempotent: clients/pets are upserted by fixed UUID (they are NOT truncated on
* reset); appointments are upserted by fixed UUID too (they ARE truncated on
* reset, but the upsert keeps re-runs safe in non-truncating dev/test paths).
* Skips cleanly when the UAT groomer staff record is absent (e.g. prod/demo or a
* dev seed without the UAT personas).
*/
async function seedUatRouteCohort(db: ReturnType<typeof drizzle>): Promise<void> {
// Fixed calendar date the UAT playbook hardcodes for §4.16. Times are UTC so
// they fall inside the optimize endpoint's [date 00:00Z, +24h) day window.
const ROUTE_DATE = "2026-09-15";
const [uatGroomer] = await db
.select({ id: schema.staff.id })
.from(schema.staff)
.where(eq(schema.staff.email, "uat-groomer@groombook.dev"))
.limit(1);
if (!uatGroomer) {
console.log("✓ GRO-2225: uat-groomer not present — skipping route cohort");
return;
}
// Resolve a service for the appointments: prefer Bath & Brush, else any active.
const BATH_AND_BRUSH_ID = "b0000001-0000-0000-0000-000000000001";
const [bathService] = await db
.select({ id: schema.services.id })
.from(schema.services)
.where(eq(schema.services.id, BATH_AND_BRUSH_ID))
.limit(1);
let serviceId: string;
if (bathService) {
serviceId = bathService.id;
} else {
const [fallback] = await db
.select({ id: schema.services.id })
.from(schema.services)
.where(eq(schema.services.active, true))
.limit(1);
if (!fallback) {
console.warn("⚠ GRO-2225: no active services found — skipping route cohort");
return;
}
serviceId = fallback.id;
}
// Hand-picked fixture coordinates clustered in the Seattle metro. `coords:null`
// marks an intentionally un-geocoded client (skip-and-surface path TC-16.5).
const cohort: Array<{
n: number;
name: string;
coords: { lat: number; lng: number } | null;
}> = [
{ n: 1, name: "Route Demo — Ada Lovelace", coords: { lat: 47.6097, lng: -122.3331 } },
{ n: 2, name: "Route Demo — Grace Hopper", coords: { lat: 47.6205, lng: -122.3493 } },
{ n: 3, name: "Route Demo — Alan Turing", coords: { lat: 47.5990, lng: -122.3300 } },
{ n: 4, name: "Route Demo — Katherine Johnson", coords: { lat: 47.6150, lng: -122.3200 } },
{ n: 5, name: "Route Demo — Edsger Dijkstra", coords: { lat: 47.6280, lng: -122.3550 } },
{ n: 6, name: "Route Demo — Barbara Liskov", coords: { lat: 47.5920, lng: -122.3150 } },
{ n: 7, name: "Route Demo — Donald Knuth", coords: { lat: 47.6350, lng: -122.3400 } },
{ n: 8, name: "Route Demo — Margaret Hamilton", coords: { lat: 47.6050, lng: -122.3600 } },
{ n: 9, name: "Route Demo — Ken Thompson", coords: { lat: 47.6420, lng: -122.3250 } },
{ n: 10, name: "Route Demo — Radia Perlman", coords: { lat: 47.5880, lng: -122.3450 } },
// Intentionally un-geocoded — exercises the skip-and-surface path.
{ n: 11, name: "Route Demo — Ungeocoded One", coords: null },
{ n: 12, name: "Route Demo — Ungeocoded Two", coords: null },
];
// Stagger appointments 45 min apart starting 15:00Z on ROUTE_DATE.
const dayStartMs = new Date(`${ROUTE_DATE}T15:00:00.000Z`).getTime();
const SLOT_MS = 45 * 60 * 1000;
let geocodedCount = 0;
let ungeocodedCount = 0;
for (const c of cohort) {
const pad = String(c.n).padStart(2, "0");
const clientId = `d0000000-0000-0000-0000-0000000000${pad}`;
const petId = `d0000000-0000-0000-0000-0000000001${pad}`;
const apptId = `d0000000-0000-0000-0000-0000000002${pad}`;
const geocodedAt = c.coords ? new Date(`${ROUTE_DATE}T00:00:00.000Z`) : null;
await db.insert(schema.clients)
.values({
id: clientId,
name: c.name,
email: `route-client-${pad}@uat.groombook.dev`,
phone: `(206) 555-01${pad}`,
address: `${100 + c.n} Pike Street, Seattle, WA 98101`,
status: "active",
latitude: c.coords?.lat ?? null,
longitude: c.coords?.lng ?? null,
geocodedAt,
})
.onConflictDoUpdate({
target: schema.clients.id,
set: {
name: c.name,
address: `${100 + c.n} Pike Street, Seattle, WA 98101`,
latitude: c.coords?.lat ?? null,
longitude: c.coords?.lng ?? null,
geocodedAt,
},
});
await db.insert(schema.pets)
.values({
id: petId,
clientId,
name: `Route Pup ${c.n}`,
species: "Dog",
breed: "Mixed",
weightKg: "18.00",
})
.onConflictDoUpdate({
target: schema.pets.id,
set: { clientId, name: `Route Pup ${c.n}`, species: "Dog" },
});
const startTime = new Date(dayStartMs + (c.n - 1) * SLOT_MS);
const endTime = new Date(startTime.getTime() + SLOT_MS);
await db.insert(schema.appointments)
.values({
id: apptId,
clientId,
petId,
serviceId,
staffId: uatGroomer.id,
batherStaffId: null,
status: "confirmed",
startTime,
endTime,
notes: "GRO-2225: deterministic route-optimization cohort appointment.",
priceCents: null,
confirmationStatus: "confirmed",
})
.onConflictDoUpdate({
target: schema.appointments.id,
set: {
clientId,
petId,
serviceId,
staffId: uatGroomer.id,
status: "confirmed",
startTime,
endTime,
},
});
if (c.coords) geocodedCount++;
else ungeocodedCount++;
}
console.log(
`✓ GRO-2225: seeded route cohort for ${ROUTE_DATE}${geocodedCount} geocoded + ${ungeocodedCount} un-geocoded appointment(s) for uat-groomer (${uatGroomer.id})`,
);
}
// ── Known-users-only seed (prod/demo) ───────────────────────────────────────
/**
@@ -906,6 +1315,10 @@ async function seedKnownUsers() {
// to attach to the appointment; on a fresh reset there are none yet at
// the time seedUatStaffAccounts() returns).
await seedUatGroomerLinkage(db, uatCustomerClientId);
// GRO-2311 / GRO-2313: portal customer StatusBadge palette coverage (reachable
// appointment statuses only). Runs after the groomer linkage so the customer
// client + Pup Alpha already exist.
await seedUatCustomerPortalAppointments(db, uatCustomerClientId);
// ── Client: Demo Client ──
const [existingClient] = await db
@@ -989,7 +1402,7 @@ async function seedKnownUsers() {
// from runbooks without ambiguity and binds to the single-argument
// `pg_advisory_lock(int)` form, which postgres-js serializes as a plain
// number (no bigint type plumbing required).
const SEED_ADVISORY_LOCK_KEY = 0x47524f4f; // "GROO" in ASCII — arbitrary, stable
export const SEED_ADVISORY_LOCK_KEY = 0x47524f4f; // "GROO" in ASCII — arbitrary, stable
/**
* Reserve a dedicated connection from `pool`, take the seed advisory lock
@@ -1002,7 +1415,7 @@ const SEED_ADVISORY_LOCK_KEY = 0x47524f4f; // "GROO" in ASCII — arbitrary, sta
* for the lock and release it from the same reserved connection. The
* seed work itself still runs on the pooled connections.
*/
async function withSeedAdvisoryLock<T>(
export async function withSeedAdvisoryLock<T>(
pool: ReturnType<typeof postgres>,
fn: () => Promise<T>,
): Promise<T> {
@@ -1060,7 +1473,7 @@ async function seed() {
await client.end();
}
async function runSeedBody(
export async function runSeedBody(
client: ReturnType<typeof postgres>,
db: ReturnType<typeof drizzle>,
profile: SeedProfile,
@@ -1168,6 +1581,15 @@ async function runSeedBody(
// to attach to the appointment; on a fresh reset there are none yet at
// the time seedUatStaffAccounts() returns).
await seedUatGroomerLinkage(db, uatCustomerClientId);
// GRO-2311 / GRO-2313: portal customer StatusBadge palette coverage (reachable
// appointment statuses only). Runs after the groomer linkage so the customer
// client + Pup Alpha already exist.
await seedUatCustomerPortalAppointments(db, uatCustomerClientId);
// GRO-2225: deterministic pre-geocoded route cohort + fixed-date appointments
// for the UAT groomer. Must run AFTER services are seeded (it looks up a
// service id for the appointments). Skips cleanly if uat-groomer is absent.
await seedUatRouteCohort(db);
// ── Clients & Pets ──
const now = new Date();
+5
View File
@@ -69,9 +69,14 @@ describe("auth init", () => {
beforeEach(() => {
dbSelectResult = [];
vi.clearAllMocks();
// Stub fetch so OIDC discovery requests resolve instantly during tests.
// Without this, AbortSignal.timeout(5000) in auth.ts races with vitest's
// 5000ms default test timeout and causes flaky failures.
vi.stubGlobal("fetch", vi.fn().mockResolvedValue({ ok: false, status: 503 }));
});
afterEach(() => {
vi.unstubAllGlobals();
process.env = { ...originalEnv };
});
+60
View File
@@ -0,0 +1,60 @@
import { describe, it, expect } from "vitest";
import { enforceAuthCors } from "../lib/auth-cors.js";
const TRUSTED = ["https://uat.groombook.dev", "https://dev.groombook.dev"];
/** Simulates Better Auth reflecting the request Origin (the pre-fix bug). */
function makeReflectedResponse(origin: string | null): Response {
return new Response('{"ok":true}', {
status: 200,
headers: {
"Content-Type": "application/json",
...(origin
? {
"Access-Control-Allow-Origin": origin,
"Access-Control-Allow-Credentials": "true",
}
: {}),
},
});
}
describe("enforceAuthCors (GRO-2586)", () => {
it("passes trusted origin through with credentials", () => {
const origin = "https://uat.groombook.dev";
const res = enforceAuthCors(origin, TRUSTED, makeReflectedResponse(origin));
expect(res.headers.get("Access-Control-Allow-Origin")).toBe(origin);
expect(res.headers.get("Access-Control-Allow-Credentials")).toBe("true");
});
it("strips ACAO for attacker origin (credentialed cross-origin read blocked)", () => {
const origin = "https://evil.example.com";
const res = enforceAuthCors(origin, TRUSTED, makeReflectedResponse(origin));
expect(res.headers.get("Access-Control-Allow-Origin")).toBeNull();
expect(res.headers.get("Access-Control-Allow-Credentials")).toBeNull();
});
it("strips ACAO when no Origin header (undefined)", () => {
const res = enforceAuthCors(undefined, TRUSTED, makeReflectedResponse(null));
expect(res.headers.get("Access-Control-Allow-Origin")).toBeNull();
expect(res.headers.get("Access-Control-Allow-Credentials")).toBeNull();
});
it("preserves non-CORS response headers and status from Better Auth", () => {
const origin = "https://evil.example.com";
const res = enforceAuthCors(origin, TRUSTED, makeReflectedResponse(origin));
expect(res.headers.get("Content-Type")).toBe("application/json");
expect(res.status).toBe(200);
});
it("second trusted origin is also allowed", () => {
const origin = "https://dev.groombook.dev";
const res = enforceAuthCors(origin, TRUSTED, makeReflectedResponse(origin));
expect(res.headers.get("Access-Control-Allow-Origin")).toBe(origin);
});
it("empty string origin is treated as untrusted", () => {
const res = enforceAuthCors("", TRUSTED, makeReflectedResponse(""));
expect(res.headers.get("Access-Control-Allow-Origin")).toBeNull();
});
});
+192
View File
@@ -0,0 +1,192 @@
import { describe, it, expect, vi } from "vitest";
import {
geocodeClient,
geocodeUngeocodedClients,
resolveClientGeocodingProvider,
} from "../services/clientGeocoding.js";
import {
NominatimGeocodingProvider,
type GeocodeResult,
type GeocodingProvider,
} from "../services/geocoding.js";
// ─── Fakes ──────────────────────────────────────────────────────────────────
/** Fake provider with a scripted geocode behaviour and a call log. */
function fakeProvider(
impl: (address: string) => Promise<GeocodeResult | null>
): GeocodingProvider & { calls: string[] } {
const calls: string[] = [];
return {
name: "nominatim",
minRequestIntervalMs: 0,
calls,
geocode: (address: string) => {
calls.push(address);
return impl(address);
},
};
}
const okResult = (lat: number, lng: number): GeocodeResult => ({
latitude: lat,
longitude: lng,
formattedAddress: "1 Main St, Anytown",
provider: "nominatim",
});
/**
* Minimal db double recording update() set-values. `select()` chains return the
* preloaded `selectQueue` shift()ed per call so different statements get
* different rows (used by geocodeUngeocodedClients: count, then rows).
*/
function fakeDb(selectQueue: unknown[][]) {
const updates: Record<string, unknown>[] = [];
const queue = [...selectQueue];
const chain = () => {
const rows = queue.shift() ?? [];
const proxy: Record<string, unknown> = {};
for (const k of ["from", "where", "orderBy", "limit"]) {
proxy[k] = () => proxy;
}
// Make the chain awaitable / iterable as the resolved rows.
(proxy as { then: unknown }).then = (resolve: (v: unknown) => void) =>
resolve(rows);
(proxy as { [Symbol.iterator]: unknown })[Symbol.iterator] = () =>
(rows as unknown[])[Symbol.iterator]();
return proxy;
};
const db = {
select: () => chain(),
update: () => ({
set: (vals: Record<string, unknown>) => ({
where: () => {
updates.push(vals);
return { returning: async () => [] };
},
}),
}),
updates,
};
return db as unknown as Parameters<typeof geocodeClient>[0] & {
updates: Record<string, unknown>[];
};
}
const clientRow = (over: Record<string, unknown> = {}) =>
({
id: "client-1",
name: "Alice",
email: "a@example.com",
address: "1 Main St",
latitude: null,
longitude: null,
geocodedAt: null,
...over,
}) as unknown as Parameters<typeof geocodeClient>[1];
// ─── geocodeClient ────────────────────────────────────────────────────────────
describe("geocodeClient", () => {
it("persists coordinates and returns a geocoded outcome", async () => {
const db = fakeDb([]);
const provider = fakeProvider(async () => okResult(40.1, -74.2));
const outcome = await geocodeClient(db, clientRow(), provider);
expect(outcome.status).toBe("geocoded");
expect(outcome.latitude).toBe(40.1);
expect(outcome.longitude).toBe(-74.2);
expect(outcome.geocodedAt).toBeTruthy();
expect(db.updates).toHaveLength(1);
expect(db.updates[0]!.latitude).toBe(40.1);
expect(db.updates[0]!.longitude).toBe(-74.2);
expect(db.updates[0]!.geocodedAt).toBeInstanceOf(Date);
});
it("returns no_address and does not persist when address is blank", async () => {
const db = fakeDb([]);
const provider = fakeProvider(async () => okResult(0, 0));
const outcome = await geocodeClient(db, clientRow({ address: " " }), provider);
expect(outcome.status).toBe("no_address");
expect(provider.calls).toHaveLength(0);
expect(db.updates).toHaveLength(0);
});
it("returns unresolved when the provider finds no match", async () => {
const db = fakeDb([]);
const provider = fakeProvider(async () => null);
const outcome = await geocodeClient(db, clientRow(), provider);
expect(outcome.status).toBe("unresolved");
expect(outcome.message).toMatch(/could not be resolved/i);
expect(db.updates).toHaveLength(0);
});
it("returns error (without throwing) when the provider fails", async () => {
const db = fakeDb([]);
const provider = fakeProvider(async () => {
throw new Error("quota exceeded");
});
const outcome = await geocodeClient(db, clientRow(), provider);
expect(outcome.status).toBe("error");
expect(outcome.message).toMatch(/quota exceeded/);
expect(db.updates).toHaveLength(0);
});
});
// ─── geocodeUngeocodedClients ─────────────────────────────────────────────────
describe("geocodeUngeocodedClients", () => {
it("geocodes candidates, tallies outcomes, and reports remaining", async () => {
// First select() = count query, second select() = candidate rows.
const db = fakeDb([
[{ count: 5 }],
[
clientRow({ id: "c1", address: "1 Main St" }),
clientRow({ id: "c2", address: "2 Oak Ave" }),
clientRow({ id: "c3", address: "" }), // no_address
],
]);
const provider = fakeProvider(async (addr) =>
addr === "2 Oak Ave" ? null : okResult(1, 2)
);
const summary = await geocodeUngeocodedClients(db, 50, provider);
expect(summary.processed).toBe(3);
expect(summary.geocoded).toBe(1);
expect(summary.unresolved).toBe(1); // "2 Oak Ave"
expect(summary.remaining).toBe(2); // 5 total - 3 processed
expect(summary.provider).toBe("nominatim");
expect(db.updates).toHaveLength(1); // only the successful one persisted
});
it("clamps the limit to the 1..500 range", async () => {
const db = fakeDb([[{ count: 0 }], []]);
const provider = fakeProvider(async () => okResult(1, 2));
const summary = await geocodeUngeocodedClients(db, 0, provider);
expect(summary.processed).toBe(0);
expect(summary.remaining).toBe(0);
});
});
// ─── resolveClientGeocodingProvider ───────────────────────────────────────────
describe("resolveClientGeocodingProvider", () => {
it("defaults to Nominatim when no settings row exists", async () => {
const db = fakeDb([[]]); // businessSettings select -> empty
const provider = await resolveClientGeocodingProvider(db);
expect(provider).toBeInstanceOf(NominatimGeocodingProvider);
expect(provider.name).toBe("nominatim");
});
it("defaults to Nominatim when provider is unset on settings", async () => {
const db = fakeDb([[{ routeOptimizationProvider: null, googleMapsApiKey: null }]]);
const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
const provider = await resolveClientGeocodingProvider(db);
expect(provider.name).toBe("nominatim");
warn.mockRestore();
});
});
+89
View File
@@ -0,0 +1,89 @@
import { describe, it, expect, vi, beforeEach } from "vitest";
import { Hono } from "hono";
// ─── Mocks ──────────────────────────────────────────────────────────────────
// GRO-2294: the POST /clients/geocode-batch handler must clamp ?limit to the
// documented maximum (500) before invoking the geocoding service. We mock the
// service to capture the exact limit the route forwards.
const geocodeUngeocodedClients = vi.fn(async () => ({
totalRemaining: 0,
processed: 0,
geocoded: 0,
failed: 0,
remaining: 0,
}));
vi.mock("../services/clientGeocoding.js", () => ({
geocodeUngeocodedClients,
geocodeClient: vi.fn(),
resolveClientGeocodingProvider: vi.fn(),
}));
vi.mock("@groombook/db", () => {
const tableProxy = (name: string) =>
new Proxy(
{ _name: name },
{ get: (_t, p) => (p === "_name" ? name : { table: name, column: p }) }
);
return {
getDb: () => ({}),
clients: tableProxy("clients"),
appointments: tableProxy("appointments"),
and: vi.fn(),
eq: vi.fn(),
or: vi.fn(),
exists: vi.fn(),
};
});
const { clientsRouter } = await import("../routes/clients.js");
const app = new Hono();
app.route("/clients", clientsRouter);
function postBatch(query: string) {
return app.request(`/clients/geocode-batch${query}`, { method: "POST" });
}
describe("POST /clients/geocode-batch — ?limit cap (GRO-2294)", () => {
beforeEach(() => {
geocodeUngeocodedClients.mockClear();
});
it("defaults to 50 when no ?limit is supplied", async () => {
const res = await postBatch("");
expect(res.status).toBe(200);
expect(geocodeUngeocodedClients).toHaveBeenCalledWith(expect.anything(), 50);
});
it("passes through a value within the cap", async () => {
const res = await postBatch("?limit=120");
expect(res.status).toBe(200);
expect(geocodeUngeocodedClients).toHaveBeenCalledWith(expect.anything(), 120);
});
it("clamps an over-cap value to 500", async () => {
const res = await postBatch("?limit=100000");
expect(res.status).toBe(200);
expect(geocodeUngeocodedClients).toHaveBeenCalledWith(expect.anything(), 500);
});
it("floors a fractional value before clamping", async () => {
const res = await postBatch("?limit=49.9");
expect(res.status).toBe(200);
expect(geocodeUngeocodedClients).toHaveBeenCalledWith(expect.anything(), 49);
});
it("rejects a non-positive limit with 400", async () => {
const res = await postBatch("?limit=0");
expect(res.status).toBe(400);
expect(geocodeUngeocodedClients).not.toHaveBeenCalled();
});
it("rejects a non-numeric limit with 400", async () => {
const res = await postBatch("?limit=abc");
expect(res.status).toBe(400);
expect(geocodeUngeocodedClients).not.toHaveBeenCalled();
});
});
+313
View File
@@ -0,0 +1,313 @@
import { describe, it, expect, vi, afterEach } from "vitest";
import {
NominatimGeocodingProvider,
GoogleGeocodingProvider,
resolveGeocodingProvider,
geocodeBatch,
type FetchLike,
} from "../services/geocoding.js";
/** Builds a fake fetch returning a single JSON body, recording the called URLs. */
function fakeFetch(
body: unknown,
init: { ok?: boolean; status?: number; statusText?: string } = {}
): { fetchImpl: FetchLike; calls: string[] } {
const calls: string[] = [];
const fetchImpl: FetchLike = async (url) => {
calls.push(url);
return {
ok: init.ok ?? true,
status: init.status ?? 200,
statusText: init.statusText ?? "OK",
json: async () => body,
};
};
return { fetchImpl, calls };
}
/** Virtual clock whose `sleep` advances `now`, so throttle timing is deterministic. */
function fakeClock() {
const state = { t: 0 };
const sleeps: number[] = [];
return {
now: () => state.t,
sleep: async (ms: number) => {
sleeps.push(ms);
state.t += ms;
},
sleeps,
};
}
const NOMINATIM_ROW = {
lat: "40.7128",
lon: "-74.0060",
display_name: "New York, NY, USA",
};
describe("NominatimGeocodingProvider", () => {
it("parses the top match into a GeocodeResult", async () => {
const { fetchImpl, calls } = fakeFetch([NOMINATIM_ROW]);
const provider = new NominatimGeocodingProvider({ fetchImpl });
const result = await provider.geocode("123 Main St");
expect(result).toEqual({
latitude: 40.7128,
longitude: -74.006,
formattedAddress: "New York, NY, USA",
provider: "nominatim",
});
expect(calls).toHaveLength(1);
expect(calls[0]).toContain("/search");
expect(calls[0]).toContain("q=123+Main+St");
expect(calls[0]).toContain("format=jsonv2");
expect(calls[0]).toContain("limit=1");
});
it("returns null for an empty result set", async () => {
const { fetchImpl } = fakeFetch([]);
const provider = new NominatimGeocodingProvider({ fetchImpl });
expect(await provider.geocode("nowhere at all")).toBeNull();
});
it("returns null for a blank address without calling fetch", async () => {
const { fetchImpl, calls } = fakeFetch([NOMINATIM_ROW]);
const provider = new NominatimGeocodingProvider({ fetchImpl });
expect(await provider.geocode(" ")).toBeNull();
expect(calls).toHaveLength(0);
});
it("throws on a non-OK HTTP response", async () => {
const { fetchImpl } = fakeFetch("rate limited", {
ok: false,
status: 429,
statusText: "Too Many Requests",
});
const provider = new NominatimGeocodingProvider({ fetchImpl });
await expect(provider.geocode("123 Main St")).rejects.toThrow(
/Nominatim geocoding failed: 429/
);
});
it("sends the configured User-Agent and honors a custom base URL", async () => {
const calls: Array<{ url: string; headers?: Record<string, string> }> = [];
const fetchImpl: FetchLike = async (url, opts) => {
calls.push({ url, headers: opts?.headers });
return { ok: true, status: 200, statusText: "OK", json: async () => [NOMINATIM_ROW] };
};
const provider = new NominatimGeocodingProvider({
fetchImpl,
baseUrl: "https://nominatim.example.com/",
userAgent: "TestAgent/9.9",
});
await provider.geocode("123 Main St");
expect(calls[0]!.url).toContain("https://nominatim.example.com/search");
expect(calls[0]!.headers?.["User-Agent"]).toBe("TestAgent/9.9");
});
it("throttles to ~1 req/sec across consecutive calls (first call not delayed)", async () => {
const clock = fakeClock();
const { fetchImpl } = fakeFetch([NOMINATIM_ROW]);
const provider = new NominatimGeocodingProvider({
fetchImpl,
minRequestIntervalMs: 1000,
now: clock.now,
sleep: clock.sleep,
});
await provider.geocode("a");
await provider.geocode("b");
await provider.geocode("c");
// First request immediate; each subsequent waits the full interval.
expect(clock.sleeps).toEqual([1000, 1000]);
});
});
describe("GoogleGeocodingProvider", () => {
const GOOGLE_OK = {
status: "OK",
results: [
{
formatted_address: "1600 Amphitheatre Pkwy, Mountain View, CA",
geometry: { location: { lat: 37.4224, lng: -122.0842 } },
},
],
};
it("parses the first result into a GeocodeResult", async () => {
const { fetchImpl, calls } = fakeFetch(GOOGLE_OK);
const provider = new GoogleGeocodingProvider("test-key", { fetchImpl });
const result = await provider.geocode("1600 Amphitheatre Pkwy");
expect(result).toEqual({
latitude: 37.4224,
longitude: -122.0842,
formattedAddress: "1600 Amphitheatre Pkwy, Mountain View, CA",
provider: "google",
});
expect(calls[0]).toContain("key=test-key");
expect(calls[0]).toContain("address=1600+Amphitheatre+Pkwy");
});
it("returns null on ZERO_RESULTS", async () => {
const { fetchImpl } = fakeFetch({ status: "ZERO_RESULTS", results: [] });
const provider = new GoogleGeocodingProvider("test-key", { fetchImpl });
expect(await provider.geocode("nowhere")).toBeNull();
});
it("throws on an API error status with the error message", async () => {
const { fetchImpl } = fakeFetch({
status: "REQUEST_DENIED",
error_message: "The provided API key is invalid.",
});
const provider = new GoogleGeocodingProvider("bad-key", { fetchImpl });
await expect(provider.geocode("123 Main St")).rejects.toThrow(
/Google geocoding error: REQUEST_DENIED: The provided API key is invalid\./
);
});
it("returns null for a blank address without calling fetch", async () => {
const { fetchImpl, calls } = fakeFetch(GOOGLE_OK);
const provider = new GoogleGeocodingProvider("test-key", { fetchImpl });
expect(await provider.geocode("")).toBeNull();
expect(calls).toHaveLength(0);
});
it("rejects construction with an empty API key", () => {
expect(() => new GoogleGeocodingProvider("")).toThrow(/non-empty API key/);
});
});
describe("resolveGeocodingProvider", () => {
const originalEnv = process.env.GOOGLE_MAPS_API_KEY;
afterEach(() => {
if (originalEnv === undefined) delete process.env.GOOGLE_MAPS_API_KEY;
else process.env.GOOGLE_MAPS_API_KEY = originalEnv;
});
it("defaults to Nominatim when provider is unset", () => {
const provider = resolveGeocodingProvider(null);
expect(provider.name).toBe("nominatim");
});
it("returns Nominatim for an explicit nominatim setting", () => {
const provider = resolveGeocodingProvider({
routeOptimizationProvider: "nominatim",
});
expect(provider.name).toBe("nominatim");
});
it("returns Google and decrypts the stored key when provider is google", () => {
const decrypt = vi.fn().mockReturnValue("decrypted-google-key");
const provider = resolveGeocodingProvider(
{ routeOptimizationProvider: "google", googleMapsApiKey: "enc:abc" },
{ decrypt }
);
expect(provider.name).toBe("google");
expect(decrypt).toHaveBeenCalledWith("enc:abc");
});
it("falls back to Nominatim (with a warning) when google has no usable key", () => {
delete process.env.GOOGLE_MAPS_API_KEY;
const warn = vi.fn();
const provider = resolveGeocodingProvider(
{ routeOptimizationProvider: "google", googleMapsApiKey: null },
{ warn }
);
expect(provider.name).toBe("nominatim");
expect(warn).toHaveBeenCalledOnce();
});
it("falls back to Nominatim (with a warning) when decryption fails", () => {
const decrypt = vi.fn().mockImplementation(() => {
throw new Error("bad ciphertext");
});
const warn = vi.fn();
delete process.env.GOOGLE_MAPS_API_KEY;
const provider = resolveGeocodingProvider(
{ routeOptimizationProvider: "google", googleMapsApiKey: "enc:corrupt" },
{ decrypt, warn }
);
expect(provider.name).toBe("nominatim");
expect(warn).toHaveBeenCalled();
});
it("uses GOOGLE_MAPS_API_KEY env var as a fallback key source", () => {
process.env.GOOGLE_MAPS_API_KEY = "env-key";
const provider = resolveGeocodingProvider({
routeOptimizationProvider: "google",
});
expect(provider.name).toBe("google");
});
});
describe("geocodeBatch", () => {
it("geocodes items in order and preserves keys", async () => {
const { fetchImpl } = fakeFetch([NOMINATIM_ROW]);
const provider = new NominatimGeocodingProvider({
fetchImpl,
minRequestIntervalMs: 0,
});
const outcomes = await geocodeBatch(
[
{ key: "c1", address: "123 Main St" },
{ key: "c2", address: "456 Oak Ave" },
],
provider
);
expect(outcomes.map((o) => o.key)).toEqual(["c1", "c2"]);
expect(outcomes[0]!.result?.latitude).toBe(40.7128);
expect(outcomes[1]!.error).toBeUndefined();
});
it("captures per-item errors and continues the batch", async () => {
let call = 0;
const fetchImpl: FetchLike = async () => {
call += 1;
if (call === 1) {
return { ok: false, status: 500, statusText: "Server Error", json: async () => "" };
}
return { ok: true, status: 200, statusText: "OK", json: async () => [NOMINATIM_ROW] };
};
const provider = new NominatimGeocodingProvider({ fetchImpl, minRequestIntervalMs: 0 });
const outcomes = await geocodeBatch(
[
{ key: 1, address: "bad" },
{ key: 2, address: "good" },
],
provider
);
expect(outcomes[0]!.result).toBeNull();
expect(outcomes[0]!.error).toMatch(/500/);
expect(outcomes[1]!.result?.latitude).toBe(40.7128);
});
it("reports progress for each completed item", async () => {
const { fetchImpl } = fakeFetch([NOMINATIM_ROW]);
const provider = new NominatimGeocodingProvider({ fetchImpl, minRequestIntervalMs: 0 });
const progress: Array<[number, number]> = [];
await geocodeBatch(
[
{ key: "a", address: "1 St" },
{ key: "b", address: "2 St" },
],
provider,
{ onProgress: (completed, total) => progress.push([completed, total]) }
);
expect(progress).toEqual([
[1, 2],
[2, 2],
]);
});
});
+140
View File
@@ -0,0 +1,140 @@
import { describe, it, expect } from "vitest";
import {
buildGoogleMapsUrl,
buildAppleMapsUrl,
buildNavigationUrl,
intermediateWaypointCount,
GOOGLE_MAPS_MAX_WAYPOINTS,
APPLE_MAPS_MAX_WAYPOINTS,
type NavigationStop,
} from "../services/navigationExport.js";
function stops(n: number): NavigationStop[] {
return Array.from({ length: n }, (_, i) => ({
latitude: 47 + i / 100,
longitude: -122 - i / 100,
label: `Stop ${i + 1}`,
}));
}
describe("intermediateWaypointCount", () => {
it("excludes origin and destination", () => {
expect(intermediateWaypointCount(0)).toBe(0);
expect(intermediateWaypointCount(1)).toBe(0);
expect(intermediateWaypointCount(2)).toBe(0);
expect(intermediateWaypointCount(5)).toBe(3);
});
});
describe("buildGoogleMapsUrl", () => {
it("rejects an empty route", () => {
const r = buildGoogleMapsUrl([]);
expect(r).toEqual({ error: "route has no stops to export", status: 400 });
});
it("builds a single-stop link (destination only, no waypoints)", () => {
const r = buildGoogleMapsUrl(stops(1));
if ("error" in r) throw new Error(r.error);
expect(r.platform).toBe("google-maps");
expect(r.stopCount).toBe(1);
expect(r.waypointCount).toBe(0);
expect(r.url).toContain("https://www.google.com/maps/dir/?");
expect(r.url).toContain("api=1");
expect(r.url).toContain("travelmode=driving");
expect(r.url).toContain("origin=47%2C-122");
expect(r.url).toContain("destination=47%2C-122");
expect(r.url).not.toContain("waypoints=");
});
it("builds origin/destination only for two stops", () => {
const r = buildGoogleMapsUrl(stops(2));
if ("error" in r) throw new Error(r.error);
expect(r.waypointCount).toBe(0);
expect(r.url).not.toContain("waypoints=");
expect(r.url).toContain("origin=47%2C-122");
expect(r.url).toContain("destination=47.01%2C-122.01");
});
it("includes intermediate waypoints in order, pipe-separated", () => {
const r = buildGoogleMapsUrl(stops(4));
if ("error" in r) throw new Error(r.error);
expect(r.stopCount).toBe(4);
expect(r.waypointCount).toBe(2);
// waypoints param holds stops[1] and stops[2], pipe-joined (encoded %7C)
const url = new URL(r.url);
expect(url.searchParams.get("origin")).toBe("47,-122");
expect(url.searchParams.get("destination")).toBe("47.03,-122.03");
expect(url.searchParams.get("waypoints")).toBe(
"47.01,-122.01|47.02,-122.02"
);
});
it("accepts a route at exactly the waypoint limit", () => {
const r = buildGoogleMapsUrl(stops(GOOGLE_MAPS_MAX_WAYPOINTS + 2));
if ("error" in r) throw new Error(r.error);
expect(r.waypointCount).toBe(GOOGLE_MAPS_MAX_WAYPOINTS);
});
it("rejects a route over the waypoint limit", () => {
const r = buildGoogleMapsUrl(stops(GOOGLE_MAPS_MAX_WAYPOINTS + 3));
expect("error" in r).toBe(true);
if ("error" in r) {
expect(r.status).toBe(400);
expect(r.error).toContain(`${GOOGLE_MAPS_MAX_WAYPOINTS}`);
}
});
});
describe("buildAppleMapsUrl", () => {
it("rejects an empty route", () => {
const r = buildAppleMapsUrl([]);
expect(r).toEqual({ error: "route has no stops to export", status: 400 });
});
it("builds a destination-only link for one stop", () => {
const r = buildAppleMapsUrl(stops(1));
if ("error" in r) throw new Error(r.error);
expect(r.platform).toBe("apple-maps");
expect(r.url).toBe("maps://?daddr=47,-122&dirflg=d");
expect(r.url).not.toContain("saddr=");
});
it("chains destinations with +to: for multiple stops", () => {
const r = buildAppleMapsUrl(stops(3));
if ("error" in r) throw new Error(r.error);
expect(r.stopCount).toBe(3);
expect(r.waypointCount).toBe(1);
expect(r.url).toBe(
"maps://?saddr=47,-122&daddr=47.01,-122.01+to:47.02,-122.02&dirflg=d"
);
});
it("accepts a route at exactly the waypoint limit", () => {
const r = buildAppleMapsUrl(stops(APPLE_MAPS_MAX_WAYPOINTS + 2));
if ("error" in r) throw new Error(r.error);
expect(r.waypointCount).toBe(APPLE_MAPS_MAX_WAYPOINTS);
});
it("rejects a route over the waypoint limit", () => {
const r = buildAppleMapsUrl(stops(APPLE_MAPS_MAX_WAYPOINTS + 3));
expect("error" in r).toBe(true);
if ("error" in r) {
expect(r.status).toBe(400);
expect(r.error).toContain(`${APPLE_MAPS_MAX_WAYPOINTS}`);
}
});
});
describe("buildNavigationUrl", () => {
it("dispatches to the google-maps builder", () => {
const r = buildNavigationUrl("google-maps", stops(2));
if ("error" in r) throw new Error(r.error);
expect(r.platform).toBe("google-maps");
});
it("dispatches to the apple-maps builder", () => {
const r = buildNavigationUrl("apple-maps", stops(2));
if ("error" in r) throw new Error(r.error);
expect(r.platform).toBe("apple-maps");
});
});
-16
View File
@@ -131,20 +131,6 @@ function makeAppointment(overrides: Record<string, unknown> = {}) {
};
}
function makeService(overrides: Record<string, unknown> = {}) {
return {
id: "service-1",
name: "Full Groom",
description: null,
basePriceCents: 6000,
durationMinutes: 120,
active: true,
createdAt: new Date(),
updatedAt: new Date(),
...overrides,
};
}
function makeSession(overrides: Record<string, unknown> = {}) {
return {
id: "sess-owner",
@@ -164,7 +150,6 @@ function makeSession(overrides: Record<string, unknown> = {}) {
let petsTable: Record<string, unknown>[];
let appointmentsTable: Record<string, unknown>[];
let servicesTable: Record<string, unknown>[];
let sessionsTable: Record<string, unknown>[];
// selectQueue: queries resolve in FIFO order. Each .from(table) result
@@ -198,7 +183,6 @@ function enqueueThrow(table: string, message: string) {
function resetMock() {
petsTable = [makePet()];
appointmentsTable = [makeAppointment()];
servicesTable = [makeService()];
sessionsTable = [makeSession()];
selectQueue = [];
insertCapture = [];
+130
View File
@@ -39,11 +39,19 @@ const APPOINTMENT = {
let selectSessionRow: Record<string, unknown> | null = null;
let selectAppointmentRow: Record<string, unknown> | null = null;
let selectWaitlistRows: Record<string, unknown>[] = [];
let selectPetRows: Record<string, unknown>[] = [];
let selectStaffRows: Record<string, unknown>[] = [];
let selectServiceRows: Record<string, unknown>[] = [];
let updatedValues: Record<string, unknown>[] = [];
function resetMock() {
selectSessionRow = null;
selectAppointmentRow = null;
selectWaitlistRows = [];
selectPetRows = [];
selectStaffRows = [];
selectServiceRows = [];
updatedValues = [];
}
@@ -72,6 +80,13 @@ vi.mock("@groombook/db", () => {
{ get: (t, p) => (p === "_name" ? "appointments" : { table: "appointments", column: p }) }
);
const mkTable = (name: string) =>
new Proxy({ _name: name }, { get: (t, p) => (p === "_name" ? name : { table: name, column: p }) });
const waitlistEntries = mkTable("waitlistEntries");
const pets = mkTable("pets");
const staff = mkTable("staff");
const services = mkTable("services");
return {
getDb: () => ({
select: () => ({
@@ -82,6 +97,18 @@ vi.mock("@groombook/db", () => {
if (table._name === "appointments") {
return makeChainable(selectAppointmentRow ? [selectAppointmentRow] : []);
}
if (table._name === "waitlistEntries") {
return makeChainable(selectWaitlistRows);
}
if (table._name === "pets") {
return makeChainable(selectPetRows);
}
if (table._name === "staff") {
return makeChainable(selectStaffRows);
}
if (table._name === "services") {
return makeChainable(selectServiceRows);
}
return makeChainable([]);
},
}),
@@ -102,8 +129,13 @@ vi.mock("@groombook/db", () => {
}),
impersonationSessions,
appointments,
waitlistEntries,
pets,
staff,
services,
eq: vi.fn(),
and: vi.fn(),
inArray: vi.fn(),
};
});
@@ -125,6 +157,104 @@ function jsonPatch(path: string, body: unknown, headers?: Record<string, string>
beforeEach(() => resetMock());
// GRO-2319 item 2: the portal Upcoming list renders active waitlist entries as
// synthetic `waitlisted` cards, so GET /portal/appointments must surface them.
describe("GET /portal/appointments (waitlist surfacing — GRO-2319)", () => {
it("returns active waitlist entries as synthetic waitlisted cards", async () => {
selectSessionRow = ACTIVE_SESSION;
selectAppointmentRow = { ...APPOINTMENT };
selectWaitlistRows = [
{
id: "11111111-1111-1111-1111-111111111111",
petId: "pet-1",
serviceId: "svc-1",
preferredDate: "2099-01-01",
preferredTime: "13:00:00",
},
];
selectPetRows = [{ id: "pet-1", name: "Rex", photoKey: null }];
const res = await app.request("/portal/appointments", {
headers: { "X-Impersonation-Session-Id": SESSION_ID },
});
expect(res.status).toBe(200);
const body = await res.json();
const waitlistCard = body.appointments.find(
(a: { status: string }) => a.status === "waitlisted",
);
expect(waitlistCard).toBeTruthy();
expect(waitlistCard.id).toBe("waitlist:11111111-1111-1111-1111-111111111111");
expect(waitlistCard.pet.name).toBe("Rex");
expect(waitlistCard.confirmationStatus).toBeNull();
// startTime is derived from preferredDate + preferredTime so the card sorts
// and classifies as Upcoming.
expect(waitlistCard.startTime).toBeTruthy();
});
it("omits the waitlist section when the client has no active entries", async () => {
selectSessionRow = ACTIVE_SESSION;
selectAppointmentRow = { ...APPOINTMENT };
selectWaitlistRows = [];
const res = await app.request("/portal/appointments", {
headers: { "X-Impersonation-Session-Id": SESSION_ID },
});
expect(res.status).toBe(200);
const body = await res.json();
expect(body.appointments.some((a: { status: string }) => a.status === "waitlisted")).toBe(false);
});
});
// GRO-2342: GET /portal/appointments must populate the synthetic waitlist
// card's `service` object with the full service record (id + name) — same
// shape the appointments join returns — so the portal renders the real
// service name in place of the fallback "Service" label.
describe("GET /portal/appointments (waitlist service name — GRO-2342)", () => {
it("returns service {id, name} on the synthetic waitlist card", async () => {
selectSessionRow = ACTIVE_SESSION;
selectAppointmentRow = { ...APPOINTMENT };
selectWaitlistRows = [
{
id: "22222222-2222-2222-2222-222222222222",
petId: "pet-1",
serviceId: "svc-1",
preferredDate: "2099-01-01",
preferredTime: "13:00:00",
},
];
selectPetRows = [{ id: "pet-1", name: "Rex", photoKey: null }];
selectServiceRows = [{ id: "svc-1", name: "Full Groom" }];
const res = await app.request("/portal/appointments", {
headers: { "X-Impersonation-Session-Id": SESSION_ID },
});
expect(res.status).toBe(200);
const body = await res.json();
const waitlistCard = body.appointments.find(
(a: { status: string }) => a.status === "waitlisted",
);
expect(waitlistCard).toBeTruthy();
expect(waitlistCard.service).toEqual({ id: "svc-1", name: "Full Groom" });
});
it("returns service {id, name} on the appointment card (same shape)", async () => {
selectSessionRow = ACTIVE_SESSION;
selectAppointmentRow = { ...APPOINTMENT, serviceId: "svc-appt" };
selectServiceRows = [{ id: "svc-appt", name: "Bath & Brush" }];
const res = await app.request("/portal/appointments", {
headers: { "X-Impersonation-Session-Id": SESSION_ID },
});
expect(res.status).toBe(200);
const body = await res.json();
const apptCard = body.appointments.find(
(a: { status: string }) => a.status === "scheduled",
);
expect(apptCard).toBeTruthy();
expect(apptCard.service).toEqual({ id: "svc-appt", name: "Bath & Brush" });
});
});
describe("PATCH /portal/appointments/:id/notes", () => {
it("returns updated appointment with safe fields only", async () => {
selectSessionRow = ACTIVE_SESSION;
+201
View File
@@ -0,0 +1,201 @@
import { describe, it, expect, vi, beforeEach } from "vitest";
import { Hono } from "hono";
import { getAuth } from "../lib/auth.js";
const NEW_USER_EMAIL = "new-sso-user@example.com";
const NEW_USER_NAME = "New SSO User";
const NEW_USER_ID = "11111111-2222-3333-4444-555555555555";
const BETTER_AUTH_SESSION = {
user: {
id: "auth-user-new",
email: NEW_USER_EMAIL,
name: NEW_USER_NAME,
},
session: {
id: "ba-session-new",
expiresAt: new Date(Date.now() + 60 * 60 * 1000),
},
};
let mockGetAuth: ReturnType<typeof vi.fn>;
let mockGetSession: ReturnType<typeof vi.fn>;
let existingClientRow: Record<string, unknown> | null = null;
let insertedClientValues: Record<string, unknown> | null = null;
let insertShouldThrow: { code?: string } | null = null;
function makeChainable(data: unknown[]): unknown {
const arr = [...data];
return new Proxy(arr, {
get(target, prop) {
if (prop === "where" || prop === "orderBy" || prop === "limit") {
return () => makeChainable(target);
}
// @ts-expect-error proxy
return target[prop];
},
});
}
vi.mock("@groombook/db", () => {
const clients = new Proxy(
{ _name: "clients" },
{ get: (t, p) => (p === "_name" ? "clients" : { table: "clients", column: p }) }
);
return {
getDb: () => ({
select: () => ({
from: (table: { _name: string }) => {
if (table._name === "clients") {
return makeChainable(existingClientRow ? [existingClientRow] : []);
}
return makeChainable([]);
},
}),
insert: (table: { _name: string }) => ({
values: (vals: Record<string, unknown>) => {
if (insertShouldThrow) {
const err = new Error("unique violation") as Error & { code?: string };
err.code = insertShouldThrow.code;
throw err;
}
return {
returning: () => {
if (table._name === "clients") {
insertedClientValues = { id: NEW_USER_ID, ...vals };
return [insertedClientValues];
}
return [];
},
};
},
}),
}),
clients,
eq: vi.fn(),
and: vi.fn(),
inArray: vi.fn(),
};
});
vi.mock("../lib/auth.js", () => ({
getAuth: vi.fn(),
}));
const { portalRouter } = await import("../routes/portal.js");
const app = new Hono();
app.route("/portal", portalRouter);
describe("POST /portal/clients-from-auth (GRO-2359)", () => {
beforeEach(() => {
existingClientRow = null;
insertedClientValues = null;
insertShouldThrow = null;
mockGetSession = vi.fn();
mockGetAuth = vi.fn(() => ({
api: {
getSession: mockGetSession,
},
}));
vi.mocked(getAuth).mockImplementation(mockGetAuth);
});
it("returns 401 when no Better Auth session is present", async () => {
mockGetSession.mockResolvedValue(null);
const res = await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "Test User" }),
});
expect(res.status).toBe(401);
const body = await res.json();
expect(body.error).toBe("Unauthorized");
});
it("returns 400 when body fails zod validation (empty name)", async () => {
mockGetSession.mockResolvedValue(BETTER_AUTH_SESSION);
const res = await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "" }),
});
expect(res.status).toBe(400);
});
it("creates a new client row bound to the auth user's email and returns 201", async () => {
mockGetSession.mockResolvedValue(BETTER_AUTH_SESSION);
const res = await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
name: " New SSO User ",
phone: "555-1234",
address: "1 Main St",
notes: "test note",
}),
});
expect(res.status).toBe(201);
const body = await res.json();
expect(body).toMatchObject({
id: NEW_USER_ID,
name: "New SSO User",
email: NEW_USER_EMAIL,
});
// Trim must be applied to the persisted values.
expect(insertedClientValues).not.toBeNull();
expect((insertedClientValues as Record<string, unknown>).name).toBe("New SSO User");
expect((insertedClientValues as Record<string, unknown>).email).toBe(NEW_USER_EMAIL);
expect((insertedClientValues as Record<string, unknown>).phone).toBe("555-1234");
});
it("normalizes empty optional fields to null on insert", async () => {
mockGetSession.mockResolvedValue(BETTER_AUTH_SESSION);
await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "Test", phone: "", address: " " }),
});
expect(insertedClientValues).not.toBeNull();
expect((insertedClientValues as Record<string, unknown>).phone).toBeNull();
expect((insertedClientValues as Record<string, unknown>).address).toBeNull();
});
it("returns 409 when a client row already exists for this email", async () => {
mockGetSession.mockResolvedValue(BETTER_AUTH_SESSION);
existingClientRow = { id: "existing-client-id", email: NEW_USER_EMAIL };
const res = await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "Test" }),
});
expect(res.status).toBe(409);
const body = await res.json();
expect(body.error).toMatch(/already exists/i);
expect(insertedClientValues).toBeNull();
});
it("returns 409 on unique constraint race (23505)", async () => {
mockGetSession.mockResolvedValue(BETTER_AUTH_SESSION);
insertShouldThrow = { code: "23505" };
const res = await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "Test" }),
});
expect(res.status).toBe(409);
});
it("returns 503 when auth is not configured", async () => {
mockGetAuth.mockImplementation(() => {
throw new Error("Auth not initialized");
});
const res = await app.request("/portal/clients-from-auth", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ name: "Test" }),
});
expect(res.status).toBe(503);
});
});
+70 -1
View File
@@ -177,7 +177,10 @@ describe("PATCH /portal/pets/:petId", () => {
expect(persisted.weightKg).toBe("18.25");
expect(persisted.groomingNotes).toBe("old grooming notes");
expect(persisted.healthAlerts).toBe("Allergic to oatmeal shampoo");
expect(persisted.photoKey).toBe("pets/rex.jpg");
// photoKey is NOT writable via portal PATCH (GRO-2187 S3 key-hijack fix):
// the web form round-trips the GET-shaped photoUrl, but the server must not
// persist it. Photo changes go through the key-validated upload flow.
expect(persisted.photoKey).toBeUndefined();
expect(persisted.coatType).toBe("double");
expect(persisted.petSizeCategory).toBe("extra_large");
expect(persisted.preferredCuts).toEqual(["teddy bear", "puppy cut"]);
@@ -187,6 +190,55 @@ describe("PATCH /portal/pets/:petId", () => {
expect(persisted.updatedAt).toBeInstanceOf(Date);
});
// GRO-2187 security regression: a portal customer must not be able to set the
// S3 object key. photoKey is consumed server-side by getPresignedGetUrl /
// deleteObject; the upload path guards keys with a pets/{petId}/ prefix, and the
// portal PATCH must not offer a bypass. A foreign/arbitrary photoUrl is accepted
// (Zod strips the unknown key) but must leave photoKey untouched.
it("does not mutate photoKey when a foreign photoUrl is supplied (200)", async () => {
selectSessionRow = ACTIVE_SESSION;
const ownKey = `pets/${PET_ID}/original.jpg`;
selectPetRow = { ...PET, photoKey: ownKey };
const res = await jsonPatch(
`/portal/pets/${PET_ID}`,
{
name: "Rex",
// attacker-chosen key pointing at another tenant's object
photoUrl: "pets/00000000-0000-0000-0000-0000000000ff/victim-secret.jpg",
},
{ "X-Impersonation-Session-Id": SESSION_ID }
);
expect(res.status).toBe(200);
const persisted = updatedValues[0]!;
// The attacker-supplied key never reaches the update payload.
expect(persisted.photoKey).toBeUndefined();
// And the stored key is unchanged from the pet's own value.
const body = await res.json();
expect(body.photoUrl).toBe(ownKey);
});
// The length/array caps live in the Zod schema, so violations are rejected by
// zValidator with 400 (in-handler enum checks are what return 422).
it("returns 400 when a medicalAlert description exceeds the length cap", async () => {
selectSessionRow = ACTIVE_SESSION;
selectPetRow = PET;
const res = await jsonPatch(
`/portal/pets/${PET_ID}`,
{
medicalAlerts: [
{ type: "allergy", description: "x".repeat(2001), severity: "low" },
],
},
{ "X-Impersonation-Session-Id": SESSION_ID }
);
expect(res.status).toBe(400);
expect(updatedValues).toHaveLength(0);
});
it("falls back to the weight key when weightKg is absent", async () => {
selectSessionRow = ACTIVE_SESSION;
selectPetRow = PET;
@@ -228,6 +280,23 @@ describe("PATCH /portal/pets/:petId", () => {
expect(res.status).toBe(404);
});
it("returns 404 for a malformed (non-UUID) petId without hitting the db (GRO-2203)", async () => {
selectSessionRow = ACTIVE_SESSION;
// A non-UUID petId previously reached `where(eq(pets.id, ...))` and made
// Postgres throw "invalid input syntax for type uuid" → unhandled 500.
// It must now short-circuit to 404 before any select/update.
selectPetRow = PET;
const res = await jsonPatch(
`/portal/pets/not-a-uuid`,
{ coatType: "short" },
{ "X-Impersonation-Session-Id": SESSION_ID }
);
expect(res.status).toBe(404);
expect(updatedValues).toHaveLength(0);
});
it("returns 422 for an invalid coatType", async () => {
selectSessionRow = ACTIVE_SESSION;
selectPetRow = PET;
+188
View File
@@ -0,0 +1,188 @@
import { describe, it, expect, beforeEach, vi } from "vitest";
import { Hono } from "hono";
import {
validatePortalSession,
PORTAL_SESSION_IDLE_TTL_MS,
PORTAL_SESSION_MAX_LIFETIME_MS,
type PortalEnv,
} from "../middleware/portalSession.js";
const SESSION_ID = "770e8400-e29b-41d4-a716-446655440003";
const CLIENT_ID = "550e8400-e29b-41d4-a716-446655440001";
// Mutable test state driven per-case.
let selectSessionRow: Record<string, unknown> | null = null;
let sessionUpdates: Record<string, unknown>[] = [];
function resetMock() {
selectSessionRow = null;
sessionUpdates = [];
}
vi.mock("@groombook/db", () => {
function makeChainable(data: unknown[]): unknown {
const arr = [...data];
const chain = new Proxy(arr, {
get(target, prop) {
if (prop === "where" || prop === "orderBy" || prop === "limit") {
return () => chain;
}
// @ts-expect-error proxy index
return target[prop];
},
});
return chain;
}
const impersonationSessions = new Proxy(
{ _name: "impersonationSessions" },
{ get: (t, p) => (p === "_name" ? "impersonationSessions" : { table: "impersonationSessions", column: p }) }
);
return {
getDb: () => ({
select: () => ({
from: (table: { _name: string }) => {
if (table._name === "impersonationSessions") {
return makeChainable(selectSessionRow ? [selectSessionRow] : []);
}
return makeChainable([]);
},
}),
update: () => ({
set: (vals: Record<string, unknown>) => {
sessionUpdates.push(vals);
return { where: () => Promise.resolve(undefined) };
},
}),
}),
impersonationSessions,
eq: vi.fn(),
and: vi.fn(),
};
});
const app = new Hono<PortalEnv>();
app.use("/portal/*", validatePortalSession);
app.get("/portal/ping", (c) => c.json({ ok: true, clientId: c.get("portalClientId") }));
function ping(headers?: Record<string, string>) {
return app.request("/portal/ping", { method: "GET", headers });
}
beforeEach(() => resetMock());
describe("validatePortalSession — sliding expiration (GRO-2234)", () => {
it("extends an sso-bridge session's expiresAt on each authenticated request", async () => {
const now = Date.now();
// Session minted ~28 min ago, originally a 30-min idle window: it is still
// valid (2 min left) but a slow wizard would otherwise let it lapse.
selectSessionRow = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active",
reason: "sso-bridge",
startedAt: new Date(now - 28 * 60 * 1000),
expiresAt: new Date(now + 2 * 60 * 1000),
};
const res = await ping({ "X-Impersonation-Session-Id": SESSION_ID });
expect(res.status).toBe(200);
expect(sessionUpdates).toHaveLength(1);
const newExpiry = sessionUpdates[0]!.expiresAt as Date;
// Slid forward to ~now + 30 min (well past the original 2-min-left window).
expect(newExpiry.getTime()).toBeGreaterThan(now + PORTAL_SESSION_IDLE_TTL_MS - 5_000);
expect(newExpiry.getTime()).toBeLessThanOrEqual(now + PORTAL_SESSION_IDLE_TTL_MS + 5_000);
});
it("keeps a slow-wizard customer authorized past the original mint TTL", async () => {
const now = Date.now();
// Original mint window has fully elapsed in wall-clock terms, but the session
// was slid forward on the previous request, so it is still valid now.
selectSessionRow = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active",
reason: "sso-bridge",
startedAt: new Date(now - 35 * 60 * 1000),
expiresAt: new Date(now + 10 * 60 * 1000), // previously slid
};
const res = await ping({ "X-Impersonation-Session-Id": SESSION_ID });
expect(res.status).toBe(200);
const body = await res.json();
expect(body.clientId).toBe(CLIENT_ID);
});
it("never extends beyond startedAt + MAX_LIFETIME (bounded)", async () => {
const now = Date.now();
// Session started right at the absolute cap boundary minus a hair.
const startedAt = now - (PORTAL_SESSION_MAX_LIFETIME_MS - 5 * 60 * 1000);
selectSessionRow = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active",
reason: "sso-bridge",
startedAt: new Date(startedAt),
expiresAt: new Date(now + 60 * 1000),
};
const res = await ping({ "X-Impersonation-Session-Id": SESSION_ID });
expect(res.status).toBe(200);
expect(sessionUpdates).toHaveLength(1);
const newExpiry = (sessionUpdates[0]!.expiresAt as Date).getTime();
// Capped at startedAt + MAX_LIFETIME, NOT now + IDLE_TTL.
expect(newExpiry).toBeLessThanOrEqual(startedAt + PORTAL_SESSION_MAX_LIFETIME_MS + 1_000);
expect(newExpiry).toBeGreaterThan(now); // still extends at least a little
});
it("does NOT slide a staff-initiated impersonation session (no regression)", async () => {
const now = Date.now();
selectSessionRow = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active",
reason: "manager reviewing booking", // staff-console reason, free text
startedAt: new Date(now - 5 * 60 * 1000),
expiresAt: new Date(now + 20 * 60 * 1000),
};
const res = await ping({ "X-Impersonation-Session-Id": SESSION_ID });
expect(res.status).toBe(200);
expect(sessionUpdates).toHaveLength(0);
});
it("still rejects an already-expired session (no resurrection)", async () => {
const now = Date.now();
selectSessionRow = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active",
reason: "sso-bridge",
startedAt: new Date(now - 40 * 60 * 1000),
expiresAt: new Date(now - 60 * 1000), // already lapsed
};
const res = await ping({ "X-Impersonation-Session-Id": SESSION_ID });
expect(res.status).toBe(401);
expect(sessionUpdates).toHaveLength(0);
});
it("skips the write when the extension is below the slide threshold", async () => {
const now = Date.now();
// Already slid this minute: expiresAt is essentially now + IDLE_TTL already.
selectSessionRow = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active",
reason: "sso-bridge",
startedAt: new Date(now - 2 * 60 * 1000),
expiresAt: new Date(now + PORTAL_SESSION_IDLE_TTL_MS - 2_000),
};
const res = await ping({ "X-Impersonation-Session-Id": SESSION_ID });
expect(res.status).toBe(200);
expect(sessionUpdates).toHaveLength(0);
});
});
@@ -0,0 +1,154 @@
import { describe, it, expect, vi, beforeEach } from "vitest";
import { Hono } from "hono";
// GRO-2235: a duplicate active waitlist entry violates the partial unique index
// idx_waitlist_active_unique. postgres-js surfaces it as SQLSTATE 23505 — the
// handler must return a friendly 409, not a generic 500. The first insert still
// returns 201, and unrelated errors still surface as 500.
const CLIENT_ID = "550e8400-e29b-41d4-a716-446655440001";
const SESSION_ID = "770e8400-e29b-41d4-a716-446655440003";
const PET_ID = "880e8400-e29b-41d4-a716-446655440004";
const SERVICE_ID = "990e8400-e29b-41d4-a716-446655440005";
const futureDate = () => new Date(Date.now() + 30 * 60 * 1000);
const ACTIVE_SESSION = {
id: SESSION_ID,
clientId: CLIENT_ID,
status: "active" as const,
reason: "manual",
startedAt: new Date(),
expiresAt: futureDate(),
createdAt: new Date(),
};
// Behaviour knob for the waitlist insert: "ok" returns a row, "duplicate" throws
// a postgres-js-shaped unique-violation, "other" throws an unrelated error.
let waitlistInsertMode: "ok" | "duplicate" | "other" = "ok";
function resetMock() {
waitlistInsertMode = "ok";
}
function tableProxy(name: string) {
return new Proxy(
{ _name: name },
{ get: (t, p) => (p === "_name" ? name : { table: name, column: p }) }
);
}
vi.mock("@groombook/db", () => {
function makeChainable(data: unknown[]): unknown {
const arr = [...data];
const chain = new Proxy(arr, {
get(target, prop) {
if (prop === "where" || prop === "orderBy" || prop === "limit") {
return () => chain;
}
// @ts-expect-error proxy
return target[prop];
},
});
return chain;
}
const impersonationSessions = tableProxy("impersonationSessions");
const waitlistEntries = tableProxy("waitlistEntries");
const impersonationAuditLogs = tableProxy("impersonationAuditLogs");
return {
getDb: () => ({
select: () => ({
from: (table: { _name: string }) => {
if (table._name === "impersonationSessions") {
return makeChainable([ACTIVE_SESSION]);
}
return makeChainable([]);
},
}),
insert: (table: { _name: string }) => ({
values: (vals: Record<string, unknown>) => ({
returning: () => {
if (table._name === "waitlistEntries") {
if (waitlistInsertMode === "duplicate") {
throw Object.assign(new Error("duplicate key value"), { code: "23505" });
}
if (waitlistInsertMode === "other") {
throw Object.assign(new Error("not null violation"), { code: "23502" });
}
return [{ id: "entry-1", ...vals }];
}
// impersonationAuditLogs and anything else: succeed silently.
return [{ id: "audit-1", ...vals }];
},
}),
}),
update: () => ({
set: () => ({ where: () => Promise.resolve() }),
}),
}),
impersonationSessions,
waitlistEntries,
impersonationAuditLogs,
appointments: tableProxy("appointments"),
clients: tableProxy("clients"),
pets: tableProxy("pets"),
services: tableProxy("services"),
staff: tableProxy("staff"),
invoices: tableProxy("invoices"),
invoiceLineItems: tableProxy("invoiceLineItems"),
eq: vi.fn(),
and: vi.fn(),
inArray: vi.fn(),
};
});
const { portalRouter } = await import("../routes/portal.js");
const app = new Hono();
app.route("/portal", portalRouter);
function postWaitlist(body: unknown) {
return app.request("/portal/waitlist", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-Impersonation-Session-Id": SESSION_ID,
},
body: JSON.stringify(body),
});
}
const VALID_BODY = {
petId: PET_ID,
serviceId: SERVICE_ID,
preferredDate: "2026-07-01",
preferredTime: "09:00",
};
beforeEach(() => resetMock());
describe("POST /portal/waitlist duplicate handling (GRO-2235)", () => {
it("returns 201 for the first insert", async () => {
waitlistInsertMode = "ok";
const res = await postWaitlist(VALID_BODY);
expect(res.status).toBe(201);
});
it("returns 409 with a friendly message for a duplicate (23505)", async () => {
waitlistInsertMode = "duplicate";
const res = await postWaitlist(VALID_BODY);
expect(res.status).toBe(409);
const json = (await res.json()) as { error: string };
expect(json.error).toBe(
"You already have a booking for this pet at that date and time."
);
});
it("still surfaces unrelated DB errors as 500", async () => {
waitlistInsertMode = "other";
const res = await postWaitlist(VALID_BODY);
expect(res.status).toBe(500);
});
});
+44
View File
@@ -0,0 +1,44 @@
import { describe, it, expect, vi } from "vitest";
import { Hono } from "hono";
// Mock auth lib so getAuth() throws — non-bypass paths hit the 503 "not configured" guard.
vi.mock("../lib/auth.js", () => ({
getAuth: () => {
throw new Error("auth not configured");
},
initAuth: vi.fn(),
getActiveProviders: vi.fn(() => []),
}));
describe("authMiddleware bypass: /api/readyz", () => {
it("serves /api/readyz without auth (bypass before auth check)", async () => {
// Ensure AUTH_DISABLED is not set so the bypass is exercised, not AUTH_DISABLED shortcut.
const prev = process.env.AUTH_DISABLED;
delete process.env.AUTH_DISABLED;
const { authMiddleware } = await import("../middleware/auth.js");
const app = new Hono();
app.use("/api/*", authMiddleware);
app.get("/api/readyz", (c) => c.json({ status: "ok" }, 200));
const res = await app.request("/api/readyz", { method: "GET" });
expect(res.status).toBe(200);
if (prev !== undefined) process.env.AUTH_DISABLED = prev;
});
it("blocks non-whitelisted /api/* paths when auth is not configured", async () => {
const prev = process.env.AUTH_DISABLED;
delete process.env.AUTH_DISABLED;
const { authMiddleware } = await import("../middleware/auth.js");
const app = new Hono();
app.use("/api/*", authMiddleware);
app.get("/api/staff", (c) => c.json({ ok: true }, 200));
const res = await app.request("/api/staff", { method: "GET" });
expect(res.status).toBe(503);
if (prev !== undefined) process.env.AUTH_DISABLED = prev;
});
});
+87
View File
@@ -0,0 +1,87 @@
import { describe, it, expect, vi, beforeEach } from "vitest";
import { Hono } from "hono";
// ─── Mock db module ───────────────────────────────────────────────────────────
let selectImpl: () => Promise<unknown>;
vi.mock("@groombook/db", () => {
const staff = new Proxy(
{ _name: "staff" },
{
get(_target, prop) {
if (prop === "_name") return "staff";
return { table: "staff", column: prop };
},
}
);
return {
getDb: () => ({
select: (_fields: unknown) => ({
from: (_table: unknown) => ({
limit: (_n: number) => selectImpl(),
}),
}),
}),
staff,
};
});
// ─── Build test app ───────────────────────────────────────────────────────────
async function makeApp() {
// Import after mocks are in place
const { getDb, staff } = await import("@groombook/db");
const app = new Hono();
app.get("/api/readyz", async (c) => {
try {
await getDb().select({ id: staff.id }).from(staff).limit(1);
return c.json({ status: "ready" }, 200);
} catch (err) {
console.error("[readyz] DB check failed:", err);
return c.json({ status: "degraded", check: "db" }, 503);
}
});
return app;
}
// ─── Tests ────────────────────────────────────────────────────────────────────
describe("GET /api/readyz", () => {
beforeEach(() => {
vi.restoreAllMocks();
});
it("returns 200 {status:'ready'} when DB query succeeds", async () => {
selectImpl = () => Promise.resolve([{ id: "staff-1" }]);
const app = await makeApp();
const res = await app.request("/api/readyz", { method: "GET" });
const body = (await res.json()) as Record<string, unknown>;
expect(res.status).toBe(200);
expect(body.status).toBe("ready");
});
it("returns 503 {status:'degraded',check:'db'} when DB query throws", async () => {
selectImpl = () => Promise.reject(new Error("42P01: relation staff does not exist"));
const consoleSpy = vi.spyOn(console, "error").mockImplementation(() => {});
const app = await makeApp();
const res = await app.request("/api/readyz", { method: "GET" });
const body = (await res.json()) as Record<string, unknown>;
expect(res.status).toBe(503);
expect(body.status).toBe("degraded");
expect(body.check).toBe("db");
// Raw SQL / driver error must NOT appear in the response body
expect(JSON.stringify(body)).not.toContain("42P01");
expect(JSON.stringify(body)).not.toContain("relation");
consoleSpy.mockRestore();
});
});
+335
View File
@@ -0,0 +1,335 @@
import { describe, it, expect } from "vitest";
import {
haversineKm,
estimateLeg,
nearestNeighborOrder,
optimizeRoute,
detectScheduleConflicts,
recomputeLegsForOrder,
MAX_STOPS_PER_ROUTE,
type RouteStopInput,
} from "../services/routeOptimization.js";
import type { FetchLike } from "../services/geocoding.js";
/** Builds a fake fetch returning a single JSON body, recording called URLs. */
function fakeFetch(
body: unknown,
init: { ok?: boolean; status?: number; statusText?: string } = {}
): { fetchImpl: FetchLike; calls: string[] } {
const calls: string[] = [];
const fetchImpl: FetchLike = async (url) => {
calls.push(url);
return {
ok: init.ok ?? true,
status: init.status ?? 200,
statusText: init.statusText ?? "OK",
json: async () => body,
};
};
return { fetchImpl, calls };
}
function stop(appointmentId: string, lat: number, lng: number): RouteStopInput {
return { appointmentId, latitude: lat, longitude: lng };
}
describe("haversineKm", () => {
it("is zero for the same point", () => {
expect(haversineKm({ latitude: 40, longitude: -74 }, { latitude: 40, longitude: -74 })).toBe(0);
});
it("approximates 1 degree of latitude as ~111km", () => {
const d = haversineKm({ latitude: 0, longitude: 0 }, { latitude: 1, longitude: 0 });
expect(d).toBeGreaterThan(110);
expect(d).toBeLessThan(112);
});
});
describe("estimateLeg", () => {
it("applies the circuity factor and average speed", () => {
const a = { latitude: 0, longitude: 0 };
const b = { latitude: 0, longitude: 1 };
const { distanceKm, mins } = estimateLeg(a, b);
// ~111km straight * 1.3 circuity ≈ 144.6km; at 40km/h ≈ 217 min
expect(distanceKm).toBeGreaterThan(140);
expect(distanceKm).toBeLessThan(150);
expect(mins).toBeGreaterThan(200);
expect(mins).toBeLessThan(230);
expect(Number.isInteger(mins)).toBe(true);
});
});
describe("nearestNeighborOrder", () => {
it("returns trivial order for 0 or 1 points", () => {
expect(nearestNeighborOrder([])).toEqual([]);
expect(nearestNeighborOrder([{ latitude: 1, longitude: 1 }])).toEqual([0]);
});
it("greedily visits the nearest unvisited point", () => {
// Points on a line; scrambled input order.
const points = [
{ latitude: 0, longitude: 0 }, // 0 (start)
{ latitude: 0, longitude: 5 }, // 1 (far)
{ latitude: 0, longitude: 1 }, // 2
{ latitude: 0, longitude: 2 }, // 3
];
expect(nearestNeighborOrder(points, 0)).toEqual([0, 2, 3, 1]);
});
});
describe("optimizeRoute — nearest-neighbor fallback (no API key)", () => {
it("returns an empty route for no stops", async () => {
const r = await optimizeRoute([]);
expect(r.stops).toHaveLength(0);
expect(r.totalTravelMins).toBe(0);
expect(r.totalDistanceKm).toBe(0);
expect(r.provider).toBe("nearest_neighbor");
expect(r.chunked).toBe(false);
});
it("handles a single stop with null travel-from-prev", async () => {
const r = await optimizeRoute([stop("a", 40, -74)]);
expect(r.stops).toHaveLength(1);
expect(r.stops[0]!.travelMinsFromPrev).toBeNull();
expect(r.stops[0]!.travelDistanceKmFromPrev).toBeNull();
expect(r.totalTravelMins).toBe(0);
});
it("orders multiple stops greedily and sums totals", async () => {
const stops = [
stop("start", 0, 0),
stop("far", 0, 5),
stop("near1", 0, 1),
stop("near2", 0, 2),
];
const r = await optimizeRoute(stops);
expect(r.provider).toBe("nearest_neighbor");
expect(r.stops.map((s) => s.appointmentId)).toEqual([
"start",
"near1",
"near2",
"far",
]);
// First stop has no inbound leg.
expect(r.stops[0]!.travelMinsFromPrev).toBeNull();
// Remaining stops have positive travel.
for (const s of r.stops.slice(1)) {
expect(s.travelMinsFromPrev!).toBeGreaterThan(0);
expect(s.travelDistanceKmFromPrev!).toBeGreaterThan(0);
}
const summed = r.stops.reduce((acc, s) => acc + (s.travelMinsFromPrev ?? 0), 0);
expect(r.totalTravelMins).toBe(summed);
});
});
describe("optimizeRoute — Google Directions path", () => {
it("uses optimized waypoint order and real leg metrics, dropping the return leg", async () => {
const stops = [stop("A", 0, 0), stop("B", 0, 1), stop("C", 0, 2)];
// waypoints = [B, C]; optimizer reorders them to [C, B] (waypoint_order [1,0]).
// legs: A->C, C->B, B->A(return). The return leg must be dropped.
const { fetchImpl, calls } = fakeFetch({
status: "OK",
routes: [
{
waypoint_order: [1, 0],
legs: [
{ distance: { value: 2000 }, duration: { value: 600 } }, // A->C
{ distance: { value: 1000 }, duration: { value: 300 } }, // C->B
{ distance: { value: 3000 }, duration: { value: 900 } }, // B->A (return, dropped)
],
},
],
});
const r = await optimizeRoute(stops, { googleApiKey: "key", fetchImpl });
expect(r.provider).toBe("google");
expect(r.stops.map((s) => s.appointmentId)).toEqual(["A", "C", "B"]);
expect(r.stops[0]!.travelMinsFromPrev).toBeNull();
expect(r.stops[1]!.travelDistanceKmFromPrev).toBe(2); // 2000m -> 2km
expect(r.stops[1]!.travelMinsFromPrev).toBe(10); // 600s -> 10min
expect(r.stops[2]!.travelDistanceKmFromPrev).toBe(1); // 1000m
expect(r.stops[2]!.travelMinsFromPrev).toBe(5); // 300s
expect(r.totalDistanceKm).toBe(3);
expect(r.totalTravelMins).toBe(15);
expect(decodeURIComponent(calls[0]!)).toContain("optimize:true");
});
it("falls back to the heuristic when Google returns a non-OK status", async () => {
const stops = [stop("A", 0, 0), stop("B", 0, 1), stop("C", 0, 2)];
const { fetchImpl } = fakeFetch({ status: "REQUEST_DENIED", error_message: "bad key" });
const r = await optimizeRoute(stops, { googleApiKey: "key", fetchImpl });
// Provider label reflects the chosen strategy (google requested) but a
// warning records the degradation and stops are still ordered.
expect(r.stops).toHaveLength(3);
expect(r.warnings.some((w) => w.includes("offline heuristic"))).toBe(true);
expect(r.stops[0]!.travelMinsFromPrev).toBeNull();
});
});
describe("optimizeRoute — >25 stop chunking", () => {
it("splits into sub-routes with a warning and continuous stop ordering", async () => {
const stops: RouteStopInput[] = [];
for (let i = 0; i < MAX_STOPS_PER_ROUTE + 5; i++) {
stops.push(stop(`s${i}`, 0, i * 0.1));
}
const r = await optimizeRoute(stops);
expect(r.chunked).toBe(true);
expect(r.subRouteCount).toBe(2);
expect(r.warnings.some((w) => w.includes("sub-routes"))).toBe(true);
expect(r.stops).toHaveLength(MAX_STOPS_PER_ROUTE + 5);
// Only the very first stop of the whole route lacks an inbound leg.
expect(r.stops[0]!.travelMinsFromPrev).toBeNull();
expect(r.stops.slice(1).every((s) => s.travelMinsFromPrev !== null)).toBe(true);
// All appointment ids preserved exactly once.
expect(new Set(r.stops.map((s) => s.appointmentId)).size).toBe(stops.length);
});
});
describe("detectScheduleConflicts", () => {
const at = (iso: string) => new Date(iso);
it("returns no conflict and null gaps for an empty or single-stop route", () => {
expect(detectScheduleConflicts([])).toEqual([]);
const one = detectScheduleConflicts([
{
appointmentStartTime: at("2026-06-08T09:00:00Z"),
appointmentEndTime: at("2026-06-08T10:00:00Z"),
travelMinsFromPrev: null,
bufferMins: 15,
},
]);
expect(one).toEqual([
{
hasConflict: false,
scheduleGapMins: null,
requiredGapMins: null,
shortfallMins: null,
},
]);
});
it("flags a tight schedule when gap < travel + buffer", () => {
// Stop 1 ends 10:00, stop 2 starts 10:20 → 20min gap. Travel 15 + buffer 15
// = 30 required → shortfall 10 → conflict.
const flags = detectScheduleConflicts([
{
appointmentStartTime: at("2026-06-08T09:00:00Z"),
appointmentEndTime: at("2026-06-08T10:00:00Z"),
travelMinsFromPrev: null,
bufferMins: 0,
},
{
appointmentStartTime: at("2026-06-08T10:20:00Z"),
appointmentEndTime: at("2026-06-08T11:00:00Z"),
travelMinsFromPrev: 15,
bufferMins: 15,
},
]);
expect(flags[0]!.hasConflict).toBe(false);
expect(flags[1]).toEqual({
hasConflict: true,
scheduleGapMins: 20,
requiredGapMins: 30,
shortfallMins: 10,
});
});
it("does not flag when the gap comfortably covers travel + buffer", () => {
// 90min gap, 15 travel + 15 buffer = 30 required → 60 slack → no conflict.
const flags = detectScheduleConflicts([
{
appointmentStartTime: at("2026-06-08T09:00:00Z"),
appointmentEndTime: at("2026-06-08T10:00:00Z"),
travelMinsFromPrev: null,
bufferMins: 0,
},
{
appointmentStartTime: at("2026-06-08T11:30:00Z"),
appointmentEndTime: at("2026-06-08T12:00:00Z"),
travelMinsFromPrev: 15,
bufferMins: 15,
},
]);
expect(flags[1]).toEqual({
hasConflict: false,
scheduleGapMins: 90,
requiredGapMins: 30,
shortfallMins: -60,
});
});
it("treats a null travelMinsFromPrev as zero travel", () => {
const flags = detectScheduleConflicts([
{
appointmentStartTime: at("2026-06-08T09:00:00Z"),
appointmentEndTime: at("2026-06-08T10:00:00Z"),
travelMinsFromPrev: null,
bufferMins: 0,
},
{
appointmentStartTime: at("2026-06-08T10:05:00Z"),
appointmentEndTime: at("2026-06-08T11:00:00Z"),
travelMinsFromPrev: null,
bufferMins: 15,
},
]);
// 5min gap vs 0 travel + 15 buffer = 15 required → conflict, shortfall 10.
expect(flags[1]!.hasConflict).toBe(true);
expect(flags[1]!.requiredGapMins).toBe(15);
expect(flags[1]!.shortfallMins).toBe(10);
});
it("flags overlapping appointments (negative gap) as conflicts", () => {
const flags = detectScheduleConflicts([
{
appointmentStartTime: at("2026-06-08T09:00:00Z"),
appointmentEndTime: at("2026-06-08T10:00:00Z"),
travelMinsFromPrev: null,
bufferMins: 0,
},
{
appointmentStartTime: at("2026-06-08T09:30:00Z"),
appointmentEndTime: at("2026-06-08T10:30:00Z"),
travelMinsFromPrev: 10,
bufferMins: 15,
},
]);
expect(flags[1]!.scheduleGapMins).toBe(-30);
expect(flags[1]!.hasConflict).toBe(true);
expect(flags[1]!.shortfallMins).toBe(55);
});
});
describe("recomputeLegsForOrder", () => {
it("returns null travel for an empty or single-point order", () => {
expect(recomputeLegsForOrder([])).toEqual([]);
expect(recomputeLegsForOrder([{ latitude: 40, longitude: -74 }])).toEqual([
{ travelMinsFromPrev: null, travelDistanceKmFromPrev: null },
]);
});
it("estimates each leg for the fixed given order without reordering", () => {
const pts = [
{ latitude: 0, longitude: 0 },
{ latitude: 0, longitude: 1 },
{ latitude: 0, longitude: 2 },
];
const legs = recomputeLegsForOrder(pts);
expect(legs).toHaveLength(3);
expect(legs[0]).toEqual({
travelMinsFromPrev: null,
travelDistanceKmFromPrev: null,
});
// Each leg equals estimateLeg between adjacent points (no optimization).
const e01 = estimateLeg(pts[0]!, pts[1]!);
const e12 = estimateLeg(pts[1]!, pts[2]!);
expect(legs[1]).toEqual({
travelMinsFromPrev: e01.mins,
travelDistanceKmFromPrev: e01.distanceKm,
});
expect(legs[2]).toEqual({
travelMinsFromPrev: e12.mins,
travelDistanceKmFromPrev: e12.distanceKm,
});
});
});
+145
View File
@@ -0,0 +1,145 @@
import { describe, it, expect, vi, beforeEach } from "vitest";
import { Hono } from "hono";
// ─── Mocks ──────────────────────────────────────────────────────────────────
// GRO-2294: GET /api/admin/settings must not return the encrypted
// googleMapsApiKey ciphertext, on either the existing-row or auto-create branch.
let selectRows: Record<string, unknown>[] = [];
let insertReturning: Record<string, unknown>[] = [];
let updateReturning: Record<string, unknown>[] = [];
function makeChainable(data: unknown[]): unknown {
const arr = [...data];
const chain = new Proxy(arr, {
get(target, prop) {
if (prop === "where" || prop === "orderBy" || prop === "limit") {
return () => chain;
}
// @ts-expect-error proxy passthrough
return target[prop];
},
});
return chain;
}
vi.mock("@groombook/db", () => {
const businessSettings = new Proxy(
{ _name: "business_settings" },
{ get: (_t, p) => (p === "_name" ? "business_settings" : { column: p }) }
);
return {
getDb: () => ({
select: () => ({ from: () => makeChainable(selectRows) }),
insert: () => ({
values: () => ({ returning: () => insertReturning }),
}),
update: () => ({
set: () => ({ where: () => ({ returning: () => updateReturning }) }),
}),
}),
businessSettings,
eq: vi.fn(),
};
});
vi.mock("../lib/s3.js", () => ({
getPresignedUploadUrl: vi.fn(),
deleteObject: vi.fn(),
putObject: vi.fn(),
getObject: vi.fn(),
}));
const { settingsRouter } = await import("../routes/settings.js");
const app = new Hono();
app.route("/settings", settingsRouter);
// PATCH /settings is guarded by requireSuperUser(), which reads the staff record
// from context. Inject a super-user staff row so the handler runs.
const patchApp = new Hono<{
Variables: { staff: { id: string; isSuperUser: boolean } };
}>();
patchApp.use("*", async (c, next) => {
c.set("staff", { id: "staff-1", isSuperUser: true });
await next();
});
patchApp.route("/settings", settingsRouter);
const FULL_ROW = {
id: "settings-uuid-1",
businessName: "GroomBook",
primaryColor: "#4f8a6f",
accentColor: "#8b7355",
routeOptimizationProvider: "google",
googleMapsApiKey: "ENCRYPTED::super-secret-ciphertext",
createdAt: new Date(),
updatedAt: new Date(),
};
describe("GET /settings — googleMapsApiKey redaction (GRO-2294)", () => {
beforeEach(() => {
selectRows = [];
insertReturning = [];
});
it("omits googleMapsApiKey from an existing settings row", async () => {
selectRows = [{ ...FULL_ROW }];
const res = await app.request("/settings", { method: "GET" });
expect(res.status).toBe(200);
const body = (await res.json()) as Record<string, unknown>;
expect(body).not.toHaveProperty("googleMapsApiKey");
// Non-secret fields are still returned.
expect(body.businessName).toBe("GroomBook");
expect(body.routeOptimizationProvider).toBe("google");
});
it("omits googleMapsApiKey from the auto-create branch", async () => {
selectRows = [];
insertReturning = [{ ...FULL_ROW, id: "settings-uuid-new" }];
const res = await app.request("/settings", { method: "GET" });
expect(res.status).toBe(200);
const body = (await res.json()) as Record<string, unknown>;
expect(body).not.toHaveProperty("googleMapsApiKey");
expect(body.id).toBe("settings-uuid-new");
});
});
describe("PATCH /settings — googleMapsApiKey redaction (GRO-2299)", () => {
beforeEach(() => {
selectRows = [];
insertReturning = [];
updateReturning = [];
});
function patchRequest(body: Record<string, unknown>) {
return patchApp.request("/settings", {
method: "PATCH",
headers: { "content-type": "application/json" },
body: JSON.stringify(body),
});
}
it("omits googleMapsApiKey from the PATCH response", async () => {
selectRows = [{ ...FULL_ROW }];
updateReturning = [{ ...FULL_ROW, businessName: "Updated Name" }];
const res = await patchRequest({ businessName: "Updated Name" });
expect(res.status).toBe(200);
const body = (await res.json()) as Record<string, unknown>;
expect(body).not.toHaveProperty("googleMapsApiKey");
// Non-secret updated fields are still returned.
expect(body.businessName).toBe("Updated Name");
expect(body.routeOptimizationProvider).toBe("google");
});
it("omits googleMapsApiKey on the auto-create-then-update branch", async () => {
selectRows = [];
insertReturning = [{ ...FULL_ROW, id: "settings-uuid-new" }];
updateReturning = [{ ...FULL_ROW, id: "settings-uuid-new" }];
const res = await patchRequest({ primaryColor: "#123456" });
expect(res.status).toBe(200);
const body = (await res.json()) as Record<string, unknown>;
expect(body).not.toHaveProperty("googleMapsApiKey");
expect(body.id).toBe("settings-uuid-new");
});
});
+70
View File
@@ -184,6 +184,66 @@ describe("POST /portal/waitlist", () => {
expect(insertedValues).toHaveLength(1);
});
it("normalizes HH:MM:SS preferredTime and returns 201 (GRO-2211)", async () => {
selectSessionRow = ACTIVE_SESSION;
const res = await jsonRequest("POST", "/portal/waitlist", {
petId: VALID_UUID_3,
serviceId: VALID_UUID_4,
preferredDate: "2026-03-25",
preferredTime: "10:00:00",
}, { "X-Impersonation-Session-Id": VALID_UUID_5 });
expect(res.status).toBe(201);
expect(insertedValues[0]?.preferredTime).toBe("10:00:00");
});
it("normalizes HH:MM preferredTime to HH:MM:SS before insert (GRO-2211)", async () => {
selectSessionRow = ACTIVE_SESSION;
const res = await jsonRequest("POST", "/portal/waitlist", {
petId: VALID_UUID_3,
serviceId: VALID_UUID_4,
preferredDate: "2026-03-25",
preferredTime: "10:00",
}, { "X-Impersonation-Session-Id": VALID_UUID_5 });
expect(res.status).toBe(201);
expect(insertedValues[0]?.preferredTime).toBe("10:00:00");
});
it("returns 400 (not 500) for a full ISO datetime preferredTime (GRO-2211)", async () => {
selectSessionRow = ACTIVE_SESSION;
const res = await jsonRequest("POST", "/portal/waitlist", {
petId: VALID_UUID_3,
serviceId: VALID_UUID_4,
preferredDate: "2026-03-25",
preferredTime: "2026-06-09T10:00:00.000Z",
}, { "X-Impersonation-Session-Id": VALID_UUID_5 });
expect(res.status).toBe(400);
expect(insertedValues).toHaveLength(0);
});
it("returns 400 for a malformed preferredDate (GRO-2211)", async () => {
selectSessionRow = ACTIVE_SESSION;
const res = await jsonRequest("POST", "/portal/waitlist", {
petId: VALID_UUID_3,
serviceId: VALID_UUID_4,
preferredDate: "03/25/2026",
preferredTime: "10:00",
}, { "X-Impersonation-Session-Id": VALID_UUID_5 });
expect(res.status).toBe(400);
expect(insertedValues).toHaveLength(0);
});
it("returns 400 for an out-of-range preferredTime (GRO-2211)", async () => {
selectSessionRow = ACTIVE_SESSION;
const res = await jsonRequest("POST", "/portal/waitlist", {
petId: VALID_UUID_3,
serviceId: VALID_UUID_4,
preferredDate: "2026-03-25",
preferredTime: "25:99",
}, { "X-Impersonation-Session-Id": VALID_UUID_5 });
expect(res.status).toBe(400);
expect(insertedValues).toHaveLength(0);
});
it("returns 401 without session", async () => {
const res = await jsonRequest("POST", "/portal/waitlist", {
petId: VALID_UUID_3,
@@ -258,6 +318,16 @@ describe("PATCH /portal/waitlist/:id", () => {
expect(updatedValues[0]?.status).toBe("cancelled");
});
it("returns 400 (not 500) for a full ISO datetime preferredTime on update (GRO-2211)", async () => {
selectSessionRow = ACTIVE_SESSION;
selectRows = [WAITLIST_ENTRY];
const res = await jsonRequest("PATCH", `/portal/waitlist/${VALID_UUID_1}`, {
preferredTime: "2026-06-09T10:00:00.000Z",
}, { "X-Impersonation-Session-Id": VALID_UUID_5 });
expect(res.status).toBe(400);
expect(updatedValues).toHaveLength(0);
});
it("returns 401 without session", async () => {
const res = await jsonRequest("PATCH", `/portal/waitlist/${VALID_UUID_1}`, {
status: "cancelled",
+52 -4
View File
@@ -3,6 +3,7 @@ import { Hono } from "hono";
import { logger } from "hono/logger";
import { cors } from "hono/cors";
import { getAuth, initAuth, getActiveProviders } from "./lib/auth.js";
import { enforceAuthCors } from "./lib/auth-cors.js";
import { clientsRouter } from "./routes/clients.js";
import { petsRouter } from "./routes/pets.js";
import { servicesRouter } from "./routes/services.js";
@@ -20,6 +21,7 @@ import { settingsRouter } from "./routes/settings.js";
import { authProviderRouter } from "./routes/authProvider.js";
import { searchRouter } from "./routes/search.js";
import { bufferRulesRouter } from "./routes/buffer-rules.js";
import { routesRouter } from "./routes/routes.js";
import { getObject } from "./lib/s3.js";
import { calendarRouter } from "./routes/calendar.js";
import { setupRouter } from "./routes/setup.js";
@@ -63,6 +65,17 @@ app.use(
app.get("/health", (c) => c.json({ status: "ok" }));
// /api/health: used by Gateway HTTPRoute (/api/* → API pod)
app.get("/api/health", (c) => c.json({ status: "ok" }));
// /api/readyz: DB-touching deep health check consumed by monitoring (not K8s probes)
// Distinct from /health so a dropped schema triggers an alert without cycling pods (GRO-2678)
app.get("/api/readyz", async (c) => {
try {
await getDb().select({ id: staff.id }).from(staff).limit(1);
return c.json({ status: "ready" }, 200);
} catch (err) {
console.error("[readyz] DB check failed:", err);
return c.json({ status: "degraded", check: "db" }, 503);
}
});
// Public booking routes — no auth required, must be registered before auth middleware
app.route("/api/book", bookRouter);
@@ -199,9 +212,10 @@ api.use("*", resolveStaffMiddleware);
// Better-Auth handler — mounted as sub-app to handle all /api/auth/* routes
// authMiddleware and resolveStaffMiddleware both skip /api/auth/ paths
const authRouter = new Hono();
authRouter.all("/*", (c) => {
authRouter.all("/*", async (c) => {
try {
return getAuth().handler(c.req.raw);
const res = await getAuth().handler(c.req.raw);
return enforceAuthCors(c.req.header("origin"), TRUSTED_ORIGINS, res);
} catch {
return c.json({ error: "Authentication not configured" }, 503);
}
@@ -220,6 +234,10 @@ api.use("/reports/*", requireRole("manager"));
api.use("/invoices/*", requireRole("manager", "groomer"));
api.use("/impersonation/*", requireRole("manager"));
// Route optimization: manager (any groomer's route) or groomer (own route only,
// enforced in-handler). Receptionists have no access. (GRO-2155)
api.use("/routes/*", requireRole("manager", "groomer"));
// Manager + Receptionist only (groomers have no access): appointment-groups, grooming-logs, waitlist
api.use("/appointment-groups/*", requireRole("manager", "receptionist"));
api.use("/grooming-logs/*", requireRole("manager", "receptionist"));
@@ -235,6 +253,15 @@ api.on(
requireRole("manager", "receptionist", "groomer")
);
// Route-optimization geocoding endpoints are manager-only (GRO-2154), stricter
// than the general client write guard below. Registered FIRST so receptionists
// are rejected here before the manager+receptionist guard can admit them.
api.on(
["POST"],
["/clients/geocode-batch", "/clients/:clientId/geocode"],
requireRole("manager")
);
// Clients, appointments: all roles may read; only manager + receptionist may write
api.on(
["POST", "PUT", "PATCH", "DELETE"],
@@ -274,15 +301,36 @@ api.route("/admin/auth-provider", authProviderRouter);
api.route("/admin/seed", adminSeedRouter);
api.route("/search", searchRouter);
api.route("/buffer-rules", bufferRulesRouter);
api.route("/routes", routesRouter);
// Start the HTTP server first so /health and public routes are available immediately.
// Auth initialization runs afterward with retry — a transient DB ECONNRESET at boot
// must not crash the process (GRO-2652). Auth routes return 503 until initAuth succeeds.
const port = Number(process.env.PORT ?? 3000);
await initAuth();
console.log(`API server listening on port ${port}`);
const server = serve({ fetch: app.fetch, port });
console.log(`API server listening on port ${port}`);
// Start background reminder scheduler (runs every minute to check for upcoming appointments)
startReminderScheduler();
let initAttempt = 0;
while (true) {
try {
await initAuth();
break;
} catch (err) {
initAttempt++;
const delay = Math.min(2 ** initAttempt * 500, 30_000);
console.error(`[auth] initAuth attempt ${initAttempt} failed: ${err}`);
if (initAttempt >= 10) {
console.error("[auth] auth init permanently failed — auth endpoints will serve 503");
break;
}
console.error(`[auth] retrying in ${delay}ms`);
await new Promise((r) => setTimeout(r, delay));
}
}
function shutdown() {
console.log("Shutting down gracefully...");
// SIGTERM/SIGINT → server.close() → callback → process.exit(0)
+22
View File
@@ -0,0 +1,22 @@
/**
* Enforces the trusted-origins CORS allowlist on a raw Response from Better Auth.
* Better Auth reflects the request Origin into Access-Control-Allow-Origin
* regardless of the trustedOrigins config, allowing credentialed cross-origin reads
* from arbitrary attacker origins. This wrapper strips CORS headers for any origin
* not in the allowlist. (GRO-2586)
*/
export function enforceAuthCors(
requestOrigin: string | undefined,
trustedOrigins: string[],
res: Response
): Response {
const headers = new Headers(res.headers);
if (requestOrigin && trustedOrigins.includes(requestOrigin)) {
headers.set("Access-Control-Allow-Origin", requestOrigin);
headers.set("Access-Control-Allow-Credentials", "true");
} else {
headers.delete("Access-Control-Allow-Origin");
headers.delete("Access-Control-Allow-Credentials");
}
return new Response(res.body, { status: res.status, statusText: res.statusText, headers });
}
+31 -9
View File
@@ -118,18 +118,34 @@ export async function initAuth(): Promise<void> {
updateAge: 60 * 60 * 24,
cookieCache: { enabled: false },
},
trustedOrigins: [process.env.CORS_ORIGIN ?? "http://localhost:5173"],
trustedOrigins: (process.env.CORS_ORIGIN ?? "http://localhost:5173")
.split(",").map((s) => s.trim()).filter(Boolean),
});
return;
}
// Step 1: Try to load config from DB
// Step 1: Try to load config from DB, with retry-with-backoff for transient ECONNRESET (GRO-2652).
// A single connection reset during boot must not abort initialization.
const db = getDb();
const [dbConfig] = await db
.select()
.from(authProviderConfig)
.where(eq(authProviderConfig.enabled, true))
.limit(1);
let dbQueryRows: (typeof authProviderConfig.$inferSelect)[] = [];
let dbAttempt = 0;
while (true) {
try {
dbQueryRows = await db
.select()
.from(authProviderConfig)
.where(eq(authProviderConfig.enabled, true))
.limit(1);
break;
} catch (err) {
dbAttempt++;
if (dbAttempt >= 5) throw err;
const delay = Math.min(1000 * 2 ** (dbAttempt - 1), 8_000);
console.warn(`[auth] DB query attempt ${dbAttempt} failed (${err}), retrying in ${delay}ms`);
await new Promise((r) => setTimeout(r, delay));
}
}
const [dbConfig] = dbQueryRows;
let providerConfig: {
providerId: string;
@@ -308,9 +324,15 @@ export async function initAuth(): Promise<void> {
maxAge: 5 * 60, // 5 minutes
},
},
trustedOrigins: [process.env.CORS_ORIGIN ?? "http://localhost:5173"],
trustedOrigins: (process.env.CORS_ORIGIN ?? "http://localhost:5173")
.split(",").map((s) => s.trim()).filter(Boolean),
});
})();
await authInitPromise;
try {
await authInitPromise;
} catch (err) {
authInitPromise = null; // allow retry on next call
throw err;
}
}
+1 -1
View File
@@ -23,7 +23,7 @@ if (process.env.AUTH_DISABLED === "true") {
}
export const authMiddleware: MiddlewareHandler = async (c, next) => {
if (c.req.path.startsWith("/api/auth/") || c.req.path === "/api/health") {
if (c.req.path.startsWith("/api/auth/") || c.req.path === "/api/health" || c.req.path === "/api/readyz") {
await next();
return;
}
+46 -1
View File
@@ -8,6 +8,32 @@ export interface PortalEnv {
};
}
/**
* Idle lifetime of an SSO-bridge portal impersonation session. Each authenticated
* portal request slides `expiresAt` forward to `now + IDLE_TTL`, so an actively-used
* session (e.g. a customer working through the multi-step Book New wizard) never
* lapses mid-flow. Matches the staff-console impersonation idle window
* (SESSION_TIMEOUT_MINUTES in routes/impersonation.ts). (GRO-2234)
*/
export const PORTAL_SESSION_IDLE_TTL_MS = 30 * 60 * 1000;
/**
* Absolute cap on a single SSO-bridge portal session's lifetime, measured from
* `startedAt`. Sliding can never extend a session beyond this bound, keeping the
* impersonation model bounded regardless of how long a customer keeps the tab
* active. Deliberately tighter than the previous static 24h mint. (GRO-2234)
*/
export const PORTAL_SESSION_MAX_LIFETIME_MS = 8 * 60 * 60 * 1000;
/**
* Minimum extension before we issue a sliding-expiration write. Avoids a DB write
* on every rapid successive request — at most one slide per minute per session.
*/
const PORTAL_SESSION_SLIDE_THRESHOLD_MS = 60 * 1000;
/** Reason marker for sessions minted by the Better Auth -> portal bridge. */
const SSO_BRIDGE_REASON = "sso-bridge";
/**
* Validates the X-Impersonation-Session-Id header against the impersonationSessions table.
* Must be applied to all portal routes.
@@ -16,6 +42,12 @@ export interface PortalEnv {
* id = sessionId AND status = 'active', and checks session.expiresAt > new Date().
* Returns 401 if session is invalid/missing/expired.
* On success, sets c.set("portalClientId", session.clientId) and c.set("portalSessionId", session.id).
*
* Sliding expiration (GRO-2234): for SSO-bridge sessions, each successful request
* extends `expiresAt` to `now + PORTAL_SESSION_IDLE_TTL_MS`, bounded by
* `startedAt + PORTAL_SESSION_MAX_LIFETIME_MS`. Staff-initiated impersonation
* sessions (any other `reason`) are left untouched, preserving their existing
* console-enforced timeout behavior.
*/
export const validatePortalSession: MiddlewareHandler<PortalEnv> = async (c, next) => {
const sessionId = c.req.header("X-Impersonation-Session-Id");
@@ -24,16 +56,29 @@ export const validatePortalSession: MiddlewareHandler<PortalEnv> = async (c, nex
}
const db = getDb();
const now = new Date();
const [session] = await db
.select()
.from(impersonationSessions)
.where(and(eq(impersonationSessions.id, sessionId), eq(impersonationSessions.status, "active")))
.limit(1);
if (!session || session.expiresAt <= new Date()) {
if (!session || session.expiresAt <= now) {
return c.json({ error: "Unauthorized" }, 401);
}
// Sliding expiration for SSO-bridge portal sessions only (GRO-2234).
if (session.reason === SSO_BRIDGE_REASON) {
const maxExpiry = session.startedAt.getTime() + PORTAL_SESSION_MAX_LIFETIME_MS;
const slidExpiry = Math.min(now.getTime() + PORTAL_SESSION_IDLE_TTL_MS, maxExpiry);
if (slidExpiry - session.expiresAt.getTime() >= PORTAL_SESSION_SLIDE_THRESHOLD_MS) {
await db
.update(impersonationSessions)
.set({ expiresAt: new Date(slidExpiry) })
.where(eq(impersonationSessions.id, session.id));
}
}
c.set("portalClientId", session.clientId);
c.set("portalSessionId", session.id);
await next();
+130 -3
View File
@@ -3,9 +3,67 @@ import { zValidator } from "@hono/zod-validator";
import { z } from "zod/v3";
import { and, eq, exists, getDb, or, clients, appointments } from "@groombook/db";
import type { AppEnv } from "../middleware/rbac.js";
import {
geocodeClient,
geocodeUngeocodedClients,
resolveClientGeocodingProvider,
type ClientGeocodeOutcome,
} from "../services/clientGeocoding.js";
export const clientsRouter = new Hono<AppEnv>();
// Batch-geocode bounds (GRO-2294): default 50, hard cap 500. The cap bounds how
// long one synchronous request stays open and the per-request external API cost
// when routeOptimizationProvider = "google".
const GEOCODE_BATCH_DEFAULT_LIMIT = 50;
const GEOCODE_BATCH_MAX_LIMIT = 500;
type ClientRow = typeof clients.$inferSelect;
/**
* Best-effort auto-geocode of a freshly created/updated client (GRO-2154).
* Never throws: a flaky geocoding backend must not break client mutations.
* Returns the (possibly coordinate-enriched) row plus a structured outcome the
* caller surfaces under a `geocoding` field so ambiguous addresses are visible.
*/
async function autoGeocodeClient(
db: ReturnType<typeof getDb>,
row: ClientRow
): Promise<{ row: ClientRow; outcome: ClientGeocodeOutcome }> {
try {
const provider = await resolveClientGeocodingProvider(db);
const outcome = await geocodeClient(db, row, provider);
const enriched =
outcome.status === "geocoded"
? {
...row,
latitude: outcome.latitude,
longitude: outcome.longitude,
geocodedAt: outcome.geocodedAt
? new Date(outcome.geocodedAt)
: row.geocodedAt,
}
: row;
return { row: enriched, outcome };
} catch (err) {
return {
row,
outcome: {
clientId: row.id,
status: "error",
message: `Auto-geocode failed: ${
err instanceof Error ? err.message : String(err)
}`,
latitude: null,
longitude: null,
geocodedAt: null,
formattedAddress: null,
provider: null,
},
};
}
}
const createClientSchema = z.object({
name: z.string().min(1).max(200),
email: z.string().email(),
@@ -91,9 +149,62 @@ clientsRouter.post("/", zValidator("json", createClientSchema), async (c) => {
const db = getDb();
const body = c.req.valid("json");
const [row] = await db.insert(clients).values(body).returning();
if (!row) return c.json({ error: "Failed to create client" }, 500);
// Auto-geocode on create when an address is supplied (GRO-2154). Best-effort:
// the client is created regardless; the `geocoding` field surfaces failures.
if (body.address && body.address.trim()) {
const { row: enriched, outcome } = await autoGeocodeClient(db, row);
return c.json({ ...enriched, geocoding: outcome }, 201);
}
return c.json(row, 201);
});
// Geocode a single client's address and persist coordinates (manager-only;
// enforced by the route guard in index.ts).
clientsRouter.post("/:clientId/geocode", async (c) => {
const db = getDb();
const clientId = c.req.param("clientId");
const [client] = await db
.select()
.from(clients)
.where(eq(clients.id, clientId));
if (!client) return c.json({ error: "Not found" }, 404);
const provider = await resolveClientGeocodingProvider(db);
const outcome = await geocodeClient(db, client, provider);
// Map outcome to an HTTP status so the result is unambiguous to the caller:
// geocoded -> 200, provider error -> 502, no_address/unresolved -> 422.
const status =
outcome.status === "geocoded"
? 200
: outcome.status === "error"
? 502
: 422;
return c.json(outcome, status);
});
// Batch-geocode un-geocoded clients with provider-rate-limited throttling
// (manager-only). Processes up to ?limit clients (default 50, max 500) per call;
// re-invoke while `remaining` > 0 to finish large datasets.
clientsRouter.post("/geocode-batch", async (c) => {
const db = getDb();
const limitRaw = c.req.query("limit");
let limit = GEOCODE_BATCH_DEFAULT_LIMIT;
if (limitRaw !== undefined) {
limit = Number(limitRaw);
if (!Number.isFinite(limit) || limit <= 0) {
return c.json({ error: "limit must be a positive integer" }, 400);
}
// Clamp to the documented maximum to bound synchronous request duration
// and (for the Google provider) per-request external API cost.
limit = Math.min(Math.floor(limit), GEOCODE_BATCH_MAX_LIMIT);
}
const summary = await geocodeUngeocodedClients(db, limit);
return c.json(summary);
});
// Update a client (including status changes)
const patchClientSchema = createClientSchema.partial().extend({
status: z.enum(["active", "disabled"]).optional(),
@@ -123,13 +234,29 @@ clientsRouter.patch(
}
delete setValues.smsOptOut;
const [row] = await db
// Auto-geocode on address change (GRO-2154). If the address was cleared,
// drop any stale coordinates so a disabled/blank address never keeps a pin.
const addressProvided = Object.prototype.hasOwnProperty.call(body, "address");
const trimmedAddress =
typeof body.address === "string" ? body.address.trim() : undefined;
if (addressProvided && !trimmedAddress) {
setValues.latitude = null;
setValues.longitude = null;
setValues.geocodedAt = null;
}
const [updated] = await db
.update(clients)
.set(setValues)
.where(eq(clients.id, c.req.param("id")))
.returning();
if (!row) return c.json({ error: "Not found" }, 404);
return c.json(row);
if (!updated) return c.json({ error: "Not found" }, 404);
if (addressProvided && trimmedAddress) {
const { row: enriched, outcome } = await autoGeocodeClient(db, updated);
return c.json({ ...enriched, geocoding: outcome });
}
return c.json(updated);
}
);
+26 -2
View File
@@ -57,6 +57,23 @@ const createPetSchema = z.object({
customFields: z.record(z.string(), z.string()).optional(),
petSizeCategory: z.enum(["small", "medium", "large", "extra_large"]).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 });
@@ -333,7 +350,8 @@ petsRouter.get("/:id/profile-summary", async (c) => {
petsRouter.post("/", zValidator("json", createPetSchema), async (c) => {
const db = getDb();
const { weightKg, dateOfBirth, customFields, ...rest } = c.req.valid("json");
const { weightKg, dateOfBirth, customFields, medicalAlerts, ...rest } =
c.req.valid("json");
const [row] = await db
.insert(pets)
.values({
@@ -341,6 +359,10 @@ petsRouter.post("/", zValidator("json", createPetSchema), async (c) => {
weightKg: weightKg?.toString(),
dateOfBirth: dateOfBirth ? new Date(dateOfBirth) : undefined,
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();
return c.json(row, 201);
@@ -351,7 +373,8 @@ petsRouter.patch(
zValidator("json", updatePetSchema),
async (c) => {
const db = getDb();
const { weightKg, dateOfBirth, customFields, ...rest } = c.req.valid("json");
const { weightKg, dateOfBirth, customFields, medicalAlerts, ...rest } =
c.req.valid("json");
const [row] = await db
.update(pets)
.set({
@@ -359,6 +382,7 @@ petsRouter.patch(
weightKg: weightKg?.toString(),
dateOfBirth: dateOfBirth ? new Date(dateOfBirth) : undefined,
...(customFields !== undefined ? { customFields } : {}),
medicalAlerts: medicalAlerts as never,
updatedAt: new Date(),
})
.where(eq(pets.id, c.req.param("id")))
+236 -27
View File
@@ -1,9 +1,9 @@
import { Hono } from "hono";
import { zValidator } from "@hono/zod-validator";
import { z } from "zod/v3";
import { eq, inArray } from "@groombook/db";
import { and, eq, inArray } from "@groombook/db";
import { getDb, appointments, impersonationSessions, waitlistEntries, clients, pets, services, staff, invoices, invoiceLineItems } from "@groombook/db";
import { validatePortalSession } from "../middleware/portalSession.js";
import { validatePortalSession, PORTAL_SESSION_IDLE_TTL_MS } from "../middleware/portalSession.js";
import { portalAudit } from "../middleware/portalAudit.js";
import type { PortalEnv } from "../middleware/portalSession.js";
@@ -129,7 +129,7 @@ portalRouter.post("/session-from-auth", async (c) => {
staffId,
clientId: client.id,
reason: "sso-bridge",
expiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000),
expiresAt: new Date(Date.now() + PORTAL_SESSION_IDLE_TTL_MS),
})
.returning();
@@ -147,6 +147,114 @@ portalRouter.post("/session-from-auth", async (c) => {
);
});
// GRO-2359 — register a brand-new SSO user. The post-auth handler in the
// web portal redirects here when `session-from-auth` returns 404, so the
// OOBE can complete a customer record for the new user. Auth is via the
// Better Auth session (same shape as `session-from-auth`), so this is
// registered BEFORE the `validatePortalSession` middleware.
//
// Contract:
// POST /api/portal/clients-from-auth
// Body: { name: string; phone?: string|null; address?: string|null; notes?: string|null }
// 201: { id, name, email }
// 400: invalid body (zod failure)
// 401: no Better Auth session
// 409: a `clients` row already exists for this email (portal selection case)
// 500: insert failed
//
// We do NOT auto-link the user's auth account to the new client row; the
// existing `session-from-auth` endpoint re-resolves the row by email on the
// next call, so the OOBE's success path just navigates the user back to
// `/` and lets the bridge mint a portal session.
const createClientFromAuthSchema = z.object({
name: z.string().min(1).max(200),
phone: z.string().max(50).nullish(),
address: z.string().max(500).nullish(),
notes: z.string().max(2000).nullish(),
});
portalRouter.post(
"/clients-from-auth",
zValidator("json", createClientFromAuthSchema),
async (c) => {
let auth;
try {
auth = getAuth();
} catch {
return c.json({ error: "Authentication not configured" }, 503);
}
const session = await auth.api.getSession({
headers: c.req.raw.headers,
});
if (!session) {
return c.json({ error: "Unauthorized" }, 401);
}
const body = c.req.valid("json");
const db = getDb();
// Pre-check: if a client already exists for this email, return 409 so
// the OOBE can render the "portal selection" message (the user needs
// to contact their groomer to link the new SSO identity to the
// pre-existing customer record). We don't return the existing row to
// avoid leaking PII about other accounts.
const [existing] = await db
.select({ id: clients.id })
.from(clients)
.where(eq(clients.email, session.user.email))
.limit(1);
if (existing) {
return c.json(
{ error: "A customer record with this email already exists" },
409,
);
}
let row;
try {
[row] = await db
.insert(clients)
.values({
name: body.name.trim(),
email: session.user.email,
phone: body.phone?.trim() || null,
address: body.address?.trim() || null,
notes: body.notes?.trim() || null,
})
.returning();
} catch (err) {
// Concurrent insert from a parallel OOBE submit — treat as 409.
if (
err instanceof Error &&
"code" in err &&
(err as { code?: string }).code === "23505"
) {
return c.json(
{ error: "A customer record with this email already exists" },
409,
);
}
throw err;
}
if (!row) {
return c.json({ error: "Failed to create client" }, 500);
}
return c.json(
{
id: row.id,
name: row.name,
email: row.email,
},
201,
);
},
);
// Apply middleware to all portal routes
portalRouter.use("/*", validatePortalSession, portalAudit);
@@ -195,14 +303,46 @@ portalRouter.get("/appointments", async (c) => {
.where(eq(appointments.clientId, clientId))
.orderBy(appointments.startTime);
const petIds = allAppts.map(a => a.petId).filter((id): id is string => id !== null);
// GRO-2319: surface the client's ACTIVE waitlist entries alongside their
// appointments so the portal can render them as `waitlisted` cards in the
// Upcoming list. The `appointment_status` enum cannot represent `waitlisted`,
// so these are synthetic entries (status hard-set to `waitlisted`, id prefixed
// `waitlist:`) derived from `waitlist_entries`.
const waitlistRows = await db
.select({
id: waitlistEntries.id,
petId: waitlistEntries.petId,
serviceId: waitlistEntries.serviceId,
preferredDate: waitlistEntries.preferredDate,
preferredTime: waitlistEntries.preferredTime,
})
.from(waitlistEntries)
.where(
and(eq(waitlistEntries.clientId, clientId), eq(waitlistEntries.status, "active")),
);
// Pet lookups must cover both appointment and waitlist pets.
const petIds = [
...allAppts.map(a => a.petId).filter((id): id is string => id !== null),
...waitlistRows.map(w => w.petId),
];
const staffIds = allAppts.map(a => a.staffId).filter((id): id is string => id !== null);
// GRO-2342: services must be looked up for both appointment and waitlist cards
// so the portal can render `service.name` in place of the fallback "Service"
// label (CMPO sign-off on the GRO-2319 waitlist card explicitly excluded the
// service name; this follow-up closes the cosmetic gap).
const serviceIds = [
...allAppts.map(a => a.serviceId).filter((id): id is string => id !== null),
...waitlistRows.map(w => w.serviceId).filter((id): id is string => id !== null),
];
const petRows = petIds.length ? await db.select().from(pets).where(inArray(pets.id, petIds)) : [];
const staffRows = staffIds.length ? await db.select().from(staff).where(inArray(staff.id, staffIds)) : [];
const serviceRows = serviceIds.length ? await db.select().from(services).where(inArray(services.id, serviceIds)) : [];
const petMap = Object.fromEntries(petRows.map(p => [p.id, p]));
const staffMap = Object.fromEntries(staffRows.map(s => [s.id, s]));
const serviceMap = Object.fromEntries(serviceRows.map(s => [s.id, s]));
const appts = allAppts.map(a => ({
id: a.id,
@@ -213,11 +353,35 @@ portalRouter.get("/appointments", async (c) => {
customerNotes: a.customerNotes,
notes: a.notes,
pet: a.petId ? { id: petMap[a.petId]?.id, name: petMap[a.petId]?.name, photo: petMap[a.petId]?.photoKey } : null,
service: a.serviceId ? { id: a.serviceId } : null,
service: a.serviceId ? { id: a.serviceId, name: serviceMap[a.serviceId]?.name } : null,
staff: a.staffId ? { id: staffMap[a.staffId]?.id, name: staffMap[a.staffId]?.name } : null,
}));
return c.json({ appointments: appts });
// Derive a display `startTime` from the entry's preferred date/time so the
// portal can sort/classify the synthetic card (an invalid combination simply
// yields a null startTime, which the portal tolerates). GRO-2342: also
// populate the synthetic card's `service` object with the full service
// record (id + name) — same shape the appointments join returns — so the
// portal renders the real service name in place of the fallback "Service"
// label.
const waitlistAppts = waitlistRows.map(w => {
const parsed = new Date(`${w.preferredDate}T${w.preferredTime}`);
const startTime = Number.isNaN(parsed.getTime()) ? null : parsed;
return {
id: `waitlist:${w.id}`,
startTime,
endTime: null,
status: "waitlisted" as const,
confirmationStatus: null,
customerNotes: null,
notes: null,
pet: { id: petMap[w.petId]?.id, name: petMap[w.petId]?.name, photo: petMap[w.petId]?.photoKey },
service: w.serviceId ? { id: w.serviceId, name: serviceMap[w.serviceId]?.name } : null,
staff: null,
};
});
return c.json({ appointments: [...appts, ...waitlistAppts] });
});
portalRouter.get("/pets", async (c) => {
@@ -261,8 +425,8 @@ const PORTAL_PET_SIZE_ALIASES: Record<string, string> = { xlarge: "extra_large"
const portalMedicalAlertSchema = z.object({
id: z.string().optional(),
type: z.string(),
description: z.string(),
type: z.string().max(2000),
description: z.string().max(2000),
severity: z.enum(["low", "medium", "high"]),
});
@@ -275,12 +439,16 @@ const portalPetUpdateSchema = z.object({
birthDate: z.string().nullable().optional(),
notes: z.string().max(2000).nullable().optional(),
healthAlerts: z.string().max(2000).nullable().optional(),
photoUrl: z.string().nullable().optional(),
// photoUrl/photoKey are intentionally NOT writable here: photoKey is a trusted
// S3 object key consumed server-side (getPresignedGetUrl / deleteObject), and the
// upload path (pets.ts) already enforces a pets/{petId}/ prefix guard against key
// hijacking. Photo changes go through the dedicated upload + /photo/confirm flow.
// The web form round-trips the GET-shaped photoUrl; Zod strips it as an unknown key.
// coatType / petSizeCategory validated in-handler so bad values return 422.
coatType: z.string().nullable().optional(),
petSizeCategory: z.string().nullable().optional(),
preferredCuts: z.array(z.string()).nullable().optional(),
medicalAlerts: z.array(portalMedicalAlertSchema).nullable().optional(),
preferredCuts: z.array(z.string().max(2000)).max(50).nullable().optional(),
medicalAlerts: z.array(portalMedicalAlertSchema).max(50).nullable().optional(),
});
portalRouter.patch(
@@ -292,6 +460,14 @@ portalRouter.patch(
const body = c.req.valid("json");
const clientId = c.get("portalClientId");
// GRO-2203: validate UUID format before hitting Postgres. Passing a non-UUID
// string to a uuid column makes the driver throw ("invalid input syntax for
// type uuid"), which previously surfaced as an unhandled 500. Mirror the
// GRO-2014 fix in pets.ts and treat a malformed id as Not found.
if (!z.string().uuid().safeParse(petId).success) {
return c.json({ error: "Not found" }, 404);
}
const [pet] = await db
.select()
.from(pets)
@@ -322,7 +498,8 @@ portalRouter.patch(
if (body.notes !== undefined) updateData.groomingNotes = body.notes;
if (body.healthAlerts !== undefined) updateData.healthAlerts = body.healthAlerts;
if (body.photoUrl !== undefined) updateData.photoKey = body.photoUrl;
// photoKey is intentionally not writable here — see portalPetUpdateSchema note.
// Photo changes go through the key-validated upload + /photo/confirm flow.
if (body.coatType !== undefined) {
if (body.coatType !== null && !PORTAL_COAT_TYPES.includes(body.coatType)) {
@@ -546,17 +723,33 @@ portalRouter.post("/appointments/:id/cancel", async (c) => {
// ─── Client-facing waitlist routes ────────────────────────────────────────────
// Postgres `date` / `time` columns reject arbitrary strings (e.g. a full ISO
// datetime), throwing a DateTimeParseError that surfaces as an unhandled 500.
// Constrain client input here so malformed values are rejected with a 400 by
// zValidator before they ever reach the DB (GRO-2211 defense-in-depth).
const preferredDateSchema = z
.string()
.regex(/^\d{4}-\d{2}-\d{2}$/, "preferredDate must be YYYY-MM-DD");
const preferredTimeSchema = z
.string()
.regex(/^([01]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$/, "preferredTime must be HH:MM or HH:MM:SS");
// Normalize HH:MM → HH:MM:SS so it matches the Postgres `time` column format.
function normalizeTime(value: string): string {
return value.length === 5 ? `${value}:00` : value;
}
const createWaitlistEntrySchema = z.object({
petId: z.string().uuid(),
serviceId: z.string().uuid(),
preferredDate: z.string(),
preferredTime: z.string(),
preferredDate: preferredDateSchema,
preferredTime: preferredTimeSchema,
});
const updateWaitlistEntrySchema = z.object({
status: z.literal("cancelled").optional(),
preferredDate: z.string().optional(),
preferredTime: z.string().optional(),
preferredDate: preferredDateSchema.optional(),
preferredTime: preferredTimeSchema.optional(),
});
portalRouter.post(
@@ -567,16 +760,32 @@ portalRouter.post(
const body = c.req.valid("json");
const clientId = c.get("portalClientId");
const [entry] = await db
.insert(waitlistEntries)
.values({
clientId,
petId: body.petId,
serviceId: body.serviceId,
preferredDate: body.preferredDate,
preferredTime: body.preferredTime,
})
.returning();
let entry;
try {
[entry] = await db
.insert(waitlistEntries)
.values({
clientId,
petId: body.petId,
serviceId: body.serviceId,
preferredDate: body.preferredDate,
preferredTime: normalizeTime(body.preferredTime),
})
.returning();
} catch (err) {
// An exact duplicate active waitlist entry violates the partial unique
// index idx_waitlist_active_unique (client_id, pet_id, service_id,
// preferred_date, preferred_time WHERE status='active'). postgres-js
// surfaces this as SQLSTATE 23505 — return a friendly 409 rather than a
// generic 500 (GRO-2235). Unrelated errors still surface as 500.
if ((err as { code?: string })?.code === "23505") {
return c.json(
{ error: "You already have a booking for this pet at that date and time." },
409
);
}
throw err;
}
return c.json(entry, 201);
}
@@ -605,7 +814,7 @@ portalRouter.patch(
const updateData: Record<string, unknown> = { updatedAt: new Date() };
if (body.status !== undefined) updateData.status = body.status;
if (body.preferredDate !== undefined) updateData.preferredDate = body.preferredDate;
if (body.preferredTime !== undefined) updateData.preferredTime = body.preferredTime;
if (body.preferredTime !== undefined) updateData.preferredTime = normalizeTime(body.preferredTime);
const [updated] = await db
.update(waitlistEntries)
+529
View File
@@ -0,0 +1,529 @@
import { Hono, type Context } from "hono";
import { zValidator } from "@hono/zod-validator";
import { z } from "zod/v3";
import {
and,
asc,
eq,
gte,
lt,
ne,
getDb,
appointments,
businessSettings,
clients,
groomerRoutes,
routeStops,
} from "@groombook/db";
import type { AppEnv, StaffRow } from "../middleware/rbac.js";
import {
optimizeRoute,
resolveRouteGoogleApiKey,
detectScheduleConflicts,
recomputeLegsForOrder,
type RouteStopInput,
type StopConflictFlags,
} from "../services/routeOptimization.js";
import {
buildNavigationUrl,
type NavigationPlatform,
type NavigationStop,
} from "../services/navigationExport.js";
export const routesRouter = new Hono<AppEnv>();
const dailyQuerySchema = z.object({
staffId: z.string().uuid().optional(),
date: z.string().regex(/^\d{4}-\d{2}-\d{2}$/, "date must be YYYY-MM-DD"),
});
const optimizeBodySchema = z.object({
staffId: z.string().uuid().optional(),
date: z.string().regex(/^\d{4}-\d{2}-\d{2}$/, "date must be YYYY-MM-DD"),
});
const reorderBodySchema = z.object({
// New visiting order expressed as routeStops.id values, first-to-last.
stopOrder: z.array(z.string().uuid()).min(1),
});
/**
* Resolves the target staffId for the request and enforces the groomer-own /
* manager authorization rule. Groomers may only act on their own route; if a
* groomer omits staffId it defaults to their own. Returns either the resolved
* id or an error tuple the caller turns into a JSON response.
*/
function resolveTargetStaffId(
staffRow: StaffRow | undefined,
requestedStaffId: string | undefined
): { staffId: string } | { error: string; status: 400 | 403 } {
const isGroomer = staffRow?.role === "groomer";
if (isGroomer) {
if (requestedStaffId && requestedStaffId !== staffRow.id) {
return {
error: "Forbidden: groomers may only access their own route",
status: 403,
};
}
return { staffId: staffRow.id };
}
// Manager: staffId is required (no implicit self — managers plan others' days).
if (!requestedStaffId) {
return { error: "staffId is required", status: 400 };
}
return { staffId: requestedStaffId };
}
/** Day window [date 00:00:00Z, nextDay 00:00:00Z) for filtering appointments. */
function dayBounds(date: string): { start: Date; end: Date } {
const start = new Date(`${date}T00:00:00.000Z`);
const end = new Date(start.getTime() + 24 * 60 * 60 * 1000);
return { start, end };
}
/** Loads a route's persisted stops, enriched with appointment + client detail. */
async function loadRouteStops(db: ReturnType<typeof getDb>, routeId: string) {
return db
.select({
id: routeStops.id,
appointmentId: routeStops.appointmentId,
stopOrder: routeStops.stopOrder,
latitude: routeStops.latitude,
longitude: routeStops.longitude,
travelMinsFromPrev: routeStops.travelMinsFromPrev,
travelDistanceKmFromPrev: routeStops.travelDistanceKmFromPrev,
bufferMins: routeStops.bufferMins,
appointmentStartTime: appointments.startTime,
appointmentEndTime: appointments.endTime,
appointmentStatus: appointments.status,
clientId: clients.id,
clientName: clients.name,
clientAddress: clients.address,
})
.from(routeStops)
.innerJoin(appointments, eq(routeStops.appointmentId, appointments.id))
.innerJoin(clients, eq(appointments.clientId, clients.id))
.where(eq(routeStops.routeId, routeId))
.orderBy(asc(routeStops.stopOrder));
}
type LoadedRouteStop = Awaited<ReturnType<typeof loadRouteStops>>[number];
/**
* Annotates persisted stops with "tight schedule" conflict flags for the
* frontend. Conflicts are derived at read time from the live appointment times,
* persisted travel estimates and buffers — never auto-resolved by moving stops.
*/
function annotateConflicts(stops: LoadedRouteStop[]): {
stops: Array<LoadedRouteStop & { conflict: StopConflictFlags }>;
hasConflicts: boolean;
conflictCount: number;
} {
const flags = detectScheduleConflicts(
stops.map((s) => ({
appointmentStartTime: s.appointmentStartTime,
appointmentEndTime: s.appointmentEndTime,
travelMinsFromPrev: s.travelMinsFromPrev,
bufferMins: s.bufferMins,
}))
);
const annotated = stops.map((s, i) => ({ ...s, conflict: flags[i]! }));
const conflictCount = flags.filter((f) => f.hasConflict).length;
return { stops: annotated, hasConflicts: conflictCount > 0, conflictCount };
}
/**
* GET /api/routes/daily?staffId=&date=
* Fetches (creating a draft if absent) the daily route for a groomer, with all
* persisted stops. Auth: groomer (own) or manager.
*/
routesRouter.get("/daily", zValidator("query", dailyQuerySchema), async (c) => {
const db = getDb();
const { staffId: requestedStaffId, date } = c.req.valid("query");
const resolved = resolveTargetStaffId(c.get("staff"), requestedStaffId);
if ("error" in resolved) {
return c.json({ error: resolved.error }, resolved.status);
}
const staffId = resolved.staffId;
let [route] = await db
.select()
.from(groomerRoutes)
.where(
and(
eq(groomerRoutes.staffId, staffId),
eq(groomerRoutes.routeDate, date)
)
);
if (!route) {
// Create a draft route so the day is addressable before optimization.
[route] = await db
.insert(groomerRoutes)
.values({ staffId, routeDate: date, status: "draft" })
.returning();
}
const stops = await loadRouteStops(db, route!.id);
const annotated = annotateConflicts(stops);
return c.json({
route,
stops: annotated.stops,
hasConflicts: annotated.hasConflicts,
conflictCount: annotated.conflictCount,
});
});
/**
* POST /api/routes/optimize { staffId, date }
* Generates or re-optimizes the daily route: pulls the day's geocoded
* appointments, optimizes the visiting order (Google Directions when a key is
* configured, else nearest-neighbor), and persists the ordered stops + totals.
* Auth: groomer (own) or manager.
*/
routesRouter.post(
"/optimize",
zValidator("json", optimizeBodySchema),
async (c) => {
const db = getDb();
const { staffId: requestedStaffId, date } = c.req.valid("json");
const resolved = resolveTargetStaffId(c.get("staff"), requestedStaffId);
if ("error" in resolved) {
return c.json({ error: resolved.error }, resolved.status);
}
const staffId = resolved.staffId;
const { start, end } = dayBounds(date);
// Pull the day's non-cancelled appointments for this groomer, joined to the
// client coordinates. Ordered by start time so the earliest booking anchors
// the route.
const dayAppointments = await db
.select({
appointmentId: appointments.id,
startTime: appointments.startTime,
clientId: clients.id,
clientName: clients.name,
latitude: clients.latitude,
longitude: clients.longitude,
})
.from(appointments)
.innerJoin(clients, eq(appointments.clientId, clients.id))
.where(
and(
eq(appointments.staffId, staffId),
gte(appointments.startTime, start),
lt(appointments.startTime, end),
ne(appointments.status, "cancelled")
)
)
.orderBy(asc(appointments.startTime));
const stopInputs: RouteStopInput[] = [];
const skipped: Array<{ appointmentId: string; clientName: string; reason: string }> =
[];
for (const appt of dayAppointments) {
if (appt.latitude == null || appt.longitude == null) {
skipped.push({
appointmentId: appt.appointmentId,
clientName: appt.clientName,
reason: "client address is not geocoded",
});
continue;
}
stopInputs.push({
appointmentId: appt.appointmentId,
latitude: appt.latitude,
longitude: appt.longitude,
});
}
const [settings] = await db.select().from(businessSettings).limit(1);
const bufferMins = settings?.defaultTravelBufferMins ?? 15;
const googleApiKey = await resolveRouteGoogleApiKey(db);
const optimized = await optimizeRoute(stopInputs, { googleApiKey });
const warnings = [...optimized.warnings];
if (skipped.length > 0) {
warnings.push(
`${skipped.length} appointment(s) were skipped because the client address is not geocoded.`
);
}
const now = new Date();
const route = await db.transaction(async (tx) => {
// Upsert the route row for (staffId, date).
const [existing] = await tx
.select()
.from(groomerRoutes)
.where(
and(
eq(groomerRoutes.staffId, staffId),
eq(groomerRoutes.routeDate, date)
)
);
const [routeRow] = existing
? await tx
.update(groomerRoutes)
.set({
status: "optimized",
totalTravelMins: optimized.totalTravelMins,
totalDistanceKm: optimized.totalDistanceKm.toFixed(2),
optimizedAt: now,
updatedAt: now,
})
.where(eq(groomerRoutes.id, existing.id))
.returning()
: await tx
.insert(groomerRoutes)
.values({
staffId,
routeDate: date,
status: "optimized",
totalTravelMins: optimized.totalTravelMins,
totalDistanceKm: optimized.totalDistanceKm.toFixed(2),
optimizedAt: now,
})
.returning();
// Replace stops: clear prior ordering, insert the freshly optimized one.
await tx.delete(routeStops).where(eq(routeStops.routeId, routeRow!.id));
if (optimized.stops.length > 0) {
await tx.insert(routeStops).values(
optimized.stops.map((s, i) => ({
routeId: routeRow!.id,
appointmentId: s.appointmentId,
stopOrder: i + 1,
latitude: s.latitude,
longitude: s.longitude,
travelMinsFromPrev: s.travelMinsFromPrev,
travelDistanceKmFromPrev:
s.travelDistanceKmFromPrev == null
? null
: s.travelDistanceKmFromPrev.toFixed(2),
// Buffer applies between consecutive stops; the first stop has no
// predecessor, so it carries no travel buffer.
bufferMins: i === 0 ? 0 : bufferMins,
}))
);
}
return routeRow!;
});
const stops = await loadRouteStops(db, route.id);
const annotated = annotateConflicts(stops);
return c.json({
route,
stops: annotated.stops,
hasConflicts: annotated.hasConflicts,
conflictCount: annotated.conflictCount,
provider: optimized.provider,
chunked: optimized.chunked,
subRouteCount: optimized.subRouteCount,
skipped,
warnings,
});
}
);
/**
* PATCH /api/routes/:routeId/reorder { stopOrder: string[] }
* Persists a manual stop order (array of routeStops.id, first-to-last), then
* re-runs the buffer logic: each leg's travel is re-estimated for the new
* adjacency, the default travel buffer is re-applied between consecutive stops,
* route totals are recomputed, and tight-schedule conflicts are re-flagged.
* Appointments are never moved. Auth: groomer (own route) or manager.
*/
routesRouter.patch(
"/:routeId/reorder",
zValidator("json", reorderBodySchema),
async (c) => {
const db = getDb();
const routeId = c.req.param("routeId");
if (!z.string().uuid().safeParse(routeId).success) {
return c.json({ error: "routeId must be a UUID" }, 400);
}
const { stopOrder: newOrderIds } = c.req.valid("json");
const [route] = await db
.select()
.from(groomerRoutes)
.where(eq(groomerRoutes.id, routeId));
if (!route) {
return c.json({ error: "Route not found" }, 404);
}
// Reuse the groomer-own / manager authorization rule against the route owner.
const resolved = resolveTargetStaffId(c.get("staff"), route.staffId);
if ("error" in resolved) {
return c.json({ error: resolved.error }, resolved.status);
}
const existing = await db
.select({
id: routeStops.id,
latitude: routeStops.latitude,
longitude: routeStops.longitude,
})
.from(routeStops)
.where(eq(routeStops.routeId, routeId));
// The new order must be an exact permutation of the route's current stops.
const existingIds = new Set(existing.map((s) => s.id));
if (newOrderIds.length !== existing.length) {
return c.json(
{
error: `stopOrder must list every stop exactly once (expected ${existing.length}, got ${newOrderIds.length})`,
},
400
);
}
const seen = new Set<string>();
for (const id of newOrderIds) {
if (!existingIds.has(id)) {
return c.json({ error: `unknown stop id: ${id}` }, 400);
}
if (seen.has(id)) {
return c.json({ error: `duplicate stop id: ${id}` }, 400);
}
seen.add(id);
}
const [settings] = await db.select().from(businessSettings).limit(1);
const bufferMins = settings?.defaultTravelBufferMins ?? 15;
const byId = new Map(existing.map((s) => [s.id, s]));
const legs = recomputeLegsForOrder(
newOrderIds.map((id) => {
const s = byId.get(id)!;
return { latitude: s.latitude, longitude: s.longitude };
})
);
const totalTravelMins = legs.reduce(
(sum, l) => sum + (l.travelMinsFromPrev ?? 0),
0
);
const totalDistanceKm =
Math.round(
legs.reduce((sum, l) => sum + (l.travelDistanceKmFromPrev ?? 0), 0) * 100
) / 100;
const now = new Date();
await db.transaction(async (tx) => {
// Two-pass update: park stopOrder in a non-colliding negative range first
// so the unique(routeId, stopOrder) constraint never trips mid-reorder.
for (let i = 0; i < newOrderIds.length; i++) {
await tx
.update(routeStops)
.set({ stopOrder: -(i + 1), updatedAt: now })
.where(eq(routeStops.id, newOrderIds[i]!));
}
for (let i = 0; i < newOrderIds.length; i++) {
const leg = legs[i]!;
await tx
.update(routeStops)
.set({
stopOrder: i + 1,
travelMinsFromPrev: leg.travelMinsFromPrev,
travelDistanceKmFromPrev:
leg.travelDistanceKmFromPrev == null
? null
: leg.travelDistanceKmFromPrev.toFixed(2),
bufferMins: i === 0 ? 0 : bufferMins,
updatedAt: now,
})
.where(eq(routeStops.id, newOrderIds[i]!));
}
await tx
.update(groomerRoutes)
.set({
totalTravelMins,
totalDistanceKm: totalDistanceKm.toFixed(2),
updatedAt: now,
})
.where(eq(groomerRoutes.id, routeId));
});
const [updatedRoute] = await db
.select()
.from(groomerRoutes)
.where(eq(groomerRoutes.id, routeId));
const stops = await loadRouteStops(db, routeId);
const annotated = annotateConflicts(stops);
return c.json({
route: updatedRoute,
stops: annotated.stops,
hasConflicts: annotated.hasConflicts,
conflictCount: annotated.conflictCount,
});
}
);
/**
* GET /:routeId/export/:platform — build a native-navigation deep-link URL for an
* optimized route. Origin = first stop, destination = last stop, the rest carried
* as ordered intermediate waypoints. Waypoint count is validated against the
* platform's limit. Auth: manager (any route) or groomer (own route only).
*/
async function handleNavigationExport(
c: Context<AppEnv>,
platform: NavigationPlatform
) {
const db = getDb();
const routeId = c.req.param("routeId");
if (!routeId || !z.string().uuid().safeParse(routeId).success) {
return c.json({ error: "routeId must be a UUID" }, 400);
}
const [route] = await db
.select()
.from(groomerRoutes)
.where(eq(groomerRoutes.id, routeId));
if (!route) {
return c.json({ error: "Route not found" }, 404);
}
// Reuse the groomer-own / manager authorization rule against the route owner.
const resolved = resolveTargetStaffId(c.get("staff"), route.staffId);
if ("error" in resolved) {
return c.json({ error: resolved.error }, resolved.status);
}
const stops = await loadRouteStops(db, routeId);
if (stops.length === 0) {
return c.json({ error: "route has no stops to export" }, 400);
}
const navStops: NavigationStop[] = stops.map((s) => ({
latitude: s.latitude,
longitude: s.longitude,
label: s.clientName,
}));
const result = buildNavigationUrl(platform, navStops);
if ("error" in result) {
return c.json({ error: result.error }, result.status);
}
return c.json({
platform: result.platform,
url: result.url,
stopCount: result.stopCount,
waypointCount: result.waypointCount,
});
}
routesRouter.get("/:routeId/export/google-maps", (c) =>
handleNavigationExport(c, "google-maps")
);
routesRouter.get("/:routeId/export/apple-maps", (c) =>
handleNavigationExport(c, "apple-maps")
);
+16 -3
View File
@@ -7,6 +7,17 @@ import { requireSuperUser } from "../middleware/rbac.js";
export const settingsRouter = new Hono();
type BusinessSettingsRow = typeof businessSettings.$inferSelect;
// Strip the encrypted googleMapsApiKey ciphertext from settings responses
// (GRO-2294, defense-in-depth). The secret is never needed client-side; it is
// only written via the dedicated provider-config endpoint.
function redactSettings(row: BusinessSettingsRow) {
const rest: Partial<BusinessSettingsRow> = { ...row };
delete rest.googleMapsApiKey;
return rest;
}
// GET /api/admin/settings — return current business settings
settingsRouter.get("/", async (c) => {
const db = getDb();
@@ -14,9 +25,10 @@ settingsRouter.get("/", async (c) => {
if (!row) {
// Auto-create default settings if none exist
const [created] = await db.insert(businessSettings).values({}).returning();
return c.json(created);
if (!created) throw new Error("Failed to create default settings");
return c.json(redactSettings(created));
}
return c.json(row);
return c.json(redactSettings(row));
});
const hexColorRegex = /^#[0-9a-fA-F]{6}$/;
@@ -53,7 +65,8 @@ settingsRouter.patch(
.where(eq(businessSettings.id, settingsId))
.returning();
return c.json(updated);
if (!updated) throw new Error("Failed to update settings");
return c.json(redactSettings(updated));
}
);
+212
View File
@@ -0,0 +1,212 @@
import {
getDb,
businessSettings,
clients,
and,
eq,
isNull,
sql,
} from "@groombook/db";
import {
resolveGeocodingProvider,
type GeocodingProvider,
type GeocodeResult,
} from "./geocoding.js";
/**
* Client geocoding orchestration (GRO-2154, Phase 1.3 of Route Optimization).
*
* Bridges the provider-agnostic {@link GeocodingProvider} layer (GRO-2153) and
* the `clients` table: resolves the configured provider from `businessSettings`,
* geocodes a client's address, and persists `latitude`/`longitude`/`geocodedAt`.
*
* Outcomes are returned as structured {@link ClientGeocodeOutcome} values so that
* callers (the geocode endpoints and the auto-geocode create/update hook) can
* surface clear, actionable feedback — groomers need to know when an address is
* ambiguous or unresolvable, not just that "something failed".
*/
type Db = ReturnType<typeof getDb>;
type ClientRow = typeof clients.$inferSelect;
/** Status of a single client geocode attempt. */
export type ClientGeocodeStatus =
/** Coordinates resolved and persisted. */
| "geocoded"
/** Client has no (non-blank) address on file — nothing to geocode. */
| "no_address"
/** Provider returned no match; the address is ambiguous or unrecognized. */
| "unresolved"
/** Provider call failed (transport, quota, bad key). Coordinates unchanged. */
| "error";
/** Structured, UI-surfaceable result of geocoding one client. */
export interface ClientGeocodeOutcome {
clientId: string;
status: ClientGeocodeStatus;
/** Human-readable explanation, safe to show to managers/groomers. */
message: string;
latitude: number | null;
longitude: number | null;
geocodedAt: string | null;
/** Provider-normalized address, when a match was found. */
formattedAddress: string | null;
/** Provider that produced (or attempted) this result. */
provider: string | null;
}
/**
* Builds the geocoding provider for the current business settings. A single
* provider instance should be reused across a batch so its internal rate limiter
* throttles the whole run (e.g. Nominatim's 1 req/sec policy).
*/
export async function resolveClientGeocodingProvider(
db: Db
): Promise<GeocodingProvider> {
const [settings] = await db.select().from(businessSettings).limit(1);
return resolveGeocodingProvider(settings ?? null);
}
/**
* Geocodes a single client row through the given provider and persists the
* result on success. Never throws on provider failure — transport/quota errors
* are captured as an `"error"` outcome so callers (especially the create/update
* auto-geocode hook) are not broken by a flaky geocoding backend.
*/
export async function geocodeClient(
db: Db,
client: ClientRow,
provider: GeocodingProvider
): Promise<ClientGeocodeOutcome> {
const base = {
clientId: client.id,
latitude: null as number | null,
longitude: null as number | null,
geocodedAt: null as string | null,
formattedAddress: null as string | null,
provider: provider.name as string | null,
};
const address = client.address?.trim();
if (!address) {
return {
...base,
status: "no_address",
message: "Client has no address on file, so it cannot be geocoded.",
};
}
let result: GeocodeResult | null;
try {
result = await provider.geocode(address);
} catch (err) {
return {
...base,
status: "error",
message: `Geocoding provider (${provider.name}) failed: ${
err instanceof Error ? err.message : String(err)
}`,
};
}
if (!result) {
return {
...base,
status: "unresolved",
message: `Address could not be resolved to a location: "${address}". Please verify or correct the address.`,
};
}
const geocodedAt = new Date();
await db
.update(clients)
.set({
latitude: result.latitude,
longitude: result.longitude,
geocodedAt,
updatedAt: geocodedAt,
})
.where(eq(clients.id, client.id));
return {
clientId: client.id,
status: "geocoded",
message: `Geocoded via ${result.provider} to ${result.latitude}, ${result.longitude}.`,
latitude: result.latitude,
longitude: result.longitude,
geocodedAt: geocodedAt.toISOString(),
formattedAddress: result.formattedAddress,
provider: result.provider,
};
}
/** Summary returned by {@link geocodeUngeocodedClients}. */
export interface BatchGeocodeSummary {
provider: string;
/** Number of clients processed in this invocation. */
processed: number;
geocoded: number;
unresolved: number;
errors: number;
/** Un-geocoded clients with an address that were NOT processed (over `limit`). */
remaining: number;
/** Per-client outcomes for everything processed this invocation. */
outcomes: ClientGeocodeOutcome[];
}
/**
* Batch-geocodes clients that have an address but no `geocodedAt` yet, throttled
* by the active provider's rate limiter.
*
* Because Nominatim allows only ~1 req/sec, geocoding every un-geocoded client in
* a single HTTP request would risk timeouts on large datasets. Each invocation
* therefore processes at most `limit` clients (default 50, clamped 1..500) and
* reports `remaining`; managers re-run until `remaining` is 0.
*/
export async function geocodeUngeocodedClients(
db: Db,
limit = 50,
injectedProvider?: GeocodingProvider
): Promise<BatchGeocodeSummary> {
const effectiveLimit = Math.min(Math.max(Math.trunc(limit) || 0, 1), 500);
const provider =
injectedProvider ?? (await resolveClientGeocodingProvider(db));
// Un-geocoded = geocodedAt IS NULL with a non-blank address.
const candidateFilter = and(
isNull(clients.geocodedAt),
sql`${clients.address} IS NOT NULL AND length(trim(${clients.address})) > 0`
);
const countRows = await db
.select({ count: sql<number>`count(*)::int` })
.from(clients)
.where(candidateFilter);
const totalRemaining = countRows[0]?.count ?? 0;
const rows = await db
.select()
.from(clients)
.where(candidateFilter)
.orderBy(clients.createdAt)
.limit(effectiveLimit);
const outcomes: ClientGeocodeOutcome[] = [];
for (const row of rows) {
outcomes.push(await geocodeClient(db, row, provider));
}
const geocoded = outcomes.filter((o) => o.status === "geocoded").length;
const unresolved = outcomes.filter((o) => o.status === "unresolved").length;
const errors = outcomes.filter((o) => o.status === "error").length;
return {
provider: provider.name,
processed: outcomes.length,
geocoded,
unresolved,
errors,
remaining: Math.max(totalRemaining - outcomes.length, 0),
outcomes,
};
}
+419
View File
@@ -0,0 +1,419 @@
import { decryptSecret } from "@groombook/db";
/**
* Abstracted geocoding service layer (GRO-2153, Phase 1.2 of Route Optimization).
*
* Provides a provider-agnostic interface for turning a street address into
* latitude/longitude coordinates, with two concrete implementations:
*
* - {@link NominatimGeocodingProvider} — OpenStreetMap Nominatim (default, free,
* self-hostable). Enforces the public Nominatim usage policy of at most one
* request per second.
* - {@link GoogleGeocodingProvider} — Google Geocoding API (optional fallback,
* requires an API key stored encrypted at rest in `businessSettings`).
*
* Provider selection is driven by `businessSettings.routeOptimizationProvider`
* via {@link resolveGeocodingProvider}. A {@link geocodeBatch} helper geocodes a
* list of addresses while respecting the active provider's rate limit.
*/
/** Identifier for a supported geocoding backend. Mirrors `route_optimization_provider`. */
export type GeocodingProviderName = "nominatim" | "google";
/** Successful geocoding result in WGS84 decimal degrees. */
export interface GeocodeResult {
latitude: number;
longitude: number;
/** Provider-normalized display address, when available. */
formattedAddress: string | null;
/** Which provider produced this result. */
provider: GeocodingProviderName;
}
/** Abstract geocoding provider contract. */
export interface GeocodingProvider {
/** Stable provider identifier. */
readonly name: GeocodingProviderName;
/**
* Minimum milliseconds to leave between consecutive requests. Used both by the
* provider's internal rate limiter and by {@link geocodeBatch} so callers do
* not need to know provider-specific limits.
*/
readonly minRequestIntervalMs: number;
/**
* Geocode a single address.
* @returns the top match, or `null` when the address is blank or unresolvable.
* @throws on transport failures or provider-level errors (e.g. quota, bad key).
*/
geocode(address: string): Promise<GeocodeResult | null>;
}
// --- Constants -------------------------------------------------------------
/** Nominatim usage policy: at most 1 request per second. */
const NOMINATIM_RATE_LIMIT_MS = 1000;
const DEFAULT_NOMINATIM_BASE_URL = "https://nominatim.openstreetmap.org";
/** Nominatim requires a descriptive User-Agent identifying the application. */
const DEFAULT_NOMINATIM_USER_AGENT = "GroomBook/1.0 (+https://groombook.app route-optimization)";
const GOOGLE_GEOCODE_BASE_URL = "https://maps.googleapis.com/maps/api/geocode/json";
/**
* Google permits a high request rate; a small floor keeps batch traffic polite
* without throttling interactive single calls.
*/
const GOOGLE_RATE_LIMIT_MS = 20;
// --- Injectable primitives (for testability) -------------------------------
/** Minimal `fetch` shape this module depends on. Defaults to the global `fetch`. */
export type FetchLike = (
input: string,
init?: { headers?: Record<string, string> }
) => Promise<{
ok: boolean;
status: number;
statusText: string;
json(): Promise<unknown>;
}>;
type NowFn = () => number;
type SleepFn = (ms: number) => Promise<void>;
const defaultSleep: SleepFn = (ms) =>
new Promise((resolve) => setTimeout(resolve, ms));
const defaultFetch: FetchLike = (input, init) =>
(globalThis.fetch as unknown as FetchLike)(input, init);
/**
* Serializes async tasks and guarantees at least `intervalMs` between the start
* of consecutive tasks. A failing task never wedges the queue.
*/
class RateLimiter {
// Negative infinity so the very first task never waits.
private last = Number.NEGATIVE_INFINITY;
private chain: Promise<unknown> = Promise.resolve();
constructor(
private readonly intervalMs: number,
private readonly now: NowFn = Date.now,
private readonly sleep: SleepFn = defaultSleep
) {}
run<T>(task: () => Promise<T>): Promise<T> {
const result = this.chain.then(async () => {
if (this.intervalMs > 0) {
const elapsed = this.now() - this.last;
const wait = this.intervalMs - elapsed;
if (wait > 0) await this.sleep(wait);
}
this.last = this.now();
return task();
});
// Keep the queue alive regardless of whether this task resolves or rejects.
this.chain = result.then(
() => undefined,
() => undefined
);
return result;
}
}
function normalizeAddress(address: string): string {
return address.trim();
}
// --- Nominatim provider ----------------------------------------------------
interface NominatimSearchRow {
lat?: string;
lon?: string;
display_name?: string;
}
export interface NominatimProviderOptions {
/** Override the Nominatim instance base URL (e.g. a self-hosted mirror). */
baseUrl?: string;
/** User-Agent header identifying this application, per Nominatim policy. */
userAgent?: string;
/** Minimum spacing between requests; defaults to the 1 req/sec policy. */
minRequestIntervalMs?: number;
fetchImpl?: FetchLike;
now?: NowFn;
sleep?: SleepFn;
}
export class NominatimGeocodingProvider implements GeocodingProvider {
readonly name = "nominatim" as const;
readonly minRequestIntervalMs: number;
private readonly baseUrl: string;
private readonly userAgent: string;
private readonly fetchImpl: FetchLike;
private readonly limiter: RateLimiter;
constructor(options: NominatimProviderOptions = {}) {
this.baseUrl = (options.baseUrl ?? DEFAULT_NOMINATIM_BASE_URL).replace(/\/+$/, "");
this.userAgent = options.userAgent ?? DEFAULT_NOMINATIM_USER_AGENT;
this.minRequestIntervalMs = options.minRequestIntervalMs ?? NOMINATIM_RATE_LIMIT_MS;
this.fetchImpl = options.fetchImpl ?? defaultFetch;
this.limiter = new RateLimiter(this.minRequestIntervalMs, options.now, options.sleep);
}
async geocode(address: string): Promise<GeocodeResult | null> {
const query = normalizeAddress(address);
if (!query) return null;
return this.limiter.run(async () => {
const url = new URL(`${this.baseUrl}/search`);
url.searchParams.set("q", query);
url.searchParams.set("format", "jsonv2");
url.searchParams.set("limit", "1");
const res = await this.fetchImpl(url.toString(), {
headers: { "User-Agent": this.userAgent },
});
if (!res.ok) {
throw new Error(
`Nominatim geocoding failed: ${res.status} ${res.statusText}`
);
}
const body = (await res.json()) as NominatimSearchRow[];
if (!Array.isArray(body) || body.length === 0) return null;
const top = body[0]!;
const latitude = Number(top.lat);
const longitude = Number(top.lon);
if (!Number.isFinite(latitude) || !Number.isFinite(longitude)) return null;
return {
latitude,
longitude,
formattedAddress: top.display_name ?? null,
provider: this.name,
};
});
}
}
// --- Google provider -------------------------------------------------------
interface GoogleGeocodeResponse {
status: string;
error_message?: string;
results?: Array<{
formatted_address?: string;
geometry?: { location?: { lat?: number; lng?: number } };
}>;
}
export interface GoogleProviderOptions {
baseUrl?: string;
minRequestIntervalMs?: number;
fetchImpl?: FetchLike;
now?: NowFn;
sleep?: SleepFn;
}
export class GoogleGeocodingProvider implements GeocodingProvider {
readonly name = "google" as const;
readonly minRequestIntervalMs: number;
private readonly apiKey: string;
private readonly baseUrl: string;
private readonly fetchImpl: FetchLike;
private readonly limiter: RateLimiter;
constructor(apiKey: string, options: GoogleProviderOptions = {}) {
if (!apiKey) {
throw new Error("GoogleGeocodingProvider requires a non-empty API key");
}
this.apiKey = apiKey;
this.baseUrl = options.baseUrl ?? GOOGLE_GEOCODE_BASE_URL;
this.minRequestIntervalMs = options.minRequestIntervalMs ?? GOOGLE_RATE_LIMIT_MS;
this.fetchImpl = options.fetchImpl ?? defaultFetch;
this.limiter = new RateLimiter(this.minRequestIntervalMs, options.now, options.sleep);
}
async geocode(address: string): Promise<GeocodeResult | null> {
const query = normalizeAddress(address);
if (!query) return null;
return this.limiter.run(async () => {
const url = new URL(this.baseUrl);
url.searchParams.set("address", query);
url.searchParams.set("key", this.apiKey);
const res = await this.fetchImpl(url.toString());
if (!res.ok) {
throw new Error(
`Google geocoding failed: ${res.status} ${res.statusText}`
);
}
const body = (await res.json()) as GoogleGeocodeResponse;
if (body.status === "ZERO_RESULTS") return null;
if (body.status !== "OK") {
const detail = body.error_message ? `: ${body.error_message}` : "";
throw new Error(`Google geocoding error: ${body.status}${detail}`);
}
const top = body.results?.[0];
const location = top?.geometry?.location;
const latitude = location?.lat;
const longitude = location?.lng;
if (
typeof latitude !== "number" ||
typeof longitude !== "number" ||
!Number.isFinite(latitude) ||
!Number.isFinite(longitude)
) {
return null;
}
return {
latitude,
longitude,
formattedAddress: top?.formatted_address ?? null,
provider: this.name,
};
});
}
}
// --- Provider selection ----------------------------------------------------
/** Subset of `businessSettings` relevant to geocoding provider selection. */
export interface GeocodingSettings {
routeOptimizationProvider?: string | null;
/** Google API key, encrypted at rest (AES-256-GCM via `encryptSecret`). */
googleMapsApiKey?: string | null;
}
export interface ResolveProviderOptions {
/** Decryption function for the stored Google key. Defaults to `decryptSecret`. */
decrypt?: (ciphertext: string) => string;
/** Options forwarded to the constructed provider (base URL, fetch, timing). */
nominatim?: NominatimProviderOptions;
google?: GoogleProviderOptions;
/** Sink for non-fatal selection warnings. Defaults to `console.warn`. */
warn?: (message: string) => void;
}
/**
* Resolves the Google API key from settings (decrypting the at-rest value) or,
* as a development convenience, from the `GOOGLE_MAPS_API_KEY` env var.
* Returns `null` when no usable key is available.
*/
function resolveGoogleApiKey(
settings: GeocodingSettings,
decrypt: (ciphertext: string) => string,
warn: (message: string) => void
): string | null {
const stored = settings.googleMapsApiKey?.trim();
if (stored) {
try {
const decrypted = decrypt(stored).trim();
if (decrypted) return decrypted;
} catch (err) {
warn(
`Failed to decrypt googleMapsApiKey; falling back to Nominatim: ${
err instanceof Error ? err.message : String(err)
}`
);
return null;
}
}
const fromEnv = process.env.GOOGLE_MAPS_API_KEY?.trim();
return fromEnv ? fromEnv : null;
}
/**
* Selects a geocoding provider based on `businessSettings.routeOptimizationProvider`.
*
* - `"google"` returns a {@link GoogleGeocodingProvider} when a usable key exists,
* otherwise warns and falls back to Nominatim.
* - Any other value (including `null`/`undefined`) returns a
* {@link NominatimGeocodingProvider}.
*/
export function resolveGeocodingProvider(
settings: GeocodingSettings | null | undefined,
options: ResolveProviderOptions = {}
): GeocodingProvider {
const warn = options.warn ?? ((message: string) => console.warn(message));
const decrypt = options.decrypt ?? decryptSecret;
const requested = settings?.routeOptimizationProvider ?? "nominatim";
if (requested === "google") {
const apiKey = resolveGoogleApiKey(settings ?? {}, decrypt, warn);
if (apiKey) {
return new GoogleGeocodingProvider(apiKey, options.google);
}
warn(
"routeOptimizationProvider is 'google' but no usable API key was found; falling back to Nominatim"
);
}
return new NominatimGeocodingProvider(options.nominatim);
}
// --- Batch geocoding -------------------------------------------------------
/** Input item for {@link geocodeBatch}: a caller-defined key and its address. */
export interface BatchGeocodeItem<K> {
key: K;
address: string;
}
/** Per-item outcome from {@link geocodeBatch}. */
export interface BatchGeocodeOutcome<K> {
key: K;
address: string;
/** Resolved coordinates, or `null` when unresolvable. */
result: GeocodeResult | null;
/** Present when the geocode call threw; the batch continues past errors. */
error?: string;
}
export interface GeocodeBatchOptions<K> {
/** Invoked after each item completes; useful for progress reporting. */
onProgress?: (
completed: number,
total: number,
outcome: BatchGeocodeOutcome<K>
) => void;
}
/**
* Geocodes a list of addresses sequentially through the given provider. The
* provider's internal rate limiter enforces throttling (e.g. Nominatim's
* 1 req/sec), so addresses are processed one at a time and individual failures
* are captured per item rather than aborting the whole batch.
*/
export async function geocodeBatch<K>(
items: ReadonlyArray<BatchGeocodeItem<K>>,
provider: GeocodingProvider,
options: GeocodeBatchOptions<K> = {}
): Promise<Array<BatchGeocodeOutcome<K>>> {
const outcomes: Array<BatchGeocodeOutcome<K>> = [];
for (const item of items) {
let outcome: BatchGeocodeOutcome<K>;
try {
const result = await provider.geocode(item.address);
outcome = { key: item.key, address: item.address, result };
} catch (err) {
outcome = {
key: item.key,
address: item.address,
result: null,
error: err instanceof Error ? err.message : String(err),
};
}
outcomes.push(outcome);
options.onProgress?.(outcomes.length, items.length, outcome);
}
return outcomes;
}
+155
View File
@@ -0,0 +1,155 @@
// Navigation export — turn an optimized groomer route into a deep-link URL that
// opens the device's native navigation app (Google Maps / Apple Maps).
//
// A route is exported as: origin = first stop, destination = last stop, with the
// in-between stops carried as ordered intermediate waypoints. Each platform caps
// how many intermediate waypoints a deep link may carry, so callers must validate
// the route length before handing the URL to the client.
/**
* Max intermediate waypoints a Google Maps URLs API deep link supports
* (`https://www.google.com/maps/dir/?api=1&...&waypoints=...`). Google documents
* a ceiling of 9 waypoints between origin and destination.
*/
export const GOOGLE_MAPS_MAX_WAYPOINTS = 9;
/**
* Max intermediate waypoints we allow in an Apple Maps `maps://` deep link. Apple's
* URL scheme chains destinations with `+to:` but does not publish a hard cap; 15 is
* a conservative practical limit that keeps the URL well under length limits.
*/
export const APPLE_MAPS_MAX_WAYPOINTS = 15;
export type NavigationPlatform = "google-maps" | "apple-maps";
/** A single ordered point on the route. `label` is optional, for display only. */
export interface NavigationStop {
latitude: number;
longitude: number;
label?: string | null;
}
export interface NavigationExportSuccess {
platform: NavigationPlatform;
url: string;
/** Total stops included (origin + waypoints + destination). */
stopCount: number;
/** Intermediate waypoints only (excludes origin and destination). */
waypointCount: number;
}
export interface NavigationExportError {
error: string;
status: 400;
}
export type NavigationExportResult =
| NavigationExportSuccess
| NavigationExportError;
function isError(r: NavigationExportResult): r is NavigationExportError {
return "error" in r;
}
/** Intermediate waypoints = every stop that is neither origin nor destination. */
export function intermediateWaypointCount(stopCount: number): number {
return Math.max(0, stopCount - 2);
}
function coord(stop: NavigationStop): string {
return `${stop.latitude},${stop.longitude}`;
}
/**
* Builds a Google Maps URLs API driving deep link. On mobile this opens the
* native Google Maps app; on desktop it opens maps.google.com.
*/
export function buildGoogleMapsUrl(
stops: NavigationStop[]
): NavigationExportResult {
if (stops.length === 0) {
return { error: "route has no stops to export", status: 400 };
}
const waypointCount = intermediateWaypointCount(stops.length);
if (waypointCount > GOOGLE_MAPS_MAX_WAYPOINTS) {
return {
error: `route has ${waypointCount} intermediate waypoints, exceeding Google Maps' limit of ${GOOGLE_MAPS_MAX_WAYPOINTS}`,
status: 400,
};
}
const origin = stops[0]!;
const destination = stops[stops.length - 1]!;
const params = new URLSearchParams();
params.set("api", "1");
params.set("travelmode", "driving");
params.set("origin", coord(origin));
params.set("destination", coord(destination));
if (stops.length > 2) {
const mids = stops
.slice(1, -1)
.map(coord)
.join("|");
params.set("waypoints", mids);
}
return {
platform: "google-maps",
url: `https://www.google.com/maps/dir/?${params.toString()}`,
stopCount: stops.length,
waypointCount,
};
}
/**
* Builds an Apple Maps `maps://` driving deep link. The first stop is the source
* (`saddr`); the remaining stops are chained as destinations with `+to:` (`daddr`).
* Built by hand because the `+to:` separators are part of Apple's scheme and must
* not be percent-encoded.
*/
export function buildAppleMapsUrl(
stops: NavigationStop[]
): NavigationExportResult {
if (stops.length === 0) {
return { error: "route has no stops to export", status: 400 };
}
const waypointCount = intermediateWaypointCount(stops.length);
if (waypointCount > APPLE_MAPS_MAX_WAYPOINTS) {
return {
error: `route has ${waypointCount} intermediate waypoints, exceeding Apple Maps' limit of ${APPLE_MAPS_MAX_WAYPOINTS}`,
status: 400,
};
}
const params: string[] = ["dirflg=d"];
if (stops.length === 1) {
// Single stop: destination only, no source.
params.unshift(`daddr=${coord(stops[0]!)}`);
} else {
const daddr = stops
.slice(1)
.map(coord)
.join("+to:");
params.unshift(`daddr=${daddr}`);
params.unshift(`saddr=${coord(stops[0]!)}`);
}
return {
platform: "apple-maps",
url: `maps://?${params.join("&")}`,
stopCount: stops.length,
waypointCount,
};
}
/** Dispatches to the correct builder for the requested platform. */
export function buildNavigationUrl(
platform: NavigationPlatform,
stops: NavigationStop[]
): NavigationExportResult {
return platform === "google-maps"
? buildGoogleMapsUrl(stops)
: buildAppleMapsUrl(stops);
}
export { isError as isNavigationExportError };
+513
View File
@@ -0,0 +1,513 @@
import { businessSettings, decryptSecret, type Db } from "@groombook/db";
import type { FetchLike } from "./geocoding.js";
/**
* Route optimization service (GRO-2155, Phase 2.1 of Route Optimization).
*
* Given a groomer's geocoded stops for a day, produces an optimized visiting
* order plus per-leg and total travel estimates. Two strategies:
*
* - {@link optimizeWithGoogle}: Google Maps Directions API with
* `optimizeWaypoints: true` (real road durations/distances), used when a
* Google Maps API key is configured.
* - {@link nearestNeighborOrder}: an offline nearest-neighbor TSP heuristic over
* great-circle distance, used as the default free / no-API-key fallback.
*
* Both strategies share the same public {@link optimizeRoute} orchestrator,
* which also handles the >25-stop edge case by chunking into sub-routes (the
* Google Directions waypoint cap) and surfacing a warning.
*/
/** Google Directions allows origin + destination + up to 23 waypoints = 25
* points per request. We cap a sub-route at 25 stops and chunk beyond that. */
export const MAX_STOPS_PER_ROUTE = 25;
/** Average driving speed (km/h) used to convert distance into travel minutes in
* the offline heuristic. Tuned for mixed urban/suburban mobile-groomer routes. */
export const AVG_SPEED_KMH = 40;
/** Multiplier applied to great-circle distance to approximate real road
* distance in the offline heuristic (straight-line underestimates driving). */
export const ROAD_CIRCUITY_FACTOR = 1.3;
const EARTH_RADIUS_KM = 6371;
/** A geocoded stop to be ordered. `appointmentId` ties it back to the schedule. */
export interface RouteStopInput {
appointmentId: string;
latitude: number;
longitude: number;
}
/** A single stop in the optimized order, with travel from the previous stop. */
export interface OptimizedStop {
appointmentId: string;
latitude: number;
longitude: number;
/** Null for the first stop of the whole route. */
travelMinsFromPrev: number | null;
/** Null for the first stop of the whole route. Kilometres, 2-dp. */
travelDistanceKmFromPrev: number | null;
}
export type RouteOptimizationProvider = "google" | "nearest_neighbor";
export interface OptimizedRoute {
provider: RouteOptimizationProvider;
stops: OptimizedStop[];
totalTravelMins: number;
/** Kilometres, rounded to 2 decimal places. */
totalDistanceKm: number;
/** True when the route was split into multiple sub-routes (>25 stops). */
chunked: boolean;
subRouteCount: number;
/** Non-fatal advisories for the caller to surface to the user. */
warnings: string[];
}
export interface OptimizeRouteOptions {
/** Google Maps API key. When absent, the nearest-neighbor heuristic is used. */
googleApiKey?: string | null;
/** Injectable fetch for testing the Google path. Defaults to global fetch. */
fetchImpl?: FetchLike;
}
const defaultFetch: FetchLike = (input, init) =>
(globalThis.fetch as unknown as FetchLike)(input, init);
// ─── Geometry helpers ───────────────────────────────────────────────────────
function toRadians(deg: number): number {
return (deg * Math.PI) / 180;
}
/** Great-circle distance between two coordinates, in kilometres. */
export function haversineKm(
a: { latitude: number; longitude: number },
b: { latitude: number; longitude: number }
): number {
const dLat = toRadians(b.latitude - a.latitude);
const dLon = toRadians(b.longitude - a.longitude);
const lat1 = toRadians(a.latitude);
const lat2 = toRadians(b.latitude);
const h =
Math.sin(dLat / 2) ** 2 +
Math.cos(lat1) * Math.cos(lat2) * Math.sin(dLon / 2) ** 2;
return 2 * EARTH_RADIUS_KM * Math.asin(Math.min(1, Math.sqrt(h)));
}
/** Round to 2 decimal places, returning a finite number. */
function round2(n: number): number {
return Math.round(n * 100) / 100;
}
/**
* Estimate a road travel leg from the great-circle distance between two points.
* Applies a circuity factor for distance and a fixed average speed for time.
*/
export function estimateLeg(
a: { latitude: number; longitude: number },
b: { latitude: number; longitude: number }
): { distanceKm: number; mins: number } {
const straight = haversineKm(a, b);
const distanceKm = straight * ROAD_CIRCUITY_FACTOR;
const mins = (distanceKm / AVG_SPEED_KMH) * 60;
return { distanceKm: round2(distanceKm), mins: Math.round(mins) };
}
// ─── Nearest-neighbor heuristic ─────────────────────────────────────────────
/**
* Orders points greedily: start at `startIndex`, then repeatedly visit the
* nearest unvisited point (great-circle distance). Returns indices into the
* input array in visiting order. Deterministic ties broken by lowest index.
*/
export function nearestNeighborOrder(
points: Array<{ latitude: number; longitude: number }>,
startIndex = 0
): number[] {
const n = points.length;
if (n <= 1) return points.map((_, i) => i);
const visited = new Array<boolean>(n).fill(false);
const order: number[] = [startIndex];
visited[startIndex] = true;
let current = startIndex;
for (let step = 1; step < n; step++) {
let best = -1;
let bestDist = Infinity;
for (let j = 0; j < n; j++) {
if (visited[j]) continue;
const d = haversineKm(points[current]!, points[j]!);
if (d < bestDist) {
bestDist = d;
best = j;
}
}
visited[best] = true;
order.push(best);
current = best;
}
return order;
}
/** Orders one chunk (<= MAX_STOPS_PER_ROUTE) via nearest-neighbor. */
function optimizeChunkNearestNeighbor(
stops: RouteStopInput[]
): RouteStopInput[] {
const order = nearestNeighborOrder(stops, 0);
return order.map((i) => stops[i]!);
}
// ─── Google Directions ──────────────────────────────────────────────────────
const GOOGLE_DIRECTIONS_URL =
"https://maps.googleapis.com/maps/api/directions/json";
interface GoogleDirectionsResponse {
status: string;
error_message?: string;
routes?: Array<{
waypoint_order?: number[];
legs?: Array<{
duration?: { value?: number };
distance?: { value?: number };
}>;
}>;
}
/**
* Orders one chunk via the Google Directions API with `optimizeWaypoints=true`.
*
* The first stop is fixed as both origin and destination (a closed tour); the
* remaining stops are passed as optimizable waypoints. We keep the optimized
* forward order and drop the final return-to-origin leg, yielding an open route
* whose per-leg durations/distances come from real road data.
*/
async function optimizeChunkGoogle(
stops: RouteStopInput[],
apiKey: string,
fetchImpl: FetchLike
): Promise<{ stops: RouteStopInput[]; legsMeters: number[]; legsSeconds: number[] }> {
if (stops.length <= 1) {
return { stops: [...stops], legsMeters: [], legsSeconds: [] };
}
const origin = stops[0]!;
const waypoints = stops.slice(1);
const url = new URL(GOOGLE_DIRECTIONS_URL);
url.searchParams.set("origin", `${origin.latitude},${origin.longitude}`);
url.searchParams.set("destination", `${origin.latitude},${origin.longitude}`);
url.searchParams.set(
"waypoints",
"optimize:true|" +
waypoints.map((w) => `${w.latitude},${w.longitude}`).join("|")
);
url.searchParams.set("key", apiKey);
const res = await fetchImpl(url.toString());
if (!res.ok) {
throw new Error(
`Google Directions request failed: ${res.status} ${res.statusText}`
);
}
const body = (await res.json()) as GoogleDirectionsResponse;
if (body.status !== "OK" || !body.routes || body.routes.length === 0) {
throw new Error(
`Google Directions returned status ${body.status}${
body.error_message ? `: ${body.error_message}` : ""
}`
);
}
const route = body.routes[0]!;
const waypointOrder = route.waypoint_order ?? waypoints.map((_, i) => i);
const legs = route.legs ?? [];
// Ordered stops: origin first, then waypoints in the optimized order.
const orderedStops: RouteStopInput[] = [
origin,
...waypointOrder.map((i) => waypoints[i]!),
];
// legs[k] is the travel into orderedStops[k+1]. Drop the trailing return leg
// (orderedStops.length-1 legs describe the open route).
const legsMeters: number[] = [];
const legsSeconds: number[] = [];
for (let k = 0; k < orderedStops.length - 1; k++) {
const leg = legs[k];
legsMeters.push(leg?.distance?.value ?? 0);
legsSeconds.push(leg?.duration?.value ?? 0);
}
return { stops: orderedStops, legsMeters, legsSeconds };
}
// ─── Orchestration ──────────────────────────────────────────────────────────
function chunk<T>(items: T[], size: number): T[][] {
const out: T[][] = [];
for (let i = 0; i < items.length; i += size) {
out.push(items.slice(i, i + size));
}
return out;
}
/**
* Optimizes a full day's stops into a single visiting order with travel
* metrics. Uses Google Directions when `googleApiKey` is provided, otherwise the
* offline nearest-neighbor heuristic. Routes longer than
* {@link MAX_STOPS_PER_ROUTE} stops are split into sub-routes and a warning is
* emitted; sub-routes are stitched end-to-end, with the boundary leg estimated
* from great-circle distance.
*/
export async function optimizeRoute(
inputStops: RouteStopInput[],
options: OptimizeRouteOptions = {}
): Promise<OptimizedRoute> {
const fetchImpl = options.fetchImpl ?? defaultFetch;
const useGoogle = Boolean(options.googleApiKey);
const provider: RouteOptimizationProvider = useGoogle
? "google"
: "nearest_neighbor";
const warnings: string[] = [];
if (inputStops.length === 0) {
return {
provider,
stops: [],
totalTravelMins: 0,
totalDistanceKm: 0,
chunked: false,
subRouteCount: 0,
warnings,
};
}
const chunks = chunk(inputStops, MAX_STOPS_PER_ROUTE);
const chunked = chunks.length > 1;
if (chunked) {
warnings.push(
`Route has ${inputStops.length} stops, exceeding the ${MAX_STOPS_PER_ROUTE}-stop optimization limit. Split into ${chunks.length} sub-routes; review the order at sub-route boundaries.`
);
}
const ordered: OptimizedStop[] = [];
let prev: RouteStopInput | null = null;
for (const group of chunks) {
let groupStops: RouteStopInput[];
let legDistanceKm: (i: number) => number;
let legMins: (i: number) => number;
if (useGoogle) {
try {
const result = await optimizeChunkGoogle(
group,
options.googleApiKey!,
fetchImpl
);
groupStops = result.stops;
legDistanceKm = (i) => round2(result.legsMeters[i]! / 1000);
legMins = (i) => Math.round(result.legsSeconds[i]! / 60);
} catch (err) {
// Google failed mid-optimization — degrade to the offline heuristic for
// this run rather than failing the whole request.
warnings.push(
`Google Directions unavailable; used offline heuristic: ${
err instanceof Error ? err.message : String(err)
}`
);
groupStops = optimizeChunkNearestNeighbor(group);
legDistanceKm = (i) => estimateLeg(groupStops[i]!, groupStops[i + 1]!).distanceKm;
legMins = (i) => estimateLeg(groupStops[i]!, groupStops[i + 1]!).mins;
}
} else {
groupStops = optimizeChunkNearestNeighbor(group);
legDistanceKm = (i) => estimateLeg(groupStops[i]!, groupStops[i + 1]!).distanceKm;
legMins = (i) => estimateLeg(groupStops[i]!, groupStops[i + 1]!).mins;
}
for (let i = 0; i < groupStops.length; i++) {
const stop = groupStops[i]!;
if (prev === null) {
// Very first stop of the whole route.
ordered.push({
appointmentId: stop.appointmentId,
latitude: stop.latitude,
longitude: stop.longitude,
travelMinsFromPrev: null,
travelDistanceKmFromPrev: null,
});
} else if (i === 0) {
// First stop of a non-initial chunk: estimate the boundary leg.
const est = estimateLeg(prev, stop);
ordered.push({
appointmentId: stop.appointmentId,
latitude: stop.latitude,
longitude: stop.longitude,
travelMinsFromPrev: est.mins,
travelDistanceKmFromPrev: est.distanceKm,
});
} else {
ordered.push({
appointmentId: stop.appointmentId,
latitude: stop.latitude,
longitude: stop.longitude,
travelMinsFromPrev: legMins(i - 1),
travelDistanceKmFromPrev: legDistanceKm(i - 1),
});
}
prev = stop;
}
}
const totalTravelMins = ordered.reduce(
(sum, s) => sum + (s.travelMinsFromPrev ?? 0),
0
);
const totalDistanceKm = round2(
ordered.reduce((sum, s) => sum + (s.travelDistanceKmFromPrev ?? 0), 0)
);
return {
provider,
stops: ordered,
totalTravelMins,
totalDistanceKm,
chunked,
subRouteCount: chunks.length,
warnings,
};
}
// ─── Google API key resolution ──────────────────────────────────────────────
/**
* Resolves the Google Maps API key for route optimization from
* `businessSettings.googleMapsApiKey` (decrypted at rest) or, as a development
* convenience, the `GOOGLE_MAPS_API_KEY` env var. Returns `null` when no usable
* key exists, in which case callers fall back to the offline heuristic.
*/
export async function resolveRouteGoogleApiKey(
db: Db,
decrypt: (ciphertext: string) => string = decryptSecret
): Promise<string | null> {
const [settings] = await db.select().from(businessSettings).limit(1);
const stored = settings?.googleMapsApiKey?.trim();
if (stored) {
try {
const decrypted = decrypt(stored).trim();
if (decrypted) return decrypted;
} catch (err) {
console.warn(
`Failed to decrypt googleMapsApiKey for route optimization; using offline heuristic: ${
err instanceof Error ? err.message : String(err)
}`
);
}
}
const fromEnv = process.env.GOOGLE_MAPS_API_KEY?.trim();
return fromEnv ? fromEnv : null;
}
// ─── Travel buffer & schedule-conflict logic (GRO-2156, Phase 2.2) ───────────
/** A single stop's timing inputs for schedule-conflict detection. */
export interface ScheduleStopTiming {
/** Scheduled appointment start. */
appointmentStartTime: Date;
/** Scheduled appointment end. */
appointmentEndTime: Date;
/** Travel minutes into this stop from the previous one (null for first). */
travelMinsFromPrev: number | null;
/** Configured buffer minutes before this stop. */
bufferMins: number;
}
/** Conflict annotation for one stop, surfaced for the frontend to display. */
export interface StopConflictFlags {
/** True when the schedule gap is too tight for travel + buffer. */
hasConflict: boolean;
/** Minutes between the previous appointment's end and this one's start.
* Null for the first stop (no predecessor). */
scheduleGapMins: number | null;
/** travelMinsFromPrev + bufferMins. Null for the first stop. */
requiredGapMins: number | null;
/** requiredGapMins scheduleGapMins; positive when the schedule is tight.
* Null for the first stop. */
shortfallMins: number | null;
}
const MS_PER_MIN = 60_000;
/**
* Detects "tight schedule" conflicts between consecutive stops, in visiting
* order. A conflict exists when the real gap between the previous appointment's
* end and this appointment's start is smaller than the time needed to travel
* plus the configured buffer (`travelMinsFromPrev + bufferMins`).
*
* This only *flags* conflicts — appointments are never moved. The first stop
* has no predecessor and is therefore always conflict-free.
*/
export function detectScheduleConflicts(
stops: ScheduleStopTiming[]
): StopConflictFlags[] {
return stops.map((s, i) => {
if (i === 0) {
return {
hasConflict: false,
scheduleGapMins: null,
requiredGapMins: null,
shortfallMins: null,
};
}
const prev = stops[i - 1]!;
const scheduleGapMins = Math.round(
(s.appointmentStartTime.getTime() - prev.appointmentEndTime.getTime()) /
MS_PER_MIN
);
const requiredGapMins = (s.travelMinsFromPrev ?? 0) + s.bufferMins;
const shortfallMins = requiredGapMins - scheduleGapMins;
return {
hasConflict: shortfallMins > 0,
scheduleGapMins,
requiredGapMins,
shortfallMins,
};
});
}
/** A coordinate used when recomputing legs for a fixed (manually chosen) order. */
export interface OrderedPoint {
latitude: number;
longitude: number;
}
/** Recomputed per-leg travel for a fixed stop order. */
export interface RecomputedLeg {
/** Null for the first stop. */
travelMinsFromPrev: number | null;
/** Null for the first stop. Kilometres, 2-dp. */
travelDistanceKmFromPrev: number | null;
}
/**
* Recomputes per-leg travel estimates for a *fixed* visiting order (e.g. after a
* manual reorder). Unlike {@link optimizeRoute} this does not reorder anything —
* it walks the given order and estimates each leg offline via {@link estimateLeg}
* so a manual drag does not consume Google Directions quota.
*/
export function recomputeLegsForOrder(points: OrderedPoint[]): RecomputedLeg[] {
return points.map((p, i) => {
if (i === 0) {
return { travelMinsFromPrev: null, travelDistanceKmFromPrev: null };
}
const est = estimateLeg(points[i - 1]!, p);
return {
travelMinsFromPrev: est.mins,
travelDistanceKmFromPrev: est.distanceKm,
};
});
}
View File