From 2d53be0267acc49cda46707b885096193a1f4e9c Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Mon, 7 Dec 2020 14:32:36 +0100 Subject: replace numbers with typed http status codes (#3409) --- shared/extra-utils/users/accounts.ts | 13 ++++-- shared/extra-utils/users/blocklist.ts | 65 +++++++++++++++++++++----- shared/extra-utils/users/user-notifications.ts | 14 ++++-- shared/extra-utils/users/user-subscriptions.ts | 13 +++--- shared/extra-utils/users/users.ts | 63 ++++++++++++++++--------- 5 files changed, 121 insertions(+), 47 deletions(-) (limited to 'shared/extra-utils/users') diff --git a/shared/extra-utils/users/accounts.ts b/shared/extra-utils/users/accounts.ts index f87706f6a..4ea7f1402 100644 --- a/shared/extra-utils/users/accounts.ts +++ b/shared/extra-utils/users/accounts.ts @@ -8,8 +8,9 @@ import { Account } from '../../models/actors' import { root } from '../miscs/miscs' import { makeGetRequest } from '../requests/requests' import { VideoRateType } from '../../models/videos' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' -function getAccountsList (url: string, sort = '-createdAt', statusCodeExpected = 200) { +function getAccountsList (url: string, sort = '-createdAt', statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/accounts' return makeGetRequest({ @@ -20,7 +21,7 @@ function getAccountsList (url: string, sort = '-createdAt', statusCodeExpected = }) } -function getAccount (url: string, accountName: string, statusCodeExpected = 200) { +function getAccount (url: string, accountName: string, statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/accounts/' + accountName return makeGetRequest({ @@ -55,7 +56,13 @@ async function checkActorFilesWereRemoved (filename: string, serverNumber: numbe } } -function getAccountRatings (url: string, accountName: string, accessToken: string, rating?: VideoRateType, statusCodeExpected = 200) { +function getAccountRatings ( + url: string, + accountName: string, + accessToken: string, + rating?: VideoRateType, + statusCodeExpected = HttpStatusCode.OK_200 +) { const path = '/api/v1/accounts/' + accountName + '/ratings' const query = rating ? { rating } : {} diff --git a/shared/extra-utils/users/blocklist.ts b/shared/extra-utils/users/blocklist.ts index 39e720b42..bdf7ee58a 100644 --- a/shared/extra-utils/users/blocklist.ts +++ b/shared/extra-utils/users/blocklist.ts @@ -1,6 +1,7 @@ /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */ import { makeGetRequest, makeDeleteRequest, makePostBodyRequest } from '../requests/requests' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' function getAccountBlocklistByAccount ( url: string, @@ -8,7 +9,7 @@ function getAccountBlocklistByAccount ( start: number, count: number, sort = '-createdAt', - statusCodeExpected = 200 + statusCodeExpected = HttpStatusCode.OK_200 ) { const path = '/api/v1/users/me/blocklist/accounts' @@ -21,7 +22,12 @@ function getAccountBlocklistByAccount ( }) } -function addAccountToAccountBlocklist (url: string, token: string, accountToBlock: string, statusCodeExpected = 204) { +function addAccountToAccountBlocklist ( + url: string, + token: string, + accountToBlock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/me/blocklist/accounts' return makePostBodyRequest({ @@ -35,7 +41,12 @@ function addAccountToAccountBlocklist (url: string, token: string, accountToBloc }) } -function removeAccountFromAccountBlocklist (url: string, token: string, accountToUnblock: string, statusCodeExpected = 204) { +function removeAccountFromAccountBlocklist ( + url: string, + token: string, + accountToUnblock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/me/blocklist/accounts/' + accountToUnblock return makeDeleteRequest({ @@ -52,7 +63,7 @@ function getServerBlocklistByAccount ( start: number, count: number, sort = '-createdAt', - statusCodeExpected = 200 + statusCodeExpected = HttpStatusCode.OK_200 ) { const path = '/api/v1/users/me/blocklist/servers' @@ -65,7 +76,12 @@ function getServerBlocklistByAccount ( }) } -function addServerToAccountBlocklist (url: string, token: string, serverToBlock: string, statusCodeExpected = 204) { +function addServerToAccountBlocklist ( + url: string, + token: string, + serverToBlock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/me/blocklist/servers' return makePostBodyRequest({ @@ -79,7 +95,12 @@ function addServerToAccountBlocklist (url: string, token: string, serverToBlock: }) } -function removeServerFromAccountBlocklist (url: string, token: string, serverToBlock: string, statusCodeExpected = 204) { +function removeServerFromAccountBlocklist ( + url: string, + token: string, + serverToBlock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/me/blocklist/servers/' + serverToBlock return makeDeleteRequest({ @@ -96,7 +117,7 @@ function getAccountBlocklistByServer ( start: number, count: number, sort = '-createdAt', - statusCodeExpected = 200 + statusCodeExpected = HttpStatusCode.OK_200 ) { const path = '/api/v1/server/blocklist/accounts' @@ -109,7 +130,12 @@ function getAccountBlocklistByServer ( }) } -function addAccountToServerBlocklist (url: string, token: string, accountToBlock: string, statusCodeExpected = 204) { +function addAccountToServerBlocklist ( + url: string, + token: string, + accountToBlock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/server/blocklist/accounts' return makePostBodyRequest({ @@ -123,7 +149,12 @@ function addAccountToServerBlocklist (url: string, token: string, accountToBlock }) } -function removeAccountFromServerBlocklist (url: string, token: string, accountToUnblock: string, statusCodeExpected = 204) { +function removeAccountFromServerBlocklist ( + url: string, + token: string, + accountToUnblock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/server/blocklist/accounts/' + accountToUnblock return makeDeleteRequest({ @@ -140,7 +171,7 @@ function getServerBlocklistByServer ( start: number, count: number, sort = '-createdAt', - statusCodeExpected = 200 + statusCodeExpected = HttpStatusCode.OK_200 ) { const path = '/api/v1/server/blocklist/servers' @@ -153,7 +184,12 @@ function getServerBlocklistByServer ( }) } -function addServerToServerBlocklist (url: string, token: string, serverToBlock: string, statusCodeExpected = 204) { +function addServerToServerBlocklist ( + url: string, + token: string, + serverToBlock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/server/blocklist/servers' return makePostBodyRequest({ @@ -167,7 +203,12 @@ function addServerToServerBlocklist (url: string, token: string, serverToBlock: }) } -function removeServerFromServerBlocklist (url: string, token: string, serverToBlock: string, statusCodeExpected = 204) { +function removeServerFromServerBlocklist ( + url: string, + token: string, + serverToBlock: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/server/blocklist/servers/' + serverToBlock return makeDeleteRequest({ diff --git a/shared/extra-utils/users/user-notifications.ts b/shared/extra-utils/users/user-notifications.ts index 98d222e1d..467a3d959 100644 --- a/shared/extra-utils/users/user-notifications.ts +++ b/shared/extra-utils/users/user-notifications.ts @@ -11,8 +11,14 @@ import { flushAndRunMultipleServers, ServerInfo } from '../server/servers' import { getUserNotificationSocket } from '../socket/socket-io' import { setAccessTokensToServers, userLogin } from './login' import { createUser, getMyUserInformation } from './users' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' -function updateMyNotificationSettings (url: string, token: string, settings: UserNotificationSetting, statusCodeExpected = 204) { +function updateMyNotificationSettings ( + url: string, + token: string, + settings: UserNotificationSetting, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/me/notification-settings' return makePutBodyRequest({ @@ -31,7 +37,7 @@ async function getUserNotifications ( count: number, unread?: boolean, sort = '-createdAt', - statusCodeExpected = 200 + statusCodeExpected = HttpStatusCode.OK_200 ) { const path = '/api/v1/users/me/notifications' @@ -49,7 +55,7 @@ async function getUserNotifications ( }) } -function markAsReadNotifications (url: string, token: string, ids: number[], statusCodeExpected = 204) { +function markAsReadNotifications (url: string, token: string, ids: number[], statusCodeExpected = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users/me/notifications/read' return makePostBodyRequest({ @@ -61,7 +67,7 @@ function markAsReadNotifications (url: string, token: string, ids: number[], sta }) } -function markAsReadAllNotifications (url: string, token: string, statusCodeExpected = 204) { +function markAsReadAllNotifications (url: string, token: string, statusCodeExpected = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users/me/notifications/read-all' return makePostBodyRequest({ diff --git a/shared/extra-utils/users/user-subscriptions.ts b/shared/extra-utils/users/user-subscriptions.ts index 6d402c073..edc7a3562 100644 --- a/shared/extra-utils/users/user-subscriptions.ts +++ b/shared/extra-utils/users/user-subscriptions.ts @@ -1,6 +1,7 @@ import { makeDeleteRequest, makeGetRequest, makePostBodyRequest } from '../requests/requests' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' -function addUserSubscription (url: string, token: string, targetUri: string, statusCodeExpected = 204) { +function addUserSubscription (url: string, token: string, targetUri: string, statusCodeExpected = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users/me/subscriptions' return makePostBodyRequest({ @@ -19,7 +20,7 @@ function listUserSubscriptions (parameters: { search?: string statusCodeExpected?: number }) { - const { url, token, sort = '-createdAt', search, statusCodeExpected = 200 } = parameters + const { url, token, sort = '-createdAt', search, statusCodeExpected = HttpStatusCode.OK_200 } = parameters const path = '/api/v1/users/me/subscriptions' return makeGetRequest({ @@ -34,7 +35,7 @@ function listUserSubscriptions (parameters: { }) } -function listUserSubscriptionVideos (url: string, token: string, sort = '-createdAt', statusCodeExpected = 200) { +function listUserSubscriptionVideos (url: string, token: string, sort = '-createdAt', statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/users/me/subscriptions/videos' return makeGetRequest({ @@ -46,7 +47,7 @@ function listUserSubscriptionVideos (url: string, token: string, sort = '-create }) } -function getUserSubscription (url: string, token: string, uri: string, statusCodeExpected = 200) { +function getUserSubscription (url: string, token: string, uri: string, statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/users/me/subscriptions/' + uri return makeGetRequest({ @@ -57,7 +58,7 @@ function getUserSubscription (url: string, token: string, uri: string, statusCod }) } -function removeUserSubscription (url: string, token: string, uri: string, statusCodeExpected = 204) { +function removeUserSubscription (url: string, token: string, uri: string, statusCodeExpected = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users/me/subscriptions/' + uri return makeDeleteRequest({ @@ -68,7 +69,7 @@ function removeUserSubscription (url: string, token: string, uri: string, status }) } -function areSubscriptionsExist (url: string, token: string, uris: string[], statusCodeExpected = 200) { +function areSubscriptionsExist (url: string, token: string, uris: string[], statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/users/me/subscriptions/exist' return makeGetRequest({ diff --git a/shared/extra-utils/users/users.ts b/shared/extra-utils/users/users.ts index ebb8bc257..c683dcdd1 100644 --- a/shared/extra-utils/users/users.ts +++ b/shared/extra-utils/users/users.ts @@ -7,6 +7,7 @@ import { UserRole } from '../../models/users/user-role' import { makeGetRequest, makePostBodyRequest, makePutBodyRequest, updateAvatarRequest } from '../requests/requests' import { ServerInfo } from '../server/servers' import { userLogin } from './login' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' type CreateUserArgs = { url: string @@ -29,7 +30,7 @@ function createUser (parameters: CreateUserArgs) { videoQuota = 1000000, videoQuotaDaily = -1, role = UserRole.USER, - specialStatus = 200 + specialStatus = HttpStatusCode.OK_200 } = parameters const path = '/api/v1/users' @@ -58,7 +59,7 @@ async function generateUserAccessToken (server: ServerInfo, username: string) { return userLogin(server, { username, password }) } -function registerUser (url: string, username: string, password: string, specialStatus = 204) { +function registerUser (url: string, username: string, password: string, specialStatus = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users/register' const body = { username, @@ -94,11 +95,11 @@ function registerUserWithChannel (options: { url: options.url, path, fields: body, - statusCodeExpected: 204 + statusCodeExpected: HttpStatusCode.NO_CONTENT_204 }) } -function getMyUserInformation (url: string, accessToken: string, specialStatus = 200) { +function getMyUserInformation (url: string, accessToken: string, specialStatus = HttpStatusCode.OK_200) { const path = '/api/v1/users/me' return request(url) @@ -109,7 +110,7 @@ function getMyUserInformation (url: string, accessToken: string, specialStatus = .expect('Content-Type', /json/) } -function getUserScopedTokens (url: string, token: string, statusCodeExpected = 200) { +function getUserScopedTokens (url: string, token: string, statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/users/scoped-tokens' return makeGetRequest({ @@ -120,7 +121,7 @@ function getUserScopedTokens (url: string, token: string, statusCodeExpected = 2 }) } -function renewUserScopedTokens (url: string, token: string, statusCodeExpected = 200) { +function renewUserScopedTokens (url: string, token: string, statusCodeExpected = HttpStatusCode.OK_200) { const path = '/api/v1/users/scoped-tokens' return makePostBodyRequest({ @@ -131,7 +132,7 @@ function renewUserScopedTokens (url: string, token: string, statusCodeExpected = }) } -function deleteMe (url: string, accessToken: string, specialStatus = 204) { +function deleteMe (url: string, accessToken: string, specialStatus = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users/me' return request(url) @@ -141,7 +142,7 @@ function deleteMe (url: string, accessToken: string, specialStatus = 204) { .expect(specialStatus) } -function getMyUserVideoQuotaUsed (url: string, accessToken: string, specialStatus = 200) { +function getMyUserVideoQuotaUsed (url: string, accessToken: string, specialStatus = HttpStatusCode.OK_200) { const path = '/api/v1/users/me/video-quota-used' return request(url) @@ -160,11 +161,11 @@ function getUserInformation (url: string, accessToken: string, userId: number, w .query({ withStats }) .set('Accept', 'application/json') .set('Authorization', 'Bearer ' + accessToken) - .expect(200) + .expect(HttpStatusCode.OK_200) .expect('Content-Type', /json/) } -function getMyUserVideoRating (url: string, accessToken: string, videoId: number | string, specialStatus = 200) { +function getMyUserVideoRating (url: string, accessToken: string, videoId: number | string, specialStatus = HttpStatusCode.OK_200) { const path = '/api/v1/users/me/videos/' + videoId + '/rating' return request(url) @@ -182,7 +183,7 @@ function getUsersList (url: string, accessToken: string) { .get(path) .set('Accept', 'application/json') .set('Authorization', 'Bearer ' + accessToken) - .expect(200) + .expect(HttpStatusCode.OK_200) .expect('Content-Type', /json/) } @@ -210,11 +211,11 @@ function getUsersListPaginationAndSort ( .query(query) .set('Accept', 'application/json') .set('Authorization', 'Bearer ' + accessToken) - .expect(200) + .expect(HttpStatusCode.OK_200) .expect('Content-Type', /json/) } -function removeUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) { +function removeUser (url: string, userId: number | string, accessToken: string, expectedStatus = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users' return request(url) @@ -224,7 +225,13 @@ function removeUser (url: string, userId: number | string, accessToken: string, .expect(expectedStatus) } -function blockUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204, reason?: string) { +function blockUser ( + url: string, + userId: number | string, + accessToken: string, + expectedStatus = HttpStatusCode.NO_CONTENT_204, + reason?: string +) { const path = '/api/v1/users' let body: any if (reason) body = { reason } @@ -237,7 +244,7 @@ function blockUser (url: string, userId: number | string, accessToken: string, e .expect(expectedStatus) } -function unblockUser (url: string, userId: number | string, accessToken: string, expectedStatus = 204) { +function unblockUser (url: string, userId: number | string, accessToken: string, expectedStatus = HttpStatusCode.NO_CONTENT_204) { const path = '/api/v1/users' return request(url) @@ -247,7 +254,7 @@ function unblockUser (url: string, userId: number | string, accessToken: string, .expect(expectedStatus) } -function updateMyUser (options: { url: string, accessToken: string, statusCodeExpected?: number } & UserUpdateMe) { +function updateMyUser (options: { url: string, accessToken: string, statusCodeExpected?: HttpStatusCode } & UserUpdateMe) { const path = '/api/v1/users/me' const toSend: UserUpdateMe = omit(options, 'url', 'accessToken') @@ -257,7 +264,7 @@ function updateMyUser (options: { url: string, accessToken: string, statusCodeEx path, token: options.accessToken, fields: toSend, - statusCodeExpected: options.statusCodeExpected || 204 + statusCodeExpected: options.statusCodeExpected || HttpStatusCode.NO_CONTENT_204 }) } @@ -299,7 +306,7 @@ function updateUser (options: { path, token: options.accessToken, fields: toSend, - statusCodeExpected: 204 + statusCodeExpected: HttpStatusCode.NO_CONTENT_204 }) } @@ -310,11 +317,17 @@ function askResetPassword (url: string, email: string) { url, path, fields: { email }, - statusCodeExpected: 204 + statusCodeExpected: HttpStatusCode.NO_CONTENT_204 }) } -function resetPassword (url: string, userId: number, verificationString: string, password: string, statusCodeExpected = 204) { +function resetPassword ( + url: string, + userId: number, + verificationString: string, + password: string, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/' + userId + '/reset-password' return makePostBodyRequest({ @@ -332,11 +345,17 @@ function askSendVerifyEmail (url: string, email: string) { url, path, fields: { email }, - statusCodeExpected: 204 + statusCodeExpected: HttpStatusCode.NO_CONTENT_204 }) } -function verifyEmail (url: string, userId: number, verificationString: string, isPendingEmail = false, statusCodeExpected = 204) { +function verifyEmail ( + url: string, + userId: number, + verificationString: string, + isPendingEmail = false, + statusCodeExpected = HttpStatusCode.NO_CONTENT_204 +) { const path = '/api/v1/users/' + userId + '/verify-email' return makePostBodyRequest({ -- cgit v1.2.3