Add nostore to upload healthcheck and fix double-sort

This commit is contained in:
Alan Grainger
2026-10-20 09:39:37 +13:00
parent fc7670157b
commit 6ae80569ff
10 changed files with 115 additions and 68 deletions
+21 -6
View File
@@ -5,7 +5,7 @@ import { resolveImageEndpoint } from './sizing'
/** /**
* Where an asset sits in its share, for the position-based download names of * Where an asset sits in its share, for the position-based download names of
* `downloadedFilename: 2`. Built with `positionInShare` / `findPositionInShare`. * `downloadedFilename: 2`. Built with `positionInShare`, `sharePositions` or `findPositionInShare`.
*/ */
export interface AssetPosition { export interface AssetPosition {
/** The share's key. Only its hash reaches a filename, never the key itself. */ /** The share's key. Only its hash reaches a filename, never the key itself. */
@@ -25,13 +25,28 @@ export function positionInShare (share: SharedLink, index: number): AssetPositio
} }
/** /**
* Look up an asset's position in its share by id. A motion photo's clip takes * Every asset's position in its share, by id, for a caller that looks up many.
* the position of the still it belongs to. Undefined when the id is not in * A motion photo's clip takes the position of the still it belongs to. The
* the share, which `getFilename` treats as "no position". * first asset to claim an id keeps it.
*/
export function sharePositions (share: SharedLink): Map<string, AssetPosition> {
const positions = new Map<string, AssetPosition>()
share.assets.forEach((asset, index) => {
const position = positionInShare(share, index)
for (const id of [asset.id, asset.livePhotoVideoId]) {
if (id && !positions.has(id)) positions.set(id, position)
}
})
return positions
}
/**
* Look up one asset's position in its share by id, as `sharePositions` does.
* Undefined when the id is not in the share, which `getFilename` treats as
* "no position".
*/ */
export function findPositionInShare (share: SharedLink, assetId: string): AssetPosition | undefined { export function findPositionInShare (share: SharedLink, assetId: string): AssetPosition | undefined {
const index = share.assets.findIndex(a => a.id === assetId || a.livePhotoVideoId === assetId) return sharePositions(share).get(assetId)
return index === -1 ? undefined : positionInShare(share, index)
} }
/** `ipp.downloadedFilename` when the operator's config omits it: share hash plus position */ /** `ipp.downloadedFilename` when the operator's config omits it: share hash plus position */
+17 -15
View File
@@ -6,36 +6,38 @@ import type { GroupByDateMode } from '../shared/types'
* when the share is loaded, so the gallery, the zip download and the single * when the share is loaded, so the gallery, the zip download and the single
* download all see the same order and an asset's position is its index. * download all see the same order and an asset's position is its index.
* *
* An album with a sort order is sorted by capture time in that direction. * With date grouping on, sorts by the local timestamp the client buckets on,
* Date grouping then sorts by the local timestamp the client buckets on, so * so buckets stay contiguous. Otherwise an album with a sort order is sorted
* buckets stay contiguous (`dateSortComparator`). * by capture time in that direction, and anything else keeps Immich's order.
* *
* Sorts in place and returns the same array. * Sorts in place and returns the same array.
*/ */
export function displayOrder (assets: Asset[], albumOrder?: string): Asset[] { export function displayOrder (assets: Asset[], albumOrder?: string): Asset[] {
if (albumOrder === 'asc') {
assets.sort((a, b) => a?.fileCreatedAt?.localeCompare(b.fileCreatedAt || '') || 0)
} else if (albumOrder === 'desc') {
assets.sort((a, b) => b?.fileCreatedAt?.localeCompare(a.fileCreatedAt || '') || 0)
}
if (groupByDateMode()) { if (groupByDateMode()) {
assets.sort(dateSortComparator(albumOrder)) assets.sort(dateSortComparator(albumOrder))
} else if (albumOrder === 'asc' || albumOrder === 'desc') {
assets.sort(dateSortComparator(albumOrder, captureTime))
} }
return assets return assets
} }
/** The local timestamp the client's date groups bucket on */
const localTime = (a: Asset) => a.localDateTime || a.fileCreatedAt || ''
/** The capture timestamp in UTC, which Immich sorts an album by */
const captureTime = (a: Asset) => a.fileCreatedAt || ''
/** /**
* Comparator for the date-grouping sort: ascending when the album's order is * Comparator on the timestamp `key` returns: ascending when the album's order
* `'asc'`, otherwise newest-first (individual shares and orderless albums). * is `'asc'`, otherwise newest-first (individual shares and orderless albums).
* Undated assets always sort last regardless of direction, so the client's * Undated assets always sort last regardless of direction, so the client's
* "Undated" group renders at the bottom. * "Undated" group renders at the bottom and the order is consistent.
*/ */
export function dateSortComparator (order?: string): (a: Asset, b: Asset) => number { export function dateSortComparator (order?: string, key: (a: Asset) => string = localTime): (a: Asset, b: Asset) => number {
const ascending = order === 'asc' const ascending = order === 'asc'
const sortKey = (a: Asset) => a.localDateTime || a.fileCreatedAt || ''
return (a, b) => { return (a, b) => {
const ka = sortKey(a) const ka = key(a)
const kb = sortKey(b) const kb = key(b)
if (!ka || !kb) return ka ? -1 : kb ? 1 : 0 // undated always last if (!ka || !kb) return ka ? -1 : kb ? 1 : 0 // undated always last
return ascending ? ka.localeCompare(kb) : kb.localeCompare(ka) return ascending ? ka.localeCompare(kb) : kb.localeCompare(ka)
} }
+4 -4
View File
@@ -19,7 +19,7 @@ import { pipeline } from 'stream/promises'
* or locked assets are handled implicitly: Immich's own endpoints refuse * or locked assets are handled implicitly: Immich's own endpoints refuse
* to serve them, and the upstream failure surfaces as a client 404. * 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) { export async function assetBuffer (req: IncomingShareRequest, res: Response, asset: Asset, size: ImageSize | string | undefined, share: SharedLink, forceVideoPlayback = false) {
// A cancelled download must not leave Immich streaming #288 // A cancelled download must not leave Immich streaming #288
const upstream = abortOnClose(res) const upstream = abortOnClose(res)
@@ -31,7 +31,7 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
let servedSize: ImageSize | undefined let servedSize: ImageSize | undefined
const requested = validateImageSize(size) const requested = validateImageSize(size)
const useVideoPlayback = forceVideoPlayback || (isVideoAsset(asset) && requested === ImageSize.original && share?.allowDownload === false) const useVideoPlayback = forceVideoPlayback || (isVideoAsset(asset) && requested === ImageSize.original && share.allowDownload === false)
if (useVideoPlayback) { if (useVideoPlayback) {
subpath = '/video/playback' subpath = '/video/playback'
@@ -60,7 +60,7 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
if (detail?.originalMimeType) asset = { ...asset, originalMimeType: detail.originalMimeType } if (detail?.originalMimeType) asset = { ...asset, originalMimeType: detail.originalMimeType }
} }
const endpoint = requested === ImageSize.original const endpoint = requested === ImageSize.original
? resolveDownloadEndpoint(asset, share?.allowDownload !== false) ? resolveDownloadEndpoint(asset, share.allowDownload !== false)
: resolveImageEndpoint(requested, asset) : resolveImageEndpoint(requested, asset)
subpath = endpoint.subpath subpath = endpoint.subpath
sizeQueryParam = endpoint.sizeQueryParam sizeQueryParam = endpoint.sizeQueryParam
@@ -95,7 +95,7 @@ export async function assetBuffer (req: IncomingShareRequest, res: Response, ass
// Always an attachment, so an SVG can't render inline. Album assets have // Always an attachment, so an SVG can't render inline. Album assets have
// no originalFileName; Immich's own Content-Disposition carries it. // no originalFileName; Immich's own Content-Disposition carries it.
const named = asset.originalFileName ? asset : enrichFromHeaders(asset, data) const named = asset.originalFileName ? asset : enrichFromHeaders(asset, data)
const position = share && findPositionInShare(share, asset.id) const position = findPositionInShare(share, asset.id)
res.setHeader('Content-Disposition', attachmentDisposition(getFilename(named, servedSize, servedMimeFrom(subpath, data), position))) res.setHeader('Content-Disposition', attachmentDisposition(getFilename(named, servedSize, servedMimeFrom(subpath, data), position)))
} }
headerList.forEach(header => { headerList.forEach(header => {
+5 -5
View File
@@ -3,7 +3,7 @@ import { assetFetchUrl, authHeadersForAsset } from '../immich'
import { Response } from 'express-serve-static-core' import { Response } from 'express-serve-static-core'
import archiver, { Archiver } from 'archiver' import archiver, { Archiver } from 'archiver'
import { resolveDownloadEndpoint, ImageEndpoint } from '../gallery/sizing' import { resolveDownloadEndpoint, ImageEndpoint } from '../gallery/sizing'
import { AssetPosition, attachmentDisposition, enrichFromHeaders, findPositionInShare, getFilename, servedMimeFrom } from '../gallery/filename' import { AssetPosition, attachmentDisposition, enrichFromHeaders, getFilename, servedMimeFrom, sharePositions } from '../gallery/filename'
/** Attempts to get response headers from Immich for one asset before giving up. */ /** Attempts to get response headers from Immich for one asset before giving up. */
const MAX_ATTEMPTS = 3 const MAX_ATTEMPTS = 3
@@ -77,10 +77,12 @@ export async function downloadAssets (res: Response, share: SharedLink, assets:
// Headers and piping are deferred until the first asset has arrived, so a // Headers and piping are deferred until the first asset has arrived, so a
// failure before then can still be answered with a normal error response. // failure before then can still be answered with a normal error response.
let piped = false let piped = false
// A multi-select download keeps each asset's position in the whole share
const positions = sharePositions(share)
for (const asset of assets) { for (const asset of assets) {
if (controller.signal.aborted) break if (controller.signal.aborted) break
const fetched = await fetchOne(share, asset, controller.signal) const fetched = await fetchOne(share, asset, positions.get(asset.id), controller.signal)
if (fetched === null) break // aborted while waiting on Immich if (fetched === null) break // aborted while waiting on Immich
if ('failure' in fetched) { if ('failure' in fetched) {
if (!piped) { if (!piped) {
@@ -196,7 +198,7 @@ function teardownArchive (archive: Archiver, res: Response) {
* Returns the fetched asset on success, a wrapped Failure on error, or null * Returns the fetched asset on success, a wrapped Failure on error, or null
* if the download was aborted before we got an answer. * if the download was aborted before we got an answer.
*/ */
async function fetchOne (share: SharedLink, asset: Asset, signal: AbortSignal): Promise<FetchOutcome> { async function fetchOne (share: SharedLink, asset: Asset, position: AssetPosition | undefined, signal: AbortSignal): Promise<FetchOutcome> {
if (signal.aborted) return null if (signal.aborted) return null
const endpoint = resolveDownloadEndpoint(asset, share.allowDownload !== false) const endpoint = resolveDownloadEndpoint(asset, share.allowDownload !== false)
@@ -213,8 +215,6 @@ async function fetchOne (share: SharedLink, asset: Asset, signal: AbortSignal):
// so recover them from the headers we already fetched - no extra calls. // so recover them from the headers we already fetched - no extra calls.
const namedAsset = asset.originalFileName ? asset : enrichFromHeaders(asset, fetched.response) const namedAsset = asset.originalFileName ? asset : enrichFromHeaders(asset, fetched.response)
// A multi-select download keeps each asset's position in the whole share
const position = findPositionInShare(share, asset.id)
return { response: fetched.response, asset: namedAsset, endpoint, servedMime: servedMimeFrom(endpoint.subpath, fetched.response), url, position } return { response: fetched.response, asset: namedAsset, endpoint, servedMime: servedMimeFrom(endpoint.subpath, fetched.response), url, position }
} }
+26 -12
View File
@@ -1,5 +1,5 @@
import { describe, it, expect, vi, afterEach } from 'vitest' import { describe, it, expect, vi, afterEach } from 'vitest'
import { Asset, AssetType, KeyType, loadConfig } from '@ipp/core' import { Asset, AssetType, KeyType, loadConfig, SharedLink } from '@ipp/core'
import { Writable } from 'stream' import { Writable } from 'stream'
import type { Request, Response } from 'express-serve-static-core' import type { Request, Response } from 'express-serve-static-core'
import { assetBuffer } from '../src/stream/asset' import { assetBuffer } from '../src/stream/asset'
@@ -28,6 +28,11 @@ const asset: Asset = {
originalMimeType: 'image/jpeg' originalMimeType: 'image/jpeg'
} }
/** A share holding just `item`, which every streamed asset belongs to. */
function shareOf (item: Asset): SharedLink {
return { key: 'testkey', keyType: KeyType.key, type: 'INDIVIDUAL', assets: [item] }
}
function makeRequest (method = 'GET'): IncomingShareRequest { function makeRequest (method = 'GET'): IncomingShareRequest {
return { req: { method } as Request, key: 'testkey', range: '' } return { req: { method } as Request, key: 'testkey', range: '' }
} }
@@ -117,10 +122,11 @@ function newSource (): Source {
describe('assetBuffer streaming', () => { describe('assetBuffer streaming', () => {
it('delivers the whole body and forwards upstream headers', async () => { it('delivers the whole body and forwards upstream headers', async () => {
setConfig({ ipp: { downloadedFilename: 0 } })
const source = newSource() const source = newSource()
vi.stubGlobal('fetch', pullFetch(4 * CHUNK, source)) vi.stubGlobal('fetch', pullFetch(4 * CHUNK, source))
const res = new FakeRes() const res = new FakeRes()
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(res.received).toBe(4 * CHUNK) expect(res.received).toBe(4 * CHUNK)
expect(res.writableFinished).toBe(true) expect(res.writableFinished).toBe(true)
expect(res.headers['content-type']).toBe('image/jpeg') expect(res.headers['content-type']).toBe('image/jpeg')
@@ -129,6 +135,13 @@ describe('assetBuffer streaming', () => {
expect(res.headers['x-accel-buffering']).toBe('no') expect(res.headers['x-accel-buffering']).toBe('no')
}) })
it('names a download by its position in the share by default', async () => {
vi.stubGlobal('fetch', pullFetch(CHUNK, newSource()))
const res = new FakeRes()
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(res.headers['content-disposition']).toMatch(/''[0-9a-f]{8}_001\.jpg$/)
})
it('applies backpressure so upstream is read no faster than the visitor drains it', async () => { it('applies backpressure so upstream is read no faster than the visitor drains it', async () => {
// Issue #288: a fast NAS read against a slow visitor used to buffer the // Issue #288: a fast NAS read against a slow visitor used to buffer the
// whole file in memory. Track how far ahead of the sink the source gets. // whole file in memory. Track how far ahead of the sink the source gets.
@@ -142,7 +155,7 @@ describe('assetBuffer streaming', () => {
maxOutstanding = Math.max(maxOutstanding, source.pulled - res.received) maxOutstanding = Math.max(maxOutstanding, source.pulled - res.received)
origWrite(chunk, enc, cb) origWrite(chunk, enc, cb)
} }
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(res.received).toBe(total) expect(res.received).toBe(total)
expect(maxOutstanding).toBeLessThan(1024 * 1024) expect(maxOutstanding).toBeLessThan(1024 * 1024)
}, 20_000) }, 20_000)
@@ -160,7 +173,7 @@ describe('assetBuffer streaming', () => {
setImmediate(() => res.destroy(new Error('client aborted'))) setImmediate(() => res.destroy(new Error('client aborted')))
} }
} }
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(source.cancelled || source.signals[0].aborted).toBe(true) expect(source.cancelled || source.signals[0].aborted).toBe(true)
// Upstream must stop shortly after the disconnect, not run to infinity // Upstream must stop shortly after the disconnect, not run to infinity
expect(source.pulled).toBeLessThan(1024 * 1024) expect(source.pulled).toBeLessThan(1024 * 1024)
@@ -171,7 +184,7 @@ describe('assetBuffer streaming', () => {
vi.stubGlobal('fetch', pullFetch(Infinity, source, 200)) vi.stubGlobal('fetch', pullFetch(Infinity, source, 200))
const res = new FakeRes() const res = new FakeRes()
setTimeout(() => res.destroy(new Error('client aborted')), 20) setTimeout(() => res.destroy(new Error('client aborted')), 20)
await expect(assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original)).resolves.toBeUndefined() await expect(assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))).resolves.toBeUndefined()
expect(source.signals[0].aborted).toBe(true) expect(source.signals[0].aborted).toBe(true)
expect(source.pulled).toBe(0) expect(source.pulled).toBe(0)
expect(res.received).toBe(0) expect(res.received).toBe(0)
@@ -182,7 +195,7 @@ describe('assetBuffer streaming', () => {
vi.stubGlobal('fetch', pullFetch(Infinity, source, 50)) vi.stubGlobal('fetch', pullFetch(Infinity, source, 50))
const res = new FakeRes() const res = new FakeRes()
res.destroy() res.destroy()
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(source.signals[0].aborted).toBe(true) expect(source.signals[0].aborted).toBe(true)
expect(source.pulled).toBe(0) expect(source.pulled).toBe(0)
}) })
@@ -191,7 +204,7 @@ describe('assetBuffer streaming', () => {
const source = newSource() const source = newSource()
vi.stubGlobal('fetch', pullFetch(4 * CHUNK, source)) vi.stubGlobal('fetch', pullFetch(4 * CHUNK, source))
const res = new FakeRes() const res = new FakeRes()
await assetBuffer(makeRequest('HEAD'), asResponse(res), asset, ImageSize.original) await assetBuffer(makeRequest('HEAD'), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(res.writableEnded).toBe(true) expect(res.writableEnded).toBe(true)
expect(res.received).toBe(0) expect(res.received).toBe(0)
expect(source.cancelled).toBe(true) expect(source.cancelled).toBe(true)
@@ -199,7 +212,7 @@ describe('assetBuffer streaming', () => {
}) })
it('names a WebP preview download .webp', async () => { it('names a WebP preview download .webp', async () => {
setConfig({ ipp: { maxDownloadQuality: 'preview' } }) setConfig({ ipp: { maxDownloadQuality: 'preview', downloadedFilename: 0 } })
vi.stubGlobal('fetch', vi.fn(async () => new globalThis.Response( vi.stubGlobal('fetch', vi.fn(async () => new globalThis.Response(
new ReadableStream({ new ReadableStream({
start (controller) { controller.enqueue(new Uint8Array(1024)); controller.close() } start (controller) { controller.enqueue(new Uint8Array(1024)); controller.close() }
@@ -207,7 +220,7 @@ describe('assetBuffer streaming', () => {
{ status: 200, headers: { 'content-type': 'image/webp', 'content-length': '1024' } } { status: 200, headers: { 'content-type': 'image/webp', 'content-length': '1024' } }
))) )))
const res = new FakeRes() const res = new FakeRes()
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.original, shareOf(asset))
expect(res.headers['content-disposition']).toContain('a1.webp') expect(res.headers['content-disposition']).toContain('a1.webp')
expect(res.headers['content-type']).toBe('image/webp') expect(res.headers['content-type']).toBe('image/webp')
}) })
@@ -227,15 +240,16 @@ describe('assetBuffer streaming', () => {
setConfig({ ipp: { downloadedFilename: 0 } }) setConfig({ ipp: { downloadedFilename: 0 } })
vi.stubGlobal('fetch', svgFetch({ 'content-disposition': 'attachment; filename="drawing.svg"' })) vi.stubGlobal('fetch', svgFetch({ 'content-disposition': 'attachment; filename="drawing.svg"' }))
const res = new FakeRes() const res = new FakeRes()
await assetBuffer(makeRequest(), asResponse(res), albumAsset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), albumAsset, ImageSize.original, shareOf(albumAsset))
expect(res.headers['content-disposition']).toBe("attachment; filename*=UTF-8''drawing.svg") expect(res.headers['content-disposition']).toBe("attachment; filename*=UTF-8''drawing.svg")
expect(res.headers['x-content-type-options']).toBe('nosniff') expect(res.headers['x-content-type-options']).toBe('nosniff')
}) })
it('falls back to the asset id when Immich sends no filename', async () => { it('falls back to the asset id when Immich sends no filename', async () => {
setConfig({ ipp: { downloadedFilename: 0 } })
vi.stubGlobal('fetch', svgFetch({})) vi.stubGlobal('fetch', svgFetch({}))
const res = new FakeRes() const res = new FakeRes()
await assetBuffer(makeRequest(), asResponse(res), albumAsset, ImageSize.original) await assetBuffer(makeRequest(), asResponse(res), albumAsset, ImageSize.original, shareOf(albumAsset))
expect(res.headers['content-disposition']).toBe("attachment; filename*=UTF-8''a2.svg") expect(res.headers['content-disposition']).toBe("attachment; filename*=UTF-8''a2.svg")
}) })
}) })
@@ -243,7 +257,7 @@ describe('assetBuffer streaming', () => {
it('serves display sizes inline, still with nosniff', async () => { it('serves display sizes inline, still with nosniff', async () => {
vi.stubGlobal('fetch', pullFetch(CHUNK, newSource())) vi.stubGlobal('fetch', pullFetch(CHUNK, newSource()))
const res = new FakeRes() const res = new FakeRes()
await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.preview) await assetBuffer(makeRequest(), asResponse(res), asset, ImageSize.preview, shareOf(asset))
expect(res.headers['content-disposition']).toBeUndefined() expect(res.headers['content-disposition']).toBeUndefined()
expect(res.headers['x-content-type-options']).toBe('nosniff') expect(res.headers['x-content-type-options']).toBe('nosniff')
}) })
+9 -3
View File
@@ -3,9 +3,9 @@ import { Asset, AssetType, KeyType, loadConfig } from '@ipp/core'
import { dateSortComparator, displayOrder } from '../src/gallery/order' import { dateSortComparator, displayOrder } from '../src/gallery/order'
/* /*
The date-grouping sort must follow the album's own order while The date sort must follow the album's own order while keeping undated
keeping undated assets last in BOTH directions. displayOrder applies it, assets last in BOTH directions. displayOrder sorts once: by local time when
after the album's own sort, when `gallery.groupByDate` is on. `gallery.groupByDate` is on, else by capture time in the album's order.
*/ */
afterEach(() => { afterEach(() => {
@@ -84,6 +84,12 @@ describe('displayOrder', () => {
expect(ids(displayOrder(album(), 'desc'))).toEqual(['b', 'a', 'c']) expect(ids(displayOrder(album(), 'desc'))).toEqual(['b', 'a', 'c'])
}) })
it('puts undated assets last in an album sort', () => {
const withUndated = () => [dated('a', '2024-02-01T10:00:00.000Z'), { ...asset(), id: 'u' }, dated('c', '2024-01-01T10:00:00.000Z')]
expect(ids(displayOrder(withUndated(), 'asc'))).toEqual(['c', 'a', 'u'])
expect(ids(displayOrder(withUndated(), 'desc'))).toEqual(['a', 'c', 'u'])
})
it('sorts by local time when date grouping is on, so buckets stay contiguous', () => { it('sorts by local time when date grouping is on, so buckets stay contiguous', () => {
process.env.CONFIG = JSON.stringify({ ipp: { gallery: { groupByDate: 'day' } } }) process.env.CONFIG = JSON.stringify({ ipp: { gallery: { groupByDate: 'day' } } })
loadConfig() loadConfig()
+3 -1
View File
@@ -38,10 +38,12 @@ export function abortOnClose (res: Response): AbortSignal {
} }
/** /**
* A `GET /healthcheck` handler: `body` while Immich answers, else 503. * A `GET /healthcheck` handler: `body` while Immich answers, else 503. Never
* cached, so a browser or CDN can't answer for a service that has gone.
*/ */
export function healthcheckHandler (body: string) { export function healthcheckHandler (body: string) {
return async (_req: Request, res: Response): Promise<void> => { return async (_req: Request, res: Response): Promise<void> => {
addNoStoreHeaders(res)
if (await accessible()) { if (await accessible()) {
res.send(body) res.send(body)
} else { } else {
+11 -1
View File
@@ -10,8 +10,9 @@ import * as client from '../src/immich/client'
*/ */
function response () { function response () {
const res = { body: undefined as string | undefined, code: 200 } const res = { body: undefined as string | undefined, code: 200, headers: {} as Record<string, string> }
return Object.assign(res, { return Object.assign(res, {
set (name: string, value: string) { res.headers[name] = value; return res },
send (body?: string) { res.body = body; return res }, send (body?: string) { res.body = body; return res },
status (code: number) { res.code = code; return res } status (code: number) { res.code = code; return res }
}) })
@@ -36,6 +37,15 @@ describe('healthcheckHandler', () => {
expect(res.body).toBeUndefined() expect(res.body).toBeUndefined()
}) })
it('is never cached, up or down', async () => {
for (const up of [true, false]) {
vi.spyOn(client, 'accessible').mockResolvedValue(up)
const res = response()
await healthcheckHandler('upload-ok')({} as never, res as never)
expect(res.headers['Cache-Control']).toContain('no-store')
}
})
it("is IPP's own healthcheck with `ok`", async () => { it("is IPP's own healthcheck with `ok`", async () => {
vi.spyOn(client, 'accessible').mockResolvedValue(true) vi.spyOn(client, 'accessible').mockResolvedValue(true)
const res = response() const res = response()
+1 -4
View File
@@ -79,10 +79,7 @@ function bodyDeadline (ms: number): RequestHandler {
IPP answers `ok`, so the owner can tell which service a route reached. IPP answers `ok`, so the owner can tell which service a route reached.
*/ */
const healthcheck = healthcheckHandler('upload-ok') const healthcheck = healthcheckHandler('upload-ok')
app.get(['/healthcheck', '/share/healthcheck'], (_req, res, next) => { app.get(['/healthcheck', '/share/healthcheck'], asyncHandler(healthcheck))
addNoStoreHeaders(res)
next()
}, asyncHandler(healthcheck))
const router = Router() const router = Router()
+18 -17
View File
@@ -49,18 +49,8 @@ export interface TagOptions {
print: (line: string) => void print: (line: string) => void
} }
/** What `tagUploads` found and did. */
export interface TagSummary {
/** Asset IDs per visitor name. */
named: Map<string, string[]>
anonymous: number
unreadable: number
/** Assets that got a tag they did not have. Always 0 in a dry run. */
tagged: number
}
/** The fields of an Immich `AssetResponseDto` that the script reads. */ /** The fields of an Immich `AssetResponseDto` that the script reads. */
interface Asset { export interface Asset {
id: string id: string
ownerId: string ownerId: string
originalFileName: string originalFileName: string
@@ -68,6 +58,16 @@ interface Asset {
isTrashed: boolean isTrashed: boolean
} }
/** What `tagUploads` found and did. */
export interface TagSummary {
/** Uploads per visitor name. */
named: Map<string, Asset[]>
anonymous: number
unreadable: number
/** Assets that got a tag they did not have. Always 0 in a dry run. */
tagged: number
}
/** A failed Immich call, with a message fit for the owner. */ /** A failed Immich call, with a message fit for the owner. */
export class ImmichError extends Error {} export class ImmichError extends Error {}
@@ -136,7 +136,6 @@ function files (count: number): string {
export async function tagUploads (options: TagOptions): Promise<TagSummary> { export async function tagUploads (options: TagOptions): Promise<TagSummary> {
const { apiKey, apply, parent, prefix, separator, print } = options const { apiKey, apply, parent, prefix, separator, print } = options
const summary: TagSummary = { named: new Map(), anonymous: 0, unreadable: 0, tagged: 0 } const summary: TagSummary = { named: new Map(), anonymous: 0, unreadable: 0, tagged: 0 }
const fileNames = new Map<string, string[]>()
const uploads = await findUploads(apiKey, prefix) const uploads = await findUploads(apiKey, prefix)
print('Found ' + files(uploads.length) + ' starting with "' + prefix + '".') print('Found ' + files(uploads.length) + ' starting with "' + prefix + '".')
@@ -148,8 +147,9 @@ export async function tagUploads (options: TagOptions): Promise<TagSummary> {
summary.unreadable++ summary.unreadable++
print('Skipped ' + asset.originalFileName + ': ' + stored.reason + '.') print('Skipped ' + asset.originalFileName + ': ' + stored.reason + '.')
} else { } else {
summary.named.set(stored.uploader, [...(summary.named.get(stored.uploader) || []), asset.id]) const named = summary.named.get(stored.uploader)
fileNames.set(stored.uploader, [...(fileNames.get(stored.uploader) || []), asset.originalFileName]) if (named) named.push(asset)
else summary.named.set(stored.uploader, [asset])
} }
} }
@@ -164,13 +164,14 @@ export async function tagUploads (options: TagOptions): Promise<TagSummary> {
print('') print('')
for (const name of names) { for (const name of names) {
const ids = summary.named.get(name) || [] const sent = summary.named.get(name) || []
const tag = parent + '/' + name const tag = parent + '/' + name
if (!apply) { if (!apply) {
print(tag + ': ' + files(ids.length)) print(tag + ': ' + files(sent.length))
for (const fileName of (fileNames.get(name) || []).sort()) print(' ' + fileName) for (const fileName of sent.map(asset => asset.originalFileName).sort()) print(' ' + fileName)
continue continue
} }
const ids = sent.map(asset => asset.id)
const tagId = tagIds.get(tag) const tagId = tagIds.get(tag)
if (!tagId) throw new ImmichError('Immich did not return the tag ' + tag) if (!tagId) throw new ImmichError('Immich did not return the tag ' + tag)
let added = 0 let added = 0