feat: partInstances invalid state

Author: Julusian

meteor/server/publications/segmentPartNotesUI/generateNotesForSegment.ts

@@ -155,5 +155,31 @@ export function generateNotesForSegment(
 		}
 	}
 
+	// Generate notes for runtime invalidReason on PartInstances
+	// This is distinct from planned invalidReason on Parts - these are runtime validation issues
+	for (const partInstance of partInstances) {
+		// Skip if the PartInstance has been reset (no longer relevant) or has no runtime invalidReason
+		if (partInstance.reset || !partInstance.invalidReason) continue
+
+		notes.push({
+			_id: protectString(`${segment._id}_partinstance_${partInstance._id}_invalid_runtime`),
+			playlistId,
+			rundownId: partInstance.rundownId,
+			segmentId: segment._id,
+			note: {
+				type: NoteSeverity.ERROR,
+				message: partInstance.invalidReason,
+				rank: segment._rank,
+				origin: {
+					segmentId: partInstance.segmentId,
+					partId: partInstance.part._id,
+					rundownId: partInstance.rundownId,
+					segmentName: segment.name,
+					name: partInstance.part.title,
+				},
+			},
+		})
+	}
+
 	return notes
 }

meteor/server/publications/segmentPartNotesUI/publication.ts

@@ -91,7 +91,7 @@ async function setupUISegmentPartNotesPublicationObservers(
 						triggerUpdate({ invalidateSegmentIds: [doc.segmentId, oldDoc.segmentId] }),
 					removed: (doc) => triggerUpdate({ invalidateSegmentIds: [doc.segmentId] }),
 				}),
-				cache.DeletedPartInstances.find({}).observe({
+				cache.PartInstances.find({}).observe({
 					added: (doc) => triggerUpdate({ invalidateSegmentIds: [doc.segmentId] }),
 					changed: (doc, oldDoc) =>
 						triggerUpdate({ invalidateSegmentIds: [doc.segmentId, oldDoc.segmentId] }),
@@ -184,13 +184,13 @@ export async function manipulateUISegmentPartNotesPublicationData(
 interface UpdateNotesData {
 	rundownsCache: Map<RundownId, Pick<Rundown, RundownFields>>
 	parts: Map<SegmentId, Pick<DBPart, PartFields>[]>
-	deletedPartInstances: Map<SegmentId, Pick<DBPartInstance, PartInstanceFields>[]>
+	partInstances: Map<SegmentId, Pick<DBPartInstance, PartInstanceFields>[]>
 }
 function compileUpdateNotesData(cache: ReadonlyDeep<ContentCache>): UpdateNotesData {
 	return {
 		rundownsCache: normalizeArrayToMap(cache.Rundowns.find({}).fetch(), '_id'),
 		parts: groupByToMap(cache.Parts.find({}).fetch(), 'segmentId'),
-		deletedPartInstances: groupByToMap(cache.DeletedPartInstances.find({}).fetch(), 'segmentId'),
+		partInstances: groupByToMap(cache.PartInstances.find({}).fetch(), 'segmentId'),
 	}
 }
 
@@ -205,7 +205,7 @@ function updateNotesForSegment(
 		segment,
 		getRundownNrcsName(state.rundownsCache.get(segment.rundownId)),
 		state.parts.get(segment._id) ?? [],
-		state.deletedPartInstances.get(segment._id) ?? []
+		state.partInstances.get(segment._id) ?? []
 	)
 
 	// Insert generated notes

meteor/server/publications/segmentPartNotesUI/reactiveContentCache.ts

@@ -35,7 +35,7 @@ export const partFieldSpecifier = literal<MongoFieldSpecifierOnesStrict<Pick<DBP
 	invalidReason: 1,
 })
 
-export type PartInstanceFields = '_id' | 'segmentId' | 'rundownId' | 'orphaned' | 'reset' | 'part'
+export type PartInstanceFields = '_id' | 'segmentId' | 'rundownId' | 'orphaned' | 'reset' | 'part' | 'invalidReason'
 export const partInstanceFieldSpecifier = literal<
 	MongoFieldSpecifierOnesStrict<Pick<PartInstance, PartInstanceFields>>
 >({
@@ -44,6 +44,9 @@ export const partInstanceFieldSpecifier = literal<
 	rundownId: 1,
 	orphaned: 1,
 	reset: 1,
+	invalidReason: 1,
+	// @ts-expect-error Deep not supported
+	'part._id': 1,
 	// @ts-expect-error Deep not supported
 	'part.title': 1,
 })
@@ -52,17 +55,15 @@ export interface ContentCache {
 	Rundowns: ReactiveCacheCollection<Pick<Rundown, RundownFields>>
 	Segments: ReactiveCacheCollection<Pick<DBSegment, SegmentFields>>
 	Parts: ReactiveCacheCollection<Pick<DBPart, PartFields>>
-	DeletedPartInstances: ReactiveCacheCollection<Pick<PartInstance, PartInstanceFields>>
+	PartInstances: ReactiveCacheCollection<Pick<PartInstance, PartInstanceFields>>
 }
 
 export function createReactiveContentCache(): ContentCache {
 	const cache: ContentCache = {
 		Rundowns: new ReactiveCacheCollection<Pick<Rundown, RundownFields>>('rundowns'),
 		Segments: new ReactiveCacheCollection<Pick<DBSegment, SegmentFields>>('segments'),
 		Parts: new ReactiveCacheCollection<Pick<DBPart, PartFields>>('parts'),
-		DeletedPartInstances: new ReactiveCacheCollection<Pick<PartInstance, PartInstanceFields>>(
-			'deletedPartInstances'
-		),
+		PartInstances: new ReactiveCacheCollection<Pick<PartInstance, PartInstanceFields>>('partInstances'),
 	}
 
 	return cache

meteor/server/publications/segmentPartNotesUI/rundownContentObserver.ts

@@ -58,8 +58,12 @@ export class RundownContentObserver {
 				}
 			),
 			PartInstances.observeChanges(
-				{ rundownId: { $in: rundownIds }, reset: { $ne: true }, orphaned: 'deleted' },
-				cache.DeletedPartInstances.link(),
+				{
+					rundownId: { $in: rundownIds },
+					reset: { $ne: true },
+					$or: [{ invalidReason: { $exists: true } }, { orphaned: 'deleted' }],
+				},
+				cache.PartInstances.link(),
 				{ projection: partInstanceFieldSpecifier }
 			),
 		])

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

@@ -1,5 +1,6 @@
 import {
 	IBlueprintMutatablePart,
+	IBlueprintMutatablePartInstance,
 	IBlueprintPart,
 	IBlueprintPartInstance,
 	IBlueprintPiece,
@@ -72,10 +73,16 @@ export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContex
 	/** Update a piecesInstance from the partInstance being set as Next */
 	updatePieceInstance(pieceInstanceId: string, piece: Partial<IBlueprintPiece>): Promise<IBlueprintPieceInstance>
 
-	/** Update a partInstance */
+	/**
+	 * Update a partInstance
+	 * @param part Which part to update
+	 * @param props Properties of the Part itself
+	 * @param instanceProps Properties of the PartInstance (runtime state)
+	 */
 	updatePartInstance(
 		part: 'current' | 'next',
-		props: Partial<IBlueprintMutatablePart>
+		props: Partial<IBlueprintMutatablePart>,
+		instanceProps?: Partial<IBlueprintMutatablePartInstance>
 	): Promise<IBlueprintPartInstance>
 
 	/**

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

@@ -1,6 +1,7 @@
 import { ReadonlyDeep } from 'type-fest'
 import {
 	IBlueprintMutatablePart,
+	IBlueprintMutatablePartInstance,
 	IBlueprintPart,
 	IBlueprintPartInstance,
 	IBlueprintPiece,
@@ -64,10 +65,16 @@ export interface IPartAndPieceActionContext {
 	/** Update a piecesInstance */
 	updatePieceInstance(pieceInstanceId: string, piece: Partial<IBlueprintPiece>): Promise<IBlueprintPieceInstance>
 
-	/** Update a partInstance */
+	/**
+	 * Update a partInstance
+	 * @param part Which part to update
+	 * @param props Properties of the Part itself
+	 * @param instanceProps Properties of the PartInstance (runtime state)
+	 */
 	updatePartInstance(
 		part: 'current' | 'next',
-		props: Partial<IBlueprintMutatablePart>
+		props: Partial<IBlueprintMutatablePart>,
+		instanceProps?: Partial<IBlueprintMutatablePartInstance>
 	): Promise<IBlueprintPartInstance>
 	/** Inform core that a take out of the partinstance should be blocked until the specified time */
 	blockTakeUntil(time: Time | null): Promise<void>

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

@@ -1,6 +1,7 @@
 import type { IRundownUserContext } from './rundownContext.js'
 import type {
 	IBlueprintMutatablePart,
+	IBlueprintMutatablePartInstance,
 	IBlueprintPartInstance,
 	IBlueprintPiece,
 	IBlueprintPieceInstance,
@@ -37,8 +38,15 @@ export interface ISyncIngestUpdateToPartInstanceContext extends IRundownUserCont
 	// /** Remove a ActionInstance */
 	// removeActionInstances(...actionInstanceIds: string[]): string[]
 
-	/** Update a partInstance */
-	updatePartInstance(props: Partial<IBlueprintMutatablePart>): IBlueprintPartInstance
+	/**
+	 * Update a partInstance
+	 * @param props Properties of the Part itself
+	 * @param instanceProps Properties of the PartInstance (runtime state)
+	 */
+	updatePartInstance(
+		props: Partial<IBlueprintMutatablePart>,
+		instanceProps?: Partial<IBlueprintMutatablePartInstance>
+	): IBlueprintPartInstance
 
 	/** Remove the partInstance. This is only valid when `playstatus: 'next'` */
 	removePartInstance(): void

packages/blueprints-integration/src/documents/partInstance.ts

@@ -1,10 +1,25 @@
 import type { Time } from '../common.js'
 import type { IBlueprintPartDB } from './part.js'
+import type { ITranslatableMessage } from '../translations.js'
 
 export type PartEndState = unknown
 
+/**
+ * Properties of a PartInstance that can be modified at runtime by blueprints.
+ * These are runtime state properties, distinct from the planned Part properties.
+ */
+export interface IBlueprintMutatablePartInstance {
+	/**
+	 * If set, this PartInstance exists and is valid as being next, but it cannot be taken in its current state.
+	 * This can be used to block taking a PartInstance that requires user action to resolve.
+	 * This is a runtime validation issue, distinct from the planned `invalidReason` on the Part itself.
+	 */
+	invalidReason?: ITranslatableMessage
+}
+
 /** The Part instance sent from Core */
-export interface IBlueprintPartInstance<TPrivateData = unknown, TPublicData = unknown> {
+export interface IBlueprintPartInstance<TPrivateData = unknown, TPublicData = unknown>
+	extends IBlueprintMutatablePartInstance {
 	_id: string
 	/** The segment ("Title") this line belongs to */
 	segmentId: string

packages/corelib/src/dataModel/PartInstance.ts

@@ -2,6 +2,7 @@ import { PartEndState, Time } from '@sofie-automation/blueprints-integration'
 import { PartCalculatedTimings } from '../playout/timings.js'
 import { PartInstanceId, RundownId, RundownPlaylistActivationId, SegmentId, SegmentPlayoutId } from './Ids.js'
 import { DBPart } from './Part.js'
+import type { ITranslatableMessage } from '../TranslatableMessage.js'
 
 export interface DBPartInstance {
 	_id: PartInstanceId
@@ -40,6 +41,13 @@ export interface DBPartInstance {
 
 	/** If taking out of the current part is blocked, this is the time it is blocked until */
 	blockTakeUntil?: number
+
+	/**
+	 * If set, this PartInstance exists and is valid as being next, but it cannot be taken in its current state.
+	 * This can be used to block taking a PartInstance that requires user action to resolve.
+	 * This is a runtime validation issue, distinct from the planned `invalidReason` on the Part itself.
+	 */
+	invalidReason?: ITranslatableMessage
 }
 
 export interface PartInstanceTimings {

packages/corelib/src/error.ts

@@ -64,6 +64,7 @@ export enum UserErrorMessage {
 	IdempotencyKeyAlreadyUsed = 48,
 	RateLimitExceeded = 49,
 	SystemSingleStudio = 50,
+	TakePartInstanceInvalid = 51,
 }
 
 const UserErrorMessagesTranslations: { [key in UserErrorMessage]: string } = {
@@ -126,6 +127,7 @@ const UserErrorMessagesTranslations: { [key in UserErrorMessage]: string } = {
 	[UserErrorMessage.IdempotencyKeyAlreadyUsed]: t(`Idempotency-Key is already used`),
 	[UserErrorMessage.RateLimitExceeded]: t(`Rate limit exceeded`),
 	[UserErrorMessage.SystemSingleStudio]: t(`System must have exactly one studio`),
+	[UserErrorMessage.TakePartInstanceInvalid]: t(`Part has issues and cannot be taken`),
 }
 
 export interface SerializedUserError {