trails/apps/journal/app/routes/api.sync.callback.$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

85 lines
3.3 KiB
TypeScript

import { redirect, data } from "react-router";
import { getOrigin } from "~/lib/config.server";
import type { Route } from "./+types/api.sync.callback.$provider";
import { requireSessionUser } from "~/lib/auth/session.server";
import { getManifest, link } from "~/lib/connected-services";
import {
decodeOAuthState,
readPkceVerifier,
clearPkceCookieHeader,
} from "~/lib/connected-services/oauth-state.server";
import { pushRouteToProvider } from "~/lib/connected-services/push-action.server";
export async function loader({ params, request }: Route.LoaderArgs) {
const user = await requireSessionUser(request);
const manifest = getManifest(params.provider);
if (!manifest || !manifest.exchangeCode) {
return data({ error: "Unknown provider" }, { status: 404 });
}
const url = new URL(request.url);
const state = decodeOAuthState(url.searchParams.get("state"));
const fallbackReturn = state.returnTo ?? "/settings";
// User denied the new scope at Wahoo. Send them back to the originating
// page with a notice instead of looping them through OAuth again.
if (url.searchParams.get("error") === "access_denied") {
return redirect(`${fallbackReturn}?push=needs_permission`);
}
const code = url.searchParams.get("code");
if (!code) return data({ error: "Missing authorization code" }, { status: 400 });
const origin = getOrigin();
const redirectUri = `${origin}/api/sync/callback/${params.provider}`;
// PKCE providers: recover the verifier from the connect-time cookie.
const codeVerifier = manifest.pkce ? readPkceVerifier(request) : null;
if (manifest.pkce && !codeVerifier) {
return redirect(`${fallbackReturn}?error=sync_failed`);
}
try {
const exchange = await manifest.exchangeCode(
code,
redirectUri,
codeVerifier ? { codeVerifier } : undefined,
);
await link({
userId: user.id,
provider: manifest.id,
credentialKind: manifest.credentialKind,
credentials: exchange.credentials as Record<string, unknown>,
providerUserId: exchange.providerUserId,
grantedScopes: exchange.grantedScopes,
});
} catch (e) {
console.error(`OAuth callback failed for ${params.provider}:`, e);
const errCode =
typeof (e as { code?: string }).code === "string"
? (e as { code: string }).code
: "sync_failed";
return redirect(`${fallbackReturn}?error=${errCode}`);
}
if (state.pushAfter?.routeId) {
const outcome = await pushRouteToProvider({
userId: user.id,
providerId: manifest.id,
routeId: state.pushAfter.routeId,
});
const target = state.returnTo ?? `/routes/${state.pushAfter.routeId}`;
if (outcome.status === "success") return redirect(`${target}?push=success`);
if (outcome.status === "scope_missing") return redirect(`${target}?push=needs_permission`);
if (outcome.status === "needs_relink") return redirect(`${target}?push=needs_permission`);
if (outcome.status === "error") return redirect(`${target}?push=error&code=${outcome.code}`);
return redirect(`${target}?push=${outcome.status}`);
}
return redirect(state.returnTo ?? "/settings", {
// Spent verifier — clear it regardless of which provider this was
// (harmless no-op for non-PKCE providers without the cookie).
headers: { "Set-Cookie": clearPkceCookieHeader() },
});
}