Files
immich-magic-proxy/app/src/client/virtualisation.ts
T
Vignan Posham 06741b47bb Keep loaded gallery thumbnails mounted to stop scroll-back flicker
The gallery virtualiser removed a tile's <a>/<img> from the DOM whenever it
left the viewport ± 1 buffer and rebuilt it from scratch on re-entry, so
scrolling back up replayed the thumbhash placeholder and opacity fade on
thumbnails that were already loaded - even for small albums where no network
fetch happens.

Track tile indices whose <img> has fired `load` in a bounded, LRU-ordered
`stickyTiles` set. virtualize() keeps those tiles in the "needed" set so
syncRendered never unmounts them; not-yet-loaded tiles still get the normal
lazy create/remove + data-src treatment, so large albums keep lazy-loading
on first scroll-into-view.

The set is trimmed to STICKY_TILE_LIMIT (1500) each pass - currently visible
tiles are bumped to most-recently-used and the oldest off-screen overflow is
released back to normal virtualisation - so a very large album (100k+ photos)
cannot accumulate unbounded mounted DOM or retained image memory as the user
scrolls. Cleared on a layout recompute since tile geometry changes there.
Also adds a fast-path skip in loadVisibleTiles() for finished loads now that
the rendered-tile map can be larger.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-07 01:10:23 -04:00

218 lines
7.6 KiB
TypeScript

// Viewport-based tile / header lifecycle. Only tiles within viewport ± 1
// viewport-height buffer exist in the DOM at any moment. The image-src
// lifecycle (lazy load / unload of `img.src`) is part of the same loop.
import {
state,
IMAGE_LOAD_MARGIN_PX,
SCROLL_SETTLE_MS,
BUFFER_VIEWPORTS,
STICKY_TILE_LIMIT,
type HeaderEntry
} from './state.js'
import { computeLayout } from './layout.js'
import { createTile } from './tiles.js'
/**
* Translate the current window viewport into container-relative coordinates
* (so layout entries' absolute `top` values can be compared directly) and
* extend by `BUFFER_VIEWPORTS` worth of viewport height in each direction.
* The buffer is what lets tiles fade in just before they scroll into view
* instead of popping in at the edge.
*/
function getVisibleRange () {
if (!state.container) return { top: 0, bottom: 0 }
const containerTop = state.container.getBoundingClientRect().top
const viewportTopInContainer = -containerTop
const viewportBottomInContainer = viewportTopInContainer + window.innerHeight
const buffer = window.innerHeight * BUFFER_VIEWPORTS
return {
top: viewportTopInContainer - buffer,
bottom: viewportBottomInContainer + buffer
}
}
function createHeader (header: HeaderEntry): HTMLElement {
const el = document.createElement('h2')
el.className = 'group-header'
el.style.top = header.top + 'px'
el.textContent = header.label
return el
}
/**
* Bring the DOM in line with the current visible range: create tiles and
* headers that should now be on screen, remove ones that have scrolled out.
* Idempotent; safe to call multiple times per frame (scroll handler does).
*/
export function virtualize () {
if (!state.container || !state.layout.length) return
const { top, bottom } = getVisibleRange()
// Tiles
const neededTiles = new Set<number>()
for (const l of state.layout) {
if (!l) continue
if (l.top + l.height < top) continue
if (l.top > bottom) break
neededTiles.add(l.index)
}
// Sticky (already-loaded) tiles: keep them in the "needed" set so
// syncRendered never removes them and a scroll-back shows the cached image
// with no flicker. Bounded so a very large album can't grow unbounded DOM:
// 1. bump currently-visible sticky tiles to most-recently-used (set tail),
// 2. evict the oldest overflow that isn't on screen right now,
// 3. union whatever remains into neededTiles (all already rendered, so
// this only blocks removal - it never triggers a re-create).
for (const index of neededTiles) {
if (state.stickyTiles.delete(index)) state.stickyTiles.add(index)
}
if (state.stickyTiles.size > STICKY_TILE_LIMIT) {
let overflow = state.stickyTiles.size - STICKY_TILE_LIMIT
for (const index of state.stickyTiles) {
if (overflow <= 0) break
if (neededTiles.has(index)) continue
state.stickyTiles.delete(index)
overflow--
}
}
for (const index of state.stickyTiles) neededTiles.add(index)
syncRendered(neededTiles, state.renderedTiles, createTile)
// Group headers (when grouping is enabled; headers is empty otherwise)
const neededHeaders = new Set<string>()
for (const h of state.headers) {
if (h.top + h.height < top) continue
if (h.top > bottom) break
neededHeaders.add(h.label)
}
syncRendered(neededHeaders, state.renderedHeaders, (label) => {
const h = state.headers.find(x => x.label === label)
return h ? createHeader(h) : null
})
}
/**
* Reconcile a Map of rendered DOM elements against the set of keys that
* should currently be on screen: remove elements whose key is no longer
* needed, then create + append elements for keys that aren't rendered yet.
*
* The `create` callback may return `null` when the key can't be resolved
* (e.g. a stale header label that no longer matches any layout entry); in
* that case nothing is added for the key and the Map is left alone.
*/
function syncRendered<K> (
needed: Set<K>,
rendered: Map<K, HTMLElement>,
create: (key: K) => HTMLElement | null
): void {
if (!state.container) return
for (const [key, el] of rendered) {
if (!needed.has(key)) {
el.remove()
rendered.delete(key)
}
}
for (const key of needed) {
if (rendered.has(key)) continue
const el = create(key)
if (!el) continue
state.container.appendChild(el)
rendered.set(key, el)
}
}
/**
* Recompute the layout when the container width has actually changed, then
* re-virtualize and load images for the visible range. If the width is the
* same as last time (e.g. a resize fired but the gallery column is unchanged)
* the cached layout is reused and only virtualize runs.
*
* Called from the ResizeObserver in init.ts.
*/
export function computeLayoutAndRender () {
if (!state.container) return
const containerW = state.container.clientWidth
if (containerW <= 0) return
if (containerW === state.lastContainerW) {
virtualize()
return
}
state.lastContainerW = containerW
const result = computeLayout(containerW)
state.layout = result.layout
state.headers = result.headers
state.container.style.height = result.totalHeight + 'px'
for (const [, el] of state.renderedTiles) el.remove()
state.renderedTiles.clear()
for (const [, el] of state.renderedHeaders) el.remove()
state.renderedHeaders.clear()
// Tile positions/sizes have changed, so the old pinned <img> elements are
// gone. Drop the sticky set and let tiles re-pin themselves as they reload
// for the new layout - otherwise the virtualize() below would rebuild every
// previously-seen tile at once.
state.stickyTiles.clear()
virtualize()
loadVisibleTiles()
}
/**
* Walk the currently rendered tiles and toggle their `<img>` src based on
* proximity to the viewport. Tiles within IMAGE_LOAD_MARGIN_PX get their
* `data-src` promoted to `src` (browser fetches the thumbnail); tiles far
* off-screen with an unfinished load have their `src` parked back into
* `data-src` so the browser cancels the fetch.
*
* Run after scroll has settled, not on every scroll tick.
*/
export function loadVisibleTiles () {
if (!state.container) return
const vpHeight = window.innerHeight
const containerTop = state.container.getBoundingClientRect().top
for (const a of state.renderedTiles.values()) {
const img = a.firstElementChild
if (!(img instanceof HTMLImageElement)) continue
// Fast-path: a finished load with no parked data-src has nothing to
// toggle. Matters now that sticky tiles keep this map large.
if (img.complete && img.src && !img.dataset.src) continue
const aTopInVp = containerTop + parseFloat(a.style.top || '0')
const aHeight = parseFloat(a.style.height || '0')
const isFar = aTopInVp + aHeight < -IMAGE_LOAD_MARGIN_PX ||
aTopInVp > vpHeight + IMAGE_LOAD_MARGIN_PX
if (isFar) {
if (img.src && !img.complete) {
img.dataset.src = img.src
img.removeAttribute('src')
}
} else if (img.dataset.src) {
img.src = img.dataset.src
img.removeAttribute('data-src')
}
}
}
let scrollFrame: number | null = null
let loadTimer: ReturnType<typeof setTimeout> | null = null
/**
* Window scroll handler. Coalesces virtualize calls into the next animation
* frame and debounces the more expensive image-src lifecycle by
* SCROLL_SETTLE_MS so we don't thrash `img.src` during fast flings.
*/
export function onScroll () {
if (scrollFrame == null) {
scrollFrame = requestAnimationFrame(() => {
scrollFrame = null
virtualize()
})
}
if (loadTimer) clearTimeout(loadTimer)
loadTimer = setTimeout(() => {
loadTimer = null
loadVisibleTiles()
}, SCROLL_SETTLE_MS)
}