wip: first draft

Author: Julusian

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

@@ -112,7 +112,6 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 		context: ISyncIngestUpdateToPartInstanceContext,
 		existingPartInstance: BlueprintSyncIngestPartInstance,
 		newData: BlueprintSyncIngestNewData,
-
 		playoutStatus: 'previous' | 'current' | 'next'
 	) => void
 
@@ -123,7 +122,6 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 	 */
 	executeDataStoreAction?: (
 		context: IDataStoreActionExecutionContext,
-		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>,
 		actionId: string,
 		userData: ActionUserData,
 		triggerMode?: string

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) {

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

@@ -1,13 +1,7 @@
 import { BlueprintId, TimelineHash } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { JobContext, JobStudio } from '../../jobs'
 import { ReadonlyDeep } from 'type-fest'
-import {
-	BlueprintResultBaseline,
-	BlueprintResultTimeline,
-	OnGenerateTimelineObj,
-	Time,
-	TSR,
-} from '@sofie-automation/blueprints-integration'
+import { BlueprintResultBaseline, OnGenerateTimelineObj, Time, TSR } from '@sofie-automation/blueprints-integration'
 import {
 	deserializeTimelineBlob,
 	OnGenerateTimelineObjExt,
@@ -46,6 +40,7 @@ import { getPartTimingsOrDefaults, PartCalculatedTimings } from '@sofie-automati
 import { applyAbPlaybackForTimeline } from '../abPlayback'
 import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyError'
 import { PlayoutPartInstanceModel } from '../model/PlayoutPartInstanceModel'
+import { PersistentPlayoutStateStore } from '../../blueprints/context/services/PersistantStateStore'
 
 function isModelForStudio(model: StudioPlayoutModelBase): model is StudioPlayoutModel {
 	const tmp = model as StudioPlayoutModel
@@ -388,14 +383,17 @@ async function getTimelineRundown(
 						})
 					}
 
-					let tlGenRes: BlueprintResultTimeline | undefined
 					if (blueprint.blueprint.onTimelineGenerate) {
+						const blueprintPersistentState = new PersistentPlayoutStateStore(
+							playoutModel.playlist.previousPersistentState
+						)
+
 						const span = context.startSpan('blueprint.onTimelineGenerate')
 						const influxTrace = startTrace('blueprints:onTimelineGenerate')
-						tlGenRes = await blueprint.blueprint.onTimelineGenerate(
+						const tlGenRes = await blueprint.blueprint.onTimelineGenerate(
 							blueprintContext,
 							timelineObjs,
-							clone(playoutModel.playlist.previousPersistentState),
+							blueprintPersistentState,
 							clone(currentPartInstance?.partInstance?.previousPartEndState),
 							resolvedPieces.map(convertResolvedPieceInstanceToBlueprints)
 						)
@@ -408,10 +406,13 @@ async function getTimelineRundown(
 								objectType: TimelineObjType.RUNDOWN,
 							})
 						})
+
+						if (blueprintPersistentState.hasChanges) {
+							playoutModel.setBlueprintPersistentState(blueprintPersistentState.getAll())
+						}
 					}
 
-					playoutModel.setOnTimelineGenerateResult(
-						tlGenRes?.persistentState,
+					playoutModel.setAbResolvingState(
 						newAbSessionsResult.assignments,
 						blueprintContext.abSessionsHelper.knownSessions
 					)