Skip to content

Readiness score: Today card and Settings (2/5) - #105

Open
ak710 wants to merge 3 commits into
saksham2001:mainfrom
ak710:feat/readiness-tile
Open

Readiness score: Today card and Settings (2/5)#105
ak710 wants to merge 3 commits into
saksham2001:mainfrom
ak710:feat/readiness-tile

Conversation

@ak710

@ak710 ak710 commented Aug 2, 2026

Copy link
Copy Markdown

Second readiness PR (#103), building on the scoring engine in #104. This is the follow-up listed there as "2. Today tile + Settings".

Stacked on #104. This branch sits directly on top of feat/readiness-score, so until #104 merges the diff here shows both commits. Once it lands, this collapses to the single tile commit. Reviewing 3f1d618 alone is the intended unit.

Puts the score on screen as a full-width card pinned directly under the Today hero, above the metric grid, with its own Settings page.

Deliberately not a tile in the reorderable grid

Every other tile reports one measurement. Readiness is a verdict over those measurements — HRV, resting HR, sleep, temperature and yesterday's load collapsed into a single number. Placing it beside a peer tile framed it as a sibling metric, which is the wrong mental model, and half a tile's width couldn't carry the reasoning that stops it being a black box.

So it carries no MetricKey at all: it's pinned by design, and visibility is the Settings toggle's job rather than the drag tray's.

The width earns its keep. The card shows the score, its band, the share of signals it's based on, and the top two contributors holding it back — each with its own explanation and what it cost, e.g. "Skin temperature 0.5 °C above your baseline, −3.4 pts".

The empty state counts down instead of repeating an instruction

Readiness can't say anything until it knows what your normal looks like. A flat "wear your ring overnight" gives no sense of whether that means one more night or two more weeks — and on a device with a month of history it reads as broken.

The card now shows a filling ring with "3 of 7 nights" and "4 more nights to go", so the feature visibly works before it can produce a score.

Three things make that honest rather than decorative:

  • Progress counts nights that actually produced overnight signal, not days since install. Someone who wore the ring twice in a month is two nights along, and saying otherwise would promise a score that isn't coming.
  • A night whose sleep decode failed still counts if vitals were captured.
  • Nights are a proxy for BaselineStats.isEstablished, which also requires enough individual readings — so the copy never claims "0 more nights" while still showing no score. It says it's still gathering readings instead. A test pins the advertised night count against the gate itself, so the countdown can't drift from what actually unblocks a score.

This also fixes a real gap in the previous copy: it keyed off the pairing calibration state, so a long-established user who simply lacked a readiness baseline saw a bare "No score yet" with no path forward.

Gating

The card is gated on its master toggle plus "can this ring measure recovery at all" — HRV or sleep, the two signals ReadinessScore requires. A ring with neither could never produce a score, so the card is absent rather than permanently empty.

Two things worth a closer look in review

1. Band zones live in ReadinessZones, not on a view. The card, the detail hero and the trend chart all need them, and none should depend on another's type name. A test pins them against ReadinessScore.band.

2. TodayStore needed two changes. ReadinessService.refreshIfStale runs before the signature is captured, not after — otherwise the write lands after the snapshot and forces a second, wasted rebuild. And the signature gained a readiness clause; without it a freshly scored night sits in the database while the card keeps showing yesterday's.

Progress is computed only while there is no score, so it never runs on the happy path.

Testing

25 new tests. Layout verified in the simulator against seeded demo data (-seedDemo YES), which #104 made produce 10 scored days across multiple bands.

Also adds an -openReadinessSettings launch arg, matching the existing nutrition test tooling.

Follow-ups

  1. Detail screen with contributor breakdown and trend
  2. Coach tool get_readiness
  3. Widget metric
  4. Check-in mention + sharp-drop anomaly rule

Each is already implemented on its own branch and will be opened as its parent merges, so no PR ever carries more than one step's diff.

ak710 and others added 2 commits July 31, 2026 22:14
First of several PRs implementing the readiness/recovery score from the
roadmap's "Metrics you can trust" section (saksham2001#103). This one lands the engine
and its storage; the Today tile, detail screen, coach tool, and widget
follow separately.

A daily 0-100 score from five contributors, weighted 30/25/30/10/5:
overnight HRV, resting heart rate, sleep, skin temperature, and yesterday's
training load. Four are judged against the user's own baseline; sleep is
absolute because SleepScore already encodes population-normal ranges.

Three rules shape the design:

- Missing signals leave the denominator rather than scoring zero. A night
  without a temperature reading is scored out of 90 points, not penalised
  10, and the result reports its coverage. This mirrors the doctrine at the
  top of SleepInsights.swift.
- An unestablished baseline counts as missing, not as "at baseline".
  Scoring a deviation against three days of data would look authoritative
  while being noise.
- Every contributor carries its own explanation ("HRV 12% below your
  baseline"), so the score is never surfaced as a bare number. The full
  algorithm - every weight and threshold - is documented in
  docs/project/readiness.md.

Reuses the existing baseline machinery rather than building a parallel one:
BaselineStats for HRV and temperature, and UserProfile.hrRestingBaseline,
which RestingHRBaselineService already learns and throttles. ReadinessService
is shaped after that service. Overnight signals are read from the sleep
session's own span, falling back to 22:00-08:00 when sleep wasn't decoded,
so daytime readings can't masquerade as recovery data.

Scores persist as ReadinessDaily with their breakdown, since recomputing an
old morning against today's baseline would give a different and wrong
answer. Rows carry an algorithmVersion that invalidates them on a weight
change instead of silently reinterpreting them.

Archive format version goes to 2. readinessDailies is Optional because
PulseArchive uses the synthesized decoder, which has no notion of property
defaults - a non-optional array would make every existing v1 backup
unimportable. Covered by a test that strips the key from a real export.

39 new tests. Demo seed data produces 10 scored days across multiple bands,
so the feature is reviewable without a ring.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Second readiness PR (saksham2001#103), building on the scoring engine. Puts the score
on screen as a full-width card pinned directly under the Today hero, above
the metric grid, with its own Settings page.

Deliberately NOT a tile in the reorderable grid. Every other tile reports
one measurement; readiness is a verdict *over* those measurements - HRV,
resting HR, sleep, temperature and yesterday's load collapsed into a single
number. Placing it beside a peer tile framed it as a sibling metric, which
is the wrong mental model, and half a tile's width could not carry the
reasoning that stops it being a black box. So it carries no MetricKey at
all: it is pinned by design, and visibility is the Settings toggle's job
rather than the drag tray's.

The width earns its keep. The card shows the score, its band, the share of
signals it is based on, and the top two contributors holding it back - each
with its own explanation and what it cost, e.g. "Skin temperature 0.5 °C
above your baseline, −3.4 pts".

The empty state counts down instead of repeating an instruction. Readiness
cannot say anything until it knows what *your* normal looks like, and a flat
"wear your ring overnight" gives no sense of whether that means one more
night or two more weeks - on a device with a month of history it reads as
broken. The card now shows a filling ring with "3 of 7 nights" and "4 more
nights to go", so the feature visibly works before it can produce a score.

Progress counts nights that actually produced overnight signal, not days
since install: someone who wore the ring twice in a month is two nights
along, and saying otherwise would promise a score that isn't coming. A night
whose sleep decode failed still counts if vitals were captured. And because
nights are a proxy for BaselineStats.isEstablished - which also requires
enough individual readings - the copy never claims "0 more nights" while
still showing no score; it says it is still gathering readings. A test pins
the advertised night count against the gate itself, so the countdown cannot
drift from what actually unblocks a score.

This also fixes a real gap the previous copy had: it keyed off the pairing
calibration state, so a long-established user who simply lacked a readiness
baseline saw a bare "No score yet" with no path forward.

The card is gated on its master toggle plus "can this ring measure recovery
at all" - HRV or sleep, the two signals ReadinessScore requires. A ring with
neither could never produce a score, so the card is absent rather than
permanently empty.

Band zones live in ReadinessZones rather than on a view, because the card,
the detail hero and the trend chart all need them and none should depend on
another's type name. A test pins them against ReadinessScore.band.

TodayStore needed two changes. ReadinessService.refreshIfStale runs BEFORE
the signature is captured, not after - otherwise the write lands after the
snapshot and forces a second, wasted rebuild. And the signature gained a
readiness clause; without it a freshly scored night sits in the database
while the card keeps showing yesterday's.

Progress is computed only while there is no score, so it never runs on the
happy path.

Also adds an -openReadinessSettings launch arg, matching the existing
nutrition test tooling.

25 new tests. Layout verified in the simulator against seeded demo data.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ak710
ak710 requested a review from saksham2001 as a code owner August 2, 2026 01:02
Two inline contributor JSON literals ran past 200 characters, which is
SwiftLint's error threshold and was failing CI. Hoist both into named
multiline constants, matching how the other readiness tests already
carry their fixtures.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant