wip: change structure to be one source

Author: Julusian

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

@@ -6,20 +6,20 @@ import { PackageInfo } from '@sofie-automation/blueprints-integration'
 import { unprotectObjectArray } from '@sofie-automation/corelib/dist/protectedString'
 import { IngestModelReadonly } from '../../ingest/model/IngestModel'
 import { ReadonlyDeep } from 'type-fest'
-import {
-	stripExpectedPackageDBToIngestExpectedPackage,
-	type IngestExpectedPackage,
-} from '../../ingest/model/IngestExpectedPackage'
+import type { IngestExpectedPackage } from '../../ingest/model/IngestExpectedPackage'
 import type { ExpectedPackageIngestSource } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 
 /**
  * This is a helper class to simplify exposing packageInfo to various places in the blueprints
  */
 export class WatchedPackagesHelper {
-	private readonly packages = new Map<ExpectedPackageId, ReadonlyDeep<IngestExpectedPackage>>()
+	private readonly packages = new Map<
+		ExpectedPackageId,
+		ReadonlyDeep<IngestExpectedPackage<ExpectedPackageIngestSource>>
+	>()
 
 	private constructor(
-		packages: ReadonlyDeep<IngestExpectedPackage[]>,
+		packages: ReadonlyDeep<IngestExpectedPackage<ExpectedPackageIngestSource>[]>,
 		private readonly packageInfos: ReadonlyDeep<PackageInfoDB[]>
 	) {
 		for (const pkg of packages) {
@@ -59,8 +59,18 @@ export class WatchedPackagesHelper {
 			packageId: { $in: watchedPackages.map((p) => p._id) },
 		})
 
-		const watchedIngestPackages: IngestExpectedPackage[] = watchedPackages.map(
-			stripExpectedPackageDBToIngestExpectedPackage
+		const watchedIngestPackages: IngestExpectedPackage<ExpectedPackageIngestSource>[] = watchedPackages.flatMap(
+			(expectedPackage) => {
+				// Split into a package per source
+				return expectedPackage.ingestSources.map(
+					(source) =>
+						({
+							_id: expectedPackage._id,
+							package: expectedPackage.package,
+							source: source,
+						} satisfies IngestExpectedPackage<ExpectedPackageIngestSource>)
+				)
+			}
 		)
 
 		return new WatchedPackagesHelper(watchedIngestPackages, watchedPackageInfos)
@@ -137,8 +147,11 @@ export class WatchedPackagesHelper {
 	 * This is useful so that all the data for a rundown can be loaded at the start of an ingest operation, and then subsets can be taken for particular blueprint methods without needing to do more db operations.
 	 * @param func A filter to check if each package should be included
 	 */
-	filter(_context: JobContext, func: (pkg: ReadonlyDeep<IngestExpectedPackage>) => boolean): WatchedPackagesHelper {
-		const watchedPackages: ReadonlyDeep<IngestExpectedPackage>[] = []
+	filter(
+		_context: JobContext,
+		func: (pkg: ReadonlyDeep<IngestExpectedPackage<ExpectedPackageIngestSource>>) => boolean
+	): WatchedPackagesHelper {
+		const watchedPackages: ReadonlyDeep<IngestExpectedPackage<ExpectedPackageIngestSource>>[] = []
 		for (const pkg of this.packages.values()) {
 			if (func(pkg)) watchedPackages.push(pkg)
 		}
@@ -149,8 +162,8 @@ export class WatchedPackagesHelper {
 		return new WatchedPackagesHelper(watchedPackages, watchedPackageInfos)
 	}
 
-	getPackage(packageId: ExpectedPackageId): ReadonlyDeep<IngestExpectedPackage> | undefined {
-		return this.packages.get(packageId)
+	hasPackage(packageId: ExpectedPackageId): boolean {
+		return this.packages.has(packageId)
 	}
 
 	getPackageInfo(packageId: string): Readonly<Array<PackageInfo.Any>> {

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

@@ -218,9 +218,6 @@ export function updateBaselineExpectedPackagesOnStudio(
 ): void {
 	updateBaselineExpectedPlayoutItemsOnStudio(context, playoutModel, baseline.expectedPlayoutItems ?? [])
 
-	// Fill in ids of unnamed expectedPackages
-	setDefaultIdOnExpectedPackages(baseline.expectedPackages)
-
 	playoutModel.setExpectedPackagesForStudioBaseline(baseline.expectedPackages ?? [])
 }
 

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

@@ -214,12 +214,11 @@ export async function regenerateRundownAndBaselineFromIngestData(
 	allRundownWatchedPackages: WatchedPackagesHelper,
 	extraRundownNotes: RundownNote[]
 ): Promise<ReadonlyDeep<DBRundown> | null> {
-	const rundownBaselinePackages = allRundownWatchedPackages.filter(context, (pkg) =>
-		pkg.ingestSources.some(
-			(source) =>
-				source.fromPieceType === ExpectedPackageDBType.BASELINE_ADLIB_ACTION ||
-				source.fromPieceType === ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS
-		)
+	const rundownBaselinePackages = allRundownWatchedPackages.filter(
+		context,
+		(pkg) =>
+			pkg.source.fromPieceType === ExpectedPackageDBType.BASELINE_ADLIB_ACTION ||
+			pkg.source.fromPieceType === ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS
 	)
 
 	const blueprintContext = new GetRundownContext(
@@ -356,7 +355,7 @@ function generateExpectedPackagesForBaseline(
 
 			package: expectedPackage,
 
-			ingestSources: [source],
+			source: source,
 		}
 	}
 

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

@@ -105,8 +105,9 @@ async function regenerateSegmentAndUpdateModelFull(
 
 	// Filter down to the packages for this segment
 	const segmentId = ingestModel.getSegmentIdFromExternalId(ingestSegment.externalId)
-	const segmentWatchedPackages = allRundownWatchedPackages.filter(context, (p) =>
-		p.ingestSources.some((src) => 'segmentId' in src && src.segmentId === segmentId)
+	const segmentWatchedPackages = allRundownWatchedPackages.filter(
+		context,
+		(p) => 'segmentId' in p.source && p.source.segmentId === segmentId
 	)
 
 	let updatedSegmentModel = await regenerateSegmentAndUpdateModel(
@@ -191,8 +192,7 @@ async function checkIfSegmentReferencesUnloadedPackageInfos(
 	for (const part of segmentModel.parts) {
 		for (const expectedPackage of part.expectedPackages) {
 			if (expectedPackage.package.listenToPackageInfoUpdates) {
-				const loadedPackage = segmentWatchedPackages.getPackage(expectedPackage._id)
-				if (!loadedPackage) {
+				if (!segmentWatchedPackages.hasPackage(expectedPackage._id)) {
 					// The package didn't exist prior to the blueprint running
 					expectedPackageIdsToCheck.add(expectedPackage._id)
 				}

packages/job-worker/src/ingest/model/IngestExpectedPackage.ts

@@ -1,6 +1,5 @@
 import type { ExpectedPackage } from '@sofie-automation/blueprints-integration'
 import type {
-	ExpectedPackageDB,
 	ExpectedPackageDBType,
 	ExpectedPackageIngestSourcePart,
 	ExpectedPackageIngestSourceRundownBaseline,
@@ -10,6 +9,7 @@ import type { ReadonlyDeep } from 'type-fest'
 
 /**
  * A simpler form of ExpectedPackageDB that is scoped to the properties relevant to ingest.
+ * This is limited to be owned by one source, during the save process the documents will be merged
  */
 export interface IngestExpectedPackage<
 	TPackageSource extends { fromPieceType: ExpectedPackageDBType } =
@@ -20,16 +20,5 @@ export interface IngestExpectedPackage<
 
 	package: ReadonlyDeep<ExpectedPackage.Any>
 
-	// HACK: Temporary single item
-	ingestSources: [TPackageSource]
-}
-
-export function stripExpectedPackageDBToIngestExpectedPackage(
-	expectedPackage: ExpectedPackageDB
-): IngestExpectedPackage {
-	return {
-		_id: expectedPackage._id,
-		package: expectedPackage.package,
-		ingestSources: expectedPackage.ingestSources as any, // Future: can this be omitted
-	}
+	source: TPackageSource
 }

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

@@ -110,16 +110,9 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 			rundownId,
 			partId,
 		})
-		setValuesAndTrackChangesFunc(this.#expectedPackagesWithChanges, this.#expectedPackages, (pkg) => {
-			let changed = false
-
-			for (const source of pkg.ingestSources) {
-				const sourceChanged = updatePackageSource(source)
-				changed = changed || sourceChanged
-			}
-
-			return changed
-		})
+		setValuesAndTrackChangesFunc(this.#expectedPackagesWithChanges, this.#expectedPackages, (pkg) =>
+			updatePackageSource(pkg.source)
+		)
 	}
 
 	compareToPreviousData(oldStore: ExpectedPackagesStore<TPackageSource>): void {

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

@@ -59,7 +59,7 @@ import { generateWriteOpsForLazyDocuments } from './DocumentChangeTracker'
 import { IS_PRODUCTION } from '../../../environment'
 import { logger } from '../../../logging'
 import { NotificationsModelHelper } from '../../../notifications/NotificationsModelHelper'
-import { IngestExpectedPackage, stripExpectedPackageDBToIngestExpectedPackage } from '../IngestExpectedPackage'
+import { IngestExpectedPackage } from '../IngestExpectedPackage'
 
 export interface IngestModelImplExistingData {
 	rundown: DBRundown
@@ -344,11 +344,11 @@ export class IngestModelImpl implements IngestModel, IngestDatabasePersistedMode
 		const baselinePackage = this.#rundownBaselineExpectedPackagesStore.expectedPackages.find(
 			(pkg) => pkg._id === packageId
 		)
-		if (baselinePackage) sources.push(...baselinePackage.ingestSources)
+		if (baselinePackage) sources.push(baselinePackage.source)
 
 		for (const part of this.getAllOrderedParts()) {
 			const partPackage = part.expectedPackages.find((pkg) => pkg._id === packageId)
-			if (partPackage) sources.push(...partPackage.ingestSources)
+			if (partPackage) sources.push(partPackage.source)
 		}
 
 		return sources
@@ -709,17 +709,19 @@ function groupExpectedPackages(expectedPackages: ExpectedPackageDB[]) {
 			case ExpectedPackageDBType.BASELINE_ADLIB_PIECE:
 			case ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS:
 				baselineExpectedPackages.push({
-					...stripExpectedPackageDBToIngestExpectedPackage(expectedPackage),
-					ingestSources: [src],
+					_id: expectedPackage._id,
+					package: expectedPackage.package,
+					source: src,
 				})
 				break
 			case ExpectedPackageDBType.PIECE:
 			case ExpectedPackageDBType.ADLIB_PIECE:
 			case ExpectedPackageDBType.ADLIB_ACTION: {
 				const partPackages = groupedExpectedPackagesByPart.get(src.partId) ?? []
 				partPackages.push({
-					...stripExpectedPackageDBToIngestExpectedPackage(expectedPackage),
-					ingestSources: [src],
+					_id: expectedPackage._id,
+					package: expectedPackage.package,
+					source: src,
 				})
 				groupedExpectedPackagesByPart.set(src.partId, partPackages)
 				break

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

@@ -279,7 +279,7 @@ function generateExpectedPackagesForPart(
 
 			package: expectedPackage,
 
-			ingestSources: [source],
+			source: source,
 		}
 	}
 

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

@@ -131,7 +131,7 @@ export async function writeExpectedPackagesChangesForRundown(
 			bucketId: null,
 			created: Date.now(),
 			package: doc.package,
-			ingestSources: doc.ingestSources,
+			ingestSources: [doc.source],
 		}
 
 		const existingDoc = existingDocsMap.get(doc._id)

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

@@ -38,7 +38,7 @@ export class StudioBaselineHelper {
 
 					package: expectedPackage,
 
-					ingestSources: [source],
+					source: source,
 				} satisfies IngestExpectedPackage<ExpectedPackageIngestSourceStudioBaseline>)
 		)
 	}