import fs from "node:fs/promises"; import path from "node:path"; import JSZip from "jszip"; import sharp from "sharp"; import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; import { isPathWithinBase } from "../../test/helpers/paths.js"; import { createTempHomeEnv, type TempHomeEnv } from "../test-utils/temp-home.js"; describe("media store", () => { let store: typeof import("./store.js"); let home = ""; let tempHome: TempHomeEnv; beforeAll(async () => { tempHome = await createTempHomeEnv("openclaw-test-home-"); home = tempHome.home; store = await import("./store.js"); }); afterAll(async () => { try { await tempHome.restore(); } catch { // ignore cleanup failures in tests } }); async function withTempStore( fn: (store: typeof import("./store.js"), home: string) => Promise, ): Promise { return await fn(store, home); } it("creates and returns media directory", async () => { await withTempStore(async (store, home) => { const dir = await store.ensureMediaDir(); expect(isPathWithinBase(home, dir)).toBe(true); expect(path.normalize(dir)).toContain(`${path.sep}.openclaw${path.sep}media`); const stat = await fs.stat(dir); expect(stat.isDirectory()).toBe(true); }); }); it("saves buffers and enforces size limit", async () => { await withTempStore(async (store) => { const buf = Buffer.from("hello"); const saved = await store.saveMediaBuffer(buf, "text/plain"); const savedStat = await fs.stat(saved.path); expect(savedStat.size).toBe(buf.length); expect(saved.contentType).toBe("text/plain"); expect(saved.path.endsWith(".txt")).toBe(true); const jpeg = await sharp({ create: { width: 2, height: 2, channels: 3, background: "#123456" }, }) .jpeg({ quality: 80 }) .toBuffer(); const savedJpeg = await store.saveMediaBuffer(jpeg, "image/jpeg"); expect(savedJpeg.contentType).toBe("image/jpeg"); expect(savedJpeg.path.endsWith(".jpg")).toBe(true); const huge = Buffer.alloc(5 * 1024 * 1024 + 1); await expect(store.saveMediaBuffer(huge)).rejects.toThrow("Media exceeds 5MB limit"); }); }); it("copies local files and cleans old media", async () => { await withTempStore(async (store, home) => { const srcFile = path.join(home, "tmp-src.txt"); await fs.mkdir(home, { recursive: true }); await fs.writeFile(srcFile, "local file"); const saved = await store.saveMediaSource(srcFile); expect(saved.size).toBe(10); const savedStat = await fs.stat(saved.path); expect(savedStat.isFile()).toBe(true); expect(path.extname(saved.path)).toBe(".txt"); // make the file look old and ensure cleanOldMedia removes it const past = Date.now() - 10_000; await fs.utimes(saved.path, past / 1000, past / 1000); await store.cleanOldMedia(1); await expect(fs.stat(saved.path)).rejects.toThrow(); }); }); it.runIf(process.platform !== "win32")("rejects symlink sources", async () => { await withTempStore(async (store, home) => { const target = path.join(home, "sensitive.txt"); const source = path.join(home, "source.txt"); await fs.writeFile(target, "sensitive"); await fs.symlink(target, source); await expect(store.saveMediaSource(source)).rejects.toThrow("symlink"); await expect(store.saveMediaSource(source)).rejects.toMatchObject({ code: "invalid-path" }); }); }); it("rejects directory sources with typed error code", async () => { await withTempStore(async (store, home) => { await expect(store.saveMediaSource(home)).rejects.toMatchObject({ code: "not-file" }); }); }); it("cleans old media files in first-level subdirectories", async () => { await withTempStore(async (store) => { const saved = await store.saveMediaBuffer(Buffer.from("nested"), "text/plain", "inbound"); const inboundDir = path.dirname(saved.path); const past = Date.now() - 10_000; await fs.utimes(saved.path, past / 1000, past / 1000); await store.cleanOldMedia(1); await expect(fs.stat(saved.path)).rejects.toThrow(); const inboundStat = await fs.stat(inboundDir); expect(inboundStat.isDirectory()).toBe(true); }); }); it("sets correct mime for xlsx by extension", async () => { await withTempStore(async (store, home) => { const xlsxPath = path.join(home, "sheet.xlsx"); await fs.mkdir(home, { recursive: true }); await fs.writeFile(xlsxPath, "not really an xlsx"); const saved = await store.saveMediaSource(xlsxPath); expect(saved.contentType).toBe( "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", ); expect(path.extname(saved.path)).toBe(".xlsx"); }); }); it("renames media based on detected mime even when extension is wrong", async () => { await withTempStore(async (store, home) => { const pngBytes = await sharp({ create: { width: 2, height: 2, channels: 3, background: "#00ff00" }, }) .png() .toBuffer(); const bogusExt = path.join(home, "image-wrong.bin"); await fs.writeFile(bogusExt, pngBytes); const saved = await store.saveMediaSource(bogusExt); expect(saved.contentType).toBe("image/png"); expect(path.extname(saved.path)).toBe(".png"); const buf = await fs.readFile(saved.path); expect(buf.equals(pngBytes)).toBe(true); }); }); it("sniffs xlsx mime for zip buffers and renames extension", async () => { await withTempStore(async (store, home) => { const zip = new JSZip(); zip.file( "[Content_Types].xml", '', ); zip.file("xl/workbook.xml", ""); const fakeXlsx = await zip.generateAsync({ type: "nodebuffer" }); const bogusExt = path.join(home, "sheet.bin"); await fs.writeFile(bogusExt, fakeXlsx); const saved = await store.saveMediaSource(bogusExt); expect(saved.contentType).toBe( "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", ); expect(path.extname(saved.path)).toBe(".xlsx"); }); }); it("prefers header mime extension when sniffed mime lacks mapping", async () => { await withTempStore(async (_store, home) => { vi.resetModules(); vi.doMock("./mime.js", async () => { const actual = await vi.importActual("./mime.js"); return { ...actual, detectMime: vi.fn(async () => "audio/opus"), }; }); try { const storeWithMock = await import("./store.js"); const buf = Buffer.from("fake-audio"); const saved = await storeWithMock.saveMediaBuffer(buf, "audio/ogg; codecs=opus"); expect(path.extname(saved.path)).toBe(".ogg"); expect(saved.path.startsWith(home)).toBe(true); } finally { vi.doUnmock("./mime.js"); } }); }); describe("extractOriginalFilename", () => { it("extracts original filename from embedded pattern", async () => { await withTempStore(async (store) => { // Pattern: {original}---{uuid}.{ext} const filename = "report---a1b2c3d4-e5f6-7890-abcd-ef1234567890.pdf"; const result = store.extractOriginalFilename(`/path/to/${filename}`); expect(result).toBe("report.pdf"); }); }); it("handles uppercase UUID pattern", async () => { await withTempStore(async (store) => { const filename = "Document---A1B2C3D4-E5F6-7890-ABCD-EF1234567890.docx"; const result = store.extractOriginalFilename(`/media/inbound/${filename}`); expect(result).toBe("Document.docx"); }); }); it("falls back to basename for non-matching patterns", async () => { await withTempStore(async (store) => { // UUID-only filename (legacy format) const uuidOnly = "a1b2c3d4-e5f6-7890-abcd-ef1234567890.pdf"; expect(store.extractOriginalFilename(`/path/${uuidOnly}`)).toBe(uuidOnly); // Regular filename without embedded pattern expect(store.extractOriginalFilename("/path/to/regular.txt")).toBe("regular.txt"); // Filename with --- but invalid UUID part expect(store.extractOriginalFilename("/path/to/foo---bar.txt")).toBe("foo---bar.txt"); }); }); it("preserves original name with special characters", async () => { await withTempStore(async (store) => { const filename = "报告_2024---a1b2c3d4-e5f6-7890-abcd-ef1234567890.pdf"; const result = store.extractOriginalFilename(`/media/${filename}`); expect(result).toBe("报告_2024.pdf"); }); }); }); describe("saveMediaBuffer with originalFilename", () => { it("embeds original filename in stored path when provided", async () => { await withTempStore(async (store) => { const buf = Buffer.from("test content"); const saved = await store.saveMediaBuffer( buf, "text/plain", "inbound", 5 * 1024 * 1024, "report.txt", ); // Should contain the original name and a UUID pattern expect(saved.id).toMatch(/^report---[a-f0-9-]{36}\.txt$/); expect(saved.path).toContain("report---"); // Should be able to extract original name const extracted = store.extractOriginalFilename(saved.path); expect(extracted).toBe("report.txt"); }); }); it("sanitizes unsafe characters in original filename", async () => { await withTempStore(async (store) => { const buf = Buffer.from("test"); // Filename with unsafe chars: < > : " / \ | ? * const saved = await store.saveMediaBuffer( buf, "text/plain", "inbound", 5 * 1024 * 1024, "my:test.txt", ); // Unsafe chars should be replaced with underscores expect(saved.id).toMatch(/^my_file_test---[a-f0-9-]{36}\.txt$/); }); }); it("truncates long original filenames", async () => { await withTempStore(async (store) => { const buf = Buffer.from("test"); const longName = "a".repeat(100) + ".txt"; const saved = await store.saveMediaBuffer( buf, "text/plain", "inbound", 5 * 1024 * 1024, longName, ); // Original name should be truncated to 60 chars const baseName = path.parse(saved.id).name.split("---")[0]; expect(baseName.length).toBeLessThanOrEqual(60); }); }); it("falls back to UUID-only when originalFilename not provided", async () => { await withTempStore(async (store) => { const buf = Buffer.from("test"); const saved = await store.saveMediaBuffer(buf, "text/plain", "inbound"); // Should be UUID-only pattern (legacy behavior) expect(saved.id).toMatch(/^[a-f0-9-]{36}\.txt$/); expect(saved.id).not.toContain("---"); }); }); }); });