From 31b6b25d8bb16f0b1b42c8f1bde8e190578cc3a3 Mon Sep 17 00:00:00 2001 From: German Khokhlov Date: Thu, 19 Nov 2026 18:29:24 +0400 Subject: [PATCH] fix(places): make no-store the default and refuse an unreadable Places 200 Every Google route now sets no-store right after the same-site gate and switches to private, max-age=300 only on a confirmed answer, so the proxy's own 400, 405, 429 and 502 replies are no longer left without a header. Both Places routes answer an unreadable 200 body with 502 instead of caching an empty result, as the geocode routes already did. The test pins the allowlist with OVER_DAILY_LIMIT and UNKNOWN_ERROR and covers the unreadable and empty Places bodies; the changelog fragment is shorter. --- changelog.d/1570-places-no-store-on-errors.md | 6 +- docs/CURRENT-STATE.md | 2 +- server/providers/places/google.js | 71 +++++++++++-------- src/tooling/placeProviders.test.mjs | 59 ++++++++++++++- 4 files changed, 103 insertions(+), 35 deletions(-) diff --git a/changelog.d/1570-places-no-store-on-errors.md b/changelog.d/1570-places-no-store-on-errors.md index 459258ad0b..4753638588 100644 --- a/changelog.d/1570-places-no-store-on-errors.md +++ b/changelog.d/1570-places-no-store-on-errors.md @@ -1,4 +1,2 @@ -- Stop the browser caching a refused Google Places or Geocoding answer. The - proxies sent `private, max-age=300` on a 403 and on a geocode - `REQUEST_DENIED` or `OVER_QUERY_LIMIT`, so a fixed key kept failing for five - minutes; refusals are now `no-store` (Rudy Celekli, @rudycelekli, #1570). +- Stop the browser caching a refused Google Places or Geocoding answer, so a + fixed key works at once (Rudy Celekli, @rudycelekli, #1570). diff --git a/docs/CURRENT-STATE.md b/docs/CURRENT-STATE.md index ece994cab5..42ff3ff9c2 100644 --- a/docs/CURRENT-STATE.md +++ b/docs/CURRENT-STATE.md @@ -5996,7 +5996,7 @@ apply to `public/` assets or built-preview serving. - `AISSTREAM_API_KEY` is server-side only; the browser reads the same-origin `/api/vessels` cache. - `/api/google/nearby-places` keeps the Google key out of Places requests issued for voice scene context. - `/api/google/text-search` keeps the Google key server-side for view-biased Places recovery used by annotation resolution. -- The two Places routes and both geocode routes let the browser keep an answer for five minutes (`private, max-age=300`), but a refusal is `no-store`: a Places error status, or a Geocoding status other than `OK` or `ZERO_RESULTS` (Google sends `REQUEST_DENIED` and `OVER_QUERY_LIMIT` as HTTP 200). A denied or exhausted key is not replayed from the browser cache after it is fixed. +- The two Places routes and both geocode routes let the browser keep an answer for five minutes (`private, max-age=300`), and everything else is `no-store`: a Places error status or unreadable body, a Geocoding status other than `OK` or `ZERO_RESULTS` (Google sends `REQUEST_DENIED` and `OVER_QUERY_LIMIT` as HTTP 200), and the proxy's own 400, 405, 429 and 502 replies. A denied or exhausted key is not replayed from the browser cache after it is fixed. - `/api/overpass` is bounded by body/response caps, per-client/global rate limits, concurrency limits, operator-configured upstreams, in-flight dedupe, cache bounds, and static validation that every selector is spatially bounded. - `/api/military-installations` uses an independent limiter with the same 90-per-client/300-global one-minute bounds, so viewport installation refreshes never consume `/api/overpass` annotation capacity. - `/api/route` proxies bounded OSRM route requests for annotation routes, with profile allowlisting, distance caps, response caps, caching, and sanitized "no route found" errors. diff --git a/server/providers/places/google.js b/server/providers/places/google.js index e20efa899d..c321dc0c4b 100644 --- a/server/providers/places/google.js +++ b/server/providers/places/google.js @@ -71,7 +71,6 @@ const GEOCODE_UPSTREAM_TIMEOUT_MS = 10_000; const GEOCODE_MAX_RESPONSE_BYTES = 256 * 1024; -/** Geocoding statuses that answer the query; the rest report a failure. */ const GEOCODE_ANSWER_STATUSES = new Set(['OK', 'ZERO_RESULTS']); /** Validate a free-text geocoder query before consuming request quota. */ @@ -117,6 +116,9 @@ export function googlePlacesContextProxy({ // Gate first, like the OpenAI routes: a cross-site caller learns nothing // about this endpoint's method surface. if (admitSameSite(req, res)) return; + // Nothing but a confirmed answer is kept: a refusal (bad key, API not + // enabled, quota) would be replayed for five minutes after the key is fixed. + res.setHeader('Cache-Control', 'no-store'); if (req.method !== 'GET') { res.statusCode = 405; res.setHeader('Content-Type', 'application/json'); @@ -132,7 +134,6 @@ export function googlePlacesContextProxy({ if (keyless) { res.statusCode = keyless.statusCode; res.setHeader('Content-Type', 'application/json'); - res.setHeader('Cache-Control', 'no-store'); res.end(JSON.stringify(keyless.payload)); return; } @@ -197,23 +198,30 @@ export function googlePlacesContextProxy({ }), }, ); - const data = await response.json().catch(() => ({})); - const places = projectNearbyPlaces(data, latitude, longitude); + const data = await response.json().catch(() => null); + // A 200 we could not read is an upstream failure, not an empty answer. + if (response.ok && !data) { + res.statusCode = 502; + res.setHeader('Content-Type', 'application/json; charset=utf-8'); + res.end( + JSON.stringify({ + error: 'Google Places request failed', + places: [], + }), + ); + return; + } + const places = projectNearbyPlaces(data || {}, latitude, longitude); res.statusCode = response.ok ? 200 : response.status; res.setHeader('Content-Type', 'application/json; charset=utf-8'); - // A refusal (bad key, API not enabled, quota) is not kept: the browser - // would replay it for five minutes after the key is fixed. - res.setHeader( - 'Cache-Control', - response.ok ? 'private, max-age=300' : 'no-store', - ); + if (response.ok) res.setHeader('Cache-Control', 'private, max-age=300'); res.end( JSON.stringify({ places, error: response.ok ? null - : data.error?.message || 'Google Places request failed', + : data?.error?.message || 'Google Places request failed', }), ); } catch (error) { @@ -231,10 +239,12 @@ export function googlePlacesContextProxy({ // Text Search: resolve a named landmark/POI to a real coordinate, biased to // the view. Geocoding scatters obscure monument/POI names across the city; // a view-biased Text Search lands on the actual feature. Same key, field - // mask, throttle, and `places: []` error contract as nearby-places above. + // mask, throttle, cache rule, and `places: []` error contract as + // nearby-places above. middlewares.use('/api/google/text-search', async (req, res) => { // Paid like nearby-places, so gated the same way, first. if (admitSameSite(req, res)) return; + res.setHeader('Cache-Control', 'no-store'); if (req.method !== 'GET') { res.statusCode = 405; res.setHeader('Content-Type', 'application/json'); @@ -250,7 +260,6 @@ export function googlePlacesContextProxy({ if (keyless) { res.statusCode = keyless.statusCode; res.setHeader('Content-Type', 'application/json'); - res.setHeader('Cache-Control', 'no-store'); res.end(JSON.stringify(keyless.payload)); return; } @@ -323,23 +332,30 @@ export function googlePlacesContextProxy({ }), }, ); - const data = await response.json().catch(() => ({})); - const places = projectTextSearchPlaces(data, latitude, longitude); + const data = await response.json().catch(() => null); + // A 200 we could not read is an upstream failure, not an empty answer. + if (response.ok && !data) { + res.statusCode = 502; + res.setHeader('Content-Type', 'application/json; charset=utf-8'); + res.end( + JSON.stringify({ + error: 'Google Places request failed', + places: [], + }), + ); + return; + } + const places = projectTextSearchPlaces(data || {}, latitude, longitude); res.statusCode = response.ok ? 200 : response.status; res.setHeader('Content-Type', 'application/json; charset=utf-8'); - // A refusal (bad key, API not enabled, quota) is not kept: the browser - // would replay it for five minutes after the key is fixed. - res.setHeader( - 'Cache-Control', - response.ok ? 'private, max-age=300' : 'no-store', - ); + if (response.ok) res.setHeader('Cache-Control', 'private, max-age=300'); res.end( JSON.stringify({ places, error: response.ok ? null - : data.error?.message || 'Google Places request failed', + : data?.error?.message || 'Google Places request failed', }), ); } catch (error) { @@ -379,6 +395,8 @@ export function googlePlacesContextProxy({ // Gate first, like the Places routes above: a cross-site caller learns // nothing about this endpoint's method surface. if (admitSameSite(req, res)) return; + // As in the Places routes, only the confirmed answer below is kept. + res.setHeader('Cache-Control', 'no-store'); if (req.method !== 'GET') { refuse(405, 'Method not allowed'); return; @@ -392,7 +410,6 @@ export function googlePlacesContextProxy({ if (keyless) { res.statusCode = keyless.statusCode; res.setHeader('Content-Type', 'application/json'); - res.setHeader('Cache-Control', 'no-store'); res.end(JSON.stringify(keyless.payload)); return; } @@ -461,12 +478,8 @@ export function googlePlacesContextProxy({ res.setHeader('Content-Type', 'application/json; charset=utf-8'); // Geocoding reports a denied key or spent quota as HTTP 200 with a // status of its own; only an answer is worth keeping. - res.setHeader( - 'Cache-Control', - response.ok && GEOCODE_ANSWER_STATUSES.has(data.status) - ? 'private, max-age=300' - : 'no-store', - ); + if (response.ok && GEOCODE_ANSWER_STATUSES.has(data.status)) + res.setHeader('Cache-Control', 'private, max-age=300'); res.end(JSON.stringify(data)); } catch { // Fixed public text: a transport, URL or runtime message would diff --git a/src/tooling/placeProviders.test.mjs b/src/tooling/placeProviders.test.mjs index a6a3457536..2a9cf16daa 100644 --- a/src/tooling/placeProviders.test.mjs +++ b/src/tooling/placeProviders.test.mjs @@ -209,7 +209,12 @@ test('a refused Places or Geocoding answer is not kept by the browser', async (t t.mock.method(globalThis, 'fetch', async () => Response.json({ status, results: [] }), ); - for (const denied of ['REQUEST_DENIED', 'OVER_QUERY_LIMIT']) { + for (const denied of [ + 'REQUEST_DENIED', + 'OVER_QUERY_LIMIT', + 'OVER_DAILY_LIMIT', + 'UNKNOWN_ERROR', + ]) { status = denied; const answer = await request('/api/google/geocode', '?address=Austin'); assert.equal(answer.statusCode, 200); @@ -223,6 +228,58 @@ test('a refused Places or Geocoding answer is not kept by the browser', async (t } }); +const ROUTES = [ + ['/api/google/nearby-places', '?lat=30&lon=-97'], + ['/api/google/text-search', '?q=museum&lat=30&lon=-97'], +]; + +const truncated = () => + new Response( + new ReadableStream({ + start(c) { + c.enqueue(new TextEncoder().encode('{"places":[{"displayName"')); + c.error(new TypeError('terminated')); + }, + }), + { status: 200 }, + ); + +for (const [name, body] of [ + ['non-JSON', () => new Response('not json', { status: 200 })], + ['cut mid-body', truncated], +]) { + test(`an unreadable Places 200 (${name}) is a failure, not a cached empty answer`, async () => { + const request = install((middlewares) => + googlePlacesContextProxy({ + resolveApiKey: () => 'fixture-server-key', + fetchImpl: async () => body(), + }).configureServer({ middlewares }), + ); + for (const [route, query] of ROUTES) { + const res = await request(route, query); + assert.equal(res.statusCode, 502, route); + assert.equal(res.headers['cache-control'], 'no-store', route); + assert.deepEqual(res.body.places, [], route); + assert.ok(res.body.error, route); + } + }); +} + +test('a real empty Places answer ({}) stays cacheable', async () => { + const request = install((middlewares) => + googlePlacesContextProxy({ + resolveApiKey: () => 'fixture-server-key', + fetchImpl: async () => Response.json({}), + }).configureServer({ middlewares }), + ); + for (const [route, query] of ROUTES) { + const res = await request(route, query); + assert.equal(res.statusCode, 200, route); + assert.equal(res.headers['cache-control'], 'private, max-age=300', route); + assert.equal(res.body.error, null, route); + } +}); + test('OSRM routing preserves aliases, cache, span guards and upstream failure behavior', async (t) => { const request = install(installRouteMiddleware); let calls = 0;