feat: replace wasActive in onRundownActivate with context (Sofie-Automation#1514)

feat: replace `wasActive` in onRundownActivate with previousState&currentState in RundownActivationContext. Also changed the algorithm in handleResetRundownPlaylist, so that activateRundownPlaylist always runs

This is to provide better context for blueprints, so that they can determine if a RundownPlaylist is being Activated from idle, from Rehersal or a Reset

Author: nytamin

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

@@ -195,8 +195,13 @@ export interface ShowStyleBlueprintManifest<TRawConfig = IBlueprintConfig, TProc
 
 	// Events
 
-	onRundownActivate?: (context: IRundownActivationContext, wasActive: boolean) => Promise<void>
+	/**
+	 * Called when a RundownPlaylist has been activated
+	 */
+	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 */
 	onRundownDeActivate?: (context: IRundownActivationContext) => Promise<void>
 
 	/** Called before a Take action */

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

@@ -13,7 +13,11 @@ export interface IRundownContext extends IShowStyleContext {
 
 export interface IRundownUserContext extends IUserNotesContext, IRundownContext {}
 
-export interface IRundownActivationContext extends IRundownContext, IExecuteTSRActionsContext, IDataStoreMethods {}
+export interface IRundownActivationContext extends IRundownContext, IExecuteTSRActionsContext, IDataStoreMethods {
+	/** Info about the RundownPlaylist state before the Activation / Deactivation event */
+	readonly previousState: IRundownActivationContextState
+	readonly currentState: IRundownActivationContextState
+}
 
 export interface ISegmentUserContext extends IUserNotesContext, IRundownContext, IPackageInfoContext {
 	/** Display a notification to the user of an error */
@@ -23,3 +27,13 @@ export interface ISegmentUserContext extends IUserNotesContext, IRundownContext,
 	/** Display a notification to the user of a note */
 	notifyUserInfo: (message: string, params?: { [key: string]: any }, partExternalId?: string) => void
 }
+
+/** Info about the RundownPlaylist state at a point in time */
+export interface IRundownActivationContextState {
+	/** If the playlist was active */
+	active: boolean
+	/** If the playlist was in rehearsal mode */
+	rehearsal: boolean
+	/** Timestamp when the playlist was last reset. Used to silence a few errors upon reset.*/
+	resetTime?: number
+}

packages/corelib/src/worker/studio.ts

@@ -238,7 +238,9 @@ export type ActivateHoldProps = RundownPlayoutPropsBase
 export type DeactivateHoldProps = RundownPlayoutPropsBase
 export type PrepareRundownForBroadcastProps = RundownPlayoutPropsBase
 export interface ResetRundownPlaylistProps extends RundownPlayoutPropsBase {
+	/** If set, also activate the RundownPlaylist */
 	activate?: 'active' | 'rehearsal'
+	/** If true and `activate` is set, deactivates any other active Playlists and activates this one. */
 	forceActivate?: boolean
 }
 export interface ActivateRundownPlaylistProps extends RundownPlayoutPropsBase {

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

@@ -2,6 +2,7 @@ import {
 	DatastorePersistenceMode,
 	IBlueprintPlayoutDevice,
 	IRundownActivationContext,
+	IRundownActivationContextState,
 	TSR,
 } from '@sofie-automation/blueprints-integration'
 import { PeripheralDeviceId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
@@ -17,22 +18,38 @@ export class RundownActivationContext extends RundownEventContext implements IRu
 	private readonly _playoutModel: PlayoutModel
 	private readonly _context: JobContext
 
+	private readonly _previousState: IRundownActivationContextState
+	private readonly _currentState: IRundownActivationContextState
+
 	constructor(
 		context: JobContext,
-		playoutModel: PlayoutModel,
-		showStyleCompound: ReadonlyDeep<ProcessedShowStyleCompound>,
-		rundown: ReadonlyDeep<DBRundown>
+		options: {
+			playoutModel: PlayoutModel
+			showStyle: ReadonlyDeep<ProcessedShowStyleCompound>
+			rundown: ReadonlyDeep<DBRundown>
+			previousState: IRundownActivationContextState
+			currentState: IRundownActivationContextState
+		}
 	) {
 		super(
 			context.studio,
 			context.getStudioBlueprintConfig(),
-			showStyleCompound,
-			context.getShowStyleBlueprintConfig(showStyleCompound),
-			rundown
+			options.showStyle,
+			context.getShowStyleBlueprintConfig(options.showStyle),
+			options.rundown
 		)
 
 		this._context = context
-		this._playoutModel = playoutModel
+		this._playoutModel = options.playoutModel
+		this._previousState = options.previousState
+		this._currentState = options.currentState
+	}
+
+	get previousState(): IRundownActivationContextState {
+		return this._previousState
+	}
+	get currentState(): IRundownActivationContextState {
+		return this._currentState
 	}
 
 	async listPlayoutDevices(): Promise<IBlueprintPlayoutDevice[]> {

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

@@ -8,7 +8,7 @@ import { getCurrentTime } from '../lib/index.js'
 import { logger } from '../logging.js'
 import { getActiveRundownPlaylistsInStudioFromDb } from '../studio/lib.js'
 import { cleanTimelineDatastore } from './datastore.js'
-import { resetRundownPlaylist } from './lib.js'
+import { getActivationContextState, resetRundownPlaylist } from './lib.js'
 import { PlayoutModel } from './model/PlayoutModel.js'
 import { selectNextPart } from './selectNextPart.js'
 import { setNextPart } from './setNext.js'
@@ -17,12 +17,12 @@ import { updateStudioTimeline, updateTimeline } from './timeline/generate.js'
 export async function activateRundownPlaylist(
 	context: JobContext,
 	playoutModel: PlayoutModel,
-	rehearsal: boolean
+	rehearsal: boolean,
+	forceReset?: boolean
 ): Promise<void> {
 	logger.info('Activating rundown ' + playoutModel.playlist._id + (rehearsal ? ' (Rehearsal)' : ''))
 
 	rehearsal = !!rehearsal
-	const wasActive = !!playoutModel.playlist.activationId
 
 	const anyOtherActiveRundowns = await getActiveRundownPlaylistsInStudioFromDb(
 		context,
@@ -37,8 +37,10 @@ export async function activateRundownPlaylist(
 				JSON.stringify(otherActiveIds)
 		)
 	}
+	// Get the ActivationContext state, for later use. (This must be done before any actions are done on the PlayoutModel)
+	const previousState = getActivationContextState(playoutModel)
 
-	if (!playoutModel.playlist.activationId) {
+	if (!playoutModel.playlist.activationId || forceReset) {
 		// Reset the playlist if it wasnt already active
 		await resetRundownPlaylist(context, playoutModel)
 	}
@@ -93,37 +95,58 @@ export async function activateRundownPlaylist(
 
 	await updateTimeline(context, playoutModel)
 
+	// Get the ActivationContext state, for later use. (This must be done after all actions are done on the PlayoutModel)
+	const currentState = getActivationContextState(playoutModel)
+
 	playoutModel.deferBeforeSave(async () => {
 		if (!rundown) return // if the proper rundown hasn't been found, there's little point doing anything else
 		const showStyle = await context.getShowStyleCompound(rundown.showStyleVariantId, rundown.showStyleBaseId)
 		const blueprint = await context.getShowStyleBlueprint(showStyle._id)
 
 		try {
 			if (blueprint.blueprint.onRundownActivate) {
-				const blueprintContext = new RundownActivationContext(context, playoutModel, showStyle, rundown)
-
-				await blueprint.blueprint.onRundownActivate(blueprintContext, wasActive)
+				const blueprintContext = new RundownActivationContext(context, {
+					playoutModel,
+					showStyle,
+					rundown,
+					previousState,
+					currentState,
+				})
+
+				await blueprint.blueprint.onRundownActivate(blueprintContext)
 			}
 		} catch (err) {
 			logger.error(`Error in showStyleBlueprint.onRundownActivate: ${stringifyError(err)}`)
 		}
 	})
 }
 export async function deactivateRundownPlaylist(context: JobContext, playoutModel: PlayoutModel): Promise<void> {
+	// Get the ActivationContext state, for later use. (This must be done before any actions are done on the PlayoutModel)
+	const previousState = getActivationContextState(playoutModel)
+
 	const rundown = await deactivateRundownPlaylistInner(context, playoutModel)
 
 	await updateStudioTimeline(context, playoutModel)
 
 	await cleanTimelineDatastore(context, playoutModel)
 
+	// Get the ActivationContext state, for later use. (This must be done after all actions are done on the PlayoutModel)
+	const currentState = getActivationContextState(playoutModel)
+
 	playoutModel.deferBeforeSave(async () => {
 		if (rundown) {
 			const showStyle = await context.getShowStyleCompound(rundown.showStyleVariantId, rundown.showStyleBaseId)
 			const blueprint = await context.getShowStyleBlueprint(showStyle._id)
 
 			try {
 				if (blueprint.blueprint.onRundownDeActivate) {
-					const blueprintContext = new RundownActivationContext(context, playoutModel, showStyle, rundown)
+					const blueprintContext = new RundownActivationContext(context, {
+						playoutModel,
+						showStyle,
+						rundown,
+						previousState,
+						currentState,
+					})
 					await blueprint.blueprint.onRundownDeActivate(blueprintContext)
 				}
 			} catch (err) {

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

@@ -9,7 +9,6 @@ import {
 import { JobContext } from '../jobs/index.js'
 import { runJobWithPlayoutModel } from './lock.js'
 import { resetRundownPlaylist } from './lib.js'
-import { updateTimeline } from './timeline/generate.js'
 import { getActiveRundownPlaylistsInStudioFromDb } from '../studio/lib.js'
 import {
 	activateRundownPlaylist,
@@ -53,9 +52,7 @@ export async function handlePrepareRundownPlaylistForBroadcast(
 			await checkNoOtherPlaylistsActive(context, playlist)
 		},
 		async (playoutModel) => {
-			await resetRundownPlaylist(context, playoutModel)
-
-			await activateRundownPlaylist(context, playoutModel, true) // Activate rundownPlaylist (rehearsal)
+			await activateRundownPlaylist(context, playoutModel, true, true) // Activate rundownPlaylist (rehearsal)
 		}
 	)
 }
@@ -110,14 +107,16 @@ export async function handleResetRundownPlaylist(context: JobContext, data: Rese
 			}
 		},
 		async (playoutModel) => {
-			await resetRundownPlaylist(context, playoutModel)
+			if (playoutModel.playlist.activationId || data.activate !== undefined) {
+				const goToRehearsal =
+					data.activate === undefined
+						? (playoutModel.playlist.rehearsal ?? false)
+						: data.activate === 'rehearsal'
 
-			if (data.activate) {
-				// Do the activation
-				await activateRundownPlaylist(context, playoutModel, data.activate !== 'active') // Activate rundown
-			} else if (playoutModel.playlist.activationId) {
-				// Only update the timeline if this is the active playlist
-				await updateTimeline(context, playoutModel)
+				await activateRundownPlaylist(context, playoutModel, goToRehearsal, true) // Activate rundown
+			} else {
+				// If the Playlist is inactive, and we are not activating it, just reset it:
+				await resetRundownPlaylist(context, playoutModel)
 			}
 		}
 	)

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

@@ -1,6 +1,6 @@
 import { TimelineObjGeneric } from '@sofie-automation/corelib/dist/dataModel/Timeline'
 import { applyToArray, clone } from '@sofie-automation/corelib/dist/lib'
-import { TSR } from '@sofie-automation/blueprints-integration'
+import { TSR, IRundownActivationContextState } from '@sofie-automation/blueprints-integration'
 import { JobContext } from '../jobs/index.js'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 import { PartInstanceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
@@ -203,3 +203,10 @@ export async function updateTimelineFromStudioPlayoutModel(
 		await updateStudioTimeline(context, studioPlayoutModel)
 	}
 }
+export function getActivationContextState(playoutModel: PlayoutModel): IRundownActivationContextState {
+	return {
+		active: playoutModel.playlist.activationId ? true : false,
+		rehearsal: playoutModel.playlist.rehearsal ? true : false,
+		resetTime: playoutModel.playlist.resetTime,
+	}
+}