Something went wrong. Try again.
A free, open-source, self-hosted place to write a novel.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202import { afterEach, beforeEach, describe, expect, it } from 'vitest';import { existsSync, mkdirSync, mkdtempSync, readdirSync, rmSync, symlinkSync, writeFileSync} from 'node:fs';import { tmpdir } from 'node:os';import { join } from 'node:path';import sharp from 'sharp';import { db, tables } from './db/index.ts';import { MAX_IMAGE_BYTES, openImportSource, readImage, removeImage, setUploadsDirForTest, storeImage, ImageRefusedError} from './uploads.ts';
let testDir: string;
beforeEach(() => { testDir = mkdtempSync(join(tmpdir(), 'fablewright-uploads-test-')); setUploadsDirForTest(testDir); db.delete(tables.noteImage).run(); db.delete(tables.note).run(); db.delete(tables.project).run();});
afterEach(() => { setUploadsDirForTest(null); rmSync(testDir, { recursive: true, force: true });});
async function makeImage( format: 'png' | 'jpeg' | 'webp' | 'gif' | 'avif', width = 100, height = 100): Promise<Uint8Array> { let pipeline = sharp({ create: { width, height, channels: 4, background: { r: 120, g: 80, b: 40, alpha: 1 } } });
if (format === 'png') pipeline = pipeline.png(); else if (format === 'jpeg') pipeline = pipeline.jpeg(); else if (format === 'webp') pipeline = pipeline.webp(); else if (format === 'gif') pipeline = pipeline.gif(); else if (format === 'avif') pipeline = pipeline.avif();
return new Uint8Array(await pipeline.toBuffer());}
describe('uploads module', () => { it('stores an image preserving the original and returns its length', async () => { const bytes = await makeImage('png', 200, 150); const result = await storeImage(bytes, { preserveOriginal: true });
expect(result.imageId).toMatch( /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ ); expect(result.mime).toBe('image/png'); expect(result.bytes).toBe(bytes.length); expect(result.width).toBe(200); expect(result.height).toBe(150);
const display = readImage(result.imageId, 'display'); expect(display).not.toBeNull(); expect(display?.mime).toBe('image/webp'); expect(display?.bytes.length).toBeGreaterThan(0);
const original = readImage(result.imageId, 'original'); expect(original).not.toBeNull(); expect(original?.mime).toBe('image/png'); expect(new Uint8Array(original!.bytes)).toEqual(bytes); });
it('stores an image without original when preserveOriginal is false', async () => { const bytes = await makeImage('jpeg', 300, 200); const result = await storeImage(bytes, { preserveOriginal: false });
expect(result.bytes).toBe(0); expect(result.mime).toBe('image/jpeg');
expect(readImage(result.imageId, 'display')).not.toBeNull(); expect(readImage(result.imageId, 'original')).toBeNull(); expect(existsSync(join(testDir, `${result.imageId}.orig`))).toBe(false); });
it('downscales display copy when larger than DISPLAY_EDGE (1600px)', async () => { const bytes = await makeImage('png', 2000, 1000); const result = await storeImage(bytes, { preserveOriginal: true });
// 2000x1000 fitted inside 1600x1600 becomes 1600x800. expect(result.width).toBe(1600); expect(result.height).toBe(800); expect(result.bytes).toBe(bytes.length); });
it('refuses oversized files (> MAX_IMAGE_BYTES)', async () => { for (const preserveOriginal of [true, false]) { const fakeBig = new Uint8Array(MAX_IMAGE_BYTES + 1024); await expect(storeImage(fakeBig, { preserveOriginal })).rejects.toThrow(ImageRefusedError);
// A refused upload leaves no files behind on disk. const files = readdirSync(testDir); expect(files).toHaveLength(0); } });
it('refuses non-image or fake extension files', async () => { for (const preserveOriginal of [true, false]) { const textBytes = new TextEncoder().encode('not an image at all'); await expect(storeImage(textBytes, { preserveOriginal })).rejects.toThrow(ImageRefusedError);
// Neither the display copy nor the original is written. expect(readdirSync(testDir)).toHaveLength(0); } });
it('refuses unsupported formats (e.g. svg)', async () => { for (const preserveOriginal of [true, false]) { const svgBytes = new TextEncoder().encode('<svg><script>alert(1)</script></svg>'); await expect(storeImage(svgBytes, { preserveOriginal })).rejects.toThrow(ImageRefusedError);
expect(readdirSync(testDir)).toHaveLength(0); } });
it('blocks path traversal attempts in readImage', () => { expect(readImage('../etc/passwd', 'display')).toBeNull(); expect(readImage('../../secret', 'original')).toBeNull(); expect(readImage('not-a-uuid', 'display')).toBeNull(); });
// A backup restores a directory the tool did not write, so a link in it is a // name that points at somebody else's file. Reading through one hands out files // the app never stored. describe.skipIf(process.platform === 'win32')('a link where a file belongs', () => { const ID = '0b9c8a52-4a09-4a1e-9a4b-1f2c5a0d7e11';
it('refuses a symbolic link in place of an image', () => { const secret = join(testDir, 'outside.txt'); writeFileSync(secret, 'not an image'); symlinkSync(secret, join(testDir, `${ID}.webp`)); symlinkSync(secret, join(testDir, `${ID}.orig`));
expect(readImage(ID, 'display')).toBeNull(); expect(readImage(ID, 'original')).toBeNull(); });
it('refuses a symbolic link in place of an import source', () => { const imports = join(testDir, 'imports'); mkdirSync(imports); const secret = join(testDir, 'outside.txt'); writeFileSync(secret, 'not an import'); symlinkSync(secret, join(imports, `${ID}.zip`));
expect(openImportSource(`${ID}.zip`)).toBeNull(); });
it('still hands back a regular import source', () => { const imports = join(testDir, 'imports'); mkdirSync(imports); writeFileSync(join(imports, `${ID}.txt`), 'the words');
expect(openImportSource(`${ID}.txt`)).toEqual({ path: join(imports, `${ID}.txt`), size: 9 }); }); });
it('removes image files and tmp files with removeImage', async () => { const bytes = await makeImage('webp', 50, 50); const { imageId } = await storeImage(bytes, { preserveOriginal: true });
expect(existsSync(join(testDir, `${imageId}.webp`))).toBe(true); expect(existsSync(join(testDir, `${imageId}.orig`))).toBe(true);
removeImage(imageId);
expect(existsSync(join(testDir, `${imageId}.webp`))).toBe(false); expect(existsSync(join(testDir, `${imageId}.orig`))).toBe(false); });});