/**
* Clicking a place pin after the map has been dragged (#2504).
*
* Nothing Leaflet-related is mocked here on purpose. The bug lived in the space between
* our drag wiring and Leaflet's own event routing: the pins swallow mousedown so a drag
* onto a day can start without the map sliding away, and Leaflet only forgets that the
* map was panned when it sees the next mousedown. A mocked react-leaflet, like the one
* MapView.test.tsx uses, has no such memory and kept passing throughout.
*
* The click itself has to keep taking Leaflet's route and the page's: it is what closes
* an open popup on the map, and an open context menu beside it.
*/
import React, { useState } from 'react'
import { flushSync } from 'react-dom'
import { describe, it, expect, vi, beforeAll, afterAll, afterEach } from 'vitest'
import { render, waitFor, act } from '../../../tests/helpers/render'
import { resetAllStores } from '../../../tests/helpers/store'
import { buildPlace } from '../../../tests/helpers/factories'
import { AMAP_ROAD } from '../../constants/mapDefaults'
import { useSettingsStore } from '../../store/settingsStore'
vi.mock('../../hooks/useGeolocation', () => ({
useGeolocation: () => ({ position: null, mode: 'off', error: null, errorCode: null, cycleMode: vi.fn(), setMode: vi.fn() }),
}))
// What the via ferrata layer draws is FerrataLayerLeaflet's own suite; here only what the
// renderer hands it. jsdom has no SVG renderer for Leaflet to draw real lines into.
vi.mock('../Ferratas/FerrataLayerLeaflet', () => ({
FerrataMapLayerLeaflet: ({ layer }: { layer?: { active: boolean; groups: readonly unknown[] } }) =>
layer?.active ?
: null,
}))
vi.mock('../../services/photoService', () => ({
getCached: vi.fn(() => null),
isLoading: vi.fn(() => false),
fetchPhoto: vi.fn(),
onThumbReady: vi.fn(() => () => {}),
getAllThumbs: vi.fn(() => ({})),
}))
import L from 'leaflet'
import { MapView } from './MapView'
import { ContextMenu } from '../shared/ContextMenu'
import type { Ferrata } from '@trek/shared'
import { groupFerratas } from '../Ferratas/ferrataGroups'
// Every map this file builds, newest last, for the tests that reach past the component.
const maps: L.Map[] = []
L.Map.addInitHook(function (this: L.Map) { maps.push(this) })
// A raster template keeps the basemap a plain TileLayer: the vector default needs WebGL.
const RASTER = 'https://tiles.example.test/{z}/{x}/{y}.png'
// Leaflet sizes the map from the container, which jsdom lays out at 0 x 0. The cluster
// group only draws pins inside the visible bounds, so the map needs a real size.
const sized = ['clientWidth', 'clientHeight'] as const
const originals = new Map()
beforeAll(() => {
// The pans here are synthetic and instant. With inertia, Leaflet would carry them on in
// animation frames that can land after a test has already unmounted its map.
L.Map.mergeOptions({ inertia: false })
for (const key of sized) {
originals.set(key, Object.getOwnPropertyDescriptor(HTMLElement.prototype, key))
Object.defineProperty(HTMLElement.prototype, key, { configurable: true, get: () => (key === 'clientWidth' ? 1000 : 700) })
}
})
afterAll(() => {
L.Map.mergeOptions({ inertia: true })
for (const key of sized) {
const original = originals.get(key)
if (original) Object.defineProperty(HTMLElement.prototype, key, original)
else delete (HTMLElement.prototype as unknown as Record)[key]
}
})
afterEach(() => {
resetAllStores()
})
/** Leaflet only starts a pan for the primary button, which it reads off `which`. */
function mouse(type: string, x: number, y: number): MouseEvent {
const event = new MouseEvent(type, { bubbles: true, cancelable: true, button: 0, clientX: x, clientY: y })
Object.defineProperty(event, 'which', { value: 1 })
return event
}
/** Drag the map by its background, the way a user pans it. */
function panMap(container: Element) {
act(() => {
container.dispatchEvent(mouse('mousedown', 300, 300))
container.dispatchEvent(mouse('mousemove', 340, 320))
container.dispatchEvent(mouse('mousemove', 380, 340))
container.dispatchEvent(mouse('mouseup', 380, 340))
})
}
/** A plain click on an element: press, release, click, all on the same spot. */
function clickOn(el: Element) {
act(() => {
el.dispatchEvent(mouse('mousedown', 500, 350))
el.dispatchEvent(mouse('mouseup', 500, 350))
el.dispatchEvent(mouse('click', 500, 350))
})
}
/** The Leaflet marker that renders `el`; throws when the map has none. */
function markerOf(map: L.Map, el: Element): L.Marker {
let found: L.Marker | null = null
map.eachLayer(layer => {
if (layer instanceof L.Marker && layer.getElement() === el) found = layer
})
if (!found) throw new Error('no marker renders this element')
return found
}
function pointer(type: string, x: number, y: number): Event {
const event = new Event(type, { bubbles: true, cancelable: true })
Object.defineProperties(event, {
button: { value: 0 },
clientX: { value: x },
clientY: { value: y },
pointerId: { value: 1 },
})
return event
}
// Two stops a few hundred metres apart in Nara: separate pins at this zoom, not a cluster.
const places = [
{ ...buildPlace({ id: 1, name: 'Todai-ji', lat: 34.689, lng: 135.8398 }), category_name: null, category_color: null, category_icon: null },
{ ...buildPlace({ id: 2, name: 'Kasuga Taisha', lat: 34.6812, lng: 135.8484 }), category_name: null, category_color: null, category_icon: null },
]
async function renderMap() {
const onMarkerClick = vi.fn()
const onMapClick = vi.fn()
const view = render(
,
)
const container = view.container.querySelector('.leaflet-container') as HTMLElement
// The cluster group takes its markers in on a timer (chunkedLoading).
await waitFor(() => expect(container.querySelectorAll('.leaflet-marker-icon[draggable="true"]').length).toBe(2))
const pins = [...container.querySelectorAll('.leaflet-marker-icon[draggable="true"]')] as HTMLElement[]
return { container, pins, onMarkerClick, onMapClick }
}
describe('MapView on a real Leaflet map', () => {
it('RC-08: previews waypoint drags locally and commits only at pointer up without panning', async () => {
const waypoint = { id: 'via-1', lat: 34.689, lng: 135.8398, role: 'via' as const }
const waypoints = [waypoint]
const onMove = vi.fn(() => true)
const onSelect = vi.fn()
const onMapClick = vi.fn()
const view = render(
)
const map = maps[maps.length - 1]
await waitFor(() => expect(view.container.querySelector('.tour-planner-waypoint-marker')).not.toBeNull())
const pin = view.container.querySelector('.tour-planner-waypoint-marker') as HTMLElement
const marker = markerOf(map, pin)
const start = map.latLngToContainerPoint([waypoint.lat, waypoint.lng])
const end = start.add([30, 20])
const expected = map.containerPointToLatLng(end)
const center = map.getCenter()
act(() => {
pin.dispatchEvent(pointer('pointerdown', start.x, start.y))
pin.dispatchEvent(mouse('mousedown', start.x, start.y))
pin.dispatchEvent(pointer('pointermove', end.x, end.y))
})
expect(marker.getLatLng().lat).toBeCloseTo(expected.lat, 6)
expect(marker.getLatLng().lng).toBeCloseTo(expected.lng, 6)
expect(onMove).not.toHaveBeenCalled()
expect(waypoints[0]).toEqual(waypoint)
view.rerender(
)
expect(marker.getLatLng().lat).toBeCloseTo(expected.lat, 6)
expect(marker.getLatLng().lng).toBeCloseTo(expected.lng, 6)
act(() => {
pin.dispatchEvent(pointer('pointerup', end.x, end.y))
pin.dispatchEvent(mouse('mouseup', end.x, end.y))
pin.dispatchEvent(mouse('click', end.x, end.y))
})
expect(onMove).toHaveBeenCalledOnce()
expect(onMove).toHaveBeenCalledWith(waypoint.id, expected.lat, expected.lng)
expect(onSelect).not.toHaveBeenCalled()
expect(onMapClick).not.toHaveBeenCalled()
expect(map.getCenter().lat).toBeCloseTo(center.lat, 6)
expect(map.getCenter().lng).toBeCloseTo(center.lng, 6)
view.rerender(
)
expect(map.getCenter().lat).toBeCloseTo(center.lat, 6)
expect(map.getCenter().lng).toBeCloseTo(center.lng, 6)
})
it('RC-08: cancellation restores the marker and a plain click still selects without affecting map-add', async () => {
const waypoint = { id: 'start', lat: 34.689, lng: 135.8398, role: 'start' as const }
const onMove = vi.fn(() => true)
const onSelect = vi.fn()
const onMapClick = vi.fn()
const view = render(
)
const map = maps[maps.length - 1]
await waitFor(() => expect(view.container.querySelector('.tour-planner-waypoint-marker')).not.toBeNull())
const pin = view.container.querySelector('.tour-planner-waypoint-marker') as HTMLElement
const marker = markerOf(map, pin)
const start = map.latLngToContainerPoint([waypoint.lat, waypoint.lng])
const end = start.add([30, 20])
act(() => {
pin.dispatchEvent(pointer('pointerdown', start.x, start.y))
pin.dispatchEvent(pointer('pointermove', end.x, end.y))
pin.dispatchEvent(pointer('pointercancel', end.x, end.y))
})
expect(marker.getLatLng().lat).toBeCloseTo(waypoint.lat, 6)
expect(marker.getLatLng().lng).toBeCloseTo(waypoint.lng, 6)
expect(onMove).not.toHaveBeenCalled()
clickOn(pin)
expect(onSelect).toHaveBeenCalledOnce()
expect(onSelect).toHaveBeenCalledWith(waypoint.id)
expect(onMapClick).not.toHaveBeenCalled()
act(() => { map.fire('click', { latlng: L.latLng(34.7, 135.85) }) })
expect(onMapClick).toHaveBeenCalledOnce()
})
it('uses WGS-84 for Tours-local Topo over global Amap and preserves a Beijing click through layer switches', async () => {
useSettingsStore.setState({ settings: { ...useSettingsStore.getState().settings, map_base_layer: 'default' } })
const beijing = { ...buildPlace({ id: 201, name: 'Beijing', lat: 39.9042, lng: 116.4074 }), category_name: null, category_color: null, category_icon: null }
const onMapClick = vi.fn()
const route: [number, number][][] = [[[39.9042, 116.4074], [39.9052, 116.4084]]]
const waypoints = [{ id: 'beijing', lat: 39.9042, lng: 116.4074, role: 'start' as const }]
const renderLayer = (viewBaseLayer: 'default' | 'topo' | 'satellite') => (
)
const view = render(renderLayer('default'))
await waitFor(() => expect(view.container.querySelector('.leaflet-container')).toBeInTheDocument())
let map = maps[maps.length - 1]
expect(map.options.crs).toBeTruthy()
expect(map.options.crs?.code).toBe('TREK:GCJ02')
const retainedCenter = L.latLng(39.91, 116.41)
act(() => map.setView(retainedCenter, 13))
view.rerender(renderLayer('topo'))
await waitFor(() => expect(maps[maps.length - 1]).not.toBe(map))
map = maps[maps.length - 1]
expect(map.options.crs).toBe(L.CRS.EPSG3857)
expect(map.getCenter().lat).toBeCloseTo(retainedCenter.lat, 5)
expect(map.getCenter().lng).toBeCloseTo(retainedCenter.lng, 5)
const expectedClick = L.latLng(39.9042, 116.4074)
const pixel = map.latLngToContainerPoint(expectedClick)
const roundTrip = map.containerPointToLatLng(pixel)
const pixelTolerance = map.distance(expectedClick, map.containerPointToLatLng(pixel.add([1, 1])))
map.fire('click', { latlng: roundTrip })
expect(onMapClick).toHaveBeenCalledOnce()
expect(map.distance(onMapClick.mock.calls[0][0].latlng, expectedClick)).toBeLessThanOrEqual(pixelTolerance)
view.rerender(renderLayer('satellite'))
await waitFor(() => expect(maps[maps.length - 1]).not.toBe(map))
map = maps[maps.length - 1]
expect(map.options.crs?.code).toBe('TREK:GCJ02')
expect(map.getCenter().lat).toBeCloseTo(retainedCenter.lat, 5)
expect(map.getCenter().lng).toBeCloseTo(retainedCenter.lng, 5)
expect(waypoints).toEqual([{ id: 'beijing', lat: 39.9042, lng: 116.4074, role: 'start' }])
expect(route).toEqual([[[39.9042, 116.4074], [39.9052, 116.4084]]])
})
it('FE-MAPCLICK-001: a pin opens its place on a map nobody has dragged yet', async () => {
const { pins, onMarkerClick, onMapClick } = await renderMap()
clickOn(pins[0])
expect(onMarkerClick).toHaveBeenCalledTimes(1)
// Still the marker's click, not one on the empty map behind it.
expect(onMapClick).not.toHaveBeenCalled()
})
it('FE-MAPCLICK-002: a pin still opens its place after the map was dragged (#2504)', async () => {
const { container, pins, onMarkerClick, onMapClick } = await renderMap()
panMap(container)
clickOn(pins[0])
expect(onMarkerClick).toHaveBeenCalledTimes(1)
// And again: the report was that every click after the pan went nowhere.
clickOn(pins[1])
expect(onMarkerClick).toHaveBeenCalledTimes(2)
expect(onMarkerClick.mock.calls.map(call => call[0]).sort()).toEqual([1, 2])
expect(onMapClick).not.toHaveBeenCalled()
})
it('FE-MAPCLICK-003: the click that ends a pan still counts for nothing', async () => {
const { container, onMarkerClick, onMapClick } = await renderMap()
panMap(container)
// The browser aims the click that closes a drag at the element both ends share,
// which is the map rather than the pin the pointer happened to stop on. Leaflet
// swallows it, and must go on doing so: it is not a click on the empty map either.
act(() => { container.dispatchEvent(mouse('click', 380, 340)) })
expect(onMarkerClick).not.toHaveBeenCalled()
expect(onMapClick).not.toHaveBeenCalled()
})
it("FE-MAPCLICK-004: a pin on a touch screen keeps Leaflet's own click and no drag wiring", async () => {
const original = Object.getOwnPropertyDescriptor(window.navigator, 'maxTouchPoints')
Object.defineProperty(window.navigator, 'maxTouchPoints', { configurable: true, value: 5 })
try {
const onMarkerClick = vi.fn()
const view = render()
const container = view.container.querySelector('.leaflet-container') as HTMLElement
await waitFor(() => expect(container.querySelectorAll('.leaflet-marker-icon').length).toBe(2))
const pin = container.querySelector('.leaflet-marker-icon') as HTMLElement
expect(pin.getAttribute('draggable')).toBeNull()
clickOn(pin)
expect(onMarkerClick).toHaveBeenCalledTimes(1)
} finally {
if (original) Object.defineProperty(window.navigator, 'maxTouchPoints', original)
else delete (window.navigator as unknown as Record).maxTouchPoints
}
})
it('FE-MAPCLICK-005: the place a pin opens stays open when the pin redraws mid-click', async () => {
// The selection a pin makes redraws its icon, which replaces the element the click
// landed on. Leaflet has to have found the pin before that happens: reading the target
// afterwards, it finds it cut out of the map and takes the click for one on the empty
// background, which would close the place again straight away.
const onMapClick = vi.fn()
function Planner() {
const [selected, setSelected] = useState(null)
return (
<>
flushSync(() => setSelected(id))}
onMapClick={() => { onMapClick(); setSelected(null) }}
/>
>
)
}
const view = render()
const container = view.container.querySelector('.leaflet-container') as HTMLElement
await waitFor(() => expect(container.querySelectorAll('.leaflet-marker-icon[draggable="true"]').length).toBe(2))
const pin = container.querySelector('.leaflet-marker-icon[draggable="true"]') as HTMLElement
// The pointer lands on the photo inside the pin, which the redraw replaces.
clickOn(pin.firstElementChild as HTMLElement)
expect(onMapClick).not.toHaveBeenCalled()
expect(view.getByTestId('selected').textContent).not.toBe('')
})
it('FE-MAPCLICK-006: a pin click after a pan still closes an open popup on the map', async () => {
const { container, pins, onMarkerClick } = await renderMap()
const map = maps[maps.length - 1]
panMap(container)
// A hazard or plugin popup, as the planner opens them. Leaflet closes those on the
// "preclick" it sends ahead of every click it routes, a pin's included.
const popup = L.popup({ autoPan: false }).setLatLng([34.685, 135.844]).setContent('Road closed')
act(() => { popup.openOn(map) })
expect(map.hasLayer(popup)).toBe(true)
clickOn(pins[0])
expect(onMarkerClick).toHaveBeenCalledTimes(1)
expect(map.hasLayer(popup)).toBe(false)
})
it('FE-MAPCLICK-007: a pin click after a pan still reaches the page and closes an open context menu', async () => {
const onClose = vi.fn()
const onMarkerClick = vi.fn()
const view = render(
<>
{/* The menu the places list and the day plan open on a right click. It closes on
any click that reaches the document. */}
>,
)
const container = view.container.querySelector('.leaflet-container') as HTMLElement
await waitFor(() => expect(container.querySelectorAll('.leaflet-marker-icon[draggable="true"]').length).toBe(2))
const pin = container.querySelector('.leaflet-marker-icon[draggable="true"]') as HTMLElement
panMap(container)
clickOn(pin)
expect(onMarkerClick).toHaveBeenCalledTimes(1)
expect(onClose).toHaveBeenCalledTimes(1)
})
it('FE-MAPCLICK-008: pressing a pin after a pan still holds the map still for a drag onto a day', async () => {
const { container, pins } = await renderMap()
const map = maps[maps.length - 1]
panMap(container)
const before = map.getCenter()
// Press on the pin and move off it, as the start of a drag towards the day plan.
act(() => {
pins[0].dispatchEvent(mouse('mousedown', 500, 350))
document.dispatchEvent(mouse('mousemove', 560, 390))
document.dispatchEvent(mouse('mousemove', 620, 430))
document.dispatchEvent(mouse('mouseup', 620, 430))
})
expect(map.getCenter()).toEqual(before)
// The pan handler is back on, and the background still pans the map.
expect(map.dragging.enabled()).toBe(true)
panMap(container)
expect(map.getCenter()).not.toEqual(before)
})
it('RC-10: the tour layer pill offers the via ferrata switch, and the layer is drawn only while it is on', async () => {
const ferrata: Ferrata = { id: 'way/42', name: 'Via delle Trincee', grade: { raw: '4', level: 4, plus: null }, routeName: null,
geometry: [[46.52, 11.8], [46.53, 11.81]], osmUrl: 'https://www.openstreetmap.org/way/42' }
const layer = {
active: false, onToggle: vi.fn(), status: 'idle' as const, count: 0, groups: groupFerratas([ferrata]),
selectedId: null, onSelect: vi.fn(),
}
const view = render(
,
)
const toggle = await view.findByRole('button', { name: 'Via ferratas' })
expect(toggle).toHaveAttribute('aria-pressed', 'false')
expect(view.queryByTestId('ferrata-leaflet-layer')).toBeNull()
act(() => toggle.click())
expect(layer.onToggle).toHaveBeenCalledOnce()
view.rerender(
,
)
await waitFor(() => expect(view.getByTestId('ferrata-leaflet-layer')).toHaveAttribute('data-count', '1'))
expect(view.getByRole('button', { name: 'Via ferratas' })).toHaveAttribute('aria-pressed', 'true')
expect(view.getByTestId('ferrata-count-badge')).toHaveTextContent('1')
})
})