shared/ typescript types dir server-commands

3 files changed, 259 insertions, 0 deletions

diff --git a/shared/server-commands/requests/check-api-params.ts b/shared/server-commands/requests/check-api-params.ts
new file mode 100644
index 000000000..26ba1e913
--- /dev/null
+++ b/shared/server-commands/requests/check-api-params.ts
@@ -0,0 +1,48 @@
+import { HttpStatusCode } from '@shared/models'
+import { makeGetRequest } from './requests'
+
+function checkBadStartPagination (url: string, path: string, token?: string, query = {}) {
+  return makeGetRequest({
+    url,
+    path,
+    token,
+    query: { ...query, start: 'hello' },
+    expectedStatus: HttpStatusCode.BAD_REQUEST_400
+  })
+}
+
+async function checkBadCountPagination (url: string, path: string, token?: string, query = {}) {
+  await makeGetRequest({
+    url,
+    path,
+    token,
+    query: { ...query, count: 'hello' },
+    expectedStatus: HttpStatusCode.BAD_REQUEST_400
+  })
+
+  await makeGetRequest({
+    url,
+    path,
+    token,
+    query: { ...query, count: 2000 },
+    expectedStatus: HttpStatusCode.BAD_REQUEST_400
+  })
+}
+
+function checkBadSortPagination (url: string, path: string, token?: string, query = {}) {
+  return makeGetRequest({
+    url,
+    path,
+    token,
+    query: { ...query, sort: 'hello' },
+    expectedStatus: HttpStatusCode.BAD_REQUEST_400
+  })
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  checkBadStartPagination,
+  checkBadCountPagination,
+  checkBadSortPagination
+}
diff --git a/shared/server-commands/requests/index.ts b/shared/server-commands/requests/index.ts
new file mode 100644
index 000000000..501163f92
--- /dev/null
+++ b/shared/server-commands/requests/index.ts
@@ -0,0 +1,3 @@
+// Don't include activitypub that import stuff from server
+export * from './check-api-params'
+export * from './requests'
diff --git a/shared/server-commands/requests/requests.ts b/shared/server-commands/requests/requests.ts
new file mode 100644
index 000000000..b6b9024ed
--- /dev/null
+++ b/shared/server-commands/requests/requests.ts
@@ -0,0 +1,208 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+
+import { decode } from 'querystring'
+import request from 'supertest'
+import { URL } from 'url'
+import { HttpStatusCode } from '@shared/models'
+import { buildAbsoluteFixturePath } from '../miscs/tests'
+
+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, expectedStatus?: HttpStatusCode, range?: string) {
+  const { host, protocol, pathname } = new URL(url)
+
+  return makeGetRequest({ url: `${protocol}//${host}`, path: pathname, expectedStatus, range })
+}
+
+function makeGetRequest (options: CommonRequestParams & {
+  query?: any
+  rawQuery?: string
+}) {
+  const req = request(options.url).get(options.path)
+
+  if (options.query) req.query(options.query)
+  if (options.rawQuery) req.query(options.rawQuery)
+
+  return buildRequest(req, { contentType: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
+}
+
+function makeHTMLRequest (url: string, path: string) {
+  return makeGetRequest({
+    url,
+    path,
+    accept: 'text/html',
+    expectedStatus: HttpStatusCode.OK_200
+  })
+}
+
+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'
+  })
+}
+
+function makeDeleteRequest (options: CommonRequestParams & {
+  query?: any
+  rawQuery?: string
+}) {
+  const req = request(options.url).delete(options.path)
+
+  if (options.query) req.query(options.query)
+  if (options.rawQuery) req.query(options.rawQuery)
+
+  return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
+}
+
+function makeUploadRequest (options: CommonRequestParams & {
+  method?: 'POST' | 'PUT'
+
+  fields: { [ fieldName: string ]: any }
+  attaches?: { [ attachName: string ]: any | any[] }
+}) {
+  let req = options.method === 'PUT'
+    ? request(options.url).put(options.path)
+    : request(options.url).post(options.path)
+
+  req = buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
+
+  buildFields(req, options.fields)
+
+  Object.keys(options.attaches || {}).forEach(attach => {
+    const value = options.attaches[attach]
+    if (!value) return
+
+    if (Array.isArray(value)) {
+      req.attach(attach, buildAbsoluteFixturePath(value[0]), value[1])
+    } else {
+      req.attach(attach, buildAbsoluteFixturePath(value))
+    }
+  })
+
+  return req
+}
+
+function makePostBodyRequest (options: CommonRequestParams & {
+  fields?: { [ fieldName: string ]: any }
+}) {
+  const req = request(options.url).post(options.path)
+                                  .send(options.fields)
+
+  return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
+}
+
+function makePutBodyRequest (options: {
+  url: string
+  path: string
+  token?: string
+  fields: { [ fieldName: string ]: any }
+  expectedStatus?: HttpStatusCode
+}) {
+  const req = request(options.url).put(options.path)
+                                  .send(options.fields)
+
+  return buildRequest(req, { accept: 'application/json', expectedStatus: HttpStatusCode.BAD_REQUEST_400, ...options })
+}
+
+function decodeQueryString (path: string) {
+  return decode(path.split('?')[1])
+}
+
+function unwrapBody <T> (test: request.Test): Promise<T> {
+  return test.then(res => res.body)
+}
+
+function unwrapText (test: request.Test): Promise<string> {
+  return test.then(res => res.text)
+}
+
+function unwrapBodyOrDecodeToJSON <T> (test: request.Test): Promise<T> {
+  return test.then(res => {
+    if (res.body instanceof Buffer) {
+      return JSON.parse(new TextDecoder().decode(res.body))
+    }
+
+    return res.body
+  })
+}
+
+function unwrapTextOrDecode (test: request.Test): Promise<string> {
+  return test.then(res => res.text || new TextDecoder().decode(res.body))
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  makeHTMLRequest,
+  makeGetRequest,
+  decodeQueryString,
+  makeUploadRequest,
+  makePostBodyRequest,
+  makePutBodyRequest,
+  makeDeleteRequest,
+  makeRawRequest,
+  makeActivityPubGetRequest,
+  unwrapBody,
+  unwrapTextOrDecode,
+  unwrapBodyOrDecodeToJSON,
+  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, [])
+      continue
+    }
+
+    if (fields[key] !== null && typeof fields[key] === 'object') {
+      buildFields(req, fields[key], formKey)
+    } else {
+      req.field(formKey, fields[key])
+    }
+  }
+}