feat(v2): add temp-photo/upload/{start,finish} endpoints (#728) (#729)

vince-hz · hyrious · web-flow · commit cea970d9385e · 2023-05-31T10:12:55.000+08:00
Co-authored-by: hyrious &lt;hyrious@outlook.com&gt;
diff --git a/config/defaults.yaml b/config/defaults.yaml
@@ -49,6 +49,16 @@ cloud_storage:
     - gif
     - mp3
     - mp4
+  temp_photo:
+    # max single file size: 5M
+    single_file_size: 5242880
+    # max files per day per user: 60
+    total_files: 60
+    prefix_path: cloud-storage/temp-photo
+    allow_suffix:
+      - png
+      - jpg
+      - jpeg
 
 user:
   avatar:
diff --git a/config/test.yaml b/config/test.yaml
@@ -44,6 +44,14 @@ cloud_storage:
     - gif
     - mp3
     - mp4
+  temp_photo:
+    single_file_size: 5242880
+    total_files: 60
+    prefix_path: cloud-storage/temp-photo
+    allow_suffix:
+      - png
+      - jpg
+      - jpeg
 
 user:
   avatar:
diff --git a/src/constants/Config.ts b/src/constants/Config.ts
@@ -142,6 +142,12 @@ export const CloudStorage = {
     totalSize: config.cloud_storage.total_size,
     prefixPath: config.cloud_storage.prefix_path,
     allowFileSuffix: config.cloud_storage.allow_file_suffix,
+    tempPhoto: {
+        singleFileSize: config.cloud_storage.temp_photo.single_file_size,
+        totalFiles: config.cloud_storage.temp_photo.total_files,
+        prefixPath: config.cloud_storage.temp_photo.prefix_path,
+        allowSuffix: config.cloud_storage.temp_photo.allow_suffix,
+    },
 };
 
 export const StorageService = {
diff --git a/src/plugins/Ajv.ts b/src/plugins/Ajv.ts
@@ -41,6 +41,14 @@ const avatarSuffix: FormatDefinition<string> = {
     },
 };
 
+const tempPhotoSuffix: FormatDefinition<string> = {
+    validate: fileName => {
+        const suffix = path.extname(fileName).slice(1).toLowerCase();
+
+        return CloudStorage.tempPhoto.allowSuffix.includes(suffix);
+    },
+};
+
 const oauthLogoSuffix: FormatDefinition<string> = {
     validate: fileName => {
         const suffix = path.extname(fileName).slice(1).toLowerCase();
@@ -98,6 +106,7 @@ export const ajvSelfPlugin = (ajv: Ajv): void => {
     ajv.addFormat("uuid-v4", uuidV4);
     ajv.addFormat("file-suffix", fileSuffix);
     ajv.addFormat("avatar-suffix", avatarSuffix);
+    ajv.addFormat("temp-photo-suffix", tempPhotoSuffix);
     ajv.addFormat("oauth-logo-suffix", oauthLogoSuffix);
     ajv.addFormat("url", url);
     ajv.addFormat("https", https);
diff --git a/src/utils/ParseConfig.ts b/src/utils/ParseConfig.ts
@@ -66,6 +66,12 @@ type Config = {
         total_size: number;
         prefix_path: string;
         allow_file_suffix: string[];
+        temp_photo: {
+            single_file_size: number;
+            total_files: number;
+            prefix_path: string;
+            allow_suffix: string[];
+        };
     };
     user: {
         avatar: {
diff --git a/src/utils/Redis.ts b/src/utils/Redis.ts
@@ -9,6 +9,8 @@ export const RedisKey = {
     agoraRTMUserToken: (userUUID: string): string => `agora:rtm:userUUID:${userUUID}`,
     cloudStorageFileInfo: (userUUID: string, fileUUID: string): string =>
         `cloudStorage:${userUUID}:${fileUUID}`,
+    cloudStorageTempPhotoInfo: (userUUID: string, fileUUID: string): string =>
+        `cloudStorage:tempPhoto:${userUUID}:${fileUUID}`,
     userAvatarFileInfo: (userUUID: string, fileUUID: string): string =>
         `user:avatar:${userUUID}:${fileUUID}`,
     roomInviteCode: (inviteCode: string): string => `room:invite:${inviteCode}`,
diff --git a/src/v2/controllers/routes.ts b/src/v2/controllers/routes.ts
@@ -4,6 +4,7 @@ import { developerOAuthRouters } from "./developer/routes";
 import { applicationRouters } from "./application/routes";
 import { roomRouters } from "./room/routes";
 import { oauthRouters } from "./auth2/routes";
+import { tempPhotoRouters } from "./temp-photo/routes";
 
 export const v2Routes = [
     userRouters,
@@ -12,4 +13,5 @@ export const v2Routes = [
     applicationRouters,
     roomRouters,
     oauthRouters,
+    tempPhotoRouters,
 ];
diff --git a/src/v2/controllers/temp-photo/routes.ts b/src/v2/controllers/temp-photo/routes.ts
@@ -0,0 +1,13 @@
+import { Server } from "../../../utils/registryRoutersV2";
+import { tempPhotoUploadStart, tempPhotoUploadStartSchema } from "./upload/start";
+import { tempPhotoUploadFinish, tempPhotoUploadFinishSchema } from "./upload/finish";
+
+export const tempPhotoRouters = (server: Server): void => {
+    server.post("temp-photo/upload/start", tempPhotoUploadStart, {
+        schema: tempPhotoUploadStartSchema,
+    });
+
+    server.post("temp-photo/upload/finish", tempPhotoUploadFinish, {
+        schema: tempPhotoUploadFinishSchema,
+    });
+};
diff --git a/src/v2/controllers/temp-photo/upload/finish.ts b/src/v2/controllers/temp-photo/upload/finish.ts
@@ -0,0 +1,33 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { successJSON } from "../../internal/utils/response-json";
+import { CloudStorageUploadService } from "../../../services/cloud-storage/upload";
+
+export const tempPhotoUploadFinishSchema = {
+    body: Type.Object(
+        {
+            fileUUID: Type.String({
+                format: "uuid-v4",
+            }),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const tempPhotoUploadFinish = async (
+    req: FastifyRequestTypebox<typeof tempPhotoUploadFinishSchema>,
+): Promise<Response> => {
+    const cloudStorageUploadSVC = new CloudStorageUploadService(
+        req.ids,
+        req.DBTransaction,
+        req.userUUID,
+    );
+
+    await cloudStorageUploadSVC.tempPhotoFinish({
+        fileUUID: req.body.fileUUID,
+    });
+
+    return successJSON({});
+};
diff --git a/src/v2/controllers/temp-photo/upload/start.ts b/src/v2/controllers/temp-photo/upload/start.ts
@@ -0,0 +1,46 @@
+import { Static, Type } from "@sinclair/typebox";
+import { CloudStorage } from "../../../../constants/Config";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { successJSON } from "../../internal/utils/response-json";
+import { CloudStorageUploadService } from "../../../services/cloud-storage/upload";
+import { uploadStartReturnSchema } from "../../../services/cloud-storage/upload.schema";
+import { useOnceService } from "../../../service-locator";
+
+export const tempPhotoUploadStartSchema = {
+    body: Type.Object(
+        {
+            fileName: Type.String({
+                minLength: 3,
+                maxLength: 128,
+                format: "temp-photo-suffix",
+            }),
+            fileSize: Type.Integer({
+                maximum: CloudStorage.tempPhoto.singleFileSize,
+                minimum: 1,
+            }),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const tempPhotoUploadStart = async (
+    req: FastifyRequestTypebox<typeof tempPhotoUploadStartSchema>,
+): Promise<Response<Static<typeof uploadStartReturnSchema>>> => {
+    const complianceText = useOnceService("complianceText", req.ids);
+    await complianceText.assertTextNormal(req.body.fileName);
+
+    const cloudStorageUploadSVC = new CloudStorageUploadService(
+        req.ids,
+        req.DBTransaction,
+        req.userUUID,
+    );
+
+    const result = await cloudStorageUploadSVC.tempPhotoStart({
+        fileName: req.body.fileName,
+        fileSize: req.body.fileSize,
+    });
+
+    return successJSON(result);
+};
diff --git a/src/v2/services/cloud-storage/upload.ts b/src/v2/services/cloud-storage/upload.ts
@@ -6,6 +6,9 @@ import {
     CloudStorageUploadStartReturn,
     GetFileInfoByRedisReturn,
     InsertFileInfo,
+    TempPhotoUploadFinishConfig,
+    TempPhotoUploadStartConfig,
+    TempPhotoUploadStartReturn,
 } from "./upload.type";
 import { FError } from "../../../error/ControllerError";
 import { ErrorCode } from "../../../ErrorCode";
@@ -251,4 +254,95 @@ export class CloudStorageUploadService {
               }
             : {};
     }
+
+    // Codes below are for temp photo uploading.
+    public static generateTempPhotoOSSFilePath = (fileName: string, fileUUID: string): string => {
+        const datePath = format("yyyy-MM/dd")(Date.now());
+        const prefix = CloudStorage.tempPhoto.prefixPath;
+        // e.g: PREFIX/temp-photo/2021-10/19/UUID/UUID.jpg
+        return `${prefix}/${datePath}/${fileUUID}/${fileUUID}${path.extname(fileName)}`;
+    };
+
+    public async assertTempPhotoConcurrentLimit(): Promise<void> {
+        const uploadingFiles = await RedisService.scan(
+            RedisKey.cloudStorageTempPhotoInfo(this.userUUID, "*"),
+            CloudStorage.tempPhoto.totalFiles + 1,
+        );
+
+        if (uploadingFiles.length >= CloudStorage.tempPhoto.totalFiles) {
+            throw new FError(ErrorCode.UploadConcurrentLimit);
+        }
+    }
+
+    public async getTempPhotoFileInfoByRedis(
+        fileUUID: string,
+    ): Promise<TempPhotoUploadStartConfig> {
+        const fileInfo = await RedisService.hmget(
+            RedisKey.cloudStorageTempPhotoInfo(this.userUUID, fileUUID),
+            ["fileName", "fileSize"],
+        );
+
+        const fileName = fileInfo[0];
+        const fileSize = Number(fileInfo[1] || undefined);
+
+        if (!fileName || Number.isNaN(fileSize)) {
+            this.logger.info("not found temp photo in redis", {
+                CloudStorageUpload: {
+                    fileNameIsEmpty: !fileName,
+                    fileSizeIsNaN: Number.isNaN(fileSize),
+                },
+            });
+            throw new FError(ErrorCode.FileNotFound);
+        }
+
+        return {
+            fileName,
+            fileSize,
+        };
+    }
+
+    public async tempPhotoStart(
+        config: TempPhotoUploadStartConfig,
+    ): Promise<TempPhotoUploadStartReturn> {
+        const { fileName, fileSize } = config;
+        await this.assertTempPhotoConcurrentLimit();
+
+        const fileUUID = v4();
+        const oneDay = 60 * 60 * 24;
+        await RedisService.hmset(
+            RedisKey.cloudStorageTempPhotoInfo(this.userUUID, fileUUID),
+            {
+                fileName,
+                fileSize: String(fileSize),
+            },
+            oneDay,
+        );
+
+        const ossFilePath = CloudStorageUploadService.generateTempPhotoOSSFilePath(
+            fileName,
+            fileUUID,
+        );
+        const { policy, signature } = this.oss.policyTemplate(fileName, ossFilePath, fileSize);
+
+        return {
+            fileUUID,
+            ossFilePath,
+            ossDomain: this.oss.domain,
+            policy,
+            signature,
+        };
+    }
+
+    public async tempPhotoFinish(config: TempPhotoUploadFinishConfig): Promise<void> {
+        const { fileUUID } = config;
+
+        const { fileName } = await this.getTempPhotoFileInfoByRedis(fileUUID);
+
+        const ossFilePath = CloudStorageUploadService.generateTempPhotoOSSFilePath(
+            fileName,
+            fileUUID,
+        );
+
+        await this.oss.assertExists(ossFilePath);
+    }
 }
diff --git a/src/v2/services/cloud-storage/upload.type.ts b/src/v2/services/cloud-storage/upload.type.ts
@@ -33,3 +33,20 @@ export interface GetFileInfoByRedisReturn {
     targetDirectoryPath: string;
     fileResourceType: FileResourceType;
 }
+
+export interface TempPhotoUploadStartConfig {
+    fileName: string;
+    fileSize: number;
+}
+
+export interface TempPhotoUploadStartReturn {
+    fileUUID: string;
+    ossDomain: string;
+    ossFilePath: string;
+    policy: string;
+    signature: string;
+}
+
+export interface TempPhotoUploadFinishConfig {
+    fileUUID: string;
+}
