refactor(s3): replace put with putObject

Author: ycdzj

src/attachments/attachments.service.ts

@@ -88,14 +88,14 @@ export class AttachmentsService {
       ResourcePermission.CAN_EDIT,
     );
 
-    const { key, objectName } = await this.s3Service.generateObjectKey(
+    const { objectKey, objectName } = await this.s3Service.generateObjectKey(
       'attachments',
       filename,
     );
     const metadata = {
       filename: encodeFileName(filename),
     };
-    await this.s3Service.putObject(key, buffer, mimetype, metadata);
+    await this.s3Service.putObject(objectKey, buffer, mimetype, metadata);
 
     // Create the resource-attachment relation
     await this.resourceAttachmentsService.addAttachmentToResource(

src/feedback/feedback.controller.ts

@@ -58,12 +58,12 @@ export class FeedbackController {
 
     if (image) {
       const originalname = encodeFileName(image.originalname);
-      imageUrl = await this.s3Service.put(
+      const { objectKey, objectName } = await this.s3Service.generateObjectKey(
+        'feedback',
         originalname,
-        image.buffer,
-        image.mimetype,
-        { folder: 'feedback' },
       );
+      await this.s3Service.putObject(objectKey, image.buffer, image.mimetype);
+      imageUrl = objectName;
     }
 
     const userAgent = request.get('User-Agent');

src/s3/s3.service.ts

@@ -13,16 +13,7 @@ import {
 } from '@aws-sdk/client-s3';
 import { Readable } from 'stream';
 import generateId from 'omniboxd/utils/generate-id';
-import {
-  encodeFileName,
-  getOriginalFileName,
-} from 'omniboxd/utils/encode-filename';
-
-export interface PutOptions {
-  id?: string;
-  metadata?: Record<string, string>;
-  folder?: string;
-}
+import { getOriginalFileName } from 'omniboxd/utils/encode-filename';
 
 export class ObjectMeta {
   constructor(
@@ -126,15 +117,15 @@ export class S3Service implements OnModuleInit {
     prefix: string,
     filename?: string,
     length: number = 32,
-  ): Promise<{ key: string; objectName: string }> {
+  ): Promise<{ objectKey: string; objectName: string }> {
     if (!prefix.endsWith('/')) {
       prefix += '/';
     }
     for (let i = 0; i < 5; i++) {
       const objectName = this.generateId(filename, length);
-      const key = `${prefix}${objectName}`;
-      if ((await this.headObject(key)) === null) {
-        return { key, objectName };
+      const objectKey = `${prefix}${objectName}`;
+      if ((await this.headObject(objectKey)) === null) {
+        return { objectKey, objectName };
       }
     }
     throw new Error('Unable to generate unique S3 key');
@@ -197,19 +188,4 @@ export class S3Service implements OnModuleInit {
     });
     return await this.s3Client.send(command);
   }
-
-  async put(
-    filename: string,
-    buffer: Buffer,
-    mimetype: string,
-    options?: PutOptions,
-  ): Promise<string> {
-    const { id = this.generateId(filename) } = options || {};
-    const path: string = options?.folder ? `${options.folder}/${id}` : id;
-    await this.putObject(path, buffer, mimetype, {
-      ...options?.metadata,
-      filename: encodeFileName(filename),
-    });
-    return id;
-  }
 }

src/wizard/wizard.service.ts

@@ -157,31 +157,35 @@ export class WizardService {
       resourceDto,
     );
 
-    const filename = 'html.gz';
-    const id = await this.s3Service.put(
-      filename,
+    const { objectKey } = await this.s3Service.generateObjectKey(
+      this.gzipHtmlFolder,
+      'html.gz',
+    );
+    const metadata = {
+      resourceId: resource.id,
+      url,
+    };
+    await this.s3Service.putObject(
+      objectKey,
       compressedHtml.buffer,
       compressedHtml.mimetype,
-      {
-        folder: this.gzipHtmlFolder,
-        metadata: { resourceId: resource.id, url },
-      },
+      metadata,
     );
 
     if (this.isVideoUrl(url)) {
       const task = await this.wizardTaskService.createGenerateVideoNoteTask(
         userId,
         namespaceId,
         resource.id,
-        { html: [this.gzipHtmlFolder, id].join('/'), url, title },
+        { html: objectKey, url, title },
       );
       return { task_id: task.id, resource_id: resource.id };
     } else {
       const task = await this.wizardTaskService.createCollectTask(
         userId,
         namespaceId,
         resource.id,
-        { html: [this.gzipHtmlFolder, id].join('/'), url, title },
+        { html: objectKey, url, title },
       );
       return { task_id: task.id, resource_id: resource.id };
     }