feat: Allow blueprints to request that syncIngestUpdateToPartInstance is run

Author: PeterC89

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

@@ -3,6 +3,14 @@ import type { IStudioContext } from './studioContext.js'
 import type { IngestDefaultChangesOptions, MutableIngestRundown, NrcsIngestChangeDetails } from '../ingest.js'
 
 export interface IProcessIngestDataContext extends IStudioContext {
+	/**
+	 * Request that `syncIngestUpdateToPartInstance` should be executed for the active PartInstances
+	 * in this ingest operation, even if it would otherwise be skipped.
+	 *
+	 * The request is one-shot and only applies to the current ingest operation.
+	 */
+	requestSyncIngestUpdateToPartInstance(): void
+
 	/**
 	 * Perform the default syncing of changes from the ingest data to the rundown.
 	 *

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

@@ -20,6 +20,18 @@ import {
  * Custom updates of the IngestRundown are done by calling methods on the mutableIngestRundown itself.
  */
 export class ProcessIngestDataContext extends StudioContext implements IProcessIngestDataContext {
+	#requestSyncIngestUpdateToPartInstance = false
+
+	requestSyncIngestUpdateToPartInstance(): void {
+		this.#requestSyncIngestUpdateToPartInstance = true
+	}
+
+	consumeRequestSyncIngestUpdateToPartInstance(): boolean {
+		const shouldRequest = this.#requestSyncIngestUpdateToPartInstance
+		this.#requestSyncIngestUpdateToPartInstance = false
+		return shouldRequest
+	}
+
 	defaultApplyIngestChanges<TRundownPayload, TSegmentPayload, TPartPayload>(
 		mutableIngestRundown: MutableIngestRundown<TRundownPayload, TSegmentPayload, TPartPayload>,
 		nrcsIngestRundown: IngestRundown,

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

@@ -0,0 +1,37 @@
+import { setupDefaultJobEnvironment } from '../../../__mocks__/context.js'
+import { ProcessIngestDataContext } from '../ProcessIngestDataContext.js'
+
+describe('ProcessIngestDataContext', () => {
+	function createContext(): ProcessIngestDataContext {
+		const jobContext = setupDefaultJobEnvironment()
+
+		return new ProcessIngestDataContext(
+			{
+				name: 'test',
+				identifier: 'test',
+			},
+			jobContext.studio,
+			jobContext.getStudioBlueprintConfig()
+		)
+	}
+
+	test('requestSyncIngestUpdateToPartInstance is one-shot', () => {
+		const context = createContext()
+
+		expect(context.consumeRequestSyncIngestUpdateToPartInstance()).toBe(false)
+
+		context.requestSyncIngestUpdateToPartInstance()
+		expect(context.consumeRequestSyncIngestUpdateToPartInstance()).toBe(true)
+		expect(context.consumeRequestSyncIngestUpdateToPartInstance()).toBe(false)
+	})
+
+	test('multiple requests collapse into a single consume result', () => {
+		const context = createContext()
+
+		context.requestSyncIngestUpdateToPartInstance()
+		context.requestSyncIngestUpdateToPartInstance()
+
+		expect(context.consumeRequestSyncIngestUpdateToPartInstance()).toBe(true)
+		expect(context.consumeRequestSyncIngestUpdateToPartInstance()).toBe(false)
+	})
+})

packages/job-worker/src/ingest/commit.ts

@@ -230,7 +230,12 @@ export async function CommitIngestOperation(
 
 			try {
 				// sync changes to the 'selected' partInstances
-				await syncChangesToPartInstances(context, playoutModel, ingestModel)
+				await syncChangesToPartInstances(
+					context,
+					playoutModel,
+					ingestModel,
+					data.forceSyncIngestUpdateToPartInstance
+				)
 
 				// update the quickloop in case we did any changes to things involving marker
 				playoutModel.updateQuickLoopState()

packages/job-worker/src/ingest/lock.ts

@@ -25,6 +25,9 @@ export interface CommitIngestData {
 	/** Set to true if the rundown should be removed or orphaned */
 	removeRundown: boolean
 
+	/** Force execution of syncIngestUpdateToPartInstance for this commit operation */
+	forceSyncIngestUpdateToPartInstance?: boolean
+
 	/** Whether to return an error if the rundown is unable to be removed */
 	returnRemoveFailure?: boolean
 }

packages/job-worker/src/ingest/runOperation.ts

@@ -53,6 +53,11 @@ export interface ComputedIngestChangeObject {
 	regenerateRundown: boolean // Future: full vs metadata?
 
 	segmentExternalIdChanges: Record<string, string> // old -> new
+
+	/**
+	 * Force an execution of syncIngestUpdateToPartInstance for this ingest operation.
+	 */
+	forceSyncIngestUpdateToPartInstance?: boolean
 }
 
 export type ComputedIngestChanges = ComputedIngestChangeObject | ComputedIngestChangeAction
@@ -335,12 +340,16 @@ async function updateSofieIngestRundown(
 
 		const ingestObjectGenerator = new SofieIngestRundownDataCacheGenerator(rundownId)
 		const resultChanges = mutableIngestRundown.intoIngestRundown(ingestObjectGenerator)
+		const forceSyncIngestUpdateToPartInstance = blueprintContext.consumeRequestSyncIngestUpdateToPartInstance()
 
 		// Sync changes to the cache
 		sofieIngestObjectCache.replaceDocuments(resultChanges.changedCacheObjects)
 		sofieIngestObjectCache.removeAllOtherDocuments(resultChanges.allCacheObjectIds)
 
-		return resultChanges.computedChanges
+		return {
+			...resultChanges.computedChanges,
+			forceSyncIngestUpdateToPartInstance,
+		}
 	}
 }
 
@@ -438,13 +447,15 @@ async function applyCalculatedIngestChangesToModel(
 		if (result) {
 			return {
 				...result,
+				forceSyncIngestUpdateToPartInstance: computedIngestChanges.forceSyncIngestUpdateToPartInstance,
 				renamedSegments,
 			}
 		} else {
 			return {
 				changedSegmentIds: [],
 				removedSegmentIds: [],
 				removeRundown: false,
+				forceSyncIngestUpdateToPartInstance: computedIngestChanges.forceSyncIngestUpdateToPartInstance,
 				renamedSegments,
 			}
 		}
@@ -480,6 +491,7 @@ async function applyCalculatedIngestChangesToModel(
 				return {
 					changedSegmentIds: regeneratedSegmentIds.changedSegmentIds,
 					removedSegmentIds: regeneratedSegmentIds.removedSegmentIds,
+					forceSyncIngestUpdateToPartInstance: computedIngestChanges.forceSyncIngestUpdateToPartInstance,
 					renamedSegments: renamedSegments,
 
 					removeRundown: false,
@@ -520,6 +532,7 @@ async function applyCalculatedIngestChangesToModel(
 		return {
 			changedSegmentIds: Array.from(changedSegmentIdsSet),
 			removedSegmentIds: orphanedSegmentIds, // Only inform about the ones that werent renamed
+			forceSyncIngestUpdateToPartInstance: computedIngestChanges.forceSyncIngestUpdateToPartInstance,
 			renamedSegments: renamedSegments,
 
 			removeRundown: false,

packages/job-worker/src/ingest/syncChangesToPartInstance.ts

@@ -58,7 +58,8 @@ export interface PartInstanceToSync {
 export async function syncChangesToPartInstances(
 	context: JobContext,
 	playoutModel: PlayoutModel,
-	ingestModel: IngestModelReadonly
+	ingestModel: IngestModelReadonly,
+	forceSyncIngestUpdateToPartInstance = false
 ): Promise<void> {
 	if (!playoutModel.playlist.activationId) return
 
@@ -76,7 +77,13 @@ export async function syncChangesToPartInstances(
 		return
 	}
 
-	const instancesToSync = findInstancesToSync(context, playoutModel, ingestModel, playoutRundownModel)
+	const instancesToSync = findInstancesToSync(
+		context,
+		playoutModel,
+		ingestModel,
+		playoutRundownModel,
+		forceSyncIngestUpdateToPartInstance
+	)
 
 	const worker = new SyncChangesToPartInstancesWorker(context, playoutModel, ingestModel, showStyle, blueprint)
 
@@ -299,7 +306,8 @@ export function findInstancesToSync(
 	context: JobContext,
 	playoutModel: PlayoutModel,
 	ingestModel: IngestModelReadonly,
-	playoutRundownModel: PlayoutRundownModel
+	playoutRundownModel: PlayoutRundownModel,
+	_forceSyncIngestUpdateToPartInstance = false
 ): PartInstanceToSync[] {
 	const currentPartInstance = playoutModel.currentPartInstance
 	const nextPartInstance = playoutModel.nextPartInstance