mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-19 21:46:49 +00:00
eae8480728
* feat(studio): widen the document, and stop a save from losing it The schema gains what the elements coming after it need: an icon element, a badge that can be restyled rather than only placed, a date and a pair of coordinates on a text binding, and the map's route, pin and road settings. Widening it turned up two ways a book could fail to come back. The mood badge writes its code into the document, and the schema said that code was exactly two characters, from a first draft where it was a country. The real codes are words, so every save was rejected and the read that followed parsed to an empty document: seventeen spreads in, nothing out. Widened to what the badge actually writes, and normalizeBookDocument now drops the elements it cannot read rather than the whole book, so one bad element costs a picture frame instead of a year of work. The other was the body limit. The parser allowed 100kb for everything, and a book with a routed map measures past that, so the save came back 413 and the editor sat on "not saved" with no way forward. Book writes get their own parser at 8mb; everything else keeps the limit it had. * feat(studio): a date, a pair of coordinates and an icon library Three things that had to be drawn by hand before. A journal entry knows when it happened and where, and neither could be put on a page: you read the date off the entry and typed it into a text box, where it then stayed while the entry moved. Both are chips now, next to the title and the story, and both follow their entry the way the others do. The formatting lives in one place so the chip, the template and the resolver cannot drift by a character — coordinates in degrees or decimals, the date in the reader's language. The icons are the whole Lucide set, searchable, placed as a real element with its own colour and stroke rather than as a character in a font. The stroke is deliberately not called strokeWidth: three separate places rescale a field of that name by page width, and an icon whose line thins as the book grows is not what anyone asked for. And the badges finally have their settings. A mood or weather badge could be placed and then only moved: the icon's colour was fixed, the icon could not be turned off, and there was no way to keep the icon and drop the words. All three are switches now, with the colour following the badge unless you say otherwise. * fix(studio): let a placed entry field follow its journal entry again The inspector says a bound field follows the journal entry and that editing it here breaks the link. The first half was not true: nothing ever re-read the entry, so renaming a title in Journey left the old words on the page for good, and the same went for every other bound field. The resolver runs where the journey is loaded and re-reads the fields that still point at an entry. What it will not do is as important as what it does. A field somebody has typed over stays typed over, an entry that is gone leaves its element alone rather than blanking it, and an entry that answers with nothing never wipes what is already on the page. Formatted fields — the date, the coordinates — are only re-read when the format itself changed, which is what keeps this from quietly rewriting books that already exist: an entry whose date was placed as a heading and then set in capitals keeps its capitals. Checked against the real database before it shipped, where the first version overwrote three of them. * feat(studio): start a new book empty, with six layouts to choose from A new journey opened onto a book that had already been laid out, which is the wrong first move: it decides the shape of somebody's book before they have seen it, and undoing it means deleting pages one at a time. A new book starts empty now, and the auto layout runs when it is asked to. The layouts themselves went from two to six, so choosing one is a real choice: what was there covered a photo-heavy spread and a text-heavy one and nothing in between. * fix(studio): hyphenate the export the way the editor does, and set the bleed Two things the press sees and the editor did not. A paragraph broke in different places in the PDF than on screen. The print document is written from scratch and never carried a language, so the browser hyphenated the editor's German and the export's nothing-in- particular. It takes the page's own language now. The wait for the sheet to be ready also covers the images inside SVG, with a ceiling, so a map that is slow to draw does not print half-finished. And the bleed and the safe margin are typeable. Both were baked into every page preset at what a photo-book vendor usually asks for, 3mm and 5mm, with no control anywhere. That is fine until a printer asks for 5 and 10, at which point the book cannot be made here at all: the export carries the wrong bleed and the crop marks sit in the wrong place, which nobody finds until the guillotine has run. * feat(studio): rebuild the inspector The panel on the right had grown by accretion: every element type had added its own controls in whatever shape suited it that day, so the same idea — a colour, a size, a toggle — looked different depending on what you had selected, and long panels were a wall of unlabelled fields. It is one set of controls now, used by every element: foldable sections, a line that holds a label and its control, radio choices, checkboxes, the app's own toggle, and a number field that holds a draft so typing "500" is not read as "5", clamped and written back under the cursor. Duplicated controls were merged rather than deleted; nothing an element could do before it cannot do now. The head carries the element's identity and its actions, so what you have selected is readable without counting fields, and the sections have room to breathe: what was there was correct and unreadable. * feat(studio): a route map worth printing The map in a book was a straight grey line between grey dots on a tile that was chosen for a screen. At print size those tiles are read at roughly four times the resolution they were fetched for, which is why it looked soft next to everything around it. The imagery comes from sources that hold up on paper: NASA's shaded relief and EOX's cloudless Sentinel-2, both licensed for it, picked at a zoom that matches the printer rather than the screen. Tiles are fetched at twice the density where the source offers it, and the seam between them scales with the tile instead of sitting at a fixed fraction of a millimetre, which under editor zoom fell below one device pixel and showed as white threads. The route is drawn rather than plotted. A leg that was never recorded bows, by an amount that grows with its length and turns away from the pole, and it dashes, because an inferred line should not claim to be a track — a recorded track never bows. Both strokes are laid down in two passes, casing then core, so the line stays legible over dark sea and bright desert alike. Legs can follow roads instead, routed leg by leg with the geometry thinned before it is stored, which is the setting a road trip wants and the one a flight cannot have. Stops carry their own first photograph, cut to a circle by a stencil that exists — the first one was written into a defs block that only appears on a map clipped to a coastline, so on an ordinary map it clipped nothing and the photographs sat square on the page. A stop with no photograph of its own is numbered rather than handed one from elsewhere in the journey: a marker at one place showing a picture taken at another is a caption that lies. Whatever the frame, the whole route is inside it. The window takes the frame's aspect, so the fit and the imagery agree instead of one containing what the other covers, and a map dragged narrow no longer cuts off its end. Each linked trip can carry its own map, and a map notices a photograph added to a stop afterwards rather than having to be placed again. * i18n(journey): the new Studio strings, in all 23 locales * test(journey): pin the coverage the map work brought with it The journey domain measures higher than its floor after this round, so the floor follows it up. Only journey moved; the generator's suggestion would have taken memories' functions down a point, and a ratchet that can fall is not a ratchet. * test(studio): cover the thinning that keeps a road route saveable The one path in roadRoute nothing exercised, and the one that matters most: a router answers a long drive with thousands of points at a precision no press can resolve, and all of it goes into the document. Keeping a leg whole is what pushed a real book past the body limit. Both ends have to survive so the line still meets its stops, and the spacing has to stay even, because cutting a run out of the middle would straighten exactly the bends somebody wanted to see.
219 lines
8.9 KiB
TypeScript
219 lines
8.9 KiB
TypeScript
import { describe, it, expect, vi, beforeEach } from 'vitest'
|
|
import type { BookElement, BookPageSetup, BookSpread } from '@trek/shared'
|
|
import { bookPageSetupSchema } from '@trek/shared'
|
|
import { render } from '../../helpers/render'
|
|
import { SpreadView } from '../../../src/components/Studio/SpreadView'
|
|
import { fetchRoads } from '../../../src/components/Studio/roadRoute'
|
|
|
|
vi.mock('../../../src/components/Map/RouteCalculator', () => ({
|
|
calculateRouteWithLegs: vi.fn(),
|
|
}))
|
|
const { calculateRouteWithLegs } = await import('../../../src/components/Map/RouteCalculator')
|
|
|
|
/**
|
|
* The line following real roads, for the legs that have them (#1973).
|
|
*
|
|
* The trap this is built around: when the map element carries a track, the
|
|
* renderer draws that INSTEAD of the stop chain, whole. A road route that only
|
|
* covers some legs would therefore have printed those legs and silently dropped
|
|
* the rest — three legs of twelve, and the book looks like the journey stopped.
|
|
* So the roads are per leg and the chain is cut around them, and the case that
|
|
* proves it is the one below with a road on the middle leg only.
|
|
*
|
|
* The second thing worth protecting is what is NOT asked: a leg long enough to
|
|
* have been a flight is never sent to a router, because the answer would be a
|
|
* three-day drive and a ferry, and that is not the journey anybody made.
|
|
*/
|
|
|
|
const page: BookPageSetup = bookPageSetupSchema.parse({ preset: 'square-210' })
|
|
|
|
const STOPS = [
|
|
{ lat: 64.14, lng: -21.94, label: 'Reykjavík', photoId: null },
|
|
{ lat: 63.42, lng: -19.07, label: 'Vík', photoId: null },
|
|
{ lat: 65.68, lng: -18.12, label: 'Akureyri', photoId: null },
|
|
]
|
|
|
|
function map(over: Record<string, unknown> = {}): BookElement {
|
|
return {
|
|
id: 'mp1', kind: 'map', rotation: 0, opacity: 1, locked: false,
|
|
font: 'sans', color: '#1a1a1a', accent: '#ffffff', textScale: 1, weight: 400, stale: false,
|
|
frame: { x: 0, y: 0, w: 180, h: 140 },
|
|
style: 'minimal', source: 'vector', tileUrl: '', attribution: '', zoom: null, clip: 'rect',
|
|
showLand: true, showRoute: true, showPins: true, showLabels: false,
|
|
routeStyle: 'drawn', routeArc: 'bow', routeDash: 'arcs', pinStyle: 'dot',
|
|
countries: [], path: [], roads: [], fitPadding: 0.5, fitToCountries: false, tripId: null,
|
|
points: STOPS,
|
|
...over,
|
|
} as unknown as BookElement
|
|
}
|
|
|
|
function draw(el: BookElement) {
|
|
const spread: BookSpread = {
|
|
id: 's1', role: 'inner', background: null, elements: [el], parked: [], entryId: null,
|
|
}
|
|
return render(<SpreadView spread={spread} page={page} big />)
|
|
}
|
|
|
|
const strokes = (c: HTMLElement) =>
|
|
Array.from(c.querySelectorAll('path')).filter(p => p.getAttribute('fill') === 'none')
|
|
|
|
describe('a leg that has a road', () => {
|
|
it('is drawn as the road rather than as a line between its ends', () => {
|
|
const road: [number, number][] = [
|
|
[64.14, -21.94], [64.0, -21.5], [63.8, -20.6], [63.5, -19.6], [63.42, -19.07],
|
|
]
|
|
const { container } = draw(map({ roads: [road, null] }))
|
|
const ds = strokes(container).map(p => p.getAttribute('d') ?? '')
|
|
// A road is many points; a bow is one Q; a straight leg is one L.
|
|
expect(ds.some(d => (d.match(/L/g) ?? []).length >= 3)).toBe(true)
|
|
})
|
|
|
|
it('is drawn solid and unbowed, because it is the way that was taken', () => {
|
|
const road: [number, number][] = [
|
|
[64.14, -21.94], [64.0, -21.5], [63.8, -20.6], [63.42, -19.07],
|
|
]
|
|
const { container } = draw(map({ roads: [road, null] }))
|
|
const roadPaths = strokes(container).filter(p => (p.getAttribute('d') ?? '').match(/L/g))
|
|
for (const p of roadPaths) {
|
|
expect(p.getAttribute('d')).not.toContain('Q')
|
|
expect(p.getAttribute('stroke-dasharray')).toBeNull()
|
|
}
|
|
})
|
|
|
|
/*
|
|
* The bug this whole shape exists to avoid: `path` replaces the entire line,
|
|
* so a partial answer used to mean a partial journey.
|
|
*/
|
|
it('does not swallow the legs that have none', () => {
|
|
const middle: [number, number][] = [
|
|
[63.42, -19.07], [64.0, -18.5], [65.0, -18.2], [65.68, -18.12],
|
|
]
|
|
const { container } = draw(map({ roads: [null, middle] }))
|
|
const ds = strokes(container).map(p => p.getAttribute('d') ?? '')
|
|
// The first leg is still drawn: either bowed or straight, but drawn.
|
|
const hasFirstLeg = ds.some(d => d.includes('Q') || (d.match(/L/g) ?? []).length === 1)
|
|
expect(hasFirstLeg).toBe(true)
|
|
expect(ds.some(d => (d.match(/L/g) ?? []).length >= 2)).toBe(true)
|
|
})
|
|
|
|
it('is inside the frame, road and all', () => {
|
|
// A road that wanders well north of both its ends.
|
|
const road: [number, number][] = [
|
|
[64.14, -21.94], [66.5, -21.0], [66.6, -19.5], [63.42, -19.07],
|
|
]
|
|
const { container } = draw(map({ roads: [road, null] }))
|
|
const numbers = strokes(container)
|
|
.flatMap(p => (p.getAttribute('d') ?? '').match(/-?\d+(\.\d+)?/g) ?? [])
|
|
.map(Number)
|
|
// Coordinates come in pairs; none of them may leave the 180x140 element.
|
|
for (let i = 0; i < numbers.length; i += 2) {
|
|
expect(numbers[i]).toBeGreaterThanOrEqual(-0.01)
|
|
expect(numbers[i]).toBeLessThanOrEqual(180.01)
|
|
expect(numbers[i + 1]).toBeGreaterThanOrEqual(-0.01)
|
|
expect(numbers[i + 1]).toBeLessThanOrEqual(140.01)
|
|
}
|
|
})
|
|
})
|
|
|
|
describe('what gets asked for', () => {
|
|
beforeEach(() => {
|
|
vi.mocked(calculateRouteWithLegs).mockReset()
|
|
})
|
|
|
|
it('asks once per leg and keeps the answer in leg order', async () => {
|
|
vi.mocked(calculateRouteWithLegs).mockResolvedValue({
|
|
coordinates: [[1, 1], [1.1, 1.1], [1.2, 1.2]],
|
|
distance: 1, duration: 1, legs: [],
|
|
} as never)
|
|
|
|
const roads = await fetchRoads([
|
|
{ lat: 52.5, lng: 13.4 },
|
|
{ lat: 52.4, lng: 13.1 },
|
|
{ lat: 52.3, lng: 13.0 },
|
|
])
|
|
expect(calculateRouteWithLegs).toHaveBeenCalledTimes(2)
|
|
expect(roads).toHaveLength(2)
|
|
expect(roads[0]).toHaveLength(3)
|
|
})
|
|
|
|
it('never asks about a leg long enough to have been a flight', async () => {
|
|
const roads = await fetchRoads([
|
|
{ lat: 64.14, lng: -21.94 },
|
|
{ lat: -33.87, lng: 151.21 },
|
|
])
|
|
expect(calculateRouteWithLegs).not.toHaveBeenCalled()
|
|
expect(roads).toEqual([null])
|
|
})
|
|
|
|
it('leaves a leg alone when the router refuses, rather than failing the lot', async () => {
|
|
vi.mocked(calculateRouteWithLegs)
|
|
.mockRejectedValueOnce(new Error('no route'))
|
|
.mockResolvedValueOnce({
|
|
coordinates: [[1, 1], [1.1, 1.1], [1.2, 1.2]], distance: 1, duration: 1, legs: [],
|
|
} as never)
|
|
|
|
const roads = await fetchRoads([
|
|
{ lat: 52.5, lng: 13.4 },
|
|
{ lat: 52.4, lng: 13.1 },
|
|
{ lat: 52.3, lng: 13.0 },
|
|
])
|
|
expect(roads[0]).toBeNull()
|
|
expect(roads[1]).not.toBeNull()
|
|
})
|
|
|
|
it('keeps nothing when the answer is just the straight line back', async () => {
|
|
vi.mocked(calculateRouteWithLegs).mockResolvedValue({
|
|
coordinates: [[1, 1], [1.2, 1.2]], distance: 1, duration: 1, legs: [],
|
|
} as never)
|
|
const roads = await fetchRoads([{ lat: 52.5, lng: 13.4 }, { lat: 52.4, lng: 13.1 }])
|
|
expect(roads).toEqual([null])
|
|
})
|
|
|
|
/*
|
|
* A router answers a long drive with thousands of points, at a precision no
|
|
* press can resolve, and all of it is stored in the document. That is not a
|
|
* tidiness problem: the book is saved as one body, and a route kept whole is
|
|
* what pushed a real book past the body limit and left the editor showing
|
|
* "not saved" with no way forward.
|
|
*
|
|
* Thinned evenly rather than by cutting a run out of the middle, because a
|
|
* road's shape is the reason to draw it at all — losing the middle would
|
|
* straighten exactly the bends somebody wanted to see.
|
|
*/
|
|
it('thins a long answer, keeping both ends and the shape between them', async () => {
|
|
const many: [number, number][] = Array.from({ length: 900 }, (_, i) => [
|
|
52.5 - i * 0.001,
|
|
13.4 + i * 0.001,
|
|
])
|
|
vi.mocked(calculateRouteWithLegs).mockResolvedValue({
|
|
coordinates: many, distance: 1, duration: 1, legs: [],
|
|
} as never)
|
|
|
|
const roads = await fetchRoads([{ lat: 52.5, lng: 13.4 }, { lat: 51.6, lng: 14.3 }])
|
|
const leg = roads[0]!
|
|
expect(leg).not.toBeNull()
|
|
expect(leg.length).toBe(120)
|
|
|
|
// Both ends survive, so the line still meets the stops it runs between.
|
|
expect(leg[0]).toEqual([52.5, 13.4])
|
|
expect(leg[leg.length - 1]).toEqual([51.601, 14.299])
|
|
|
|
// Evenly spaced: no two consecutive points sit further apart than one step.
|
|
const gaps = leg.slice(1).map((p, i) => Math.abs(p[0] - leg[i][0]))
|
|
expect(Math.max(...gaps) - Math.min(...gaps)).toBeLessThan(0.002)
|
|
})
|
|
|
|
it('leaves a leg the press can already resolve exactly as it came', async () => {
|
|
const few: [number, number][] = Array.from({ length: 40 }, (_, i) => [
|
|
52.5 - i * 0.01,
|
|
13.4 + i * 0.01,
|
|
])
|
|
vi.mocked(calculateRouteWithLegs).mockResolvedValue({
|
|
coordinates: few, distance: 1, duration: 1, legs: [],
|
|
} as never)
|
|
|
|
const roads = await fetchRoads([{ lat: 52.5, lng: 13.4 }, { lat: 52.1, lng: 13.8 }])
|
|
expect(roads[0]!.length).toBe(40)
|
|
})
|
|
})
|