Better error handling, and handling of numeric config options
This commit is contained in:
@@ -17,3 +17,12 @@ export function getConfigOption (path: string, defaultOption?: unknown) {
|
|||||||
}
|
}
|
||||||
return value
|
return value
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read a configuration option that must be a finite number. Non-numeric
|
||||||
|
* values fall back to `defaultOption` instead of propagating `NaN`.
|
||||||
|
*/
|
||||||
|
export function getNumericConfigOption (path: string, defaultOption: number): number {
|
||||||
|
const value = Number(getConfigOption(path, defaultOption))
|
||||||
|
return Number.isFinite(value) ? value : defaultOption
|
||||||
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import {
|
|||||||
} from '../immich'
|
} from '../immich'
|
||||||
import { Response } from 'express-serve-static-core'
|
import { Response } from 'express-serve-static-core'
|
||||||
import { AssetType, ImageSize, SharedLink } from '../types'
|
import { AssetType, ImageSize, SharedLink } from '../types'
|
||||||
import { getConfigOption } from '../config/access'
|
import { getConfigOption, getNumericConfigOption } from '../config/access'
|
||||||
import { canDownload, expiryDate, title } from '../share'
|
import { canDownload, expiryDate, title } from '../share'
|
||||||
import { toString } from '../utils/text'
|
import { toString } from '../utils/text'
|
||||||
import { h } from 'preact'
|
import { h } from 'preact'
|
||||||
@@ -164,8 +164,7 @@ export async function gallery (res: Response, share: SharedLink, openItem?: numb
|
|||||||
}
|
}
|
||||||
|
|
||||||
// HTML gallery page cache time
|
// HTML gallery page cache time
|
||||||
const configured = Number(getConfigOption('ipp.gallery.cacheTime', 300))
|
const cacheTime = Math.max(0, getNumericConfigOption('ipp.gallery.cacheTime', 300))
|
||||||
const cacheTime = Number.isFinite(configured) ? Math.max(0, configured) : 300
|
|
||||||
res.header('Cache-Control', 'public, max-age=' + cacheTime)
|
res.header('Cache-Control', 'public, max-age=' + cacheTime)
|
||||||
res.send(renderPage(h(Gallery, props)))
|
res.send(renderPage(h(Gallery, props)))
|
||||||
}
|
}
|
||||||
|
|||||||
+27
-1
@@ -1,5 +1,7 @@
|
|||||||
import { Response } from 'express-serve-static-core'
|
import { NextFunction, Request, Response } from 'express-serve-static-core'
|
||||||
import { getConfigOption } from './config/access'
|
import { getConfigOption } from './config/access'
|
||||||
|
import { respondToInvalidRequest } from './invalidRequestHandler'
|
||||||
|
import { log } from './utils/log'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Apply the response headers configured under `ipp.responseHeaders` to the
|
* Apply the response headers configured under `ipp.responseHeaders` to the
|
||||||
@@ -12,3 +14,27 @@ export function addResponseHeaders (res: Response): void {
|
|||||||
res.set(header, value)
|
res.set(header, value)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wrap an async route handler so a rejected promise is passed to Express's
|
||||||
|
* error chain (and on to `errorHandler`).
|
||||||
|
*/
|
||||||
|
export function asyncHandler (fn: (req: Request, res: Response, next: NextFunction) => Promise<unknown>) {
|
||||||
|
return (req: Request, res: Response, next: NextFunction): void => {
|
||||||
|
fn(req, res, next).catch(next)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Terminal Express error middleware. Logs the error server-side, then applies the
|
||||||
|
* same privacy policy as any other invalid request.
|
||||||
|
*/
|
||||||
|
export function errorHandler (err: unknown, req: Request, res: Response, _next: NextFunction): void {
|
||||||
|
log.error('Error handling ' + req.method + ' ' + req.path + ' - ' +
|
||||||
|
(err instanceof Error ? (err.stack || err.message) : String(err)))
|
||||||
|
if (res.headersSent) {
|
||||||
|
res.end()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
respondToInvalidRequest(res, 404, 'Unhandled error for ' + req.path)
|
||||||
|
}
|
||||||
|
|||||||
+24
-16
@@ -22,7 +22,7 @@ import { NextFunction, Request, Response } from 'express-serve-static-core'
|
|||||||
import { Asset, AssetType, ImageSize, KeyType, SharedLink } from './types'
|
import { Asset, AssetType, ImageSize, KeyType, SharedLink } from './types'
|
||||||
import { getConfigOption } from './config/access'
|
import { getConfigOption } from './config/access'
|
||||||
import { loadConfig } from './config/loader'
|
import { loadConfig } from './config/loader'
|
||||||
import { addResponseHeaders } from './http'
|
import { addResponseHeaders, asyncHandler, errorHandler } from './http'
|
||||||
import { canDownload } from './share'
|
import { canDownload } from './share'
|
||||||
import { toString } from './utils/text'
|
import { toString } from './utils/text'
|
||||||
import { decrypt, encrypt } from './encrypt'
|
import { decrypt, encrypt } from './encrypt'
|
||||||
@@ -140,18 +140,18 @@ async function resolveSharedAsset (req: Request, keyType: KeyType): Promise<Shar
|
|||||||
* [ROUTE] Healthcheck
|
* [ROUTE] Healthcheck
|
||||||
* The path matches for /share/healthcheck, and also the legacy /healthcheck
|
* The path matches for /share/healthcheck, and also the legacy /healthcheck
|
||||||
*/
|
*/
|
||||||
app.get(/^(|\/share)\/healthcheck$/, async (_req, res) => {
|
app.get(/^(|\/share)\/healthcheck$/, asyncHandler(async (_req, res) => {
|
||||||
if (await accessible()) {
|
if (await accessible()) {
|
||||||
res.send('ok')
|
res.send('ok')
|
||||||
} else {
|
} else {
|
||||||
res.status(503).send()
|
res.status(503).send()
|
||||||
}
|
}
|
||||||
})
|
}))
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* [ROUTE] This is the main URL that someone would visit if they are opening a shared link
|
* [ROUTE] This is the main URL that someone would visit if they are opening a shared link
|
||||||
*/
|
*/
|
||||||
app.get('/:shareType(share|s)/:key/:mode(download)?', decodeCookie, async (req, res) => {
|
app.get('/:shareType(share|s)/:key/:mode(download)?', decodeCookie, asyncHandler(async (req, res) => {
|
||||||
const keyType = getKeyTypeFromShare(req.params.shareType)
|
const keyType = getKeyTypeFromShare(req.params.shareType)
|
||||||
|
|
||||||
if (keyType === KeyType.slug && !getConfigOption('ipp.allowSlugLinks', true)) {
|
if (keyType === KeyType.slug && !getConfigOption('ipp.allowSlugLinks', true)) {
|
||||||
@@ -166,7 +166,7 @@ app.get('/:shareType(share|s)/:key/:mode(download)?', decodeCookie, async (req,
|
|||||||
password: req.password
|
password: req.password
|
||||||
}, res)
|
}, res)
|
||||||
}
|
}
|
||||||
})
|
}))
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* [ROUTE] Receive an unlock request from the password page
|
* [ROUTE] Receive an unlock request from the password page
|
||||||
@@ -177,7 +177,7 @@ app.get('/:shareType(share|s)/:key/:mode(download)?', decodeCookie, async (req,
|
|||||||
* managing user session data. The data is provided to the server by the
|
* managing user session data. The data is provided to the server by the
|
||||||
* user's browser in its encrypted state.
|
* user's browser in its encrypted state.
|
||||||
*/
|
*/
|
||||||
app.post('/share/unlock', async (req, res) => {
|
app.post('/share/unlock', asyncHandler(async (req, res) => {
|
||||||
if (req.session && req.body.key) {
|
if (req.session && req.body.key) {
|
||||||
req.session[req.body.key] = encrypt(JSON.stringify({
|
req.session[req.body.key] = encrypt(JSON.stringify({
|
||||||
password: req.body.password,
|
password: req.body.password,
|
||||||
@@ -185,7 +185,7 @@ app.post('/share/unlock', async (req, res) => {
|
|||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
res.send()
|
res.send()
|
||||||
})
|
}))
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* [ROUTE] Selective download - POST a list of asset IDs, get a zip of just those.
|
* [ROUTE] Selective download - POST a list of asset IDs, get a zip of just those.
|
||||||
@@ -193,7 +193,7 @@ app.post('/share/unlock', async (req, res) => {
|
|||||||
* Validates each ID against share.assets so the request can't pull anything
|
* Validates each ID against share.assets so the request can't pull anything
|
||||||
* outside the share.
|
* outside the share.
|
||||||
*/
|
*/
|
||||||
app.post('/:shareType(share|s)/:key/download', decodeCookie, async (req, res) => {
|
app.post('/:shareType(share|s)/:key/download', decodeCookie, asyncHandler(async (req, res) => {
|
||||||
const keyType = getKeyTypeFromShare(req.params.shareType)
|
const keyType = getKeyTypeFromShare(req.params.shareType)
|
||||||
let requestedIds: unknown
|
let requestedIds: unknown
|
||||||
try {
|
try {
|
||||||
@@ -225,7 +225,7 @@ app.post('/:shareType(share|s)/:key/download', decodeCookie, async (req, res) =>
|
|||||||
}
|
}
|
||||||
|
|
||||||
await downloadAssets(res, resolved.link, validAssets)
|
await downloadAssets(res, resolved.link, validAssets)
|
||||||
})
|
}))
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* [ROUTE] Catch accidental POST requests to share URLs (e.g. from browser history
|
* [ROUTE] Catch accidental POST requests to share URLs (e.g. from browser history
|
||||||
@@ -239,7 +239,7 @@ app.post('/:shareType(share|s)/:key/:mode(download)?', (req, res) => {
|
|||||||
/*
|
/*
|
||||||
* [ROUTE] This is the direct link to a photo or video asset
|
* [ROUTE] This is the direct link to a photo or video asset
|
||||||
*/
|
*/
|
||||||
app.get('/share/:type(photo|video)/:key/:id/:size?', decodeCookie, async (req, res) => {
|
app.get('/share/:type(photo|video)/:key/:id/:size?', decodeCookie, asyncHandler(async (req, res) => {
|
||||||
// Add the headers configured in config.json (most likely `cache-control`)
|
// Add the headers configured in config.json (most likely `cache-control`)
|
||||||
addResponseHeaders(res)
|
addResponseHeaders(res)
|
||||||
|
|
||||||
@@ -274,8 +274,8 @@ app.get('/share/:type(photo|video)/:key/:id/:size?', decodeCookie, async (req, r
|
|||||||
key: req.params.key,
|
key: req.params.key,
|
||||||
range: req.headers.range || ''
|
range: req.headers.range || ''
|
||||||
}
|
}
|
||||||
assetBuffer(request, res, asset, req.params.size).then()
|
await assetBuffer(request, res, asset, req.params.size)
|
||||||
})
|
}))
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* [ROUTE] On-demand per-asset metadata for lazy album items.
|
* [ROUTE] On-demand per-asset metadata for lazy album items.
|
||||||
@@ -286,7 +286,7 @@ app.get('/share/:type(photo|video)/:key/:id/:size?', decodeCookie, async (req, r
|
|||||||
* validated against the share's asset set (defence in depth - Immich also
|
* validated against the share's asset set (defence in depth - Immich also
|
||||||
* enforces this via the share key) before we fetch `GET /assets/:id`.
|
* enforces this via the share key) before we fetch `GET /assets/:id`.
|
||||||
*/
|
*/
|
||||||
app.get('/:shareType(share|s)/meta/:key/:id', decodeCookie, async (req, res) => {
|
app.get('/:shareType(share|s)/meta/:key/:id', decodeCookie, asyncHandler(async (req, res) => {
|
||||||
addResponseHeaders(res)
|
addResponseHeaders(res)
|
||||||
|
|
||||||
const resolved = await resolveSharedAsset(req, getKeyTypeFromShare(req.params.shareType))
|
const resolved = await resolveSharedAsset(req, getKeyTypeFromShare(req.params.shareType))
|
||||||
@@ -302,7 +302,7 @@ app.get('/:shareType(share|s)/meta/:key/:id', decodeCookie, async (req, res) =>
|
|||||||
}
|
}
|
||||||
|
|
||||||
res.json(buildAssetMetadata(detail, resolved.link))
|
res.json(buildAssetMetadata(detail, resolved.link))
|
||||||
})
|
}))
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* [ROUTE] Home page
|
* [ROUTE] Home page
|
||||||
@@ -327,6 +327,13 @@ app.get('*', (req, res) => {
|
|||||||
respondToInvalidRequest(res, 404, 'Invalid route ' + req.path)
|
respondToInvalidRequest(res, 404, 'Invalid route ' + req.path)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Terminal error middleware: any throw/rejection inside a route (routed here
|
||||||
|
* by asyncHandler) is logged and answered per the 404 privacy policy, instead
|
||||||
|
* of escaping to process level.
|
||||||
|
*/
|
||||||
|
app.use(errorHandler)
|
||||||
|
|
||||||
// Send the correct process error code for any uncaught exceptions
|
// Send the correct process error code for any uncaught exceptions
|
||||||
// so that Docker can gracefully restart the container
|
// so that Docker can gracefully restart the container
|
||||||
process.on('uncaughtException', (err) => {
|
process.on('uncaughtException', (err) => {
|
||||||
@@ -334,10 +341,11 @@ process.on('uncaughtException', (err) => {
|
|||||||
server.close()
|
server.close()
|
||||||
process.exit(1)
|
process.exit(1)
|
||||||
})
|
})
|
||||||
|
// Log-only: with asyncHandler routing request errors into errorHandler, a
|
||||||
|
// stray rejection from a background task (version check, staging-dir sweep,
|
||||||
|
// etc.) is not worth killing every in-flight request for.
|
||||||
process.on('unhandledRejection', (reason, promise) => {
|
process.on('unhandledRejection', (reason, promise) => {
|
||||||
console.error('Unhandled Rejection at:', promise, 'reason:', reason)
|
console.error('Unhandled Rejection at:', promise, 'reason:', reason)
|
||||||
server.close()
|
|
||||||
process.exit(1)
|
|
||||||
})
|
})
|
||||||
process.on('SIGTERM', () => {
|
process.on('SIGTERM', () => {
|
||||||
console.log('Received SIGTERM. Gracefully shutting down...')
|
console.log('Received SIGTERM. Gracefully shutting down...')
|
||||||
|
|||||||
@@ -96,8 +96,8 @@ export interface MetadataConfig {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Shape of the JSON init block embedded in `gallery.tsx` and consumed by
|
* Shape of the JSON init block embedded in `gallery.tsx` and consumed by
|
||||||
* `client/init.ts`. The server writes it via `JSON.stringify`; the client
|
* `client/init.ts`. The server writes it via `jsonForInlineScript`; the
|
||||||
* reads it via `readInitParams()`.
|
* client reads it via `readInitParams()`.
|
||||||
*/
|
*/
|
||||||
export interface InitParams {
|
export interface InitParams {
|
||||||
items?: GalleryItem[]
|
items?: GalleryItem[]
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import { assetFetchUrl, authHeadersForAsset } from '../immich'
|
import { assetFetchUrl, authHeadersForAsset } from '../immich'
|
||||||
import { Response } from 'express-serve-static-core'
|
import { Response } from 'express-serve-static-core'
|
||||||
import { Asset, ImageSize, SharedLink } from '../types'
|
import { Asset, ImageSize, SharedLink } from '../types'
|
||||||
import { getConfigOption } from '../config/access'
|
import { getNumericConfigOption } from '../config/access'
|
||||||
import { log } from '../utils/log'
|
import { log } from '../utils/log'
|
||||||
import archiver, { Archiver } from 'archiver'
|
import archiver, { Archiver } from 'archiver'
|
||||||
import { sanitize } from '../utils/sanitize'
|
import { sanitize } from '../utils/sanitize'
|
||||||
@@ -96,7 +96,7 @@ export async function downloadAssets (res: Response, share: SharedLink, assets:
|
|||||||
|
|
||||||
const options: StagingOptions = {
|
const options: StagingOptions = {
|
||||||
stagingDir: await fs.mkdtemp(join(tmpdir(), STAGING_DIR_PREFIX)),
|
stagingDir: await fs.mkdtemp(join(tmpdir(), STAGING_DIR_PREFIX)),
|
||||||
concurrency: Math.max(1, getConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20) as number),
|
concurrency: Math.max(1, getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20)),
|
||||||
maxAttempts: 3,
|
maxAttempts: 3,
|
||||||
headerTimeoutMs: 20_000,
|
headerTimeoutMs: 20_000,
|
||||||
idleTimeoutMs: 20_000
|
idleTimeoutMs: 20_000
|
||||||
|
|||||||
@@ -12,6 +12,19 @@ export function escapeHtml (str: string): string {
|
|||||||
.replace(/'/g, ''')
|
.replace(/'/g, ''')
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Serialise a value as JSON that is safe to embed inside an inline `<script>`
|
||||||
|
* block. `JSON.stringify` does not escape `<`, so a string value containing
|
||||||
|
* `</script>` would terminate the script element early and inject markup into
|
||||||
|
* the page.
|
||||||
|
*/
|
||||||
|
export function jsonForInlineScript (value: unknown): string {
|
||||||
|
return JSON.stringify(value)
|
||||||
|
.replace(/</g, '\\u003c')
|
||||||
|
.replace(/\u2028/g, '\\u2028')
|
||||||
|
.replace(/\u2029/g, '\\u2029')
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Narrow an `unknown` to `string`, returning an empty string for any other
|
* Narrow an `unknown` to `string`, returning an empty string for any other
|
||||||
* type. Used at boundaries where the input shape isn't statically known
|
* type. Used at boundaries where the input shape isn't statically known
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { AssetType } from '../types'
|
|||||||
import { ThemeScript } from './theme'
|
import { ThemeScript } from './theme'
|
||||||
import { GalleryItem, LightboxConfig, MetadataConfig, GroupByDateMode } from '../shared/types'
|
import { GalleryItem, LightboxConfig, MetadataConfig, GroupByDateMode } from '../shared/types'
|
||||||
import { ASSET_VERSION } from '../version'
|
import { ASSET_VERSION } from '../version'
|
||||||
|
import { jsonForInlineScript } from '../utils/text'
|
||||||
|
|
||||||
export type { GalleryItem, LightboxConfig, MetadataConfig, GroupByDateMode }
|
export type { GalleryItem, LightboxConfig, MetadataConfig, GroupByDateMode }
|
||||||
|
|
||||||
@@ -25,7 +26,7 @@ export interface GalleryProps {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function Gallery (props: GalleryProps) {
|
export function Gallery (props: GalleryProps) {
|
||||||
const initJson = JSON.stringify({
|
const initJson = jsonForInlineScript({
|
||||||
items: props.items,
|
items: props.items,
|
||||||
openItem: props.openItem,
|
openItem: props.openItem,
|
||||||
lightboxConfig: props.lightboxConfig,
|
lightboxConfig: props.lightboxConfig,
|
||||||
|
|||||||
@@ -0,0 +1,77 @@
|
|||||||
|
import { describe, it, expect, vi, beforeAll, afterAll } from 'vitest'
|
||||||
|
import express from 'express'
|
||||||
|
import type { Server } from 'http'
|
||||||
|
import type { AddressInfo } from 'net'
|
||||||
|
import { asyncHandler, errorHandler } from '../src/http'
|
||||||
|
|
||||||
|
/*
|
||||||
|
Regression tests for the per-request crash class: under Express 4 a rejected
|
||||||
|
promise in an async route became an unhandledRejection, and index.ts used to
|
||||||
|
respond to that with process.exit(1) - one bad request took down the whole
|
||||||
|
container. asyncHandler + errorHandler must instead turn any thrown/rejected
|
||||||
|
route error into a plain 404 (the privacy policy: no upstream detail) while
|
||||||
|
the server keeps serving.
|
||||||
|
*/
|
||||||
|
|
||||||
|
describe('asyncHandler + errorHandler', () => {
|
||||||
|
let server: Server
|
||||||
|
let base: string
|
||||||
|
|
||||||
|
beforeAll(async () => {
|
||||||
|
// Silence errorHandler's expected server-side logging during these tests
|
||||||
|
vi.spyOn(console, 'error').mockImplementation(() => {})
|
||||||
|
|
||||||
|
const app = express()
|
||||||
|
app.get('/ok', asyncHandler(async (_req, res) => { res.send('ok') }))
|
||||||
|
app.get('/boom', asyncHandler(async () => {
|
||||||
|
throw new TypeError("Cannot read properties of undefined (reading 'headers')")
|
||||||
|
}))
|
||||||
|
app.get('/mid-stream', asyncHandler(async (_req, res) => {
|
||||||
|
res.status(200)
|
||||||
|
res.write('partial')
|
||||||
|
throw new Error('upstream died mid-response')
|
||||||
|
}))
|
||||||
|
app.use(errorHandler)
|
||||||
|
|
||||||
|
await new Promise<void>(resolve => {
|
||||||
|
server = app.listen(0, resolve)
|
||||||
|
})
|
||||||
|
base = 'http://127.0.0.1:' + (server.address() as AddressInfo).port
|
||||||
|
})
|
||||||
|
|
||||||
|
afterAll(() => {
|
||||||
|
server?.close()
|
||||||
|
vi.restoreAllMocks()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('turns a rejected route promise into a 404 with an empty body', async () => {
|
||||||
|
const res = await fetch(base + '/boom')
|
||||||
|
expect(res.status).toBe(404)
|
||||||
|
expect(await res.text()).toBe('')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('keeps serving other requests after a route has thrown', async () => {
|
||||||
|
await fetch(base + '/boom')
|
||||||
|
const res = await fetch(base + '/ok')
|
||||||
|
expect(res.status).toBe(200)
|
||||||
|
expect(await res.text()).toBe('ok')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not leak error detail to the client', async () => {
|
||||||
|
const res = await fetch(base + '/boom')
|
||||||
|
const body = await res.text()
|
||||||
|
expect(body).not.toContain('TypeError')
|
||||||
|
expect(body).not.toContain('headers')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('ends the response when the error hits after headers were sent', async () => {
|
||||||
|
const res = await fetch(base + '/mid-stream')
|
||||||
|
// Status was already committed before the throw; the handler can only
|
||||||
|
// end the stream, not rewrite it to a 404.
|
||||||
|
expect(res.status).toBe(200)
|
||||||
|
expect(await res.text()).toBe('partial')
|
||||||
|
// And the server is still alive afterwards
|
||||||
|
const ok = await fetch(base + '/ok')
|
||||||
|
expect(ok.status).toBe(200)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
import { describe, it, expect } from 'vitest'
|
|
||||||
import { escapeHtml } from '../src/utils/text'
|
|
||||||
|
|
||||||
describe('escapeHtml', () => {
|
|
||||||
it('escapes the five HTML-significant characters', () => {
|
|
||||||
expect(escapeHtml('<script>alert("xss")</script>')).toBe(
|
|
||||||
'<script>alert("xss")</script>'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('escapes ampersand first so other escapes are not re-escaped', () => {
|
|
||||||
expect(escapeHtml('&')).toBe('&amp;')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('escapes single quotes', () => {
|
|
||||||
expect(escapeHtml("it's")).toBe('it's')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('returns empty string unchanged', () => {
|
|
||||||
expect(escapeHtml('')).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('passes through strings with no special characters', () => {
|
|
||||||
expect(escapeHtml('plain text 123')).toBe('plain text 123')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
import { describe, it, expect } from 'vitest'
|
||||||
|
import { h } from 'preact'
|
||||||
|
import { Gallery, GalleryProps, GalleryItem } from '../src/view/gallery'
|
||||||
|
import { renderPage } from '../src/view/render'
|
||||||
|
|
||||||
|
/*
|
||||||
|
Regression test for the init-JSON XSS: asset strings (originalFileName, EXIF
|
||||||
|
description/city/make/model) are attacker-influenced and are serialised into
|
||||||
|
the <script type="application/json"> init block. A raw `</script>` inside
|
||||||
|
them must not be able to terminate that block and inject markup.
|
||||||
|
*/
|
||||||
|
|
||||||
|
function galleryProps (item: Partial<GalleryItem>): GalleryProps {
|
||||||
|
return {
|
||||||
|
items: [{
|
||||||
|
id: 'a',
|
||||||
|
type: 'IMAGE',
|
||||||
|
previewUrl: '/share/photo/k/a/preview',
|
||||||
|
thumbnailUrl: '/share/photo/k/a/thumbnail',
|
||||||
|
downloadFilename: 'photo.jpg',
|
||||||
|
...item
|
||||||
|
}],
|
||||||
|
title: 'Test gallery',
|
||||||
|
description: '',
|
||||||
|
publicBaseUrl: 'https://example.com',
|
||||||
|
path: '/share/k',
|
||||||
|
showDownloadZip: false,
|
||||||
|
showTitle: false,
|
||||||
|
lightboxConfig: { showArrows: true, showDownload: true, mobileArrows: false, autoPlayVideos: false },
|
||||||
|
metadataConfig: { descriptionInCaption: false, descriptionInSidebar: false, sidebarHasContent: false, locationWebLink: false },
|
||||||
|
groupByDate: false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const payload = '</script><script>alert(1)</script>'
|
||||||
|
|
||||||
|
describe('gallery init JSON escaping', () => {
|
||||||
|
it('neutralises </script> in a crafted download filename', () => {
|
||||||
|
const html = renderPage(h(Gallery, galleryProps({ downloadFilename: payload })))
|
||||||
|
expect(html).not.toContain('<script>alert(1)</script>')
|
||||||
|
expect(html).toContain('\\u003c/script>')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('neutralises </script> in crafted EXIF metadata', () => {
|
||||||
|
const html = renderPage(h(Gallery, galleryProps({
|
||||||
|
description: payload,
|
||||||
|
exif: { fileName: payload, city: payload, make: payload }
|
||||||
|
})))
|
||||||
|
expect(html).not.toContain('<script>alert(1)</script>')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('still produces JSON the client can parse back to the same items', () => {
|
||||||
|
const html = renderPage(h(Gallery, galleryProps({ downloadFilename: payload })))
|
||||||
|
const match = html.match(/<script type="application\/json" id="ipp-init">(.*?)<\/script>/s)
|
||||||
|
expect(match).not.toBeNull()
|
||||||
|
const params = JSON.parse(match![1])
|
||||||
|
expect(params.items[0].downloadFilename).toBe(payload)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
import { describe, it, expect, afterEach } from 'vitest'
|
||||||
|
import { loadConfig } from '../src/config/loader'
|
||||||
|
import { getNumericConfigOption } from '../src/config/access'
|
||||||
|
import { createLimiter } from '../src/utils/limiter'
|
||||||
|
|
||||||
|
/*
|
||||||
|
Regression tests for the non-numeric concurrency bug: a non-numeric
|
||||||
|
`ipp.downloadFromImmichConcurrencyLimit` used to reach createLimiter as NaN,
|
||||||
|
where `active >= NaN` is always false - so the limiter never throttled and
|
||||||
|
every asset in a zip download hit Immich at once.
|
||||||
|
*/
|
||||||
|
|
||||||
|
function loadConfigFrom (config: Record<string, unknown>) {
|
||||||
|
process.env.CONFIG = JSON.stringify(config)
|
||||||
|
loadConfig()
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete process.env.CONFIG
|
||||||
|
loadConfig()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('getNumericConfigOption', () => {
|
||||||
|
it('returns a configured number', () => {
|
||||||
|
loadConfigFrom({ ipp: { downloadFromImmichConcurrencyLimit: 5 } })
|
||||||
|
expect(getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20)).toBe(5)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('coerces a numeric string (docker-compose env values arrive as strings)', () => {
|
||||||
|
loadConfigFrom({ ipp: { downloadFromImmichConcurrencyLimit: '5' } })
|
||||||
|
expect(getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20)).toBe(5)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('falls back to the default for a non-numeric value instead of NaN', () => {
|
||||||
|
loadConfigFrom({ ipp: { downloadFromImmichConcurrencyLimit: 'lots' } })
|
||||||
|
expect(getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20)).toBe(20)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('falls back to the default for non-scalar values', () => {
|
||||||
|
loadConfigFrom({ ipp: { downloadFromImmichConcurrencyLimit: { max: 5 } } })
|
||||||
|
expect(getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20)).toBe(20)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('falls back to the default when the option is unset', () => {
|
||||||
|
loadConfigFrom({})
|
||||||
|
expect(getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 20)).toBe(20)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('createLimiter with guarded config', () => {
|
||||||
|
/** Run `total` tasks through the limiter and report the concurrency peak */
|
||||||
|
async function peakConcurrency (limit: number, total: number): Promise<number> {
|
||||||
|
const run = createLimiter(limit)
|
||||||
|
let active = 0
|
||||||
|
let peak = 0
|
||||||
|
await Promise.all(Array.from({ length: total }, () => run(async () => {
|
||||||
|
active++
|
||||||
|
peak = Math.max(peak, active)
|
||||||
|
// Yield so other queued tasks get a chance to start while this one is "active"
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1))
|
||||||
|
active--
|
||||||
|
})))
|
||||||
|
return peak
|
||||||
|
}
|
||||||
|
|
||||||
|
it('a NaN limit disables throttling (the failure mode being guarded against)', async () => {
|
||||||
|
expect(await peakConcurrency(NaN, 10)).toBe(10)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('the guarded value throttles as configured', async () => {
|
||||||
|
loadConfigFrom({ ipp: { downloadFromImmichConcurrencyLimit: 'lots' } })
|
||||||
|
const limit = Math.max(1, getNumericConfigOption('ipp.downloadFromImmichConcurrencyLimit', 3))
|
||||||
|
expect(await peakConcurrency(limit, 10)).toBe(3)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
import { describe, it, expect } from 'vitest'
|
||||||
|
import { escapeHtml, jsonForInlineScript } from '../src/utils/text'
|
||||||
|
|
||||||
|
describe('escapeHtml', () => {
|
||||||
|
it('escapes the five HTML-significant characters', () => {
|
||||||
|
expect(escapeHtml('<script>alert("xss")</script>')).toBe(
|
||||||
|
'<script>alert("xss")</script>'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('escapes ampersand first so other escapes are not re-escaped', () => {
|
||||||
|
expect(escapeHtml('&')).toBe('&amp;')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('escapes single quotes', () => {
|
||||||
|
expect(escapeHtml("it's")).toBe('it's')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns empty string unchanged', () => {
|
||||||
|
expect(escapeHtml('')).toBe('')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('passes through strings with no special characters', () => {
|
||||||
|
expect(escapeHtml('plain text 123')).toBe('plain text 123')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('jsonForInlineScript', () => {
|
||||||
|
it('escapes < so </script> cannot terminate an inline script block', () => {
|
||||||
|
const out = jsonForInlineScript({ name: '</script><script>alert(1)</script>' })
|
||||||
|
expect(out).not.toContain('<')
|
||||||
|
expect(out).toContain('\\u003c/script>')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('round-trips through JSON.parse unchanged', () => {
|
||||||
|
const value = {
|
||||||
|
name: '</script> & <!-- tricky --> \u2028\u2029',
|
||||||
|
n: 3,
|
||||||
|
nested: { arr: [1, 'two'] }
|
||||||
|
}
|
||||||
|
expect(JSON.parse(jsonForInlineScript(value))).toEqual(value)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('escapes the JS line separators U+2028 and U+2029', () => {
|
||||||
|
const out = jsonForInlineScript({ s: '\u2028\u2029' })
|
||||||
|
expect(out).toBe('{"s":"\\u2028\\u2029"}')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('matches JSON.stringify for benign values', () => {
|
||||||
|
const value = { a: 1, b: 'plain text', c: null }
|
||||||
|
expect(jsonForInlineScript(value)).toBe(JSON.stringify(value))
|
||||||
|
})
|
||||||
|
})
|
||||||
Reference in New Issue
Block a user