Improve error handling of API (#4345)

* wip

* wip

* wip

* Update attached_notes.ts

* wip

* Refactor

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update call.ts

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* ✌️

* Fix

src/server/api/endpoints/following/create.ts

@@ -5,6 +5,7 @@ import User, { pack } from '../../../../models/user';
 import Following from '../../../../models/following';
 import create from '../../../../services/following/create';
 import define from '../../define';
+import { ApiError } from '../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -32,15 +33,47 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: 'fcd2eef9-a9b2-4c4f-8624-038099e90aa5'
+		},
+
+		followeeIsYourself: {
+			message: 'Followee is yourself.',
+			code: 'FOLLOWEE_IS_YOURSELF',
+			id: '26fbe7bb-a331-4857-af17-205b426669a9'
+		},
+
+		alreadyFollowing: {
+			message: 'You are already following that user.',
+			code: 'ALREADY_FOLLOWING',
+			id: '35387507-38c7-4cb9-9197-300b93783fa0'
+		},
+
+		blocking: {
+			message: 'You are blocking that user.',
+			code: 'BLOCKING',
+			id: '4e2206ec-aa4f-4960-b865-6c23ac38e2d9'
+		},
+
+		blocked: {
+			message: 'You are blocked by that user.',
+			code: 'BLOCKED',
+			id: 'c4ab57cc-4e41-45e9-bfd9-584f61e35ce0'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	const follower = user;
 
 	// 自分自身
 	if (user._id.equals(ps.userId)) {
-		return rej('followee is yourself');
+		throw new ApiError(meta.errors.followeeIsYourself);
 	}
 
 	// Get followee
@@ -54,7 +87,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	});
 
 	if (followee === null) {
-		return rej('user not found');
+		throw new ApiError(meta.errors.noSuchUser);
 	}
 
 	// Check if already following
@@ -64,16 +97,16 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	});
 
 	if (exist !== null) {
-		return rej('already following');
+		throw new ApiError(meta.errors.alreadyFollowing);
 	}
 
-	// Create following
 	try {
 		await create(follower, followee);
 	} catch (e) {
-		return rej(e && e.message ? e.message : e);
+		if (e.id === '710e8fb0-b8c3-4922-be49-d5d93d8e6a6e') throw new ApiError(meta.errors.blocking);
+		if (e.id === '3338392a-f764-498d-8855-db939dcf8c48') throw new ApiError(meta.errors.blocked);
+		throw e;
 	}
 
-	// Send response
-	res(await pack(followee._id, user));
-}));
+	return await pack(followee._id, user);
+});

src/server/api/endpoints/following/delete.ts

@@ -5,6 +5,7 @@ import User, { pack } from '../../../../models/user';
 import Following from '../../../../models/following';
 import deleteFollowing from '../../../../services/following/delete';
 import define from '../../define';
+import { ApiError } from '../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -32,15 +33,35 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: '5b12c78d-2b28-4dca-99d2-f56139b42ff8'
+		},
+
+		followeeIsYourself: {
+			message: 'Followee is yourself.',
+			code: 'FOLLOWEE_IS_YOURSELF',
+			id: 'd9e400b9-36b0-4808-b1d8-79e707f1296c'
+		},
+
+		notFollowing: {
+			message: 'You are not following that user.',
+			code: 'NOT_FOLLOWING',
+			id: '5dbf82f5-c92b-40b1-87d1-6c8c0741fd09'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	const follower = user;
 
 	// Check if the followee is yourself
 	if (user._id.equals(ps.userId)) {
-		return rej('followee is yourself');
+		throw new ApiError(meta.errors.followeeIsYourself);
 	}
 
 	// Get followee
@@ -54,7 +75,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	});
 
 	if (followee === null) {
-		return rej('user not found');
+		throw new ApiError(meta.errors.noSuchUser);
 	}
 
 	// Check not following
@@ -64,12 +85,10 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	});
 
 	if (exist === null) {
-		return rej('already not following');
+		throw new ApiError(meta.errors.notFollowing);
 	}
 
-	// Delete following
 	await deleteFollowing(follower, followee);
 
-	// Send response
-	res(await pack(followee._id, user));
-}));
+	return await pack(followee._id, user);
+});

src/server/api/endpoints/following/requests/accept.ts

@@ -3,6 +3,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import acceptFollowRequest from '../../../../../services/following/requests/accept';
 import User from '../../../../../models/user';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	desc: {
@@ -23,20 +24,28 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: '66ce1645-d66c-46bb-8b79-96739af885bd'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch follower
 	const follower = await User.findOne({
 		_id: ps.userId
 	});
 
 	if (follower === null) {
-		return rej('follower not found');
+		throw new ApiError(meta.errors.noSuchUser);
 	}
 
 	await acceptFollowRequest(user, follower);
 
-	res();
-}));
+	return;
+});

src/server/api/endpoints/following/requests/cancel.ts

@@ -3,6 +3,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import cancelFollowRequest from '../../../../../services/following/requests/cancel';
 import User, { pack } from '../../../../../models/user';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	desc: {
@@ -23,24 +24,39 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: '4e68c551-fc4c-4e46-bb41-7d4a37bf9dab'
+		},
+
+		followRequestNotFound: {
+			message: 'Follow request not found.',
+			code: 'FOLLOW_REQUEST_NOT_FOUND',
+			id: '089b125b-d338-482a-9a09-e2622ac9f8d4'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch followee
 	const followee = await User.findOne({
 		_id: ps.userId
 	});
 
 	if (followee === null) {
-		return rej('followee not found');
+		throw new ApiError(meta.errors.noSuchUser);
 	}
 
 	try {
 		await cancelFollowRequest(followee, user);
 	} catch (e) {
-		return rej(e);
+		if (e.id === '17447091-ce07-46dd-b331-c1fd4f15b1e7') throw new ApiError(meta.errors.followRequestNotFound);
+		throw e;
 	}
 
-	res(await pack(followee._id, user));
-}));
+	return await pack(followee._id, user);
+});

src/server/api/endpoints/following/requests/list.ts

@@ -1,5 +1,3 @@
-// import $ from 'cafy';
-// import ID, { transform } from '../../../../../cafy-id';
 import FollowRequest, { pack } from '../../../../../models/follow-request';
 import define from '../../../define';
 
@@ -14,11 +12,10 @@ export const meta = {
 	kind: 'following-read'
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	const reqs = await FollowRequest.find({
 		followeeId: user._id
 	});
 
-	// Send response
-	res(await Promise.all(reqs.map(req => pack(req))));
-}));
+	return await Promise.all(reqs.map(req => pack(req)));
+});

src/server/api/endpoints/following/requests/reject.ts

@@ -3,6 +3,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import rejectFollowRequest from '../../../../../services/following/requests/reject';
 import User from '../../../../../models/user';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	desc: {
@@ -23,20 +24,28 @@ export const meta = {
 				'en-US': 'Target user ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchUser: {
+			message: 'No such user.',
+			code: 'NO_SUCH_USER',
+			id: 'abc2ffa6-25b2-4380-ba99-321ff3a94555'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch follower
 	const follower = await User.findOne({
 		_id: ps.userId
 	});
 
 	if (follower === null) {
-		return rej('follower not found');
+		throw new ApiError(meta.errors.noSuchUser);
 	}
 
 	await rejectFollowRequest(user, follower);
 
-	res();
-}));
+	return;
+});