mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-19 13:36:48 +00:00
Maurice
d30b916f9c
Every route is calculated in the browser against the public FOSSGIS hosts, so the server never sees a routing request and nobody has a number: not how many a real trip costs, not how big they are, not how much already goes to a self-hosted engine. Deciding whether TREK could run its own router without that number is guessing at the bill, and the counters have to be collecting before the question comes up. Counters, not a log. A row is a day, a profile, a request kind and an engine kind with totals on it: how many requests, how many waypoints, roughly how far, how many were refused. No query, no coordinate, no route, no user, no trip. Nothing leaves the instance: its own database holds them and its own admin reads them at GET /api/route-usage/summary. The client tallies in memory and flushes in batches — on a timer, past a threshold and when the page is hidden — because a counter that cost a request of its own would measure the load by adding to it. Routing all funnels through one fetch in RouteCalculator, so that is the only place instrumented. On by default and switchable off with route_usage_enabled, unlike the shadow log next door: that one stores what people typed, this one stores four integers about a day.
89 lines
3.0 KiB
TypeScript
89 lines
3.0 KiB
TypeScript
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
|
|
import { countRoute, flushRouteUsage } from './routeUsageCounter'
|
|
import { routeUsageApi } from '../../api/routeUsage'
|
|
|
|
/**
|
|
* FE-MAP-ROUTECOUNT-001..006 — the tally behind "how much routing does an instance do".
|
|
*
|
|
* Two things are worth pinning: that it batches rather than posting per route, because a
|
|
* counter that costs a request of its own measures the load by adding to it, and that it
|
|
* never throws — it sits on the hot path of every route the map draws.
|
|
*/
|
|
|
|
const sample = {
|
|
profile: 'driving' as const,
|
|
surface: 'legs' as const,
|
|
selfHosted: false,
|
|
waypoints: 3,
|
|
km: 100,
|
|
failed: false,
|
|
}
|
|
|
|
describe('routeUsageCounter', () => {
|
|
beforeEach(() => {
|
|
vi.spyOn(routeUsageApi, 'report').mockResolvedValue(undefined)
|
|
vi.useFakeTimers()
|
|
})
|
|
|
|
afterEach(() => {
|
|
flushRouteUsage()
|
|
vi.useRealTimers()
|
|
vi.restoreAllMocks()
|
|
})
|
|
|
|
it('FE-MAP-ROUTECOUNT-001: a single route posts nothing on its own', () => {
|
|
countRoute(sample)
|
|
expect(routeUsageApi.report).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('FE-MAP-ROUTECOUNT-002: the tally goes out once the timer runs out', () => {
|
|
countRoute(sample)
|
|
vi.advanceTimersByTime(60_000)
|
|
|
|
expect(routeUsageApi.report).toHaveBeenCalledTimes(1)
|
|
const [entries] = vi.mocked(routeUsageApi.report).mock.calls[0]
|
|
expect(entries).toEqual([{ ...sample, requests: 1, failed: 0 }])
|
|
})
|
|
|
|
it('FE-MAP-ROUTECOUNT-003: routes of one kind add onto one entry', () => {
|
|
countRoute(sample)
|
|
countRoute({ ...sample, waypoints: 5, km: 200 })
|
|
countRoute({ ...sample, failed: true })
|
|
flushRouteUsage()
|
|
|
|
const [entries] = vi.mocked(routeUsageApi.report).mock.calls[0]
|
|
expect(entries).toHaveLength(1)
|
|
expect(entries[0]).toMatchObject({ requests: 3, waypoints: 11, km: 400, failed: 1 })
|
|
})
|
|
|
|
it('FE-MAP-ROUTECOUNT-004: a different kind or engine is its own entry', () => {
|
|
countRoute(sample)
|
|
countRoute({ ...sample, surface: 'alternatives' })
|
|
countRoute({ ...sample, selfHosted: true })
|
|
countRoute({ ...sample, profile: 'walking' })
|
|
flushRouteUsage()
|
|
|
|
const [entries] = vi.mocked(routeUsageApi.report).mock.calls[0]
|
|
expect(entries).toHaveLength(4)
|
|
})
|
|
|
|
it('FE-MAP-ROUTECOUNT-005: a busy stretch flushes on its own, without waiting', () => {
|
|
for (let i = 0; i < 25; i++) countRoute(sample)
|
|
expect(routeUsageApi.report).toHaveBeenCalledTimes(1)
|
|
const [entries] = vi.mocked(routeUsageApi.report).mock.calls[0]
|
|
expect(entries[0].requests).toBe(25)
|
|
})
|
|
|
|
it('FE-MAP-ROUTECOUNT-006: a refused report is swallowed, and the next tally starts clean', async () => {
|
|
vi.mocked(routeUsageApi.report).mockRejectedValueOnce(new Error('offline'))
|
|
countRoute(sample)
|
|
expect(() => flushRouteUsage()).not.toThrow()
|
|
await Promise.resolve()
|
|
|
|
countRoute(sample)
|
|
flushRouteUsage()
|
|
const [entries] = vi.mocked(routeUsageApi.report).mock.calls[1]
|
|
expect(entries[0].requests).toBe(1)
|
|
})
|
|
})
|