1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
4 import * as chai from 'chai'
5 import { cleanupTests, createSingleServer, PeerTubeServer, SearchCommand, setAccessTokensToServers } from '@shared/extra-utils'
8 VideoChannelsSearchQuery,
10 VideoPlaylistsSearchQuery,
13 } from '@shared/models'
15 const expect = chai.expect
17 describe('Test videos search', function () {
18 const localVideoName = 'local video' + new Date().toISOString()
20 let server: PeerTubeServer = null
21 let command: SearchCommand
23 before(async function () {
26 server = await createSingleServer(1)
28 await setAccessTokensToServers([ server ])
30 await server.videos.upload({ attributes: { name: localVideoName } })
32 command = server.search
35 describe('Default search', async function () {
37 it('Should make a local videos search by default', async function () {
40 await server.config.updateCustomSubConfig({
45 isDefaultSearch: false,
46 disableLocalSearch: false
52 const body = await command.searchVideos({ search: 'local video' })
54 expect(body.total).to.equal(1)
55 expect(body.data[0].name).to.equal(localVideoName)
58 it('Should make a local channels search by default', async function () {
59 const body = await command.searchChannels({ search: 'root' })
61 expect(body.total).to.equal(1)
62 expect(body.data[0].name).to.equal('root_channel')
63 expect(body.data[0].host).to.equal('localhost:' + server.port)
66 it('Should make an index videos search by default', async function () {
67 await server.config.updateCustomSubConfig({
72 isDefaultSearch: true,
73 disableLocalSearch: false
79 const body = await command.searchVideos({ search: 'local video' })
80 expect(body.total).to.be.greaterThan(2)
83 it('Should make an index channels search by default', async function () {
84 const body = await command.searchChannels({ search: 'root' })
85 expect(body.total).to.be.greaterThan(2)
88 it('Should make an index videos search if local search is disabled', async function () {
89 await server.config.updateCustomSubConfig({
94 isDefaultSearch: false,
95 disableLocalSearch: true
101 const body = await command.searchVideos({ search: 'local video' })
102 expect(body.total).to.be.greaterThan(2)
105 it('Should make an index channels search if local search is disabled', async function () {
106 const body = await command.searchChannels({ search: 'root' })
107 expect(body.total).to.be.greaterThan(2)
111 describe('Videos search', async function () {
113 it('Should make a simple search and not have results', async function () {
114 const body = await command.searchVideos({ search: 'djidane'.repeat(50) })
116 expect(body.total).to.equal(0)
117 expect(body.data).to.have.lengthOf(0)
120 it('Should make a simple search and have results', async function () {
121 const body = await command.searchVideos({ search: 'What is PeerTube' })
123 expect(body.total).to.be.greaterThan(1)
126 it('Should make a complex search', async function () {
128 async function check (search: VideosSearchQuery, exists = true) {
129 const body = await command.advancedVideoSearch({ search })
131 if (exists === false) {
132 expect(body.total).to.equal(0)
133 expect(body.data).to.have.lengthOf(0)
137 expect(body.total).to.equal(1)
138 expect(body.data).to.have.lengthOf(1)
140 const video = body.data[0]
142 expect(video.name).to.equal('What is PeerTube?')
143 expect(video.category.label).to.equal('Science & Technology')
144 expect(video.licence.label).to.equal('Attribution - Share Alike')
145 expect(video.privacy.label).to.equal('Public')
146 expect(video.duration).to.equal(113)
147 expect(video.thumbnailUrl.startsWith('https://framatube.org/static/thumbnails')).to.be.true
149 expect(video.account.host).to.equal('framatube.org')
150 expect(video.account.name).to.equal('framasoft')
151 expect(video.account.url).to.equal('https://framatube.org/accounts/framasoft')
152 expect(video.account.avatar).to.exist
154 expect(video.channel.host).to.equal('framatube.org')
155 expect(video.channel.name).to.equal('bf54d359-cfad-4935-9d45-9d6be93f63e8')
156 expect(video.channel.url).to.equal('https://framatube.org/video-channels/bf54d359-cfad-4935-9d45-9d6be93f63e8')
157 expect(video.channel.avatar).to.exist
160 const baseSearch: VideosSearchQuery = {
161 search: 'what is peertube',
164 categoryOneOf: [ 15 ],
166 tagsAllOf: [ 'framasoft', 'peertube' ],
167 startDate: '2018-10-01T10:50:46.396Z',
168 endDate: '2018-10-01T10:55:46.396Z'
172 await check(baseSearch)
176 const search = { ...baseSearch, startDate: '2018-10-01T10:54:46.396Z' }
177 await check(search, false)
181 const search = { ...baseSearch, tagsAllOf: [ 'toto', 'framasoft' ] }
182 await check(search, false)
186 const search = { ...baseSearch, durationMin: 2000 }
187 await check(search, false)
191 const search = { ...baseSearch, nsfw: 'true' as BooleanBothQuery }
192 await check(search, false)
196 const search = { ...baseSearch, nsfw: 'false' as BooleanBothQuery }
197 await check(search, true)
201 const search = { ...baseSearch, nsfw: 'both' as BooleanBothQuery }
202 await check(search, true)
206 const search = { ...baseSearch, host: 'example.com' }
207 await check(search, false)
211 const search = { ...baseSearch, host: 'framatube.org' }
212 await check(search, true)
216 const goodUUID = '9c9de5e8-0a1e-484a-b099-e80766180a6d'
217 const goodShortUUID = 'kkGMgK9ZtnKfYAgnEtQxbv'
218 const badUUID = 'c29c5b77-4a04-493d-96a9-2e9267e308f0'
219 const badShortUUID = 'rP5RgUeX9XwTSrspCdkDej'
222 const uuidsMatrix = [
224 [ goodUUID, badShortUUID ],
225 [ badShortUUID, goodShortUUID ],
226 [ goodUUID, goodShortUUID ]
229 for (const uuids of uuidsMatrix) {
230 const search = { ...baseSearch, uuids }
231 await check(search, true)
236 const uuidsMatrix = [
241 for (const uuids of uuidsMatrix) {
242 const search = { ...baseSearch, uuids }
243 await check(search, false)
249 it('Should have a correct pagination', async function () {
256 const body = await command.advancedVideoSearch({ search })
258 expect(body.total).to.be.greaterThan(5)
259 expect(body.data).to.have.lengthOf(5)
262 it('Should use the nsfw instance policy as default', async function () {
266 await server.config.updateCustomSubConfig({
268 instance: { defaultNSFWPolicy: 'display' }
272 const body = await command.searchVideos({ search: 'NSFW search index', sort: '-match' })
273 expect(body.data).to.have.length.greaterThan(0)
275 const video = body.data[0]
276 expect(video.nsfw).to.be.true
278 nsfwUUID = video.uuid
282 await server.config.updateCustomSubConfig({
284 instance: { defaultNSFWPolicy: 'do_not_list' }
288 const body = await command.searchVideos({ search: 'NSFW search index', sort: '-match' })
291 expect(body.data).to.have.lengthOf(0)
293 const video = body.data[0]
295 expect(video.uuid).not.equal(nsfwUUID)
301 describe('Channels search', async function () {
303 it('Should make a simple search and not have results', async function () {
304 const body = await command.searchChannels({ search: 'a'.repeat(500) })
306 expect(body.total).to.equal(0)
307 expect(body.data).to.have.lengthOf(0)
310 it('Should make a search and have results', async function () {
312 async function check (search: VideoChannelsSearchQuery, exists = true) {
313 const body = await command.advancedChannelSearch({ search })
315 if (exists === false) {
316 expect(body.total).to.equal(0)
317 expect(body.data).to.have.lengthOf(0)
321 expect(body.total).to.be.greaterThan(0)
322 expect(body.data).to.have.length.greaterThan(0)
324 const videoChannel = body.data[0]
325 expect(videoChannel.url).to.equal('https://framatube.org/video-channels/bf54d359-cfad-4935-9d45-9d6be93f63e8')
326 expect(videoChannel.host).to.equal('framatube.org')
327 expect(videoChannel.avatar).to.exist
328 expect(videoChannel.displayName).to.exist
330 expect(videoChannel.ownerAccount.url).to.equal('https://framatube.org/accounts/framasoft')
331 expect(videoChannel.ownerAccount.name).to.equal('framasoft')
332 expect(videoChannel.ownerAccount.host).to.equal('framatube.org')
333 expect(videoChannel.ownerAccount.avatar).to.exist
336 await check({ search: 'Framasoft', sort: 'createdAt' }, true)
337 await check({ search: 'Framasoft', host: 'example.com' }, false)
338 await check({ search: 'Framasoft', host: 'framatube.org' }, true)
341 it('Should have a correct pagination', async function () {
342 const body = await command.advancedChannelSearch({ search: { search: 'root', start: 0, count: 2 } })
344 expect(body.total).to.be.greaterThan(2)
345 expect(body.data).to.have.lengthOf(2)
349 describe('Playlists search', async function () {
351 async function check (search: VideoPlaylistsSearchQuery, exists = true) {
352 const body = await command.advancedPlaylistSearch({ search })
354 if (exists === false) {
355 expect(body.total).to.equal(0)
356 expect(body.data).to.have.lengthOf(0)
360 expect(body.total).to.be.greaterThan(0)
361 expect(body.data).to.have.length.greaterThan(0)
363 const videoPlaylist = body.data[0]
365 expect(videoPlaylist.url).to.equal('https://peertube2.cpy.re/videos/watch/playlist/73804a40-da9a-40c2-b1eb-2c6d9eec8f0a')
366 expect(videoPlaylist.thumbnailUrl).to.exist
367 expect(videoPlaylist.embedUrl).to.equal('https://peertube2.cpy.re/video-playlists/embed/73804a40-da9a-40c2-b1eb-2c6d9eec8f0a')
369 expect(videoPlaylist.type.id).to.equal(VideoPlaylistType.REGULAR)
370 expect(videoPlaylist.privacy.id).to.equal(VideoPlaylistPrivacy.PUBLIC)
371 expect(videoPlaylist.videosLength).to.exist
373 expect(videoPlaylist.createdAt).to.exist
374 expect(videoPlaylist.updatedAt).to.exist
376 expect(videoPlaylist.uuid).to.equal('73804a40-da9a-40c2-b1eb-2c6d9eec8f0a')
377 expect(videoPlaylist.displayName).to.exist
379 expect(videoPlaylist.ownerAccount.url).to.equal('https://peertube2.cpy.re/accounts/chocobozzz')
380 expect(videoPlaylist.ownerAccount.name).to.equal('chocobozzz')
381 expect(videoPlaylist.ownerAccount.host).to.equal('peertube2.cpy.re')
382 expect(videoPlaylist.ownerAccount.avatar).to.exist
384 expect(videoPlaylist.videoChannel.url).to.equal('https://peertube2.cpy.re/video-channels/chocobozzz_channel')
385 expect(videoPlaylist.videoChannel.name).to.equal('chocobozzz_channel')
386 expect(videoPlaylist.videoChannel.host).to.equal('peertube2.cpy.re')
387 expect(videoPlaylist.videoChannel.avatar).to.exist
390 it('Should make a simple search and not have results', async function () {
391 const body = await command.searchPlaylists({ search: 'a'.repeat(500) })
393 expect(body.total).to.equal(0)
394 expect(body.data).to.have.lengthOf(0)
397 it('Should make a search and have results', async function () {
398 await check({ search: 'E2E playlist', sort: '-match' }, true)
401 it('Should make host search and have appropriate results', async function () {
402 await check({ search: 'E2E playlist', host: 'example.com' }, false)
403 await check({ search: 'E2E playlist', host: 'peertube2.cpy.re', sort: '-match' }, true)
406 it('Should make a search by uuids and have appropriate results', async function () {
407 const goodUUID = '73804a40-da9a-40c2-b1eb-2c6d9eec8f0a'
408 const goodShortUUID = 'fgei1ws1oa6FCaJ2qZPG29'
409 const badUUID = 'c29c5b77-4a04-493d-96a9-2e9267e308f0'
410 const badShortUUID = 'rP5RgUeX9XwTSrspCdkDej'
413 const uuidsMatrix = [
415 [ goodUUID, badShortUUID ],
416 [ badShortUUID, goodShortUUID ],
417 [ goodUUID, goodShortUUID ]
420 for (const uuids of uuidsMatrix) {
421 const search = { search: 'E2E playlist', sort: '-match', uuids }
422 await check(search, true)
427 const uuidsMatrix = [
432 for (const uuids of uuidsMatrix) {
433 const search = { search: 'E2E playlist', sort: '-match', uuids }
434 await check(search, false)
439 it('Should have a correct pagination', async function () {
440 const body = await command.advancedChannelSearch({ search: { search: 'root', start: 0, count: 2 } })
442 expect(body.total).to.be.greaterThan(2)
443 expect(body.data).to.have.lengthOf(2)
447 after(async function () {
448 await cleanupTests([ server ])