mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-22 06:56:35 +00:00
fix(ski-routing): keep one job's timeout to itself and bound the area refresh
The router thread now takes one job at a time from a queue kept on the main thread, so a job's clock starts when the thread takes it up. A job that times out ends only its own thread, and only while that thread is still the current one; the jobs in line go to a fresh thread instead of waiting out their own timers and killing the new thread in turn. A thread that dies fails the job it held, and a thread that cannot start fails each job on its own. - the daily refresh fetches changed areas two at a time and stops once the TREK Places breaker opens; the rest keep their older copies - the winter index cap is on the unpacked JSON fetch hands over, so it follows from the host's 8 MB gzip cap (64 MB) instead of matching it - a build name is read to the rule a ski tour stores it by, so a build TREK could not save is refused when the winter layer is read - an unused import in the piste router contract is gone
This commit is contained in:
@@ -1,5 +1,6 @@
|
||||
import { readEnv } from '../../app-config';
|
||||
import {
|
||||
trekPlacesHeldBack,
|
||||
trekPlacesWinterArea,
|
||||
trekPlacesWinterIndex,
|
||||
trekPlacesWinterMeta,
|
||||
@@ -24,6 +25,11 @@ export class TrekPlacesWinterService {
|
||||
return readEnv().maps.trekPlacesEnabled;
|
||||
}
|
||||
|
||||
/** Whether the circuit breaker holds requests back after the host failed several times. */
|
||||
heldBack(): boolean {
|
||||
return trekPlacesHeldBack();
|
||||
}
|
||||
|
||||
meta(): Promise<WinterMeta> {
|
||||
return trekPlacesWinterMeta();
|
||||
}
|
||||
|
||||
@@ -15,6 +15,7 @@ import { readEnv, getAppUrl } from '../../app-config';
|
||||
import { toApiLang } from './maps.helpers';
|
||||
import {
|
||||
normalizePlaceWebsite,
|
||||
skiRouteBuildSchema,
|
||||
winterIndexRowSchema,
|
||||
winterMetaSchema,
|
||||
type WinterIndex,
|
||||
@@ -887,7 +888,13 @@ export async function trekPlacesRoutes(
|
||||
export type TrekPlacesWinterBody = { status: 'not_modified' } | { status: 'ok'; bytes: Buffer; etag: string | null };
|
||||
|
||||
const WINTER_META = { timeoutMs: 5_000, maxBytes: 64 * 1024 };
|
||||
const WINTER_INDEX = { timeoutMs: 15_000, maxBytes: 8 * 1024 * 1024 };
|
||||
/**
|
||||
* The host caps the index it stores at 8 MB of gzip and sends it packed;
|
||||
* fetch unpacks it before it is read, so the cap here is on the unpacked
|
||||
* JSON, which is several times larger. 64 MB holds whatever the host's cap
|
||||
* lets through and still bounds a body that is not the index at all.
|
||||
*/
|
||||
const WINTER_INDEX = { timeoutMs: 15_000, maxBytes: 64 * 1024 * 1024 };
|
||||
const WINTER_AREA = { timeoutMs: 30_000, maxBytes: 32 * 1024 * 1024 };
|
||||
const WINTER_AREA_ID = /^[a-z]:[0-9]+(-[0-9a-z]+)?$/;
|
||||
|
||||
@@ -901,7 +908,7 @@ function bareTag(value: string | null): string | null {
|
||||
|
||||
/** The head of the index; its rows are read one by one. */
|
||||
const winterIndexHeadSchema = z.object({
|
||||
build: z.string().min(1).max(40),
|
||||
build: skiRouteBuildSchema,
|
||||
format: z.number().int(),
|
||||
areas: z.array(z.unknown()),
|
||||
});
|
||||
|
||||
@@ -10,6 +10,9 @@ import { Injectable, type OnApplicationBootstrap } from '@nestjs/common';
|
||||
* wait for it. Area files unused for 90 days go. Nothing runs while TREK
|
||||
* Places is switched off.
|
||||
*/
|
||||
/** How many changed areas are downloaded at once. */
|
||||
const REFRESH_CONCURRENCY = 2;
|
||||
|
||||
@Injectable()
|
||||
export class SkiAreasJob implements OnApplicationBootstrap {
|
||||
constructor(
|
||||
@@ -34,7 +37,12 @@ export class SkiAreasJob implements OnApplicationBootstrap {
|
||||
}
|
||||
}
|
||||
|
||||
/** The areas kept here whose graph the new build changed, fetched again. */
|
||||
/**
|
||||
* The areas kept here whose graph the new build changed, fetched again two
|
||||
* at a time so a build that changed many does not open dozens of downloads
|
||||
* against the host at once. Once the host's breaker opens the rest wait:
|
||||
* their kept copies still plan, and a planner that needs one fetches it.
|
||||
*/
|
||||
private async refreshKept(): Promise<void> {
|
||||
const index = await this.areas.index();
|
||||
if (!index) return;
|
||||
@@ -42,9 +50,25 @@ export class SkiAreasJob implements OnApplicationBootstrap {
|
||||
const changed = index.areas.filter((area) =>
|
||||
kept.some((copy) => copy.id === area.row.id && copy.sha8 !== area.row.sha256.slice(0, 8)),
|
||||
);
|
||||
const outcomes = await Promise.allSettled(changed.map((area) => this.areas.ensureArea(area.row)));
|
||||
const failed = outcomes.filter((outcome) => outcome.status === 'rejected').length;
|
||||
if (changed.length === 0) return;
|
||||
logInfo(`[Ski] ${changed.length - failed} of ${changed.length} kept ski areas fetched anew`);
|
||||
const pending = [...changed];
|
||||
let fetched = 0;
|
||||
const fetchOne = async (): Promise<void> => {
|
||||
while (!this.areas.placesHeldBack()) {
|
||||
const area = pending.shift();
|
||||
if (!area) return;
|
||||
try {
|
||||
if (!(await this.areas.ensureArea(area.row)).stale) fetched += 1;
|
||||
} catch {
|
||||
// The kept copy stays; the next planner to need the area asks again.
|
||||
}
|
||||
}
|
||||
};
|
||||
await Promise.all(Array.from({ length: REFRESH_CONCURRENCY }, fetchOne));
|
||||
const left = pending.length;
|
||||
logInfo(
|
||||
`[Ski] ${fetched} of ${changed.length} kept ski areas fetched anew` +
|
||||
(left > 0 ? `, ${left} left for later while TREK Places is unreachable` : ''),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -283,6 +283,11 @@ export class SkiAreasService implements OnApplicationBootstrap {
|
||||
await rename(temp, file);
|
||||
}
|
||||
|
||||
/** Whether the Places host failed often enough that requests to it are held back for now. */
|
||||
placesHeldBack(): boolean {
|
||||
return this.winter.heldBack();
|
||||
}
|
||||
|
||||
/** Whether an area's graph is here, on its way, or cannot be had right now. */
|
||||
stateOf(row: WinterIndexRow): 'ready' | 'loading' | 'unavailable' {
|
||||
if (existsSync(this.fileOf(row))) return 'ready';
|
||||
|
||||
@@ -12,8 +12,16 @@ export const MAX_WAITING_JOBS = 8;
|
||||
/** A thread with nothing to do ends after half an hour; the next job starts one again. */
|
||||
const IDLE_MS = 30 * 60 * 1000;
|
||||
|
||||
interface Waiting {
|
||||
/** A job in line for the thread, not yet handed to it. */
|
||||
interface Queued {
|
||||
id: number;
|
||||
job: SkiJob;
|
||||
settle: (outcome: { result: unknown } | { error: Error }) => void;
|
||||
}
|
||||
|
||||
/** The job the thread is working on, the thread it went to, and its clock. */
|
||||
interface Running extends Queued {
|
||||
worker: Worker;
|
||||
timer: NodeJS.Timeout;
|
||||
}
|
||||
|
||||
@@ -26,33 +34,31 @@ export function answerTimeoutMs(job: SkiJob): number {
|
||||
|
||||
/**
|
||||
* The piste router's own thread, so a search never holds up the server's
|
||||
* requests. Started on the first job and ended when idle; a job not answered
|
||||
* in time fails as `timeout` and the thread is replaced, a thread that dies
|
||||
* fails what it held, and the next job finds a fresh one.
|
||||
* requests. Started on the first job and ended when idle. The thread is
|
||||
* handed one job at a time, so a job's clock starts when the thread takes it
|
||||
* up, not while it waits behind a slow one. A job not answered in time fails
|
||||
* as `timeout` and its thread is replaced; a thread that dies fails the job
|
||||
* it held. Either way the jobs still in line go to a fresh thread.
|
||||
*/
|
||||
export class WorkerSkiRouterRunner implements SkiRouterRunner {
|
||||
private thread: Worker | null = null;
|
||||
private lastId = 0;
|
||||
private readonly waiting = new Map<number, Waiting>();
|
||||
private readonly queue: Queued[] = [];
|
||||
private running: Running | null = null;
|
||||
private idleTimer: NodeJS.Timeout | null = null;
|
||||
|
||||
constructor(private readonly entry = join(__dirname, 'ski-router.worker.js')) {}
|
||||
|
||||
run<J extends SkiJob>(job: J): Promise<SkiJobResult<J>> {
|
||||
if (this.waiting.size >= MAX_WAITING_JOBS) return Promise.reject(new Error('busy'));
|
||||
const worker = this.ensureThread();
|
||||
if (this.queue.length + (this.running ? 1 : 0) >= MAX_WAITING_JOBS) return Promise.reject(new Error('busy'));
|
||||
const id = ++this.lastId;
|
||||
return new Promise<SkiJobResult<J>>((resolve, reject) => {
|
||||
const timer = setTimeout(() => {
|
||||
this.waiting.delete(id);
|
||||
reject(new Error('timeout'));
|
||||
this.replaceThread();
|
||||
}, answerTimeoutMs(job));
|
||||
this.waiting.set(id, {
|
||||
timer,
|
||||
this.queue.push({
|
||||
id,
|
||||
job,
|
||||
settle: (outcome) => ('error' in outcome ? reject(outcome.error) : resolve(outcome.result as SkiJobResult<J>)),
|
||||
});
|
||||
worker.postMessage({ id, job });
|
||||
this.next();
|
||||
});
|
||||
}
|
||||
|
||||
@@ -62,12 +68,31 @@ export class WorkerSkiRouterRunner implements SkiRouterRunner {
|
||||
|
||||
async close(): Promise<void> {
|
||||
if (this.idleTimer) clearTimeout(this.idleTimer);
|
||||
this.failWaiting(new Error('closed'));
|
||||
this.idleTimer = null;
|
||||
this.failAll(new Error('closed'));
|
||||
const worker = this.thread;
|
||||
this.thread = null;
|
||||
await worker?.terminate();
|
||||
}
|
||||
|
||||
/** Hands the next job in line to the thread, once the one before it is done. */
|
||||
private next(): void {
|
||||
if (this.running) return;
|
||||
const queued = this.queue.shift();
|
||||
if (!queued) return;
|
||||
let worker: Worker;
|
||||
try {
|
||||
worker = this.ensureThread();
|
||||
} catch (err: unknown) {
|
||||
queued.settle({ error: err instanceof Error ? err : new Error(String(err)) });
|
||||
this.next();
|
||||
return;
|
||||
}
|
||||
const timer = setTimeout(() => this.timedOut(queued.id), answerTimeoutMs(queued.job));
|
||||
this.running = { ...queued, worker, timer };
|
||||
worker.postMessage({ id: queued.id, job: queued.job });
|
||||
}
|
||||
|
||||
private ensureThread(): Worker {
|
||||
if (this.idleTimer) clearTimeout(this.idleTimer);
|
||||
this.idleTimer = setTimeout(() => void this.close(), IDLE_MS);
|
||||
@@ -79,7 +104,7 @@ export class WorkerSkiRouterRunner implements SkiRouterRunner {
|
||||
arg === '--require' || arg === '-r' || all[index - 1] === '--require' || all[index - 1] === '-r',
|
||||
);
|
||||
const worker = new Worker(this.entry, { execArgv });
|
||||
worker.on('message', (reply: Reply) => this.receive(reply));
|
||||
worker.on('message', (reply: Reply) => this.receive(worker, reply));
|
||||
worker.on('error', (err: Error) => this.lost(worker, err));
|
||||
worker.on('exit', () => this.lost(worker, new Error('router thread ended')));
|
||||
worker.unref();
|
||||
@@ -87,33 +112,49 @@ export class WorkerSkiRouterRunner implements SkiRouterRunner {
|
||||
return worker;
|
||||
}
|
||||
|
||||
private receive(reply: Reply): void {
|
||||
const waiting = this.waiting.get(reply.id);
|
||||
if (!waiting) return;
|
||||
this.waiting.delete(reply.id);
|
||||
clearTimeout(waiting.timer);
|
||||
if (reply.result !== undefined) waiting.settle({ result: reply.result });
|
||||
else waiting.settle({ error: new Error(reply.error ?? 'router failed') });
|
||||
private receive(worker: Worker, reply: Reply): void {
|
||||
const running = this.running;
|
||||
if (running?.worker !== worker || running.id !== reply.id) return;
|
||||
this.finish(
|
||||
running,
|
||||
reply.result !== undefined ? { result: reply.result } : { error: new Error(reply.error ?? 'router failed') },
|
||||
);
|
||||
}
|
||||
|
||||
/** A thread that ended or failed takes its jobs with it; one already replaced leaves the new thread's alone. */
|
||||
/** Only the job still running on the thread it went to times out; its thread goes with it. */
|
||||
private timedOut(id: number): void {
|
||||
const running = this.running;
|
||||
if (running?.id !== id) return;
|
||||
this.dropThread(running.worker);
|
||||
this.finish(running, { error: new Error('timeout') });
|
||||
}
|
||||
|
||||
/** A thread that ended or failed takes its job with it; a thread already replaced touches no other job. */
|
||||
private lost(worker: Worker, err: Error): void {
|
||||
if (this.thread !== worker) return;
|
||||
this.thread = null;
|
||||
this.failWaiting(err);
|
||||
if (this.thread === worker) this.thread = null;
|
||||
const running = this.running;
|
||||
if (running?.worker === worker) this.finish(running, { error: err });
|
||||
}
|
||||
|
||||
private replaceThread(): void {
|
||||
const worker = this.thread;
|
||||
this.thread = null;
|
||||
void worker?.terminate();
|
||||
private finish(running: Running, outcome: { result: unknown } | { error: Error }): void {
|
||||
clearTimeout(running.timer);
|
||||
this.running = null;
|
||||
running.settle(outcome);
|
||||
this.next();
|
||||
}
|
||||
|
||||
private failWaiting(err: Error): void {
|
||||
for (const [id, waiting] of this.waiting) {
|
||||
clearTimeout(waiting.timer);
|
||||
this.waiting.delete(id);
|
||||
waiting.settle({ error: err });
|
||||
private dropThread(worker: Worker): void {
|
||||
if (this.thread === worker) this.thread = null;
|
||||
void worker.terminate();
|
||||
}
|
||||
|
||||
private failAll(err: Error): void {
|
||||
const running = this.running;
|
||||
this.running = null;
|
||||
if (running) {
|
||||
clearTimeout(running.timer);
|
||||
running.settle({ error: err });
|
||||
}
|
||||
for (const queued of this.queue.splice(0)) queued.settle({ error: err });
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user