Fix #288 IPP reads from NAS at LAN speed and feeds user at a much slower speed, causing its buffer to overflow

This commit is contained in:
Alan Grainger
2026-09-03 15:40:38 +12:00
parent 78ff683e8f
commit 24e8228d9f
5 changed files with 260 additions and 14 deletions
+52 -7
View File
@@ -9,6 +9,9 @@ import { Asset, ImageSize, IncomingShareRequest, SharedLink } from '../types'
import { respondToInvalidRequest } from '../invalidRequestHandler'
import { getFilename } from '../gallery/filename'
import { isVideoAsset, resolveDownloadEndpoint, resolveImageEndpoint } from '../gallery/sizing'
import { pipeline } from 'stream/promises'
import { readableFromWeb } from '../utils/webStream'
import { log } from '../utils/log'
/**
* Stream an asset from Immich back to the client.
@@ -19,6 +22,15 @@ import { isVideoAsset, resolveDownloadEndpoint, resolveImageEndpoint } from '../
* to serve them, and the upstream failure surfaces as a client 404.
*/
export async function assetBuffer (req: IncomingShareRequest, res: Response, asset: Asset, size?: ImageSize | string, share?: SharedLink, forceVideoPlayback = false) {
/*
Abort the upstream fetch as soon as the visitor goes away, so a cancelled
download doesn't leave Immich streaming #288.
*/
const upstream = new AbortController()
const onClose = () => { if (!res.writableFinished) upstream.abort() }
res.once('close', onClose)
if (res.closed) onClose()
const headerList = ['content-type', 'content-length', 'last-modified', 'etag']
const fetchHeaders: Record<string, string> = {}
let subpath: string
@@ -66,7 +78,13 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
const url = assetFetchUrl(asset, subpath, sizeQueryParam)
const reqHeaders = await authHeadersForAsset(asset)
const data = await fetch(url, { headers: { ...fetchHeaders, ...reqHeaders } })
let data: globalThis.Response
try {
data = await fetch(url, { headers: { ...fetchHeaders, ...reqHeaders }, signal: upstream.signal })
} catch (e) {
if (upstream.signal.aborted) return // visitor left before Immich answered
throw e
}
if (data.status < 200 || data.status >= 300) {
let immichMessage = ''
@@ -91,10 +109,37 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
const value = data.headers.get(header)
if (value) res.setHeader(header, value)
})
await data.body?.pipeTo(
new WritableStream({
write (chunk) { res.write(chunk) }
})
)
res.end()
// Express routes HEAD through the GET handler and Node silently drops the
// body writes, so without this we'd read the whole file from Immich for
// nothing. The headers above are all a HEAD needs.
if (req.req.method === 'HEAD' || !data.body) {
await data.body?.cancel()
res.end()
return
}
/*
pipeline (rather than a WritableStream sink around res.write) honours
backpressure from `res`: a LAN-speed read from Immich can't pile up in
memory ahead of a slow visitor #288.
*/
try {
await pipeline(readableFromWeb(data.body), res)
} catch (e) {
if (!isClientAbort(e)) {
log.warn(`Stream from Immich failed for asset ${asset.id}: ${e instanceof Error ? e.message : String(e)}`)
}
}
}
/**
* True when a pipeline error means the visitor went away: pipeline saw `res`
* close early (or found it already closed), or our abort signal, fired from
* that same close, reached the fetch body first.
*/
function isClientAbort (e: unknown): boolean {
if (!(e instanceof Error)) return false
const code = (e as NodeJS.ErrnoException).code
return code === 'ERR_STREAM_PREMATURE_CLOSE' || code === 'ERR_STREAM_UNABLE_TO_PIPE' || e.name === 'AbortError'
}