Merge remote-tracking branch 'nrk/release52' into bbc-release52

Author: Julusian

meteor/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.51.2](https://github.com/nrkno/tv-automation-server-core/compare/v1.51.1...v1.51.2) (2024-11-21)
+
+
+### Bug Fixes
+
+* Include previousPartInstance in check to orphan segments rather than remove them. ([2c113b5](https://github.com/nrkno/tv-automation-server-core/commit/2c113b58b205198d13f0fc7e2114704311eb915b))
+* updatePartInstancesSegmentIds: take into account when multiple segments have been merged into one. ([bdab8c4](https://github.com/nrkno/tv-automation-server-core/commit/bdab8c4e4ee1e67a3568cccc98106bb7f1258673))
+
 ## [1.51.0-in-testing.3](https://github.com/nrkno/sofie-core/compare/v1.51.0-in-testing.2...v1.51.0-in-testing.3) (2024-09-25)
 
 ## [1.51.0-in-testing.2](https://github.com/nrkno/sofie-core/compare/v1.51.0-in-testing.1...v1.51.0-in-testing.2) (2024-09-24)

meteor/server/api/rest/v1/index.ts

@@ -1,6 +1,7 @@
 import KoaRouter from '@koa/router'
 import { interpollateTranslation, translateMessage } from '@sofie-automation/corelib/dist/TranslatableMessage'
 import { UserError, UserErrorMessage } from '@sofie-automation/corelib/dist/error'
+import { IConfigMessage, NoteSeverity } from '@sofie-automation/blueprints-integration'
 import Koa from 'koa'
 import bodyParser from 'koa-bodyparser'
 import { Meteor } from 'meteor/meteor'
@@ -92,6 +93,30 @@ function extractErrorDetails(e: unknown): string[] | undefined {
 	}
 }
 
+export const checkValidation = (method: string, configValidationMsgs: IConfigMessage[]): void => {
+	/**
+	 * Throws if any of the configValidationMsgs indicates that the config has errors.
+	 * Will log any messages with severity WARNING or INFO
+	 */
+	const configValidationOK = configValidationMsgs.reduce((acc, msg) => acc && msg.level !== NoteSeverity.ERROR, true)
+	if (!configValidationOK) {
+		const details = JSON.stringify(
+			configValidationMsgs.filter((msg) => msg.level === NoteSeverity.ERROR).map((msg) => msg.message.key),
+			null,
+			2
+		)
+		logger.error(`${method} failed blueprint config validation with errors: ${details}`)
+		throw new Meteor.Error(409, `${method} has failed blueprint config validation`, details)
+	} else {
+		const details = JSON.stringify(
+			configValidationMsgs.map((msg) => msg.message.key),
+			null,
+			2
+		)
+		logger.info(`${method} received messages from bluepring config validation: ${details}`)
+	}
+}
+
 interface APIRequestError {
 	status: number
 	message: string

meteor/server/api/rest/v1/playlists.ts

@@ -96,7 +96,8 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 		event: string,
 		rundownPlaylistId: RundownPlaylistId,
 		adLibId: AdLibActionId | RundownBaselineAdLibActionId | PieceId | BucketAdLibId,
-		triggerMode?: string | null
+		triggerMode?: string | null,
+		adLibOptions?: { [key: string]: any }
 	): Promise<ClientAPI.ClientResponse<object>> {
 		const baselineAdLibPiece = RundownBaselineAdLibPieces.findOneAsync(adLibId as PieceId, {
 			projection: { _id: 1 },
@@ -204,6 +205,7 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 					actionId: adLibActionDoc.actionId,
 					userData: adLibActionDoc.userData,
 					triggerMode: triggerMode ?? undefined,
+					actionOptions: adLibOptions,
 				}
 			)
 		} else {
@@ -576,7 +578,7 @@ export function registerRoutes(registerRoute: APIRegisterHook<PlaylistsRestAPI>)
 		}
 	)
 
-	registerRoute<{ playlistId: string }, { adLibId: string; actionType?: string }, object>(
+	registerRoute<{ playlistId: string }, { adLibId: string; actionType?: string; adLibOptions?: any }, object>(
 		'post',
 		'/playlists/:playlistId/execute-adlib',
 		new Map([
@@ -591,12 +593,24 @@ export function registerRoutes(registerRoute: APIRegisterHook<PlaylistsRestAPI>)
 			)
 			const actionTypeObj = body
 			const triggerMode = actionTypeObj ? (actionTypeObj as { actionType: string }).actionType : undefined
-			logger.info(`API POST: execute-adlib ${rundownPlaylistId} ${adLibId} - triggerMode: ${triggerMode}`)
+			const adLibOptions = actionTypeObj ? actionTypeObj.adLibOptions : undefined
+			logger.info(
+				`API POST: execute-adlib ${rundownPlaylistId} ${adLibId} - actionType: ${triggerMode} - options: ${
+					adLibOptions ? JSON.stringify(adLibOptions) : 'undefined'
+				}`
+			)
 
 			check(adLibId, String)
 			check(rundownPlaylistId, String)
 
-			return await serverAPI.executeAdLib(connection, event, rundownPlaylistId, adLibId, triggerMode)
+			return await serverAPI.executeAdLib(
+				connection,
+				event,
+				rundownPlaylistId,
+				adLibId,
+				triggerMode,
+				adLibOptions
+			)
 		}
 	)
 

meteor/server/api/rest/v1/showstyles.ts

@@ -20,13 +20,14 @@ import {
 	APIShowStyleVariantFrom,
 	showStyleBaseFrom,
 	showStyleVariantFrom,
+	validateAPIBlueprintConfigForShowStyle,
 } from './typeConversion'
 import { Rundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { runUpgradeForShowStyleBase, validateConfigForShowStyleBase } from '../../../migration/upgrades'
-import { NoteSeverity } from '@sofie-automation/blueprints-integration'
 import { DBShowStyleVariant } from '@sofie-automation/corelib/dist/dataModel/ShowStyleVariant'
 import { assertNever } from '@sofie-automation/corelib/dist/lib'
+import { checkValidation } from '.'
 
 class ShowStylesServerAPI implements ShowStylesRestAPI {
 	async getShowStyleBases(
@@ -42,9 +43,15 @@ class ShowStylesServerAPI implements ShowStylesRestAPI {
 	async addShowStyleBase(
 		_connection: Meteor.Connection,
 		_event: string,
-		showStyleBase: APIShowStyleBase
+		apiShowStyleBase: APIShowStyleBase
 	): Promise<ClientAPI.ClientResponse<string>> {
-		const showStyle = await showStyleBaseFrom(showStyleBase)
+		const blueprintConfigValidation = await validateAPIBlueprintConfigForShowStyle(
+			apiShowStyleBase,
+			protectString(apiShowStyleBase.blueprintId)
+		)
+		checkValidation(`addShowStyleBase`, blueprintConfigValidation)
+
+		const showStyle = await showStyleBaseFrom(apiShowStyleBase)
 		if (!showStyle) throw new Meteor.Error(400, `Invalid ShowStyleBase`)
 		const showStyleId = showStyle._id
 		await ShowStyleBases.insertAsync(showStyle)
@@ -60,16 +67,22 @@ class ShowStylesServerAPI implements ShowStylesRestAPI {
 		const showStyleBase = await ShowStyleBases.findOneAsync(showStyleBaseId)
 		if (!showStyleBase) throw new Meteor.Error(404, `ShowStyleBase ${showStyleBaseId} does not exist`)
 
-		return ClientAPI.responseSuccess(APIShowStyleBaseFrom(showStyleBase))
+		return ClientAPI.responseSuccess(await APIShowStyleBaseFrom(showStyleBase))
 	}
 
 	async addOrUpdateShowStyleBase(
 		_connection: Meteor.Connection,
 		_event: string,
 		showStyleBaseId: ShowStyleBaseId,
-		showStyleBase: APIShowStyleBase
+		apiShowStyleBase: APIShowStyleBase
 	): Promise<ClientAPI.ClientResponse<void>> {
-		const showStyle = await showStyleBaseFrom(showStyleBase, showStyleBaseId)
+		const blueprintConfigValidation = await validateAPIBlueprintConfigForShowStyle(
+			apiShowStyleBase,
+			protectString(apiShowStyleBase.blueprintId)
+		)
+		checkValidation(`addOrUpdateShowStyleBase ${showStyleBaseId}`, blueprintConfigValidation)
+
+		const showStyle = await showStyleBaseFrom(apiShowStyleBase, showStyleBaseId)
 		if (!showStyle) throw new Meteor.Error(400, `Invalid ShowStyleBase`)
 
 		const existingShowStyle = await ShowStyleBases.findOneAsync(showStyleBaseId)
@@ -96,17 +109,73 @@ class ShowStylesServerAPI implements ShowStylesRestAPI {
 
 		await ShowStyleBases.upsertAsync(showStyleBaseId, showStyle)
 
+		// wait for the upsert to complete before validation and upgrade read from the showStyleBases collection
+		await new Promise<void>((resolve) => setTimeout(() => resolve(), 200))
+
 		const validation = await validateConfigForShowStyleBase(showStyleBaseId)
-		const validateOK = validation.messages.reduce((acc, msg) => acc && msg.level === NoteSeverity.INFO, true)
-		if (!validateOK) {
-			const details = JSON.stringify(
-				validation.messages.filter((msg) => msg.level < NoteSeverity.INFO).map((msg) => msg.message.key),
-				null,
-				2
-			)
-			logger.error(`addOrUpdateShowStyleBase failed validation with errors: ${details}`)
-			throw new Meteor.Error(409, `ShowStyleBase ${showStyleBaseId} has failed validation`, details)
-		}
+		checkValidation(`addOrUpdateShowStyleBase ${showStyleBaseId}`, validation.messages)
+
+		return ClientAPI.responseSuccess(await runUpgradeForShowStyleBase(showStyleBaseId))
+	}
+
+	async getShowStyleConfig(
+		_connection: Meteor.Connection,
+		_event: string,
+		showStyleBaseId: ShowStyleBaseId
+	): Promise<ClientAPI.ClientResponse<object>> {
+		const showStyleBase = await ShowStyleBases.findOneAsync(showStyleBaseId)
+		if (!showStyleBase) throw new Meteor.Error(404, `ShowStyleBase ${showStyleBaseId} does not exist`)
+
+		return ClientAPI.responseSuccess((await APIShowStyleBaseFrom(showStyleBase)).config)
+	}
+
+	async updateShowStyleConfig(
+		_connection: Meteor.Connection,
+		_event: string,
+		showStyleBaseId: ShowStyleBaseId,
+		config: object
+	): Promise<ClientAPI.ClientResponse<void>> {
+		const existingShowStyleBase = await ShowStyleBases.findOneAsync(showStyleBaseId)
+		if (existingShowStyleBase) {
+			const rundowns = (await Rundowns.findFetchAsync(
+				{ showStyleBaseId },
+				{ projection: { playlistId: 1 } }
+			)) as Array<Pick<Rundown, 'playlistId'>>
+			const playlists = (await RundownPlaylists.findFetchAsync(
+				{ _id: { $in: rundowns.map((r) => r.playlistId) } },
+				{
+					projection: {
+						activationId: 1,
+					},
+				}
+			)) as Array<Pick<DBRundownPlaylist, 'activationId'>>
+			if (playlists.some((playlist) => playlist.activationId !== undefined)) {
+				throw new Meteor.Error(
+					412,
+					`Cannot update ShowStyleBase ${showStyleBaseId} as it is in use by an active Playlist`
+				)
+			}
+		} else throw new Meteor.Error(404, `ShowStyleBase ${showStyleBaseId} not found`)
+
+		const apiShowStyleBase = await APIShowStyleBaseFrom(existingShowStyleBase)
+		apiShowStyleBase.config = config
+
+		const blueprintConfigValidation = await validateAPIBlueprintConfigForShowStyle(
+			apiShowStyleBase,
+			protectString(apiShowStyleBase.blueprintId)
+		)
+		checkValidation(`updateShowStyleConfig ${showStyleBaseId}`, blueprintConfigValidation)
+
+		const showStyle = await showStyleBaseFrom(apiShowStyleBase, showStyleBaseId)
+		if (!showStyle) throw new Meteor.Error(400, `Invalid ShowStyleBase`)
+
+		await ShowStyleBases.upsertAsync(showStyleBaseId, showStyle)
+
+		// wait for the upsert to complete before validation and upgrade read from the showStyleBases collection
+		await new Promise<void>((resolve) => setTimeout(() => resolve(), 200))
+
+		const validation = await validateConfigForShowStyleBase(showStyleBaseId)
+		checkValidation(`updateShowStyleConfig ${showStyleBaseId}`, validation.messages)
 
 		return ClientAPI.responseSuccess(await runUpgradeForShowStyleBase(showStyleBaseId))
 	}
@@ -185,20 +254,26 @@ class ShowStylesServerAPI implements ShowStylesRestAPI {
 		const variant = await ShowStyleVariants.findOneAsync(showStyleVariantId)
 		if (!variant) throw new Meteor.Error(404, `ShowStyleVariant ${showStyleVariantId} not found`)
 
-		return ClientAPI.responseSuccess(APIShowStyleVariantFrom(variant))
+		return ClientAPI.responseSuccess(await APIShowStyleVariantFrom(showStyleBase, variant))
 	}
 
 	async addOrUpdateShowStyleVariant(
 		_connection: Meteor.Connection,
 		_event: string,
 		showStyleBaseId: ShowStyleBaseId,
 		showStyleVariantId: ShowStyleVariantId,
-		showStyleVariant: APIShowStyleVariant
+		apiShowStyleVariant: APIShowStyleVariant
 	): Promise<ClientAPI.ClientResponse<void>> {
 		const showStyleBase = await ShowStyleBases.findOneAsync(showStyleBaseId)
 		if (!showStyleBase) throw new Meteor.Error(404, `ShowStyleBase ${showStyleBaseId} does not exist`)
 
-		const showStyle = showStyleVariantFrom(showStyleVariant, showStyleVariantId)
+		const blueprintConfigValidation = await validateAPIBlueprintConfigForShowStyle(
+			apiShowStyleVariant,
+			showStyleBase.blueprintId
+		)
+		checkValidation(`addOrUpdateShowStyleVariant ${showStyleVariantId}`, blueprintConfigValidation)
+
+		const showStyle = showStyleVariantFrom(apiShowStyleVariant, showStyleVariantId)
 		if (!showStyle) throw new Meteor.Error(400, `Invalid ShowStyleVariant`)
 
 		const existingShowStyle = await ShowStyleVariants.findOneAsync(showStyleVariantId)
@@ -335,6 +410,37 @@ export function registerRoutes(registerRoute: APIRegisterHook<ShowStylesRestAPI>
 		}
 	)
 
+	registerRoute<{ showStyleBaseId: string }, never, object>(
+		'get',
+		'/showstyles/:showStyleBaseId/config',
+		new Map([[404, [UserErrorMessage.ShowStyleBaseNotFound]]]),
+		showStylesAPIFactory,
+		async (serverAPI, connection, event, params, _) => {
+			const showStyleBaseId = protectString<ShowStyleBaseId>(params.showStyleBaseId)
+			logger.info(`API GET: ShowStyleBase config ${showStyleBaseId}`)
+
+			check(showStyleBaseId, String)
+			return await serverAPI.getShowStyleConfig(connection, event, showStyleBaseId)
+		}
+	)
+
+	registerRoute<{ showStyleBaseId: string }, object, void>(
+		'put',
+		'/showstyles/:showStyleBaseId/config',
+		new Map([
+			[404, [UserErrorMessage.ShowStyleBaseNotFound]],
+			[409, [UserErrorMessage.ValidationFailed]],
+		]),
+		showStylesAPIFactory,
+		async (serverAPI, connection, event, params, body) => {
+			const showStyleBaseId = protectString<ShowStyleBaseId>(params.showStyleBaseId)
+			logger.info(`API PUT: Update ShowStyleBase config ${showStyleBaseId}`)
+
+			check(showStyleBaseId, String)
+			return await serverAPI.updateShowStyleConfig(connection, event, showStyleBaseId, body)
+		}
+	)
+
 	registerRoute<{ showStyleBaseId: string }, never, void>(
 		'delete',
 		'/showstyles/:showStyleBaseId',