diff options
| author | syuilo <Syuilotan@yahoo.co.jp> | 2019-02-22 11:46:58 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-22 11:46:58 +0900 |
| commit | 2756f553c68082342a784ef716c62da6cea6f3ca (patch) | |
| tree | 1e0364ca9ddc1fd88e311f0687746f44e007effd /src/server/api/endpoints/drive/files | |
| parent | Update CHANGELOG.md (diff) | |
| download | misskey-2756f553c68082342a784ef716c62da6cea6f3ca.tar.gz misskey-2756f553c68082342a784ef716c62da6cea6f3ca.tar.bz2 misskey-2756f553c68082342a784ef716c62da6cea6f3ca.zip | |
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
* :v:
* Fix
Diffstat (limited to 'src/server/api/endpoints/drive/files')
| -rw-r--r-- | src/server/api/endpoints/drive/files/attached_notes.ts | 19 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/check_existence.ts | 10 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/create.ts | 25 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/delete.ts | 25 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/find.ts | 6 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/show.ts | 36 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/update.ts | 37 | ||||
| -rw-r--r-- | src/server/api/endpoints/drive/files/upload_from_url.ts | 6 |
8 files changed, 113 insertions, 51 deletions
diff --git a/src/server/api/endpoints/drive/files/attached_notes.ts b/src/server/api/endpoints/drive/files/attached_notes.ts index 6442b15195..506444b183 100644 --- a/src/server/api/endpoints/drive/files/attached_notes.ts +++ b/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 - })); -})); + }); +}); diff --git a/src/server/api/endpoints/drive/files/check_existence.ts b/src/server/api/endpoints/drive/files/check_existence.ts index 6e986d4170..aafd46fb2d 100644 --- a/src/server/api/endpoints/drive/files/check_existence.ts +++ b/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 }; +}); diff --git a/src/server/api/endpoints/drive/files/create.ts b/src/server/api/endpoints/drive/files/create.ts index 3611652b6c..c96e4bbf19 100644 --- a/src/server/api/endpoints/drive/files/create.ts +++ b/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); } -})); +}); diff --git a/src/server/api/endpoints/drive/files/delete.ts b/src/server/api/endpoints/drive/files/delete.ts index c322587d8f..2dc493efeb 100644 --- a/src/server/api/endpoints/drive/files/delete.ts +++ b/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; +}); diff --git a/src/server/api/endpoints/drive/files/find.ts b/src/server/api/endpoints/drive/files/find.ts index 0ebd5b789e..6eb909b9d0 100644 --- a/src/server/api/endpoints/drive/files/find.ts +++ b/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 }))); +}); diff --git a/src/server/api/endpoints/drive/files/show.ts b/src/server/api/endpoints/drive/files/show.ts index 994583bd01..f844d434fe 100644 --- a/src/server/api/endpoints/drive/files/show.ts +++ b/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); -})); +}); diff --git a/src/server/api/endpoints/drive/files/update.ts b/src/server/api/endpoints/drive/files/update.ts index 79acbec3cd..f24cc6bcd3 100644 --- a/src/server/api/endpoints/drive/files/update.ts +++ b/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; +}); diff --git a/src/server/api/endpoints/drive/files/upload_from_url.ts b/src/server/api/endpoints/drive/files/upload_from_url.ts index d79b321735..8d25530ddd 100644 --- a/src/server/api/endpoints/drive/files/upload_from_url.ts +++ b/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 }); +}); |