wip [skip-pizza]

theopensystemslab · Nov 20, 2024 · 270eaaf · 270eaaf
1 parent d37679c
commit 270eaaf
Show file tree

Hide file tree

Showing 6 changed files with 1,152 additions and 14 deletions.
diff --git a/api.planx.uk/modules/file/service/deleteFile.ts b/api.planx.uk/modules/file/service/deleteFile.ts
@@ -5,15 +5,14 @@ export const deleteFilesByURL = async (
   fileURLs: string[],
 ): Promise<string[]> => {
   const keys = fileURLs.map(getS3KeyFromURL);
-  const result = await deleteFilesByKey(keys);
-  return result;
+  return await deleteFilesByKey(keys);
 };
 
 export const deleteFilesByKey = async (keys: string[]): Promise<string[]> => {
   const s3 = s3Factory();
   const params = getDeleteFilesParams(keys);
   try {
-    await s3.deleteObjects(params).promise();
+    s3.deleteObjects(params);
     return keys;
   } catch (error) {
     throw Error(`Failed to delete S3 files: ${error}`);

diff --git a/api.planx.uk/modules/file/service/getFile.ts b/api.planx.uk/modules/file/service/getFile.ts
@@ -1,14 +1,14 @@
-import type S3 from "aws-sdk/clients/s3.js";
+import type { PutObjectCommandInput } from "@aws-sdk/client-s3";
 import { s3Factory } from "./utils.js";
 
 export const getFileFromS3 = async (fileId: string) => {
   const s3 = s3Factory();
 
   const params = {
     Key: fileId,
-  } as S3.PutObjectRequest;
+  } as PutObjectCommandInput;
 
-  const file = await s3.getObject(params).promise();
+  const file = await s3.getObject(params);
 
   return {
     body: file.Body as Buffer,

diff --git a/api.planx.uk/modules/file/service/uploadFile.ts b/api.planx.uk/modules/file/service/uploadFile.ts
@@ -1,4 +1,4 @@
-import type S3 from "aws-sdk/clients/s3.js";
+import type { PutObjectCommandInput } from "@aws-sdk/client-s3";
 import { customAlphabet } from "nanoid";
 import mime from "mime";
 import { s3Factory } from "./utils.js";
@@ -14,7 +14,7 @@ export const uploadPublicFile = async (
 
   const { params, key, fileType } = generateFileParams(file, filename, filekey);
 
-  await s3.putObject(params).promise();
+  await s3.putObject(params);
   const fileUrl = buildFileUrl(key, "public");
 
   return {
@@ -36,7 +36,7 @@ export const uploadPrivateFile = async (
     is_private: "true",
   };
 
-  await s3.putObject(params).promise();
+  await s3.putObject(params);
   const fileUrl = buildFileUrl(key, "private");
 
   return {
@@ -63,7 +63,7 @@ export function generateFileParams(
   filename: string,
   filekey?: string,
 ): {
-  params: S3.PutObjectRequest;
+  params: PutObjectCommandInput;
   fileType: string | null;
   key: string;
 } {
@@ -76,7 +76,7 @@ export function generateFileParams(
     Body: file?.buffer || JSON.stringify(file),
     ContentDisposition: `inline;filename="${filename}"`,
     ContentType: file?.mimetype || "application/json",
-  } as S3.PutObjectRequest;
+  } as PutObjectCommandInput;
 
   return {
     fileType,

diff --git a/api.planx.uk/modules/file/service/utils.ts b/api.planx.uk/modules/file/service/utils.ts
@@ -1,12 +1,19 @@
-import S3 from "aws-sdk/clients/s3.js";
+import { S3 } from "@aws-sdk/client-s3";
 import { isLiveEnv } from "../../../helpers.js";
 
 export function s3Factory() {
   return new S3({
+    // The key params is no longer supported in v3, and can be removed.
+    // @deprecated The object needs to be passed to individual operations where it's intended.
     params: { Bucket: process.env.AWS_S3_BUCKET },
+
     region: process.env.AWS_S3_REGION,
-    accessKeyId: process.env.AWS_ACCESS_KEY,
-    secretAccessKey: process.env.AWS_SECRET_KEY,
+
+    credentials: {
+      accessKeyId: process.env.AWS_ACCESS_KEY,
+      secretAccessKey: process.env.AWS_SECRET_KEY,
+    },
+
     ...useMinio(),
   });
 }

diff --git a/api.planx.uk/package.json b/api.planx.uk/package.json
@@ -11,6 +11,7 @@
   },
   "dependencies": {
     "@airbrake/node": "^2.1.8",
+    "@aws-sdk/client-s3": "^3.696.0",
     "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#ccf9ac3",
     "@types/isomorphic-fetch": "^0.0.36",
     "adm-zip": "^0.5.10",