trails/apps/journal/app/routes/api.sync.webhook.$provider.ts
Ullrich Schäfer 0360757ae8 feat(journal): Garmin activity import — provider, webhook pipeline, backfill (§1–5)
Garmin Connect as the third connected-services provider (spec:
garmin-import). The interesting parts:

- Push-first ingestion: Garmin has no list endpoint. The webhook
  normalizes ping (callbackURL) and push (inline) notification batches
  into events; the slow work (authorized FIT download, FIT→GPX via the
  shared converter, activity creation) runs in a garmin-import-activity
  pg-boss job so the webhook answers fast. Callback URLs are validated
  against Garmin's API host before any fetch (SSRF guard).
- History via backfill requests: /sync/import/garmin is a date-range
  requester with honest async progress (no pick list — the concept
  doesn't exist in a push model). Ranges chunk to Garmin's 90-day cap;
  overlaps are free via sync_imports dedupe. Requests persist in
  import_batches via two new nullable columns (range_start/range_end).
- OAuth2 + PKCE on the existing oauth credential kind. Design
  correction from apply: the verifier rides a short-lived httpOnly
  cookie scoped to the callback path — the state param is visible in
  redirect URLs and must never carry it. Manifests opt in via pkce:true.
- Deregistration notifications flip the connection to 'revoked'
  (row kept for audit, imports retained, re-connect prompt shown).
- Framework evolutions, all additive: parseWebhook returns
  WebhookEvent[] (Garmin batches; Wahoo adapted), manifest gains
  configured()/importUrl/pkce, importActivity accepts summary stats
  for FIT-less imports, manager gains markRevoked.
- Env-gated: no GARMIN_CLIENT_ID → provider hidden on
  /settings/connections. Privacy manifest entry (DE+EN). i18n en+de.

Rollout (§6) stays gated on the Garmin Developer Program application
(submitted 2026-06-07). Fixtures are doc-shaped; the staging soak
swaps in recorded payloads if shapes differ.

Gate: typecheck ✓ lint ✓ unit+integration ✓ e2e 70/72 + both known
flakes green isolated ✓ openspec validate ✓

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-07 17:47:22 +02:00

50 lines
1.6 KiB
TypeScript

import { data } from "react-router";
import { z } from "zod";
import type { Route } from "./+types/api.sync.webhook.$provider";
import { getManifest } from "~/lib/connected-services";
// Generic webhook envelope. Provider-specific shape validation happens in
// each provider's `parseWebhook`; here we only enforce that the body is a
// JSON object so downstream code never crashes on a malformed payload.
const webhookEnvelope = z.object({ webhook_token: z.string().optional() }).passthrough();
export async function action({ params, request }: Route.ActionArgs) {
if (request.method !== "POST") {
return data({ error: "Method not allowed" }, { status: 405 });
}
const manifest = getManifest(params.provider);
if (!manifest || !manifest.webhookReceiver) {
// Don't reveal provider existence — return 200 silently.
return data({ ok: true });
}
let raw: unknown;
try {
raw = await request.json();
} catch {
return data({ ok: true });
}
const envelope = webhookEnvelope.safeParse(raw);
if (!envelope.success) {
return data({ ok: true });
}
const body = envelope.data;
// Verify webhook token (provider-specific shared secret).
const expectedToken = process.env[`${params.provider.toUpperCase()}_WEBHOOK_TOKEN`];
if (expectedToken && body.webhook_token !== expectedToken) {
return data({ ok: true });
}
const events = manifest.webhookReceiver.parseWebhook(body);
for (const event of events) {
try {
await manifest.webhookReceiver.handle(event);
} catch (e) {
console.error(`Webhook import failed for ${manifest.id}/${event.workoutId}:`, e);
}
}
return data({ ok: true });
}