wip: move some properties into the source

Author: Julusian

meteor/server/api/ingest/packageInfo.ts

@@ -25,28 +25,28 @@ export async function onUpdatedPackageInfo(packageId: ExpectedPackageId, _doc: P
 		return
 	}
 
-	if (pkg.package.listenToPackageInfoUpdates) {
-		for (const source of pkg.ingestSources) {
-			switch (source.fromPieceType) {
-				case ExpectedPackageDBType.PIECE:
-				case ExpectedPackageDBType.ADLIB_PIECE:
-				case ExpectedPackageDBType.ADLIB_ACTION:
-				case ExpectedPackageDBType.BASELINE_ADLIB_PIECE:
-				case ExpectedPackageDBType.BASELINE_ADLIB_ACTION:
-				case ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS:
-					onUpdatedPackageInfoForRundownDebounce(pkg)
-					break
-				case ExpectedPackageDBType.BUCKET_ADLIB:
-				case ExpectedPackageDBType.BUCKET_ADLIB_ACTION:
-					onUpdatedPackageInfoForBucketItemDebounce(pkg, source)
-					break
-				case ExpectedPackageDBType.STUDIO_BASELINE_OBJECTS:
-					onUpdatedPackageInfoForStudioBaselineDebounce(pkg)
-					break
-				default:
-					assertNever(source)
-					break
-			}
+	for (const source of pkg.ingestSources) {
+		if (!source.listenToPackageInfoUpdates) continue
+
+		switch (source.fromPieceType) {
+			case ExpectedPackageDBType.PIECE:
+			case ExpectedPackageDBType.ADLIB_PIECE:
+			case ExpectedPackageDBType.ADLIB_ACTION:
+			case ExpectedPackageDBType.BASELINE_ADLIB_PIECE:
+			case ExpectedPackageDBType.BASELINE_ADLIB_ACTION:
+			case ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS:
+				onUpdatedPackageInfoForRundownDebounce(pkg)
+				break
+			case ExpectedPackageDBType.BUCKET_ADLIB:
+			case ExpectedPackageDBType.BUCKET_ADLIB_ACTION:
+				onUpdatedPackageInfoForBucketItemDebounce(pkg, source)
+				break
+			case ExpectedPackageDBType.STUDIO_BASELINE_OBJECTS:
+				onUpdatedPackageInfoForStudioBaselineDebounce(pkg)
+				break
+			default:
+				assertNever(source)
+				break
 		}
 	}
 }

meteor/server/migration/X_X_X.ts

@@ -55,6 +55,8 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 							pieceId: pkg.pieceId,
 							partId: pkg.partId,
 							segmentId: pkg.segmentId,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.ADLIB_ACTION:
@@ -64,26 +66,34 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 							pieceId: pkg.pieceId,
 							partId: pkg.partId,
 							segmentId: pkg.segmentId,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.BASELINE_ADLIB_PIECE:
 						rundownId = pkg.rundownId
 						ingestSource = {
 							fromPieceType: pkg.fromPieceType,
 							pieceId: pkg.pieceId,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.BASELINE_ADLIB_ACTION:
 						rundownId = pkg.rundownId
 						ingestSource = {
 							fromPieceType: pkg.fromPieceType,
 							pieceId: pkg.pieceId,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS:
 						rundownId = pkg.rundownId
 						ingestSource = {
 							fromPieceType: pkg.fromPieceType,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.BUCKET_ADLIB:
@@ -92,6 +102,8 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 							fromPieceType: pkg.fromPieceType,
 							pieceId: pkg.pieceId,
 							pieceExternalId: pkg.pieceExternalId,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.BUCKET_ADLIB_ACTION:
@@ -100,11 +112,15 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 							fromPieceType: pkg.fromPieceType,
 							pieceId: pkg.pieceId,
 							pieceExternalId: pkg.pieceExternalId,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					case PackagesPreR53.ExpectedPackageDBType.STUDIO_BASELINE_OBJECTS:
 						ingestSource = {
 							fromPieceType: pkg.fromPieceType,
+							blueprintPackageId: pkg.blueprintPackageId,
+							listenToPackageInfoUpdates: pkg.listenToPackageInfoUpdates,
 						}
 						break
 					default:

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -51,7 +51,7 @@ export interface ExpectedPackageDB {
 
 	created: Time
 
-	package: ReadonlyDeep<ExpectedPackage.Any>
+	package: ReadonlyDeep<Omit<ExpectedPackage.Base, 'listenToPackageInfoUpdates'>>
 
 	/**
 	 * The ingest sources that generated this package.
@@ -64,22 +64,30 @@ export interface ExpectedPackageDB {
 	// }
 }
 
-export interface ExpectedPackageIngestSourceBucketPiece {
+export interface ExpectedPackageIngestSourceBase {
+	/** The id of the package as known by the blueprints */
+	blueprintPackageId: string
+
+	/** Whether the blueprints are listening for updates to packageInfos for this package */
+	listenToPackageInfoUpdates: boolean | undefined
+}
+
+export interface ExpectedPackageIngestSourceBucketAdlibPiece extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB
 	/** The Bucket adlib this package belongs to */
 	pieceId: BucketAdLibId
 	/** The `externalId` of the Bucket adlib this package belongs to */
 	pieceExternalId: string
 }
-export interface ExpectedPackageIngestSourceBucketAdlibAction {
+export interface ExpectedPackageIngestSourceBucketAdlibAction extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB_ACTION
 	/** The Bucket adlib-action this package belongs to */
 	pieceId: BucketAdLibActionId
 	/** The `externalId` of the Bucket adlib-action this package belongs to */
 	pieceExternalId: string
 }
 
-export interface ExpectedPackageIngestSourcePiece {
+export interface ExpectedPackageIngestSourcePiece extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.PIECE | ExpectedPackageDBType.ADLIB_PIECE
 	/** The Piece this package belongs to */
 	pieceId: PieceId
@@ -88,7 +96,7 @@ export interface ExpectedPackageIngestSourcePiece {
 	/** The Segment this package belongs to */
 	segmentId: SegmentId
 }
-export interface ExpectedPackageIngestSourceAdlibAction {
+export interface ExpectedPackageIngestSourceAdlibAction extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.ADLIB_ACTION
 	/** The Piece this package belongs to */
 	pieceId: AdLibActionId
@@ -97,29 +105,29 @@ export interface ExpectedPackageIngestSourceAdlibAction {
 	/** The Segment this package belongs to */
 	segmentId: SegmentId
 }
-export interface ExpectedPackageIngestSourceBaselineAdlibPiece {
+export interface ExpectedPackageIngestSourceBaselineAdlibPiece extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.BASELINE_ADLIB_PIECE
 	/** The Piece this package belongs to */
 	pieceId: PieceId
 }
-export interface ExpectedPackageIngestSourceBaselineAdlibAction {
+export interface ExpectedPackageIngestSourceBaselineAdlibAction extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.BASELINE_ADLIB_ACTION
 	/** The Piece this package belongs to */
 	pieceId: RundownBaselineAdLibActionId
 }
-export interface ExpectedPackageIngestSourceBaselineObjects {
+export interface ExpectedPackageIngestSourceBaselineObjects extends ExpectedPackageIngestSourceBase {
 	fromPieceType: ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS
 }
 
-export interface ExpectedPackageIngestSourceStudioBaseline {
+export interface ExpectedPackageIngestSourceStudioBaseline extends ExpectedPackageIngestSourceBase {
 	// Future: Technically this is a playout source, but for now it needs to be treated as an ingest source
 	fromPieceType: ExpectedPackageDBType.STUDIO_BASELINE_OBJECTS
 }
 
 export type ExpectedPackageIngestSourcePart = ExpectedPackageIngestSourcePiece | ExpectedPackageIngestSourceAdlibAction
 
 export type ExpectedPackageIngestSourceBucket =
-	| ExpectedPackageIngestSourceBucketPiece
+	| ExpectedPackageIngestSourceBucketAdlibPiece
 	| ExpectedPackageIngestSourceBucketAdlibAction
 
 export type ExpectedPackageIngestSourceRundownBaseline =
@@ -154,13 +162,14 @@ export function getExpectedPackageIdNew(
 	/** Preferably a RundownId or BucketId, but StudioId is allowed when not owned by a rundown or bucket */
 	parentId: RundownId | StudioId | BucketId,
 	/** The locally unique id of the expectedPackage */
-	expectedPackage: ReadonlyDeep<ExpectedPackage.Any>
+	expectedPackage: ReadonlyDeep<Omit<ExpectedPackage.Base, 'listenToPackageInfoUpdates'>>
 ): ExpectedPackageId {
 	// This may be too agressive, but we don't know how to merge some of the properties
 	const objHash = hashObj({
 		...expectedPackage,
+		_id: '', // Ignore the _id, this is not guaranteed to be stable
 		listenToPackageInfoUpdates: false, // Not relevant for the hash
-	} satisfies ReadonlyDeep<ExpectedPackage.Any>)
+	} satisfies ReadonlyDeep<ExpectedPackage.Base>)
 
 	return protectString(`${parentId}_${getHash(objHash)}`)
 }

packages/job-worker/src/blueprints/context/watchedPackages.ts

@@ -99,7 +99,7 @@ export class WatchedPackagesHelper {
 
 		return this.#createFromPackages(
 			context,
-			packages.filter((pkg) => !!pkg.package.listenToPackageInfoUpdates)
+			packages.filter((pkg) => !!pkg.source.listenToPackageInfoUpdates)
 		)
 	}
 
@@ -127,7 +127,7 @@ export class WatchedPackagesHelper {
 
 		return this.#createFromPackages(
 			context,
-			packages.filter((pkg) => !!pkg.package.listenToPackageInfoUpdates)
+			packages.filter((pkg) => !!pkg.source.listenToPackageInfoUpdates)
 		)
 	}
 
@@ -170,11 +170,11 @@ export class WatchedPackagesHelper {
 		return this.packages.has(packageId)
 	}
 
-	getPackageInfo(packageId: string): Readonly<Array<PackageInfo.Any>> {
+	getPackageInfo(blueprintPackageId: string): Readonly<Array<PackageInfo.Any>> {
 		// nocommit - can this/should this do more scoping by source?
 		for (const packages of this.packages.values()) {
 			for (const pkg of packages) {
-				if (pkg.package._id === packageId) {
+				if (pkg.source.blueprintPackageId === blueprintPackageId) {
 					const info = this.packageInfos.filter((p) => p.packageId === pkg.packageId)
 					return unprotectObjectArray(info)
 				}

packages/job-worker/src/blueprints/postProcess.ts

@@ -40,7 +40,7 @@ import {
 	interpollateTranslation,
 	wrapTranslatableMessageFromBlueprints,
 } from '@sofie-automation/corelib/dist/TranslatableMessage'
-import { setDefaultIdOnExpectedPackages } from '../ingest/expectedPackages'
+import { sanitiseExpectedPackages } from '../ingest/expectedPackages'
 import { logger } from '../logging'
 import { validateTimeline } from 'superfly-timeline'
 import { ReadonlyDeep } from 'type-fest'
@@ -136,7 +136,7 @@ export function postProcessPieces(
 		piece.timelineObjectsString = serializePieceTimelineObjectsBlob(timelineObjects)
 
 		// Fill in ids of unnamed expectedPackages
-		setDefaultIdOnExpectedPackages(piece.expectedPackages)
+		sanitiseExpectedPackages(piece.expectedPackages)
 
 		return piece
 	})
@@ -266,7 +266,7 @@ export function postProcessAdLibPieces(
 		piece.timelineObjectsString = serializePieceTimelineObjectsBlob(timelineObjects)
 
 		// Fill in ids of unnamed expectedPackages
-		setDefaultIdOnExpectedPackages(piece.expectedPackages)
+		sanitiseExpectedPackages(piece.expectedPackages)
 
 		return piece
 	})
@@ -303,7 +303,7 @@ export function postProcessGlobalAdLibActions(
 		)
 
 		// Fill in ids of unnamed expectedPackages
-		setDefaultIdOnExpectedPackages(action.expectedPackages)
+		sanitiseExpectedPackages(action.expectedPackages)
 
 		return literal<RundownBaselineAdLibAction>({
 			...action,
@@ -344,7 +344,7 @@ export function postProcessAdLibActions(
 		)
 
 		// Fill in ids of unnamed expectedPackages
-		setDefaultIdOnExpectedPackages(action.expectedPackages)
+		sanitiseExpectedPackages(action.expectedPackages)
 
 		return literal<AdLibAction>({
 			...action,
@@ -424,7 +424,7 @@ export function postProcessBucketAdLib(
 		timelineObjectsString: EmptyPieceTimelineObjectsBlob,
 	}
 	// Fill in ids of unnamed expectedPackages
-	setDefaultIdOnExpectedPackages(piece.expectedPackages)
+	sanitiseExpectedPackages(piece.expectedPackages)
 
 	const timelineObjects = postProcessTimelineObjects(piece._id, blueprintId, itemOrig.content.timelineObjects)
 	piece.timelineObjectsString = serializePieceTimelineObjectsBlob(timelineObjects)
@@ -473,7 +473,7 @@ export function postProcessBucketAction(
 	}
 
 	// Fill in ids of unnamed expectedPackages
-	setDefaultIdOnExpectedPackages(action.expectedPackages)
+	sanitiseExpectedPackages(action.expectedPackages)
 
 	return action
 }

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

@@ -5,6 +5,8 @@ import {
 	ExpectedPackageDB,
 	ExpectedPackageIngestSource,
 	getExpectedPackageIdNew,
+	ExpectedPackageIngestSourceBucketAdlibAction,
+	ExpectedPackageIngestSourceBucketAdlibPiece,
 } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 import { AdLibActionId, PieceId, BucketId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { PlayoutModel } from '../playout/model/PlayoutModel'
@@ -42,7 +44,7 @@ function generateExpectedPackagesForBucketAdlib(studio: ReadonlyDeep<JobStudio>,
 
 	if (adlib.expectedPackages) {
 		packages.push(
-			...generateBucketExpectedPackages(
+			...generateBucketExpectedPackages<ExpectedPackageIngestSourceBucketAdlibPiece>(
 				studio,
 				adlib.bucketId,
 				{
@@ -62,7 +64,7 @@ function generateExpectedPackagesForBucketAdlibAction(studio: ReadonlyDeep<JobSt
 
 	if (action.expectedPackages) {
 		packages.push(
-			...generateBucketExpectedPackages(
+			...generateBucketExpectedPackages<ExpectedPackageIngestSourceBucketAdlibAction>(
 				studio,
 				action.bucketId,
 				{
@@ -77,10 +79,10 @@ function generateExpectedPackagesForBucketAdlibAction(studio: ReadonlyDeep<JobSt
 
 	return packages
 }
-function generateBucketExpectedPackages(
+function generateBucketExpectedPackages<TSource = never>(
 	studio: ReadonlyDeep<JobStudio>,
 	bucketId: BucketId,
-	source: ExpectedPackageIngestSource,
+	source: Omit<TSource, 'blueprintPackageId' | 'listenToPackageInfoUpdates'>,
 	expectedPackages: ReadonlyDeep<ExpectedPackage.Any[]>
 ): ExpectedPackageDB[] {
 	const bases: ExpectedPackageDB[] = []
@@ -100,7 +102,13 @@ function generateBucketExpectedPackages(
 			rundownId: null,
 			bucketId: bucketId,
 			created: Date.now(), // This will be preserved during the save if needed
-			ingestSources: [source],
+			ingestSources: [
+				{
+					...(source as any), // Because this is a generic, this spread doesnt work
+					blueprintPackageId: expectedPackage._id,
+					listenToPackageInfoUpdates: expectedPackage.listenToPackageInfoUpdates,
+				},
+			],
 		})
 	}
 
@@ -273,15 +281,10 @@ export function updateBaselineExpectedPackagesOnStudio(
 	playoutModel.setExpectedPackagesForStudioBaseline(baseline.expectedPackages ?? [])
 }
 
-export function setDefaultIdOnExpectedPackages(expectedPackages: ExpectedPackage.Any[] | undefined): void {
+export function sanitiseExpectedPackages(expectedPackages: ExpectedPackage.Any[] | undefined): void {
 	// Fill in ids of unnamed expectedPackage
 	if (expectedPackages) {
-		for (let i = 0; i < expectedPackages.length; i++) {
-			const expectedPackage = expectedPackages[i]
-			if (!expectedPackage._id) {
-				expectedPackage._id = `__index${i}`
-			}
-
+		for (const expectedPackage of expectedPackages) {
 			expectedPackage.contentVersionHash = getContentVersionHash(expectedPackage)
 		}
 	}