test: Bring file module coverage back up to 100\%

theopensystemslab · Nov 28, 2024 · 888091e · 888091e
1 parent 541aa4a
commit 888091e
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 12 deletions.
diff --git a/api.planx.uk/modules/file/file.test.ts b/api.planx.uk/modules/file/file.test.ts
@@ -74,16 +74,19 @@ describe("File upload", () => {
     });
 
     it("should upload file", async () => {
+      vi.stubEnv("API_URL_EXT", "https://api.editor.planx.dev");
+      vi.stubEnv("AWS_S3_BUCKET", "myBucketName");
+
       await supertest(app)
         .post(ENDPOINT)
         .field("filename", "some_file.txt")
         .attach("file", Buffer.from("some data"), "some_file.txt")
         .then((res) => {
           expect(res.body).toEqual({
             fileType: "text/plain",
-            fileUrl: expect.stringContaining(
-              "/file/private/nanoid/modified%20key",
-            ),
+            // Bucket name stripped from URL
+            fileUrl:
+              "https://api.editor.planx.dev/file/private/nanoid/modified%20key",
           });
         });
       expect(mockPutObject).toHaveBeenCalledTimes(1);
@@ -103,6 +106,26 @@ describe("File upload", () => {
         });
       expect(mockPutObject).toHaveBeenCalledTimes(1);
     });
+
+    it("should generate a correct URL on production", async () => {
+      vi.stubEnv("API_URL_EXT", "https://api.editor.planx.dev");
+      vi.stubEnv("NODE_ENV", "production");
+
+      await supertest(app)
+        .post(ENDPOINT)
+        .field("filename", "some_file.txt")
+        .attach("file", Buffer.from("some data"), "some_file.txt")
+        .then((res) => {
+          expect(res.body).toEqual({
+            fileType: "text/plain",
+            fileUrl: expect.stringContaining(
+              "/file/private/nanoid/modified%20key",
+            ),
+          });
+        });
+      expect(mockPutObject).toHaveBeenCalledTimes(1);
+      expect(getSignedUrl).toHaveBeenCalledTimes(1);
+    });
   });
 
   describe("Public", () => {
@@ -237,14 +260,29 @@ describe("File download", () => {
 
       await supertest(app)
         .get("/file/public/someKey/someFile.txt")
-        .field("filename", "some_file.txt")
-        .attach("file", Buffer.from("some data"), "some_file.txt")
         .expect(500)
         .then((res) => {
           expect(res.body.error).toMatch(/S3 error!/);
         });
       expect(mockGetObject).toHaveBeenCalledTimes(1);
     });
+
+    it("should handle an empty file body", async () => {
+      mockGetObject = vi.fn(() =>
+        Promise.resolve({
+          ...getObjectResponse,
+          Body: undefined,
+        }),
+      );
+
+      await supertest(app)
+        .get("/file/public/someKey/someFile.txt")
+        .expect(500)
+        .then((res) => {
+          expect(res.body.error).toMatch(/Missing body from S3 file/);
+        });
+      expect(mockGetObject).toHaveBeenCalledTimes(1);
+    });
   });
 
   describe("Private", () => {

diff --git a/api.planx.uk/modules/file/service/getFile.ts b/api.planx.uk/modules/file/service/getFile.ts
@@ -11,7 +11,6 @@ export const getFileFromS3 = async (fileId: string) => {
 
   const file = await s3.getObject(params);
 
-  // TODO: test this
   if (!file.Body) throw Error(`Missing body from S3 file ${fileId}`);
 
   const body = Buffer.from(await file.Body.transformToByteArray());

diff --git a/api.planx.uk/modules/file/service/uploadFile.ts b/api.planx.uk/modules/file/service/uploadFile.ts
@@ -79,9 +79,9 @@ export function generateFileParams(
     ACL: "public-read",
     Bucket: process.env.AWS_S3_BUCKET,
     Key: key,
-    Body: file?.buffer || JSON.stringify(file),
+    Body: file.buffer,
     ContentDisposition: `inline;filename="${filename}"`,
-    ContentType: file?.mimetype || "application/json",
+    ContentType: file.mimetype,
   };
 
   return {

diff --git a/api.planx.uk/vitest.config.ts b/api.planx.uk/vitest.config.ts
@@ -13,10 +13,10 @@ export default defineConfig({
       // html reporter required to inspect coverage in Vitest UI dashboard
       reporter: ["lcov", "html", "text-summary"],
       thresholds: {
-        statements: 72.03,
-        branches: 54.92,
-        functions: 67.62,
-        lines: 71.84,
+        statements: 73.28,
+        branches: 55.27,
+        functions: 73.59,
+        lines: 73.42,
         autoUpdate: true,
       },
     },