chore: Move to Typescript (#2783)

This PR moves the entire project to Typescript. Due to the ~1000 ignores this will lead to a messy codebase for a while, but the churn is worth it – all of those ignore comments are places that were never type-safe previously.

closes #1282

server/commands/documentImporter.test.ts

@@ -0,0 +1,205 @@
+import path from "path";
+// @ts-expect-error ts-migrate(7016) FIXME: Could not find a declaration file for module 'form... Remove this comment to see the full error message
+import File from "formidable/lib/file";
+import { Attachment } from "@server/models";
+import { buildUser } from "@server/test/factories";
+import { flushdb } from "@server/test/support";
+import documentImporter from "./documentImporter";
+
+jest.mock("../utils/s3");
+beforeEach(() => flushdb());
+describe("documentImporter", () => {
+  const ip = "127.0.0.1";
+
+  it("should convert Word Document to markdown", async () => {
+    const user = await buildUser();
+    const name = "images.docx";
+    const file = new File({
+      name,
+      type:
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    const attachments = await Attachment.count();
+    expect(attachments).toEqual(1);
+    expect(response.text).toContain("This is a test document for images");
+    expect(response.text).toContain("![](/api/attachments.redirect?id=");
+    expect(response.title).toEqual("images");
+  });
+
+  it("should convert Word Document to markdown for application/octet-stream mimetype", async () => {
+    const user = await buildUser();
+    const name = "images.docx";
+    const file = new File({
+      name,
+      type: "application/octet-stream",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    const attachments = await Attachment.count();
+    expect(attachments).toEqual(1);
+    expect(response.text).toContain("This is a test document for images");
+    expect(response.text).toContain("![](/api/attachments.redirect?id=");
+    expect(response.title).toEqual("images");
+  });
+
+  it("should error when a file with application/octet-stream mimetype doesn't have .docx extension", async () => {
+    const user = await buildUser();
+    const name = "normal.docx.txt";
+    const file = new File({
+      name,
+      type: "application/octet-stream",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    let error;
+
+    try {
+      await documentImporter({
+        user,
+        file,
+        ip,
+      });
+    } catch (err) {
+      error = err.message;
+    }
+
+    expect(error).toEqual("File type application/octet-stream not supported");
+  });
+
+  it("should convert Word Document on Windows to markdown", async () => {
+    const user = await buildUser();
+    const name = "images.docx";
+    const file = new File({
+      name,
+      type: "application/octet-stream",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    const attachments = await Attachment.count();
+    expect(attachments).toEqual(1);
+    expect(response.text).toContain("This is a test document for images");
+    expect(response.text).toContain("![](/api/attachments.redirect?id=");
+    expect(response.title).toEqual("images");
+  });
+
+  it("should convert HTML Document to markdown", async () => {
+    const user = await buildUser();
+    const name = "webpage.html";
+    const file = new File({
+      name,
+      type: "text/html",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    expect(response.text).toContain("Text paragraph");
+    expect(response.title).toEqual("Heading 1");
+  });
+
+  it("should convert Confluence Word output to markdown", async () => {
+    const user = await buildUser();
+    const name = "confluence.doc";
+    const file = new File({
+      name,
+      type: "application/msword",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    expect(response.text).toContain("this is a test document");
+    expect(response.title).toEqual("Heading 1");
+  });
+
+  it("should load markdown", async () => {
+    const user = await buildUser();
+    const name = "markdown.md";
+    const file = new File({
+      name,
+      type: "text/plain",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    expect(response.text).toContain("This is a test paragraph");
+    expect(response.title).toEqual("Heading 1");
+  });
+
+  it("should handle encoded slashes", async () => {
+    const user = await buildUser();
+    const name = "this %2F and %2F this.md";
+    const file = new File({
+      name,
+      type: "text/plain",
+      path: path.resolve(__dirname, "..", "test", "fixtures", "empty.md"),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    expect(response.text).toContain("");
+    expect(response.title).toEqual("this / and / this");
+  });
+
+  it("should fallback to extension if mimetype unknown", async () => {
+    const user = await buildUser();
+    const name = "markdown.md";
+    const file = new File({
+      name,
+      type: "application/lol",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    const response = await documentImporter({
+      user,
+      file,
+      ip,
+    });
+    expect(response.text).toContain("This is a test paragraph");
+    expect(response.title).toEqual("Heading 1");
+  });
+
+  it("should error with unknown file type", async () => {
+    const user = await buildUser();
+    const name = "files.zip";
+    const file = new File({
+      name,
+      type: "executable/zip",
+      path: path.resolve(__dirname, "..", "test", "fixtures", name),
+    });
+    let error;
+
+    try {
+      await documentImporter({
+        user,
+        file,
+        ip,
+      });
+    } catch (err) {
+      error = err.message;
+    }
+
+    expect(error).toEqual("File type executable/zip not supported");
+  });
+});