Deprecate filter video query

Introduce include and isLocal instead

3 files changed, 204 insertions, 115 deletions

diff --git a/server/tests/api/check-params/index.ts b/server/tests/api/check-params/index.ts
index a14e4d3e0..0882f8176 100644
--- a/server/tests/api/check-params/index.ts
+++ b/server/tests/api/check-params/index.ts
@@ -27,6 +27,6 @@ import './video-comments'
 import './video-imports'
 import './video-playlists'
 import './videos'
-import './videos-filter'
+import './videos-common-filters'
 import './videos-history'
 import './videos-overviews'
diff --git a/server/tests/api/check-params/videos-common-filters.ts b/server/tests/api/check-params/videos-common-filters.ts
new file mode 100644
index 000000000..afe42b0d5
--- /dev/null
+++ b/server/tests/api/check-params/videos-common-filters.ts
@@ -0,0 +1,203 @@
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
+
+import 'mocha'
+import {
+  cleanupTests,
+  createSingleServer,
+  makeGetRequest,
+  PeerTubeServer,
+  setAccessTokensToServers,
+  setDefaultVideoChannel
+} from '@shared/extra-utils'
+import { HttpStatusCode, UserRole, VideoInclude } from '@shared/models'
+
+describe('Test video filters validators', function () {
+  let server: PeerTubeServer
+  let userAccessToken: string
+  let moderatorAccessToken: string
+
+  // ---------------------------------------------------------------
+
+  before(async function () {
+    this.timeout(30000)
+
+    server = await createSingleServer(1)
+
+    await setAccessTokensToServers([ server ])
+    await setDefaultVideoChannel([ server ])
+
+    const user = { username: 'user1', password: 'my super password' }
+    await server.users.create({ username: user.username, password: user.password })
+    userAccessToken = await server.login.getAccessToken(user)
+
+    const moderator = { username: 'moderator', password: 'my super password' }
+    await server.users.create({ username: moderator.username, password: moderator.password, role: UserRole.MODERATOR })
+
+    moderatorAccessToken = await server.login.getAccessToken(moderator)
+  })
+
+  describe('When setting a deprecated video filter', function () {
+
+    async function testEndpoints (token: string, filter: string, expectedStatus: HttpStatusCode) {
+      const paths = [
+        '/api/v1/video-channels/root_channel/videos',
+        '/api/v1/accounts/root/videos',
+        '/api/v1/videos',
+        '/api/v1/search/videos'
+      ]
+
+      for (const path of paths) {
+        await makeGetRequest({
+          url: server.url,
+          path,
+          token,
+          query: {
+            filter
+          },
+          expectedStatus
+        })
+      }
+    }
+
+    it('Should fail with a bad filter', async function () {
+      await testEndpoints(server.accessToken, 'bad-filter', HttpStatusCode.BAD_REQUEST_400)
+    })
+
+    it('Should succeed with a good filter', async function () {
+      await testEndpoints(server.accessToken, 'local', HttpStatusCode.OK_200)
+    })
+
+    it('Should fail to list all-local/all with a simple user', async function () {
+      await testEndpoints(userAccessToken, 'all-local', HttpStatusCode.UNAUTHORIZED_401)
+      await testEndpoints(userAccessToken, 'all', HttpStatusCode.UNAUTHORIZED_401)
+    })
+
+    it('Should succeed to list all-local/all with a moderator', async function () {
+      await testEndpoints(moderatorAccessToken, 'all-local', HttpStatusCode.OK_200)
+      await testEndpoints(moderatorAccessToken, 'all', HttpStatusCode.OK_200)
+    })
+
+    it('Should succeed to list all-local/all with an admin', async function () {
+      await testEndpoints(server.accessToken, 'all-local', HttpStatusCode.OK_200)
+      await testEndpoints(server.accessToken, 'all', HttpStatusCode.OK_200)
+    })
+
+    // Because we cannot authenticate the user on the RSS endpoint
+    it('Should fail on the feeds endpoint with the all-local/all filter', async function () {
+      for (const filter of [ 'all', 'all-local' ]) {
+        await makeGetRequest({
+          url: server.url,
+          path: '/feeds/videos.json',
+          expectedStatus: HttpStatusCode.UNAUTHORIZED_401,
+          query: {
+            filter
+          }
+        })
+      }
+    })
+
+    it('Should succeed on the feeds endpoint with the local filter', async function () {
+      await makeGetRequest({
+        url: server.url,
+        path: '/feeds/videos.json',
+        expectedStatus: HttpStatusCode.OK_200,
+        query: {
+          filter: 'local'
+        }
+      })
+    })
+  })
+
+  describe('When setting video filters', function () {
+
+    const validIncludes = [
+      VideoInclude.NONE,
+      VideoInclude.HIDDEN_PRIVACY,
+      VideoInclude.NOT_PUBLISHED_STATE | VideoInclude.BLACKLISTED
+    ]
+
+    async function testEndpoints (options: {
+      token?: string
+      isLocal?: boolean
+      include?: VideoInclude
+      expectedStatus: HttpStatusCode
+    }) {
+      const paths = [
+        '/api/v1/video-channels/root_channel/videos',
+        '/api/v1/accounts/root/videos',
+        '/api/v1/videos',
+        '/api/v1/search/videos'
+      ]
+
+      for (const path of paths) {
+        await makeGetRequest({
+          url: server.url,
+          path,
+          token: options.token || server.accessToken,
+          query: {
+            isLocal: options.isLocal,
+            include: options.include
+          },
+          expectedStatus: options.expectedStatus
+        })
+      }
+    }
+
+    it('Should fail with a bad include', async function () {
+      await testEndpoints({ include: 'toto' as any, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
+    })
+
+    it('Should succeed with a good include', async function () {
+      for (const include of validIncludes) {
+        await testEndpoints({ include, expectedStatus: HttpStatusCode.OK_200 })
+      }
+    })
+
+    it('Should fail to include more videos with a simple user', async function () {
+      for (const include of validIncludes) {
+        await testEndpoints({ token: userAccessToken, include, expectedStatus: HttpStatusCode.UNAUTHORIZED_401 })
+      }
+    })
+
+    it('Should succeed to list all local/all with a moderator', async function () {
+      for (const include of validIncludes) {
+        await testEndpoints({ token: moderatorAccessToken, include, expectedStatus: HttpStatusCode.OK_200 })
+      }
+    })
+
+    it('Should succeed to list all local/all with an admin', async function () {
+      for (const include of validIncludes) {
+        await testEndpoints({ token: server.accessToken, include, expectedStatus: HttpStatusCode.OK_200 })
+      }
+    })
+
+    // Because we cannot authenticate the user on the RSS endpoint
+    it('Should fail on the feeds endpoint with the all filter', async function () {
+      for (const include of [ VideoInclude.NOT_PUBLISHED_STATE ]) {
+        await makeGetRequest({
+          url: server.url,
+          path: '/feeds/videos.json',
+          expectedStatus: HttpStatusCode.UNAUTHORIZED_401,
+          query: {
+            include
+          }
+        })
+      }
+    })
+
+    it('Should succeed on the feeds endpoint with the local filter', async function () {
+      await makeGetRequest({
+        url: server.url,
+        path: '/feeds/videos.json',
+        expectedStatus: HttpStatusCode.OK_200,
+        query: {
+          isLocal: true
+        }
+      })
+    })
+  })
+
+  after(async function () {
+    await cleanupTests([ server ])
+  })
+})
diff --git a/server/tests/api/check-params/videos-filter.ts b/server/tests/api/check-params/videos-filter.ts
deleted file mode 100644
index d08570bbe..000000000
--- a/server/tests/api/check-params/videos-filter.ts
+++ /dev/null
@@ -1,114 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
-
-import 'mocha'
-import {
-  cleanupTests,
-  createSingleServer,
-  makeGetRequest,
-  PeerTubeServer,
-  setAccessTokensToServers,
-  setDefaultVideoChannel
-} from '@shared/extra-utils'
-import { HttpStatusCode, UserRole } from '@shared/models'
-
-async function testEndpoints (server: PeerTubeServer, token: string, filter: string, expectedStatus: HttpStatusCode) {
-  const paths = [
-    '/api/v1/video-channels/root_channel/videos',
-    '/api/v1/accounts/root/videos',
-    '/api/v1/videos',
-    '/api/v1/search/videos'
-  ]
-
-  for (const path of paths) {
-    await makeGetRequest({
-      url: server.url,
-      path,
-      token,
-      query: {
-        filter
-      },
-      expectedStatus
-    })
-  }
-}
-
-describe('Test video filters validators', function () {
-  let server: PeerTubeServer
-  let userAccessToken: string
-  let moderatorAccessToken: string
-
-  // ---------------------------------------------------------------
-
-  before(async function () {
-    this.timeout(30000)
-
-    server = await createSingleServer(1)
-
-    await setAccessTokensToServers([ server ])
-    await setDefaultVideoChannel([ server ])
-
-    const user = { username: 'user1', password: 'my super password' }
-    await server.users.create({ username: user.username, password: user.password })
-    userAccessToken = await server.login.getAccessToken(user)
-
-    const moderator = { username: 'moderator', password: 'my super password' }
-    await server.users.create({ username: moderator.username, password: moderator.password, role: UserRole.MODERATOR })
-
-    moderatorAccessToken = await server.login.getAccessToken(moderator)
-  })
-
-  describe('When setting a video filter', function () {
-
-    it('Should fail with a bad filter', async function () {
-      await testEndpoints(server, server.accessToken, 'bad-filter', HttpStatusCode.BAD_REQUEST_400)
-    })
-
-    it('Should succeed with a good filter', async function () {
-      await testEndpoints(server, server.accessToken, 'local', HttpStatusCode.OK_200)
-    })
-
-    it('Should fail to list all-local/all with a simple user', async function () {
-      await testEndpoints(server, userAccessToken, 'all-local', HttpStatusCode.UNAUTHORIZED_401)
-      await testEndpoints(server, userAccessToken, 'all', HttpStatusCode.UNAUTHORIZED_401)
-    })
-
-    it('Should succeed to list all-local/all with a moderator', async function () {
-      await testEndpoints(server, moderatorAccessToken, 'all-local', HttpStatusCode.OK_200)
-      await testEndpoints(server, moderatorAccessToken, 'all', HttpStatusCode.OK_200)
-    })
-
-    it('Should succeed to list all-local/all with an admin', async function () {
-      await testEndpoints(server, server.accessToken, 'all-local', HttpStatusCode.OK_200)
-      await testEndpoints(server, server.accessToken, 'all', HttpStatusCode.OK_200)
-    })
-
-    // Because we cannot authenticate the user on the RSS endpoint
-    it('Should fail on the feeds endpoint with the all-local/all filter', async function () {
-      for (const filter of [ 'all', 'all-local' ]) {
-        await makeGetRequest({
-          url: server.url,
-          path: '/feeds/videos.json',
-          expectedStatus: HttpStatusCode.UNAUTHORIZED_401,
-          query: {
-            filter
-          }
-        })
-      }
-    })
-
-    it('Should succeed on the feeds endpoint with the local filter', async function () {
-      await makeGetRequest({
-        url: server.url,
-        path: '/feeds/videos.json',
-        expectedStatus: HttpStatusCode.OK_200,
-        query: {
-          filter: 'local'
-        }
-      })
-    })
-  })
-
-  after(async function () {
-    await cleanupTests([ server ])
-  })
-})