wip

Author: Julusian

packages/corelib/src/dataModel/ExpectedPackageWorkStatuses.ts

@@ -1,6 +1,5 @@
 import { ExpectedPackageStatusAPI, Time } from '@sofie-automation/blueprints-integration'
-import { ExpectedPackageDBBase } from './ExpectedPackages'
-import { ExpectedPackageWorkStatusId, PeripheralDeviceId } from './Ids'
+import { ExpectedPackageId, ExpectedPackageWorkStatusId, PeripheralDeviceId, StudioId } from './Ids'
 
 /**
  * ExpectedPackageWorkStatus contains statuses about Work that is being performed on expected packages
@@ -10,7 +9,7 @@ import { ExpectedPackageWorkStatusId, PeripheralDeviceId } from './Ids'
 export interface ExpectedPackageWorkStatus extends Omit<ExpectedPackageStatusAPI.WorkStatus, 'fromPackages'> {
 	_id: ExpectedPackageWorkStatusId
 
-	studioId: ExpectedPackageDBBase['studioId']
+	studioId: StudioId
 	fromPackages: ExpectedPackageWorkStatusFromPackage[]
 
 	/** Which PeripheralDevice this update came from */
@@ -20,5 +19,5 @@ export interface ExpectedPackageWorkStatus extends Omit<ExpectedPackageStatusAPI
 }
 export interface ExpectedPackageWorkStatusFromPackage
 	extends Omit<ExpectedPackageStatusAPI.WorkBaseInfoFromPackage, 'id'> {
-	id: ExpectedPackageDBBase['_id']
+	id: ExpectedPackageId
 }

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -68,9 +68,6 @@ export enum ExpectedPackageDBType {
 export interface ExpectedPackageDBNew {
 	_id: ExpectedPackageId // derived from rundownId and hash of `package`
 
-	// /** The local package id - as given by the blueprints */
-	// blueprintPackageId: string // TODO - remove this?
-
 	/** The studio of the Rundown of the Piece this package belongs to */
 	studioId: StudioId
 

packages/corelib/src/dataModel/PackageInfos.ts

@@ -1,6 +1,6 @@
 import { PackageInfo, Time } from '@sofie-automation/blueprints-integration'
 import { protectString } from '../protectedString'
-import { ExpectedPackageDB } from './ExpectedPackages'
+import type { ExpectedPackageDBNew } from './ExpectedPackages'
 import { ExpectedPackageId, PackageInfoId, PeripheralDeviceId, StudioId } from './Ids'
 
 /**
@@ -14,7 +14,7 @@ export interface PackageInfoDB extends PackageInfo.Base {
 	/** Reference to the Package this document has info about */
 	packageId: ExpectedPackageId
 	/** Reference to the contentVersionHash of the ExpectedPackage, used to reference the expected content+version of the Package */
-	expectedContentVersionHash: ExpectedPackageDB['contentVersionHash']
+	expectedContentVersionHash: ExpectedPackageDBNew['contentVersionHash']
 	/** Referring to the actual contentVersionHash of the Package, used to reference the exact content+version of the Package */
 	actualContentVersionHash: string
 

packages/corelib/src/pubsub.ts

@@ -19,7 +19,7 @@ import { BucketAdLibAction } from './dataModel/BucketAdLibAction'
 import { BucketAdLib } from './dataModel/BucketAdLibPiece'
 import { ExpectedMediaItem } from './dataModel/ExpectedMediaItem'
 import { ExpectedPackageWorkStatus } from './dataModel/ExpectedPackageWorkStatuses'
-import { ExpectedPackageDBBase } from './dataModel/ExpectedPackages'
+import { ExpectedPackageDBNew } from './dataModel/ExpectedPackages'
 import { ExternalMessageQueueObj } from './dataModel/ExternalMessageQueue'
 import { PackageContainerStatusDB } from './dataModel/PackageContainerStatus'
 import { PeripheralDevice } from './dataModel/PeripheralDevice'
@@ -344,7 +344,7 @@ export type CorelibPubSubCollections = {
 	[CollectionName.BucketAdLibActions]: BucketAdLibAction
 	[CollectionName.BucketAdLibPieces]: BucketAdLib
 	[CollectionName.ExpectedMediaItems]: ExpectedMediaItem
-	[CollectionName.ExpectedPackages]: ExpectedPackageDBBase
+	[CollectionName.ExpectedPackages]: ExpectedPackageDBNew
 	[CollectionName.ExpectedPackageWorkStatuses]: ExpectedPackageWorkStatus
 	[CollectionName.ExternalMessageQueue]: ExternalMessageQueueObj
 	[CollectionName.NrcsIngestDataCache]: NrcsIngestDataCacheObj

packages/job-worker/src/__mocks__/collection.ts

@@ -4,7 +4,7 @@ import { Blueprint } from '@sofie-automation/corelib/dist/dataModel/Blueprint'
 import { BucketAdLibAction } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibAction'
 import { BucketAdLib } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibPiece'
 import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
-import { ExpectedPackageDB } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
+import { ExpectedPackageDBNew } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 import { ExpectedPlayoutItem } from '@sofie-automation/corelib/dist/dataModel/ExpectedPlayoutItem'
 import { NrcsIngestDataCacheObj } from '@sofie-automation/corelib/dist/dataModel/NrcsIngestDataCache'
 import { SofieIngestDataCacheObj } from '@sofie-automation/corelib/dist/dataModel/SofieIngestDataCache'
@@ -310,7 +310,7 @@ export function getMockCollections(): {
 			Timelines: new MockMongoCollection<TimelineComplete>(CollectionName.Timelines),
 			TimelineDatastores: new MockMongoCollection<DBTimelineDatastoreEntry>(CollectionName.TimelineDatastore),
 
-			ExpectedPackages: new MockMongoCollection<ExpectedPackageDB>(CollectionName.ExpectedPackages),
+			ExpectedPackages: new MockMongoCollection<ExpectedPackageDBNew>(CollectionName.ExpectedPackages),
 			PackageInfos: new MockMongoCollection(CollectionName.PackageInfos),
 
 			ExternalMessageQueue: new MockMongoCollection(CollectionName.ExternalMessageQueue),
@@ -364,7 +364,7 @@ export interface IMockCollections {
 	Timelines: MockMongoCollection<TimelineComplete>
 	TimelineDatastores: MockMongoCollection<DBTimelineDatastoreEntry>
 
-	ExpectedPackages: MockMongoCollection<ExpectedPackageDB>
+	ExpectedPackages: MockMongoCollection<ExpectedPackageDBNew>
 	PackageInfos: MockMongoCollection<PackageInfoDB>
 
 	ExternalMessageQueue: MockMongoCollection<ExternalMessageQueueObj>

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

@@ -149,7 +149,7 @@ export class WatchedPackagesHelper {
 
 	getPackageInfo(packageId: string): Readonly<Array<PackageInfo.Any>> {
 		for (const pkg of this.packages.values()) {
-			if (pkg.blueprintPackageId === packageId) {
+			if (pkg.package._id === packageId) {
 				const info = this.packageInfos.filter((p) => p.packageId === pkg._id)
 				return unprotectObjectArray(info)
 			}

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

@@ -216,11 +216,12 @@ export async function regenerateRundownAndBaselineFromIngestData(
 	allRundownWatchedPackages: WatchedPackagesHelper,
 	extraRundownNotes: RundownNote[]
 ): Promise<ReadonlyDeep<DBRundown> | null> {
-	const rundownBaselinePackages = allRundownWatchedPackages.filter(
-		context,
-		(pkg) =>
-			pkg.fromPieceType === ExpectedPackageDBType.BASELINE_ADLIB_ACTION ||
-			pkg.fromPieceType === ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS
+	const rundownBaselinePackages = allRundownWatchedPackages.filter(context, (pkg) =>
+		pkg.ingestSources.some(
+			(source) =>
+				source.fromPieceType === ExpectedPackageDBType.BASELINE_ADLIB_ACTION ||
+				source.fromPieceType === ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS
+		)
 	)
 
 	const blueprintContext = new GetRundownContext(
@@ -345,19 +346,19 @@ function generateExpectedPackagesForBaseline(
 	adLibPieces: AdLibPiece[],
 	adLibActions: RundownBaselineAdLibAction[],
 	expectedPackages: ExpectedPackage.Any[]
-): IngestExpectedPackage[] {
-	const packages: IngestExpectedPackage[] = []
+): IngestExpectedPackage<ExpectedPackageIngestSourceRundownBaseline>[] {
+	const packages: IngestExpectedPackage<ExpectedPackageIngestSourceRundownBaseline>[] = []
 
 	const wrapPackage = (
 		expectedPackage: ReadonlyDeep<ExpectedPackage.Any>,
-		source: ExpectedPackageIngestSourcePart | ExpectedPackageIngestSourceRundownBaseline
-	): IngestExpectedPackage => {
+		source: ExpectedPackageIngestSourceRundownBaseline
+	): IngestExpectedPackage<ExpectedPackageIngestSourceRundownBaseline> => {
 		return {
 			_id: getExpectedPackageIdTmp(rundownId, source, expectedPackage._id),
 
 			contentVersionHash: getContentVersionHash(expectedPackage),
 
-			created: Date.now(), // nocommit - avoid churn on this?
+			created: null,
 
 			package: expectedPackage,
 

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

@@ -1,24 +1,30 @@
 import type { ExpectedPackage, Time } from '@sofie-automation/blueprints-integration'
 import type {
 	ExpectedPackageDBNew,
+	ExpectedPackageDBType,
 	ExpectedPackageIngestSourcePart,
 	ExpectedPackageIngestSourceRundownBaseline,
 } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 import type { ExpectedPackageId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import type { ReadonlyDeep } from 'type-fest'
 
-export interface IngestExpectedPackage {
+export interface IngestExpectedPackage<
+	TPackageSource extends { fromPieceType: ExpectedPackageDBType } =
+		| ExpectedPackageIngestSourcePart
+		| ExpectedPackageIngestSourceRundownBaseline
+> {
 	_id: ExpectedPackageId
 
 	/** Hash that changes whenever the content or version changes. See getContentVersionHash() */
 	contentVersionHash: string
 
-	created: Time
+	/** The time this expectedPackage was created. This can be null when it has not yet been written to mongodb */
+	created: Time | null
 
 	package: ReadonlyDeep<ExpectedPackage.Any>
 
 	// HACK: Temporary single item
-	ingestSources: [ExpectedPackageIngestSourcePart | ExpectedPackageIngestSourceRundownBaseline]
+	ingestSources: [TPackageSource]
 }
 
 export function stripExpectedPackageDBToIngestExpectedPackage(

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

@@ -60,10 +60,4 @@ export interface IngestPartModel extends IngestPartModelReadonly {
 	 * @param expectedMediaItems The new ExpectedMediaItems
 	 */
 	setExpectedMediaItems(expectedMediaItems: ExpectedMediaItemRundown[]): void
-
-	// /**
-	//  * Set the ExpectedPackages for the contents of this Part
-	//  * @param expectedPackages The new ExpectedPackages
-	//  */
-	// setExpectedPackages(expectedPackages: ReadonlyDeep<ExpectedPackage.Any>[]): void
 }

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

@@ -9,21 +9,31 @@ import {
 	SegmentId,
 } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { ReadonlyDeep } from 'type-fest'
-import { diffAndReturnLatestObjects, DocumentChanges, getDocumentChanges, setValuesAndTrackChanges } from './utils'
+import {
+	diffAndReturnLatestObjects,
+	DocumentChanges,
+	getDocumentChanges,
+	setValuesAndTrackChanges,
+	setValuesAndTrackChangesFunc,
+} from './utils'
 import type { IngestExpectedPackage } from '../IngestExpectedPackage'
+import { ExpectedPackageDBType } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 
-function mutateExpectedPackage(oldObj: IngestExpectedPackage, newObj: IngestExpectedPackage): IngestExpectedPackage {
+function mutateExpectedPackage<TPackageSource extends { fromPieceType: ExpectedPackageDBType }>(
+	oldObj: IngestExpectedPackage<TPackageSource>,
+	newObj: IngestExpectedPackage<TPackageSource>
+): IngestExpectedPackage<TPackageSource> {
 	return {
 		...newObj,
 		// Retain the created property
 		created: oldObj.created,
 	}
 }
 
-export class ExpectedPackagesStore {
+export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: ExpectedPackageDBType }> {
 	#expectedMediaItems: ExpectedMediaItemRundown[]
 	#expectedPlayoutItems: ExpectedPlayoutItemRundown[]
-	#expectedPackages: IngestExpectedPackage[]
+	#expectedPackages: IngestExpectedPackage<TPackageSource>[]
 
 	#expectedMediaItemsWithChanges = new Set<ExpectedMediaItemId>()
 	#expectedPlayoutItemsWithChanges = new Set<ExpectedPlayoutItemId>()
@@ -35,8 +45,9 @@ export class ExpectedPackagesStore {
 	get expectedPlayoutItems(): ReadonlyDeep<ExpectedPlayoutItemRundown[]> {
 		return this.#expectedPlayoutItems
 	}
-	get expectedPackages(): ReadonlyDeep<IngestExpectedPackage[]> {
-		return this.#expectedPackages
+	get expectedPackages(): ReadonlyDeep<IngestExpectedPackage<TPackageSource>[]> {
+		// Typescript is not happy because of the generic
+		return this.#expectedPackages as any
 	}
 
 	get hasChanges(): boolean {
@@ -53,7 +64,7 @@ export class ExpectedPackagesStore {
 	get expectedPlayoutItemsChanges(): DocumentChanges<ExpectedPlayoutItemRundown> {
 		return getDocumentChanges(this.#expectedPlayoutItemsWithChanges, this.#expectedPlayoutItems)
 	}
-	get expectedPackagesChanges(): DocumentChanges<IngestExpectedPackage> {
+	get expectedPackagesChanges(): DocumentChanges<IngestExpectedPackage<TPackageSource>> {
 		return getDocumentChanges(this.#expectedPackagesWithChanges, this.#expectedPackages)
 	}
 
@@ -74,7 +85,7 @@ export class ExpectedPackagesStore {
 		partId: PartId | undefined,
 		expectedMediaItems: ExpectedMediaItemRundown[],
 		expectedPlayoutItems: ExpectedPlayoutItemRundown[],
-		expectedPackages: IngestExpectedPackage[]
+		expectedPackages: IngestExpectedPackage<TPackageSource>[]
 	) {
 		this.#rundownId = rundownId
 		this.#segmentId = segmentId
@@ -98,7 +109,12 @@ export class ExpectedPackagesStore {
 		}
 	}
 
-	setOwnerIds(rundownId: RundownId, segmentId: SegmentId | undefined, partId: PartId | undefined): void {
+	setOwnerIds(
+		rundownId: RundownId,
+		segmentId: SegmentId | undefined,
+		partId: PartId | undefined,
+		updatePackageSource: (source: TPackageSource) => boolean
+	): void {
 		this.#rundownId = rundownId
 		this.#segmentId = segmentId
 		this.#partId = partId
@@ -111,16 +127,19 @@ export class ExpectedPackagesStore {
 			rundownId,
 			partId,
 		})
-		// nocommit - reimplement
-		// setValuesAndTrackChanges(this.#expectedPackagesWithChanges, this.#expectedPackages, {
-		// 	rundownId,
-		// 	// @ts-expect-error Not all ExpectedPackage types have this property
-		// 	segmentId,
-		// 	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
+		})
 	}
 
-	compareToPreviousData(oldStore: ExpectedPackagesStore): void {
+	compareToPreviousData(oldStore: ExpectedPackagesStore<TPackageSource>): void {
 		// Diff the objects, but don't update the stored copies
 		diffAndReturnLatestObjects(
 			this.#expectedPlayoutItemsWithChanges,
@@ -166,19 +185,12 @@ export class ExpectedPackagesStore {
 			newExpectedMediaItems
 		)
 	}
-	setExpectedPackages(expectedPackages: IngestExpectedPackage[]): void {
-		// nocommit - the whole packages flow needs reimplementing
-		// const newExpectedPackages: IngestExpectedPackage[] = expectedPackages.map((pkg) => ({
-		// 	...pkg,
-		// 	partId: this.#partId,
-		// 	segmentId: this.#segmentId,
-		// 	rundownId: this.#rundownId,
-		// }))
-		// this.#expectedPackages = diffAndReturnLatestObjects(
-		// 	this.#expectedPackagesWithChanges,
-		// 	this.#expectedPackages,
-		// 	newExpectedPackages,
-		// 	mutateExpectedPackage
-		// )
+	setExpectedPackages(expectedPackages: IngestExpectedPackage<TPackageSource>[]): void {
+		this.#expectedPackages = diffAndReturnLatestObjects(
+			this.#expectedPackagesWithChanges,
+			this.#expectedPackages,
+			expectedPackages,
+			mutateExpectedPackage
+		)
 	}
 }