fix: statuses for PieceInstances should copy from the Piece until package-manager catches up

Author: Julusian

meteor/server/publications/packageManager/expectedPackages/generate.ts

@@ -1,11 +1,6 @@
 import { PackageContainerOnPackage, Accessor, AccessorOnPackage } from '@sofie-automation/blueprints-integration'
 import { getContentVersionHash, getExpectedPackageId } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
-import {
-	PeripheralDeviceId,
-	ExpectedPackageId,
-	PieceInstanceId,
-	PieceId,
-} from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { PeripheralDeviceId, ExpectedPackageId, PieceInstanceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { protectString, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
 import {
 	PackageManagerExpectedPackage,
@@ -120,10 +115,7 @@ export async function updateCollectionForPieceInstanceIds(
 		if (!pieceInstanceDoc.piece?.expectedPackages) continue
 
 		pieceInstanceDoc.piece.expectedPackages.forEach((expectedPackage, i) => {
-			const sanitisedPackageId = getExpectedPackageId(
-				protectString<PieceId>(unprotectString(pieceInstanceId)),
-				expectedPackage._id || '__unnamed' + i
-			)
+			const sanitisedPackageId = getExpectedPackageId(pieceInstanceId, expectedPackage._id || '__unnamed' + i)
 
 			// Map the expectedPackages onto their specified layer:
 			const allDeviceIds = new Set<PeripheralDeviceId>()

meteor/server/publications/pieceContentStatusUI/checkPieceContentStatus.ts

@@ -11,7 +11,7 @@ import {
 	VTContent,
 } from '@sofie-automation/blueprints-integration'
 import { getExpectedPackageId } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
-import { ExpectedPackageId, PeripheralDeviceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { ExpectedPackageId, PeripheralDeviceId, PieceInstanceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import {
 	getPackageContainerPackageId,
 	PackageContainerPackageStatusDB,
@@ -156,7 +156,9 @@ export function getMediaObjectMediaId(
 	return undefined
 }
 
-export type PieceContentStatusPiece = Pick<PieceGeneric, '_id' | 'content' | 'expectedPackages'>
+export type PieceContentStatusPiece = Pick<PieceGeneric, '_id' | 'content' | 'expectedPackages'> & {
+	pieceInstanceId?: PieceInstanceId
+}
 export interface PieceContentStatusStudio
 	extends Pick<
 		Studio,
@@ -506,60 +508,78 @@ async function checkPieceContentExpectedPackageStatus(
 
 				checkedPackageContainers.add(packageContainerId)
 
-				const expectedPackageId = getExpectedPackageId(piece._id, expectedPackage._id)
-				const packageOnPackageContainer = await getPackageContainerPackageStatus(
-					packageContainerId,
-					expectedPackageId
-				)
-				const packageName =
-					// @ts-expect-error hack
-					expectedPackage.content.filePath ||
-					// @ts-expect-error hack
-					expectedPackage.content.guid ||
-					expectedPackage._id
-
-				if (!thumbnailUrl && packageOnPackageContainer) {
-					const sideEffect = getSideEffect(expectedPackage, studio)
-
-					const packageThumbnailPath = sideEffect.thumbnailPackageSettings?.path
-					const thumbnailContainerId = sideEffect.thumbnailContainerId
-					if (packageThumbnailPath && thumbnailContainerId) {
-						thumbnailUrl = getAssetUrlFromExpectedPackages(
-							packageThumbnailPath,
-							thumbnailContainerId,
-							studio,
-							packageOnPackageContainer
-						)
-					}
+				const expectedPackageIds = [getExpectedPackageId(piece._id, expectedPackage._id)]
+				if (piece.pieceInstanceId) {
+					// If this is a PieceInstance, try looking up the PieceInstance first
+					expectedPackageIds.unshift(getExpectedPackageId(piece.pieceInstanceId, expectedPackage._id))
 				}
 
-				if (!previewUrl && packageOnPackageContainer) {
-					const sideEffect = getSideEffect(expectedPackage, studio)
-
-					const packagePreviewPath = sideEffect.previewPackageSettings?.path
-					const previewContainerId = sideEffect.previewContainerId
-					if (packagePreviewPath && previewContainerId) {
-						previewUrl = getAssetUrlFromExpectedPackages(
-							packagePreviewPath,
-							previewContainerId,
-							studio,
-							packageOnPackageContainer
-						)
+				let warningMessage: ContentMessage | null = null
+				let matchedExpectedPackageId: ExpectedPackageId | null = null
+				for (const expectedPackageId of expectedPackageIds) {
+					const packageOnPackageContainer = await getPackageContainerPackageStatus(
+						packageContainerId,
+						expectedPackageId
+					)
+					if (!packageOnPackageContainer) continue
+
+					matchedExpectedPackageId = expectedPackageId
+
+					if (!thumbnailUrl) {
+						const sideEffect = getSideEffect(expectedPackage, studio)
+
+						const packageThumbnailPath = sideEffect.thumbnailPackageSettings?.path
+						const thumbnailContainerId = sideEffect.thumbnailContainerId
+						if (packageThumbnailPath && thumbnailContainerId) {
+							thumbnailUrl = getAssetUrlFromExpectedPackages(
+								packageThumbnailPath,
+								thumbnailContainerId,
+								studio,
+								packageOnPackageContainer
+							)
+						}
+					}
+
+					if (!previewUrl) {
+						const sideEffect = getSideEffect(expectedPackage, studio)
+
+						const packagePreviewPath = sideEffect.previewPackageSettings?.path
+						const previewContainerId = sideEffect.previewContainerId
+						if (packagePreviewPath && previewContainerId) {
+							previewUrl = getAssetUrlFromExpectedPackages(
+								packagePreviewPath,
+								previewContainerId,
+								studio,
+								packageOnPackageContainer
+							)
+						}
 					}
+
+					warningMessage = getPackageWarningMessage(packageOnPackageContainer, sourceLayer)
+
+					// Found a packageOnPackageContainer
+					break
 				}
 
-				const warningMessage = getPackageWarningMessage(packageOnPackageContainer, sourceLayer)
-				if (warningMessage) {
-					messages.push(warningMessage)
+				if (!matchedExpectedPackageId || warningMessage) {
+					// If no package matched, we must have a warning
+					messages.push(warningMessage ?? getPackageSoruceMissingWarning(sourceLayer))
 				} else {
 					// No warning, must be OK
 
+					const packageName =
+						// @ts-expect-error hack
+						expectedPackage.content.filePath ||
+						// @ts-expect-error hack
+						expectedPackage.content.guid ||
+						expectedPackage._id
+
 					readyCount++
 					packageInfos[expectedPackage._id] = {
 						packageName,
 					}
 					// Fetch scan-info about the package:
-					const dbPackageInfos = await getPackageInfos(expectedPackageId)
+					const dbPackageInfos = await getPackageInfos(matchedExpectedPackageId)
 					for (const packageInfo of dbPackageInfos) {
 						if (packageInfo.type === PackageInfo.Type.SCAN) {
 							packageInfos[expectedPackage._id].scan = packageInfo.payload
@@ -689,25 +709,28 @@ function getAssetUrlFromExpectedPackages(
 	}
 }
 
+function getPackageSoruceMissingWarning(sourceLayer: ISourceLayer): ContentMessage {
+	// Examples of contents in packageOnPackageContainer?.status.statusReason.user:
+	// * Target package: Quantel clip "XXX" not found
+	// * Can't read the Package from PackageContainer "Quantel source 0" (on accessor "${accessorLabel}"), due to: Quantel clip "XXX" not found
+
+	return {
+		status: PieceStatusCode.SOURCE_MISSING,
+		message: generateTranslation(`{{sourceLayer}} can't be found on the playout system`, {
+			sourceLayer: sourceLayer.name,
+		}),
+	}
+}
+
 function getPackageWarningMessage(
-	packageOnPackageContainer: Pick<PackageContainerPackageStatusDB, 'status'> | undefined,
+	packageOnPackageContainer: Pick<PackageContainerPackageStatusDB, 'status'>,
 	sourceLayer: ISourceLayer
 ): ContentMessage | null {
 	if (
-		!packageOnPackageContainer ||
 		packageOnPackageContainer.status.status ===
-			ExpectedPackageStatusAPI.PackageContainerPackageStatusStatus.NOT_FOUND
+		ExpectedPackageStatusAPI.PackageContainerPackageStatusStatus.NOT_FOUND
 	) {
-		// Examples of contents in packageOnPackageContainer?.status.statusReason.user:
-		// * Target package: Quantel clip "XXX" not found
-		// * Can't read the Package from PackageContainer "Quantel source 0" (on accessor "${accessorLabel}"), due to: Quantel clip "XXX" not found
-
-		return {
-			status: PieceStatusCode.SOURCE_MISSING,
-			message: generateTranslation(`{{sourceLayer}} can't be found on the playout system`, {
-				sourceLayer: sourceLayer.name,
-			}),
-		}
+		return getPackageSoruceMissingWarning(sourceLayer)
 	} else if (
 		packageOnPackageContainer.status.status ===
 		ExpectedPackageStatusAPI.PackageContainerPackageStatusStatus.NOT_READY

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

@@ -7,7 +7,7 @@ import {
 } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { ReadonlyDeep } from 'type-fest'
 import { UIPieceContentStatus } from '../../../../lib/api/rundownNotifications'
-import { literal, protectString, unprotectString } from '../../../../lib/lib'
+import { literal, protectString } from '../../../../lib/lib'
 import { CustomPublishCollection } from '../../../lib/customPublication'
 import { ContentCache } from './reactiveContentCache'
 import { wrapTranslatableMessageFromBlueprintsIfNotString } from '@sofie-automation/corelib/dist/TranslatableMessage'
@@ -154,7 +154,7 @@ export async function regenerateForPieceInstanceIds(
 					uiStudio,
 					{
 						...pieceDoc.piece,
-						_id: protectString(unprotectString(pieceDoc._id)),
+						pieceInstanceId: pieceDoc._id,
 					},
 					sourceLayer
 				)

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -8,6 +8,7 @@ import {
 	BucketId,
 	ExpectedPackageId,
 	PieceId,
+	PieceInstanceId,
 	RundownBaselineAdLibActionId,
 	RundownId,
 	SegmentId,
@@ -134,6 +135,7 @@ export function getExpectedPackageId(
 	/** _id of the owner (the piece, adlib etc..) */
 	ownerId:
 		| PieceId
+		| PieceInstanceId
 		| AdLibActionId
 		| RundownBaselineAdLibActionId
 		| BucketAdLibId