feat: add region code (#736)

* add region code for roomUUID and inviteCode

* remove us ci, use CN as default region

* fix test.yaml

* roomUUID not only uuidv4 format

* `region_code`  use `1` as default

---------

Co-authored-by: siyu <chensiyi@agora.io>

Author: ooeyuna

config/test.yaml

@@ -1,6 +1,8 @@
 server:
   port: 8761
   env: dev
+  region: CN
+  region_code: 1
 
 redis:
   host: 127.0.0.1

src/constants/Config.ts

@@ -9,6 +9,9 @@ export const Server = {
     name: "flat-server",
     version: packages.version,
     env: config.server.env,
+    region: config.server.region || "CN",
+    // value: 1-9
+    regionCode: config.server.region_code || 1,
 };
 
 export const Redis = {

src/plugins/__tests__/ajv.test.ts

@@ -10,17 +10,18 @@ test(`${namespace} - inject self plugin`, ava => {
     const ajv = new Ajv();
     ajvSelfPlugin(ajv);
 
-    ava.deepEqual(Object.keys(ajv.formats), [
-        "unix-timestamp",
-        "uuid-v4",
-        "file-suffix",
+    ava.deepEqual(Object.keys(ajv.formats).sort(), [
         "avatar-suffix",
-        "oauth-logo-suffix",
-        "url",
-        "https",
-        "phone",
         "directory-name",
         "directory-path",
+        "file-suffix",
+        "https",
+        "oauth-logo-suffix",
+        "phone",
+        "temp-photo-suffix",
+        "unix-timestamp",
+        "url",
+        "uuid-v4",
     ]);
 });
 

src/utils/ParseConfig.ts

@@ -30,6 +30,8 @@ type Config = {
     server: {
         port: number;
         env: string;
+        region: string | null;
+        region_code: number | null;
     };
     redis: {
         host: string;

src/v1/controller/room/cancel/History.ts

@@ -19,7 +19,6 @@ export class CancelHistory extends AbstractController<RequestType, ResponseType>
             properties: {
                 roomUUID: {
                     type: "string",
-                    format: "uuid-v4",
                 },
             },
         },

src/v1/controller/room/cancel/Ordinary.ts

@@ -25,7 +25,6 @@ export class CancelOrdinary extends AbstractController<RequestType, ResponseType
             properties: {
                 roomUUID: {
                     type: "string",
-                    format: "uuid-v4",
                 },
             },
         },

src/v1/controller/room/create/Ordinary.ts

@@ -1,7 +1,6 @@
 import { RoomType } from "../../../../model/room/Constants";
 import { Region, Status } from "../../../../constants/Project";
 import { FastifySchema, Response, ResponseError } from "../../../../types/Server";
-import { v4 } from "uuid";
 import { ErrorCode } from "../../../../ErrorCode";
 import {
     beginTimeLessEndTime,
@@ -12,7 +11,7 @@ import { AbstractController, ControllerClassParams } from "../../../../abstract/
 import { Controller } from "../../../../decorator/Controller";
 import { ControllerError } from "../../../../error/ControllerError";
 import { ServiceRoom, ServiceRoomUser } from "../../../service";
-import { generateRoomInviteCode } from "./Utils";
+import { generateRoomInviteCode, generateRoomUUID } from "./Utils";
 import { rtcQueue } from "../../../queue";
 import { aliGreenText } from "../../../utils/AliGreen";
 import { dataSource } from "../../../../thirdPartyService/TypeORMService";
@@ -59,7 +58,7 @@ export class CreateOrdinary extends AbstractController<RequestType, ResponseType
         roomUser: ServiceRoomUser;
     };
 
-    private readonly roomUUID: string = v4();
+    private readonly roomUUID: string = generateRoomUUID();
 
     public constructor(params: ControllerClassParams) {
         super(params);

src/v1/controller/room/create/Utils.ts

@@ -1,7 +1,9 @@
+import { v4 } from "uuid";
 import { Logger, LoggerAPI, parseError } from "../../../../logger";
 import RedisService from "../../../../thirdPartyService/RedisService";
 import { RedisKey } from "../../../../utils/Redis";
 import { generateInviteCode } from "../utils/GenerateInviteCode";
+import { Server } from "../../../../constants/Config";
 
 export const generateRoomInviteCode = async (
     roomUUID: string,
@@ -10,7 +12,8 @@ export const generateRoomInviteCode = async (
     let inviteCode = "";
     try {
         // when invite code is used up, fallback to uuid
-        inviteCode = (await generateInviteCode()) || roomUUID;
+        const code = await generateInviteCode();
+        inviteCode = code === null ? roomUUID : `${Server.regionCode}`.concat(code);
     } catch (error) {
         logger.warn("generate invite code failed", parseError(error));
         inviteCode = roomUUID;
@@ -41,3 +44,7 @@ export const generateRoomInviteCode = async (
 
     return inviteCode;
 };
+
+export const generateRoomUUID = (): string => {
+    return `${Server.region}-` + v4();
+};

src/v1/controller/room/info/Ordinary.ts

@@ -20,7 +20,6 @@ export class OrdinaryInfo extends AbstractController<RequestType, ResponseType>
             properties: {
                 roomUUID: {
                     type: "string",
-                    format: "uuid-v4",
                 },
             },
         },

src/v1/controller/room/info/Users.ts

@@ -21,7 +21,6 @@ export class UserInfo extends AbstractController<RequestType, ResponseType> {
             properties: {
                 roomUUID: {
                     type: "string",
-                    format: "uuid-v4",
                 },
                 usersUUID: {
                     type: "array",