mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-20 14:06:27 +00:00
Maurice
2e1dca9fe9
Settings, Integrations, wanderer gains an optional background check of the trails you imported, off until you switch it on. While on, TREK reads the short record of each such trail at most once a day (never its GPX file) and leaves a hint when the trail may have moved on: "may have changed" when only wanderer's change time moved, "changed" when its name or description proves it, and "not checkable" when the trail is gone, no longer yours or carries no change time. Nothing is ever said to be unchanged. A new hint arrives as a notification that opens the tour (a new ?place= link in the planner); the tour's provenance shows it with the source check right beside it, and the card lists all open hints in a dialog, each leading to its tour. The check reads the source in full as before and spends the hint; taking a change in stays the confirmed reimport. No tour is ever changed or deleted. The check only asks through your own connection, only about trails your account imported into trips you can still open, and stops when you switch it off, remove the connection, wanderer refuses the token (until a test passes or a new token is saved) or the admin switches wanderer off; hints and snapshots stay. A run asks at most 25 connections for at most 10 records each, one after another, and an instance that fails (an outage, a rate limit) is left alone for an hour, doubling up to two days. Server: migration 046120 adds the switch and the run bookkeeping to wanderer_connections and the tour_source_hints table (one row per snapshot, for its importer, gone with it). WandererWatchService and an hourly wanderer-watch job on the CronRegistrar live in the tours domain and read through WandererService; GET and PUT /api/integrations/wanderer/watch and GET /api/trips/:tripId/tours/wanderer/sources/:placeId/hint (place_edit, like the check) answer with @trek/shared contracts. A new user notification event, wanderer_source_hint, can be muted per channel. Saving a new token now clears what the last check said about the old one. There is no MCP tool, as for the rest of the personal wanderer connection. All 27 locales carry the strings, and the admin wiki page says what the check does.
63 lines
3.3 KiB
TypeScript
63 lines
3.3 KiB
TypeScript
import type {
|
|
AdminFeatureToggleResponse,
|
|
TourSourceCheckResponse,
|
|
TourSourceHintResponse,
|
|
WandererConnection,
|
|
WandererImportPreview,
|
|
WandererImportRequest,
|
|
WandererImportResponse,
|
|
WandererSaveResponse,
|
|
WandererSearchRequest,
|
|
WandererSearchResponse,
|
|
WandererSettingsRequest,
|
|
WandererTestRequest,
|
|
WandererTestResponse,
|
|
WandererWatch,
|
|
} from '@trek/shared';
|
|
import apiClient from './client';
|
|
|
|
/**
|
|
* How long the browser waits for a call that makes the server ask wanderer.
|
|
* A preview reads the trail's index entry, its record and its GPX one after
|
|
* another, each allowed 15 s on the server, so the shared 8 s would give up
|
|
* while the server carries on.
|
|
*/
|
|
const WANDERER_UPSTREAM_TIMEOUT_MS = 60_000;
|
|
|
|
const upstream = { timeout: WANDERER_UPSTREAM_TIMEOUT_MS };
|
|
|
|
export const wandererApi = {
|
|
getSettings: (): Promise<WandererConnection> => apiClient.get('/integrations/wanderer/settings').then((r) => r.data),
|
|
saveSettings: (data: WandererSettingsRequest): Promise<WandererSaveResponse> =>
|
|
apiClient.put('/integrations/wanderer/settings', data).then((r) => r.data),
|
|
disconnect: (): Promise<{ success: true }> => apiClient.delete('/integrations/wanderer/settings').then((r) => r.data),
|
|
test: (data: WandererTestRequest): Promise<WandererTestResponse> =>
|
|
apiClient.post('/integrations/wanderer/test', data, upstream).then((r) => r.data),
|
|
/** WAN-02: the optional background watch of the connection, with the open hints. */
|
|
getWatch: (): Promise<WandererWatch> => apiClient.get('/integrations/wanderer/watch').then((r) => r.data),
|
|
setWatch: (enabled: boolean): Promise<WandererWatch> =>
|
|
apiClient.put('/integrations/wanderer/watch', { enabled }).then((r) => r.data),
|
|
|
|
search: (tripId: number, body: WandererSearchRequest, signal?: AbortSignal): Promise<WandererSearchResponse> =>
|
|
apiClient.post(`/trips/${tripId}/tours/wanderer/search`, body, { ...upstream, signal }).then((r) => r.data),
|
|
preview: (tripId: number, trailId: string, signal?: AbortSignal): Promise<WandererImportPreview> =>
|
|
apiClient
|
|
.get(`/trips/${tripId}/tours/wanderer/trails/${encodeURIComponent(trailId)}`, { ...upstream, signal })
|
|
.then((r) => r.data),
|
|
importTrail: (tripId: number, body: WandererImportRequest): Promise<WandererImportResponse> =>
|
|
apiClient.post(`/trips/${tripId}/tours/wanderer/import`, body, upstream).then((r) => r.data),
|
|
/** MF-03: whether the trail a snapshot came from changed since; the server reads, it writes nothing. */
|
|
checkSource: (tripId: number, placeId: number): Promise<TourSourceCheckResponse> =>
|
|
apiClient.post(`/trips/${tripId}/tours/wanderer/sources/${placeId}/check`, {}, upstream).then((r) => r.data),
|
|
/** WAN-02: the caller's own background hint on a snapshot; the server only reads its own rows. */
|
|
sourceHint: (tripId: number, placeId: number, signal?: AbortSignal): Promise<TourSourceHintResponse> =>
|
|
apiClient.get(`/trips/${tripId}/tours/wanderer/sources/${placeId}/hint`, { signal }).then((r) => r.data),
|
|
};
|
|
|
|
/** The admin's switch for wanderer under the Tours addon. */
|
|
export const wandererAdminApi = {
|
|
get: (): Promise<AdminFeatureToggleResponse> => apiClient.get('/admin/tours-wanderer').then((r) => r.data),
|
|
update: (enabled: boolean): Promise<AdminFeatureToggleResponse> =>
|
|
apiClient.put('/admin/tours-wanderer', { enabled }).then((r) => r.data),
|
|
};
|