From 23a3a8827cb8b862f5cc7ee2819f39918303beca Mon Sep 17 00:00:00 2001
From: Chocobozzz <me@florianbigard.com>
Date: Tue, 6 Jul 2021 14:30:20 +0200
Subject: Introduce overviews command

---
 shared/extra-utils/index.ts                       |  1 +
 shared/extra-utils/overviews/index.ts             |  1 +
 shared/extra-utils/overviews/overviews-command.ts | 25 +++++++++++++++++
 shared/extra-utils/overviews/overviews.ts         | 34 -----------------------
 shared/extra-utils/server/servers.ts              |  3 ++
 shared/extra-utils/shared/abstract-command.ts     |  5 +++-
 6 files changed, 34 insertions(+), 35 deletions(-)
 create mode 100644 shared/extra-utils/overviews/index.ts
 create mode 100644 shared/extra-utils/overviews/overviews-command.ts
 delete mode 100644 shared/extra-utils/overviews/overviews.ts

(limited to 'shared')

diff --git a/shared/extra-utils/index.ts b/shared/extra-utils/index.ts
index 7ca079c78..38c8c4c1c 100644
--- a/shared/extra-utils/index.ts
+++ b/shared/extra-utils/index.ts
@@ -6,6 +6,7 @@ export * from './logs'
 export * from './miscs'
 export * from './mock-servers'
 export * from './moderation'
+export * from './overviews'
 
 export * from './requests/check-api-params'
 export * from './requests/requests'
diff --git a/shared/extra-utils/overviews/index.ts b/shared/extra-utils/overviews/index.ts
new file mode 100644
index 000000000..e19551907
--- /dev/null
+++ b/shared/extra-utils/overviews/index.ts
@@ -0,0 +1 @@
+export * from './overviews-command'
diff --git a/shared/extra-utils/overviews/overviews-command.ts b/shared/extra-utils/overviews/overviews-command.ts
new file mode 100644
index 000000000..0ac3cbd33
--- /dev/null
+++ b/shared/extra-utils/overviews/overviews-command.ts
@@ -0,0 +1,25 @@
+import { HttpStatusCode } from '@shared/core-utils'
+import { VideosOverview } from '@shared/models'
+import { AbstractCommand, OverrideCommandOptions } from '../shared'
+
+export class OverviewsCommand extends AbstractCommand {
+
+  getVideos (options: OverrideCommandOptions & {
+    page: number
+    token?: string
+  }) {
+    const { token, page } = options
+    const path = '/api/v1/overviews/videos'
+
+    const query = { page }
+
+    return this.getRequestBody<VideosOverview>({
+      ...options,
+
+      token: token || null,
+      path,
+      query,
+      defaultExpectedStatus: HttpStatusCode.OK_200
+    })
+  }
+}
diff --git a/shared/extra-utils/overviews/overviews.ts b/shared/extra-utils/overviews/overviews.ts
deleted file mode 100644
index 5e1a13e5e..000000000
--- a/shared/extra-utils/overviews/overviews.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-import { makeGetRequest } from '../requests/requests'
-import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
-
-function getVideosOverview (url: string, page: number, statusCodeExpected = HttpStatusCode.OK_200) {
-  const path = '/api/v1/overviews/videos'
-
-  const query = { page }
-
-  return makeGetRequest({
-    url,
-    path,
-    query,
-    statusCodeExpected
-  })
-}
-
-function getVideosOverviewWithToken (url: string, page: number, token: string, statusCodeExpected = HttpStatusCode.OK_200) {
-  const path = '/api/v1/overviews/videos'
-
-  const query = { page }
-
-  return makeGetRequest({
-    url,
-    path,
-    query,
-    token,
-    statusCodeExpected
-  })
-}
-
-export {
-  getVideosOverview,
-  getVideosOverviewWithToken
-}
diff --git a/shared/extra-utils/server/servers.ts b/shared/extra-utils/server/servers.ts
index f05f0dbbe..70be96cf6 100644
--- a/shared/extra-utils/server/servers.ts
+++ b/shared/extra-utils/server/servers.ts
@@ -13,6 +13,7 @@ import { FeedCommand } from '../feeds'
 import { LogsCommand } from '../logs'
 import { buildServerDirectory, getFileSize, isGithubCI, root, wait } from '../miscs/miscs'
 import { AbusesCommand } from '../moderation'
+import { OverviewsCommand } from '../overviews'
 import { makeGetRequest } from '../requests/requests'
 
 interface ServerInfo {
@@ -73,6 +74,7 @@ interface ServerInfo {
   feedCommand?: FeedCommand
   logsCommand?: LogsCommand
   abusesCommand?: AbusesCommand
+  overviewsCommand?: OverviewsCommand
 }
 
 function parallelTests () {
@@ -284,6 +286,7 @@ async function runServer (server: ServerInfo, configOverrideArg?: any, args = []
       server.feedCommand = new FeedCommand(server)
       server.logsCommand = new LogsCommand(server)
       server.abusesCommand = new AbusesCommand(server)
+      server.overviewsCommand = new OverviewsCommand(server)
 
       res(server)
     })
diff --git a/shared/extra-utils/shared/abstract-command.ts b/shared/extra-utils/shared/abstract-command.ts
index 3ee5cd865..3815fab0e 100644
--- a/shared/extra-utils/shared/abstract-command.ts
+++ b/shared/extra-utils/shared/abstract-command.ts
@@ -78,7 +78,10 @@ abstract class AbstractCommand {
     return {
       url: this.server.url,
       path,
-      token: token ?? this.server.accessToken,
+
+      // Token can be null if we don't want to add it
+      token: token !== undefined ? token : this.server.accessToken,
+
       statusCodeExpected: expectedStatus ?? this.expectedStatus ?? defaultExpectedStatus
     }
   }
-- 
cgit v1.2.3