server/tests/plugins/action-hooks.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import { ServerHookName, VideoPlaylistPrivacy, VideoPrivacy } from '@shared/models'
   5 import {
   6   cleanupTests,
   7   createMultipleServers,
   8   killallServers,
   9   PeerTubeServer,
  10   PluginsCommand,
  11   setAccessTokensToServers,
  12   setDefaultVideoChannel
  13 } from '@shared/server-commands'
  14
  15 describe('Test plugin action hooks', function () {
  16   let servers: PeerTubeServer[]
  17   let videoUUID: string
  18   let threadId: number
  19
  20   function checkHook (hook: ServerHookName, strictCount = true) {
  21     return servers[0].servers.waitUntilLog('Run hook ' + hook, 1, strictCount)
  22   }
  23
  24   before(async function () {
  25     this.timeout(30000)
  26
  27     servers = await createMultipleServers(2)
  28     await setAccessTokensToServers(servers)
  29     await setDefaultVideoChannel(servers)
  30
  31     await servers[0].plugins.install({ path: PluginsCommand.getPluginTestPath() })
  32
  33     await killallServers([ servers[0] ])
  34
  35     await servers[0].run({
  36       live: {
  37         enabled: true
  38       }
  39     })
  40   })
  41
  42   describe('Application hooks', function () {
  43     it('Should run action:application.listening', async function () {
  44       await checkHook('action:application.listening')
  45     })
  46   })
  47
  48   describe('Videos hooks', function () {
  49
  50     it('Should run action:api.video.uploaded', async function () {
  51       const { uuid } = await servers[0].videos.upload({ attributes: { name: 'video' } })
  52       videoUUID = uuid
  53
  54       await checkHook('action:api.video.uploaded')
  55     })
  56
  57     it('Should run action:api.video.updated', async function () {
  58       await servers[0].videos.update({ id: videoUUID, attributes: { name: 'video updated' } })
  59
  60       await checkHook('action:api.video.updated')
  61     })
  62
  63     it('Should run action:api.video.viewed', async function () {
  64       await servers[0].views.simulateView({ id: videoUUID })
  65
  66       await checkHook('action:api.video.viewed')
  67     })
  68
  69     it('Should run action:api.video.deleted', async function () {
  70       await servers[0].videos.remove({ id: videoUUID })
  71
  72       await checkHook('action:api.video.deleted')
  73     })
  74
  75     after(async function () {
  76       const { uuid } = await servers[0].videos.quickUpload({ name: 'video' })
  77       videoUUID = uuid
  78     })
  79   })
  80
  81   describe('Video channel hooks', function () {
  82     const channelName = 'my_super_channel'
  83
  84     it('Should run action:api.video-channel.created', async function () {
  85       await servers[0].channels.create({ attributes: { name: channelName } })
  86
  87       await checkHook('action:api.video-channel.created')
  88     })
  89
  90     it('Should run action:api.video-channel.updated', async function () {
  91       await servers[0].channels.update({ channelName, attributes: { displayName: 'my display name' } })
  92
  93       await checkHook('action:api.video-channel.updated')
  94     })
  95
  96     it('Should run action:api.video-channel.deleted', async function () {
  97       await servers[0].channels.delete({ channelName })
  98
  99       await checkHook('action:api.video-channel.deleted')
 100     })
 101   })
 102
 103   describe('Live hooks', function () {
 104
 105     it('Should run action:api.live-video.created', async function () {
 106       const attributes = {
 107         name: 'live',
 108         privacy: VideoPrivacy.PUBLIC,
 109         channelId: servers[0].store.channel.id
 110       }
 111
 112       await servers[0].live.create({ fields: attributes })
 113
 114       await checkHook('action:api.live-video.created')
 115     })
 116   })
 117
 118   describe('Comments hooks', function () {
 119     it('Should run action:api.video-thread.created', async function () {
 120       const created = await servers[0].comments.createThread({ videoId: videoUUID, text: 'thread' })
 121       threadId = created.id
 122
 123       await checkHook('action:api.video-thread.created')
 124     })
 125
 126     it('Should run action:api.video-comment-reply.created', async function () {
 127       await servers[0].comments.addReply({ videoId: videoUUID, toCommentId: threadId, text: 'reply' })
 128
 129       await checkHook('action:api.video-comment-reply.created')
 130     })
 131
 132     it('Should run action:api.video-comment.deleted', async function () {
 133       await servers[0].comments.delete({ videoId: videoUUID, commentId: threadId })
 134
 135       await checkHook('action:api.video-comment.deleted')
 136     })
 137   })
 138
 139   describe('Captions hooks', function () {
 140     it('Should run action:api.video-caption.created', async function () {
 141       await servers[0].captions.add({ videoId: videoUUID, language: 'en', fixture: 'subtitle-good.srt' })
 142
 143       await checkHook('action:api.video-caption.created')
 144     })
 145
 146     it('Should run action:api.video-caption.deleted', async function () {
 147       await servers[0].captions.delete({ videoId: videoUUID, language: 'en' })
 148
 149       await checkHook('action:api.video-caption.deleted')
 150     })
 151   })
 152
 153   describe('Users hooks', function () {
 154     let userId: number
 155
 156     it('Should run action:api.user.registered', async function () {
 157       await servers[0].users.register({ username: 'registered_user' })
 158
 159       await checkHook('action:api.user.registered')
 160     })
 161
 162     it('Should run action:api.user.created', async function () {
 163       const user = await servers[0].users.create({ username: 'created_user' })
 164       userId = user.id
 165
 166       await checkHook('action:api.user.created')
 167     })
 168
 169     it('Should run action:api.user.oauth2-got-token', async function () {
 170       await servers[0].login.login({ user: { username: 'created_user' } })
 171
 172       await checkHook('action:api.user.oauth2-got-token')
 173     })
 174
 175     it('Should run action:api.user.blocked', async function () {
 176       await servers[0].users.banUser({ userId })
 177
 178       await checkHook('action:api.user.blocked')
 179     })
 180
 181     it('Should run action:api.user.unblocked', async function () {
 182       await servers[0].users.unbanUser({ userId })
 183
 184       await checkHook('action:api.user.unblocked')
 185     })
 186
 187     it('Should run action:api.user.updated', async function () {
 188       await servers[0].users.update({ userId, videoQuota: 50 })
 189
 190       await checkHook('action:api.user.updated')
 191     })
 192
 193     it('Should run action:api.user.deleted', async function () {
 194       await servers[0].users.remove({ userId })
 195
 196       await checkHook('action:api.user.deleted')
 197     })
 198   })
 199
 200   describe('Playlist hooks', function () {
 201     let playlistId: number
 202     let videoId: number
 203
 204     before(async function () {
 205       {
 206         const { id } = await servers[0].playlists.create({
 207           attributes: {
 208             displayName: 'My playlist',
 209             privacy: VideoPlaylistPrivacy.PRIVATE
 210           }
 211         })
 212         playlistId = id
 213       }
 214
 215       {
 216         const { id } = await servers[0].videos.upload({ attributes: { name: 'my super name' } })
 217         videoId = id
 218       }
 219     })
 220
 221     it('Should run action:api.video-playlist-element.created', async function () {
 222       await servers[0].playlists.addElement({ playlistId, attributes: { videoId } })
 223
 224       await checkHook('action:api.video-playlist-element.created')
 225     })
 226   })
 227
 228   describe('Notification hook', function () {
 229
 230     it('Should run action:notifier.notification.created', async function () {
 231       await checkHook('action:notifier.notification.created', false)
 232     })
 233   })
 234
 235   after(async function () {
 236     await cleanupTests(servers)
 237   })
 238 })