fix(onboarding): the connect step reads the sync verdict

The step decided "connected" from the ledger's `state` and had one piece of
copy for every outcome: "the first sync is in progress". That sentence was
false for a connection delivering for months, and worse for one the person
has to repair — the screen said everything was fine while the grant was gone.

`connectSourceView` resolves the envelope entry into one of four tiles and
says whether the flow may record its result. Only `pending_first_sync` and
`fresh` may; `stale` is acknowledged without being claimed as new; `stalled`,
`failing`, `reauth_required` and `parked` name the state and link at the page
that can change it. An unresolved envelope paints no tile at all.

A source the instance cannot connect — a BYO provider with no client pair, a
shared-app provider with no app — now points at the credentials instead of
offering a "Connect" button onto a card that has none.
This commit is contained in:
Marc-André Bombeck committed 2026-09-11 09:15:32 +02:00
1 parent 0bdbf009f6
commit da58d16642
11 files changed
+883 -45

No files matched your search

@@ -0,0 +1,194 @@
/**
* v1.38.19 (wave B / C1, C2, I1, I2, I3) — the connect arm of the one task
* the flow ends on.
*
* This arm is the only place in the flow that renders a claim about real
* account state, and it shipped without a test. It decided "connected" from
* the ledger's `state` field, whose "no row" default was `connected` — so a
* brand-new account that ticked WHOOP on Q4 was told WHOOP was connected and
* had the flow's one result stamped as achieved on its behalf. It also had a
* single piece of copy, "the first sync is in progress", for every outcome,
* including the two that need the person to act.
*
* Vitest renders without a DOM here (project convention: SSR only), so what
* is pinned is the first paint — which tile the screen paints for each of the
* eight verdicts and what it says. Whether the result is RECORDED is decided
* by `connectSourceView(...).settled` and pinned in
* `src/lib/onboarding/__tests__/first-result-config.test.ts`, where the eight
* verdicts are enumerated against the decision itself rather than its markup.
*/
import { describe, expect, it, vi } from "vitest";
import { renderToStaticMarkup } from "react-dom/server";
import { I18nProvider } from "@/lib/i18n/context";
import type { SyncVerdict } from "@/lib/integrations/sync-verdict";
import {
defaultOnboardingSteps,
emptyOnboardingNeeds,
type OnboardingStateDto,
} from "@/lib/onboarding/needs";
vi.mock("next/navigation", () => ({
useRouter: () => ({ push: vi.fn(), replace: vi.fn() }),
}));
vi.mock("../use-onboarding-flow", async () => {
const actual = await vi.importActual<typeof import("../use-onboarding-flow")>(
"../use-onboarding-flow",
);
return {
...actual,
useOnboardingAnswer: () => ({
mutateAsync: vi.fn().mockResolvedValue(undefined),
isPending: false,
}),
};
});
const envelope = vi.hoisted(() => ({
value: undefined as { isLoading: boolean; data: unknown } | undefined,
}));
vi.mock("@/components/settings/integrations/shared", async () => {
const actual = await vi.importActual<
typeof import("@/components/settings/integrations/shared")
>("@/components/settings/integrations/shared");
return {
...actual,
useIntegrationStatuses: () => envelope.value,
};
});
import { FirstResultScreen } from "../first-result-screen";
interface StatusOverrides {
connected?: boolean;
configured?: boolean;
available?: boolean;
state?: string;
verdict?: SyncVerdict;
since?: string | null;
lastSuccessAt?: string | null;
}
function statuses(overrides: StatusOverrides | null) {
envelope.value =
overrides === null
? { isLoading: true, data: undefined }
: {
isLoading: false,
data: {
threshold: 3,
integrations: [
{
integration: "whoop",
connected: overrides.connected ?? false,
configured: overrides.configured ?? true,
available: overrides.available,
state: overrides.state ?? "unknown",
lastSuccessAt: overrides.lastSuccessAt ?? null,
lastAttemptAt: null,
lastError: null,
consecutiveFailuresByKind: null,
syncHealth: {
verdict: overrides.verdict ?? "disconnected",
since: overrides.since ?? null,
},
metricFreshness: [],
},
],
},
};
}
function state(): OnboardingStateDto {
return {
steps: defaultOnboardingSteps(),
needs: {
...emptyOnboardingNeeds(),
recordTarget: "me",
sources: ["whoop"],
},
completedAt: null,
firstResult: null,
};
}
function render(overrides: StatusOverrides | null) {
statuses(overrides);
return renderToStaticMarkup(
<I18nProvider initialLocale="en">
<FirstResultScreen state={state()} />
</I18nProvider>,
);
}
const VERDICT_SLOT = [
["disconnected", "connect"],
["pending_first_sync", "result"],
["fresh", "result"],
["stale", "result"],
["stalled", "attention"],
["failing", "attention"],
["reauth_required", "attention"],
["parked", "attention"],
] as const;
describe("<FirstResultScreen> — the connect arm", () => {
it.each(VERDICT_SLOT)(
"paints the %s verdict on the %s tile",
(verdict, slot) => {
const html = render({
connected: verdict !== "disconnected",
verdict,
since: "2026-09-01T00:00:00.000Z",
lastSuccessAt: "2026-09-01T00:00:00.000Z",
});
expect(html).toContain(`data-connect-slot="${slot}"`);
},
);
it("never claims a connection for a fresh account's empty ledger", () => {
// The exact envelope a brand-new account publishes: no row for the
// provider, so the ledger state is the synthetic `unknown`.
const html = render({ connected: false, state: "unknown" });
expect(html).toContain('data-connect-slot="connect"');
expect(html).not.toContain("is connected");
expect(html).not.toContain("The first sync is in progress");
});
it("says the first sync is running only while it actually is", () => {
expect(
render({ connected: true, verdict: "pending_first_sync" }),
).toContain("The first sync is in progress");
expect(
render({
connected: true,
verdict: "fresh",
lastSuccessAt: "2026-09-01T00:00:00.000Z",
}),
).not.toContain("The first sync is in progress");
});
it("names the state a connection that needs repairing is in", () => {
const html = render({
connected: true,
verdict: "reauth_required",
since: "2026-09-01T00:00:00.000Z",
});
expect(html).toContain("needs renewing");
expect(html).toContain("/settings/integrations#whoop");
});
it("points a source the instance cannot connect at the credentials", () => {
const html = render({ connected: false, configured: false });
expect(html).toContain('data-connect-slot="credentials"');
expect(html).toContain("no WHOOP app on file yet");
});
it("decides nothing while the status envelope is still in flight", () => {
const html = render(null);
expect(html).not.toContain("data-connect-slot=");
expect(html).toContain('data-slot="onboarding-task-checking"');
});
});
+128 -16
View File
@@ -33,7 +33,9 @@ import type { OnboardingAreaKey } from "@/lib/modules/registry";
import {
AREA_PAGE_HREF,
AREA_READING_TARGETS,
connectSourceView,
SOURCE_INTEGRATION,
type ConnectSourceSlot,
} from "@/lib/onboarding/first-result-config";
import type { OnboardingStateDto } from "@/lib/onboarding/needs";
import { questionOptionLabelKey } from "@/lib/onboarding/question-config";
@@ -193,32 +195,92 @@ function ConnectSourceTask({
onComplete: (target: string | null) => Promise<void>;
}) {
const { t } = useTranslations();
const fmt = useFormatters();
const { anchor, statusKey } = SOURCE_INTEGRATION[source];
const label = t(questionOptionLabelKey("sources", source));
// Refetches on window focus, so coming back from the integrations tab
// after the handshake picks the fresh verdict up on its own.
const statuses = useIntegrationStatuses(true);
const status = pickStatus(statuses.data, statusKey as IntegrationKey);
const connected = status?.connected === true || status?.state === "connected";
// The liveness truth is the server-resolved verdict and nothing else. The
// ledger's `state` is what the last ATTEMPT did, and its "no row" default
// read as `connected` until v1.38.19 — which is how a brand-new account was
// told its wearable was connected, and had this step stamped as achieved on
// its behalf. `null` means the envelope has not resolved: no claim, no tile.
const view = connectSourceView(source, status);
const settled = view?.settled ?? false;
// Record the result once the connection is there — once. `completed` flips
// only after the write resolves, and the status envelope can re-render this
// in between, so a ref latches the first call.
// Record the result once the connection is really there — once. `completed`
// flips only after the write resolves, and the status envelope can re-render
// this in between, so a ref latches the first call.
const recorded = useRef(completed);
useEffect(() => {
if (connected && !recorded.current) {
if (settled && !recorded.current) {
recorded.current = true;
void onComplete(source);
}
}, [connected, onComplete, source]);
}, [settled, onComplete, source]);
if (completed || connected) {
const settingsHref = `/settings/integrations#${anchor}`;
if (!view) {
// Nothing is known yet. The heading is the person's own answer, so it
// stays; the body says only that the check is running.
return (
<p
className="text-muted-foreground text-sm"
role="status"
data-slot="onboarding-task-checking"
>
{t("onboarding.flow.first-result.connect-source.checking")}
</p>
);
}
const key = `onboarding.flow.first-result.connect-source.state.${view.verdict}`;
const when = view.when
? fmt.dateTime(view.when)
: t("onboarding.flow.first-result.connect-source.noDate");
if (view.slot === "result") {
return (
<ResultTile
title={t("onboarding.flow.first-result.connect-source.done", {
target: label,
})}
detail={t("onboarding.flow.first-result.connect-source.syncing")}
title={t(`${key}.title`, { target: label })}
detail={t(`${key}.detail`, { when })}
connect={{ slot: view.slot, state: view.verdict }}
/>
);
}
if (view.slot === "attention") {
return (
<ConnectNoticeTile
slot={view.slot}
state={view.verdict}
testSlot="onboarding-task-attention"
title={t(`${key}.title`, { target: label })}
detail={t(`${key}.detail`, { when })}
href={settingsHref}
cta={t("onboarding.flow.first-result.connect-source.openSettings")}
/>
);
}
if (view.slot === "credentials") {
return (
<ConnectNoticeTile
slot={view.slot}
state={view.verdict}
testSlot="onboarding-task-credentials"
title={t(
"onboarding.flow.first-result.connect-source.needsCredentials.title",
{ target: label },
)}
detail={t(
"onboarding.flow.first-result.connect-source.needsCredentials.detail",
)}
href={settingsHref}
cta={t("onboarding.flow.first-result.connect-source.openSettings")}
/>
);
}
@@ -227,6 +289,8 @@ function ConnectSourceTask({
<div
className="bg-card border-border space-y-4 rounded-xl border p-4 md:p-6"
data-slot="onboarding-task-connect"
data-connect-slot={view.slot}
data-connect-state={view.verdict}
>
<p className="text-sm">
{t("onboarding.flow.first-result.connect-source.howTo", {
@@ -234,21 +298,58 @@ function ConnectSourceTask({
})}
</p>
<Button asChild className="min-h-11">
<Link href={`/settings/integrations#${anchor}`}>
<Link href={settingsHref}>
{t("onboarding.flow.first-result.connect-source.cta", {
target: label,
})}
</Link>
</Button>
<p className="text-muted-foreground text-xs" aria-live="polite">
{statuses.isLoading
? t("onboarding.flow.first-result.connect-source.checking")
: t("onboarding.flow.first-result.connect-source.waiting")}
{t("onboarding.flow.first-result.connect-source.waiting")}
</p>
</div>
);
}
/**
* A connection the flow cannot treat as its result: one that needs repairing
* (`attention`) or one the instance cannot start at all (`credentials`). Both
* say which state it is in and link at the one page that can change it —
* never a "Connect" button onto a card that has none.
*/
function ConnectNoticeTile({
slot,
state,
testSlot,
title,
detail,
href,
cta,
}: {
slot: ConnectSourceSlot;
state: string;
testSlot: string;
title: string;
detail: string;
href: string;
cta: string;
}) {
return (
<div
className="bg-card border-border space-y-3 rounded-xl border p-4 md:p-6"
data-slot={testSlot}
data-connect-slot={slot}
data-connect-state={state}
>
<p className="text-sm font-medium">{title}</p>
<p className="text-muted-foreground text-sm">{detail}</p>
<Button asChild variant="outline" className="min-h-11">
<Link href={href}>{cta}</Link>
</Button>
</div>
);
}
/* ── add a medication ──────────────────────────────────────────────────── */
interface MedicationDetail {
@@ -508,11 +609,22 @@ function LatestReadingTile({
* itself sits under it in content colour, because it is the reading, the
* medication or the connection the person came for.
*/
function ResultTile({ title, detail }: { title: string; detail?: string }) {
function ResultTile({
title,
detail,
connect,
}: {
title: string;
detail?: string;
/** Set by the connect arm so a journey can read which verdict it painted. */
connect?: { slot: ConnectSourceSlot; state: string };
}) {
return (
<div
className="bg-card border-border space-y-2 rounded-xl border p-4 md:p-6"
data-slot="onboarding-first-result-done"
data-connect-slot={connect?.slot}
data-connect-state={connect?.state}
>
<WrittenOutcomeLine
outcome="success"
@@ -3,6 +3,9 @@
* on a surface that exists, so the first-result screen can never be handed
* a task it cannot render.
*/
import { readdirSync, readFileSync } from "node:fs";
import { join } from "node:path";
import { describe, expect, it } from "vitest";
import { ONBOARDING_AREA_KEYS } from "@/lib/modules/registry";
@@ -11,6 +14,7 @@ import { NAV_DESTINATIONS } from "@/components/layout/nav-model";
import {
AREA_PAGE_HREF,
AREA_READING_TARGETS,
connectSourceView,
SOURCE_INTEGRATION,
} from "../first-result-config";
import { BROWSER_CONNECTABLE_SOURCES } from "../wizard-steps";
@@ -38,3 +42,180 @@ describe("first-result targets", () => {
}
});
});
/**
* v1.38.19 (wave B / C1, I2, I3) — what the connect step is allowed to say.
*
* The screen used to decide "connected" from the ledger's `state` field, whose
* default meant the opposite of its name, and had one piece of copy for every
* outcome. The decision is a pure function over the envelope entry now, so the
* eight verdicts can be enumerated here rather than inferred from markup.
*/
describe("connectSourceView", () => {
const cases = [
["disconnected", "connect", false],
["pending_first_sync", "result", true],
["fresh", "result", true],
["stale", "result", false],
["stalled", "attention", false],
["failing", "attention", false],
["reauth_required", "attention", false],
["parked", "attention", false],
] as const;
it.each(cases)(
"verdict %s renders the %s tile and settles=%s",
(verdict, slot, settled) => {
const view = connectSourceView("whoop", {
connected: verdict !== "disconnected",
configured: true,
syncHealth: { verdict, since: "2026-09-01T00:00:00.000Z" },
lastSuccessAt: "2026-09-01T00:00:00.000Z",
});
expect(view?.slot).toBe(slot);
expect(view?.settled).toBe(settled);
expect(view?.verdict).toBe(verdict);
},
);
it("says nothing at all until the envelope has resolved", () => {
expect(connectSourceView("whoop", undefined)).toBeNull();
});
it("does not read a fresh account's empty ledger as a connection", () => {
// What a brand-new account publishes: no row anywhere, so `state` is the
// synthetic `unknown` and the verdict is `disconnected`.
const view = connectSourceView("whoop", {
connected: false,
configured: true,
state: "unknown",
syncHealth: { verdict: "disconnected", since: null },
lastSuccessAt: null,
});
expect(view?.slot).toBe("connect");
expect(view?.settled).toBe(false);
});
it("points a BYO provider with no credentials at the credentials", () => {
const view = connectSourceView("whoop", {
connected: false,
configured: false,
syncHealth: { verdict: "disconnected", since: null },
lastSuccessAt: null,
});
expect(view?.slot).toBe("credentials");
});
it("points a shared-app provider with no usable app at the credentials", () => {
const view = connectSourceView("oura", {
connected: false,
configured: false,
available: false,
syncHealth: { verdict: "disconnected", since: null },
lastSuccessAt: null,
});
expect(view?.slot).toBe("credentials");
});
it("offers the connect card when the instance's shared app resolves", () => {
const view = connectSourceView("oura", {
connected: false,
configured: false,
available: true,
syncHealth: { verdict: "disconnected", since: null },
lastSuccessAt: null,
});
expect(view?.slot).toBe("connect");
});
it("never withholds the connect card from a self-hosted URL source", () => {
const view = connectSourceView("nightscout", {
connected: false,
configured: false,
syncHealth: { verdict: "disconnected", since: null },
lastSuccessAt: null,
});
expect(view?.slot).toBe("connect");
});
it("dates a stale tile from the last value and a failing one from the streak", () => {
expect(
connectSourceView("whoop", {
connected: true,
configured: true,
syncHealth: { verdict: "stale", since: "2026-08-01T00:00:00.000Z" },
lastSuccessAt: "2026-08-20T00:00:00.000Z",
})?.when,
).toBe("2026-08-20T00:00:00.000Z");
expect(
connectSourceView("whoop", {
connected: true,
configured: true,
syncHealth: { verdict: "failing", since: "2026-08-01T00:00:00.000Z" },
lastSuccessAt: null,
})?.when,
).toBe("2026-08-01T00:00:00.000Z");
});
});
/**
* The connect step's copy is chosen by a key built at runtime from the
* verdict, which the repo's three i18n guards cannot see into: a template
* `ns.${x}` counts as covering its whole subtree, so a MEMBER missing from
* every bundle is invisible to them. Enumerate the verdicts here instead —
* the eight the server can resolve, in all seven locales.
*/
describe("connect-source state copy", () => {
const VERDICTS = [
"fresh",
"stale",
"stalled",
"failing",
"reauth_required",
"parked",
"pending_first_sync",
] as const;
const LOCALES = readdirSync(join(__dirname, "../../../../messages"))
.filter((file) => file.endsWith(".json"))
.map((file) => ({
locale: file.replace(/\.json$/, ""),
copy: JSON.parse(
readFileSync(join(__dirname, "../../../../messages", file), "utf8"),
) as Record<string, never>,
}));
it("covers all seven locales", () => {
expect(LOCALES.length).toBe(7);
});
it.each(LOCALES)(
"names every verdict in $locale, with no English fallback",
({ locale, copy }) => {
const block = (
copy as unknown as {
onboarding: {
flow: {
"first-result": {
"connect-source": Record<string, Record<string, unknown>>;
};
};
};
}
).onboarding.flow["first-result"]["connect-source"];
for (const verdict of VERDICTS) {
const entry = block.state[verdict] as
{ title?: string; detail?: string } | undefined;
expect(entry?.title, `${locale}/${verdict}.title`).toBeTruthy();
expect(entry?.detail, `${locale}/${verdict}.detail`).toBeTruthy();
}
// `disconnected` is the one verdict with no state copy: it renders the
// connect card or the credentials note, neither of which is a claim
// about a connection that exists.
expect(block.state.disconnected).toBeUndefined();
expect(block.needsCredentials.title).toBeTruthy();
expect(block.openSettings).toBeTruthy();
expect(block.noDate).toBeTruthy();
},
);
});
+121 -8
View File
@@ -7,6 +7,7 @@
* which integration a Q4 source is, and which page carries an area the
* measurement form cannot log.
*/
import type { SyncVerdict } from "@/lib/integrations/sync-verdict";
import type { OnboardingAreaKey } from "@/lib/modules/registry";
import type { BrowserConnectableSource } from "./wizard-steps";
@@ -47,19 +48,131 @@ export const AREA_PAGE_HREF: Readonly<
illness: "/illness",
});
/**
* How a source's connection is authorised on this instance, which decides
* what "cannot be connected yet" means for it:
*
* - `byo` — the OAuth app is per-user only (`configured` is the stored client
* id/secret pair). With none, the provider card renders a credentials note
* and no connect button at all, so offering "Connect" walks the person into
* a dead end.
* - `shared` — an operator env app is the fallback (`available` says whether
* any usable credentials resolve, own or shared).
* - `self-hosted` — a URL the person pastes; nothing can be missing up front.
*/
export type SourceCredentialModel = "byo" | "shared" | "self-hosted";
/**
* The connections panel's anchor for each connectable source — the `id` of
* the provider card on Settings → Integrations, and the key its status is
* published under on `/api/integrations/status`.
*/
export const SOURCE_INTEGRATION: Readonly<
Record<BrowserConnectableSource, { anchor: string; statusKey: string }>
Record<
BrowserConnectableSource,
{ anchor: string; statusKey: string; credentials: SourceCredentialModel }
>
> = Object.freeze({
withings: { anchor: "withings", statusKey: "withings" },
oura: { anchor: "oura", statusKey: "oura" },
whoop: { anchor: "whoop", statusKey: "whoop" },
polar: { anchor: "polar", statusKey: "polar" },
fitbit: { anchor: "fitbit", statusKey: "fitbit" },
strava: { anchor: "strava", statusKey: "strava" },
nightscout: { anchor: "nightscout", statusKey: "nightscout" },
withings: { anchor: "withings", statusKey: "withings", credentials: "byo" },
oura: { anchor: "oura", statusKey: "oura", credentials: "shared" },
whoop: { anchor: "whoop", statusKey: "whoop", credentials: "byo" },
polar: { anchor: "polar", statusKey: "polar", credentials: "shared" },
fitbit: { anchor: "fitbit", statusKey: "fitbit", credentials: "byo" },
strava: { anchor: "strava", statusKey: "strava", credentials: "shared" },
nightscout: {
anchor: "nightscout",
statusKey: "nightscout",
credentials: "self-hosted",
},
});
/** Which tile the connect step renders. */
export type ConnectSourceSlot =
/** Nothing is connected and something can be: today's connect card. */
| "connect"
/** Nothing is connected and nothing CAN be: point at the credentials. */
| "credentials"
/** A working connection — the flow's result, whether or not it is new. */
| "result"
/** A connection the person has to repair, named rather than painted green. */
| "attention";
/** The fields of an `/api/integrations/status` entry this decision reads. */
export interface ConnectSourceStatus {
connected?: boolean;
configured?: boolean;
available?: boolean;
state?: string;
syncHealth?: { verdict: SyncVerdict; since: string | null };
lastSuccessAt?: string | null;
}
export interface ConnectSourceView {
slot: ConnectSourceSlot;
verdict: SyncVerdict;
/**
* Whether the flow may record this as the completed first result. Only a
* connection that is delivering, or one whose first sync is under way —
* never a connection that needs repairing, and never the mere absence of a
* ledger row.
*/
settled: boolean;
/** The instant the copy names, or null when there is none to name. */
when: string | null;
}
/**
* What the connect step may honestly say about one source.
*
* The liveness truth is `syncHealth.verdict` and nothing else — the ledger's
* `state` is what the last ATTEMPT did, and its "no row" default used to read
* as `connected`, which is how a brand-new account was told its wearable was
* connected and had the flow's one result stamped as achieved on its behalf.
*
* Returns `null` while the envelope has not resolved: an unloaded status is
* not evidence of anything, and the screen says nothing rather than guessing.
*/
export function connectSourceView(
source: BrowserConnectableSource,
status: ConnectSourceStatus | undefined,
): ConnectSourceView | null {
if (!status) return null;
const verdict = status.syncHealth?.verdict ?? "disconnected";
const settled = verdict === "pending_first_sync" || verdict === "fresh";
const when =
verdict === "fresh" || verdict === "stale"
? (status.lastSuccessAt ?? status.syncHealth?.since ?? null)
: (status.syncHealth?.since ?? status.lastSuccessAt ?? null);
if (settled || verdict === "stale") {
return { slot: "result", verdict, settled, when };
}
if (verdict !== "disconnected") {
return { slot: "attention", verdict, settled, when };
}
return {
slot: canStartConnection(source, status) ? "connect" : "credentials",
verdict,
settled,
when,
};
}
/**
* Whether the connect CTA leads anywhere. A `byo` provider without its client
* pair and a `shared` provider without any resolvable app both land on a card
* that has no connect button — the dead end the flow used to walk into.
*/
function canStartConnection(
source: BrowserConnectableSource,
status: ConnectSourceStatus,
): boolean {
switch (SOURCE_INTEGRATION[source].credentials) {
case "byo":
return status.configured !== false;
case "shared":
return status.available !== false;
case "self-hosted":
return true;
}
}