mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-19 08:12:52 +00:00
feat(cycle): add the calendar-feed credential table
A record's cycle calendar subscription is a URL credential: one row per feed, only the HMAC of the raw hlf_ token stored, and at most one live feed per record through a partial unique index on user_id where revoked_at is null. Both foreign keys cascade, so deleting the record or the carrier who minted the feed ends it. The row is a credential everywhere else too. It stays out of the backup (a restore would bring back a revoked link), Delete All Data takes it on both sides, a credential remediation revokes the feeds on the record and the ones the account minted elsewhere, and a managed-profile handover claim revokes any feed a guardian minted. backupVerdict moves beside the plan into its own module so the plan stays the lists and their reasons.
This commit is contained in:
1 parent
c0470df14c
commit
2480a0138d
9 files changed
+235
-18
No files matched your search
@@ -0,0 +1,85 @@
|
||||
-- Subscribable cycle forecast (#1350): one table holding the calendar-feed
|
||||
-- credential of a record, and the enum for how its events are titled.
|
||||
--
|
||||
-- The row is a URL credential. Only the HMAC of the raw `hlf_` token is
|
||||
-- stored; the forecast itself is computed on every fetch and never persisted.
|
||||
-- Revocation stamps `revoked_at` and never deletes, so the uniqueness that
|
||||
-- matters (at most one LIVE feed per record) is a partial index, the shape
|
||||
-- `account_grants_live_pair_key` uses. Prisma cannot express it, so it lives
|
||||
-- here only.
|
||||
--
|
||||
-- Both foreign keys cascade: deleting the record ends its feed, and deleting
|
||||
-- the carrier who minted it does too, so a delegate's account going away
|
||||
-- cannot leave a link behind that nobody can revoke.
|
||||
--
|
||||
-- One DO block, so the file is one statement that rolls back whole and the
|
||||
-- foreign keys' lock wait on `users` is bounded. Only the new table and the
|
||||
-- new type are created; nothing existing changes shape. Reversibility:
|
||||
-- dropping the table and the type ends every feed URL; subscribers see 404 and
|
||||
-- the owner mints again.
|
||||
--
|
||||
-- @retry-on-lock-timeout
|
||||
|
||||
DO $migration$
|
||||
BEGIN
|
||||
PERFORM set_config('lock_timeout', '5s', true);
|
||||
|
||||
IF NOT EXISTS (
|
||||
SELECT 1 FROM pg_type WHERE typname = 'cycle_calendar_feed_title_mode'
|
||||
) THEN
|
||||
CREATE TYPE "cycle_calendar_feed_title_mode" AS ENUM ('DISCREET', 'DESCRIPTIVE');
|
||||
END IF;
|
||||
|
||||
CREATE TABLE IF NOT EXISTS "cycle_calendar_feeds" (
|
||||
"id" TEXT NOT NULL,
|
||||
"user_id" TEXT NOT NULL,
|
||||
"created_by_id" TEXT NOT NULL,
|
||||
"token_hash" TEXT NOT NULL,
|
||||
"token_prefix" TEXT NOT NULL,
|
||||
"created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||
"revoked_at" TIMESTAMP(3),
|
||||
"last_fetched_at" TIMESTAMP(3),
|
||||
"fetch_count" INTEGER NOT NULL DEFAULT 0,
|
||||
"last_fetcher_ua" TEXT,
|
||||
"body_hash" TEXT,
|
||||
"content_changed_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||
"horizon_cycles" INTEGER NOT NULL DEFAULT 3,
|
||||
"history_cycles" INTEGER NOT NULL DEFAULT 0,
|
||||
"include_fertile" BOOLEAN NOT NULL DEFAULT false,
|
||||
"title_mode" "cycle_calendar_feed_title_mode" NOT NULL DEFAULT 'DISCREET',
|
||||
|
||||
CONSTRAINT "cycle_calendar_feeds_pkey" PRIMARY KEY ("id"),
|
||||
-- The ranges the options route validates, held again by the table so a
|
||||
-- write that bypassed the route cannot widen the horizon.
|
||||
CONSTRAINT "cycle_calendar_feeds_horizon_check"
|
||||
CHECK ("horizon_cycles" BETWEEN 1 AND 6),
|
||||
CONSTRAINT "cycle_calendar_feeds_history_check"
|
||||
CHECK ("history_cycles" BETWEEN 0 AND 12)
|
||||
);
|
||||
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS "cycle_calendar_feeds_token_hash_key"
|
||||
ON "cycle_calendar_feeds" ("token_hash");
|
||||
|
||||
CREATE INDEX IF NOT EXISTS "cycle_calendar_feeds_user_id_created_at_idx"
|
||||
ON "cycle_calendar_feeds" ("user_id", "created_at" DESC);
|
||||
|
||||
CREATE INDEX IF NOT EXISTS "cycle_calendar_feeds_created_by_id_idx"
|
||||
ON "cycle_calendar_feeds" ("created_by_id");
|
||||
|
||||
-- At most one live feed per record. Revoked rows fall out of the index, so a
|
||||
-- rotate (revoke, then mint, in one transaction) never collides with itself.
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS "cycle_calendar_feeds_live_user_key"
|
||||
ON "cycle_calendar_feeds" ("user_id")
|
||||
WHERE "revoked_at" IS NULL;
|
||||
|
||||
ALTER TABLE "cycle_calendar_feeds"
|
||||
ADD CONSTRAINT "cycle_calendar_feeds_user_id_fkey"
|
||||
FOREIGN KEY ("user_id") REFERENCES "users"("id")
|
||||
ON DELETE CASCADE ON UPDATE CASCADE;
|
||||
|
||||
ALTER TABLE "cycle_calendar_feeds"
|
||||
ADD CONSTRAINT "cycle_calendar_feeds_created_by_id_fkey"
|
||||
FOREIGN KEY ("created_by_id") REFERENCES "users"("id")
|
||||
ON DELETE CASCADE ON UPDATE CASCADE;
|
||||
END
|
||||
$migration$;
|
||||
@@ -1166,6 +1166,12 @@ model User {
|
||||
// v1.15.0 — owner of a per-user custom CycleSymptom (NULL = the global
|
||||
// seeded catalogue).
|
||||
cycleSymptomsCustom CycleSymptom[] @relation("UserCycleSymptoms")
|
||||
// #1350 — the subscribable cycle forecast. `cycleCalendarFeeds` is the
|
||||
// record the feed serves; `cycleCalendarFeedsMinted` is the carrier who
|
||||
// minted it, which is the owner on their own record and a MANAGE delegate
|
||||
// on a record they manage.
|
||||
cycleCalendarFeeds CycleCalendarFeed[] @relation("CycleCalendarFeedSubject")
|
||||
cycleCalendarFeedsMinted CycleCalendarFeed[] @relation("CycleCalendarFeedCreator")
|
||||
|
||||
// v1.39 — the needs-based onboarding's answers and step ledger for THIS
|
||||
// record. 1:1, and keyed by record rather than by the person at the
|
||||
@@ -8328,6 +8334,75 @@ model CycleProfile {
|
||||
@@map("cycle_profiles")
|
||||
}
|
||||
|
||||
/// #1350 — how the feed titles its events. DISCREET shows a dot and names the
|
||||
/// calendar "HealthLog"; DESCRIPTIVE names the period and the calendar.
|
||||
enum CycleCalendarFeedTitleMode {
|
||||
DISCREET
|
||||
DESCRIPTIVE
|
||||
|
||||
@@map("cycle_calendar_feed_title_mode")
|
||||
}
|
||||
|
||||
/// #1350 — a subscribable calendar feed of one record's cycle forecast.
|
||||
///
|
||||
/// The row is a URL credential. Only the HMAC of the raw `hlf_` token is
|
||||
/// stored (`hashToken`, the same key as `ApiToken.tokenHash`); the raw token is
|
||||
/// returned once at mint and is unrecoverable afterwards. The feed is computed
|
||||
/// live on every fetch from the record's own rows, so nothing about the
|
||||
/// forecast is stored here.
|
||||
///
|
||||
/// At most one live feed per record: a partial unique index on `user_id WHERE
|
||||
/// revoked_at IS NULL`, written in the migration because Prisma cannot express
|
||||
/// it. Revocation stamps `revokedAt` and never deletes, so the status read can
|
||||
/// say when a link stopped working. Not in the backup: a restore would bring
|
||||
/// back a link the owner revoked (see `backup-plan.ts`).
|
||||
model CycleCalendarFeed {
|
||||
id String @id @default(cuid())
|
||||
/// The record whose forecast the feed serves.
|
||||
userId String @map("user_id")
|
||||
/// Who minted it: the owner, or a MANAGE delegate. A carrier's feed is
|
||||
/// re-checked against their live grant on every fetch.
|
||||
createdById String @map("created_by_id")
|
||||
|
||||
/// HMAC-SHA256 of the raw `hlf_` token.
|
||||
tokenHash String @unique @map("token_hash")
|
||||
/// The first 8 characters of the raw token, shown in settings so the owner
|
||||
/// can tell which link is live. Not enough to rebuild it.
|
||||
tokenPrefix String @map("token_prefix")
|
||||
|
||||
createdAt DateTime @default(now()) @map("created_at")
|
||||
revokedAt DateTime? @map("revoked_at")
|
||||
|
||||
/// Fetch statistics, written fire-and-forget by the feed route and read by
|
||||
/// the status endpoint ("last fetched 3 h ago by Google Calendar").
|
||||
lastFetchedAt DateTime? @map("last_fetched_at")
|
||||
fetchCount Int @default(0) @map("fetch_count")
|
||||
/// The last fetcher's User-Agent, truncated to 80 characters.
|
||||
lastFetcherUa String? @map("last_fetcher_ua")
|
||||
|
||||
/// SHA-256 of the last served body without its timestamps. When a fetch
|
||||
/// builds a different body, `contentChangedAt` moves; both drive DTSTAMP,
|
||||
/// LAST-MODIFIED and the ETag.
|
||||
bodyHash String? @map("body_hash")
|
||||
contentChangedAt DateTime @default(now()) @map("content_changed_at")
|
||||
|
||||
/// Forecast cycles ahead (1..6). The feed caps itself further once the
|
||||
/// band grows past ±10 days or half a cycle.
|
||||
horizonCycles Int @default(3) @map("horizon_cycles")
|
||||
/// Observed cycles included as history (0..12).
|
||||
historyCycles Int @default(0) @map("history_cycles")
|
||||
/// The fertile window of the next cycle, for TRYING_TO_CONCEIVE only.
|
||||
includeFertile Boolean @default(false) @map("include_fertile")
|
||||
titleMode CycleCalendarFeedTitleMode @default(DISCREET) @map("title_mode")
|
||||
|
||||
user User @relation("CycleCalendarFeedSubject", fields: [userId], references: [id], onDelete: Cascade)
|
||||
createdBy User @relation("CycleCalendarFeedCreator", fields: [createdById], references: [id], onDelete: Cascade)
|
||||
|
||||
@@index([userId, createdAt(sort: Desc)])
|
||||
@@index([createdById])
|
||||
@@map("cycle_calendar_feeds")
|
||||
}
|
||||
|
||||
/// One row per menstrual cycle (a period-start anchor + derived span).
|
||||
/// `isPredicted` rows are forward-minted forecasts; observed rows are
|
||||
/// confirmed from logged flow. Soft-deleted + syncVersion-bumped so the
|
||||
|
||||
Reference in new issue
Block a user