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/server-commands'
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 async function check (search: VideosSearchQuery, exists = true) {
114 const body = await command.advancedVideoSearch({ search })
116 if (exists === false) {
117 expect(body.total).to.equal(0)
118 expect(body.data).to.have.lengthOf(0)
122 expect(body.total).to.equal(1)
123 expect(body.data).to.have.lengthOf(1)
125 const video = body.data[0]
127 expect(video.name).to.equal('What is PeerTube?')
128 expect(video.category.label).to.equal('Science & Technology')
129 expect(video.licence.label).to.equal('Attribution - Share Alike')
130 expect(video.privacy.label).to.equal('Public')
131 expect(video.duration).to.equal(113)
132 expect(video.thumbnailUrl.startsWith('https://framatube.org/static/thumbnails')).to.be.true
134 expect(video.account.host).to.equal('framatube.org')
135 expect(video.account.name).to.equal('framasoft')
136 expect(video.account.url).to.equal('https://framatube.org/accounts/framasoft')
137 expect(video.account.avatar).to.exist
139 expect(video.channel.host).to.equal('framatube.org')
140 expect(video.channel.name).to.equal('joinpeertube')
141 expect(video.channel.url).to.equal('https://framatube.org/video-channels/joinpeertube')
142 expect(video.channel.avatar).to.exist
145 const baseSearch: VideosSearchQuery = {
146 search: 'what is peertube',
149 categoryOneOf: [ 15 ],
151 tagsAllOf: [ 'framasoft', 'peertube' ],
152 startDate: '2018-10-01T10:50:46.396Z',
153 endDate: '2018-10-01T10:55:46.396Z'
156 it('Should make a simple search and not have results', async function () {
157 const body = await command.searchVideos({ search: 'djidane'.repeat(50) })
159 expect(body.total).to.equal(0)
160 expect(body.data).to.have.lengthOf(0)
163 it('Should make a simple search and have results', async function () {
164 const body = await command.searchVideos({ search: 'What is PeerTube' })
166 expect(body.total).to.be.greaterThan(1)
169 it('Should make a simple search', async function () {
170 await check(baseSearch)
173 it('Should search by start date', async function () {
174 const search = { ...baseSearch, startDate: '2018-10-01T10:54:46.396Z' }
175 await check(search, false)
178 it('Should search by tags', async function () {
179 const search = { ...baseSearch, tagsAllOf: [ 'toto', 'framasoft' ] }
180 await check(search, false)
183 it('Should search by duration', async function () {
184 const search = { ...baseSearch, durationMin: 2000 }
185 await check(search, false)
188 it('Should search by nsfw attribute', async function () {
190 const search = { ...baseSearch, nsfw: 'true' as BooleanBothQuery }
191 await check(search, false)
195 const search = { ...baseSearch, nsfw: 'false' as BooleanBothQuery }
196 await check(search, true)
200 const search = { ...baseSearch, nsfw: 'both' as BooleanBothQuery }
201 await check(search, true)
205 it('Should search by host', async function () {
207 const search = { ...baseSearch, host: 'example.com' }
208 await check(search, false)
212 const search = { ...baseSearch, host: 'framatube.org' }
213 await check(search, true)
217 it('Should search by uuids', async function () {
218 const goodUUID = '9c9de5e8-0a1e-484a-b099-e80766180a6d'
219 const goodShortUUID = 'kkGMgK9ZtnKfYAgnEtQxbv'
220 const badUUID = 'c29c5b77-4a04-493d-96a9-2e9267e308f0'
221 const badShortUUID = 'rP5RgUeX9XwTSrspCdkDej'
224 const uuidsMatrix = [
226 [ goodUUID, badShortUUID ],
227 [ badShortUUID, goodShortUUID ],
228 [ goodUUID, goodShortUUID ]
231 for (const uuids of uuidsMatrix) {
232 const search = { ...baseSearch, uuids }
233 await check(search, true)
238 const uuidsMatrix = [
243 for (const uuids of uuidsMatrix) {
244 const search = { ...baseSearch, uuids }
245 await check(search, false)
250 it('Should have a correct pagination', async function () {
257 const body = await command.advancedVideoSearch({ search })
259 expect(body.total).to.be.greaterThan(5)
260 expect(body.data).to.have.lengthOf(5)
263 it('Should use the nsfw instance policy as default', async function () {
267 await server.config.updateCustomSubConfig({
269 instance: { defaultNSFWPolicy: 'display' }
273 const body = await command.searchVideos({ search: 'NSFW search index', sort: '-match' })
274 expect(body.data).to.have.length.greaterThan(0)
276 const video = body.data[0]
277 expect(video.nsfw).to.be.true
279 nsfwUUID = video.uuid
283 await server.config.updateCustomSubConfig({
285 instance: { defaultNSFWPolicy: 'do_not_list' }
289 const body = await command.searchVideos({ search: 'NSFW search index', sort: '-match' })
292 expect(body.data).to.have.lengthOf(0)
294 const video = body.data[0]
296 expect(video.uuid).not.equal(nsfwUUID)
302 describe('Channels search', async function () {
304 async function check (search: VideoChannelsSearchQuery, exists = true) {
305 const body = await command.advancedChannelSearch({ search })
307 if (exists === false) {
308 expect(body.total).to.equal(0)
309 expect(body.data).to.have.lengthOf(0)
313 expect(body.total).to.be.greaterThan(0)
314 expect(body.data).to.have.length.greaterThan(0)
316 const videoChannel = body.data[0]
317 expect(videoChannel.url).to.equal('https://framatube.org/video-channels/bf54d359-cfad-4935-9d45-9d6be93f63e8')
318 expect(videoChannel.host).to.equal('framatube.org')
319 expect(videoChannel.avatar).to.exist
320 expect(videoChannel.displayName).to.exist
322 expect(videoChannel.ownerAccount.url).to.equal('https://framatube.org/accounts/framasoft')
323 expect(videoChannel.ownerAccount.name).to.equal('framasoft')
324 expect(videoChannel.ownerAccount.host).to.equal('framatube.org')
325 expect(videoChannel.ownerAccount.avatar).to.exist
328 it('Should make a simple search and not have results', async function () {
329 const body = await command.searchChannels({ search: 'a'.repeat(500) })
331 expect(body.total).to.equal(0)
332 expect(body.data).to.have.lengthOf(0)
335 it('Should make a search and have results', async function () {
336 await check({ search: 'Framasoft', sort: 'createdAt' }, true)
339 it('Should make host search and have appropriate results', async function () {
340 await check({ search: 'Framasoft', host: 'example.com' }, false)
341 await check({ search: 'Framasoft', host: 'framatube.org' }, true)
344 it('Should make handles search and have appropriate results', async function () {
345 await check({ handles: [ 'bf54d359-cfad-4935-9d45-9d6be93f63e8@framatube.org' ] }, true)
346 await check({ handles: [ 'jeanine', 'bf54d359-cfad-4935-9d45-9d6be93f63e8@framatube.org' ] }, true)
347 await check({ handles: [ 'jeanine', 'chocobozzz_channel2@peertube2.cpy.re' ] }, false)
350 it('Should have a correct pagination', async function () {
351 const body = await command.advancedChannelSearch({ search: { search: 'root', start: 0, count: 2 } })
353 expect(body.total).to.be.greaterThan(2)
354 expect(body.data).to.have.lengthOf(2)
358 describe('Playlists search', async function () {
360 async function check (search: VideoPlaylistsSearchQuery, exists = true) {
361 const body = await command.advancedPlaylistSearch({ search })
363 if (exists === false) {
364 expect(body.total).to.equal(0)
365 expect(body.data).to.have.lengthOf(0)
369 expect(body.total).to.be.greaterThan(0)
370 expect(body.data).to.have.length.greaterThan(0)
372 const videoPlaylist = body.data[0]
374 expect(videoPlaylist.url).to.equal('https://peertube2.cpy.re/videos/watch/playlist/73804a40-da9a-40c2-b1eb-2c6d9eec8f0a')
375 expect(videoPlaylist.thumbnailUrl).to.exist
376 expect(videoPlaylist.embedUrl).to.equal('https://peertube2.cpy.re/video-playlists/embed/73804a40-da9a-40c2-b1eb-2c6d9eec8f0a')
378 expect(videoPlaylist.type.id).to.equal(VideoPlaylistType.REGULAR)
379 expect(videoPlaylist.privacy.id).to.equal(VideoPlaylistPrivacy.PUBLIC)
380 expect(videoPlaylist.videosLength).to.exist
382 expect(videoPlaylist.createdAt).to.exist
383 expect(videoPlaylist.updatedAt).to.exist
385 expect(videoPlaylist.uuid).to.equal('73804a40-da9a-40c2-b1eb-2c6d9eec8f0a')
386 expect(videoPlaylist.displayName).to.exist
388 expect(videoPlaylist.ownerAccount.url).to.equal('https://peertube2.cpy.re/accounts/chocobozzz')
389 expect(videoPlaylist.ownerAccount.name).to.equal('chocobozzz')
390 expect(videoPlaylist.ownerAccount.host).to.equal('peertube2.cpy.re')
391 expect(videoPlaylist.ownerAccount.avatar).to.exist
393 expect(videoPlaylist.videoChannel.url).to.equal('https://peertube2.cpy.re/video-channels/chocobozzz_channel')
394 expect(videoPlaylist.videoChannel.name).to.equal('chocobozzz_channel')
395 expect(videoPlaylist.videoChannel.host).to.equal('peertube2.cpy.re')
396 expect(videoPlaylist.videoChannel.avatar).to.exist
399 it('Should make a simple search and not have results', async function () {
400 const body = await command.searchPlaylists({ search: 'a'.repeat(500) })
402 expect(body.total).to.equal(0)
403 expect(body.data).to.have.lengthOf(0)
406 it('Should make a search and have results', async function () {
407 await check({ search: 'E2E playlist', sort: '-match' }, true)
410 it('Should make host search and have appropriate results', async function () {
411 await check({ search: 'E2E playlist', host: 'example.com' }, false)
412 await check({ search: 'E2E playlist', host: 'peertube2.cpy.re', sort: '-match' }, true)
415 it('Should make a search by uuids and have appropriate results', async function () {
416 const goodUUID = '73804a40-da9a-40c2-b1eb-2c6d9eec8f0a'
417 const goodShortUUID = 'fgei1ws1oa6FCaJ2qZPG29'
418 const badUUID = 'c29c5b77-4a04-493d-96a9-2e9267e308f0'
419 const badShortUUID = 'rP5RgUeX9XwTSrspCdkDej'
422 const uuidsMatrix = [
424 [ goodUUID, badShortUUID ],
425 [ badShortUUID, goodShortUUID ],
426 [ goodUUID, goodShortUUID ]
429 for (const uuids of uuidsMatrix) {
430 const search = { search: 'E2E playlist', sort: '-match', uuids }
431 await check(search, true)
436 const uuidsMatrix = [
441 for (const uuids of uuidsMatrix) {
442 const search = { search: 'E2E playlist', sort: '-match', uuids }
443 await check(search, false)
448 it('Should have a correct pagination', async function () {
449 const body = await command.advancedChannelSearch({ search: { search: 'root', start: 0, count: 2 } })
451 expect(body.total).to.be.greaterThan(2)
452 expect(body.data).to.have.lengthOf(2)
456 after(async function () {
457 await cleanupTests([ server ])