Merge branch 'develop'

Author: nytamin

.github/workflows/build-windows.yaml

@@ -30,15 +30,33 @@ jobs:
       - name: Enable Corepack
         run: corepack enable
 
+      - name: Cache node_modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            .yarn/cache
+            .yarn/install-state.gz
+            **/node_modules
+          key: ${{ runner.os }}-18-modules-${{ hashFiles('**/yarn.lock') }}
+
       - name: Prepare Environment
         run: yarn install --immutable
         env:
           CI: true
 
+      - name: Cache pkg/electron binaries
+        uses: actions/cache@v4
+        with:
+          key: ${{ runner.os }}-natives-${{ hashFiles('node_modules/**/expected-shas.json') }}-${{ hashFiles('node_modules/**/electron/package.json') }}
+          path: |
+            ${{ github.workspace }}/.cache
+
       - name: Run build
         env:
           CI: true
-          PKG_CACHE_PATH: ${{ runner.temp }}
+          ELECTRON_CACHE: ${{ github.workspace }}/.cache/electron
+          ELECTRON_BUILDER_CACHE: ${{ github.workspace }}/.cache/electron-builder
+          PKG_CACHE_PATH: ${{ github.workspace  }}/.cache/yao-pkg
         run: |
           # try and avoid timeout errors
 

.github/workflows/lint-and-test.yaml

@@ -30,6 +30,15 @@ jobs:
       - name: Enable Corepack
         run: corepack enable
 
+      - name: Cache node_modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            .yarn/cache
+            .yarn/install-state.gz
+            **/node_modules
+          key: ${{ runner.os }}-18-modules-${{ hashFiles('**/yarn.lock') }}
+
       - name: Prepare Environment
         run: yarn install --immutable
         env:
@@ -50,9 +59,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node_version: ['20', '22', '24']
+        node_version: ['24']
         os: [ubuntu-latest, windows-latest] # [windows-latest, macOS-latest]
-    timeout-minutes: 10
+    timeout-minutes: 15
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v6
@@ -65,6 +74,21 @@ jobs:
           node-version: ${{ matrix.node_version }}
           cache: 'yarn'
 
+      - name: Cache node_modules
+        uses: actions/cache@v4
+        with:
+          path: |
+            .yarn/cache
+            .yarn/install-state.gz
+            **/node_modules
+          key: ${{ runner.os }}-${{ matrix.node_version }}-modules-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Cache ffmpeg binaries
+        uses: actions/cache@v4
+        with:
+          path: '.ffmpeg'
+          key: ${{ runner.os }}-ffmpeg-${{ hashFiles('**/ffmpegReleases.json') }}
+
       - name: Enable Corepack
         run: corepack enable
 

.gitignore

@@ -42,3 +42,4 @@ apps/single-app/app/expectedPackages.json_smartbull
 signtool.exe
 apps/single-app/app/tmp/
 apps/single-app/app/tmpRenderHTML/
+apps/html-renderer/app/tmp/

DEVELOPER.md

@@ -207,7 +207,7 @@ yarn test
 yarn start:single-app
 
 # Start the single-app in local-only mode, using packages from expectedPackages.json
-yarn start:single-app -- -- --watchFiles=true --noCore=true --logLevel=debug
+yarn start:single-app -- -- --watchFiles=true --noCore=true --logLevel=debug --executableAliases='ffmpeg=C:\\ffmpeg\\ffmpeg.exe;ffprobe=C:\\ffmpeg\\ffprobe.exe;kairos-converter=C:\\Program Files\\Panasonic\\KairosCreator\\bin\\KairosConverter.exe'
 
 
 

apps/appcontainer-node/packages/generic/src/__mocks__/@sofie-package-manager/api.ts

@@ -53,5 +53,7 @@ packageManagerAPI.findValue = realPackageManagerAPI.findValue
 packageManagerAPI.DataStore = realPackageManagerAPI.DataStore
 packageManagerAPI.stringifyError = realPackageManagerAPI.stringifyError
 packageManagerAPI.waitTime = realPackageManagerAPI.waitTime
+packageManagerAPI.isRunningInTest = realPackageManagerAPI.isRunningInTest
+packageManagerAPI.isRunningInDevelopment = realPackageManagerAPI.isRunningInDevelopment
 
 module.exports = packageManagerAPI

apps/appcontainer-node/packages/generic/src/__tests__/lib/setupEnv.ts

@@ -47,6 +47,11 @@ export async function setupAppContainer(partialAppContainerConfig: Partial<AppCo
 					resourceId: '',
 					windowsDriveLetters: [],
 					temporaryFolderPath: '',
+					matchFilenamesWithoutExtension: false,
+					failurePeriod: 0,
+					failurePeriodLimit: 0,
+					executableAliases: {},
+					sourcePackageStabilityThreshold: 0,
 				},
 				workforceURL: null,
 			},

apps/appcontainer-node/packages/generic/src/appContainer.ts

@@ -17,7 +17,6 @@ import {
 	PackageContainerExpectation,
 	Reason,
 	stringifyError,
-	setLogLevel,
 	isNodeRunningInDebugMode,
 	INNER_ACTION_TIMEOUT,
 	DataStore,
@@ -33,9 +32,10 @@ import {
 	DataId,
 	LockId,
 	protectString,
-	getLogLevel,
 	Cost,
 	LeveledLogMethodLight,
+	isRunningInDevelopment,
+	isRunningInTest,
 } from '@sofie-package-manager/api'
 
 import { WorkforceAPI } from './workforceApi'
@@ -283,9 +283,9 @@ export class AppContainer {
 
 	private async discoverAvailableApps() {
 		const getWorkerArgs = (appId: AppId, pickUpCriticalExpectationsOnly: boolean): string[] => {
-			return [
+			const args: string[] = [
 				// Set initial loglevel to be same as appContainer:
-				`--logLevel=${getLogLevel()}`,
+				`--logLevel=${this.logger.getLogLevel()}`,
 
 				`--workerId=${appId}`,
 				pickUpCriticalExpectationsOnly ? `--pickUpCriticalExpectationsOnly=true` : '',
@@ -296,38 +296,54 @@ export class AppContainer {
 				this.config.process.certificates.length
 					? `--certificates=${this.config.process.certificates.join(';')}`
 					: '',
-
-				this.config.appContainer.worker.windowsDriveLetters
-					? `--windowsDriveLetters=${this.config.appContainer.worker.windowsDriveLetters?.join(';')}`
-					: '',
-				this.config.appContainer.worker.temporaryFolderPath
-					? `--temporaryFolderPath=${this.config.appContainer.worker.temporaryFolderPath}`
-					: '',
-				this.config.appContainer.worker.costMultiplier
-					? `--costMultiplier=${this.config.appContainer.worker.costMultiplier}`
-					: '',
-				this.config.appContainer.worker.considerCPULoad
-					? `--considerCPULoad=${this.config.appContainer.worker.considerCPULoad}`
-					: '',
-				this.config.appContainer.worker.resourceId
-					? `--resourceId=${this.config.appContainer.worker.resourceId}`
-					: '',
-				this.config.appContainer.worker.networkIds.length
-					? `--networkIds=${this.config.appContainer.worker.networkIds.join(';')}`
-					: '',
-				this.config.appContainer.worker.failurePeriodLimit
-					? `--failurePeriodLimit=${this.config.appContainer.worker.failurePeriodLimit}`
-					: '',
-				this.config.appContainer.worker.failurePeriod
-					? `--failurePeriod=${this.config.appContainer.worker.failurePeriod}`
-					: '',
 			]
+
+			const workerArgs = this.config.appContainer.worker
+			const keys = Object.keys(workerArgs) as (keyof AppContainerProcessConfig['appContainer']['worker'])[]
+			for (const key of keys) {
+				let argValue: string | undefined = undefined
+				if (key === 'windowsDriveLetters') {
+					argValue = workerArgs.windowsDriveLetters?.join(';')
+				} else if (key === 'temporaryFolderPath') {
+					argValue = workerArgs.temporaryFolderPath
+				} else if (key === 'costMultiplier') {
+					argValue = workerArgs.costMultiplier?.toString()
+				} else if (key === 'considerCPULoad') {
+					argValue = workerArgs.considerCPULoad?.toString()
+				} else if (key === 'resourceId') {
+					argValue = workerArgs.resourceId
+				} else if (key === 'networkIds') {
+					argValue = workerArgs.networkIds.join(';')
+				} else if (key === 'failurePeriodLimit') {
+					argValue = workerArgs.failurePeriodLimit?.toString()
+				} else if (key === 'failurePeriod') {
+					argValue = workerArgs.failurePeriod?.toString()
+				} else if (key === 'sourcePackageStabilityThreshold') {
+					argValue = workerArgs.sourcePackageStabilityThreshold?.toString()
+				} else if (key === 'executableAliases') {
+					argValue = workerArgs.executableAliases
+						? Object.entries<string>(workerArgs.executableAliases)
+								.map(([k, v]) => `${k}=${v}`)
+								.join(';')
+						: undefined
+				} else if (key === 'allowedExpectationTypes') {
+					argValue = workerArgs.allowedExpectationTypes
+						? workerArgs.allowedExpectationTypes.join(';')
+						: undefined
+				} else if (key === 'matchFilenamesWithoutExtension') {
+					// This is handled separately above, skip it here
+				} else {
+					assertNever(key)
+					this.logger.error(`Unknown worker argument key: "${key}"=${workerArgs[key]}`)
+				}
+
+				if (argValue) args.push(`--${key}=${argValue}`)
+			}
+
+			return args
 		}
-		if (
-			path.basename(process.execPath) === 'node.exe' || // windows
-			path.basename(process.execPath) === 'node' // linux
-		) {
-			// Process runs as a node process, we're probably in development mode.
+
+		if (isRunningInDevelopment() || isRunningInTest()) {
 			const appType = protectString<AppType>('worker')
 			this.availableApps.set(appType, {
 				file: process.execPath,
@@ -381,7 +397,7 @@ export class AppContainer {
 	}
 	async setLogLevel(logLevel: LogLevel): Promise<void> {
 		this.logger.info(`Setting log level to "${logLevel}"`)
-		setLogLevel(logLevel)
+		this.logger.setLogLevel(logLevel)
 	}
 	async _debugKill(): Promise<void> {
 		// This is for testing purposes only
@@ -414,7 +430,11 @@ export class AppContainer {
 		if (this.availableApps.size === 0) {
 			this.logger.error('No apps available')
 		} else {
-			this.logger.debug(`Available apps: ${Array.from(this.availableApps.keys()).join(', ')}`)
+			this.logger.debug(
+				`Available apps: ${Array.from(this.availableApps.entries())
+					.map(([key, app]) => `${key}:${app.file}`)
+					.join(', ')}`
+			)
 		}
 
 		let lastNotSupportReason: ExpectedPackageStatusAPI.Reason = {
@@ -470,7 +490,11 @@ export class AppContainer {
 		if (this.availableApps.size === 0) {
 			this.logger.error('No apps available')
 		} else {
-			this.logger.debug(`Available apps: ${Array.from(this.availableApps.keys()).join(', ')}`)
+			this.logger.debug(
+				`Available apps: ${Array.from(this.availableApps.entries())
+					.map(([key, app]) => `${key}:${app.file}`)
+					.join(', ')}`
+			)
 		}
 
 		for (const [appType, availableApp] of this.availableApps.entries()) {
@@ -633,10 +657,7 @@ export class AppContainer {
 		availableApp: AvailableAppInfo,
 		useCriticalOnlyMode: boolean
 	): cp.ChildProcess {
-		const isRunningInDevelopmentMode = process.execPath.endsWith('node.exe') || process.execPath.endsWith('node')
-		const cwd = isRunningInDevelopmentMode
-			? undefined // Process runs as a node process, we're probably in development mode.
-			: path.dirname(process.execPath) // Process runs as a node process, we're probably in development mode.
+		const cwd = isRunningInDevelopment() ? undefined : path.dirname(process.execPath)
 
 		let inspectPort: number | undefined = undefined
 		if (isNodeRunningInDebugMode()) {

apps/html-renderer/app/src/config.ts

@@ -5,6 +5,7 @@ import {
 	processOptions,
 	defineArguments,
 	getProcessArgv,
+	parseExecutableAliases,
 } from '@sofie-package-manager/api'
 
 /*
@@ -58,6 +59,12 @@ const htmlRendererOptions = defineArguments({
 		type: 'boolean',
 		describe: 'When true, will simply trace the version and then close.',
 	},
+	executableAliases: {
+		type: 'string',
+		default: process.env.WORKER_EXECUTABLE_ALIASES || '',
+		describe:
+			'List of aliases for executables the worker can use. Format: "alias1=path to executable1;alias2=executable2". (This is used to alias ffmpeg for the HTML-Renderer.)',
+	},
 })
 
 export interface HTMLRendererOptionsConfig {
@@ -78,6 +85,8 @@ export interface HTMLRendererOptionsConfig {
 	genericWaitStop: number | undefined
 	interactive: boolean | undefined
 	test: boolean | undefined
+	/** List of aliases for executables the worker can use. */
+	executableAliases: { [alias: string]: string }
 }
 export async function getHTMLRendererConfig(): Promise<{
 	process: ProcessConfig
@@ -110,6 +119,7 @@ export async function getHTMLRendererConfig(): Promise<{
 			genericWaitStop: argv.genericWaitStop,
 			interactive: argv.interactive,
 			test: argv.test,
+			executableAliases: parseExecutableAliases(argv.executableAliases),
 		},
 	}
 }

apps/html-renderer/app/src/index.ts

@@ -227,6 +227,7 @@ async function main(): Promise<void> {
 		background: config.htmlRenderer.background,
 		outputFolder: config.htmlRenderer.outputPath ?? '',
 		tempFolder: config.htmlRenderer.tempPath ?? 'tmp',
+		executableAliases: config.htmlRenderer.executableAliases ?? {},
 		url,
 		scripts,
 		interactive,

apps/html-renderer/packages/generic/src/BrowserRenderer.ts

@@ -369,9 +369,17 @@ export class BrowserRenderer implements InteractiveAPI {
 		const logger = this.logger.category('FFMpeg')
 		await new Promise<void>((resolve, reject) => {
 			let logTrace = ''
-			const child = spawn(getFFMpegExecutable(), args, {
-				windowsVerbatimArguments: true, // To fix an issue with ffmpeg.exe on Windows
-			})
+			const child = spawn(
+				getFFMpegExecutable({
+					getExecutable: (executableAlias: string): string | undefined => {
+						return this.options.executableAliases[executableAlias]
+					},
+				}),
+				args,
+				{
+					windowsVerbatimArguments: true, // To fix an issue with ffmpeg.exe on Windows
+				}
+			)
 
 			child.stdout.on('data', (data) => {
 				options?.onStdout?.(data.toString())