Merge pull request #273 from trails-cool/feat/planner-compute-gpx-endpoint

Route journal BRouter calls through the planner
This commit is contained in:
Ullrich Schäfer 2026-04-19 11:16:50 +02:00 committed by GitHub
commit 0ac4d9674d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 90 additions and 20 deletions

View file

@ -413,9 +413,16 @@ export function pickLocale(
return persona.locales[Math.floor(rand() * persona.locales.length)]!;
}
// --- BRouter --------------------------------------------------------------
// --- Route compute via the planner ---------------------------------------
const BROUTER_URL = process.env.BROUTER_URL ?? "http://localhost:17777";
/**
* The journal goes through the planner (not BRouter directly) because
* the planner is the BRouter client in this architecture route
* compute, rate limiting, and the eventual move of BRouter off-box
* all live there. Same `PLANNER_URL` the interactive handoff routes
* use; falls back to the dev port in local work.
*/
const PLANNER_URL = process.env.PLANNER_URL ?? "http://localhost:3001";
export interface BrouterResult {
gpx: string;
@ -430,12 +437,26 @@ export async function requestBrouterGpx(
endpoints: Endpoints,
{ signal }: { signal?: AbortSignal } = {},
): Promise<BrouterResult | BrouterError> {
const lonlats = `${endpoints.start[0]},${endpoints.start[1]}|${endpoints.end[0]},${endpoints.end[1]}`;
const url = `${BROUTER_URL}/brouter?lonlats=${lonlats}&profile=trekking&alternativeidx=0&format=gpx`;
const url = `${PLANNER_URL}/api/route`;
const body = {
waypoints: [
{ lon: endpoints.start[0], lat: endpoints.start[1] },
{ lon: endpoints.end[0], lat: endpoints.end[1] },
],
profile: "trekking",
format: "gpx" as const,
};
try {
const resp = await fetch(url, { signal });
const resp = await fetch(url, {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify(body),
signal,
});
if (!resp.ok) {
if (resp.status === 500) return { kind: "no-route" };
// Planner returns 422 for BRouter client errors (unroutable
// waypoints) and 5xx for upstream/planner failures.
if (resp.status === 422) return { kind: "no-route" };
return { kind: "upstream-error", status: resp.status };
}
const gpx = await resp.text();

View file

@ -2,9 +2,9 @@ import type { Route } from "./+types/api.v1.routes.compute";
import { requireApiUser, apiError } from "~/lib/api-guard.server";
import { ComputeRouteRequestSchema, ERROR_CODES } from "@trails-cool/api";
const BROUTER_URL = process.env.BROUTER_URL ?? "http://localhost:17777";
const PLANNER_URL = process.env.PLANNER_URL ?? "http://localhost:3001";
/** POST /api/v1/routes/compute — proxy to BRouter */
/** POST /api/v1/routes/compute — server-to-server proxy through the planner. */
export async function action({ request }: Route.ActionArgs) {
if (request.method !== "POST") return new Response(null, { status: 405 });
await requireApiUser(request);
@ -16,19 +16,18 @@ export async function action({ request }: Route.ActionArgs) {
parsed.error.issues.map((i) => ({ field: i.path.join("."), message: i.message })));
}
const { waypoints, profile } = parsed.data;
const lonlats = waypoints.map((w) => `${w.lon},${w.lat}`).join("|");
const brouterUrl = `${BROUTER_URL}/brouter?lonlats=${lonlats}&profile=${profile}&alternativeidx=0&format=geojson`;
try {
const resp = await fetch(brouterUrl);
const resp = await fetch(`${PLANNER_URL}/api/route`, {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify(parsed.data),
});
if (!resp.ok) {
return apiError(502, ERROR_CODES.INTERNAL_ERROR, `BRouter returned ${resp.status}`);
return apiError(resp.status === 422 ? 422 : 502, ERROR_CODES.INTERNAL_ERROR, `Planner returned ${resp.status}`);
}
const geojson = await resp.json();
return Response.json(geojson);
const payload = await resp.json();
return Response.json(payload);
} catch {
return apiError(502, ERROR_CODES.INTERNAL_ERROR, "BRouter unavailable");
return apiError(502, ERROR_CODES.INTERNAL_ERROR, "Planner unavailable");
}
}

View file

@ -284,3 +284,38 @@ function noGoAreasToParam(areas: NoGoArea[]): string {
export function getBRouterUrl(): string {
return BROUTER_URL;
}
/**
* Single-segment GPX fetch. Used by callers (notably the Journal's
* demo-bot) that only need the raw GPX track for two endpoints no
* multi-waypoint merge, no way-tag enrichment. Throws BRouterError on
* non-2xx so the action handler can map it to an HTTP status.
*/
export async function computeSegmentGpx(request: {
waypoints: Array<{ lat: number; lon: number }>;
profile?: string;
noGoAreas?: NoGoArea[];
}): Promise<string> {
if (request.waypoints.length < 2) {
throw new Error("At least 2 waypoints are required");
}
const profile = request.profile ?? "trekking";
const lonlats = request.waypoints.map((w) => `${w.lon},${w.lat}`).join("|");
const params = new URLSearchParams({
lonlats,
profile,
alternativeidx: "0",
format: "gpx",
});
const nogoParam = request.noGoAreas?.length ? noGoAreasToParam(request.noGoAreas) : undefined;
if (nogoParam) params.set("polygons", nogoParam);
const resp = await fetch(`${BROUTER_URL}/brouter?${params}`);
if (!resp.ok) {
const body = await resp.text();
throw new BRouterError(body.trim(), resp.status);
}
const gpx = await resp.text();
if (!gpx.includes("<trkpt")) throw new BRouterError("no route found", 422);
return gpx;
}

View file

@ -1,6 +1,6 @@
import { data } from "react-router";
import type { Route } from "./+types/api.route";
import { computeRoute, BRouterError } from "~/lib/brouter";
import { computeRoute, computeSegmentGpx, BRouterError } from "~/lib/brouter";
import { checkRateLimit } from "~/lib/rate-limit";
export async function action({ request }: Route.ActionArgs) {
@ -9,11 +9,12 @@ export async function action({ request }: Route.ActionArgs) {
}
const body = await request.json();
const { waypoints, profile, sessionId, noGoAreas } = body as {
const { waypoints, profile, sessionId, noGoAreas, format } = body as {
waypoints: Array<{ lat: number; lon: number }>;
profile?: string;
sessionId?: string;
noGoAreas?: Array<{ points: Array<{ lat: number; lon: number }> }>;
format?: "geojson" | "gpx";
};
if (!waypoints || waypoints.length < 2) {
@ -35,6 +36,20 @@ export async function action({ request }: Route.ActionArgs) {
}
try {
// `format: "gpx"` returns BRouter's raw GPX without the way-tag
// enrichment the interactive planner needs. Used by server-to-server
// callers (e.g. the Journal's demo-bot) that just want the track.
if (format === "gpx") {
const gpx = await computeSegmentGpx({ waypoints, profile, noGoAreas });
return new Response(gpx, {
status: 200,
headers: {
"content-type": "application/gpx+xml; charset=utf-8",
"x-ratelimit-remaining": String(limit.remaining),
},
});
}
const route = await computeRoute({ waypoints, profile, noGoAreas });
return data(route, {
headers: { "X-RateLimit-Remaining": String(limit.remaining) },