wip: update store

Author: Julusian

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

@@ -2,19 +2,12 @@ import { ExpectedMediaItemRundown } from '@sofie-automation/corelib/dist/dataMod
 import { ExpectedPlayoutItemRundown } from '@sofie-automation/corelib/dist/dataModel/ExpectedPlayoutItem'
 import {
 	ExpectedMediaItemId,
-	ExpectedPackageId,
 	ExpectedPlayoutItemId,
 	PartId,
 	RundownId,
 } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { ReadonlyDeep } from 'type-fest'
-import {
-	diffAndReturnLatestObjects,
-	DocumentChanges,
-	getDocumentChanges,
-	setValuesAndTrackChanges,
-	setValuesAndTrackChangesFunc,
-} from './utils'
+import { diffAndReturnLatestObjects, DocumentChanges, getDocumentChanges, setValuesAndTrackChanges } from './utils'
 import type { IngestExpectedPackage } from '../IngestExpectedPackage'
 import { ExpectedPackageDBType } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 
@@ -25,7 +18,7 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 
 	#expectedMediaItemsWithChanges = new Set<ExpectedMediaItemId>()
 	#expectedPlayoutItemsWithChanges = new Set<ExpectedPlayoutItemId>()
-	#expectedPackagesWithChanges = new Set<ExpectedPackageId>()
+	#expectedPackagesHasChanges = false
 
 	get expectedMediaItems(): ReadonlyDeep<ExpectedMediaItemRundown[]> {
 		return this.#expectedMediaItems
@@ -42,7 +35,7 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 		return (
 			this.#expectedMediaItemsWithChanges.size > 0 ||
 			this.#expectedPlayoutItemsWithChanges.size > 0 ||
-			this.#expectedPackagesWithChanges.size > 0
+			this.#expectedPackagesHasChanges
 		)
 	}
 
@@ -52,14 +45,14 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 	get expectedPlayoutItemsChanges(): DocumentChanges<ExpectedPlayoutItemRundown> {
 		return getDocumentChanges(this.#expectedPlayoutItemsWithChanges, this.#expectedPlayoutItems)
 	}
-	get expectedPackagesChanges(): DocumentChanges<IngestExpectedPackage<TPackageSource>> {
-		return getDocumentChanges(this.#expectedPackagesWithChanges, this.#expectedPackages)
-	}
+	// get expectedPackagesChanges(): DocumentChanges<IngestExpectedPackage<TPackageSource>> {
+	// 	return getDocumentChanges(this.#expectedPackagesWithChanges, this.#expectedPackages)
+	// }
 
 	clearChangedFlags(): void {
 		this.#expectedMediaItemsWithChanges.clear()
 		this.#expectedPlayoutItemsWithChanges.clear()
-		this.#expectedPackagesWithChanges.clear()
+		this.#expectedPackagesHasChanges = false
 	}
 
 	#rundownId: RundownId
@@ -88,9 +81,7 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 			for (const expectedMediaItem of this.#expectedMediaItems) {
 				this.#expectedMediaItemsWithChanges.add(expectedMediaItem._id)
 			}
-			for (const expectedPackage of this.#expectedPackages) {
-				this.#expectedPackagesWithChanges.add(expectedPackage.packageId)
-			}
+			this.#expectedPackagesHasChanges = true
 		}
 	}
 
@@ -110,9 +101,12 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 			rundownId,
 			partId,
 		})
-		setValuesAndTrackChangesFunc(this.#expectedPackagesWithChanges, this.#expectedPackages, (pkg) =>
-			updatePackageSource(pkg.source)
-		)
+		for (const expectedPackage of this.#expectedPackages) {
+			const mutatorChanged = updatePackageSource(expectedPackage.source)
+
+			// The doc changed, track it as such
+			if (mutatorChanged) this.#expectedPackagesHasChanges = true
+		}
 	}
 
 	compareToPreviousData(oldStore: ExpectedPackagesStore<TPackageSource>): void {
@@ -127,11 +121,7 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 			oldStore.#expectedMediaItems,
 			this.#expectedMediaItems
 		)
-		diffAndReturnLatestObjects(
-			this.#expectedPackagesWithChanges,
-			oldStore.#expectedPackages,
-			this.#expectedPackages
-		)
+		this.#expectedPackagesHasChanges = true
 	}
 
 	setExpectedPlayoutItems(expectedPlayoutItems: ExpectedPlayoutItemRundown[]): void {
@@ -161,11 +151,7 @@ export class ExpectedPackagesStore<TPackageSource extends { fromPieceType: Expec
 		)
 	}
 	setExpectedPackages(expectedPackages: IngestExpectedPackage<TPackageSource>[]): void {
-		// nocommit - this wont work because of the clashing ids...
-		this.#expectedPackages = diffAndReturnLatestObjects(
-			this.#expectedPackagesWithChanges,
-			this.#expectedPackages,
-			expectedPackages
-		)
+		this.#expectedPackagesHasChanges = true
+		this.#expectedPackages = [...expectedPackages]
 	}
 }

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

@@ -178,7 +178,7 @@ export class IngestPartModelImpl implements IngestPartModel {
 
 	/**
 	 * This IngestPartModel replaces an existing one.
-	 * Run some comparisons to ensure that
+	 * Run some comparisons to ensure that the changed flags are set correctly
 	 * @param previousModel
 	 */
 	compareToPreviousModel(previousModel: IngestPartModelImpl): void {

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

@@ -20,7 +20,7 @@ import { normalizeArrayToMap } from '@sofie-automation/corelib/dist/lib'
 export class SaveIngestModelHelper {
 	readonly #rundownId: RundownId
 
-	#expectedPackages = new DocumentChangeTracker<IngestExpectedPackage<any>>()
+	#expectedPackages: IngestExpectedPackage<any>[] = []
 	#expectedPlayoutItems = new DocumentChangeTracker<ExpectedPlayoutItem>()
 	#expectedMediaItems = new DocumentChangeTracker<ExpectedMediaItem>()
 
@@ -38,7 +38,7 @@ export class SaveIngestModelHelper {
 		store: ExpectedPackagesStore<TPackageSource>,
 		deleteAll?: boolean
 	): void {
-		this.#expectedPackages.addChanges(store.expectedPackagesChanges, deleteAll ?? false)
+		if (!deleteAll) this.#expectedPackages.push(...store.expectedPackages)
 		this.#expectedPlayoutItems.addChanges(store.expectedPlayoutItemsChanges, deleteAll ?? false)
 		this.#expectedMediaItems.addChanges(store.expectedMediaItemsChanges, deleteAll ?? false)
 	}
@@ -68,7 +68,6 @@ export class SaveIngestModelHelper {
 	commit(context: JobContext): Array<Promise<unknown>> {
 		// Log deleted ids:
 		const deletedIds: { [key: string]: ProtectedString<any>[] } = {
-			expectedPackages: this.#expectedPackages.getDeletedIds(),
 			expectedPlayoutItems: this.#expectedPlayoutItems.getDeletedIds(),
 			expectedMediaItems: this.#expectedMediaItems.getDeletedIds(),
 			segments: this.#segments.getDeletedIds(),
@@ -84,13 +83,7 @@ export class SaveIngestModelHelper {
 		}
 
 		return [
-			writeExpectedPackagesChangesForRundown(
-				context,
-				this.#rundownId,
-				// This isn't using the expectedPackages store fully, because we know the content of the documents is immutable
-				// But it is easier to keep using the store for the sake of consistency
-				Array.from(this.#expectedPackages.getDocumentsToSave().values())
-			),
+			writeExpectedPackagesChangesForRundown(context, this.#rundownId, this.#expectedPackages),
 			context.directCollections.ExpectedPlayoutItems.bulkWrite(this.#expectedPlayoutItems.generateWriteOps()),
 			context.directCollections.ExpectedMediaItems.bulkWrite(this.#expectedMediaItems.generateWriteOps()),
 
@@ -131,7 +124,7 @@ async function writeExpectedPackagesChangesForRundown(
 			// Add the source to the existing document
 			partialDoc.ingestSources.push(doc.source)
 
-			// TODO - should we check for duplicates entries?
+			// Maybe this should check for duplicates, but the point where these documents are generated should be handling that.
 		} else {
 			// Add a new document
 			// Future: omit 'playoutSources from this doc

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

@@ -67,19 +67,6 @@ export function setValuesAndTrackChanges<T extends { _id: ProtectedString<any> }
 	}
 }
 
-export function setValuesAndTrackChangesFunc<T extends { _id: ProtectedString<any> }>(
-	changedIds: Set<T['_id']>,
-	objects: readonly T[],
-	mutator: (obj: T) => boolean
-): void {
-	for (const obj of objects) {
-		const mutatorChanged = mutator(obj)
-
-		// The doc changed, track it as such
-		if (mutatorChanged) changedIds.add(obj._id)
-	}
-}
-
 export function addManyToSet<T>(set: Set<T>, iter: Iterable<T>): void {
 	for (const val of iter) {
 		set.add(val)