feat(v2): add register/phone{/send-message} (#743)

hyrious · hyrious · commit bfb0124d8b37 · 2023-08-24T16:42:15.000+08:00
feat(v2): add login/phone

feat(v2): add user/password

feat(v2): add reset/phone{/send-password}

add unit test

move mysql.salt to login.salt
diff --git a/config/defaults.yaml b/config/defaults.yaml
@@ -79,6 +79,7 @@ oauth:
       - jpeg
 
 login:
+  salt:
   wechat:
     web:
       enable: false
diff --git a/config/test.yaml b/config/test.yaml
@@ -74,6 +74,7 @@ oauth:
       - jpeg
 
 login:
+  salt: test
   wechat:
     web:
       enable: true
diff --git a/src/ErrorCode.ts b/src/ErrorCode.ts
@@ -25,6 +25,7 @@ export enum ErrorCode {
     UserNotFound = 400000, // user not found
     UserRoomListNotEmpty, // user room list is not empty.
     UserAlreadyBinding, // user already binding
+    UserPasswordIncorrect, // user password (for update) incorrect
 
     RecordNotFound = 500000, // record info not found
 
diff --git a/src/abstract/login/index.ts b/src/abstract/login/index.ts
@@ -108,7 +108,7 @@ export abstract class AbstractLogin {
         ]);
     }
 
-    private static get guidePPTX(): string {
+    public static get guidePPTX(): string {
         return "guide-pptx/guide.pptx";
     }
 }
diff --git a/src/constants/Config.ts b/src/constants/Config.ts
@@ -31,6 +31,8 @@ export const MySQL = {
     db: config.mysql.db,
 };
 
+export const Salt = config.login.salt;
+
 export const Website = config.website;
 
 export const WeChat = {
diff --git a/src/plugins/Ajv.ts b/src/plugins/Ajv.ts
@@ -101,6 +101,13 @@ const directoryPath: FormatDefinition<string> = {
     },
 };
 
+const password: FormatDefinition<string> = {
+    validate: str => {
+        // 8..32 characters, at least one letter and one number
+        return 8 <= str.length && str.length <= 32 && /[a-z]/i.test(str) && /\d/.test(str);
+    },
+};
+
 export const ajvSelfPlugin = (ajv: Ajv): void => {
     ajv.addFormat("unix-timestamp", unixTimestamp);
     ajv.addFormat("uuid-v4", uuidV4);
@@ -113,6 +120,7 @@ export const ajvSelfPlugin = (ajv: Ajv): void => {
     ajv.addFormat("phone", phone);
     ajv.addFormat("directory-name", directoryName);
     ajv.addFormat("directory-path", directoryPath);
+    ajv.addFormat("password", password);
 };
 
 export const validateDirectoryName = (str: string): void => {
diff --git a/src/utils/Hash.ts b/src/utils/Hash.ts
@@ -0,0 +1,6 @@
+import { createHash } from "crypto";
+import { Salt } from "../constants/Config";
+
+export function hash(data: string): string {
+    return createHash("md5").update(data).update(Salt).digest("hex");
+}
diff --git a/src/utils/ParseConfig.ts b/src/utils/ParseConfig.ts
@@ -89,6 +89,7 @@ type Config = {
         };
     };
     login: {
+        salt: string;
         wechat: {
             web: {
                 enable: boolean;
diff --git a/src/utils/Redis.ts b/src/utils/Redis.ts
@@ -2,26 +2,36 @@ export const RedisKey = {
     authUUID: (uuid: string): string => `auth:uuid:${uuid}`,
     authFailed: (authUUID: string): string => `auth:failed:${authUUID}`,
     authUserInfo: (authUUID: string): string => `auth:userInfo:${authUUID}`,
+
     bindingAuthUUID: (uuid: string): string => `binding:auth:uuid:${uuid}`,
     bindingAuthStatus: (authUUID: string): string => `binding:auth:status:${authUUID}`,
+
     agoraRTCRoomUserToken: (roomUUID: string, uid: string | number): string =>
         `agora:rtc:room:${roomUUID}:uid:${uid}`,
     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}`,
     roomInviteCodeReverse: (roomUUID: string): string => `room:inviteReverse:${roomUUID}`,
+
     phoneLogin: (phone: string): string => `phone:login:${phone}`,
     phoneTryLoginCount: (phone: string): string => `phone:count:login:${phone}`,
+
     phoneBinding: (phone: string): string => `phone:binding:${phone}`,
     phoneTryBindingCount: (phone: string): string => `phone:count:binding:${phone}`,
+
     userDelete: (userUUID: string): string => `user:delete:${userUUID}`,
+
     videoIllegalCount: (roomUUID: string): string => `illegal:video:${roomUUID}`,
     voiceIllegalCount: (roomUUID: string): string => `illegal:voice:${roomUUID}`,
+
     oauthLogoFileInfo: (oauthUUID: string, fileUUID: string): string =>
         `oauth:logo:${oauthUUID}:${fileUUID}`,
     oauthAccessToken: (accessToken: string): string => `oauth:accessToken:${accessToken}`,
@@ -36,4 +46,7 @@ export const RedisKey = {
         `oauth:authorize:refreshToken:${refreshToken}`,
     oauthAuthorizeTokenByUserUUID: (clientID: string, userUUID: string) =>
         `oauth:authorize:clientID:${clientID}:user:${userUUID}`,
+
+    phoneRegisterOrReset: (phone: string): string => `phone:register:${phone}`,
+    phoneTryRegisterOrResetCount: (phone: string): string => `phone:count:register:${phone}`,
 };
diff --git a/src/v2/__tests__/helpers/db/user.ts b/src/v2/__tests__/helpers/db/user.ts
@@ -21,17 +21,24 @@ export class CreateUser {
         return info;
     }
 
-    public async quick() {
-        const info = {
-            userUUID: v4(),
-            userName: v4(),
-            userPassword: v4(),
-            avatarURL: v4(),
+    public async quick(
+        info: {
+            userUUID?: string;
+            userName?: string;
+            userPassword?: string;
+            avatarURL?: string;
+        } = {},
+    ) {
+        const fullInfo = {
+            userUUID: info.userUUID || v4(),
+            userName: info.userName || v4(),
+            userPassword: info.userPassword ?? v4(),
+            avatarURL: info.avatarURL || v4(),
         };
 
-        await this.full(info);
+        await this.full(fullInfo);
 
-        return info;
+        return fullInfo;
     }
 
     public async fixedName(userName: string) {
diff --git a/src/v2/constants.ts b/src/v2/constants.ts
@@ -0,0 +1,2 @@
+export const MessageIntervalSecond = 60;
+export const MessageExpirationSecond = 60 * 10;
diff --git a/src/v2/controllers/login/phone/index.ts b/src/v2/controllers/login/phone/index.ts
@@ -0,0 +1,39 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyReply } from "fastify";
+import { LoginPlatform } from "../../../../constants/Project";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { PhoneLoginReturn, UserPhoneService } from "../../../services/user/phone";
+import { successJSON } from "../../internal/utils/response-json";
+
+export const loginPhoneSchema = {
+    body: Type.Object(
+        {
+            phone: Type.String(),
+            password: Type.String({
+                format: "password",
+                minLength: 8,
+                maxLength: 32,
+            }),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const loginPhone = async (
+    req: FastifyRequestTypebox<typeof loginPhoneSchema>,
+    reply: FastifyReply,
+): Promise<Response<PhoneLoginReturn>> => {
+    const service = new UserPhoneService(req.ids, req.DBTransaction);
+
+    const jwtSign = (userUUID: string): Promise<string> =>
+        reply.jwtSign({
+            userUUID,
+            loginSource: LoginPlatform.Phone,
+        });
+
+    const result = await service.login(req.body.phone, req.body.password, jwtSign);
+
+    return successJSON(result);
+};
diff --git a/src/v2/controllers/login/routes.ts b/src/v2/controllers/login/routes.ts
@@ -0,0 +1,9 @@
+import { Server } from "../../../utils/registryRoutersV2";
+import { loginPhone, loginPhoneSchema } from "./phone";
+
+export const loginRouters = (server: Server): void => {
+    server.post("login/phone", loginPhone, {
+        schema: loginPhoneSchema,
+        auth: false,
+    });
+};
diff --git a/src/v2/controllers/register/phone/index.ts b/src/v2/controllers/register/phone/index.ts
@@ -0,0 +1,45 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyReply } from "fastify";
+import { LoginPlatform } from "../../../../constants/Project";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { PhoneRegisterReturn, UserPhoneService } from "../../../services/user/phone";
+import { successJSON } from "../../internal/utils/response-json";
+
+export const registerPhoneSchema = {
+    body: Type.Object(
+        {
+            phone: Type.String(),
+            code: Type.Integer(),
+            password: Type.String({
+                format: "password",
+                minLength: 8,
+                maxLength: 32,
+            }),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const registerPhone = async (
+    req: FastifyRequestTypebox<typeof registerPhoneSchema>,
+    reply: FastifyReply,
+): Promise<Response<PhoneRegisterReturn>> => {
+    const service = new UserPhoneService(req.ids, req.DBTransaction);
+
+    const jwtSign = (userUUID: string): Promise<string> =>
+        reply.jwtSign({
+            userUUID,
+            loginSource: LoginPlatform.Phone,
+        });
+
+    const result = await service.register(
+        req.body.phone,
+        req.body.code,
+        req.body.password,
+        jwtSign,
+    );
+
+    return successJSON(result);
+};
diff --git a/src/v2/controllers/register/phone/send-message.ts b/src/v2/controllers/register/phone/send-message.ts
@@ -0,0 +1,25 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { UserPhoneService } from "../../../services/user/phone";
+import { successJSON } from "../../internal/utils/response-json";
+
+export const registerPhoneSendMessageSchema = {
+    body: Type.Object(
+        {
+            phone: Type.String(),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const registerPhoneSendMessage = async (
+    req: FastifyRequestTypebox<typeof registerPhoneSendMessageSchema>,
+): Promise<Response> => {
+    const service = new UserPhoneService(req.ids, req.DBTransaction);
+
+    await service.sendMessageForRegister(req.body.phone);
+
+    return successJSON({});
+};
diff --git a/src/v2/controllers/register/routes.ts b/src/v2/controllers/register/routes.ts
@@ -0,0 +1,15 @@
+import { Server } from "../../../utils/registryRoutersV2";
+import { registerPhone, registerPhoneSchema } from "./phone";
+import { registerPhoneSendMessage, registerPhoneSendMessageSchema } from "./phone/send-message";
+
+export const registerRouters = (server: Server): void => {
+    server.post("register/phone/send-message", registerPhoneSendMessage, {
+        schema: registerPhoneSendMessageSchema,
+        auth: false,
+    });
+
+    server.post("register/phone", registerPhone, {
+        schema: registerPhoneSchema,
+        auth: false,
+    });
+};
diff --git a/src/v2/controllers/reset/phone/index.ts b/src/v2/controllers/reset/phone/index.ts
@@ -0,0 +1,31 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { UserPhoneService } from "../../../services/user/phone";
+import { successJSON } from "../../internal/utils/response-json";
+
+export const resetPhoneSchema = {
+    body: Type.Object(
+        {
+            phone: Type.String(),
+            code: Type.Integer(),
+            password: Type.String({
+                format: "password",
+                minLength: 8,
+                maxLength: 32,
+            }),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const resetPhone = async (
+    req: FastifyRequestTypebox<typeof resetPhoneSchema>,
+): Promise<Response> => {
+    const service = new UserPhoneService(req.ids, req.DBTransaction);
+
+    await service.reset(req.body.phone, req.body.code, req.body.password);
+
+    return successJSON({});
+};
diff --git a/src/v2/controllers/reset/phone/send-message.ts b/src/v2/controllers/reset/phone/send-message.ts
@@ -0,0 +1,25 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { UserPhoneService } from "../../../services/user/phone";
+import { successJSON } from "../../internal/utils/response-json";
+
+export const resetPhoneSendMessageSchema = {
+    body: Type.Object(
+        {
+            phone: Type.String(),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const resetPhoneSendMessage = async (
+    req: FastifyRequestTypebox<typeof resetPhoneSendMessageSchema>,
+): Promise<Response> => {
+    const service = new UserPhoneService(req.ids, req.DBTransaction);
+
+    await service.sendMessageForReset(req.body.phone);
+
+    return successJSON({});
+};
diff --git a/src/v2/controllers/reset/routes.ts b/src/v2/controllers/reset/routes.ts
@@ -0,0 +1,15 @@
+import { Server } from "../../../utils/registryRoutersV2";
+import { resetPhone, resetPhoneSchema } from "./phone";
+import { resetPhoneSendMessage, resetPhoneSendMessageSchema } from "./phone/send-message";
+
+export const resetRouters = (server: Server): void => {
+    server.post("reset/phone/send-message", resetPhoneSendMessage, {
+        schema: resetPhoneSendMessageSchema,
+        auth: false,
+    });
+
+    server.post("reset/phone", resetPhone, {
+        schema: resetPhoneSchema,
+        auth: false,
+    });
+};
diff --git a/src/v2/controllers/routes.ts b/src/v2/controllers/routes.ts
@@ -6,6 +6,9 @@ import { roomRouters } from "./room/routes";
 import { oauthRouters } from "./auth2/routes";
 import { tempPhotoRouters } from "./temp-photo/routes";
 import { regionConfigsRouters } from "./configs/regionConfigs";
+import { registerRouters } from "./register/routes";
+import { loginRouters } from "./login/routes";
+import { resetRouters } from "./reset/routes";
 
 export const v2Routes = [
     userRouters,
@@ -16,4 +19,7 @@ export const v2Routes = [
     oauthRouters,
     tempPhotoRouters,
     regionConfigsRouters,
+    registerRouters,
+    loginRouters,
+    resetRouters,
 ];
diff --git a/src/v2/controllers/user/password/index.ts b/src/v2/controllers/user/password/index.ts
diff --git a/src/v2/controllers/user/routes.ts b/src/v2/controllers/user/routes.ts
diff --git a/src/v2/services/user/__tests__/phone.test.ts b/src/v2/services/user/__tests__/phone.test.ts
diff --git a/src/v2/services/user/phone.ts b/src/v2/services/user/phone.ts
diff --git a/src/v2/services/user/update.ts b/src/v2/services/user/update.ts

-Original file line number
+Diff line change
       - jpeg
 login:
 +  salt:
   wechat:
     web:
       enable: false
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ export abstract class AbstractLogin {`
`108`	`108`	`]);`
`109`	`109`	`}`
`110`	`110`
`111`		`- private static get guidePPTX(): string {`
	`111`	`+ public static get guidePPTX(): string {`
`112`	`112`	`return "guide-pptx/guide.pptx";`
`113`	`113`	`}`
`114`	`114`	`}`