Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

11.5 KB
Raw Blame
/* oxlint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */

import { arrayify } from '@peertube/peertube-core-utils'
import {
  ActivityPubActor,
  HttpStatusCode,
  PlaylistElementObject,
  VideoComment,
  VideoCreateResult,
  VideoObject,
  VideoPlaylistCreateResult,
  VideoPlaylistPrivacy,
  VideoPrivacy,
  WatchActionObject
} from '@peertube/peertube-models'
import {
  cleanupTests,
  createMultipleServers,
  doubleFollow,
  makeActivityPubGetRequest,
  PeerTubeServer,
  setAccessTokensToServers,
  setDefaultAccountAvatar,
  setDefaultChannelAvatar,
  setDefaultVideoChannel
} from '@peertube/peertube-server-commands'
import { processViewersStats } from '@tests/shared/views.js'
import { expect } from 'chai'

describe('Test ActivityPub', function () {
  let servers: PeerTubeServer[] = []

  let video: VideoCreateResult
  let privateVideo: VideoCreateResult
  let unlistedVideo: VideoCreateResult

  let playlist: VideoPlaylistCreateResult
  let privatePlaylist: VideoPlaylistCreateResult
  let unlistedPlaylist: VideoPlaylistCreateResult
  let privateVideoPlaylistElementId: number
  let unlistedPlaylistElementId: number

  let comment: VideoComment

  async function testAccount (path: string, hasIcon: boolean) {
    const res = await makeActivityPubGetRequest(servers[0].url, path)
    const object = res.body as ActivityPubActor

    expect(object.type).to.equal('Person')
    expect(object.id).to.equal(servers[0].url + '/accounts/root')
    expect(object.name).to.equal('root')
    expect(object.preferredUsername).to.equal('root')

    expect(object.indexable).to.be.true
    expect(object.discoverable).to.be.true

    if (hasIcon) {
      expect(arrayify(object.icon).map(i => i.width)).to.deep.equal([ 120, 48, 600, 1500 ])
    } else {
      expect(object.icon).to.not.exist
    }

    const htmlURLs = [
      servers[0].url + '/accounts/root',
      servers[0].url + '/a/root',
      servers[0].url + '/a/root/video-channels'
    ]

    for (const htmlURL of htmlURLs) {
      expect(object.url.find(u => u.href === htmlURL), htmlURL).to.exist
    }
  }

  async function testChannel (path: string, hasIcon: boolean) {
    const res = await makeActivityPubGetRequest(servers[0].url, path)
    const object = res.body as ActivityPubActor

    expect(object.type).to.equal('Group')
    expect(object.id).to.equal(servers[0].url + '/video-channels/root_channel')
    expect(object.name).to.equal('Main root channel')
    expect(object.preferredUsername).to.equal('root_channel')

    expect(object.indexable).to.be.true
    expect(object.discoverable).to.be.true

    if (hasIcon) {
      expect(arrayify(object.icon).map(i => i.width)).to.deep.equal([ 120, 48, 600, 1500 ])
    } else {
      expect(object.icon).to.not.exist
    }

    const htmlURLs = [
      servers[0].url + '/video-channels/root_channel',
      servers[0].url + '/c/root_channel',
      servers[0].url + '/c/root_channel/videos'
    ]

    for (const htmlURL of htmlURLs) {
      expect(object.url.find(u => u.href === htmlURL), htmlURL).to.exist
    }
  }

  async function testVideo (path: string) {
    const res = await makeActivityPubGetRequest(servers[0].url, path)
    const object = res.body as VideoObject

    expect(object.type).to.equal('Video')
    expect(object.id).to.equal(servers[0].url + '/videos/watch/' + video.uuid)
    expect(object.name).to.equal('video')

    const htmlURLs = [
      servers[0].url + '/videos/watch/' + video.uuid,
      servers[0].url + '/w/' + video.shortUUID
    ]

    for (const htmlURL of htmlURLs) {
      expect(object.url.find(u => u.href === htmlURL), htmlURL).to.exist
    }
  }

  async function testComment (path: string) {
    const res = await makeActivityPubGetRequest(servers[0].url, path)
    const object = res.body

    expect(object.type).to.equal('Note')
    expect(object.id).to.equal(servers[0].url + '/videos/watch/' + video.uuid + '/comments/' + comment.id)
    expect(object.content).to.contain('thread')
    expect(object.inReplyTo).to.contain(servers[0].url + '/videos/watch/' + video.uuid)
    expect(object.attributedTo).to.equal(servers[0].url + '/accounts/root')
    expect(object.replyApproval).to.equal(servers[0].url + '/videos/watch/' + video.uuid + '/comments/' + comment.id + '/approve-reply')
  }

  async function testPlaylist (path: string) {
    const res = await makeActivityPubGetRequest(servers[0].url, path)
    const object = res.body

    expect(object.type).to.equal('Playlist')
    expect(object.id).to.equal(servers[0].url + '/video-playlists/' + playlist.uuid)
    expect(object.name).to.equal('playlist')
  }

  before(async function () {
    this.timeout(30000)

    servers = await createMultipleServers(2)

    await setAccessTokensToServers(servers)
    await setDefaultVideoChannel(servers)

    {
      video = await servers[0].videos.quickUpload({ name: 'video' })
      privateVideo = await servers[0].videos.quickUpload({ name: 'private video', privacy: VideoPrivacy.PRIVATE })
      unlistedVideo = await servers[0].videos.quickUpload({ name: 'unlisted video', privacy: VideoPrivacy.UNLISTED })
    }

    {
      playlist = await servers[0].playlists.create({
        attributes: {
          displayName: 'playlist',
          privacy: VideoPlaylistPrivacy.PUBLIC,
          videoChannelId: servers[0].store.channel.id
        }
      })
      privatePlaylist = await servers[0].playlists.create({
        attributes: {
          displayName: 'private playlist',
          privacy: VideoPlaylistPrivacy.PRIVATE,
          videoChannelId: servers[0].store.channel.id
        }
      })

      const { id } = await servers[0].playlists.addElement({
        playlistId: playlist.id,
        attributes: { videoId: privateVideo.id }
      })
      privateVideoPlaylistElementId = id
    }

    {
      unlistedPlaylist = await servers[0].playlists.create({
        attributes: {
          displayName: 'unlisted playlist',
          privacy: VideoPlaylistPrivacy.UNLISTED,
          videoChannelId: servers[0].store.channel.id
        }
      })

      const { id } = await servers[0].playlists.addElement({
        playlistId: unlistedPlaylist.uuid,
        attributes: { videoId: video.uuid }
      })
      unlistedPlaylistElementId = id
    }

    comment = await servers[0].comments.createThread({ text: 'thread', videoId: video.id })

    await doubleFollow(servers[0], servers[1])
  })

  it('Should return the account object', async function () {
    await testAccount('/accounts/root', false)
    await testAccount('/a/root', false)
  })

  it('Should return the channel object', async function () {
    await testChannel('/video-channels/root_channel', false)
    await testChannel('/c/root_channel', false)
  })

  it('Should return account & channels with icons', async function () {
    await setDefaultAccountAvatar(servers)
    await setDefaultChannelAvatar(servers)

    await testAccount('/a/root', true)
    await testChannel('/c/root_channel', true)
  })

  it('Should return the video comment object', async function () {
    await testComment('/videos/watch/' + video.id + '/comments/' + comment.id)
    await testComment('/videos/watch/' + video.uuid + '/comments/' + comment.id)
    await testComment('/videos/watch/' + video.shortUUID + '/comments/' + comment.id)
    await testComment('/w/' + video.shortUUID + ';threadId=' + comment.id)
  })

  it('Should return the video object', async function () {
    await testVideo('/videos/watch/' + video.id)
    await testVideo('/videos/watch/' + video.uuid)
    await testVideo('/videos/watch/' + video.shortUUID)
    await testVideo('/w/' + video.id)
    await testVideo('/w/' + video.uuid)
    await testVideo('/w/' + video.shortUUID)
  })

  it('Should return the playlist object', async function () {
    await testPlaylist('/video-playlists/' + playlist.id)
    await testPlaylist('/video-playlists/' + playlist.uuid)
    await testPlaylist('/video-playlists/' + playlist.shortUUID)
    await testPlaylist('/w/p/' + playlist.id)
    await testPlaylist('/w/p/' + playlist.uuid)
    await testPlaylist('/w/p/' + playlist.shortUUID)
    await testPlaylist('/videos/watch/playlist/' + playlist.id)
    await testPlaylist('/videos/watch/playlist/' + playlist.uuid)
    await testPlaylist('/videos/watch/playlist/' + playlist.shortUUID)
  })

  it('Should redirect to the origin video object', async function () {
    const res = await makeActivityPubGetRequest(servers[1].url, '/videos/watch/' + video.uuid, HttpStatusCode.FOUND_302)

    expect(res.header.location).to.equal(servers[0].url + '/videos/watch/' + video.uuid)
  })

  it('Should return the watch action of a remote video', async function () {
    this.timeout(50000)

    await servers[1].views.simulateViewer({ id: video.uuid, currentTimes: [ 0, 2 ] })
    await processViewersStats(servers)

    const res = await makeActivityPubGetRequest(servers[1].url, '/videos/local-viewer/1', HttpStatusCode.OK_200)

    const object: WatchActionObject = res.body
    expect(object.type).to.equal('WatchAction')
    expect(object.duration).to.equal('PT2S')
    expect(object.actionStatus).to.equal('CompletedActionStatus')
    expect(object.watchSections).to.have.lengthOf(1)
    expect(object.watchSections[0].startTimestamp).to.equal(0)
    expect(object.watchSections[0].endTimestamp).to.equal(2)
  })

  it('Should not return the watch action of a local video', async function () {
    this.timeout(50000)

    // Stats of a local viewer
    await servers[0].views.simulateViewer({ id: privateVideo.uuid, token: servers[0].accessToken, currentTimes: [ 0, 2 ] })
    await processViewersStats(servers)

    // servers[0] has stats received from servers[1] and stats of its local viewer
    for (const id of [ 1, 2 ]) {
      await makeActivityPubGetRequest(servers[0].url, '/videos/local-viewer/' + id, HttpStatusCode.NOT_FOUND_404)
    }
  })

  it('Should only return rates of public videos', async function () {
    for (const id of [ video.id, privateVideo.id, unlistedVideo.id ]) {
      await servers[0].videos.rate({ id, rating: 'like' })
    }

    await makeActivityPubGetRequest(servers[0].url, '/accounts/root/likes/' + video.id, HttpStatusCode.OK_200)

    await makeActivityPubGetRequest(servers[0].url, '/accounts/root/likes/' + privateVideo.id, HttpStatusCode.NOT_FOUND_404)
    await makeActivityPubGetRequest(servers[0].url, '/accounts/root/likes/' + unlistedVideo.id, HttpStatusCode.NOT_FOUND_404)
  })

  it('Should not return private video or private playlist', async function () {
    await makeActivityPubGetRequest(servers[0].url, '/videos/watch/' + privateVideo.uuid, HttpStatusCode.UNAUTHORIZED_401)
    await makeActivityPubGetRequest(servers[0].url, '/video-playlists/' + privatePlaylist.uuid, HttpStatusCode.UNAUTHORIZED_401)
  })

  it('Should not leak the URL of a private video that is a member of a public playlist', async function () {
    const path = '/video-playlists/' + playlist.uuid + '/videos/' + privateVideoPlaylistElementId

    const res = await makeActivityPubGetRequest(servers[0].url, path)
    const object: PlaylistElementObject = res.body

    expect(object.url).to.be.null
  })

  it('Should only return an unlisted playlist element using the playlist UUID', async function () {
    const suffix = '/videos/' + unlistedPlaylistElementId

    await makeActivityPubGetRequest(servers[0].url, '/video-playlists/' + unlistedPlaylist.id + suffix, HttpStatusCode.NOT_FOUND_404)

    const res = await makeActivityPubGetRequest(servers[0].url, '/video-playlists/' + unlistedPlaylist.uuid + suffix)
    const object: PlaylistElementObject = res.body

    expect(object.url).to.equal(servers[0].url + '/videos/watch/' + video.uuid)
  })

  after(async function () {
    await cleanupTests(servers)
  })
})