Merge pull request Sofie-Automation#1627 from tv2norge-collab/contribute/EAV-737

fix: prevent undesired timelines reaching TSR

Author: ianshade

packages/blueprints-integration/src/api/showStyle.ts

@@ -201,12 +201,16 @@ export interface ShowStyleBlueprintManifest<
 	// Events
 
 	/**
-	 * Called when a RundownPlaylist has been activated
+	 * Called at the final stage of RundownPlaylist activation, before the updated timeline is submitted to the Playout Gateway,
+	 * This is a good place to prepare any external systems for the rundown going live.
 	 */
 	onRundownActivate?: (context: IRundownActivationContext) => Promise<void>
 	/** Called upon the first take in a RundownPlaylist */
 	onRundownFirstTake?: (context: IPartEventContext) => Promise<void>
-	/** Called when a RundownPlaylist has been deactivated */
+	/**
+	 * Called at the final stage of RundownPlaylist deactivation, before the updated timeline is submitted to the Playout Gateway,
+	 * This is a good place to prepare any external systems for the rundown going offline.
+	 */
 	onRundownDeActivate?: (context: IRundownActivationContext) => Promise<void>
 
 	/** Called before a Take action */

packages/job-worker/src/playout/model/PlayoutModel.ts

@@ -387,6 +387,12 @@ export interface PlayoutModel extends PlayoutModelReadonly, StudioPlayoutModelBa
 	 */
 	getNowInPlayout(): Time
 
+	/**
+	 * Mark the playlist as needing a timeline update.
+	 * The timeline will be generated and published when model is ready to be saved.
+	 */
+	markTimelineNeedsUpdate(): void
+
 	/** Lifecycle */
 
 	/**

packages/job-worker/src/playout/model/implementation/PlayoutModelImpl.ts

@@ -71,6 +71,15 @@ import { PieceInstanceWithTimings } from '@sofie-automation/corelib/dist/playout
 import { NotificationsModelHelper } from '../../../notifications/NotificationsModelHelper.js'
 import { getExpectedLatency } from '@sofie-automation/corelib/dist/studio/playout'
 import { ExpectedPackage } from '@sofie-automation/blueprints-integration'
+import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyError'
+import {
+	getTimelineRundown,
+	flattenAndProcessTimelineObjects,
+	preserveOrReplaceNowTimesInObjects,
+	logAnyRemainingNowTimes,
+	getStudioTimeline,
+} from '../../timeline/generate.js'
+import { deNowifyMultiGatewayTimeline } from '../../timeline/multi-gateway.js'
 
 export class PlayoutModelReadonlyImpl implements PlayoutModelReadonly {
 	public readonly playlistId: RundownPlaylistId
@@ -315,6 +324,7 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 
 	#playlistHasChanged = false
 	#timelineHasChanged = false
+	#timelineNeedsRegeneration = false
 
 	#pendingPartInstanceTimingEvents = new Set<PartInstanceId>()
 
@@ -694,8 +704,17 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		}
 		this.#deferredBeforeSaveFunctions.length = 0 // clear the array
 
+		// Generate timeline if needed
+		if (this.#timelineNeedsRegeneration) {
+			await this.#regenerateTimeline()
+			this.#timelineNeedsRegeneration = false
+		}
+
 		// Prioritise the timeline for publication reasons
 		if (this.#timelineHasChanged && this.timelineImpl) {
+			// Do a fast-track for the timeline to be published faster:
+			this.context.hackPublishTimelineToFastTrack(this.timelineImpl)
+
 			await this.context.directCollections.Timelines.replace(this.timelineImpl)
 			if (!process.env.JEST_WORKER_ID) {
 				// Wait a little bit before saving the rest.
@@ -886,6 +905,10 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		return result
 	}
 
+	markTimelineNeedsUpdate(): void {
+		this.#timelineNeedsRegeneration = true
+	}
+
 	/** Notifications */
 
 	async getAllNotifications(
@@ -922,6 +945,40 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 
 	/** BaseModel */
 
+	async #regenerateTimeline(): Promise<void> {
+		const span = this.context.startSpan('PlayoutModelImpl.regenerateTimeline')
+		logger.debug('Regenerating timeline...')
+
+		try {
+			const {
+				versions,
+				objs: timelineObjs,
+				timingContext: timingInfo,
+				regenerateTimelineToken,
+			} = this.playlist.activationId
+				? await getTimelineRundown(this.context, this)
+				: await getStudioTimeline(this.context, this)
+
+			flattenAndProcessTimelineObjects(this.context, timelineObjs)
+
+			preserveOrReplaceNowTimesInObjects(this, timelineObjs)
+
+			if (this.isMultiGatewayMode) {
+				deNowifyMultiGatewayTimeline(this, timelineObjs, timingInfo)
+
+				logAnyRemainingNowTimes(this.context, timelineObjs)
+			}
+
+			const timelineHash = this.setTimeline(timelineObjs, versions, regenerateTimelineToken).timelineHash
+			logger.verbose(`Timeline regeneration done, hash: "${timelineHash}"`)
+		} catch (err) {
+			logger.error(`Error regenerating timeline: ${stringifyError(err)}`)
+			throw err
+		} finally {
+			if (span) span.end()
+		}
+	}
+
 	/**
 	 * Assert that no changes should have been made to the model, will throw an Error otherwise. This can be used in
 	 * place of `saveAllToDatabase()`, when the code controlling the model expects no changes to have been made and any

packages/job-worker/src/playout/timeline/generate.ts

@@ -1,4 +1,4 @@
-import { BlueprintId, RundownPlaylistId, TimelineHash } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { BlueprintId, RundownPlaylistId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { JobContext, JobStudio } from '../../jobs/index.js'
 import { ReadonlyDeep } from 'type-fest'
 import { BlueprintResultBaseline, OnGenerateTimelineObj, Time, TSR } from '@sofie-automation/blueprints-integration'
@@ -37,7 +37,6 @@ import { deserializePieceTimelineObjectsBlob } from '@sofie-automation/corelib/d
 import { convertResolvedPieceInstanceToBlueprints } from '../../blueprints/context/lib.js'
 import { buildTimelineObjsForRundown, RundownTimelineTimingContext } from './rundown.js'
 import { SourceLayers } from '@sofie-automation/corelib/dist/dataModel/ShowStyleBase'
-import { deNowifyMultiGatewayTimeline } from './multi-gateway.js'
 import { validateTimeline } from 'superfly-timeline'
 import { getPartTimingsOrDefaults, PartCalculatedTimings } from '@sofie-automation/corelib/dist/playout/timings'
 import { applyAbPlaybackForTimeline } from '../abPlayback/index.js'
@@ -67,25 +66,19 @@ function generateTimelineVersions(
 	}
 }
 
-export async function updateStudioTimeline(
+/**
+ * Generate timeline objects for a studio (when no playlist is active)
+ */
+export async function getStudioTimeline(
 	context: JobContext,
 	playoutModel: StudioPlayoutModel | PlayoutModel
-): Promise<void> {
-	const span = context.startSpan('updateStudioTimeline')
-	logger.debug('updateStudioTimeline running...')
+): Promise<{
+	objs: Array<TimelineObjRundown>
+	versions: TimelineCompleteGenerationVersions
+	timingContext: undefined
+	regenerateTimelineToken: undefined
+}> {
 	const studio = context.studio
-	// Ensure there isn't a playlist active, as that should be using a different function call
-	if (isModelForStudio(playoutModel)) {
-		const activePlaylists = playoutModel.getActiveRundownPlaylists()
-		if (activePlaylists.length > 0) {
-			throw new Error(`Studio has an active playlist`)
-		}
-	} else {
-		if (playoutModel.playlist.activationId) {
-			throw new Error(`Studio has an active playlist`)
-		}
-	}
-
 	let baselineObjects: TimelineObjRundown[] = []
 	let studioBaseline: BlueprintResultBaseline | undefined
 
@@ -119,60 +112,58 @@ export async function updateStudioTimeline(
 		studioBlueprint?.blueprint?.blueprintVersion ?? '-'
 	)
 
-	flattenAndProcessTimelineObjects(context, baselineObjects)
-
-	// Future: We should handle any 'now' objects that are at the root of this timeline
-	preserveOrReplaceNowTimesInObjects(playoutModel, baselineObjects)
-
-	if (playoutModel.isMultiGatewayMode) {
-		logAnyRemainingNowTimes(context, baselineObjects)
+	if (studioBaseline) {
+		updateBaselineExpectedPackagesOnStudio(context, playoutModel, studioBaseline)
 	}
 
-	const timelineHash = saveTimeline(context, playoutModel, baselineObjects, versions, undefined)
+	return {
+		objs: baselineObjects,
+		versions,
+		timingContext: undefined,
+		regenerateTimelineToken: undefined,
+	}
+}
 
-	if (studioBaseline) {
-		updateBaselineExpectedPackagesOnStudio(context, playoutModel, studioBaseline)
+export async function updateStudioTimeline(
+	context: JobContext,
+	playoutModel: StudioPlayoutModel | PlayoutModel
+): Promise<void> {
+	const span = context.startSpan('updateStudioTimeline')
+	logger.debug('updateStudioTimeline: marking studio as needing timeline update')
+	// Ensure there isn't a playlist active, as that should be using a different function call
+	if (isModelForStudio(playoutModel)) {
+		const activePlaylists = playoutModel.getActiveRundownPlaylists()
+		if (activePlaylists.length > 0) {
+			throw new Error(`Studio has an active playlist`)
+		}
+	} else {
+		if (playoutModel.playlist.activationId) {
+			throw new Error(`Studio has an active playlist`)
+		}
 	}
 
-	logger.verbose(`updateStudioTimeline done, hash: "${timelineHash}"`)
+	playoutModel.markTimelineNeedsUpdate()
+
 	if (span) span.end()
 }
 
 export async function updateTimeline(context: JobContext, playoutModel: PlayoutModel): Promise<void> {
 	const span = context.startSpan('updateTimeline')
-	logger.debug('updateTimeline running...')
+	logger.debug('updateTimeline: marking playlist as needing timeline update')
 
 	if (!playoutModel.playlist.activationId) {
 		throw new Error(`RundownPlaylist ("${playoutModel.playlist._id}") is not active")`)
 	}
 
-	const {
-		versions,
-		objs: timelineObjs,
-		timingContext: timingInfo,
-		regenerateTimelineToken,
-	} = await getTimelineRundown(context, playoutModel)
-
-	flattenAndProcessTimelineObjects(context, timelineObjs)
-
-	preserveOrReplaceNowTimesInObjects(playoutModel, timelineObjs)
-
-	if (playoutModel.isMultiGatewayMode) {
-		deNowifyMultiGatewayTimeline(playoutModel, timelineObjs, timingInfo)
-
-		logAnyRemainingNowTimes(context, timelineObjs)
-	}
-
-	const timelineHash = saveTimeline(context, playoutModel, timelineObjs, versions, regenerateTimelineToken)
-	logger.verbose(`updateTimeline done, hash: "${timelineHash}"`)
+	playoutModel.markTimelineNeedsUpdate()
 
 	if (span) span.end()
 }
 
-function preserveOrReplaceNowTimesInObjects(
+export function preserveOrReplaceNowTimesInObjects(
 	studioPlayoutModel: StudioPlayoutModelBase,
 	timelineObjs: Array<TimelineObjGeneric>
-) {
+): void {
 	const timeline = studioPlayoutModel.timeline
 	const oldTimelineObjsMap = normalizeArray(
 		(timeline?.timelineBlob !== undefined && deserializeTimelineBlob(timeline.timelineBlob)) || [],
@@ -202,7 +193,7 @@ function preserveOrReplaceNowTimesInObjects(
 	})
 }
 
-function logAnyRemainingNowTimes(_context: JobContext, timelineObjs: Array<TimelineObjGeneric>): void {
+export function logAnyRemainingNowTimes(_context: JobContext, timelineObjs: Array<TimelineObjGeneric>): void {
 	const badTimelineObjs: any[] = []
 
 	for (const obj of timelineObjs) {
@@ -229,22 +220,6 @@ function hasNow(obj: TimelineEnableExt | TimelineEnableExt[]) {
 	return res
 }
 
-/** Store the timelineobjects into the model, and perform any post-save actions */
-export function saveTimeline(
-	context: JobContext,
-	studioPlayoutModel: StudioPlayoutModelBase,
-	timelineObjs: TimelineObjGeneric[],
-	generationVersions: TimelineCompleteGenerationVersions,
-	regenerateTimelineToken: string | undefined
-): TimelineHash {
-	const newTimeline = studioPlayoutModel.setTimeline(timelineObjs, generationVersions, regenerateTimelineToken)
-
-	// Also do a fast-track for the timeline to be published faster:
-	context.hackPublishTimelineToFastTrack(newTimeline)
-
-	return newTimeline.timelineHash
-}
-
 export interface SelectedPartInstancesTimelineInfo {
 	previous?: SelectedPartInstanceTimelineInfo
 	current?: SelectedPartInstanceTimelineInfo
@@ -303,7 +278,7 @@ function getPartInstanceTimelineInfo(
 /**
  * Returns timeline objects related to rundowns in a studio
  */
-async function getTimelineRundown(
+export async function getTimelineRundown(
 	context: JobContext,
 	playoutModel: PlayoutModel
 ): Promise<{
@@ -562,7 +537,7 @@ function createRegenerateTimelineObj(
  * @param context
  * @param timelineObjs Array of timeline objects
  */
-function flattenAndProcessTimelineObjects(context: JobContext, timelineObjs: Array<TimelineObjGeneric>): void {
+export function flattenAndProcessTimelineObjects(context: JobContext, timelineObjs: Array<TimelineObjGeneric>): void {
 	const span = context.startSpan('processTimelineObjects')
 
 	// first, split out any grouped objects, to make the timeline shallow:

packages/job-worker/src/playout/timings/timelineTriggerTime.ts

@@ -4,7 +4,6 @@ import { OnTimelineTriggerTimeProps } from '@sofie-automation/corelib/dist/worke
 import { logger } from '../../logging.js'
 import { JobContext } from '../../jobs/index.js'
 import { runJobWithPlaylistLock } from '../lock.js'
-import { saveTimeline } from '../timeline/generate.js'
 import { applyToArray, normalizeArrayToMap } from '@sofie-automation/corelib/dist/lib'
 import { PieceInstance } from '@sofie-automation/corelib/dist/dataModel/PieceInstance'
 import { runJobWithStudioPlayoutModel } from '../../studio/lock.js'
@@ -69,7 +68,6 @@ export async function handleTimelineTriggerTime(context: JobContext, data: OnTim
 
 					// Take ownership of the playlist in the db, so that we can mutate the timeline and piece instances
 					const changes = timelineTriggerTimeInner(
-						context,
 						studioCache,
 						data.results,
 						partInstanceMap,
@@ -81,7 +79,7 @@ export async function handleTimelineTriggerTime(context: JobContext, data: OnTim
 				})
 			} else {
 				// No playlist is active. no extra lock needed
-				timelineTriggerTimeInner(context, studioCache, data.results, undefined, undefined, undefined)
+				timelineTriggerTimeInner(studioCache, data.results, undefined, undefined, undefined)
 			}
 		})
 	}
@@ -123,7 +121,6 @@ interface PieceInstancesChanges {
 }
 
 function timelineTriggerTimeInner(
-	context: JobContext,
 	studioPlayoutModel: StudioPlayoutModel,
 	results: OnTimelineTriggerTimeProps['results'],
 	partInstances: Map<PartInstanceId, Pick<DBPartInstance, '_id' | 'partPlayoutTimings'>> | undefined,
@@ -205,14 +202,11 @@ function timelineTriggerTimeInner(
 			}
 		}
 		if (tlChanged) {
-			const timelineHash = saveTimeline(
-				context,
-				studioPlayoutModel,
+			const timelineHash = studioPlayoutModel.setTimeline(
 				timelineObjs,
-				// Preserve some current values:
 				timeline.generationVersions,
 				timeline.regenerateTimelineToken
-			)
+			).timelineHash
 
 			logger.verbose(`timelineTriggerTime: Updated Timeline, hash: "${timelineHash}"`)
 		}

packages/job-worker/src/studio/model/StudioPlayoutModel.ts

@@ -79,4 +79,10 @@ export interface StudioPlayoutModel extends StudioPlayoutModelBase, BaseModel {
 	 * @returns Whether the change may affect timeline generation
 	 */
 	switchRouteSet(routeSetId: string, isActive: boolean | 'toggle'): boolean
+
+	/**
+	 * Mark the studio as needing a timeline update.
+	 * The timeline will be generated and published when model is ready to be saved.
+	 */
+	markTimelineNeedsUpdate(): void
 }