mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-17 23:52:24 +00:00
chore(release): v1.4.49 — audit-backlog closure + server reminder suppression + diagnostic endpoint + analytics cold-path fix
Bundles the deferred v1.4.47 Mediums + Lows with the v1.4.48-deferred items into a single release. Headline: server-side suppression of MEDICATION_REMINDER APNs for iOS clients that own their local reminders (closes GH #206), a push_attempts table backing /api/admin/notifications/diagnostic, and a sweep of v1.4.48 QA forward-findings. Performance (the user-visible win): - /api/analytics cold-fallback path splits the heavy single-statement aggregate into two parallel queries. The linearly composable columns (count / min / max / mean) keep the full-partition scan; the windowed 7 / 30 / 90-day avg / slope / r² columns take a 90-day outer cap so the planner does an index range scan on (user_id, type, measured_at) instead of a full-partition sequential scan. Output is bit-identical; cold slim slice drops from multi-second to sub-second on tenants with large measurement partitions. Server-side notifications: - GET + PATCH /api/auth/me/notification-prefs with deep-merge semantics. Initial category medication.clientManaged: boolean (default false). Cron medicationReminderJob skips dose-due APNs when the flag is true, emitting a medication_reminder.suppressed_client_managed wide-event annotation per skip. - push_attempts table backs the diagnostic endpoint. Every APNS / Web-Push / Telegram / NTFY sender writes a fire-and-forget row. Daily 03:35 Europe/Berlin cleanup prunes rows older than 90 days. - /api/admin/notifications/diagnostic — admin-only endpoint surfacing device APNs token presence (masked), channel config presence, and recent push attempts. Registered in OpenAPI. - Per-channel APNs "Send test" button now fires with eventType: "MEDICATION_REMINDER" so the dispatcher's time-sensitive + priority-10 branch runs. A successful self-test now exercises the exact path production reminders take; an unsuccessful one points the user at iOS Settings → Time Sensitive Notifications rather than appearing to be a server-side bug. Withings reliability: - OAuth callback consumes the nonce atomically (delete-first with P2025 catch for the replay branch). The previous read-then-delete pattern allowed a race between two concurrent callbacks. - ?reason=state redirect differentiated into csrf1 / replay / expired / cross_user so operators can tell mismatch types apart without DB shell access. - connect endpoint rate-limited to 10/60s/user; row-create failures redirect to a consistent error surface. Observability hardening: - redactSensitiveFields(body) denylist helper covers password / token / secret / apiKey / authorization / csrfState / nonce, recursive, case-insensitive. Caught: /api/devices invalid_format issues were echoing apnsToken values verbatim into the audit log. - sanitiseZodIssues(issues, { stripValuesFromMessage: true }) overload applied to 14 audit-log sites. Migrations: 0079 (notification_prefs), 0080 (push_attempts). Tests: 4815 → 5272 unit + integration. Workout-batch integration suite that had been red on main since v1.4.45 (three release commits shipped through it) now green again — updated to match v1.4.42 cross-source dedup semantics. Resolves PR #207.
This commit is contained in:
1 parent
30ab2112db
commit
f92e644154
87 files changed
+7939
-2950
No files matched your search
@@ -0,0 +1,146 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import {
|
||||
DEFAULT_NOTIFICATION_PREFS,
|
||||
isMedicationReminderClientManaged,
|
||||
notificationPrefsSchema,
|
||||
parseNotificationPrefs,
|
||||
resolveNotificationPrefs,
|
||||
} from "../notification-prefs";
|
||||
|
||||
/**
|
||||
* v1.4.49 M-DOUBLE-REMINDER — per-user notification preferences blob.
|
||||
*
|
||||
* The cron at `src/lib/jobs/reminder-worker.ts` reads
|
||||
* `user.notificationPrefs` and calls
|
||||
* `isMedicationReminderClientManaged` to decide whether to skip the
|
||||
* MEDICATION_REMINDER APNs dispatch. These tests pin the helper's
|
||||
* contract so the cron skip is deterministic across schema drift.
|
||||
*/
|
||||
describe("notificationPrefsSchema", () => {
|
||||
it("accepts an empty object (every key is optional)", () => {
|
||||
const out = notificationPrefsSchema.parse({});
|
||||
expect(out).toEqual({});
|
||||
});
|
||||
|
||||
it("accepts the medication.clientManaged shape", () => {
|
||||
const input = { medication: { clientManaged: true } };
|
||||
const out = notificationPrefsSchema.parse(input);
|
||||
expect(out).toEqual(input);
|
||||
});
|
||||
|
||||
it("rejects a non-boolean clientManaged", () => {
|
||||
const res = notificationPrefsSchema.safeParse({
|
||||
medication: { clientManaged: "yes" },
|
||||
});
|
||||
expect(res.success).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("parseNotificationPrefs", () => {
|
||||
it("returns documented defaults for null", () => {
|
||||
expect(parseNotificationPrefs(null)).toEqual(DEFAULT_NOTIFICATION_PREFS);
|
||||
});
|
||||
|
||||
it("returns documented defaults for undefined", () => {
|
||||
expect(parseNotificationPrefs(undefined)).toEqual(
|
||||
DEFAULT_NOTIFICATION_PREFS,
|
||||
);
|
||||
});
|
||||
|
||||
it("returns defaults when the persisted shape has drifted", () => {
|
||||
expect(parseNotificationPrefs({ unknown: "shape" })).toEqual(
|
||||
DEFAULT_NOTIFICATION_PREFS,
|
||||
);
|
||||
});
|
||||
|
||||
it("returns the persisted shape when valid", () => {
|
||||
expect(
|
||||
parseNotificationPrefs({ medication: { clientManaged: true } }),
|
||||
).toEqual({ medication: { clientManaged: true } });
|
||||
});
|
||||
|
||||
it("fills missing keys from the defaults", () => {
|
||||
expect(parseNotificationPrefs({ medication: {} })).toEqual({
|
||||
medication: { clientManaged: false },
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("resolveNotificationPrefs (deep-merge)", () => {
|
||||
it("layers the input over the persisted row", () => {
|
||||
const out = resolveNotificationPrefs(
|
||||
{ medication: { clientManaged: false } },
|
||||
{ medication: { clientManaged: true } },
|
||||
);
|
||||
expect(out).toEqual({ medication: { clientManaged: true } });
|
||||
});
|
||||
|
||||
it("preserves the persisted medication keys when the input only touches new sub-keys", () => {
|
||||
// Future-proof: the route hands the merged shape to Prisma, so
|
||||
// sibling keys inside `medication` must survive a partial PATCH.
|
||||
const out = resolveNotificationPrefs(
|
||||
{ medication: { clientManaged: true } },
|
||||
{ medication: {} },
|
||||
);
|
||||
expect(out).toEqual({ medication: { clientManaged: true } });
|
||||
});
|
||||
|
||||
it("falls back to defaults when the persisted row is null", () => {
|
||||
const out = resolveNotificationPrefs(null, {
|
||||
medication: { clientManaged: true },
|
||||
});
|
||||
expect(out).toEqual({ medication: { clientManaged: true } });
|
||||
});
|
||||
|
||||
it("returns the defaults when neither side carries a value", () => {
|
||||
const out = resolveNotificationPrefs(null, {});
|
||||
expect(out).toEqual(DEFAULT_NOTIFICATION_PREFS);
|
||||
});
|
||||
});
|
||||
|
||||
describe("isMedicationReminderClientManaged — cron-skip gate", () => {
|
||||
it("returns false for a null row (legacy server-managed default)", () => {
|
||||
expect(isMedicationReminderClientManaged(null)).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false for undefined (Prisma findUnique miss)", () => {
|
||||
expect(isMedicationReminderClientManaged(undefined)).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false when the user has not opted in", () => {
|
||||
expect(
|
||||
isMedicationReminderClientManaged({
|
||||
medication: { clientManaged: false },
|
||||
}),
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it("returns true when the user has opted in via the iOS app", () => {
|
||||
expect(
|
||||
isMedicationReminderClientManaged({
|
||||
medication: { clientManaged: true },
|
||||
}),
|
||||
).toBe(true);
|
||||
});
|
||||
|
||||
it("returns false for a drifted persisted shape (forward-compat)", () => {
|
||||
expect(
|
||||
isMedicationReminderClientManaged({ notACategory: { foo: "bar" } }),
|
||||
).toBe(false);
|
||||
});
|
||||
|
||||
it("returns false when only sibling categories are present", () => {
|
||||
// Future-proof: another (future) category set to true must NOT
|
||||
// gate MEDICATION_REMINDER — only `medication.clientManaged`
|
||||
// affects the medication cron.
|
||||
expect(
|
||||
isMedicationReminderClientManaged({
|
||||
// Cast through unknown — the production runtime sees this as
|
||||
// a JSONB value that bypasses the zod schema, but the helper
|
||||
// must still resolve to the safe default.
|
||||
otherCategory: { enabled: true },
|
||||
} as unknown),
|
||||
).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,128 @@
|
||||
/**
|
||||
* v1.4.49 M-DOUBLE-REMINDER — per-user notification preferences blob.
|
||||
*
|
||||
* Persisted on `User.notificationPrefs` as Postgres jsonb. Null = the
|
||||
* documented defaults (every category off). The flag is opt-in: the
|
||||
* iOS app flips it to `true` only after confirming local Spezi
|
||||
* reminders are wired, so existing users without a working local
|
||||
* notification path see zero regression.
|
||||
*
|
||||
* Shape (additive — future categories slot in next to `medication`):
|
||||
* {
|
||||
* "medication": { "clientManaged": boolean }
|
||||
* }
|
||||
*
|
||||
* The schema is intentionally additive — every new category grows the
|
||||
* schema with a new optional sub-object plus an entry in
|
||||
* `DEFAULT_NOTIFICATION_PREFS`. Forward-compat: an unknown / drifted
|
||||
* shape falls back to defaults rather than throwing.
|
||||
*/
|
||||
import { z } from "zod/v4";
|
||||
|
||||
/**
|
||||
* Medication category schema. Currently a single boolean
|
||||
* (`clientManaged`); the sub-object exists so future per-category
|
||||
* knobs (e.g. quiet-hours overrides) can be added without breaking
|
||||
* the persisted layout.
|
||||
*/
|
||||
const medicationPrefsSchema = z
|
||||
.object({
|
||||
clientManaged: z.boolean(),
|
||||
})
|
||||
.partial();
|
||||
|
||||
/**
|
||||
* Top-level prefs schema. Every category is optional so a PATCH that
|
||||
* only touches `medication` doesn't have to re-state future siblings.
|
||||
* The route layer deep-merges the partial input over the persisted
|
||||
* row before persisting so the column shape stays stable.
|
||||
*/
|
||||
export const notificationPrefsSchema = z
|
||||
.object({
|
||||
medication: medicationPrefsSchema,
|
||||
})
|
||||
.partial();
|
||||
|
||||
export type NotificationPrefsInput = z.infer<typeof notificationPrefsSchema>;
|
||||
|
||||
/**
|
||||
* Fully-resolved prefs. Every key required so consumers (cron
|
||||
* suppression, GET response) don't need to thread "is this present?"
|
||||
* checks through their paths.
|
||||
*/
|
||||
export interface NotificationPrefs {
|
||||
medication: {
|
||||
clientManaged: boolean;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Safe defaults. Every category is off so the server reminders flow
|
||||
* unchanged for any user the iOS app has not explicitly opted in.
|
||||
* Marc's directive: zero regression for clients without working
|
||||
* local reminders.
|
||||
*/
|
||||
export const DEFAULT_NOTIFICATION_PREFS: NotificationPrefs = {
|
||||
medication: {
|
||||
clientManaged: false,
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* Parse the persisted `notificationPrefs` JSON blob into a typed
|
||||
* `NotificationPrefs`, falling back to the defaults when the row is
|
||||
* null OR the persisted shape has drifted (a forward-compat field
|
||||
* rename, an admin-side hand-edit, etc.). Missing keys are filled
|
||||
* from the defaults so callers always get a fully-resolved object.
|
||||
*/
|
||||
export function parseNotificationPrefs(raw: unknown): NotificationPrefs {
|
||||
if (raw == null) return cloneDefaults();
|
||||
const parsed = notificationPrefsSchema.safeParse(raw);
|
||||
if (!parsed.success) return cloneDefaults();
|
||||
return mergeOverDefaults(parsed.data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deep-merge a partial input (typically from a PATCH body) over the
|
||||
* current persisted row, layering each supplied category's keys over
|
||||
* the existing category sub-object so future siblings are not
|
||||
* overwritten when the client only PATCHes `medication`.
|
||||
*/
|
||||
export function resolveNotificationPrefs(
|
||||
current: unknown,
|
||||
incoming: NotificationPrefsInput,
|
||||
): NotificationPrefs {
|
||||
const base = parseNotificationPrefs(current);
|
||||
return {
|
||||
medication: {
|
||||
...base.medication,
|
||||
...(incoming.medication ?? {}),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Cron-side helper. Returns `true` when the user has opted in to
|
||||
* client-managed medication reminders and the server-side push
|
||||
* should be suppressed. Tolerates a null / missing prefs row.
|
||||
*/
|
||||
export function isMedicationReminderClientManaged(raw: unknown): boolean {
|
||||
return parseNotificationPrefs(raw).medication.clientManaged === true;
|
||||
}
|
||||
|
||||
function cloneDefaults(): NotificationPrefs {
|
||||
return {
|
||||
medication: { ...DEFAULT_NOTIFICATION_PREFS.medication },
|
||||
};
|
||||
}
|
||||
|
||||
function mergeOverDefaults(
|
||||
input: NotificationPrefsInput,
|
||||
): NotificationPrefs {
|
||||
return {
|
||||
medication: {
|
||||
...DEFAULT_NOTIFICATION_PREFS.medication,
|
||||
...(input.medication ?? {}),
|
||||
},
|
||||
};
|
||||
}
|
||||
Reference in new issue
Block a user