wip: first round of types

Author: Julusian

meteor/server/api/__tests__/cleanup.test.ts

@@ -261,7 +261,10 @@ async function setDefaultDatatoDB(env: DefaultEnvironment, now: number) {
 		bucketId: null,
 		created: 0,
 		package: {} as any,
-		ingestSources: [] as any,
+		ingestSources: [],
+		playoutSources: {
+			pieceInstanceIds: [],
+		},
 	})
 	await ExpectedPackageWorkStatuses.insertAsync({
 		_id: getRandomId(),

meteor/server/migration/X_X_X.ts

@@ -142,6 +142,9 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 						},
 						created: pkg.created,
 						ingestSources: [ingestSource],
+						playoutSources: {
+							pieceInstanceIds: [],
+						},
 					} satisfies Complete<ExpectedPackageDB>)
 				}
 			}

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -58,10 +58,10 @@ export interface ExpectedPackageDB {
 	 */
 	ingestSources: ExpectedPackageIngestSource[]
 
-	// playoutSources: {
-	// 	/** Any playout PieceInstance. This is limited to the current and next partInstances */
-	// 	pieceInstanceIds: PieceInstanceId[]
-	// }
+	playoutSources: {
+		/** Any playout PieceInstance. This is limited to the current and next partInstances */ // nocommit - confirm this claim
+		pieceInstanceIds: PieceInstanceId[]
+	}
 }
 
 export interface ExpectedPackageIngestSourceBase {
@@ -173,3 +173,7 @@ export function getExpectedPackageIdNew(
 
 	return protectString(`${parentId}_${getHash(objHash)}`)
 }
+
+export function isPackageReferencedByPlayout(expectedPackage: Pick<ExpectedPackageDB, 'playoutSources'>): boolean {
+	return expectedPackage.playoutSources.pieceInstanceIds.length > 0
+}

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

@@ -109,6 +109,10 @@ function generateBucketExpectedPackages<TSource = never>(
 					listenToPackageInfoUpdates: expectedPackage.listenToPackageInfoUpdates,
 				},
 			],
+			playoutSources: {
+				// These don't belong to a rundown, so can't be referenced by playout
+				pieceInstanceIds: [],
+			},
 		})
 	}
 

packages/job-worker/src/ingest/model/implementation/SaveIngestModel.ts

@@ -1,7 +1,11 @@
 import { AdLibAction } from '@sofie-automation/corelib/dist/dataModel/AdlibAction'
 import { AdLibPiece } from '@sofie-automation/corelib/dist/dataModel/AdLibPiece'
 import { ExpectedMediaItem } from '@sofie-automation/corelib/dist/dataModel/ExpectedMediaItem'
-import { ExpectedPackageDB, ExpectedPackageDBType } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
+import {
+	ExpectedPackageDB,
+	ExpectedPackageDBType,
+	isPackageReferencedByPlayout,
+} from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 import { ExpectedPlayoutItem } from '@sofie-automation/corelib/dist/dataModel/ExpectedPlayoutItem'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 import { Piece } from '@sofie-automation/corelib/dist/dataModel/Piece'
@@ -110,13 +114,13 @@ async function writeExpectedPackagesChangesForRundown(
 		{
 			projection: {
 				_id: 1,
-				// Future: playoutSources
+				playoutSources: 1, // nocommit - can this be made just a count?
 			},
 		}
-	)) as Pick<ExpectedPackageDB, '_id' | 'created'>[]
+	)) as Pick<ExpectedPackageDB, '_id' | 'created' | 'playoutSources'>[]
 	const existingDocsMap = normalizeArrayToMap(existingDocs, '_id')
 
-	const packagesToSave = new Map<ExpectedPackageId, ExpectedPackageDB>()
+	const packagesToSave = new Map<ExpectedPackageId, Omit<ExpectedPackageDB, 'playoutSources'>>()
 	for (const doc of documentsToSave) {
 		const partialDoc = packagesToSave.get(doc.packageId)
 
@@ -148,7 +152,12 @@ async function writeExpectedPackagesChangesForRundown(
 			// Insert this new document
 			ops.push({
 				insertOne: {
-					document: doc,
+					document: {
+						...doc,
+						playoutSources: {
+							pieceInstanceIds: [],
+						},
+					},
 				},
 			})
 		} else {
@@ -170,13 +179,17 @@ async function writeExpectedPackagesChangesForRundown(
 
 	// Look over the existing documents, and see is no longer referenced
 	const idsToDelete: ExpectedPackageId[] = []
+	const idsToClearSources: ExpectedPackageId[] = []
 
 	for (const doc of existingDocs) {
 		// Skip if this document is in the list of documents to save
 		if (packagesToSave.has(doc._id)) continue
 
-		// Future: check for playoutSources
-		idsToDelete.push(doc._id)
+		if (isPackageReferencedByPlayout(doc)) {
+			idsToClearSources.push(doc._id)
+		} else {
+			idsToDelete.push(doc._id)
+		}
 	}
 
 	if (idsToDelete.length > 0) {
@@ -186,6 +199,18 @@ async function writeExpectedPackagesChangesForRundown(
 			},
 		})
 	}
+	if (idsToClearSources.length > 0) {
+		ops.push({
+			updateMany: {
+				filter: { _id: { $in: idsToClearSources as any } },
+				update: {
+					$set: {
+						ingestSources: [],
+					},
+				},
+			},
+		})
+	}
 
 	if (ops.length > 0) await context.directCollections.ExpectedPackages.bulkWrite(ops)
 }

packages/job-worker/src/playout/snapshot.ts

@@ -467,6 +467,9 @@ export async function handleRestorePlaylistSnapshot(
 				},
 
 				ingestSources: [source],
+				playoutSources: {
+					pieceInstanceIds: [],
+				},
 			}
 
 			expectedPackageIdMap.set(expectedPackage._id, newExpectedPackage._id)

packages/job-worker/src/studio/model/StudioBaselineHelper.ts

@@ -85,6 +85,10 @@ export class StudioBaselineHelper {
 									created: Date.now(),
 									package: pkg.package,
 									ingestSources: [pkg.source],
+									playoutSources: {
+										// This doesn't belong to a rundown, so can't be referenced by playout
+										pieceInstanceIds: [],
+									},
 								} satisfies Complete<ExpectedPackageDB>)
 						),
 						{