From 510de87607283d4d49239b1d14026a577299c99e Mon Sep 17 00:00:00 2001
From: syuilo <Syuilotan@yahoo.co.jp>
Date: Sat, 19 Feb 2022 14:05:32 +0900
Subject: refactor: use ajv instead of cafy (#8324)

* wip

* wip

* Update abuse-user-reports.ts

* Update files.ts

* Update list-remote.ts

* Update list.ts

* Update show-users.ts

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update update.ts

* Update search.ts

* Update reactions.ts

* Update search.ts

* wip

* wip

* wip

* wip

* Update update.ts

* Update relation.ts

* Update available.ts

* wip

* wip

* wip

* Update packages/backend/src/server/api/define.ts

Co-authored-by: Johann150 <johann.galle@protonmail.com>

* Update define.ts

* Update define.ts

* typo

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update update.ts

* wip

* Update signup.ts

* Update call.ts

* minimum for limit

* type

* remove needless annotation

* wip

* Update signup.ts

* wip

* wip

* fix

* Update create.ts

Co-authored-by: Johann150 <johann.galle@protonmail.com>
---
 packages/backend/src/server/api/define.ts | 69 +++++++++++--------------------
 1 file changed, 25 insertions(+), 44 deletions(-)

(limited to 'packages/backend/src/server/api/define.ts')

diff --git a/packages/backend/src/server/api/define.ts b/packages/backend/src/server/api/define.ts
index b6bb2da8ac..061ade17bf 100644
--- a/packages/backend/src/server/api/define.ts
+++ b/packages/backend/src/server/api/define.ts
@@ -1,12 +1,11 @@
 import * as fs from 'fs';
+import * as Ajv from 'ajv';
 import { ILocalUser } from '@/models/entities/user';
 import { IEndpointMeta } from './endpoints';
 import { ApiError } from './error';
-import { SchemaType } from '@/misc/schema';
+import { Schema, SchemaType } from '@/misc/schema';
 import { AccessToken } from '@/models/entities/access-token';
 
-type NonOptional<T> = T extends undefined ? never : T;
-
 type SimpleUserInfo = {
 	id: ILocalUser['id'];
 	createdAt: ILocalUser['createdAt'];
@@ -21,22 +20,24 @@ type SimpleUserInfo = {
 	showTimelineReplies: ILocalUser['showTimelineReplies'];
 };
 
-type Params<T extends IEndpointMeta> = {
-	[P in keyof T['params']]: NonNullable<T['params']>[P]['transform'] extends () => any
-		? ReturnType<NonNullable<T['params']>[P]['transform']>
-		: NonNullable<T['params']>[P]['default'] extends null | number | string
-			? NonOptional<ReturnType<NonNullable<T['params']>[P]['validator']['get']>[0]>
-			: ReturnType<NonNullable<T['params']>[P]['validator']['get']>[0];
-};
-
 export type Response = Record<string, any> | void;
 
-type executor<T extends IEndpointMeta> =
-	(params: Params<T>, user: T['requireCredential'] extends true ? SimpleUserInfo : SimpleUserInfo | null, token: AccessToken | null, file?: any, cleanup?: () => any) =>
+// TODO: paramsの型をT['params']のスキーマ定義から推論する
+type executor<T extends IEndpointMeta, Ps extends Schema> =
+	(params: SchemaType<Ps>, user: T['requireCredential'] extends true ? SimpleUserInfo : SimpleUserInfo | null, token: AccessToken | null, file?: any, cleanup?: () => any) =>
 		Promise<T['res'] extends undefined ? Response : SchemaType<NonNullable<T['res']>>>;
 
-export default function <T extends IEndpointMeta>(meta: T, cb: executor<T>)
+const ajv = new Ajv({
+	useDefaults: true,
+});
+
+ajv.addFormat('misskey:id', /^[a-z0-9]+$/);
+
+export default function <T extends IEndpointMeta, Ps extends Schema>(meta: T, paramDef: Ps, cb: executor<T, Ps>)
 		: (params: any, user: T['requireCredential'] extends true ? SimpleUserInfo : SimpleUserInfo | null, token: AccessToken | null, file?: any) => Promise<any> {
+
+	const validate = ajv.compile(paramDef);
+
 	return (params: any, user: T['requireCredential'] extends true ? SimpleUserInfo : SimpleUserInfo | null, token: AccessToken | null, file?: any) => {
 		function cleanup() {
 			fs.unlink(file.path, () => {});
@@ -48,42 +49,22 @@ export default function <T extends IEndpointMeta>(meta: T, cb: executor<T>)
 			id: '4267801e-70d1-416a-b011-4ee502885d8b',
 		}));
 
-		const [ps, pserr] = getParams(meta, params);
-		if (pserr) {
+		const valid = validate(params);
+		if (!valid) {
 			if (file) cleanup();
-			return Promise.reject(pserr);
-		}
-
-		return cb(ps, user, token, file, cleanup);
-	};
-}
 
-function getParams<T extends IEndpointMeta>(defs: T, params: any): [Params<T>, ApiError | null] {
-	if (defs.params == null) return [params, null];
-
-	const x: any = {};
-	let err: ApiError | null = null;
-	Object.entries(defs.params).some(([k, def]) => {
-		const [v, e] = def.validator.get(params[k]);
-		if (e) {
-			err = new ApiError({
+			const errors = validate.errors!;
+			const err = new ApiError({
 				message: 'Invalid param.',
 				code: 'INVALID_PARAM',
 				id: '3d81ceae-475f-4600-b2a8-2bc116157532',
 			}, {
-				param: k,
-				reason: e.message,
+				param: errors[0].schemaPath,
+				reason: errors[0].message,
 			});
-			return true;
-		} else {
-			if (v === undefined && Object.prototype.hasOwnProperty.call(def, 'default')) {
-				x[k] = def.default;
-			} else {
-				x[k] = v;
-			}
-			if (def.transform) x[k] = def.transform(x[k]);
-			return false;
+			return Promise.reject(err);
 		}
-	});
-	return [x, err];
+
+		return cb(params, user, token, file, cleanup);
+	};
 }
-- 
cgit v1.2.3-freya