Merge pull request #1386 from bbc/upstream/blueprint-playout-store

feat(Blueprint API): expose persistent playout store to more methods

Author: jstarpl

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

@@ -48,6 +48,7 @@ import type { ExpectedPackage } from '../package'
 import type { ABResolverConfiguration } from '../abPlayback'
 import type { SofieIngestSegment } from '../ingest-types'
 import { PackageStatusMessage } from '@sofie-automation/shared-lib/dist/packageStatusMessages'
+import { BlueprintPlayoutPersistentStore } from '../context/playoutStore'
 
 export { PackageStatusMessage }
 
@@ -111,7 +112,6 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 		context: ISyncIngestUpdateToPartInstanceContext,
 		existingPartInstance: BlueprintSyncIngestPartInstance,
 		newData: BlueprintSyncIngestNewData,
-
 		playoutStatus: 'previous' | 'current' | 'next'
 	) => void
 
@@ -130,12 +130,13 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	/** Execute an action defined by an IBlueprintActionManifest */
 	executeAction?: (
 		context: IActionExecutionContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		actionId: string,
 		userData: ActionUserData,
 		triggerMode: string | undefined,
-		privateData?: unknown,
-		publicData?: unknown,
-		actionOptions?: { [key: string]: any }
+		privateData: unknown | undefined,
+		publicData: unknown | undefined,
+		actionOptions: { [key: string]: any } | undefined
 	) => Promise<{ validationErrors: any } | void>
 
 	/** Generate adlib piece from ingest data */
@@ -204,21 +205,27 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	 * Called during a Take action.
 	 * Allows for part modification or aborting the take.
 	 */
-	onTake?: (context: IOnTakeContext) => Promise<void>
+	onTake?: (
+		context: IOnTakeContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>
+	) => Promise<void>
 	/** Called after a Take action */
 	onPostTake?: (context: IPartEventContext) => Promise<void>
 
 	/**
 	 * Called when a part is set as Next, including right after a Take.
 	 * Allows for part modification.
 	 */
-	onSetAsNext?: (context: IOnSetAsNextContext) => Promise<void>
+	onSetAsNext?: (
+		context: IOnSetAsNextContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>
+	) => Promise<void>
 
 	/** Called after the timeline has been generated, used to manipulate the timeline */
 	onTimelineGenerate?: (
 		context: ITimelineEventContext,
 		timeline: OnGenerateTimelineObj<TSR.TSRTimelineContent>[],
-		previousPersistentState: TimelinePersistentState | undefined,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		previousPartEndState: PartEndState | undefined,
 		resolvedPieces: IBlueprintResolvedPieceInstance[]
 	) => Promise<BlueprintResultTimeline>
@@ -229,7 +236,7 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	/** Called just before taking the next part. This generates some persisted data used by onTimelineGenerate to modify the timeline based on the previous part (eg, persist audio levels) */
 	getEndStateForPart?: (
 		context: IRundownContext,
-		previousPersistentState: TimelinePersistentState | undefined,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		partInstance: IBlueprintPartInstance,
 		resolvedPieces: IBlueprintResolvedPieceInstance[],
 		time: number
@@ -249,7 +256,6 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 
 export interface BlueprintResultTimeline {
 	timeline: OnGenerateTimelineObj<TSR.TSRTimelineContent>[]
-	persistentState: TimelinePersistentState
 }
 export interface BlueprintResultBaseline {
 	timelineObjects: TimelineObjectCoreExt<TSR.TSRTimelineContent>[]

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

@@ -5,6 +5,7 @@ export * from './fixUpConfigContext'
 export * from './onSetAsNextContext'
 export * from './onTakeContext'
 export * from './packageInfoContext'
+export * from './playoutStore'
 export * from './processIngestDataContext'
 export * from './rundownContext'
 export * from './showStyleContext'

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

@@ -0,0 +1,26 @@
+/**
+ * A store for persisting playout state between bluerpint method calls
+ * This belongs to the Playlist and will be discarded when the Playlist is reset
+ */
+export interface BlueprintPlayoutPersistentStore<T = unknown> {
+	/**
+	 * Get all the data in the store
+	 */
+	getAll(): Partial<T>
+	/**
+	 * Retrieve a key of 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
+	 * @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
+	 * @param obj The new data
+	 */
+	setAll(obj: T): void
+}

packages/corelib/src/dataModel/RundownPlaylist.ts

@@ -169,7 +169,10 @@ export interface DBRundownPlaylist {
 	/** If the order of rundowns in this playlist has ben set manually by a user/blueprints in Sofie */
 	rundownIdsInOrder: RundownId[]
 
-	/** Previous state persisted from ShowStyleBlueprint.onTimelineGenerate */
+	/**
+	 * Persistent state belong to blueprint playout methods
+	 * This can be accessed and modified by the blueprints in various methods
+	 */
 	previousPersistentState?: TimelinePersistentState
 	/** AB playback sessions calculated in the last timeline genertaion */
 	trackedAbSessions?: ABSessionInfo[]

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

@@ -0,0 +1,32 @@
+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'
+
+export class PersistentPlayoutStateStore implements BlueprintPlayoutPersistentStore {
+	#state: TimelinePersistentState | undefined
+	#hasChanges = false
+
+	get hasChanges(): boolean {
+		return this.#hasChanges
+	}
+
+	constructor(state: TimelinePersistentState | undefined) {
+		this.#state = clone(state)
+	}
+
+	getAll(): Partial<unknown> {
+		return this.#state || {}
+	}
+	getKey<K extends never>(k: K): unknown {
+		return this.#state?.[k]
+	}
+	setKey<K extends never>(k: K, v: unknown): void {
+		if (!this.#state) this.#state = {}
+		;(this.#state as any)[k] = v
+		this.#hasChanges = true
+	}
+	setAll(obj: unknown): void {
+		this.#state = obj
+		this.#hasChanges = true
+	}
+}

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

@@ -34,6 +34,7 @@ import { convertNoteToNotification } from '../notifications/util'
 import type { INoteBase } from '@sofie-automation/corelib/dist/dataModel/Notes'
 import { NotificationsModelHelper } from '../notifications/NotificationsModelHelper'
 import type { INotificationsModel } from '../notifications/NotificationsModel'
+import { PersistentPlayoutStateStore } from '../blueprints/context/services/PersistantStateStore'
 
 /**
  * Execute an AdLib Action
@@ -230,15 +231,22 @@ export async function executeActionInner(
 	)
 
 	try {
+		const blueprintPersistentState = new PersistentPlayoutStateStore(playoutModel.playlist.previousPersistentState)
+
 		await blueprint.blueprint.executeAction(
 			actionContext,
+			blueprintPersistentState,
 			actionParameters.actionId,
 			actionParameters.userData,
 			actionParameters.triggerMode,
 			actionParameters.privateData,
 			actionParameters.publicData,
 			actionParameters.actionOptions ?? {}
 		)
+
+		if (blueprintPersistentState.hasChanges) {
+			playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
+		}
 	} catch (err) {
 		logger.error(`Error in showStyleBlueprint.executeAction: ${stringifyError(err)}`)
 		throw UserError.fromUnknown(err)

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

@@ -317,17 +317,21 @@ export interface PlayoutModel extends PlayoutModelReadonly, StudioPlayoutModelBa
 	setHoldState(newState: RundownHoldState): void
 
 	/**
-	 * Store the persistent results of the AB playback resolving and onTimelineGenerate
-	 * @param persistentState Blueprint owned state from onTimelineGenerate
+	 * Store the persistent results of the AB playback resolving
 	 * @param assignedAbSessions The applied AB sessions
 	 * @param trackedAbSessions The known AB sessions
 	 */
-	setOnTimelineGenerateResult(
-		persistentState: unknown | undefined,
+	setAbResolvingState(
 		assignedAbSessions: Record<string, ABSessionAssignments>,
 		trackedAbSessions: ABSessionInfo[]
 	): void
 
+	/**
+	 * Store the blueprint persistent state
+	 * @param persistentState Blueprint owned state
+	 */
+	setBlueprintPersistentState(persistentState: unknown | undefined): void
+
 	/**
 	 * Set a PartInstance as the nexted PartInstance
 	 * @param partInstance PartInstance to be set as next, or none

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

@@ -727,18 +727,22 @@ export class PlayoutModelImpl extends PlayoutModelReadonlyImpl implements Playou
 		this.#playlistHasChanged = true
 	}
 
-	setOnTimelineGenerateResult(
-		persistentState: unknown | undefined,
+	setAbResolvingState(
 		assignedAbSessions: Record<string, ABSessionAssignments>,
 		trackedAbSessions: ABSessionInfo[]
 	): void {
-		this.playlistImpl.previousPersistentState = persistentState
 		this.playlistImpl.assignedAbSessions = assignedAbSessions
 		this.playlistImpl.trackedAbSessions = trackedAbSessions
 
 		this.#playlistHasChanged = true
 	}
 
+	setBlueprintPersistentState(persistentState: unknown | undefined): void {
+		this.playlistImpl.previousPersistentState = persistentState
+
+		this.#playlistHasChanged = true
+	}
+
 	setPartInstanceAsNext(
 		partInstance: PlayoutPartInstanceModel | null,
 		setManually: boolean,

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

@@ -31,6 +31,7 @@ import {
 } from '../blueprints/context/services/PartAndPieceInstanceActionService'
 import { NoteSeverity } from '@sofie-automation/blueprints-integration'
 import { convertNoteToNotification } from '../notifications/util'
+import { PersistentPlayoutStateStore } from '../blueprints/context/services/PersistantStateStore'
 
 /**
  * Set or clear the nexted part, from a given PartInstance, or SelectNextPartResult
@@ -225,9 +226,15 @@ async function executeOnSetAsNextCallback(
 	playoutModel.clearAllNotifications(NOTIFICATION_CATEGORY)
 
 	try {
-		await blueprint.blueprint.onSetAsNext(onSetAsNextContext)
+		const blueprintPersistentState = new PersistentPlayoutStateStore(playoutModel.playlist.previousPersistentState)
+
+		await blueprint.blueprint.onSetAsNext(onSetAsNextContext, blueprintPersistentState)
 		await applyOnSetAsNextSideEffects(context, playoutModel, onSetAsNextContext)
 
+		if (blueprintPersistentState.hasChanges) {
+			playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
+		}
+
 		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
 			playoutModel.setNotification(NOTIFICATION_CATEGORY, {

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

@@ -34,6 +34,7 @@ import {
 } from '../blueprints/context/services/PartAndPieceInstanceActionService'
 import { PlayoutRundownModel } from './model/PlayoutRundownModel'
 import { convertNoteToNotification } from '../notifications/util'
+import { PersistentPlayoutStateStore } from '../blueprints/context/services/PersistantStateStore'
 
 /**
  * Take the currently Next:ed Part (start playing it)
@@ -316,10 +317,18 @@ async function executeOnTakeCallback(
 			new PartAndPieceInstanceActionService(context, playoutModel, showStyle, currentRundown)
 		)
 		try {
-			await blueprint.blueprint.onTake(onSetAsNextContext)
+			const blueprintPersistentState = new PersistentPlayoutStateStore(
+				playoutModel.playlist.previousPersistentState
+			)
+
+			await blueprint.blueprint.onTake(onSetAsNextContext, blueprintPersistentState)
 			await applyOnTakeSideEffects(context, playoutModel, onSetAsNextContext)
 			isTakeAborted = onSetAsNextContext.isTakeAborted
 
+			if (blueprintPersistentState.hasChanges) {
+				playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
+			}
+
 			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
 				playoutModel.setNotification(NOTIFICATION_CATEGORY, {
@@ -511,13 +520,19 @@ export function updatePartInstanceOnTake(
 				context.getShowStyleBlueprintConfig(showStyle),
 				takeRundown
 			)
+			const blueprintPersistentState = new PersistentPlayoutStateStore(
+				playoutModel.playlist.previousPersistentState
+			)
 			previousPartEndState = blueprint.blueprint.getEndStateForPart(
 				context2,
-				playoutModel.playlist.previousPersistentState,
+				blueprintPersistentState,
 				convertPartInstanceToBlueprints(currentPartInstance.partInstance),
 				resolvedPieces.map(convertResolvedPieceInstanceToBlueprints),
 				time
 			)
+			if (blueprintPersistentState.hasChanges) {
+				playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
+			}
 			if (span) span.end()
 			logger.info(`Calculated end state in ${getCurrentTime() - time}ms`)
 		} catch (err) {