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/drive/files.ts

@@ -41,12 +41,7 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
-	// Check if both of sinceId and untilId is specified
-	if (ps.sinceId && ps.untilId) {
-		return rej('cannot set sinceId and untilId');
-	}
-
+export default define(meta, async (ps, user) => {
 	const sort = {
 		_id: -1
 	};
@@ -78,5 +73,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			sort: sort
 		});
 
-	res(await packMany(files, { detail: false, self: true }));
-}));
+	return await packMany(files, { detail: false, self: true });
+});

src/server/api/endpoints/drive/files/attached_notes.ts

@@ -3,6 +3,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import DriveFile from '../../../../../models/drive-file';
 import define from '../../../define';
 import { packMany } from '../../../../../models/note';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -25,10 +26,18 @@ export const meta = {
 				'en-US': 'Target file ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFile: {
+			message: 'No such file.',
+			code: 'NO_SUCH_FILE',
+			id: 'c118ece3-2e4b-4296-99d1-51756e32d232',
+		}
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch file
 	const file = await DriveFile
 		.findOne({
@@ -38,10 +47,10 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		});
 
 	if (file === null) {
-		return rej('file-not-found');
+		throw new ApiError(meta.errors.noSuchFile);
 	}
 
-	res(await packMany(file.metadata.attachedNoteIds || [], user, {
+	return await packMany(file.metadata.attachedNoteIds || [], user, {
 		detail: true
-	}));
-}));
+	});
+});

src/server/api/endpoints/drive/files/check_existence.ts

@@ -22,16 +22,12 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	const file = await DriveFile.findOne({
 		md5: ps.md5,
 		'metadata.userId': user._id,
 		'metadata.deletedAt': { $exists: false }
 	});
 
-	if (file === null) {
-		res({ file: null });
-	} else {
-		res({ file: await pack(file, { self: true }) });
-	}
-}));
+	return { file: file ? await pack(file, { self: true }) : null };
+});

src/server/api/endpoints/drive/files/create.ts

@@ -5,6 +5,7 @@ import { validateFileName, pack } from '../../../../../models/drive-file';
 import create from '../../../../../services/drive/add-file';
 import define from '../../../define';
 import { apiLogger } from '../../../logger';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	desc: {
@@ -51,10 +52,18 @@ export const meta = {
 				'ja-JP': 'true にすると、同じハッシュを持つファイルが既にアップロードされていても強制的にファイルを作成します。',
 			}
 		}
+	},
+
+	errors: {
+		invalidFileName: {
+			message: 'Invalid file name.',
+			code: 'INVALID_FILE_NAME',
+			id: 'f449b209-0c60-4e51-84d5-29486263bfd4'
+		}
 	}
 };
 
-export default define(meta, (ps, user, app, file, cleanup) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user, app, file, cleanup) => {
 	// Get 'name' parameter
 	let name = file.originalname;
 	if (name !== undefined && name !== null) {
@@ -64,7 +73,7 @@ export default define(meta, (ps, user, app, file, cleanup) => new Promise(async
 		} else if (name === 'blob') {
 			name = null;
 		} else if (!validateFileName(name)) {
-			return rej('invalid name');
+			throw new ApiError(meta.errors.invalidFileName);
 		}
 	} else {
 		name = null;
@@ -73,15 +82,11 @@ export default define(meta, (ps, user, app, file, cleanup) => new Promise(async
 	try {
 		// Create file
 		const driveFile = await create(user, file.path, name, null, ps.folderId, ps.force, false, null, null, ps.isSensitive);
-
-		cleanup();
-
-		res(pack(driveFile, { self: true }));
+		return pack(driveFile, { self: true });
 	} catch (e) {
 		apiLogger.error(e);
-
+		throw new ApiError();
+	} finally {
 		cleanup();
-
-		rej(e);
 	}
-}));
+});

src/server/api/endpoints/drive/files/delete.ts

@@ -4,6 +4,7 @@ import DriveFile from '../../../../../models/drive-file';
 import del from '../../../../../services/drive/delete-file';
 import { publishDriveStream } from '../../../../../services/stream';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -26,10 +27,24 @@ export const meta = {
 				'en-US': 'Target file ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFile: {
+			message: 'No such file.',
+			code: 'NO_SUCH_FILE',
+			id: '908939ec-e52b-4458-b395-1025195cea58'
+		},
+
+		accessDenied: {
+			message: 'Access denied.',
+			code: 'ACCESS_DENIED',
+			id: '5eb8d909-2540-4970-90b8-dd6f86088121'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch file
 	const file = await DriveFile
 		.findOne({
@@ -37,11 +52,11 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		});
 
 	if (file === null) {
-		return rej('file-not-found');
+		throw new ApiError(meta.errors.noSuchFile);
 	}
 
 	if (!user.isAdmin && !user.isModerator && !file.metadata.userId.equals(user._id)) {
-		return rej('access denied');
+		throw new ApiError(meta.errors.accessDenied);
 	}
 
 	// Delete
@@ -50,5 +65,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	// Publish fileDeleted event
 	publishDriveStream(user._id, 'fileDeleted', file._id);
 
-	res();
-}));
+	return;
+});

src/server/api/endpoints/drive/files/find.ts

@@ -24,7 +24,7 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	const files = await DriveFile
 		.find({
 			filename: ps.name,
@@ -32,5 +32,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			'metadata.folderId': ps.folderId
 		});
 
-	res(await Promise.all(files.map(file => pack(file, { self: true }))));
-}));
+	return await Promise.all(files.map(file => pack(file, { self: true })));
+});

src/server/api/endpoints/drive/files/show.ts

@@ -4,6 +4,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import DriveFile, { pack, IDriveFile } from '../../../../../models/drive-file';
 import define from '../../../define';
 import config from '../../../../../config';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -34,10 +35,30 @@ export const meta = {
 				'en-US': 'Target file URL'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFile: {
+			message: 'No such file.',
+			code: 'NO_SUCH_FILE',
+			id: '067bc436-2718-4795-b0fb-ecbe43949e31'
+		},
+
+		accessDenied: {
+			message: 'Access denied.',
+			code: 'ACCESS_DENIED',
+			id: '25b73c73-68b1-41d0-bad1-381cfdf6579f'
+		},
+
+		fileIdOrUrlRequired: {
+			message: 'fileId or url required.',
+			code: 'INVALID_PARAM',
+			id: '89674805-722c-440c-8d88-5641830dc3e4'
+		}
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	let file: IDriveFile;
 
 	if (ps.fileId) {
@@ -69,22 +90,19 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			});
 		}
 	} else {
-		return rej('fileId or url required');
+		throw new ApiError(meta.errors.fileIdOrUrlRequired);
 	}
 
 	if (!user.isAdmin && !user.isModerator && !file.metadata.userId.equals(user._id)) {
-		return rej('access denied');
+		throw new ApiError(meta.errors.accessDenied);
 	}
 
 	if (file === null) {
-		return rej('file-not-found');
+		throw new ApiError(meta.errors.noSuchFile);
 	}
 
-	// Serialize
-	const _file = await pack(file, {
+	return await pack(file, {
 		detail: true,
 		self: true
 	});
-
-	res(_file);
-}));
+});

src/server/api/endpoints/drive/files/update.ts

@@ -5,6 +5,7 @@ import DriveFile, { validateFileName, pack } from '../../../../../models/drive-f
 import { publishDriveStream } from '../../../../../services/stream';
 import define from '../../../define';
 import Note from '../../../../../models/note';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	desc: {
@@ -51,10 +52,30 @@ export const meta = {
 				'en-US': 'Whether this media is NSFW'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFile: {
+			message: 'No such file.',
+			code: 'NO_SUCH_FILE',
+			id: 'e7778c7e-3af9-49cd-9690-6dbc3e6c972d'
+		},
+
+		accessDenied: {
+			message: 'Access denied.',
+			code: 'ACCESS_DENIED',
+			id: '01a53b27-82fc-445b-a0c1-b558465a8ed2'
+		},
+
+		noSuchFolder: {
+			message: 'No such folder.',
+			code: 'NO_SUCH_FOLDER',
+			id: 'ea8fb7a5-af77-4a08-b608-c0218176cd73'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch file
 	const file = await DriveFile
 		.findOne({
@@ -62,11 +83,11 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		});
 
 	if (file === null) {
-		return rej('file-not-found');
+		throw new ApiError(meta.errors.noSuchFile);
 	}
 
 	if (!user.isAdmin && !user.isModerator && !file.metadata.userId.equals(user._id)) {
-		return rej('access denied');
+		throw new ApiError(meta.errors.accessDenied);
 	}
 
 	if (ps.name) file.filename = ps.name;
@@ -85,7 +106,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 				});
 
 			if (folder === null) {
-				return rej('folder-not-found');
+				throw new ApiError(meta.errors.noSuchFolder);
 			}
 
 			file.metadata.folderId = folder._id;
@@ -114,12 +135,10 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		}
 	});
 
-	// Serialize
 	const fileObj = await pack(file, { self: true });
 
-	// Response
-	res(fileObj);
-
 	// Publish fileUpdated event
 	publishDriveStream(user._id, 'fileUpdated', fileObj);
-}));
+
+	return fileObj;
+});

src/server/api/endpoints/drive/files/upload_from_url.ts

@@ -50,6 +50,6 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
-	res(pack(await uploadFromUrl(ps.url, user, ps.folderId, null, ps.isSensitive, ps.force), { self: true }));
-}));
+export default define(meta, async (ps, user) => {
+	return await pack(await uploadFromUrl(ps.url, user, ps.folderId, null, ps.isSensitive, ps.force), { self: true });
+});

src/server/api/endpoints/drive/folders.ts

@@ -37,12 +37,7 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
-	// Check if both of sinceId and untilId is specified
-	if (ps.sinceId && ps.untilId) {
-		return rej('cannot set sinceId and untilId');
-	}
-
+export default define(meta, async (ps, user) => {
 	const sort = {
 		_id: -1
 	};
@@ -67,5 +62,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			sort: sort
 		});
 
-	res(await Promise.all(folders.map(folder => pack(folder))));
-}));
+	return await Promise.all(folders.map(folder => pack(folder)));
+});

src/server/api/endpoints/drive/folders/create.ts

@@ -3,6 +3,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import DriveFolder, { isValidFolderName, pack } from '../../../../../models/drive-folder';
 import { publishDriveStream } from '../../../../../services/stream';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -34,10 +35,18 @@ export const meta = {
 				'en-US': 'Parent folder ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFolder: {
+			message: 'No such folder.',
+			code: 'NO_SUCH_FOLDER',
+			id: '53326628-a00d-40a6-a3cd-8975105c0f95'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// If the parent folder is specified
 	let parent = null;
 	if (ps.parentId) {
@@ -49,7 +58,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			});
 
 		if (parent === null) {
-			return rej('parent-not-found');
+			throw new ApiError(meta.errors.noSuchFolder);
 		}
 	}
 
@@ -61,12 +70,10 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		userId: user._id
 	});
 
-	// Serialize
 	const folderObj = await pack(folder);
 
-	// Response
-	res(folderObj);
-
 	// Publish folderCreated event
 	publishDriveStream(user._id, 'folderCreated', folderObj);
-}));
+
+	return folderObj;
+});

src/server/api/endpoints/drive/folders/delete.ts

@@ -4,6 +4,7 @@ import DriveFolder from '../../../../../models/drive-folder';
 import define from '../../../define';
 import { publishDriveStream } from '../../../../../services/stream';
 import DriveFile from '../../../../../models/drive-file';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -26,10 +27,24 @@ export const meta = {
 				'en-US': 'Target folder ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFolder: {
+			message: 'No such folder.',
+			code: 'NO_SUCH_FOLDER',
+			id: '1069098f-c281-440f-b085-f9932edbe091'
+		},
+
+		hasChildFilesOrFolders: {
+			message: 'This folder has child files or folders.',
+			code: 'HAS_CHILD_FILES_OR_FOLDERS',
+			id: 'b0fc8a17-963c-405d-bfbc-859a487295e1'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Get folder
 	const folder = await DriveFolder
 		.findOne({
@@ -38,7 +53,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		});
 
 	if (folder === null) {
-		return rej('folder-not-found');
+		throw new ApiError(meta.errors.noSuchFolder);
 	}
 
 	const [childFoldersCount, childFilesCount] = await Promise.all([
@@ -47,7 +62,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	]);
 
 	if (childFoldersCount !== 0 || childFilesCount !== 0) {
-		return rej('has-child-contents');
+		throw new ApiError(meta.errors.hasChildFilesOrFolders);
 	}
 
 	await DriveFolder.remove({ _id: folder._id });
@@ -55,5 +70,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 	// Publish folderCreated event
 	publishDriveStream(user._id, 'folderDeleted', folder._id);
 
-	res();
-}));
+	return;
+});

src/server/api/endpoints/drive/folders/find.ts

@@ -24,7 +24,7 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	const folders = await DriveFolder
 		.find({
 			name: ps.name,
@@ -32,5 +32,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			parentId: ps.parentId
 		});
 
-	res(await Promise.all(folders.map(folder => pack(folder))));
-}));
+	return await Promise.all(folders.map(folder => pack(folder)));
+});

src/server/api/endpoints/drive/folders/show.ts

@@ -2,6 +2,7 @@ import $ from 'cafy';
 import ID, { transform } from '../../../../../misc/cafy-id';
 import DriveFolder, { pack } from '../../../../../models/drive-folder';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -24,10 +25,18 @@ export const meta = {
 				'en-US': 'Target folder ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFolder: {
+			message: 'No such folder.',
+			code: 'NO_SUCH_FOLDER',
+			id: 'd74ab9eb-bb09-4bba-bf24-fb58f761e1e9'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Get folder
 	const folder = await DriveFolder
 		.findOne({
@@ -36,11 +45,10 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		});
 
 	if (folder === null) {
-		return rej('folder-not-found');
+		throw new ApiError(meta.errors.noSuchFolder);
 	}
 
-	// Serialize
-	res(await pack(folder, {
+	return await pack(folder, {
 		detail: true
-	}));
-}));
+	});
+});

src/server/api/endpoints/drive/folders/update.ts

@@ -3,6 +3,7 @@ import ID, { transform } from '../../../../../misc/cafy-id';
 import DriveFolder, { isValidFolderName, pack } from '../../../../../models/drive-folder';
 import { publishDriveStream } from '../../../../../services/stream';
 import define from '../../../define';
+import { ApiError } from '../../../error';
 
 export const meta = {
 	stability: 'stable',
@@ -42,10 +43,30 @@ export const meta = {
 				'en-US': 'Parent folder ID'
 			}
 		}
+	},
+
+	errors: {
+		noSuchFolder: {
+			message: 'No such folder.',
+			code: 'NO_SUCH_FOLDER',
+			id: 'f7974dac-2c0d-4a27-926e-23583b28e98e'
+		},
+
+		noSuchParentFolder: {
+			message: 'No such parent folder.',
+			code: 'NO_SUCH_PARENT_FOLDER',
+			id: 'ce104e3a-faaf-49d5-b459-10ff0cbbcaa1'
+		},
+
+		recursiveNesting: {
+			message: 'It can not be structured like nesting folders recursively.',
+			code: 'NO_SUCH_PARENT_FOLDER',
+			id: 'ce104e3a-faaf-49d5-b459-10ff0cbbcaa1'
+		},
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
+export default define(meta, async (ps, user) => {
 	// Fetch folder
 	const folder = await DriveFolder
 		.findOne({
@@ -54,7 +75,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		});
 
 	if (folder === null) {
-		return rej('folder-not-found');
+		throw new ApiError(meta.errors.noSuchFolder);
 	}
 
 	if (ps.name) folder.name = ps.name;
@@ -71,7 +92,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 				});
 
 			if (parent === null) {
-				return rej('parent-folder-not-found');
+				throw new ApiError(meta.errors.noSuchParentFolder);
 			}
 
 			// Check if the circular reference will occur
@@ -95,7 +116,7 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 
 			if (parent.parentId !== null) {
 				if (await checkCircle(parent.parentId)) {
-					return rej('detected-circular-definition');
+					throw new ApiError(meta.errors.recursiveNesting);
 				}
 			}
 
@@ -111,12 +132,10 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 		}
 	});
 
-	// Serialize
 	const folderObj = await pack(folder);
 
-	// Response
-	res(folderObj);
-
 	// Publish folderUpdated event
 	publishDriveStream(user._id, 'folderUpdated', folderObj);
-}));
+
+	return folderObj;
+});

src/server/api/endpoints/drive/stream.ts

@@ -30,12 +30,7 @@ export const meta = {
 	}
 };
 
-export default define(meta, (ps, user) => new Promise(async (res, rej) => {
-	// Check if both of sinceId and untilId is specified
-	if (ps.sinceId && ps.untilId) {
-		return rej('cannot set sinceId and untilId');
-	}
-
+export default define(meta, async (ps, user) => {
 	const sort = {
 		_id: -1
 	};
@@ -66,5 +61,5 @@ export default define(meta, (ps, user) => new Promise(async (res, rej) => {
 			sort: sort
 		});
 
-	res(await packMany(files, { self: true }));
-}));
+		return await packMany(files, { self: true });
+});