server/tests/shared/live.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import { expect } from 'chai'
   4 import { pathExists, readdir } from 'fs-extra'
   5 import { join } from 'path'
   6 import { LiveVideo, VideoStreamingPlaylistType } from '@shared/models'
   7 import { ObjectStorageCommand, PeerTubeServer } from '@shared/server-commands'
   8 import { checkLiveSegmentHash, checkResolutionsInMasterPlaylist } from './streaming-playlists'
   9
  10 async function checkLiveCleanup (server: PeerTubeServer, videoUUID: string, savedResolutions: number[] = []) {
  11   const basePath = server.servers.buildDirectory('streaming-playlists')
  12   const hlsPath = join(basePath, 'hls', videoUUID)
  13
  14   if (savedResolutions.length === 0) {
  15     return checkUnsavedLiveCleanup(server, videoUUID, hlsPath)
  16   }
  17
  18   return checkSavedLiveCleanup(hlsPath, savedResolutions)
  19 }
  20
  21 // ---------------------------------------------------------------------------
  22
  23 async function testVideoResolutions (options: {
  24   originServer: PeerTubeServer
  25   servers: PeerTubeServer[]
  26   liveVideoId: string
  27   resolutions: number[]
  28   transcoded: boolean
  29   objectStorage: boolean
  30 }) {
  31   const { originServer, servers, liveVideoId, resolutions, transcoded, objectStorage } = options
  32
  33   for (const server of servers) {
  34     const { data } = await server.videos.list()
  35     expect(data.find(v => v.uuid === liveVideoId)).to.exist
  36
  37     const video = await server.videos.get({ id: liveVideoId })
  38     expect(video.streamingPlaylists).to.have.lengthOf(1)
  39
  40     const hlsPlaylist = video.streamingPlaylists.find(s => s.type === VideoStreamingPlaylistType.HLS)
  41     expect(hlsPlaylist).to.exist
  42     expect(hlsPlaylist.files).to.have.lengthOf(0) // Only fragmented mp4 files are displayed
  43
  44     await checkResolutionsInMasterPlaylist({
  45       server,
  46       playlistUrl: hlsPlaylist.playlistUrl,
  47       resolutions,
  48       transcoded,
  49       withRetry: objectStorage
  50     })
  51
  52     if (objectStorage) {
  53       expect(hlsPlaylist.playlistUrl).to.contain(ObjectStorageCommand.getPlaylistBaseUrl())
  54     }
  55
  56     for (let i = 0; i < resolutions.length; i++) {
  57       const segmentNum = 3
  58       const segmentName = `${i}-00000${segmentNum}.ts`
  59       await originServer.live.waitUntilSegmentGeneration({
  60         server: originServer,
  61         videoUUID: video.uuid,
  62         playlistNumber: i,
  63         segment: segmentNum,
  64         objectStorage
  65       })
  66
  67       const baseUrl = objectStorage
  68         ? ObjectStorageCommand.getPlaylistBaseUrl() + 'hls'
  69         : originServer.url + '/static/streaming-playlists/hls'
  70
  71       if (objectStorage) {
  72         expect(hlsPlaylist.segmentsSha256Url).to.contain(ObjectStorageCommand.getPlaylistBaseUrl())
  73       }
  74
  75       const subPlaylist = await originServer.streamingPlaylists.get({
  76         url: `${baseUrl}/${video.uuid}/${i}.m3u8`,
  77         withRetry: objectStorage // With object storage, the request may fail because of inconsistent data in S3
  78       })
  79
  80       expect(subPlaylist).to.contain(segmentName)
  81
  82       await checkLiveSegmentHash({
  83         server,
  84         baseUrlSegment: baseUrl,
  85         videoUUID: video.uuid,
  86         segmentName,
  87         hlsPlaylist
  88       })
  89     }
  90   }
  91 }
  92
  93 // ---------------------------------------------------------------------------
  94
  95 export {
  96   checkLiveCleanup,
  97   testVideoResolutions
  98 }
  99
 100 // ---------------------------------------------------------------------------
 101
 102 async function checkSavedLiveCleanup (hlsPath: string, savedResolutions: number[] = []) {
 103   const files = await readdir(hlsPath)
 104
 105   // fragmented file and playlist per resolution + master playlist + segments sha256 json file
 106   expect(files).to.have.lengthOf(savedResolutions.length * 2 + 2)
 107
 108   for (const resolution of savedResolutions) {
 109     const fragmentedFile = files.find(f => f.endsWith(`-${resolution}-fragmented.mp4`))
 110     expect(fragmentedFile).to.exist
 111
 112     const playlistFile = files.find(f => f.endsWith(`${resolution}.m3u8`))
 113     expect(playlistFile).to.exist
 114   }
 115
 116   const masterPlaylistFile = files.find(f => f.endsWith('-master.m3u8'))
 117   expect(masterPlaylistFile).to.exist
 118
 119   const shaFile = files.find(f => f.endsWith('-segments-sha256.json'))
 120   expect(shaFile).to.exist
 121 }
 122
 123 async function checkUnsavedLiveCleanup (server: PeerTubeServer, videoUUID: string, hlsPath: string) {
 124   let live: LiveVideo
 125
 126   try {
 127     live = await server.live.get({ videoId: videoUUID })
 128   } catch {}
 129
 130   if (live?.permanentLive) {
 131     expect(await pathExists(hlsPath)).to.be.true
 132
 133     const hlsFiles = await readdir(hlsPath)
 134     expect(hlsFiles).to.have.lengthOf(1) // Only replays directory
 135
 136     const replayDir = join(hlsPath, 'replay')
 137     expect(await pathExists(replayDir)).to.be.true
 138
 139     const replayFiles = await readdir(join(hlsPath, 'replay'))
 140     expect(replayFiles).to.have.lengthOf(0)
 141
 142     return
 143   }
 144
 145   expect(await pathExists(hlsPath)).to.be.false
 146 }