1 files changed, 568 insertions, 0 deletions

diff --git a/packages/tests/src/api/search/search-videos.ts b/packages/tests/src/api/search/search-videos.ts
new file mode 100644
index 000000000..0739f0886
--- /dev/null
+++ b/packages/tests/src/api/search/search-videos.ts
@@ -0,0 +1,568 @@
+/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
+
+import { expect } from 'chai'
+import { wait } from '@peertube/peertube-core-utils'
+import { VideoPrivacy } from '@peertube/peertube-models'
+import {
+  cleanupTests,
+  createSingleServer,
+  doubleFollow,
+  PeerTubeServer,
+  SearchCommand,
+  setAccessTokensToServers,
+  setDefaultAccountAvatar,
+  setDefaultChannelAvatar,
+  setDefaultVideoChannel,
+  stopFfmpeg
+} from '@peertube/peertube-server-commands'
+
+describe('Test videos search', function () {
+  let server: PeerTubeServer
+  let remoteServer: PeerTubeServer
+  let startDate: string
+  let videoUUID: string
+  let videoShortUUID: string
+
+  let command: SearchCommand
+
+  before(async function () {
+    this.timeout(360000)
+
+    const servers = await Promise.all([
+      createSingleServer(1),
+      createSingleServer(2)
+    ])
+    server = servers[0]
+    remoteServer = servers[1]
+
+    await setAccessTokensToServers([ server, remoteServer ])
+    await setDefaultVideoChannel([ server, remoteServer ])
+    await setDefaultChannelAvatar(server)
+    await setDefaultAccountAvatar(servers)
+
+    {
+      const attributes1 = {
+        name: '1111 2222 3333',
+        fixture: '60fps_720p_small.mp4', // 2 seconds
+        category: 1,
+        licence: 1,
+        nsfw: false,
+        language: 'fr'
+      }
+      await server.videos.upload({ attributes: attributes1 })
+
+      const attributes2 = { ...attributes1, name: attributes1.name + ' - 2', fixture: 'video_short.mp4' }
+      await server.videos.upload({ attributes: attributes2 })
+
+      {
+        const attributes3 = { ...attributes1, name: attributes1.name + ' - 3', language: undefined }
+        const { id, uuid, shortUUID } = await server.videos.upload({ attributes: attributes3 })
+        videoUUID = uuid
+        videoShortUUID = shortUUID
+
+        await server.captions.add({
+          language: 'en',
+          videoId: id,
+          fixture: 'subtitle-good2.vtt',
+          mimeType: 'application/octet-stream'
+        })
+
+        await server.captions.add({
+          language: 'aa',
+          videoId: id,
+          fixture: 'subtitle-good2.vtt',
+          mimeType: 'application/octet-stream'
+        })
+      }
+
+      const attributes4 = { ...attributes1, name: attributes1.name + ' - 4', language: 'pl', nsfw: true }
+      await server.videos.upload({ attributes: attributes4 })
+
+      await wait(1000)
+
+      startDate = new Date().toISOString()
+
+      const attributes5 = { ...attributes1, name: attributes1.name + ' - 5', licence: 2, language: undefined }
+      await server.videos.upload({ attributes: attributes5 })
+
+      const attributes6 = { ...attributes1, name: attributes1.name + ' - 6', tags: [ 't1', 't2' ] }
+      await server.videos.upload({ attributes: attributes6 })
+
+      const attributes7 = { ...attributes1, name: attributes1.name + ' - 7', originallyPublishedAt: '2019-02-12T09:58:08.286Z' }
+      await server.videos.upload({ attributes: attributes7 })
+
+      const attributes8 = { ...attributes1, name: attributes1.name + ' - 8', licence: 4 }
+      await server.videos.upload({ attributes: attributes8 })
+    }
+
+    {
+      const attributes = {
+        name: '3333 4444 5555',
+        fixture: 'video_short.mp4',
+        category: 2,
+        licence: 2,
+        language: 'en'
+      }
+      await server.videos.upload({ attributes })
+
+      await server.videos.upload({ attributes: { ...attributes, name: attributes.name + ' duplicate' } })
+    }
+
+    {
+      const attributes = {
+        name: '6666 7777 8888',
+        fixture: 'video_short.mp4',
+        category: 3,
+        licence: 3,
+        language: 'pl'
+      }
+      await server.videos.upload({ attributes })
+    }
+
+    {
+      const attributes1 = {
+        name: '9999',
+        tags: [ 'aaaa', 'bbbb', 'cccc' ],
+        category: 1
+      }
+      await server.videos.upload({ attributes: attributes1 })
+      await server.videos.upload({ attributes: { ...attributes1, category: 2 } })
+
+      await server.videos.upload({ attributes: { ...attributes1, tags: [ 'cccc', 'dddd' ] } })
+      await server.videos.upload({ attributes: { ...attributes1, tags: [ 'eeee', 'ffff' ] } })
+    }
+
+    {
+      const attributes1 = {
+        name: 'aaaa 2',
+        category: 1
+      }
+      await server.videos.upload({ attributes: attributes1 })
+      await server.videos.upload({ attributes: { ...attributes1, category: 2 } })
+    }
+
+    {
+      await remoteServer.videos.upload({ attributes: { name: 'remote video 1' } })
+      await remoteServer.videos.upload({ attributes: { name: 'remote video 2' } })
+    }
+
+    await doubleFollow(server, remoteServer)
+
+    command = server.search
+  })
+
+  it('Should make a simple search and not have results', async function () {
+    const body = await command.searchVideos({ search: 'abc' })
+
+    expect(body.total).to.equal(0)
+    expect(body.data).to.have.lengthOf(0)
+  })
+
+  it('Should make a simple search and have results', async function () {
+    const body = await command.searchVideos({ search: '4444 5555 duplicate' })
+
+    expect(body.total).to.equal(2)
+
+    const videos = body.data
+    expect(videos).to.have.lengthOf(2)
+
+    // bestmatch
+    expect(videos[0].name).to.equal('3333 4444 5555 duplicate')
+    expect(videos[1].name).to.equal('3333 4444 5555')
+  })
+
+  it('Should make a search on tags too, and have results', async function () {
+    const search = {
+      search: 'aaaa',
+      categoryOneOf: [ 1 ]
+    }
+    const body = await command.advancedVideoSearch({ search })
+
+    expect(body.total).to.equal(2)
+
+    const videos = body.data
+    expect(videos).to.have.lengthOf(2)
+
+    // bestmatch
+    expect(videos[0].name).to.equal('aaaa 2')
+    expect(videos[1].name).to.equal('9999')
+  })
+
+  it('Should filter on tags without a search', async function () {
+    const search = {
+      tagsAllOf: [ 'bbbb' ]
+    }
+    const body = await command.advancedVideoSearch({ search })
+
+    expect(body.total).to.equal(2)
+
+    const videos = body.data
+    expect(videos).to.have.lengthOf(2)
+
+    expect(videos[0].name).to.equal('9999')
+    expect(videos[1].name).to.equal('9999')
+  })
+
+  it('Should filter on category without a search', async function () {
+    const search = {
+      categoryOneOf: [ 3 ]
+    }
+    const body = await command.advancedVideoSearch({ search })
+
+    expect(body.total).to.equal(1)
+
+    const videos = body.data
+    expect(videos).to.have.lengthOf(1)
+
+    expect(videos[0].name).to.equal('6666 7777 8888')
+  })
+
+  it('Should search by tags (one of)', async function () {
+    const query = {
+      search: '9999',
+      categoryOneOf: [ 1 ],
+      tagsOneOf: [ 'aAaa', 'ffff' ]
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: query })
+      expect(body.total).to.equal(2)
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, tagsOneOf: [ 'blabla' ] } })
+      expect(body.total).to.equal(0)
+    }
+  })
+
+  it('Should search by tags (all of)', async function () {
+    const query = {
+      search: '9999',
+      categoryOneOf: [ 1 ],
+      tagsAllOf: [ 'CCcc' ]
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: query })
+      expect(body.total).to.equal(2)
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, tagsAllOf: [ 'blAbla' ] } })
+      expect(body.total).to.equal(0)
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, tagsAllOf: [ 'bbbb', 'CCCC' ] } })
+      expect(body.total).to.equal(1)
+    }
+  })
+
+  it('Should search by category', async function () {
+    const query = {
+      search: '6666',
+      categoryOneOf: [ 3 ]
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: query })
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('6666 7777 8888')
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, categoryOneOf: [ 2 ] } })
+      expect(body.total).to.equal(0)
+    }
+  })
+
+  it('Should search by licence', async function () {
+    const query = {
+      search: '4444 5555',
+      licenceOneOf: [ 2 ]
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: query })
+      expect(body.total).to.equal(2)
+      expect(body.data[0].name).to.equal('3333 4444 5555')
+      expect(body.data[1].name).to.equal('3333 4444 5555 duplicate')
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, licenceOneOf: [ 3 ] } })
+      expect(body.total).to.equal(0)
+    }
+  })
+
+  it('Should search by languages', async function () {
+    const query = {
+      search: '1111 2222 3333',
+      languageOneOf: [ 'pl', 'en' ]
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: query })
+      expect(body.total).to.equal(2)
+      expect(body.data[0].name).to.equal('1111 2222 3333 - 3')
+      expect(body.data[1].name).to.equal('1111 2222 3333 - 4')
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, languageOneOf: [ 'pl', 'en', '_unknown' ] } })
+      expect(body.total).to.equal(3)
+      expect(body.data[0].name).to.equal('1111 2222 3333 - 3')
+      expect(body.data[1].name).to.equal('1111 2222 3333 - 4')
+      expect(body.data[2].name).to.equal('1111 2222 3333 - 5')
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { ...query, languageOneOf: [ 'eo' ] } })
+      expect(body.total).to.equal(0)
+    }
+  })
+
+  it('Should search by start date', async function () {
+    const query = {
+      search: '1111 2222 3333',
+      startDate
+    }
+
+    const body = await command.advancedVideoSearch({ search: query })
+    expect(body.total).to.equal(4)
+
+    const videos = body.data
+    expect(videos[0].name).to.equal('1111 2222 3333 - 5')
+    expect(videos[1].name).to.equal('1111 2222 3333 - 6')
+    expect(videos[2].name).to.equal('1111 2222 3333 - 7')
+    expect(videos[3].name).to.equal('1111 2222 3333 - 8')
+  })
+
+  it('Should make an advanced search', async function () {
+    const query = {
+      search: '1111 2222 3333',
+      languageOneOf: [ 'pl', 'fr' ],
+      durationMax: 4,
+      nsfw: 'false' as 'false',
+      licenceOneOf: [ 1, 4 ]
+    }
+
+    const body = await command.advancedVideoSearch({ search: query })
+    expect(body.total).to.equal(4)
+
+    const videos = body.data
+    expect(videos[0].name).to.equal('1111 2222 3333')
+    expect(videos[1].name).to.equal('1111 2222 3333 - 6')
+    expect(videos[2].name).to.equal('1111 2222 3333 - 7')
+    expect(videos[3].name).to.equal('1111 2222 3333 - 8')
+  })
+
+  it('Should make an advanced search and sort results', async function () {
+    const query = {
+      search: '1111 2222 3333',
+      languageOneOf: [ 'pl', 'fr' ],
+      durationMax: 4,
+      nsfw: 'false' as 'false',
+      licenceOneOf: [ 1, 4 ],
+      sort: '-name'
+    }
+
+    const body = await command.advancedVideoSearch({ search: query })
+    expect(body.total).to.equal(4)
+
+    const videos = body.data
+    expect(videos[0].name).to.equal('1111 2222 3333 - 8')
+    expect(videos[1].name).to.equal('1111 2222 3333 - 7')
+    expect(videos[2].name).to.equal('1111 2222 3333 - 6')
+    expect(videos[3].name).to.equal('1111 2222 3333')
+  })
+
+  it('Should make an advanced search and only show the first result', async function () {
+    const query = {
+      search: '1111 2222 3333',
+      languageOneOf: [ 'pl', 'fr' ],
+      durationMax: 4,
+      nsfw: 'false' as 'false',
+      licenceOneOf: [ 1, 4 ],
+      sort: '-name',
+      start: 0,
+      count: 1
+    }
+
+    const body = await command.advancedVideoSearch({ search: query })
+    expect(body.total).to.equal(4)
+
+    const videos = body.data
+    expect(videos[0].name).to.equal('1111 2222 3333 - 8')
+  })
+
+  it('Should make an advanced search and only show the last result', async function () {
+    const query = {
+      search: '1111 2222 3333',
+      languageOneOf: [ 'pl', 'fr' ],
+      durationMax: 4,
+      nsfw: 'false' as 'false',
+      licenceOneOf: [ 1, 4 ],
+      sort: '-name',
+      start: 3,
+      count: 1
+    }
+
+    const body = await command.advancedVideoSearch({ search: query })
+    expect(body.total).to.equal(4)
+
+    const videos = body.data
+    expect(videos[0].name).to.equal('1111 2222 3333')
+  })
+
+  it('Should search on originally published date', async function () {
+    const baseQuery = {
+      search: '1111 2222 3333',
+      languageOneOf: [ 'pl', 'fr' ],
+      durationMax: 4,
+      nsfw: 'false' as 'false',
+      licenceOneOf: [ 1, 4 ]
+    }
+
+    {
+      const query = { ...baseQuery, originallyPublishedStartDate: '2019-02-11T09:58:08.286Z' }
+      const body = await command.advancedVideoSearch({ search: query })
+
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('1111 2222 3333 - 7')
+    }
+
+    {
+      const query = { ...baseQuery, originallyPublishedEndDate: '2019-03-11T09:58:08.286Z' }
+      const body = await command.advancedVideoSearch({ search: query })
+
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('1111 2222 3333 - 7')
+    }
+
+    {
+      const query = { ...baseQuery, originallyPublishedEndDate: '2019-01-11T09:58:08.286Z' }
+      const body = await command.advancedVideoSearch({ search: query })
+
+      expect(body.total).to.equal(0)
+    }
+
+    {
+      const query = { ...baseQuery, originallyPublishedStartDate: '2019-03-11T09:58:08.286Z' }
+      const body = await command.advancedVideoSearch({ search: query })
+
+      expect(body.total).to.equal(0)
+    }
+
+    {
+      const query = {
+        ...baseQuery,
+        originallyPublishedStartDate: '2019-01-11T09:58:08.286Z',
+        originallyPublishedEndDate: '2019-01-10T09:58:08.286Z'
+      }
+      const body = await command.advancedVideoSearch({ search: query })
+
+      expect(body.total).to.equal(0)
+    }
+
+    {
+      const query = {
+        ...baseQuery,
+        originallyPublishedStartDate: '2019-01-11T09:58:08.286Z',
+        originallyPublishedEndDate: '2019-04-11T09:58:08.286Z'
+      }
+      const body = await command.advancedVideoSearch({ search: query })
+
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('1111 2222 3333 - 7')
+    }
+  })
+
+  it('Should search by UUID', async function () {
+    const search = videoUUID
+    const body = await command.advancedVideoSearch({ search: { search } })
+
+    expect(body.total).to.equal(1)
+    expect(body.data[0].name).to.equal('1111 2222 3333 - 3')
+  })
+
+  it('Should filter by UUIDs', async function () {
+    for (const uuid of [ videoUUID, videoShortUUID ]) {
+      const body = await command.advancedVideoSearch({ search: { uuids: [ uuid ] } })
+
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('1111 2222 3333 - 3')
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { uuids: [ 'dfd70b83-639f-4980-94af-304a56ab4b35' ] } })
+
+      expect(body.total).to.equal(0)
+      expect(body.data).to.have.lengthOf(0)
+    }
+  })
+
+  it('Should search by host', async function () {
+    {
+      const body = await command.advancedVideoSearch({ search: { search: '6666 7777 8888', host: server.host } })
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('6666 7777 8888')
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { search: '1111', host: 'example.com' } })
+      expect(body.total).to.equal(0)
+      expect(body.data).to.have.lengthOf(0)
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { search: 'remote', host: remoteServer.host } })
+      expect(body.total).to.equal(2)
+      expect(body.data).to.have.lengthOf(2)
+      expect(body.data[0].name).to.equal('remote video 1')
+      expect(body.data[1].name).to.equal('remote video 2')
+    }
+  })
+
+  it('Should search by live', async function () {
+    this.timeout(120000)
+
+    {
+      const newConfig = {
+        search: {
+          searchIndex: { enabled: false }
+        },
+        live: { enabled: true }
+      }
+      await server.config.updateCustomSubConfig({ newConfig })
+    }
+
+    {
+      const body = await command.advancedVideoSearch({ search: { isLive: true } })
+
+      expect(body.total).to.equal(0)
+      expect(body.data).to.have.lengthOf(0)
+    }
+
+    {
+      const liveCommand = server.live
+
+      const liveAttributes = { name: 'live', privacy: VideoPrivacy.PUBLIC, channelId: server.store.channel.id }
+      const live = await liveCommand.create({ fields: liveAttributes })
+
+      const ffmpegCommand = await liveCommand.sendRTMPStreamInVideo({ videoId: live.id })
+      await liveCommand.waitUntilPublished({ videoId: live.id })
+
+      const body = await command.advancedVideoSearch({ search: { isLive: true } })
+
+      expect(body.total).to.equal(1)
+      expect(body.data[0].name).to.equal('live')
+
+      await stopFfmpeg(ffmpegCommand)
+    }
+  })
+
+  after(async function () {
+    await cleanupTests([ server ])
+  })
+})