Перейти до вмісту
Hokusai2.2.2
ivantokar.com

Hokusai Hummingbird

Hokusai Hummingbird (2.1.0) — тонкий шар: потокова передача, скасування та ліміти належать самому Hokusai (writeByteBuffers у HokusaiNIO, побудований на основному writeChunks); жоден тип Hummingbird не потрапляє в нативний шар. Вимоги: Swift 6.0+, Hummingbird 2.x, Hokusai 2, libvips 8.16+ і Cairo з підтримкою PDF (встановлення).

dependencies: [
.package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.0.0"),
.package(url: "https://github.com/ivantokar/hokusai-hummingbird.git", from: "2.0.0")
]

Додайте HokusaiHummingbird до цілі, що визначає ваші маршрути.

Налаштування під час запуску

Section titled “Налаштування під час запуску”

Налаштування Hokusai фіксуються під час першого використання, тож налаштовуйте до першого запиту; initialize() перетворює проблему з нативною частиною на збій запуску.

try Hokusai.configure(.init(maxConcurrentEvaluations: .fixed(4), maxQueuedEvaluations: 64))
try Hokusai.initialize()
func buildRouter() -> Router<BasicRequestContext> {
let router = Router()
router.add(middleware: HokusaiErrorMiddleware())
// POST /resize --data-binary @photo.jpg
router.post("resize") { request, _ -> Response in
let image = try await request.hokusaiImage(maximumSize: 5 * 1024 * 1024) // 413 above 5 MiB
return try await image
.resize(width: 800, height: 600, fit: .cover)
.webp(quality: 82) // choose the encoder on the pipeline
.response() // Content-Type: image/webp, streamed
}
// An A4 PDF of the upload
router.post("report") { request, _ -> Response in
let image = try await request.hokusaiImage()
return try await image
.resize(width: 1240, height: 1754, fit: .contain)
.pdf(pageSize: .a4(), margins: .all(36), background: .white)
.response(status: .created, headers: [.cacheControl: "no-store"])
}
return router
}
@main
struct Entry {
static func main() async throws {
// Hokusai's process-level settings are frozen at first use, so set them before the first request.
try Hokusai.configure(.init(maxConcurrentEvaluations: .fixed(4), maxQueuedEvaluations: 64))
try Hokusai.initialize()
let app = Application(router: buildRouter(), configuration: .init(address: .hostname("127.0.0.1", port: 8080)))
try await app.runService()
}
}

Код вище компілюється в CI проти hokusai-hummingbird 2.1.0 (examples/integrations/hummingbird-app). Спробуйте:

Terminal window
curl -X POST http://localhost:8080/resize --data-binary "@photo.jpg" -o output.webp

На що можна покладатися

Section titled “На що можна покладатися”
  • Ліміти завантаження. hokusaiImage читає тіло в міру надходження й ніколи не понад його ліміт: оголошений Content-Length понад maximumSize (типово 20 МіБ) відхиляється до читання будь-якого байта, а тіло без нього відхиляється, щойно перевищить ліміт, обидва випадки дають 413. Передайте options: InputOptions(limits: …) для власних лімітів декодування Hokusai. Невелике завантаження лишається в пам’яті; більше за memoryLimit (типово 1 МіБ) переходить у приватний тимчасовий файл (Hokusai(spooling:)), тож закодоване завантаження займає щонайбільше memoryLimit плюс одну частину пам’яті, яким би великим не був maximumSize. Декодування обмежує окремо InputLimits.maxPixels.
  • Потокові відповіді. response() пише через Hokusai.writeByteBuffers: кожен буфер передається ResponseBodyWriter Hummingbird у міру кодування, тож повільний клієнт сповільнює кодування; тримається щонайбільше чотири буфери по 64 КіБ закодованого виводу. Тіло передається частинами, без Content-Length. Content-Type береться з кодувальника, який несе конвеєр (конвеєр без нього — це 500). status:, headers: і chunkSize: — параметри. TIFF спершу кодується в пам’яті, а потім передається потоком.
  • Збої до першого байта — це 4xx. Заголовок джерела читається до фіксації відповіді, тож відсутнє чи нечитабельне зображення — це чиста помилка, а не зламане 200. Збій після першого байта може лише достроково завершити потік, так працює HTTP; відключення клієнта скасовує обчислення.
  • Помилки. HokusaiErrorMiddleware перетворює HokusaiError, викинуту маршрутом, на помилку HTTP; hokusaiImage і response уже роблять це для того, що виконують. Відображення: invalidInput / invalidOption — 400, decode — 422, resource — 413 для байтів, 422 для пікселів чи каналів, 503, коли черга обчислень повна, unsupported — 501, а io / transform / encode / runtime — 500. error.httpStatus і error.httpError публічні, якщо потрібна інша політика.