Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

fix(backend:files): handle image formats unsupported by Sharp.

johaven2b4c12b20bf9
diff --git a/backend/src/applications/files/files-operations.controller.spec.ts b/backend/src/applications/files/files-operations.controller.spec.ts
index 4c4be1b0..2a291034 100644
--- a/backend/src/applications/files/files-operations.controller.spec.ts
+++ b/backend/src/applications/files/files-operations.controller.spec.ts
@@ -1,4 +1,5 @@
import { Test, TestingModule } from '@nestjs/testing'
+import { Readable } from 'node:stream'
import { SpaceGuard } from '../spaces/guards/space.guard.js'
import { FILE_OPERATION } from './constants/operations.js'
import { FilesOperationsController } from './files-operations.controller.js'
@@ -120,40 +121,37 @@ describe(FilesOperationsController.name, () => {
})
it('genThumbnail() should default size to 256 when not provided', async () => {
- const stream = {} as any
- filesMethodsMock.genThumbnail.mockResolvedValue(stream)
+ const stream = Readable.from(['img'])
+ filesMethodsMock.genThumbnail.mockResolvedValue({ mimeType: 'image/webp', size: 3, stream })
// pass undefined to exercise controller default parameter
- const result = await filesOperationsController.genThumbnail(fakeSpace, undefined as unknown as number, fakeRes)
+ const result = await filesOperationsController.genThumbnail(fakeSpace, undefined as unknown as number)
expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 256)
- expect(fakeRes.type).toHaveBeenCalled()
- expect(fakeRes.send).toHaveBeenCalledWith(stream)
- expect(result).toBeUndefined()
+ expect(result.getStream()).toBe(stream)
+ expect(result.getHeaders()).toMatchObject({ length: 3, type: 'image/webp' })
})
it('genThumbnail() should pass provided size', async () => {
- const stream = {} as any
- filesMethodsMock.genThumbnail.mockResolvedValue(stream)
+ const stream = Readable.from(['img'])
+ filesMethodsMock.genThumbnail.mockResolvedValue({ mimeType: 'image/webp', size: 3, stream })
- const result = await filesOperationsController.genThumbnail(fakeSpace, 512, fakeRes)
+ const result = await filesOperationsController.genThumbnail(fakeSpace, 512)
expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 512)
- expect(fakeRes.type).toHaveBeenCalled()
- expect(fakeRes.send).toHaveBeenCalledWith(stream)
- expect(result).toBeUndefined()
+ expect(result.getStream()).toBe(stream)
+ expect(result.getHeaders()).toMatchObject({ length: 3, type: 'image/webp' })
})
it('genThumbnail() should reduce size larger than 1024', async () => {
- const stream = {} as any
- filesMethodsMock.genThumbnail.mockResolvedValue(stream)
+ const stream = Readable.from(['img'])
+ filesMethodsMock.genThumbnail.mockResolvedValue({ mimeType: 'image/webp', size: 3, stream })
- const result = await filesOperationsController.genThumbnail(fakeSpace, 2048, fakeRes)
+ const result = await filesOperationsController.genThumbnail(fakeSpace, 2048)
expect(filesMethodsMock.genThumbnail).toHaveBeenCalledWith(fakeSpace, 1024)
- expect(fakeRes.type).toHaveBeenCalled()
- expect(fakeRes.send).toHaveBeenCalledWith(stream)
- expect(result).toBeUndefined()
+ expect(result.getStream()).toBe(stream)
+ expect(result.getHeaders()).toMatchObject({ length: 3, type: 'image/webp' })
})
})
diff --git a/backend/src/applications/files/files-operations.controller.ts b/backend/src/applications/files/files-operations.controller.ts
index 391fa1a1..fe47e178 100644
--- a/backend/src/applications/files/files-operations.controller.ts
+++ b/backend/src/applications/files/files-operations.controller.ts
@@ -21,7 +21,6 @@ import {
UseGuards
} from '@nestjs/common'
import { type FastifyReply } from 'fastify'
-import { webpMimeType } from '../../common/image.js'
import { SkipSpacePermissionsCheck } from '../spaces/decorators/space-skip-permissions.decorator.js'
import { GetSpace } from '../spaces/decorators/space.decorator.js'
import { SpaceGuard } from '../spaces/guards/space.guard.js'
@@ -96,15 +95,10 @@ export class FilesOperationsController {
}
@Get(`${FILES_ROUTE.OPERATION}/${FILE_OPERATION.THUMBNAIL}/*`)
- async genThumbnail(
- @GetSpace() space: SpaceEnv,
- @Query('size', new ParseIntPipe({ optional: true })) size = 256,
- @Res() res: FastifyReply
- ): Promise<StreamableFile> {
+ async genThumbnail(@GetSpace() space: SpaceEnv, @Query('size', new ParseIntPipe({ optional: true })) size = 256): Promise<StreamableFile> {
if (size > 1024) size = 1024
- const thumb = await this.filesMethods.genThumbnail(space, size)
- res.type(webpMimeType)
- return res.send(thumb)
+ const thumbnail = await this.filesMethods.genThumbnail(space, size)
+ return new StreamableFile(thumbnail.stream, { length: thumbnail.size, type: thumbnail.mimeType })
}
@Lock(`${FILES_ROUTE.OPERATION}/*`)
diff --git a/backend/src/applications/files/interfaces/file-thumbnail.interface.ts b/backend/src/applications/files/interfaces/file-thumbnail.interface.ts
new file mode 100644
index 00000000..227585f1
--- /dev/null
+++ b/backend/src/applications/files/interfaces/file-thumbnail.interface.ts
@@ -0,0 +1,7 @@
+import type { Readable } from 'node:stream'
+
+export interface FileThumbnail {
+ mimeType: string
+ size: number
+ stream: Readable
+}
diff --git a/backend/src/applications/files/services/files-manager.service.spec.ts b/backend/src/applications/files/services/files-manager.service.spec.ts
index f022e548..d6214974 100644
--- a/backend/src/applications/files/services/files-manager.service.spec.ts
+++ b/backend/src/applications/files/services/files-manager.service.spec.ts
@@ -1963,16 +1963,18 @@ describe(FilesManager.name, () => {
})
describe('generateThumbnail', () => {
- it('should validate image and return generated stream', async () => {
+ it('should validate image and return the generated thumbnail', async () => {
const space = makeSpace({ realPath: '/data/users/john/files/image.png' })
vi.mocked(filesUtils.isPathExists).mockResolvedValueOnce(true)
vi.mocked(filesUtils.getMimeType).mockReturnValueOnce('image-png')
const stream = Readable.from(['img'])
- vi.spyOn(imageUtils, 'generateThumbnail').mockReturnValueOnce(stream as any)
+ const thumbnail = { mimeType: 'image/webp', size: 3, stream }
+ const generateThumbnailSpy = vi.spyOn(imageUtils, 'generateThumbnail').mockResolvedValueOnce(thumbnail)
const result = await service.generateThumbnail(space, 256)
- expect(result).toBe(stream)
+ expect(result).toBe(thumbnail)
+ expect(generateThumbnailSpy).toHaveBeenCalledWith(space.realPath, 256, 'image-png')
})
it('should pass SVG files to the thumbnail renderer', async () => {
@@ -1980,12 +1982,13 @@ describe(FilesManager.name, () => {
vi.mocked(filesUtils.isPathExists).mockResolvedValueOnce(true)
vi.mocked(filesUtils.getMimeType).mockReturnValueOnce('image-svg+xml')
const stream = Readable.from(['img'])
- const generateThumbnailSpy = vi.spyOn(imageUtils, 'generateThumbnail').mockReturnValueOnce(stream as any)
+ const thumbnail = { mimeType: 'image/webp', size: 3, stream }
+ const generateThumbnailSpy = vi.spyOn(imageUtils, 'generateThumbnail').mockResolvedValueOnce(thumbnail)
const result = await service.generateThumbnail(space, 256)
- expect(result).toBe(stream)
- expect(generateThumbnailSpy).toHaveBeenCalledWith(space.realPath, 256)
+ expect(result).toBe(thumbnail)
+ expect(generateThumbnailSpy).toHaveBeenCalledWith(space.realPath, 256, 'image-svg+xml')
})
})
diff --git a/backend/src/applications/files/services/files-manager.service.ts b/backend/src/applications/files/services/files-manager.service.ts
index d5f2869b..bc0b6d46 100644
--- a/backend/src/applications/files/services/files-manager.service.ts
+++ b/backend/src/applications/files/services/files-manager.service.ts
@@ -3,7 +3,6 @@ import { HttpStatus, Injectable, Logger } from '@nestjs/common'
import type { Dirent } from 'node:fs'
import fs from 'node:fs/promises'
import path from 'node:path'
-import { Readable } from 'node:stream'
import { fileURLToPath } from 'node:url'
import { FastifyAuthenticatedRequest } from '../../../authentication/interfaces/auth-request.interface.js'
import { generateThumbnail } from '../../../common/image.js'
@@ -31,6 +30,7 @@ import type { DeleteFileOptions } from '../interfaces/delete-file.interface.js'
import { FileDBProps } from '../interfaces/file-db-props.interface.js'
import { FileLock } from '../interfaces/file-lock.interface.js'
import { FileLockProps } from '../interfaces/file-props.interface.js'
+import type { FileThumbnail } from '../interfaces/file-thumbnail.interface.js'
import { SaveStreamOptions } from '../interfaces/save-stream.interface.js'
import { FileError, SourceCleanupError } from '../models/file-error.js'
import { LockConflict } from '../models/file-lock-error.js'
@@ -788,7 +788,7 @@ export class FilesManager {
FileEvent.emit('event', { user, space, action: ACTION.ADD, rPath: dstPath })
}
- async generateThumbnail(space: SpaceEnv, size: number): Promise<Readable> {
+ async generateThumbnail(space: SpaceEnv, size: number): Promise<FileThumbnail> {
if (!(await isPathExists(space.realPath))) {
throw new FileError(HttpStatus.NOT_FOUND, 'Location not found')
}
@@ -797,8 +797,9 @@ export class FilesManager {
throw new FileError(HttpStatus.BAD_REQUEST, 'File is not an image')
}
try {
- return generateThumbnail(space.realPath, size)
+ return await generateThumbnail(space.realPath, size, mimeType)
} catch (e) {
+ if (e instanceof FileError) throw e
this.logger.warn({ tag: this.generateThumbnail.name, msg: e })
throw new FileError(HttpStatus.BAD_REQUEST, 'File is not an image')
}
diff --git a/backend/src/applications/files/services/files-methods.service.ts b/backend/src/applications/files/services/files-methods.service.ts
index 870ea597..2da89290 100644
--- a/backend/src/applications/files/services/files-methods.service.ts
+++ b/backend/src/applications/files/services/files-methods.service.ts
@@ -1,20 +1,20 @@
import { HttpException, HttpStatus, Injectable, Logger, StreamableFile } from '@nestjs/common'
import { FastifyReply } from 'fastify'
import path from 'node:path'
-import { Readable } from 'node:stream'
import { FastifySpaceRequest } from '../../spaces/interfaces/space-request.interface.js'
import { SpaceEnv } from '../../spaces/models/space-env.model.js'
import { SpacesManager } from '../../spaces/services/spaces-manager.service.js'
import { UserModel } from '../../users/models/user.model.js'
import { FILE_OPERATION } from '../constants/operations.js'
import { CompressFileDto, CopyMoveFileDto, DownloadFileDto, MakeFileDto } from '../dto/file-operations.dto.js'
+import type { CopyMoveFileResponse } from '../interfaces/copy-move-file.interface.js'
import { FileLockProps } from '../interfaces/file-props.interface.js'
+import type { FileThumbnail } from '../interfaces/file-thumbnail.interface.js'
import { FileError } from '../models/file-error.js'
import { LockConflict } from '../models/file-lock-error.js'
import { checkFileName, dirName, fileName, getMimeType, isPathExists, isPathInside, isPathIsDir, sanitizeName } from '../utils/files.js'
import { SendFile } from '../utils/send-file.js'
import { FilesManager } from './files-manager.service.js'
-import type { CopyMoveFileResponse } from '../interfaces/copy-move-file.interface.js'
@Injectable()
export class FilesMethods {
@@ -121,7 +121,7 @@ export class FilesMethods {
}
}
- async genThumbnail(space: SpaceEnv, size: number): Promise<Readable> {
+ async genThumbnail(space: SpaceEnv, size: number): Promise<FileThumbnail> {
try {
return await this.filesManager.generateThumbnail(space, size)
} catch (e) {
diff --git a/backend/src/common/image.spec.ts b/backend/src/common/image.spec.ts
index 34ad20c1..a6af8393 100644
--- a/backend/src/common/image.spec.ts
+++ b/backend/src/common/image.spec.ts
@@ -5,7 +5,7 @@ import { Readable } from 'node:stream'
import { pathToFileURL } from 'node:url'
import sharp from 'sharp'
import { maxFileSizeExceededError } from '../applications/files/utils/errors.js'
-import { generateThumbnail, maxThumbnailInputSize } from './image.js'
+import { generateThumbnail, maxThumbnailInputSize, webpMimeType } from './image.js'
async function streamToBuffer(stream: Readable): Promise<Buffer> {
const chunks: Buffer[] = []
@@ -30,17 +30,36 @@ describe(generateThumbnail.name, () => {
const svgPath = path.join(tmpDir, 'image.svg')
await writeFile(svgPath, '<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32"><rect width="32" height="32" fill="blue"/></svg>')
- const thumbnail = await streamToBuffer(await generateThumbnail(svgPath, 32))
+ const result = await generateThumbnail(svgPath, 32, 'image-svg+xml')
+ const thumbnail = await streamToBuffer(result.stream)
+ expect(result.mimeType).toBe(webpMimeType)
+ expect(result.size).toBe(thumbnail.length)
await expect(sharp(thumbnail).metadata()).resolves.toMatchObject({ format: 'webp', width: 32, height: 32 })
})
- it.each(['png', 'svg'])('rejects an oversized %s source before rendering', async (extension) => {
+ it('returns a Sharp-unsupported image unchanged', async () => {
+ const icoPath = path.join(tmpDir, 'image.ico')
+ const ico = Buffer.from([0, 0, 1, 0, 0, 0])
+ await writeFile(icoPath, ico)
+
+ const result = await generateThumbnail(icoPath, 32, 'image-vnd.microsoft.icon')
+
+ await expect(streamToBuffer(result.stream)).resolves.toEqual(ico)
+ expect(result.mimeType).toBe('image/vnd.microsoft.icon')
+ expect(result.size).toBe(ico.length)
+ })
+
+ it.each([
+ ['png', 'image-png'],
+ ['svg', 'image-svg+xml'],
+ ['ico', 'image-vnd.microsoft.icon']
+ ])('rejects an oversized %s source before rendering', async (extension, mimeType) => {
const imagePath = path.join(tmpDir, `oversized.${extension}`)
await writeFile(imagePath, '')
await truncate(imagePath, maxThumbnailInputSize + 1)
- await expect(generateThumbnail(imagePath, 32)).rejects.toEqual(maxFileSizeExceededError())
+ await expect(generateThumbnail(imagePath, 32, mimeType)).rejects.toEqual(maxFileSizeExceededError())
})
it.each([
@@ -60,7 +79,8 @@ describe(generateThumbnail.name, () => {
</svg>`
)
- const thumbnail = await streamToBuffer(await generateThumbnail(svgPath, 32))
+ const result = await generateThumbnail(svgPath, 32, 'image-svg+xml')
+ const thumbnail = await streamToBuffer(result.stream)
const pixel = await sharp(thumbnail).removeAlpha().extract({ left: 16, top: 16, width: 1, height: 1 }).raw().toBuffer()
expect(pixel[0]).toBeLessThan(50)
@@ -71,6 +91,6 @@ describe(generateThumbnail.name, () => {
const disguisedSvgPath = path.join(tmpDir, 'image.png')
await writeFile(disguisedSvgPath, '<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32"><rect width="32" height="32"/></svg>')
- await expect((async () => streamToBuffer(await generateThumbnail(disguisedSvgPath, 32)))()).rejects.toThrow()
+ await expect(generateThumbnail(disguisedSvgPath, 32, 'image-png')).rejects.toThrow()
})
})
diff --git a/backend/src/common/image.ts b/backend/src/common/image.ts
index c5af4ac8..6bf2b858 100644
--- a/backend/src/common/image.ts
+++ b/backend/src/common/image.ts
@@ -1,3 +1,4 @@
+import { createReadStream } from 'node:fs'
import fs from 'node:fs/promises'
import os from 'node:os'
import path from 'node:path'
@@ -6,6 +7,7 @@ import { fileURLToPath } from 'node:url'
import { promisify } from 'node:util'
import sharp from 'sharp'
import TextToSVG from 'text-to-svg'
+import type { FileThumbnail } from '../applications/files/interfaces/file-thumbnail.interface.js'
import { maxFileSizeExceededError } from '../applications/files/utils/errors.js'
import { moveFiles } from '../applications/files/utils/files.js'
@@ -21,18 +23,29 @@ export const imgMimeTypePrefix = 'image/'
export const pngMimeType = 'image/png'
export const svgMimeType = 'image/svg+xml'
export const webpMimeType = 'image/webp'
-export const maxThumbnailInputSize = 50 * 1024 * 1024
+export const maxThumbnailInputSize = 25 * 1024 * 1024
const avatarSize = 512
const fontPath = path.join(path.dirname(fileURLToPath(import.meta.url)), 'fonts', 'avatar.ttf')
const loadTextToSVG = promisify(TextToSVG.load.bind(TextToSVG))
+const sharpInputFormats = Object.values(sharp.format).filter(({ input }) => input.file || input.buffer)
let textToSvgCache: Promise<TextToSVG> | null = null
-export async function generateThumbnail(filePath: string, size: number): Promise<Readable> {
- if ((await fs.stat(filePath)).size > maxThumbnailInputSize) {
+export async function generateThumbnail(filePath: string, size: number, sourceMimeType: string): Promise<FileThumbnail> {
+ const sourceSize = (await fs.stat(filePath)).size
+ if (sourceSize > maxThumbnailInputSize) {
throw maxFileSizeExceededError()
}
- const input = path.extname(filePath).toLowerCase() === '.svg' ? await fs.readFile(filePath) : filePath
- return sharp(input, {
+ const normalizedFilePath = filePath.toLowerCase()
+ const inputFormat = sharpInputFormats.find(({ input }) => input.fileSuffix?.some((suffix) => normalizedFilePath.endsWith(suffix)))
+ if (!inputFormat) {
+ return {
+ mimeType: sourceMimeType.replace('image-', imgMimeTypePrefix),
+ size: sourceSize,
+ stream: createReadStream(filePath)
+ }
+ }
+ const input = inputFormat.id === 'svg' || !inputFormat.input.file ? await fs.readFile(filePath) : filePath
+ const thumbnail = await sharp(input, {
failOn: 'none',
sequentialRead: true, // sequential read = more efficient I/O
limitInputPixels: 268e6 // protects against extremely large images
@@ -47,6 +60,8 @@ export async function generateThumbnail(filePath: string, size: number): Promise
fastShrinkOnLoad: true // true by default, added for clarity
})
.webp({ quality: 80, effort: 0, alphaQuality: 90 })
+ .toBuffer()
+ return { mimeType: webpMimeType, size: thumbnail.length, stream: Readable.from([thumbnail]) }
}
export async function generateAvatar(initials: string): Promise<NodeJS.ReadableStream> {