Introduce subscriptions command

5 files changed, 99 insertions, 126 deletions

diff --git a/server/tests/api/moderation/blocklist-notification.ts b/server/tests/api/moderation/blocklist-notification.ts
index 99da64a2d..5b9699816 100644
--- a/server/tests/api/moderation/blocklist-notification.ts
+++ b/server/tests/api/moderation/blocklist-notification.ts
@@ -3,7 +3,6 @@
 import 'mocha'
 import * as chai from 'chai'
 import {
-  addUserSubscription,
   addVideoCommentThread,
   cleanupTests,
   createUser,
@@ -11,7 +10,6 @@ import {
   flushAndRunMultipleServers,
   getUserNotifications,
   markAsReadAllNotifications,
-  removeUserSubscription,
   ServerInfo,
   setAccessTokensToServers,
   uploadVideo,
@@ -44,8 +42,8 @@ describe('Test blocklist', function () {
 
   async function resetState () {
     try {
-      await removeUserSubscription(servers[1].url, remoteUserToken, 'user1_channel@' + servers[0].host)
-      await removeUserSubscription(servers[1].url, remoteUserToken, 'user2_channel@' + servers[0].host)
+      await servers[1].subscriptionsCommand.remove({ token: remoteUserToken, uri: 'user1_channel@' + servers[0].host })
+      await servers[1].subscriptionsCommand.remove({ token: remoteUserToken, uri: 'user2_channel@' + servers[0].host })
     } catch {}
 
     await waitJobs(servers)
@@ -66,8 +64,8 @@ describe('Test blocklist', function () {
 
     {
 
-      await addUserSubscription(servers[1].url, remoteUserToken, 'user1_channel@' + servers[0].host)
-      await addUserSubscription(servers[1].url, remoteUserToken, 'user2_channel@' + servers[0].host)
+      await servers[1].subscriptionsCommand.add({ token: remoteUserToken, targetUri: 'user1_channel@' + servers[0].host })
+      await servers[1].subscriptionsCommand.add({ token: remoteUserToken, targetUri: 'user2_channel@' + servers[0].host })
     }
 
     await waitJobs(servers)
diff --git a/server/tests/api/notifications/moderation-notifications.ts b/server/tests/api/notifications/moderation-notifications.ts
index e90640ad6..605b41947 100644
--- a/server/tests/api/notifications/moderation-notifications.ts
+++ b/server/tests/api/notifications/moderation-notifications.ts
@@ -3,7 +3,6 @@
 import 'mocha'
 import { buildUUID } from '@server/helpers/uuid'
 import {
-  addUserSubscription,
   addVideoCommentThread,
   addVideoToBlacklist,
   checkAbuseStateChange,
@@ -29,7 +28,6 @@ import {
   MockSmtpServer,
   prepareNotificationsTest,
   registerUser,
-  removeUserSubscription,
   removeVideoFromBlacklist,
   ServerInfo,
   uploadVideo,
@@ -488,8 +486,8 @@ describe('Test moderation notifications', function () {
       autoBlacklistTestsCustomConfig.transcoding.enabled = true
       await servers[0].configCommand.updateCustomConfig({ newCustomConfig: autoBlacklistTestsCustomConfig })
 
-      await addUserSubscription(servers[0].url, servers[0].accessToken, 'user_1_channel@localhost:' + servers[0].port)
-      await addUserSubscription(servers[1].url, servers[1].accessToken, 'user_1_channel@localhost:' + servers[0].port)
+      await servers[0].subscriptionsCommand.add({ targetUri: 'user_1_channel@localhost:' + servers[0].port })
+      await servers[1].subscriptionsCommand.add({ targetUri: 'user_1_channel@localhost:' + servers[0].port })
 
     })
 
@@ -611,8 +609,8 @@ describe('Test moderation notifications', function () {
     after(async () => {
       await servers[0].configCommand.updateCustomConfig({ newCustomConfig: currentCustomConfig })
 
-      await removeUserSubscription(servers[0].url, servers[0].accessToken, 'user_1_channel@localhost:' + servers[0].port)
-      await removeUserSubscription(servers[1].url, servers[1].accessToken, 'user_1_channel@localhost:' + servers[0].port)
+      await servers[0].subscriptionsCommand.remove({ uri: 'user_1_channel@localhost:' + servers[0].port })
+      await servers[1].subscriptionsCommand.remove({ uri: 'user_1_channel@localhost:' + servers[0].port })
     })
   })
 
diff --git a/server/tests/api/notifications/notifications-api.ts b/server/tests/api/notifications/notifications-api.ts
index 19f9dbbab..1ed98ae7a 100644
--- a/server/tests/api/notifications/notifications-api.ts
+++ b/server/tests/api/notifications/notifications-api.ts
@@ -2,21 +2,24 @@
 
 import 'mocha'
 import * as chai from 'chai'
-import { addUserSubscription } from '@shared/extra-utils/users/user-subscriptions'
-import { cleanupTests, getMyUserInformation, immutableAssign, uploadRandomVideo, waitJobs } from '../../../../shared/extra-utils'
-import { ServerInfo } from '../../../../shared/extra-utils/index'
-import { MockSmtpServer } from '../../../../shared/extra-utils/mock-servers/mock-email'
 import {
   CheckerBaseParams,
   checkNewVideoFromSubscription,
+  cleanupTests,
   getAllNotificationsSettings,
+  getMyUserInformation,
   getUserNotifications,
+  immutableAssign,
   markAsReadAllNotifications,
   markAsReadNotifications,
+  MockSmtpServer,
   prepareNotificationsTest,
-  updateMyNotificationSettings
-} from '../../../../shared/extra-utils/users/user-notifications'
-import { User, UserNotification, UserNotificationSettingValue } from '../../../../shared/models/users'
+  ServerInfo,
+  updateMyNotificationSettings,
+  uploadRandomVideo,
+  waitJobs
+} from '@shared/extra-utils'
+import { User, UserNotification, UserNotificationSettingValue } from '@shared/models'
 
 const expect = chai.expect
 
@@ -35,7 +38,7 @@ describe('Test notifications API', function () {
     userNotifications = res.userNotifications
     server = res.servers[0]
 
-    await addUserSubscription(server.url, userAccessToken, 'root_channel@localhost:' + server.port)
+    await server.subscriptionsCommand.add({ token: userAccessToken, targetUri: 'root_channel@localhost:' + server.port })
 
     for (let i = 0; i < 10; i++) {
       await uploadRandomVideo(server, false)
diff --git a/server/tests/api/notifications/user-notifications.ts b/server/tests/api/notifications/user-notifications.ts
index ace7e48c7..15be983f2 100644
--- a/server/tests/api/notifications/user-notifications.ts
+++ b/server/tests/api/notifications/user-notifications.ts
@@ -4,29 +4,25 @@ import 'mocha'
 import * as chai from 'chai'
 import { buildUUID } from '@server/helpers/uuid'
 import {
-  cleanupTests,
-  updateMyUser,
-  updateVideo,
-  updateVideoChannel,
-  uploadRandomVideoOnServers,
-  wait
-} from '../../../../shared/extra-utils'
-import { ServerInfo } from '../../../../shared/extra-utils/index'
-import { MockSmtpServer } from '../../../../shared/extra-utils/mock-servers/mock-email'
-import { waitJobs } from '../../../../shared/extra-utils/server/jobs'
-import {
   CheckerBaseParams,
   checkMyVideoImportIsFinished,
   checkNewActorFollow,
   checkNewVideoFromSubscription,
   checkVideoIsPublished,
+  cleanupTests,
   getLastNotification,
-  prepareNotificationsTest
-} from '../../../../shared/extra-utils/users/user-notifications'
-import { addUserSubscription, removeUserSubscription } from '../../../../shared/extra-utils/users/user-subscriptions'
-import { getBadVideoUrl, getGoodVideoUrl, importVideo } from '../../../../shared/extra-utils/videos/video-imports'
-import { UserNotification, UserNotificationType } from '../../../../shared/models/users'
-import { VideoPrivacy } from '../../../../shared/models/videos'
+  MockSmtpServer,
+  prepareNotificationsTest,
+  ServerInfo,
+  updateMyUser,
+  updateVideo,
+  updateVideoChannel,
+  uploadRandomVideoOnServers,
+  wait,
+  waitJobs
+} from '@shared/extra-utils'
+import { getBadVideoUrl, getGoodVideoUrl, importVideo } from '@shared/extra-utils/videos/video-imports'
+import { UserNotification, UserNotificationType, VideoPrivacy } from '@shared/models'
 
 const expect = chai.expect
 
@@ -79,7 +75,7 @@ describe('Test user notifications', function () {
     it('Should send a new video notification if the user follows the local video publisher', async function () {
       this.timeout(15000)
 
-      await addUserSubscription(servers[0].url, userAccessToken, 'root_channel@localhost:' + servers[0].port)
+      await servers[0].subscriptionsCommand.add({ token: userAccessToken, targetUri: 'root_channel@localhost:' + servers[0].port })
       await waitJobs(servers)
 
       const { name, uuid } = await uploadRandomVideoOnServers(servers, 1)
@@ -89,7 +85,7 @@ describe('Test user notifications', function () {
     it('Should send a new video notification from a remote account', async function () {
       this.timeout(150000) // Server 2 has transcoding enabled
 
-      await addUserSubscription(servers[0].url, userAccessToken, 'root_channel@localhost:' + servers[1].port)
+      await servers[0].subscriptionsCommand.add({ token: userAccessToken, targetUri: 'root_channel@localhost:' + servers[1].port })
       await waitJobs(servers)
 
       const { name, uuid } = await uploadRandomVideoOnServers(servers, 2)
@@ -418,23 +414,23 @@ describe('Test user notifications', function () {
     it('Should notify when a local channel is following one of our channel', async function () {
       this.timeout(50000)
 
-      await addUserSubscription(servers[0].url, servers[0].accessToken, 'user_1_channel@localhost:' + servers[0].port)
+      await servers[0].subscriptionsCommand.add({ targetUri: 'user_1_channel@localhost:' + servers[0].port })
       await waitJobs(servers)
 
       await checkNewActorFollow(baseParams, 'channel', 'root', 'super root name', myChannelName, 'presence')
 
-      await removeUserSubscription(servers[0].url, servers[0].accessToken, 'user_1_channel@localhost:' + servers[0].port)
+      await servers[0].subscriptionsCommand.remove({ uri: 'user_1_channel@localhost:' + servers[0].port })
     })
 
     it('Should notify when a remote channel is following one of our channel', async function () {
       this.timeout(50000)
 
-      await addUserSubscription(servers[1].url, servers[1].accessToken, 'user_1_channel@localhost:' + servers[0].port)
+      await servers[1].subscriptionsCommand.add({ targetUri: 'user_1_channel@localhost:' + servers[0].port })
       await waitJobs(servers)
 
       await checkNewActorFollow(baseParams, 'channel', 'root', 'super root 2 name', myChannelName, 'presence')
 
-      await removeUserSubscription(servers[1].url, servers[1].accessToken, 'user_1_channel@localhost:' + servers[0].port)
+      await servers[1].subscriptionsCommand.remove({ uri: 'user_1_channel@localhost:' + servers[0].port })
     })
 
     // PeerTube does not support accout -> account follows
diff --git a/server/tests/api/users/user-subscriptions.ts b/server/tests/api/users/user-subscriptions.ts
index 7e365d797..c119622ad 100644
--- a/server/tests/api/users/user-subscriptions.ts
+++ b/server/tests/api/users/user-subscriptions.ts
@@ -3,25 +3,19 @@
 import 'mocha'
 import * as chai from 'chai'
 import {
-  addUserSubscription,
-  areSubscriptionsExist,
   cleanupTests,
   createUser,
   doubleFollow,
   flushAndRunMultipleServers,
-  getUserSubscription,
   getVideosList,
-  listUserSubscriptions,
-  listUserSubscriptionVideos,
-  removeUserSubscription,
   ServerInfo,
   setAccessTokensToServers,
+  SubscriptionsCommand,
   updateVideo,
   uploadVideo,
   userLogin,
   waitJobs
 } from '@shared/extra-utils'
-import { Video, VideoChannel } from '@shared/models'
 
 const expect = chai.expect
 
@@ -30,6 +24,8 @@ describe('Test users subscriptions', function () {
   const users: { accessToken: string }[] = []
   let video3UUID: string
 
+  let command: SubscriptionsCommand
+
   before(async function () {
     this.timeout(120000)
 
@@ -58,6 +54,8 @@ describe('Test users subscriptions', function () {
     }
 
     await waitJobs(servers)
+
+    command = servers[0].subscriptionsCommand
   })
 
   it('Should display videos of server 2 on server 1', async function () {
@@ -69,8 +67,8 @@ describe('Test users subscriptions', function () {
   it('User of server 1 should follow user of server 3 and root of server 1', async function () {
     this.timeout(60000)
 
-    await addUserSubscription(servers[0].url, users[0].accessToken, 'user3_channel@localhost:' + servers[2].port)
-    await addUserSubscription(servers[0].url, users[0].accessToken, 'root_channel@localhost:' + servers[0].port)
+    await command.add({ token: users[0].accessToken, targetUri: 'user3_channel@localhost:' + servers[2].port })
+    await command.add({ token: users[0].accessToken, targetUri: 'root_channel@localhost:' + servers[0].port })
 
     await waitJobs(servers)
 
@@ -93,17 +91,17 @@ describe('Test users subscriptions', function () {
 
   it('Should list subscriptions', async function () {
     {
-      const res = await listUserSubscriptions({ url: servers[0].url, token: servers[0].accessToken })
-      expect(res.body.total).to.equal(0)
-      expect(res.body.data).to.be.an('array')
-      expect(res.body.data).to.have.lengthOf(0)
+      const body = await command.list()
+      expect(body.total).to.equal(0)
+      expect(body.data).to.be.an('array')
+      expect(body.data).to.have.lengthOf(0)
     }
 
     {
-      const res = await listUserSubscriptions({ url: servers[0].url, token: users[0].accessToken, sort: 'createdAt' })
-      expect(res.body.total).to.equal(2)
+      const body = await command.list({ token: users[0].accessToken, sort: 'createdAt' })
+      expect(body.total).to.equal(2)
 
-      const subscriptions: VideoChannel[] = res.body.data
+      const subscriptions = body.data
       expect(subscriptions).to.be.an('array')
       expect(subscriptions).to.have.lengthOf(2)
 
@@ -114,8 +112,7 @@ describe('Test users subscriptions', function () {
 
   it('Should get subscription', async function () {
     {
-      const res = await getUserSubscription(servers[0].url, users[0].accessToken, 'user3_channel@localhost:' + servers[2].port)
-      const videoChannel: VideoChannel = res.body
+      const videoChannel = await command.get({ token: users[0].accessToken, uri: 'user3_channel@localhost:' + servers[2].port })
 
       expect(videoChannel.name).to.equal('user3_channel')
       expect(videoChannel.host).to.equal('localhost:' + servers[2].port)
@@ -125,8 +122,7 @@ describe('Test users subscriptions', function () {
     }
 
     {
-      const res = await getUserSubscription(servers[0].url, users[0].accessToken, 'root_channel@localhost:' + servers[0].port)
-      const videoChannel: VideoChannel = res.body
+      const videoChannel = await command.get({ token: users[0].accessToken, uri: 'root_channel@localhost:' + servers[0].port })
 
       expect(videoChannel.name).to.equal('root_channel')
       expect(videoChannel.host).to.equal('localhost:' + servers[0].port)
@@ -144,8 +140,7 @@ describe('Test users subscriptions', function () {
       'user3_channel@localhost:' + servers[0].port
     ]
 
-    const res = await areSubscriptionsExist(servers[0].url, users[0].accessToken, uris)
-    const body = res.body
+    const body = await command.exist({ token: users[0].accessToken, uris })
 
     expect(body['user3_channel@localhost:' + servers[2].port]).to.be.true
     expect(body['root2_channel@localhost:' + servers[0].port]).to.be.false
@@ -155,45 +150,31 @@ describe('Test users subscriptions', function () {
 
   it('Should search among subscriptions', async function () {
     {
-      const res = await listUserSubscriptions({
-        url: servers[0].url,
-        token: users[0].accessToken,
-        sort: '-createdAt',
-        search: 'user3_channel'
-      })
-      expect(res.body.total).to.equal(1)
-
-      const subscriptions = res.body.data
-      expect(subscriptions).to.have.lengthOf(1)
+      const body = await command.list({ token: users[0].accessToken, sort: '-createdAt', search: 'user3_channel' })
+      expect(body.total).to.equal(1)
+      expect(body.data).to.have.lengthOf(1)
     }
 
     {
-      const res = await listUserSubscriptions({
-        url: servers[0].url,
-        token: users[0].accessToken,
-        sort: '-createdAt',
-        search: 'toto'
-      })
-      expect(res.body.total).to.equal(0)
-
-      const subscriptions = res.body.data
-      expect(subscriptions).to.have.lengthOf(0)
+      const body = await command.list({ token: users[0].accessToken, sort: '-createdAt', search: 'toto' })
+      expect(body.total).to.equal(0)
+      expect(body.data).to.have.lengthOf(0)
     }
   })
 
   it('Should list subscription videos', async function () {
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, servers[0].accessToken)
-      expect(res.body.total).to.equal(0)
-      expect(res.body.data).to.be.an('array')
-      expect(res.body.data).to.have.lengthOf(0)
+      const body = await command.listVideos()
+      expect(body.total).to.equal(0)
+      expect(body.data).to.be.an('array')
+      expect(body.data).to.have.lengthOf(0)
     }
 
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-      expect(res.body.total).to.equal(3)
+      const body = await command.listVideos({ token: users[0].accessToken, sort: 'createdAt' })
+      expect(body.total).to.equal(3)
 
-      const videos: Video[] = res.body.data
+      const videos = body.data
       expect(videos).to.be.an('array')
       expect(videos).to.have.lengthOf(3)
 
@@ -212,17 +193,17 @@ describe('Test users subscriptions', function () {
     await waitJobs(servers)
 
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, servers[0].accessToken)
-      expect(res.body.total).to.equal(0)
-      expect(res.body.data).to.be.an('array')
-      expect(res.body.data).to.have.lengthOf(0)
+      const body = await command.listVideos()
+      expect(body.total).to.equal(0)
+      expect(body.data).to.be.an('array')
+      expect(body.data).to.have.lengthOf(0)
     }
 
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-      expect(res.body.total).to.equal(4)
+      const body = await command.listVideos({ token: users[0].accessToken, sort: 'createdAt' })
+      expect(body.total).to.equal(4)
 
-      const videos: Video[] = res.body.data
+      const videos = body.data
       expect(videos).to.be.an('array')
       expect(videos).to.have.lengthOf(4)
 
@@ -281,17 +262,17 @@ describe('Test users subscriptions', function () {
 
   it('Should still list subscription videos', async function () {
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, servers[0].accessToken)
-      expect(res.body.total).to.equal(0)
-      expect(res.body.data).to.be.an('array')
-      expect(res.body.data).to.have.lengthOf(0)
+      const body = await command.listVideos()
+      expect(body.total).to.equal(0)
+      expect(body.data).to.be.an('array')
+      expect(body.data).to.have.lengthOf(0)
     }
 
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-      expect(res.body.total).to.equal(4)
+      const body = await command.listVideos({ token: users[0].accessToken, sort: 'createdAt' })
+      expect(body.total).to.equal(4)
 
-      const videos: Video[] = res.body.data
+      const videos = body.data
       expect(videos).to.be.an('array')
       expect(videos).to.have.lengthOf(4)
 
@@ -309,44 +290,41 @@ describe('Test users subscriptions', function () {
 
     await waitJobs(servers)
 
-    const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-    const videos: Video[] = res.body.data
-    expect(videos[2].name).to.equal('video server 3 added after follow updated')
+    const body = await command.listVideos({ token: users[0].accessToken, sort: 'createdAt' })
+    expect(body.data[2].name).to.equal('video server 3 added after follow updated')
   })
 
   it('Should remove user of server 3 subscription', async function () {
     this.timeout(30000)
 
-    await removeUserSubscription(servers[0].url, users[0].accessToken, 'user3_channel@localhost:' + servers[2].port)
+    await command.remove({ token: users[0].accessToken, uri: 'user3_channel@localhost:' + servers[2].port })
 
     await waitJobs(servers)
   })
 
   it('Should not display its videos anymore', async function () {
-    {
-      const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-      expect(res.body.total).to.equal(1)
+    const body = await command.listVideos({ token: users[0].accessToken, sort: 'createdAt' })
+    expect(body.total).to.equal(1)
 
-      const videos: Video[] = res.body.data
-      expect(videos).to.be.an('array')
-      expect(videos).to.have.lengthOf(1)
+    const videos = body.data
+    expect(videos).to.be.an('array')
+    expect(videos).to.have.lengthOf(1)
 
-      expect(videos[0].name).to.equal('video server 1 added after follow')
-    }
+    expect(videos[0].name).to.equal('video server 1 added after follow')
   })
 
   it('Should remove the root subscription and not display the videos anymore', async function () {
     this.timeout(30000)
 
-    await removeUserSubscription(servers[0].url, users[0].accessToken, 'root_channel@localhost:' + servers[0].port)
+    await command.remove({ token: users[0].accessToken, uri: 'root_channel@localhost:' + servers[0].port })
 
     await waitJobs(servers)
 
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-      expect(res.body.total).to.equal(0)
+      const body = await command.list({ token: users[0].accessToken, sort: 'createdAt' })
+      expect(body.total).to.equal(0)
 
-      const videos: Video[] = res.body.data
+      const videos = body.data
       expect(videos).to.be.an('array')
       expect(videos).to.have.lengthOf(0)
     }
@@ -366,15 +344,15 @@ describe('Test users subscriptions', function () {
   it('Should follow user of server 3 again', async function () {
     this.timeout(60000)
 
-    await addUserSubscription(servers[0].url, users[0].accessToken, 'user3_channel@localhost:' + servers[2].port)
+    await command.add({ token: users[0].accessToken, targetUri: 'user3_channel@localhost:' + servers[2].port })
 
     await waitJobs(servers)
 
     {
-      const res = await listUserSubscriptionVideos(servers[0].url, users[0].accessToken, 'createdAt')
-      expect(res.body.total).to.equal(3)
+      const body = await command.listVideos({ token: users[0].accessToken, sort: 'createdAt' })
+      expect(body.total).to.equal(3)
 
-      const videos: Video[] = res.body.data
+      const videos = body.data
       expect(videos).to.be.an('array')
       expect(videos).to.have.lengthOf(3)