fix(routes): report an upstream routing outage as unavailable

When the OSRM routing service failed (a 5xx, a 403 block, a 404), answered
with a body that was not JSON, or did not answer at all (timeout, network
error), /api/route returned HTTP 200 with 'no route found' or 'route proxy
error'. plan_route turned that into invalid_arguments ("No walk route from
...: no route found"), blaming the caller for an outage, and the directions
layer reported "No route found between A and B".

The proxy now answers all of these with 502 {ok:false, error:'routing
service unavailable'}: a rejected upstream fetch, any failure status but
400, a non-JSON content type, and a body read that fails or does not parse.
An exception in the proxy's own code after that point is still a 200 'route
proxy error'. createRouteService throws for a 5xx before reading the body's
ok:false, so plan_route reports unavailable, and the directions source
treats any 5xx as "Routing unavailable (HTTP n)", also when the failure
page in front of the proxy is not JSON. OSRM's own refusal (a 400 such as
NoRoute, or a 200 without a route) still reads "no route found".

The 12 s upstream timeout now starts when the request leaves rather than
before it waits for an outbound slot, so a wait in the proxy's own queue
(up to about 8 s at the 1 s spacing) is not reported as an outage.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
quanticsoul4772andClaude Opus 5.5 committed 2026-11-02 08:42:57 -08:00
1 parent ebd8439868
commit f8795ff426
7 files changed
+223 -34

No files matched your search

+10 -2
View File
@@ -21,7 +21,13 @@ export function createDirectionsSource({
signal,
headers: { Accept: 'application/json' },
});
const payload = await response.json();
// A failure page in front of the proxy need not be JSON.
let payload = null;
try {
payload = await response.json();
} catch (error) {
if (response.ok) throw error;
}
signal?.throwIfAborted();
// Failures keep their English message and carry the HTTP status and the
// server's refusal text, so the layer can show them in the language.
@@ -39,7 +45,9 @@ export function createDirectionsSource({
{ status: 429, refusal },
);
}
if (!response.ok && !payload?.error)
// A 5xx is a routing outage whatever its body says; only the proxy's
// refusals carry an error text worth showing.
if (response.status >= 500 || (!response.ok && !payload?.error))
throw Object.assign(
new Error(`Routing unavailable (HTTP ${response.status})`),
{ status: response.status },
+12
View File
@@ -41,3 +41,15 @@ test('route failures are surfaced without fallback requests', async () => {
assert.equal(calls, 1);
}
});
test('a routing outage stays an outage when its body carries an error', async () => {
const source = createDirectionsSource({ fetchImpl: async () =>
Response.json({ ok: false, error: 'routing service unavailable' }, { status: 502 }) });
await assert.rejects(source.getRoute(query), { status: 502, message: 'Routing unavailable (HTTP 502)' });
});
test('a routing outage page that is not JSON still reads as an outage', async () => {
const source = createDirectionsSource({ fetchImpl: async () =>
new Response('<html>Bad Gateway</html>', { status: 502, headers: { 'content-type': 'text/html' } }) });
await assert.rejects(source.getRoute(query), { status: 502, message: 'Routing unavailable (HTTP 502)' });
});
+96 -12
View File
@@ -236,23 +236,107 @@ test('OSRM routing preserves aliases, cache, span guards and upstream failure be
assert.equal((await request(route, url)).body.error, error);
assert.equal(calls, 1);
now += 600001;
t.mock.method(
globalThis,
'fetch',
async () => new Response('offline', { status: 503 }),
// OSRM's own "no route" is a 400 with a JSON code, and stays one.
t.mock.method(globalThis, 'fetch', async () =>
Response.json(
{ code: 'NoRoute', message: 'Impossible route between points' },
{ status: 400 },
),
);
assert.deepEqual((await request(route, query)).body, {
ok: false,
error: 'no route found',
});
t.mock.method(
globalThis,
'fetch',
async () => new Response('x', { headers: { 'content-type': 'text/html' } }),
const noRoute = await request(route, query);
assert.equal(noRoute.statusCode, 200);
assert.deepEqual(noRoute.body, { ok: false, error: 'no route found' });
t.mock.method(globalThis, 'fetch', async () =>
Response.json({ code: 'NoRoute', routes: [] }),
);
assert.equal((await request(route, query)).body.error, 'no route found');
});
test('a routing outage is reported as one, not as "no route found"', async (t) => {
const route = '/api/route';
const query = '?profile=car&coords=-97,30;-97.01,30.01';
for (const response of [
() => new Response('offline', { status: 503 }),
() => new Response('blocked', { status: 403 }),
() => new Response('x', { headers: { 'content-type': 'text/html' } }),
() =>
new Response('<html>', {
headers: { 'content-type': 'application/json' },
}),
() => Promise.reject(new TypeError('fetch failed')),
() => Promise.reject(new DOMException('aborted', 'AbortError')),
]) {
_resetRouteUpstreamForTest();
const request = install(installRouteMiddleware);
t.mock.method(globalThis, 'fetch', async () => response());
const result = await request(route, query);
assert.equal(result.statusCode, 502);
assert.deepEqual(result.body, {
ok: false,
error: 'routing service unavailable',
});
}
});
test('callers sharing one failed upstream call all hear the outage, and it is not cached', async (t) => {
_resetRouteUpstreamForTest();
_setRouteUpstreamIntervalForTest(0);
t.after(() => _resetRouteUpstreamForTest());
const request = install(installRouteMiddleware);
let calls = 0;
let release;
const gate = new Promise((resolve) => {
release = resolve;
});
t.mock.method(globalThis, 'fetch', async () => {
calls += 1;
await gate;
return new Response('offline', { status: 503 });
});
const route = '/api/route';
const query = '?profile=car&coords=-97,30;-97.01,30.01';
const all = [
request(route, `${query}&steps=1`),
request(route, `${query}&steps=1`),
request(route, query),
];
await Promise.resolve();
release();
for (const result of await Promise.all(all)) {
assert.equal(result.statusCode, 502);
assert.equal(result.body.error, 'routing service unavailable');
}
assert.equal(calls, 1);
assert.equal((await request(route, query)).statusCode, 502);
assert.equal(calls, 2, 'the next request asks the routing service again');
});
test('a wait for an outbound slot does not count toward the upstream timeout', async (t) => {
_resetRouteUpstreamForTest();
// The second request waits 13 s for its slot, longer than the 12 s budget.
_setRouteUpstreamIntervalForTest(13_000);
t.after(() => _resetRouteUpstreamForTest());
t.mock.timers.enable({ apis: ['setTimeout', 'Date'], now: Date.now() });
const request = install(installRouteMiddleware);
t.mock.method(globalThis, 'fetch', async (_url, { signal }) => {
signal.throwIfAborted();
return Response.json(osrmRouteWithSteps(2));
});
const first = request(
'/api/route',
'?profile=car&coords=-97,30;-97.01,30.01',
);
const second = request(
'/api/route',
'?profile=foot&coords=-97,30;-97.01,30.01',
);
assert.equal((await first).body.ok, true);
t.mock.timers.tick(13_000);
const result = await second;
assert.equal(result.statusCode, 200);
assert.equal(result.body.ok, true);
});
/** One OSRM route with `count` maneuvers, for the step tests. */
function osrmRouteWithSteps(count) {
return {
+4 -1
View File
@@ -189,7 +189,10 @@ export function createRouteService({
} catch {
/* the status below is authoritative */
}
if (response.status === 429) throw httpFailure(response, 'Routing');
// A rate limit or an outage (5xx) is the routing service's failure, not
// a missing route, whatever the body says.
if (response.status === 429 || response.status >= 500)
throw httpFailure(response, 'Routing');
if (payload?.ok === false || response.status === 400)
return { ok: false, error: payload?.error || 'no route found' };
if (!response.ok) throw httpFailure(response, 'Routing');
+36
View File
@@ -1,6 +1,7 @@
import assert from 'node:assert/strict';
import test from 'node:test';
import { composeCatalog, coreTools } from '../index.js';
import { createMcpServer } from '../mcp/index.js';
import { createPlaceSearchService, createRouteService } from '../places.js';
const place = (id, latitude, longitude, extra = {}) => ({
@@ -249,6 +250,41 @@ test('the place and route services read the app routes and translate failures',
);
});
test('a routing outage is reported as unavailable, not as invalid arguments', async () => {
for (const fetchImpl of [
async () =>
Response.json(
{ ok: false, error: 'routing service unavailable' },
{ status: 502 },
),
async () => {
throw new TypeError('fetch failed');
},
]) {
const catalog = composeCatalog({
tools: coreTools,
services: { routing: createRouteService({ fetchImpl }), places },
});
const server = createMcpServer({
catalog,
name: 'test',
version: '1.0.0',
});
const { result } = await server.handle({
jsonrpc: '2.0',
id: 1,
method: 'tools/call',
params: {
name: 'plan_route',
arguments: { from: { place: 'Austin' }, to: { place: 'Dallas' } },
},
});
assert.equal(result.isError, true);
assert.equal(result.structuredContent.error, 'unavailable');
assert.doesNotMatch(result.content[0].text, /No walk route/);
}
});
test('place answers say when the search limits may have left places out', async () => {
const five = Array.from({ length: 5 }, (_, index) =>
place(`p${index}`, 30.27, -97.74),