feat: expose persistent playout state on LSG (Sofie-Automation#1644)

Author: Julusian

meteor/server/migration/X_X_X.ts

@@ -1,7 +1,7 @@
 import { addMigrationSteps } from './databaseMigration'
 import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
 import { MongoInternals } from 'meteor/mongo'
-import { Studios } from '../collections'
+import { RundownPlaylists, Studios } from '../collections'
 import { ExpectedPackages } from '../collections'
 import * as PackagesPreR53 from '@sofie-automation/corelib/dist/dataModel/Old/ExpectedPackagesR52'
 import {
@@ -198,6 +198,50 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 			}
 		},
 	},
+	{
+		id: `Rename previousPersistentState to privatePlayoutPersistentState`,
+		canBeRunAutomatically: true,
+		validate: async () => {
+			const playlists = await RundownPlaylists.countDocuments({
+				previousPersistentState: { $exists: true },
+				privatePlayoutPersistentState: { $exists: false },
+			})
+			if (playlists > 0) {
+				return 'One or more Playlists has previousPersistentState field that needs to be renamed to privatePlayoutPersistentState'
+			}
+
+			return false
+		},
+		migrate: async () => {
+			const playlists = await RundownPlaylists.findFetchAsync(
+				{
+					previousPersistentState: { $exists: true },
+					privatePlayoutPersistentState: { $exists: false },
+				},
+				{
+					projection: {
+						_id: 1,
+						// @ts-expect-error - This field is being renamed, so it won't exist on the type anymore
+						previousPersistentState: 1,
+					},
+				}
+			)
+
+			for (const playlist of playlists) {
+				// @ts-expect-error - This field is being renamed, so it won't exist on the type anymore
+				const previousPersistentState = playlist.previousPersistentState
+
+				await RundownPlaylists.mutableCollection.updateAsync(playlist._id, {
+					$set: {
+						privatePlayoutPersistentState: previousPersistentState,
+					},
+					$unset: {
+						previousPersistentState: 1,
+					},
+				})
+			}
+		},
+	},
 	// Add your migration here
 
 	new ContainerIdsToObjectWithOverridesMigrationStep(),

packages/blueprints-integration/src/context/playoutStore.ts

@@ -1,26 +1,48 @@
 /**
  * A store for persisting playout state between bluerpint method calls
  * This belongs to the Playlist and will be discarded when the Playlist is reset
+ * This wraps both the 'privateData' and 'publicData' variants, the private variant only accessible to Blueprints, and the public variant available in APIs such as the LSG
  */
 export interface BlueprintPlayoutPersistentStore<T = unknown> {
 	/**
-	 * Get all the data in the store
+	 * Get all the private data in the store
 	 */
 	getAll(): Partial<T>
 	/**
-	 * Retrieve a key of data from the store
+	 * Retrieve a key of private data from the store
 	 * @param k The key to retrieve
 	 */
 	getKey<K extends keyof T>(k: K): T[K] | undefined
 	/**
-	 * Update a key of data in the store
+	 * Update a key of private data in the store
 	 * @param k The key to update
 	 * @param v The value to set
 	 */
 	setKey<K extends keyof T>(k: K, v: T[K]): void
 	/**
-	 * Replace all the data in the store
+	 * Replace all the private data in the store
 	 * @param obj The new data
 	 */
 	setAll(obj: T): void
+
+	/**
+	 * Get all the public data in the store
+	 */
+	getAllPublic(): Partial<T>
+	/**
+	 * Retrieve a key of public data from the store
+	 * @param k The key to retrieve
+	 */
+	getKeyPublic<K extends keyof T>(k: K): T[K] | undefined
+	/**
+	 * Update a key of public data in the store
+	 * @param k The key to update
+	 * @param v The value to set
+	 */
+	setKeyPublic<K extends keyof T>(k: K, v: T[K]): void
+	/**
+	 * Replace all the public data in the store
+	 * @param obj The new data
+	 */
+	setAllPublic(obj: T): void
 }

packages/corelib/src/dataModel/RundownPlaylist.ts

@@ -171,7 +171,13 @@ export interface DBRundownPlaylist {
 	 * Persistent state belong to blueprint playout methods
 	 * This can be accessed and modified by the blueprints in various methods
 	 */
-	previousPersistentState?: TimelinePersistentState
+	privatePlayoutPersistentState?: TimelinePersistentState
+	/**
+	 * Persistent state belong to blueprint playout methods, but exposed to APIs such as the LSG
+	 * This can be accessed and modified by the blueprints in various methods, but is also exposed to APIs such as the LSG
+	 */
+	publicPlayoutPersistentState?: TimelinePersistentState
+
 	/** AB playback sessions calculated in the last timeline genertaion */
 	trackedAbSessions?: ABSessionInfo[]
 	/** AB playback sessions assigned in the last timeline generation */

packages/job-worker/src/blueprints/context/services/PersistantStateStore.ts

@@ -1,32 +1,53 @@
 import type { TimelinePersistentState } from '@sofie-automation/blueprints-integration'
 import type { BlueprintPlayoutPersistentStore } from '@sofie-automation/blueprints-integration/dist/context/playoutStore'
 import { clone } from '@sofie-automation/corelib/dist/lib'
+import type { PlayoutModel } from '../../../playout/model/PlayoutModel.js'
 
 export class PersistentPlayoutStateStore implements BlueprintPlayoutPersistentStore {
-	#state: TimelinePersistentState | undefined
-	#hasChanges = false
+	#privateState: TimelinePersistentState | undefined
+	#hasPrivateChanges = false
+	#publicState: TimelinePersistentState | undefined
+	#hasPublicChanges = false
 
-	get hasChanges(): boolean {
-		return this.#hasChanges
+	constructor(privateState: TimelinePersistentState | undefined, publicState: TimelinePersistentState | undefined) {
+		this.#privateState = clone(privateState)
+		this.#publicState = clone(publicState)
 	}
 
-	constructor(state: TimelinePersistentState | undefined) {
-		this.#state = clone(state)
+	saveToModel(model: PlayoutModel): void {
+		if (this.#hasPrivateChanges) model.setBlueprintPrivatePersistentState(this.#privateState)
+		if (this.#hasPublicChanges) model.setBlueprintPublicPersistentState(this.#publicState)
 	}
 
 	getAll(): Partial<unknown> {
-		return this.#state || {}
+		return this.#privateState || {}
 	}
 	getKey<K extends never>(k: K): unknown {
-		return this.#state?.[k]
+		return this.#privateState?.[k]
 	}
 	setKey<K extends never>(k: K, v: unknown): void {
-		if (!this.#state) this.#state = {}
-		;(this.#state as any)[k] = v
-		this.#hasChanges = true
+		if (!this.#privateState) this.#privateState = {}
+		;(this.#privateState as any)[k] = v
+		this.#hasPrivateChanges = true
 	}
 	setAll(obj: unknown): void {
-		this.#state = obj
-		this.#hasChanges = true
+		this.#privateState = obj
+		this.#hasPrivateChanges = true
+	}
+
+	getAllPublic(): Partial<unknown> {
+		return this.#publicState || {}
+	}
+	getKeyPublic<K extends never>(k: K): unknown {
+		return this.#publicState?.[k]
+	}
+	setKeyPublic<K extends never>(k: K, v: unknown): void {
+		if (!this.#publicState) this.#publicState = {}
+		;(this.#publicState as any)[k] = v
+		this.#hasPublicChanges = true
+	}
+	setAllPublic(obj: unknown): void {
+		this.#publicState = obj
+		this.#hasPublicChanges = true
 	}
 }

packages/job-worker/src/playout/adlibAction.ts

@@ -247,7 +247,10 @@ export async function executeActionInner(
 	)
 
 	try {
-		const blueprintPersistentState = new PersistentPlayoutStateStore(playoutModel.playlist.previousPersistentState)
+		const blueprintPersistentState = new PersistentPlayoutStateStore(
+			playoutModel.playlist.privatePlayoutPersistentState,
+			playoutModel.playlist.publicPlayoutPersistentState
+		)
 
 		await blueprint.blueprint.executeAction(
 			actionContext,
@@ -260,9 +263,7 @@ export async function executeActionInner(
 			actionParameters.actionOptions ?? {}
 		)
 
-		if (blueprintPersistentState.hasChanges) {
-			playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
-		}
+		blueprintPersistentState.saveToModel(playoutModel)
 	} catch (err) {
 		logger.error(`Error in showStyleBlueprint.executeAction: ${stringifyError(err)}`)
 		throw UserError.fromUnknown(err)

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

@@ -328,10 +328,16 @@ export interface PlayoutModel extends PlayoutModelReadonly, StudioPlayoutModelBa
 	): void
 
 	/**
-	 * Store the blueprint persistent state
+	 * Store the blueprint private persistent state
 	 * @param persistentState Blueprint owned state
 	 */
-	setBlueprintPersistentState(persistentState: unknown | undefined): void
+	setBlueprintPrivatePersistentState(persistentState: unknown | undefined): void
+
+	/**
+	 * Store the blueprint public persistent state
+	 * @param persistentState Blueprint owned state
+	 */
+	setBlueprintPublicPersistentState(persistentState: unknown | undefined): void
 
 	/**
 	 * Set a PartInstance as the nexted PartInstance

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

@@ -671,7 +671,8 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		delete this.playlistImpl.startedPlayback
 		delete this.playlistImpl.rundownsStartedPlayback
 		delete this.playlistImpl.segmentsStartedPlayback
-		delete this.playlistImpl.previousPersistentState
+		delete this.playlistImpl.publicPlayoutPersistentState
+		delete this.playlistImpl.privatePlayoutPersistentState
 		delete this.playlistImpl.trackedAbSessions
 		delete this.playlistImpl.queuedSegmentId
 
@@ -783,8 +784,13 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		this.#playlistHasChanged = true
 	}
 
-	setBlueprintPersistentState(persistentState: unknown | undefined): void {
-		this.playlistImpl.previousPersistentState = persistentState
+	setBlueprintPrivatePersistentState(persistentState: unknown | undefined): void {
+		this.playlistImpl.privatePlayoutPersistentState = persistentState
+
+		this.#playlistHasChanged = true
+	}
+	setBlueprintPublicPersistentState(persistentState: unknown | undefined): void {
+		this.playlistImpl.publicPlayoutPersistentState = persistentState
 
 		this.#playlistHasChanged = true
 	}

packages/job-worker/src/playout/setNext.ts

@@ -229,14 +229,15 @@ async function executeOnSetAsNextCallback(
 	playoutModel.clearAllNotifications(NOTIFICATION_CATEGORY)
 
 	try {
-		const blueprintPersistentState = new PersistentPlayoutStateStore(playoutModel.playlist.previousPersistentState)
+		const blueprintPersistentState = new PersistentPlayoutStateStore(
+			playoutModel.playlist.privatePlayoutPersistentState,
+			playoutModel.playlist.publicPlayoutPersistentState
+		)
 
 		await blueprint.blueprint.onSetAsNext(onSetAsNextContext, blueprintPersistentState)
 		await applyOnSetAsNextSideEffects(context, playoutModel, onSetAsNextContext)
 
-		if (blueprintPersistentState.hasChanges) {
-			playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
-		}
+		blueprintPersistentState.saveToModel(playoutModel)
 
 		for (const note of onSetAsNextContext.notes) {
 			// Update the notifications. Even though these are related to a partInstance, they will be cleared on the next take

packages/job-worker/src/playout/take.ts

@@ -343,7 +343,8 @@ async function executeOnTakeCallback(
 		)
 		try {
 			const blueprintPersistentState = new PersistentPlayoutStateStore(
-				playoutModel.playlist.previousPersistentState
+				playoutModel.playlist.privatePlayoutPersistentState,
+				playoutModel.playlist.publicPlayoutPersistentState
 			)
 
 			await blueprint.blueprint.onTake(onSetAsNextContext, blueprintPersistentState)
@@ -353,9 +354,7 @@ async function executeOnTakeCallback(
 				partToQueueAfterTake = onSetAsNextContext.partToQueueAfterTake
 			}
 
-			if (blueprintPersistentState.hasChanges) {
-				playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
-			}
+			blueprintPersistentState.saveToModel(playoutModel)
 
 			for (const note of onSetAsNextContext.notes) {
 				// Update the notifications. Even though these are related to a partInstance, they will be cleared on the next take
@@ -549,7 +548,8 @@ export function updatePartInstanceOnTake(
 				takeRundown
 			)
 			const blueprintPersistentState = new PersistentPlayoutStateStore(
-				playoutModel.playlist.previousPersistentState
+				playoutModel.playlist.privatePlayoutPersistentState,
+				playoutModel.playlist.publicPlayoutPersistentState
 			)
 			previousPartEndState = blueprint.blueprint.getEndStateForPart(
 				context2,
@@ -558,9 +558,8 @@ export function updatePartInstanceOnTake(
 				resolvedPieces.map(convertResolvedPieceInstanceToBlueprints),
 				time
 			)
-			if (blueprintPersistentState.hasChanges) {
-				playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
-			}
+			blueprintPersistentState.saveToModel(playoutModel)
+
 			if (span) span.end()
 			logger.info(`Calculated end state in ${getCurrentTime() - time}ms`)
 		} catch (err) {

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

@@ -415,7 +415,8 @@ export async function getTimelineRundown(
 
 					if (blueprint.blueprint.onTimelineGenerate) {
 						const blueprintPersistentState = new PersistentPlayoutStateStore(
-							playoutModel.playlist.previousPersistentState
+							playoutModel.playlist.privatePlayoutPersistentState,
+							playoutModel.playlist.publicPlayoutPersistentState
 						)
 
 						const span = context.startSpan('blueprint.onTimelineGenerate')
@@ -437,9 +438,7 @@ export async function getTimelineRundown(
 							})
 						})
 
-						if (blueprintPersistentState.hasChanges) {
-							playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
-						}
+						blueprintPersistentState.saveToModel(playoutModel)
 					}
 
 					playoutModel.setAbResolvingState(