replace numbers with typed http status codes (#3409)

[github/Chocobozzz/PeerTube.git] / shared / extra-utils / videos / video-playlists.ts

diff --git a/shared/extra-utils/videos/video-playlists.ts b/shared/extra-utils/videos/video-playlists.ts
index 4d110a13124cebd1bd47ae286788a7d66cf3e013..c6f799e5d8a0357c739ce2652b6fc8b0680f3e36 100644 (file)
--- a/shared/extra-utils/videos/video-playlists.ts
+++ b/shared/extra-utils/videos/video-playlists.ts
@@ -10,6 +10,7 @@ import { root } from '..'
 import { readdir } from 'fs-extra'
 import { expect } from 'chai'
 import { VideoPlaylistType } from '../../models/videos/playlist/video-playlist-type.model'
+import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
 
 function getVideoPlaylistsList (url: string, start: number, count: number, sort?: string) {
   const path = '/api/v1/video-playlists'
@@ -24,7 +25,7 @@ function getVideoPlaylistsList (url: string, start: number, count: number, sort?
     url,
     path,
     query,
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }
 
@@ -41,24 +42,25 @@ function getVideoChannelPlaylistsList (url: string, videoChannelName: string, st
     url,
     path,
     query,
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }
 
-function getAccountPlaylistsList (url: string, accountName: string, start: number, count: number, sort?: string) {
+function getAccountPlaylistsList (url: string, accountName: string, start: number, count: number, sort?: string, search?: string) {
   const path = '/api/v1/accounts/' + accountName + '/video-playlists'
 
   const query = {
     start,
     count,
-    sort
+    sort,
+    search
   }
 
   return makeGetRequest({
     url,
     path,
     query,
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }
 
@@ -85,11 +87,11 @@ function getAccountPlaylistsListWithToken (
     token,
     path,
     query,
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }
 
-function getVideoPlaylist (url: string, playlistId: number | string, statusCodeExpected = 200) {
+function getVideoPlaylist (url: string, playlistId: number | string, statusCodeExpected = HttpStatusCode.OK_200) {
   const path = '/api/v1/video-playlists/' + playlistId
 
   return makeGetRequest({
@@ -99,7 +101,7 @@ function getVideoPlaylist (url: string, playlistId: number | string, statusCodeE
   })
 }
 
-function getVideoPlaylistWithToken (url: string, token: string, playlistId: number | string, statusCodeExpected = 200) {
+function getVideoPlaylistWithToken (url: string, token: string, playlistId: number | string, statusCodeExpected = HttpStatusCode.OK_200) {
   const path = '/api/v1/video-playlists/' + playlistId
 
   return makeGetRequest({
@@ -110,7 +112,7 @@ function getVideoPlaylistWithToken (url: string, token: string, playlistId: numb
   })
 }
 
-function deleteVideoPlaylist (url: string, token: string, playlistId: number | string, statusCodeExpected = 204) {
+function deleteVideoPlaylist (url: string, token: string, playlistId: number | string, statusCodeExpected = HttpStatusCode.NO_CONTENT_204) {
   const path = '/api/v1/video-playlists/' + playlistId
 
   return makeDeleteRequest({
@@ -122,9 +124,9 @@ function deleteVideoPlaylist (url: string, token: string, playlistId: number | s
 }
 
 function createVideoPlaylist (options: {
-  url: string,
-  token: string,
-  playlistAttrs: VideoPlaylistCreate,
+  url: string
+  token: string
+  playlistAttrs: VideoPlaylistCreate
   expectedStatus?: number
 }) {
   const path = '/api/v1/video-playlists'
@@ -142,15 +144,15 @@ function createVideoPlaylist (options: {
     token: options.token,
     fields,
     attaches,
-    statusCodeExpected: options.expectedStatus || 200
+    statusCodeExpected: options.expectedStatus || HttpStatusCode.OK_200
   })
 }
 
 function updateVideoPlaylist (options: {
-  url: string,
-  token: string,
-  playlistAttrs: VideoPlaylistUpdate,
-  playlistId: number | string,
+  url: string
+  token: string
+  playlistAttrs: VideoPlaylistUpdate
+  playlistId: number | string
   expectedStatus?: number
 }) {
   const path = '/api/v1/video-playlists/' + options.playlistId
@@ -168,14 +170,14 @@ function updateVideoPlaylist (options: {
     token: options.token,
     fields,
     attaches,
-    statusCodeExpected: options.expectedStatus || 204
+    statusCodeExpected: options.expectedStatus || HttpStatusCode.NO_CONTENT_204
   })
 }
 
 async function addVideoInPlaylist (options: {
-  url: string,
-  token: string,
-  playlistId: number | string,
+  url: string
+  token: string
+  playlistId: number | string
   elementAttrs: VideoPlaylistElementCreate | { videoId: string }
   expectedStatus?: number
 }) {
@@ -188,55 +190,55 @@ async function addVideoInPlaylist (options: {
     path,
     token: options.token,
     fields: options.elementAttrs,
-    statusCodeExpected: options.expectedStatus || 200
+    statusCodeExpected: options.expectedStatus || HttpStatusCode.OK_200
   })
 }
 
 function updateVideoPlaylistElement (options: {
-  url: string,
-  token: string,
-  playlistId: number | string,
-  videoId: number | string,
-  elementAttrs: VideoPlaylistElementUpdate,
+  url: string
+  token: string
+  playlistId: number | string
+  playlistElementId: number | string
+  elementAttrs: VideoPlaylistElementUpdate
   expectedStatus?: number
 }) {
-  const path = '/api/v1/video-playlists/' + options.playlistId + '/videos/' + options.videoId
+  const path = '/api/v1/video-playlists/' + options.playlistId + '/videos/' + options.playlistElementId
 
   return makePutBodyRequest({
     url: options.url,
     path,
     token: options.token,
     fields: options.elementAttrs,
-    statusCodeExpected: options.expectedStatus || 204
+    statusCodeExpected: options.expectedStatus || HttpStatusCode.NO_CONTENT_204
   })
 }
 
 function removeVideoFromPlaylist (options: {
-  url: string,
-  token: string,
-  playlistId: number | string,
-  videoId: number | string,
+  url: string
+  token: string
+  playlistId: number | string
+  playlistElementId: number
   expectedStatus?: number
 }) {
-  const path = '/api/v1/video-playlists/' + options.playlistId + '/videos/' + options.videoId
+  const path = '/api/v1/video-playlists/' + options.playlistId + '/videos/' + options.playlistElementId
 
   return makeDeleteRequest({
     url: options.url,
     path,
     token: options.token,
-    statusCodeExpected: options.expectedStatus || 204
+    statusCodeExpected: options.expectedStatus || HttpStatusCode.NO_CONTENT_204
   })
 }
 
 function reorderVideosPlaylist (options: {
-  url: string,
-  token: string,
-  playlistId: number | string,
+  url: string
+  token: string
+  playlistId: number | string
   elementAttrs: {
-    startPosition: number,
-    insertAfterPosition: number,
+    startPosition: number
+    insertAfterPosition: number
     reorderLength?: number
-  },
+  }
   expectedStatus?: number
 }) {
   const path = '/api/v1/video-playlists/' + options.playlistId + '/videos/reorder'
@@ -246,16 +248,16 @@ function reorderVideosPlaylist (options: {
     path,
     token: options.token,
     fields: options.elementAttrs,
-    statusCodeExpected: options.expectedStatus || 204
+    statusCodeExpected: options.expectedStatus || HttpStatusCode.NO_CONTENT_204
   })
 }
 
 async function checkPlaylistFilesWereRemoved (
   playlistUUID: string,
-  serverNumber: number,
+  internalServerNumber: number,
   directories = [ 'thumbnails' ]
 ) {
-  const testDirectory = 'test' + serverNumber
+  const testDirectory = 'test' + internalServerNumber
 
   for (const directory of directories) {
     const directoryPath = join(root(), testDirectory, directory)
@@ -273,7 +275,7 @@ function getVideoPlaylistPrivacies (url: string) {
   return makeGetRequest({
     url,
     path,
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }
 
@@ -285,7 +287,7 @@ function doVideosExistInMyPlaylist (url: string, token: string, videoIds: number
     token,
     path,
     query: { videoIds },
-    statusCodeExpected: 200
+    statusCodeExpected: HttpStatusCode.OK_200
   })
 }