wip

Author: Julusian

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

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

meteor/server/publications/pieceContentStatusUI/checkPieceContentStatus.ts

@@ -12,7 +12,7 @@ import {
 } from '@sofie-automation/blueprints-integration'
 import {
 	ExpectedPackageDBType,
-	getExpectedPackageId,
+	getExpectedPackageIdForPieceInstance,
 	getExpectedPackageIdFromIngestSource,
 } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 import {
@@ -657,7 +657,9 @@ async function checkPieceContentExpectedPackageStatus(
 				]
 				if (piece.pieceInstanceId) {
 					// If this is a PieceInstance, try looking up the PieceInstance first
-					expectedPackageIds.unshift(getExpectedPackageId(piece.pieceInstanceId, expectedPackage._id))
+					expectedPackageIds.unshift(
+						getExpectedPackageIdForPieceInstance(piece.pieceInstanceId, expectedPackage._id)
+					)
 				}
 
 				let warningMessage: ContentMessageLight | null = null

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -18,29 +18,14 @@ import {
 import { ReadonlyDeep } from 'type-fest'
 
 /*
- Expected Packages are created from Pieces in the rundown.
+ Expected Packages are created from Pieces and other content in the rundown.
  A "Package" is a generic term for a "thing that can be played", such as media files, audio, graphics etc..
  The blueprints generate Pieces with expectedPackages on them.
  These are then picked up by a Package Manager who then tries to fullfill the expectations.
  Example: An ExpectedPackage could be a "Media file to be present on the location used by a playout device".
    The Package Manager will then copy the file to the right place.
 */
 
-// export type ExpectedPackageFromRundown = ExpectedPackageDBFromPiece | ExpectedPackageDBFromAdLibAction
-
-// export type ExpectedPackageFromRundownBaseline =
-// 	| ExpectedPackageDBFromBaselineAdLibAction
-// 	| ExpectedPackageDBFromBaselineAdLibPiece
-// 	| ExpectedPackageDBFromRundownBaselineObjects
-
-// export type ExpectedPackageDBFromBucket = ExpectedPackageDBFromBucketAdLib | ExpectedPackageDBFromBucketAdLibAction
-
-// export type ExpectedPackageDB =
-// 	| ExpectedPackageFromRundown
-// 	| ExpectedPackageDBFromBucket
-// 	| ExpectedPackageFromRundownBaseline
-// 	| ExpectedPackageDBFromStudioBaselineObjects
-
 export enum ExpectedPackageDBType {
 	PIECE = 'piece',
 	ADLIB_PIECE = 'adlib_piece',
@@ -53,19 +38,6 @@ export enum ExpectedPackageDBType {
 	STUDIO_BASELINE_OBJECTS = 'studio_baseline_objects',
 }
 
-/*
- * What about this new concept. The aim here is to avoid the constant inserting and deleting of expectedPackages during playout, and avoiding duplicate packages with the same content.
- * The idea is to have a single expectedPackage for each 'content'.
- * Ingest will 'deduplicate' the packages produced by the blueprints, with playout able to reference them with pieceInstanceIds.
- *
- * During the ingest save phase, it will need to reload the `playoutSources` property, in case it has changed. And if there are uses remaining, it will need to keep the package after clearing the `ingestSources`.
- * During playout operations, pieceInstanceIds will be added and removed as needed. If there remains no sources (of either type), then the document can be removed. If an in-progress ingest tried to reclaim it, it will get reinserted.
- *
- * Playout can then load just the ones referenced by piece instances, and just before it needs to use them (for bluerpint types or something), can ensure that everything needed has been loaded.
- * During a take, any packages referenced by the previous(?) partinstance must be removed.
- * When doing a reset of the rundown, all playout references must be removed.
- * When inserting/removing pieceinstances, the expectedPackages must be updated.
- */
 export interface ExpectedPackageDBNew {
 	_id: ExpectedPackageId // derived from rundownId and hash of `package`
 
@@ -159,7 +131,11 @@ export type ExpectedPackageIngestSource =
 	| ExpectedPackageIngestSourceBucket
 	| ExpectedPackageIngestSourceStudioBaseline
 
-export function getExpectedPackageId(
+/**
+ * Generate the expectedPackageId for the given piece instance.
+ * Note: This will soon be replaced with a new flow based on the contentVersionHash once shared ownership is implemented.
+ */
+export function getExpectedPackageIdForPieceInstance(
 	/** _id of the owner (the piece, adlib etc..) */
 	ownerId: PieceInstanceId,
 	// | AdLibActionId