mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-22 06:56:35 +00:00
Maurice
2a8071f642
A searchProvider plugin can now implement an optional suggest() beside search(). Its places then show up in the place search's typed-ahead list, after the core suggestions and marked with the plugin's name, on desktop and phone. An index that cannot take a request per keystroke leaves it out and keeps answering the full search only. The child reports which functions each hook object carries at load, so GET /api/plugin-search/suggest only asks the plugins that implement suggest: from the second character, three rows at most across all of them, 800 ms to answer. The feed marks plugins holding hook:search-provider and the client only asks the route while one is installed. A plugin row carries its whole place, so picking it skips the details lookup, which knows no plugin id. The phone's search results now name their source as the desktop ones do, and the desktop dropdown scrolls instead of running past the dialog. Addresses discussion #2221.
85 lines
4.6 KiB
TypeScript
85 lines
4.6 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
import { corePickRank, googleHoldsSlot, offersGoogleRetry, placesGoogleOnlyHint, selectGoogleHoldsSlot, sourceLabelFor } from './placeSource'
|
|
|
|
describe('offersGoogleRetry', () => {
|
|
it('FE-PLACESOURCE-001: offers Google for a list the index or OpenStreetMap answered, only where Google answers', () => {
|
|
expect(offersGoogleRetry('trek-places+openstreetmap', true)).toBe(true)
|
|
expect(offersGoogleRetry('openstreetmap', true)).toBe(true)
|
|
expect(offersGoogleRetry('trek-places+plugin', true)).toBe(true)
|
|
expect(offersGoogleRetry('trek-places+openstreetmap', false)).toBe(false)
|
|
})
|
|
|
|
it('FE-PLACESOURCE-002: a list Google produced, the offline cache and no list at all have nowhere further to go', () => {
|
|
expect(offersGoogleRetry('google', true)).toBe(false)
|
|
expect(offersGoogleRetry('google+plugin', true)).toBe(false)
|
|
expect(offersGoogleRetry('offline-cache', true)).toBe(false)
|
|
expect(offersGoogleRetry('', true)).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('googleHoldsSlot', () => {
|
|
it('FE-PLACESOURCE-004: a key holds the slot under auto and google, not under Amap or OpenStreetMap', () => {
|
|
expect(googleHoldsSlot(true, 'auto')).toBe(true)
|
|
expect(googleHoldsSlot(true, 'google')).toBe(true)
|
|
// A stored key still serves photos and details here, but the server never
|
|
// walks the Google chain for a search, so a link that offered it would be dead.
|
|
expect(googleHoldsSlot(true, 'amap')).toBe(false)
|
|
expect(googleHoldsSlot(true, 'openstreetmap')).toBe(false)
|
|
expect(googleHoldsSlot(false, 'google')).toBe(false)
|
|
// Unrecognised reads as auto, as the server reads it.
|
|
expect(googleHoldsSlot(true, '')).toBe(true)
|
|
})
|
|
|
|
it('FE-PLACESOURCE-005: the store selector asks the same question of the auth state', () => {
|
|
expect(selectGoogleHoldsSlot({ hasMapsKey: true, placesProvider: 'auto' })).toBe(true)
|
|
expect(selectGoogleHoldsSlot({ hasMapsKey: true, placesProvider: 'openstreetmap' })).toBe(false)
|
|
expect(selectGoogleHoldsSlot({ hasMapsKey: false, placesProvider: 'auto' })).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('placesGoogleOnlyHint', () => {
|
|
it('FE-PLACESOURCE-006: names what the admin has to do before the switch does anything', () => {
|
|
expect(placesGoogleOnlyHint(false, 'auto')).toBe('admin.placesGoogleOnly.missingKey')
|
|
expect(placesGoogleOnlyHint(false, 'openstreetmap')).toBe('admin.placesGoogleOnly.missingKey')
|
|
expect(placesGoogleOnlyHint(true, 'amap')).toBe('admin.placesGoogleOnly.otherProvider')
|
|
expect(placesGoogleOnlyHint(true, 'openstreetmap')).toBe('admin.placesGoogleOnly.otherProvider')
|
|
expect(placesGoogleOnlyHint(true, 'auto')).toBe('admin.placesGoogleOnly.subtitle')
|
|
expect(placesGoogleOnlyHint(true, 'google')).toBe('admin.placesGoogleOnly.subtitle')
|
|
})
|
|
})
|
|
|
|
describe('sourceLabelFor', () => {
|
|
it('FE-PLACESOURCE-003: a row names its own index, else the list it came from', () => {
|
|
const t = (k: string) => k
|
|
expect(sourceLabelFor({ source: 'openstreetmap' }, 'trek-places+openstreetmap', t)).toBe('OpenStreetMap')
|
|
expect(sourceLabelFor({}, 'google', t)).toBe('Google')
|
|
expect(sourceLabelFor({}, 'amap', t)).toBe('places.source.amap')
|
|
})
|
|
|
|
it('FE-PLACESOURCE-007: a plugin row names its plugin, by the installed name when there is one', () => {
|
|
const t = (k: string) => k
|
|
const names: Record<string, string> = { 'all-the-places': 'All the Places' }
|
|
const pluginName = (id: string) => names[id]
|
|
expect(sourceLabelFor({ source: 'plugin:all-the-places' }, 'trek-places', t, pluginName)).toBe('All the Places')
|
|
// Uninstalled since the list was drawn, or no lookup at hand: the id still says where it came from.
|
|
expect(sourceLabelFor({ source: 'plugin:gone' }, 'trek-places', t, pluginName)).toBe('gone')
|
|
expect(sourceLabelFor({ source: 'plugin:all-the-places' }, 'trek-places', t)).toBe('all-the-places')
|
|
// A merged list's own source names no single row, so an unmarked core row stays unlabelled.
|
|
expect(sourceLabelFor({}, 'trek-places+plugin:all-the-places', t, pluginName)).toBeNull()
|
|
})
|
|
})
|
|
|
|
describe('corePickRank', () => {
|
|
it('FE-PLACESOURCE-008: ranks a core row among the core rows only, and gives a plugin row no rank at all', () => {
|
|
const rows = [
|
|
{ placeId: 'gers:1' },
|
|
{ placeId: 'node:2' },
|
|
{ placeId: 'plugin:atp:3', place: { osm_id: 'plugin:atp:3' } },
|
|
{ placeId: 'plugin:atp:4', place: { osm_id: 'plugin:atp:4' } },
|
|
]
|
|
expect(corePickRank(rows, rows[1])).toEqual({ rank: 1, count: 2 })
|
|
expect(corePickRank(rows, rows[2])).toBeUndefined()
|
|
expect(corePickRank(rows, { placeId: 'gone' })).toBeUndefined()
|
|
})
|
|
})
|