mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-16 23:33:29 +00:00
Merge branch 'main' into feat/mood-level-b
This commit is contained in:
commit
61c220b7b8
8 files changed
+906
-109
No files matched your search
@@ -20,22 +20,55 @@ import {
|
||||
|
||||
// v1.4.25 W16b — typed workout batch ingest response envelope. Mirrors
|
||||
// the measurements batch shape but reports the `workouts` count rather
|
||||
// than the entries count, and the `skipped` field is reserved (the
|
||||
// Zod schema rejects malformed entries with a 400 before the per-entry
|
||||
// pass, so today's responses always carry an empty array).
|
||||
// than the entries count. `skipped` carries the entries the server
|
||||
// refused: an unusable external id, or a `samples` array that failed
|
||||
// validation (`reason: "invalid_samples"`).
|
||||
//
|
||||
// `enriched` says the entry matched a stored workout that had no
|
||||
// heart-rate series and the series it carried was attached. The
|
||||
// workout row itself was not written, so such an entry also counts
|
||||
// towards `duplicates`. That rule is part of the published contract,
|
||||
// not just a note here: it rides the field descriptions below, because
|
||||
// a client summing the counters has to know which bucket an
|
||||
// enrichment lands in.
|
||||
const workoutBatchEntryResult = z
|
||||
.object({
|
||||
index: z.number().int().nonnegative(),
|
||||
status: z.enum(["inserted", "duplicate", "skipped"]),
|
||||
reason: z.string().optional(),
|
||||
status: z
|
||||
.enum(["inserted", "duplicate", "enriched", "skipped"])
|
||||
.describe(
|
||||
"`inserted`: a new workout row. `duplicate`: the workout was already stored and nothing was written. `enriched`: the workout was already stored and the heart-rate series this entry carried was attached to it; the workout row itself was not written, and the entry also counts towards the top-level `duplicates`. `skipped`: the server refused the entry, see `reason`.",
|
||||
),
|
||||
reason: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
"Why a `skipped` entry was refused: `unstable_external_id` for an id that does not survive a client restart, `invalid_samples` for a heart-rate series that failed validation.",
|
||||
),
|
||||
})
|
||||
.meta({ id: "WorkoutBatchEntryResult" });
|
||||
|
||||
const workoutBatchResponse = z
|
||||
.object({
|
||||
processed: z.number().int().nonnegative(),
|
||||
inserted: z.number().int().nonnegative(),
|
||||
duplicates: z.number().int().nonnegative(),
|
||||
processed: z
|
||||
.number()
|
||||
.int()
|
||||
.nonnegative()
|
||||
.describe(
|
||||
"Entries in the request. Equals `inserted + duplicates + skipped.length`.",
|
||||
),
|
||||
inserted: z
|
||||
.number()
|
||||
.int()
|
||||
.nonnegative()
|
||||
.describe("Workout rows this request wrote."),
|
||||
duplicates: z
|
||||
.number()
|
||||
.int()
|
||||
.nonnegative()
|
||||
.describe(
|
||||
"Entries that wrote no workout row because the workout was already stored. The top-level counters count workout rows, so an entry reported as `enriched` counts here as well even though its heart-rate series was attached.",
|
||||
),
|
||||
skipped: z.array(
|
||||
z.object({
|
||||
index: z.number().int().nonnegative(),
|
||||
@@ -275,7 +308,7 @@ export const workoutPaths: NonNullable<ZodOpenApiObject["paths"]> = {
|
||||
tags: ["Measurements"],
|
||||
summary: "Typed workout batch ingest (v1.4.25 W16b)",
|
||||
description:
|
||||
"Server-side ingest endpoint for HKWorkout records (iOS) and Withings activity rows (server-to-server). Up to 100 workouts per call; nested route geometry (GeoJSON LineString) is capped at 20 000 points and stored in a 1:1 `WorkoutRoute` row keyed by `workoutId`. Idempotent via the `Idempotency-Key` header (replay window 24h). Per-entry status (`inserted | duplicate | skipped`) lets the iOS sync cursor checkpoint accurately. The request body ceiling is 5 MB enforced at the HTTP layer — clients above the ceiling receive a 413 with `workout.batch.payload_too_large`.",
|
||||
'Server-side ingest endpoint for HKWorkout records (iOS) and Withings activity rows (server-to-server). Up to 100 workouts per call; nested route geometry (GeoJSON LineString) is capped at 20 000 points and stored in a 1:1 `WorkoutRoute` row keyed by `workoutId`. Idempotent via the `Idempotency-Key` header (replay window 24h). Per-entry status (`inserted | duplicate | enriched | skipped`) lets the iOS sync cursor checkpoint accurately. An entry matching a stored workout is first-write-wins for the workout row; when it carries a `samples` array and the stored workout has no heart-rate series, the series is attached and the entry reports `enriched` (repeatable: a workout that already has a series is a no-op). An entry whose `samples` array fails validation is refused on its own with `reason: "invalid_samples"` — the rest of the batch still lands. The request body ceiling is 5 MB enforced at the HTTP layer — clients above the ceiling receive a 413 with `workout.batch.payload_too_large`.',
|
||||
requestBody: {
|
||||
required: true,
|
||||
content: { "application/json": { schema: createBatchWorkoutSchema } },
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import {
|
||||
INVALID_SAMPLES_REASON,
|
||||
parseWorkoutBatch,
|
||||
} from "@/lib/workouts/batch-ingest-parse";
|
||||
|
||||
function entry(overrides: Record<string, unknown> = {}) {
|
||||
return {
|
||||
sportType: "running",
|
||||
startedAt: "2026-05-14T06:30:00.000Z",
|
||||
endedAt: "2026-05-14T07:15:00.000Z",
|
||||
source: "APPLE_HEALTH",
|
||||
externalId: "hk-uuid-1",
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
describe("parseWorkoutBatch", () => {
|
||||
it("parses a clean batch and refuses nothing", () => {
|
||||
const result = parseWorkoutBatch({
|
||||
workouts: [
|
||||
entry({ samples: [{ t: "2026-05-14T06:30:00.000Z", hr: 120 }] }),
|
||||
],
|
||||
});
|
||||
expect(result.ok).toBe(true);
|
||||
if (!result.ok) return;
|
||||
expect(result.refusedSampleIndices).toEqual([]);
|
||||
expect(result.data.workouts[0]?.samples).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("refuses only the entries whose samples array is malformed", () => {
|
||||
const result = parseWorkoutBatch({
|
||||
workouts: [
|
||||
entry({ externalId: "hk-a", samples: [{ t: "nope", hr: 4000 }] }),
|
||||
entry({ externalId: "hk-b" }),
|
||||
entry({ externalId: "hk-c", samples: [] }),
|
||||
],
|
||||
});
|
||||
expect(result.ok).toBe(true);
|
||||
if (!result.ok) return;
|
||||
expect(result.refusedSampleIndices).toEqual([0, 2]);
|
||||
// The survivors keep their full typed shape.
|
||||
expect(result.data.workouts).toHaveLength(3);
|
||||
expect(result.data.workouts[1]?.externalId).toBe("hk-b");
|
||||
expect(result.data.workouts[0]?.samples).toBeUndefined();
|
||||
});
|
||||
|
||||
it("keeps failing the whole batch when any other field is wrong", () => {
|
||||
const result = parseWorkoutBatch({
|
||||
workouts: [
|
||||
entry({ endedAt: "2026-05-14T06:00:00.000Z" }),
|
||||
entry({ externalId: "hk-b", samples: [{ t: "nope" }] }),
|
||||
],
|
||||
});
|
||||
expect(result.ok).toBe(false);
|
||||
if (result.ok) return;
|
||||
expect(result.message).toMatch(/endedAt/i);
|
||||
});
|
||||
|
||||
it("fails the batch when the envelope itself is not a batch", () => {
|
||||
expect(parseWorkoutBatch({ workouts: [] }).ok).toBe(false);
|
||||
expect(parseWorkoutBatch(null).ok).toBe(false);
|
||||
expect(parseWorkoutBatch({ workouts: "nope" }).ok).toBe(false);
|
||||
});
|
||||
|
||||
it("names the per-entry reason code the route reports", () => {
|
||||
expect(INVALID_SAMPLES_REASON).toBe("invalid_samples");
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,109 @@
|
||||
/**
|
||||
* Batch-ingest body parsing for `POST /api/workouts/batch`.
|
||||
*
|
||||
* The wire contract is `createBatchWorkoutSchema` and stays exactly that:
|
||||
* this module never widens what the endpoint accepts. What it changes is
|
||||
* WHERE one specific failure lands.
|
||||
*
|
||||
* A malformed field anywhere in the batch fails the whole call with a 400,
|
||||
* which is right for a client that got the shape wrong. The `samples`
|
||||
* array is the exception, because of how it arrives: the native client
|
||||
* re-posts workouts the server already stores purely to hand over their
|
||||
* heart-rate curve, sweeping years of history in batches of up to a
|
||||
* hundred. One session whose series came out of HealthKit malformed would
|
||||
* otherwise stall the entire sweep at a 400 the client cannot repair by
|
||||
* retrying — every other workout in that batch is fine and has nothing to
|
||||
* do with the bad one.
|
||||
*
|
||||
* So an entry whose `samples` array fails validation is refused on its
|
||||
* own, exactly the way an entry with an unusable `externalId` already is
|
||||
* (see `classifyExternalId` in the route), and the rest of the batch
|
||||
* lands. The refused entry is NOT stripped down and stored without its
|
||||
* series: the caller asked for the curve to be saved, so a half-write
|
||||
* would be a silent loss. It is reported back with its index so the
|
||||
* client knows which session to fix.
|
||||
*
|
||||
* Every other validation failure keeps failing the batch.
|
||||
*/
|
||||
import {
|
||||
createBatchWorkoutSchema,
|
||||
type CreateBatchWorkoutInput,
|
||||
} from "@/lib/validations/workout";
|
||||
|
||||
/** Per-entry `reason` code for a `samples` array that failed validation. */
|
||||
export const INVALID_SAMPLES_REASON = "invalid_samples";
|
||||
|
||||
export type WorkoutBatchParseResult =
|
||||
| {
|
||||
ok: true;
|
||||
data: CreateBatchWorkoutInput;
|
||||
/** Batch indices whose `samples` array was refused. */
|
||||
refusedSampleIndices: number[];
|
||||
}
|
||||
| { ok: false; message: string };
|
||||
|
||||
function isRecord(value: unknown): value is Record<string, unknown> {
|
||||
return typeof value === "object" && value !== null && !Array.isArray(value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Indices of entries whose ONLY problem is the `samples` array. An issue
|
||||
* path of `["workouts", 3, "samples", ...]` names entry 3; anything else
|
||||
* means the batch is broken in a way this path does not forgive.
|
||||
*/
|
||||
function collectSampleFailureIndices(
|
||||
issues: ReadonlyArray<{ path: PropertyKey[] }>,
|
||||
): number[] | null {
|
||||
const indices = new Set<number>();
|
||||
for (const issue of issues) {
|
||||
const [root, index, field] = issue.path;
|
||||
if (root !== "workouts" || typeof index !== "number" || field !== "samples")
|
||||
return null;
|
||||
indices.add(index);
|
||||
}
|
||||
return indices.size > 0 ? [...indices].sort((a, b) => a - b) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a batch body, refusing per entry when the only failures are
|
||||
* `samples` arrays. On that path the offending entries are re-parsed
|
||||
* without their series so the surviving entries keep their fully typed
|
||||
* shape; the caller drops the refused indices before any write.
|
||||
*/
|
||||
export function parseWorkoutBatch(rawBody: unknown): WorkoutBatchParseResult {
|
||||
const strict = createBatchWorkoutSchema.safeParse(rawBody);
|
||||
if (strict.success) {
|
||||
return { ok: true, data: strict.data, refusedSampleIndices: [] };
|
||||
}
|
||||
|
||||
const refusedSampleIndices = collectSampleFailureIndices(strict.error.issues);
|
||||
if (
|
||||
refusedSampleIndices === null ||
|
||||
!isRecord(rawBody) ||
|
||||
!Array.isArray(rawBody.workouts)
|
||||
) {
|
||||
return {
|
||||
ok: false,
|
||||
message: strict.error.issues[0]?.message ?? "Invalid batch",
|
||||
};
|
||||
}
|
||||
|
||||
const refused = new Set(refusedSampleIndices);
|
||||
const stripped = {
|
||||
...rawBody,
|
||||
workouts: rawBody.workouts.map((entry, index) => {
|
||||
if (!refused.has(index) || !isRecord(entry)) return entry;
|
||||
const { samples: _samples, ...rest } = entry;
|
||||
return rest;
|
||||
}),
|
||||
};
|
||||
|
||||
const relaxed = createBatchWorkoutSchema.safeParse(stripped);
|
||||
if (!relaxed.success) {
|
||||
return {
|
||||
ok: false,
|
||||
message: relaxed.error.issues[0]?.message ?? "Invalid batch",
|
||||
};
|
||||
}
|
||||
return { ok: true, data: relaxed.data, refusedSampleIndices };
|
||||
}
|
||||
Reference in new issue
Block a user