import { existsSync, copyFileSync } from "node:fs"; import { readFile } from "node:fs/promises"; import path from "node:path"; import FormData from "form-data"; import { ensureDirSync } from "fs-extra"; import JWT from "jsonwebtoken"; import { FileOperationState, FileOperationType } from "@shared/types"; import env from "@server/env"; import AttachmentHelper, { Buckets, } from "@server/models/helpers/AttachmentHelper"; import FileStorage from "@server/storage/files"; import { buildApiKey, buildAttachment, buildFileOperation, buildUser, } from "@server/test/factories"; import { getTestServer } from "@server/test/support"; import { randomUUID } from "node:crypto"; const server = getTestServer(); describe("#files.create", () => { it("should fail with status 400 bad request if key is invalid", async () => { const user = await buildUser(); const res = await server.post("/api/files.create", user, { body: { key: "public/foo/bar/baz.png", }, }); expect(res.status).toEqual(400); }); it("should fail with status 401 if associated attachment does not belong to user", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); const res = await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); expect(res.status).toEqual(403); }); it("should fail with status 401 if file exists on disk", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { userId: user.id, teamId: user.teamId, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", fileName), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key) ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); const res = await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); expect(res.status).toEqual(400); }); it("should fail with status 400 if uploaded file exceeds declared size", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, size: 100, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); const res = await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); expect(res.status).toEqual(400); expect( existsSync(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key)) ).toBe(false); }); it("should update attachment size to actual uploaded bytes", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, size: 1_000_000, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); const res = await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); expect(res.status).toEqual(200); await attachment.reload(); expect(Number(attachment.size)).toEqual(content.byteLength); }); it("should succeed with status 200 ok and create a file", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); const res = await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); const body = await res.json(); expect(res.status).toEqual(200); expect(body.success).toEqual(true); expect( existsSync(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key)) ).toBe(true); }); it("should succeed with a valid upload signature and no session", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const sig = JWT.sign( { key: attachment.key, type: "attachment-upload" }, env.SECRET_KEY, { expiresIn: 3600 } ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); form.append("sig", sig); const res = await server.post(`/api/files.create`, { headers: form.getHeaders(), body: form, }); const body = await res.json(); expect(res.status).toEqual(200); expect(body.success).toEqual(true); expect( existsSync(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key)) ).toBe(true); }); it("should fail with a signature scoped to a different key", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const sig = JWT.sign( { key: "public/foo/bar/other.png", type: "attachment-upload" }, env.SECRET_KEY, { expiresIn: 3600 } ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); form.append("sig", sig); const res = await server.post(`/api/files.create`, { headers: form.getHeaders(), body: form, }); expect(res.status).toEqual(401); expect( existsSync(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key)) ).toBe(false); }); it("should fail with status 401 when neither session nor signature is provided", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); const res = await server.post(`/api/files.create`, { headers: form.getHeaders(), body: form, }); expect(res.status).toEqual(401); }); }); describe("#files.get", () => { it("should fail with status 404 if existing file is requested with key", async () => { const user = await buildUser(); const fileName = "images.docx"; const key = path.join("uploads", user.id, crypto.randomUUID(), fileName); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", fileName), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); const res = await server.get(`/api/files.get?key=${key}`); expect(res.status).toEqual(404); }); it("should fail with status 404 if non-existing file is requested with key", async () => { const user = await buildUser(); const fileName = "images.docx"; const key = path.join("uploads", user.id, crypto.randomUUID(), fileName); const res = await server.get(`/api/files.get?key=${key}`); expect(res.status).toEqual(404); }); it("should fail with status 400 bad request if key is invalid", async () => { const res = await server.get(`/api/files.get?key=public/foo/bar/baz.png`); expect(res.status).toEqual(400); }); it("should fail with status 400 bad request if neither key or sig is supplied", async () => { const res = await server.get("/api/files.get"); const body = await res.json(); expect(res.status).toEqual(400); expect(body.message).toEqual("query: One of key or sig is required"); }); it("should succeed with status 200 ok when attachment is requested using key", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { acl: "public-read", key: AttachmentHelper.getKey({ id: randomUUID(), name: fileName, userId: user.id, }).replace(Buckets.uploads, Buckets.public), teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); const res = await server.get(attachment.canonicalUrl); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual(attachment.contentType); expect(res.headers.get("Content-Disposition")).toEqual( 'attachment; filename="images.docx"' ); }); it("should succeed with status 200 ok when private attachment is requested using signature", async () => { const user = await buildUser(); const fileName = "images.docx"; const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", acl: "private", }, fileName ); const content = await readFile( path.resolve(__dirname, "..", "test", "fixtures", fileName) ); const form = new FormData(); form.append("key", attachment.key); form.append("file", content, fileName); await server.post(`/api/files.create`, user, { headers: form.getHeaders(), body: form, }); const url = new URL(await attachment.signedUrl); const res = await server.get(url.pathname + url.search); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual(attachment.contentType); expect(res.headers.get("Content-Disposition")).toEqual( 'attachment; filename="images.docx"' ); }); it("should succeed with status 200 ok when file is requested using signature", async () => { const user = await buildUser(); const fileName = "images.docx"; const { key } = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document", acl: "private", }, fileName ); const signedUrl = await FileStorage.getSignedUrl(key); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", fileName), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); const url = new URL(signedUrl); const res = await server.get(url.pathname + url.search); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual( "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ); expect(res.headers.get("Content-Disposition")).toEqual( 'attachment; filename="images.docx"' ); }); it("should succeed with status 200 ok when avatar is requested using key and the attachment is deleted", async () => { const user = await buildUser(); const key = path.join("avatars", user.id, crypto.randomUUID()); const attachment = await buildAttachment({ key, teamId: user.teamId, userId: user.id, contentType: "image/jpg", acl: "public-read", }); await attachment.destroy({ hooks: false, }); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", "avatar.jpg"), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); const res = await server.get(`/api/files.get?key=${key}`); expect(res.status).toEqual(200); expect(res.headers.get("Content-Disposition")).toEqual("attachment"); }); it("should succeed with status 200 ok when avatar is requested using key", async () => { const user = await buildUser(); const key = path.join("avatars", user.id, crypto.randomUUID()); await buildAttachment({ key, teamId: user.teamId, userId: user.id, contentType: "image/jpg", acl: "public-read", }); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", "avatar.jpg"), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); const res = await server.get(`/api/files.get?key=${key}`); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual("image/jpg"); expect(res.headers.get("Content-Disposition")).toEqual("attachment"); }); it("should succeed with status 200 ok when public-read avatar in uploads bucket is requested by non-owner", async () => { const owner = await buildUser(); const otherUser = await buildUser({ teamId: owner.teamId }); const key = AttachmentHelper.getKey({ id: randomUUID(), name: "avatar.jpg", userId: owner.id, }); await buildAttachment({ key, teamId: owner.teamId, userId: owner.id, contentType: "image/jpg", acl: "public-read", }); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", "avatar.jpg"), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); // Non-owner user should be able to access public-read attachment const res = await server.get(`/api/files.get?key=${key}`, { headers: { Authorization: `Bearer ${otherUser.getSessionToken()}`, }, }); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual("image/jpg"); }); it("should fail with status 403 when private attachment in uploads bucket is requested by non-owner", async () => { const owner = await buildUser(); const otherUser = await buildUser({ teamId: owner.teamId }); const key = AttachmentHelper.getKey({ id: randomUUID(), name: "document.pdf", userId: owner.id, }); await buildAttachment({ key, teamId: owner.teamId, userId: owner.id, contentType: "application/pdf", acl: "private", }); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", "avatar.jpg"), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); // Non-owner user should NOT be able to access private attachment const res = await server.get(`/api/files.get?key=${key}`, { headers: { Authorization: `Bearer ${otherUser.getSessionToken()}`, }, }); expect(res.status).toEqual(403); }); it("should succeed with status 200 ok when exported file is requested using signature", async () => { const user = await buildUser(); const fileName = "export-markdown.zip"; const key = `${Buckets.uploads}/${user.teamId}/${crypto.randomUUID()}/${fileName}`; await buildFileOperation({ userId: user.id, teamId: user.teamId, type: FileOperationType.Export, state: FileOperationState.Complete, key, }); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", fileName), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); const signedUrl = await FileStorage.getSignedUrl(key); const url = new URL(signedUrl); const res = await server.get(url.pathname + url.search); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual("application/zip"); expect(res.headers.get("Content-Disposition")).toEqual( 'attachment; filename="export-markdown.zip"' ); }); it("should succeed with status 200 ok when signed file is requested with an API key lacking scope", async () => { const user = await buildUser(); const apiKey = await buildApiKey({ userId: user.id, scope: ["/api/fileOperations.redirect"], }); const fileName = "export-markdown.zip"; const key = `${Buckets.uploads}/${user.teamId}/${crypto.randomUUID()}/${fileName}`; await buildFileOperation({ userId: user.id, teamId: user.teamId, type: FileOperationType.Export, state: FileOperationState.Complete, key, }); ensureDirSync( path.dirname(path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key)) ); copyFileSync( path.resolve(__dirname, "..", "test", "fixtures", fileName), path.join(env.FILE_STORAGE_LOCAL_ROOT_DIR, key) ); const signedUrl = await FileStorage.getSignedUrl(key); const url = new URL(signedUrl); const res = await server.get(url.pathname + url.search, { headers: { authorization: `Bearer ${apiKey.value}` }, }); expect(res.status).toEqual(200); expect(res.headers.get("Content-Type")).toEqual("application/zip"); }); }); describe("#files.get byte ranges", () => { const fileName = "avatar.jpg"; const buildFile = async () => { const user = await buildUser(); const attachment = await buildAttachment( { teamId: user.teamId, userId: user.id, contentType: "image/jpeg", acl: "public-read", }, fileName ); const source = path.resolve(__dirname, "..", "test", "fixtures", fileName); const destination = path.join( env.FILE_STORAGE_LOCAL_ROOT_DIR, attachment.key ); ensureDirSync(path.dirname(destination)); copyFileSync(source, destination); return { key: attachment.key, content: await readFile(source) }; }; it("should serve the whole file when no range is requested", async () => { const { key, content } = await buildFile(); const res = await server.get(`/api/files.get?key=${key}`); expect(res.status).toEqual(200); expect(res.headers.get("Accept-Ranges")).toEqual("bytes"); expect(res.headers.get("Content-Length")).toEqual(String(content.length)); }); it("should serve the requested range", async () => { const { key, content } = await buildFile(); const res = await server.get(`/api/files.get?key=${key}`, { headers: { Range: "bytes=-100" }, }); expect(res.status).toEqual(206); expect(res.headers.get("Content-Length")).toEqual("100"); expect(res.headers.get("Content-Range")).toEqual( `bytes ${content.length - 100}-${content.length - 1}/${content.length}` ); expect(Buffer.from(await res.arrayBuffer())).toEqual( content.subarray(-100) ); }); it("should fail with status 416 when the range cannot be satisfied", async () => { const { key, content } = await buildFile(); const res = await server.get(`/api/files.get?key=${key}`, { headers: { Range: `bytes=${content.length}-` }, }); expect(res.status).toEqual(416); expect(res.headers.get("Content-Range")).toEqual( `bytes */${content.length}` ); }); });