feat: add ITTimersContext to IPartEventContext (Sofie-Automation#1705)

Author: Julusian

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

@@ -228,7 +228,10 @@ export interface ShowStyleBlueprintManifest<
 		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>
 	) => Promise<void>
 	/** Called after a Take action */
-	onPostTake?: (context: IPartEventContext) => Promise<void>
+	onPostTake?: (
+		context: IPartEventContext,
+		playoutPersistentState: BlueprintPlayoutPersistentStore<TimelinePersistentState>
+	) => Promise<void>
 
 	/**
 	 * Called when a part is set as Next, including right after a Take.

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

@@ -2,7 +2,8 @@ import type { OnGenerateTimelineObj, TSR } from '../timeline.js'
 import type { IBlueprintPartInstance, IBlueprintPieceInstance, IBlueprintSegmentDB } from '../documents/index.js'
 import type { IRundownContext } from './rundownContext.js'
 import type { IBlueprintExternalMessageQueueObj } from '../message.js'
-import { BlueprintQuickLookInfo } from './quickLoopInfo.js'
+import type { BlueprintQuickLookInfo } from './quickLoopInfo.js'
+import type { ITTimersContext } from './tTimersContext.js'
 
 export interface IEventContext {
 	getCurrentTime(): number
@@ -33,7 +34,7 @@ export interface ITimelineEventContext extends IEventContext, IRundownContext {
 	): string | undefined
 }
 
-export interface IPartEventContext extends IEventContext, IRundownContext {
+export interface IPartEventContext extends IEventContext, IRundownContext, ITTimersContext {
 	readonly part: Readonly<IBlueprintPartInstance>
 }
 

packages/job-worker/src/blueprints/__tests__/context-events.test.ts

@@ -14,6 +14,8 @@ import { ReadonlyDeep } from 'type-fest'
 import { convertPartInstanceToBlueprints } from '../context/lib.js'
 import { EmptyPieceTimelineObjectsBlob } from '@sofie-automation/corelib/dist/dataModel/Piece'
 import { ProcessedShowStyleCompound } from '../../jobs/index.js'
+import type { PlayoutModel } from '../../playout/model/PlayoutModel.js'
+import { mock } from 'jest-mock-extended'
 
 describe('Test blueprint api context', () => {
 	async function generateSparsePieceInstances(rundown: DBRundown) {
@@ -76,22 +78,25 @@ describe('Test blueprint api context', () => {
 			)) as DBRundownPlaylist
 			expect(playlist).toBeTruthy()
 
-			const showStyleConfig = jobContext.getShowStyleBlueprintConfig(showStyle)
+			const playoutModel = mock<PlayoutModel>()
+			const mockPlaylist = {
+				tTimers: [
+					{ index: 1, label: 'Timer 1', mode: null, state: null },
+					{ index: 2, label: 'Timer 2', mode: null, state: null },
+					{ index: 3, label: 'Timer 3', mode: null, state: null },
+				],
+			} as unknown as ReadonlyDeep<DBRundownPlaylist>
+			Object.defineProperty(playoutModel, 'playlist', {
+				get: () => mockPlaylist,
+				configurable: true,
+			})
 
 			const mockPart = {
 				_id: protectString('not-a-real-part'),
 			}
 
 			const tmpPart = wrapPartToTemporaryInstance(protectString('active'), mockPart as DBPart)
-			const context = new PartEventContext(
-				'fake',
-				jobContext.studio,
-				jobContext.getStudioBlueprintConfig(),
-				showStyle,
-				showStyleConfig,
-				rundown,
-				tmpPart
-			)
+			const context = new PartEventContext(jobContext, playoutModel, 'fake', showStyle, rundown, tmpPart)
 			expect(context.studio).toBeTruthy()
 
 			expect(context.part).toEqual(convertPartInstanceToBlueprints(tmpPart))

packages/job-worker/src/blueprints/context/PartEventContext.ts

@@ -1,22 +1,26 @@
-import { IBlueprintPartInstance, IPartEventContext } from '@sofie-automation/blueprints-integration'
-import { ReadonlyDeep } from 'type-fest'
-import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
-import { DBRundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
+import type { IBlueprintPartInstance, IPartEventContext } from '@sofie-automation/blueprints-integration'
+import type { ReadonlyDeep } from 'type-fest'
+import type { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
+import type { DBRundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
 import { getCurrentTime } from '../../lib/index.js'
-import { ProcessedStudioConfig, ProcessedShowStyleConfig } from '../config.js'
-import { JobStudio, ProcessedShowStyleCompound } from '../../jobs/index.js'
+import type { JobContext, ProcessedShowStyleCompound } from '../../jobs/index.js'
 import { convertPartInstanceToBlueprints } from './lib.js'
 import { RundownContext } from './RundownContext.js'
+import { TTimersService } from './services/TTimersService.js'
+import type { PlayoutModel } from '../../playout/model/PlayoutModel.js'
+import type { IPlaylistTTimer } from '@sofie-automation/blueprints-integration/dist/context/tTimersContext'
+import type { RundownTTimerIndex } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 
 export class PartEventContext extends RundownContext implements IPartEventContext {
+	readonly #tTimersService: TTimersService
+
 	readonly part: Readonly<IBlueprintPartInstance>
 
 	constructor(
+		context: JobContext,
+		playoutModel: PlayoutModel,
 		eventName: string,
-		studio: ReadonlyDeep<JobStudio>,
-		studioBlueprintConfig: ProcessedStudioConfig,
 		showStyleCompound: ReadonlyDeep<ProcessedShowStyleCompound>,
-		showStyleBlueprintConfig: ProcessedShowStyleConfig,
 		rundown: ReadonlyDeep<DBRundown>,
 		partInstance: ReadonlyDeep<DBPartInstance>
 	) {
@@ -25,17 +29,25 @@ export class PartEventContext extends RundownContext implements IPartEventContex
 				name: `Event: ${eventName}`,
 				identifier: `rundownId=${rundown._id},blueprintId=${showStyleCompound.blueprintId}`,
 			},
-			studio,
-			studioBlueprintConfig,
+			context.studio,
+			context.getStudioBlueprintConfig(),
 			showStyleCompound,
-			showStyleBlueprintConfig,
+			context.getShowStyleBlueprintConfig(showStyleCompound),
 			rundown
 		)
 
+		this.#tTimersService = TTimersService.withPlayoutModel(playoutModel, context)
 		this.part = convertPartInstanceToBlueprints(partInstance)
 	}
 
 	getCurrentTime(): number {
 		return getCurrentTime()
 	}
+
+	getTimer(index: RundownTTimerIndex): IPlaylistTTimer {
+		return this.#tTimersService.getTimer(index)
+	}
+	clearAllTimers(): void {
+		this.#tTimersService.clearAllTimers()
+	}
 }

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

@@ -259,11 +259,10 @@ export async function performTakeToNextedPart(
 		try {
 			await blueprint.blueprint.onPreTake(
 				new PartEventContext(
+					context,
+					playoutModel,
 					'onPreTake',
-					context.studio,
-					context.getStudioBlueprintConfig(),
 					showStyle,
-					context.getShowStyleBlueprintConfig(showStyle),
 					takeRundown.rundown,
 					takePartInstance.partInstance
 				)
@@ -501,11 +500,10 @@ async function afterTakeUpdateTimingsAndEvents(
 				try {
 					await blueprint.blueprint.onRundownFirstTake(
 						new PartEventContext(
+							context,
+							playoutModel,
 							'onRundownFirstTake',
-							context.studio,
-							context.getStudioBlueprintConfig(),
 							showStyle,
-							context.getShowStyleBlueprintConfig(showStyle),
 							takeRundown.rundown,
 							takePartInstance.partInstance
 						)
@@ -520,17 +518,24 @@ async function afterTakeUpdateTimingsAndEvents(
 		if (blueprint.blueprint.onPostTake && takeRundown) {
 			const span = context.startSpan('blueprint.onPostTake')
 			try {
+				const blueprintPersistentState = new PersistentPlayoutStateStore(
+					playoutModel.playlist.privatePlayoutPersistentState,
+					playoutModel.playlist.publicPlayoutPersistentState
+				)
+
 				await blueprint.blueprint.onPostTake(
 					new PartEventContext(
+						context,
+						playoutModel,
 						'onPostTake',
-						context.studio,
-						context.getStudioBlueprintConfig(),
 						showStyle,
-						context.getShowStyleBlueprintConfig(showStyle),
 						takeRundown.rundown,
 						takePartInstance.partInstance
-					)
+					),
+					blueprintPersistentState
 				)
+
+				blueprintPersistentState.saveToModel(playoutModel)
 			} catch (err) {
 				logger.error(`Error in showStyleBlueprint.onPostTake: ${stringifyError(err)}`)
 			}