chore: review comments

scripts/fetch-ffmpeg.mjs

@@ -1,3 +1,9 @@
+/**
+ * This is a small helper to download and extract a set of ffmpeg binaries.
+ * It reads the file `./tests/ffmpegReleases.json` to see what versions should be downloaded,
+ * and puts them into `.ffmpeg/` at the root of the repository.
+ */
+
 import fs from 'fs/promises'
 import { pipeline } from 'node:stream'
 import { promisify } from 'node:util'
@@ -73,5 +79,5 @@ if (platformVersions) {
 		}
 	}
 } else {
-	throw new Error(`FFmpeg downloading for "${platformInfo}" not supported yet`)
+	throw new Error(`No FFMpeg binaries have been defined for "${platformInfo}" yet`)
 }

shared/packages/worker/src/__tests__/ffmpegHelper.ts

@@ -1,9 +1,6 @@
 import path from 'path'
 import { LocalFolderAccessorHandle } from '../worker/accessorHandlers/localFolder'
-import { setFFMpegExecutables, spawnFFMpeg } from '../worker/workers/windowsWorker/expectationHandlers/lib/ffmpeg'
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const targetVersions = require('../../../../../tests/ffmpegReleases.json')
+import { overrideFFMpegExecutables, spawnFFMpeg } from '../worker/workers/windowsWorker/expectationHandlers/lib/ffmpeg'
 
 export const SamplesDir = path.join(__dirname, '../../../../../tests/samples')
 
@@ -32,16 +29,20 @@ export function runForEachFFMpegRelease(runForFFmpegRelease: () => void) {
 	const ffmpegFilename = process.platform === 'win32' ? 'bin/ffmpeg.exe' : 'ffmpeg'
 
 	const ffmpegRootPath = path.join(__dirname, '../../../../../.ffmpeg')
+
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	const targetVersions = require('../../../../../tests/ffmpegReleases.json')
+
 	for (const version of targetVersions[`${process.platform}-${process.arch}`]) {
 		describe(`FFmpeg ${version.id}`, () => {
 			beforeEach(() => {
-				setFFMpegExecutables({
+				overrideFFMpegExecutables({
 					ffmpeg: path.join(ffmpegRootPath, version.id, ffmpegFilename),
 					ffprobe: path.join(ffmpegRootPath, version.id, ffprobeFilename),
 				})
 			})
 			afterAll(() => {
-				setFFMpegExecutables(null)
+				overrideFFMpegExecutables(null)
 			})
 
 			runForFFmpegRelease()

shared/packages/worker/src/worker/workers/windowsWorker/expectationHandlers/lib/ffmpeg.ts

@@ -17,7 +17,11 @@ export interface OverriddenFFMpegExecutables {
 }
 
 let overriddenFFMpegPaths: OverriddenFFMpegExecutables | null = null
-export function setFFMpegExecutables(paths: OverriddenFFMpegExecutables | null): void {
+/**
+ * Override the paths of the ffmpeg executables, intended for unit testing purposes
+ * @param paths Paths to executables
+ */
+export function overrideFFMpegExecutables(paths: OverriddenFFMpegExecutables | null): void {
 	overriddenFFMpegPaths = paths
 }