Merge branch 'next' into develop

1 files changed, 111 insertions, 127 deletions

diff --git a/shared/extra-utils/requests/requests.ts b/shared/extra-utils/requests/requests.ts
index 38e24d897..70f790222 100644
--- a/shared/extra-utils/requests/requests.ts
+++ b/shared/extra-utils/requests/requests.ts
@@ -1,103 +1,82 @@
-/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
+/* eslint-disable @typescript-eslint/no-floating-promises */
 
+import { decode } from 'querystring'
 import * as request from 'supertest'
-import { buildAbsoluteFixturePath, root } from '../miscs/miscs'
-import { isAbsolute, join } from 'path'
 import { URL } from 'url'
-import { decode } from 'querystring'
-import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
+import { HttpStatusCode } from '@shared/models'
+import { buildAbsoluteFixturePath } from '../miscs/tests'
 
-function get4KFileUrl () {
-  return 'https://download.cpy.re/peertube/4k_file.txt'
+export type CommonRequestParams = {
+  url: string
+  path?: string
+  contentType?: string
+  range?: string
+  redirects?: number
+  accept?: string
+  host?: string
+  token?: string
+  headers?: { [ name: string ]: string }
+  type?: string
+  xForwardedFor?: string
+  expectedStatus?: HttpStatusCode
 }
 
-function makeRawRequest (url: string, statusCodeExpected?: HttpStatusCode, range?: string) {
+function makeRawRequest (url: string, expectedStatus?: HttpStatusCode, range?: string) {
   const { host, protocol, pathname } = new URL(url)
 
-  return makeGetRequest({ url: `${protocol}//${host}`, path: pathname, statusCodeExpected, range })
+  return makeGetRequest({ url: `${protocol}//${host}`, path: pathname, expectedStatus, range })
 }
 
-function makeGetRequest (options: {
-  url: string
-  path?: string
+function makeGetRequest (options: CommonRequestParams & {
   query?: any
-  token?: string
-  statusCodeExpected?: HttpStatusCode
-  contentType?: string
-  range?: string
-  redirects?: number
-  accept?: string
 }) {
-  if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
-  if (options.contentType === undefined) options.contentType = 'application/json'
-
   const req = request(options.url).get(options.path)
+                                  .query(options.query)
 
-  if (options.contentType) req.set('Accept', options.contentType)
-  if (options.token) req.set('Authorization', 'Bearer ' + options.token)
-  if (options.query) req.query(options.query)
-  if (options.range) req.set('Range', options.range)
-  if (options.accept) req.set('Accept', options.accept)
-  if (options.redirects) req.redirects(options.redirects)
-
-  return req.expect(options.statusCodeExpected)
+  return buildRequest(req, { contentType: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
 }
 
-function makeDeleteRequest (options: {
-  url: string
-  path: string
-  token?: string
-  statusCodeExpected?: HttpStatusCode
-}) {
-  if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
+function makeHTMLRequest (url: string, path: string) {
+  return makeGetRequest({
+    url,
+    path,
+    accept: 'text/html',
+    expectedStatus: HttpStatusCode.OK_200
+  })
+}
 
-  const req = request(options.url)
-    .delete(options.path)
-    .set('Accept', 'application/json')
+function makeActivityPubGetRequest (url: string, path: string, expectedStatus = HttpStatusCode.OK_200) {
+  return makeGetRequest({
+    url,
+    path,
+    expectedStatus: expectedStatus,
+    accept: 'application/activity+json,text/html;q=0.9,\\*/\\*;q=0.8'
+  })
+}
 
-  if (options.token) req.set('Authorization', 'Bearer ' + options.token)
+function makeDeleteRequest (options: CommonRequestParams) {
+  const req = request(options.url).delete(options.path)
 
-  return req.expect(options.statusCodeExpected)
+  return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
 }
 
-function makeUploadRequest (options: {
-  url: string
+function makeUploadRequest (options: CommonRequestParams & {
   method?: 'POST' | 'PUT'
-  path: string
-  token?: string
+
   fields: { [ fieldName: string ]: any }
   attaches?: { [ attachName: string ]: any | any[] }
-  statusCodeExpected?: HttpStatusCode
 }) {
-  if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
-
-  let req: request.Test
-  if (options.method === 'PUT') {
-    req = request(options.url).put(options.path)
-  } else {
-    req = request(options.url).post(options.path)
-  }
-
-  req.set('Accept', 'application/json')
+  let req = options.method === 'PUT'
+    ? request(options.url).put(options.path)
+    : request(options.url).post(options.path)
 
-  if (options.token) req.set('Authorization', 'Bearer ' + options.token)
+  req = buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
 
-  Object.keys(options.fields).forEach(field => {
-    const value = options.fields[field]
-
-    if (value === undefined) return
-
-    if (Array.isArray(value)) {
-      for (let i = 0; i < value.length; i++) {
-        req.field(field + '[' + i + ']', value[i])
-      }
-    } else {
-      req.field(field, value)
-    }
-  })
+  buildFields(req, options.fields)
 
   Object.keys(options.attaches || {}).forEach(attach => {
     const value = options.attaches[attach]
+
     if (Array.isArray(value)) {
       req.attach(attach, buildAbsoluteFixturePath(value[0]), value[1])
     } else {
@@ -105,27 +84,16 @@ function makeUploadRequest (options: {
     }
   })
 
-  return req.expect(options.statusCodeExpected)
+  return req
 }
 
-function makePostBodyRequest (options: {
-  url: string
-  path: string
-  token?: string
+function makePostBodyRequest (options: CommonRequestParams & {
   fields?: { [ fieldName: string ]: any }
-  statusCodeExpected?: HttpStatusCode
 }) {
-  if (!options.fields) options.fields = {}
-  if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
-
-  const req = request(options.url)
-                .post(options.path)
-                .set('Accept', 'application/json')
+  const req = request(options.url).post(options.path)
+                                  .send(options.fields)
 
-  if (options.token) req.set('Authorization', 'Bearer ' + options.token)
-
-  return req.send(options.fields)
-            .expect(options.statusCodeExpected)
+  return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
 }
 
 function makePutBodyRequest (options: {
@@ -133,59 +101,29 @@ function makePutBodyRequest (options: {
   path: string
   token?: string
   fields: { [ fieldName: string ]: any }
-  statusCodeExpected?: HttpStatusCode
+  expectedStatus?: HttpStatusCode
 }) {
-  if (!options.statusCodeExpected) options.statusCodeExpected = HttpStatusCode.BAD_REQUEST_400
-
-  const req = request(options.url)
-                .put(options.path)
-                .set('Accept', 'application/json')
+  const req = request(options.url).put(options.path)
+                                  .send(options.fields)
 
-  if (options.token) req.set('Authorization', 'Bearer ' + options.token)
-
-  return req.send(options.fields)
-            .expect(options.statusCodeExpected)
+  return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
 }
 
-function makeHTMLRequest (url: string, path: string) {
-  return request(url)
-    .get(path)
-    .set('Accept', 'text/html')
-    .expect(HttpStatusCode.OK_200)
+function decodeQueryString (path: string) {
+  return decode(path.split('?')[1])
 }
 
-function updateImageRequest (options: {
-  url: string
-  path: string
-  accessToken: string
-  fixture: string
-  fieldname: string
-}) {
-  let filePath = ''
-  if (isAbsolute(options.fixture)) {
-    filePath = options.fixture
-  } else {
-    filePath = join(root(), 'server', 'tests', 'fixtures', options.fixture)
-  }
-
-  return makeUploadRequest({
-    url: options.url,
-    path: options.path,
-    token: options.accessToken,
-    fields: {},
-    attaches: { [options.fieldname]: filePath },
-    statusCodeExpected: HttpStatusCode.OK_200
-  })
+function unwrapBody <T> (test: request.Test): Promise<T> {
+  return test.then(res => res.body)
 }
 
-function decodeQueryString (path: string) {
-  return decode(path.split('?')[1])
+function unwrapText (test: request.Test): Promise<string> {
+  return test.then(res => res.text)
 }
 
 // ---------------------------------------------------------------------------
 
 export {
-  get4KFileUrl,
   makeHTMLRequest,
   makeGetRequest,
   decodeQueryString,
@@ -194,5 +132,51 @@ export {
   makePutBodyRequest,
   makeDeleteRequest,
   makeRawRequest,
-  updateImageRequest
+  makeActivityPubGetRequest,
+  unwrapBody,
+  unwrapText
+}
+
+// ---------------------------------------------------------------------------
+
+function buildRequest (req: request.Test, options: CommonRequestParams) {
+  if (options.contentType) req.set('Accept', options.contentType)
+  if (options.token) req.set('Authorization', 'Bearer ' + options.token)
+  if (options.range) req.set('Range', options.range)
+  if (options.accept) req.set('Accept', options.accept)
+  if (options.host) req.set('Host', options.host)
+  if (options.redirects) req.redirects(options.redirects)
+  if (options.expectedStatus) req.expect(options.expectedStatus)
+  if (options.xForwardedFor) req.set('X-Forwarded-For', options.xForwardedFor)
+  if (options.type) req.type(options.type)
+
+  Object.keys(options.headers || {}).forEach(name => {
+    req.set(name, options.headers[name])
+  })
+
+  return req
+}
+
+function buildFields (req: request.Test, fields: { [ fieldName: string ]: any }, namespace?: string) {
+  if (!fields) return
+
+  let formKey: string
+
+  for (const key of Object.keys(fields)) {
+    if (namespace) formKey = `${namespace}[${key}]`
+    else formKey = key
+
+    if (fields[key] === undefined) continue
+
+    if (Array.isArray(fields[key]) && fields[key].length === 0) {
+      req.field(key, null)
+      continue
+    }
+
+    if (fields[key] !== null && typeof fields[key] === 'object') {
+      buildFields(req, fields[key], formKey)
+    } else {
+      req.field(formKey, fields[key])
+    }
+  }
 }