fix: use the PartInstance instead of Part for PieceInstance content status SOFIE-2993

Adlibbed/orphaned parts don't have a Part, so never got any status

Author: Julusian

meteor/lib/api/rundownNotifications.ts

@@ -38,6 +38,7 @@ export interface UIPieceContentStatus {
 	segmentId: SegmentId | undefined
 
 	pieceId: PieceId | AdLibActionId | RundownBaselineAdLibActionId | PieceInstanceId
+	isPieceInstance: boolean
 
 	name: string | ITranslatableMessage
 	segmentName: string | undefined

meteor/server/publications/pieceContentStatusUI/rundown/publication.ts

@@ -4,6 +4,7 @@ import {
 	ExpectedPackageId,
 	PackageContainerPackageId,
 	PartId,
+	PartInstanceId,
 	PieceId,
 	PieceInstanceId,
 	RundownBaselineAdLibActionId,
@@ -33,7 +34,7 @@ import { logger } from '../../../logging'
 import { resolveCredentials } from '../../../security/lib/credentials'
 import { NoSecurityReadAccess } from '../../../security/noSecurity'
 import { RundownPlaylistReadAccess } from '../../../security/rundownPlaylist'
-import { ContentCache, createReactiveContentCache } from './reactiveContentCache'
+import { ContentCache, PartInstanceFields, createReactiveContentCache } from './reactiveContentCache'
 import { RundownContentObserver } from './rundownContentObserver'
 import { RundownsObserver } from '../../lib/rundownsObserver'
 import { LiveQueryHandle } from '../../../lib/lib'
@@ -57,6 +58,7 @@ import {
 } from './regenerateItems'
 import { PieceContentStatusStudio } from '../checkPieceContentStatus'
 import { check, Match } from 'meteor/check'
+import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 
 interface UIPieceContentStatusesArgs {
 	readonly rundownPlaylistId: RundownPlaylistId
@@ -80,6 +82,7 @@ interface UIPieceContentStatusesUpdateProps extends IContentStatusesUpdatePropsB
 
 	updatedSegmentIds: SegmentId[]
 	updatedPartIds: PartId[]
+	updatedPartInstanceIds: PartInstanceId[]
 
 	updatedPieceIds: PieceId[]
 	updatedPieceInstanceIds: PieceInstanceId[]
@@ -137,13 +140,18 @@ async function setupUIPieceContentStatusesPublicationObservers(
 			contentCache.Parts.find({}).observeChanges({
 				added: (id) => triggerUpdate({ updatedPartIds: [protectString(id)] }),
 				changed: (id) => triggerUpdate({ updatedPartIds: [protectString(id)] }),
-				removed: (id) => triggerUpdate({ updatedSegmentIds: [protectString(id)] }),
+				removed: (id) => triggerUpdate({ updatedPartIds: [protectString(id)] }),
 			}),
 			contentCache.Pieces.find({}).observeChanges({
 				added: (id) => triggerUpdate({ updatedPieceIds: [protectString(id)] }),
 				changed: (id) => triggerUpdate({ updatedPieceIds: [protectString(id)] }),
 				removed: (id) => triggerUpdate({ updatedPieceIds: [protectString(id)] }),
 			}),
+			contentCache.PartInstances.find({}).observeChanges({
+				added: (id) => triggerUpdate({ updatedPartInstanceIds: [protectString(id)] }),
+				changed: (id) => triggerUpdate({ updatedPartInstanceIds: [protectString(id)] }),
+				removed: (id) => triggerUpdate({ updatedPartInstanceIds: [protectString(id)] }),
+			}),
 			contentCache.PieceInstances.find({}).observeChanges({
 				added: (id) => triggerUpdate({ updatedPieceInstanceIds: [protectString(id)] }),
 				changed: (id) => triggerUpdate({ updatedPieceInstanceIds: [protectString(id)] }),
@@ -292,7 +300,8 @@ async function manipulateUIPieceContentStatusesPublicationData(
 		state.contentCache,
 		collection,
 		new Set(updateProps?.updatedSegmentIds),
-		new Set(updateProps?.updatedPartIds)
+		new Set(updateProps?.updatedPartIds),
+		new Set(updateProps?.updatedPartInstanceIds)
 	)
 
 	let regeneratePieceIds: Set<PieceId>
@@ -414,20 +423,37 @@ function updatePartAndSegmentInfoForExistingDocs(
 	contentCache: ReadonlyDeep<ContentCache>,
 	collection: CustomPublishCollection<UIPieceContentStatus>,
 	updatedSegmentIds: Set<SegmentId>,
-	updatedPartIds: Set<PartId>
+	updatedPartIds: Set<PartId>,
+	updatedPartInstanceIds: Set<PartInstanceId>
 ) {
+	const updatedPartInstancesByPartId = new Map<PartId, Pick<DBPartInstance, PartInstanceFields>>()
+	for (const partInstanceId of updatedPartInstanceIds) {
+		const partInstance = contentCache.PartInstances.findOne(partInstanceId)
+		if (partInstance) updatedPartInstancesByPartId.set(partInstance.part._id, partInstance)
+	}
+
 	collection.updateAll((doc) => {
 		let changed = false
 
 		// If the part for this doc changed, update its part.
 		// Note: if the segment of the doc's part changes that will only be noticed here
-		if (doc.partId && updatedPartIds.has(doc.partId)) {
+		if (doc.partId && !doc.isPieceInstance && updatedPartIds.has(doc.partId)) {
 			const part = contentCache.Parts.findOne(doc.partId)
 			if (part && (part.segmentId !== doc.segmentId || part._rank !== doc.partRank)) {
 				doc.segmentId = part.segmentId
 				doc.partRank = part._rank
 				changed = true
 			}
+		} else if (doc.partId && doc.isPieceInstance) {
+			const newPartProps = updatedPartInstancesByPartId.get(doc.partId)
+			if (
+				newPartProps &&
+				(newPartProps.segmentId !== doc.segmentId || newPartProps.part._rank !== doc.partRank)
+			) {
+				doc.segmentId = newPartProps.segmentId
+				doc.partRank = newPartProps.part._rank
+				changed = true
+			}
 		}
 
 		// If the segment for this doc changed, update its rank

meteor/server/publications/pieceContentStatusUI/rundown/reactiveContentCache.ts

@@ -13,6 +13,7 @@ import { AdLibAction } from '@sofie-automation/corelib/dist/dataModel/AdlibActio
 import { RundownBaselineAdLibAction } from '@sofie-automation/corelib/dist/dataModel/RundownBaselineAdLibAction'
 import { BlueprintId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { PieceInstance } from '@sofie-automation/corelib/dist/dataModel/PieceInstance'
+import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 
 export type SourceLayersDocId = ProtectedString<'SourceLayersDocId'>
 export interface SourceLayersDoc {
@@ -54,12 +55,23 @@ export const pieceFieldSpecifier = literal<MongoFieldSpecifierOnesStrict<Pick<Pi
 	expectedPackages: 1,
 })
 
-export type PieceInstanceFields = '_id' | 'rundownId' | 'piece'
+export type PartInstanceFields = '_id' | 'segmentId' | 'rundownId' | 'part'
+export const partInstanceFieldSpecifier = literal<
+	MongoFieldSpecifierOnesStrict<Pick<DBPartInstance, PartInstanceFields>>
+>({
+	_id: 1,
+	segmentId: 1,
+	rundownId: 1,
+	part: 1, // This could be stricter, but this is unlikely to be changed once the PartInstance is created
+})
+
+export type PieceInstanceFields = '_id' | 'rundownId' | 'partInstanceId' | 'piece'
 export const pieceInstanceFieldSpecifier = literal<
 	MongoFieldSpecifierOnesStrict<Pick<PieceInstance, PieceInstanceFields>>
 >({
 	_id: 1,
 	rundownId: 1,
+	partInstanceId: 1,
 	piece: 1, // This could be stricter, but this is unlikely to be changed once the PieceInstance is created
 })
 
@@ -110,6 +122,7 @@ export interface ContentCache {
 	Segments: ReactiveCacheCollection<Pick<DBSegment, SegmentFields>>
 	Parts: ReactiveCacheCollection<Pick<DBPart, PartFields>>
 	Pieces: ReactiveCacheCollection<Pick<Piece, PieceFields>>
+	PartInstances: ReactiveCacheCollection<Pick<DBPartInstance, PartInstanceFields>>
 	PieceInstances: ReactiveCacheCollection<Pick<PieceInstance, PieceInstanceFields>>
 	AdLibPieces: ReactiveCacheCollection<Pick<AdLibPiece, AdLibPieceFields>>
 	AdLibActions: ReactiveCacheCollection<Pick<AdLibAction, AdLibActionFields>>
@@ -124,6 +137,7 @@ export function createReactiveContentCache(): ContentCache {
 		Segments: new ReactiveCacheCollection<Pick<DBSegment, SegmentFields>>('segments'),
 		Parts: new ReactiveCacheCollection<Pick<DBPart, PartFields>>('parts'),
 		Pieces: new ReactiveCacheCollection<Pick<Piece, PieceFields>>('pieces'),
+		PartInstances: new ReactiveCacheCollection<Pick<DBPartInstance, PartInstanceFields>>('partInstances'),
 		PieceInstances: new ReactiveCacheCollection<Pick<PieceInstance, PieceInstanceFields>>('pieceInstances'),
 		AdLibPieces: new ReactiveCacheCollection<Pick<AdLibPiece, AdLibPieceFields>>('adlibPieces'),
 		AdLibActions: new ReactiveCacheCollection<Pick<AdLibAction, AdLibActionFields>>('adlibActions'),

meteor/server/publications/pieceContentStatusUI/rundown/regenerateItems.ts

@@ -56,6 +56,8 @@ async function regenerateGenericPiece(
 				segmentName: segment.name,
 				name: wrapTranslatableMessageFromBlueprintsIfNotString(doc.name, [sourceLayersForRundown.blueprintId]),
 
+				isPieceInstance: false,
+
 				status,
 			},
 		}
@@ -134,29 +136,54 @@ export async function regenerateForPieceInstanceIds(
 			// Piece has been deleted, queue it for batching
 			deletedPieceIds.add(pieceId)
 		} else {
-			const res = await regenerateGenericPiece(
-				contentCache,
-				uiStudio,
-				{
-					...pieceDoc.piece,
-					_id: protectString(unprotectString(pieceDoc._id)),
-				},
-				pieceDoc.piece.sourceLayerId,
-				{
+			// Regenerate piece
+			const rundown = contentCache.Rundowns.findOne(pieceDoc.rundownId)
+			const sourceLayersForRundown = rundown
+				? contentCache.ShowStyleSourceLayers.findOne(rundown.showStyleBaseId)
+				: undefined
+
+			const partInstance = pieceDoc.partInstanceId
+				? contentCache.PartInstances.findOne(pieceDoc.partInstanceId)
+				: undefined
+			const segment = partInstance ? contentCache.Segments.findOne(partInstance.segmentId) : undefined
+			const sourceLayer =
+				pieceDoc.piece.sourceLayerId && sourceLayersForRundown?.sourceLayers?.[pieceDoc.piece.sourceLayerId]
+
+			if (partInstance && segment && sourceLayer) {
+				const [status, dependencies] = await checkPieceContentStatusAndDependencies(
+					uiStudio,
+					{
+						...pieceDoc.piece,
+						_id: protectString(unprotectString(pieceDoc._id)),
+					},
+					sourceLayer
+				)
+
+				const res: UIPieceContentStatus = {
 					_id: protectString(`piece_${pieceId}`),
 
 					partId: pieceDoc.piece.startPartId,
 					rundownId: pieceDoc.rundownId,
 					pieceId: pieceId,
 
-					name: pieceDoc.piece.name,
+					segmentId: segment._id,
+
+					segmentRank: segment._rank,
+					partRank: partInstance.part._rank,
+
+					segmentName: segment.name,
+					name: wrapTranslatableMessageFromBlueprintsIfNotString(pieceDoc.piece.name, [
+						sourceLayersForRundown.blueprintId,
+					]),
+
+					isPieceInstance: true,
+
+					status,
 				}
-			)
 
-			if (res) {
-				dependenciesState.set(pieceId, res.dependencies)
+				dependenciesState.set(pieceId, dependencies)
 
-				collection.replace(res.doc)
+				collection.replace(res)
 			} else {
 				deletedPieceIds.add(pieceId)
 			}
@@ -323,6 +350,8 @@ export async function regenerateForBaselineAdLibPieceIds(
 					segmentRank: -1,
 					partRank: -1,
 
+					isPieceInstance: false,
+
 					status,
 				})
 			} else {
@@ -399,6 +428,8 @@ export async function regenerateForBaselineAdLibActionIds(
 					segmentRank: -1,
 					partRank: -1,
 
+					isPieceInstance: false,
+
 					status,
 				})
 			} else {

meteor/server/publications/pieceContentStatusUI/rundown/rundownContentObserver.ts

@@ -6,6 +6,7 @@ import {
 	adLibPieceFieldSpecifier,
 	ContentCache,
 	partFieldSpecifier,
+	partInstanceFieldSpecifier,
 	pieceFieldSpecifier,
 	pieceInstanceFieldSpecifier,
 	rundownFieldSpecifier,
@@ -17,6 +18,7 @@ import {
 import {
 	AdLibActions,
 	AdLibPieces,
+	PartInstances,
 	Parts,
 	PieceInstances,
 	Pieces,
@@ -138,6 +140,18 @@ export class RundownContentObserver {
 					projection: pieceFieldSpecifier,
 				}
 			),
+			PartInstances.observe(
+				{
+					rundownId: {
+						$in: rundownIds,
+					},
+					reset: { $ne: true },
+				},
+				cache.PartInstances.link(),
+				{
+					projection: partInstanceFieldSpecifier,
+				}
+			),
 			PieceInstances.observe(
 				{
 					rundownId: {