chore: add SofieIngestDataCache collection

bbc · Julusian · Sep 30, 2024 · Apr 4, 2024 · Apr 4, 2024 · Apr 4, 2024
commit c3a82a42b82d4519e30236aef5672877ec0c7cd2
diff --git a/meteor/server/__tests__/cronjobs.test.ts b/meteor/server/__tests__/cronjobs.test.ts
@@ -51,6 +51,7 @@ import {
 	Snapshots,
 	UserActionsLog,
 	Segments,
+	SofieIngestDataCache,
 } from '../collections'
 import { IngestCacheType } from '@sofie-automation/corelib/dist/dataModel/IngestDataCache'
 import { JSONBlobStringify } from '@sofie-automation/shared-lib/dist/lib/JSONBlob'
@@ -209,6 +210,46 @@ describe('cronjobs', () => {
 			})
 			expect(await NrcsIngestDataCache.findOneAsync(dataCache0Id)).toBeUndefined()
 		})
+		testInFiber('Remove SofieIngestDataCache objects that are not connected to any Rundown', async () => {
+			// Set up a mock rundown, a detached SofieIngestDataCache object and an object attached to the mock rundown
+			// Detached SofieIngestDataCache object 0
+			const dataCache0Id = protectString<IngestDataCacheObjId>(getRandomString())
+			await SofieIngestDataCache.mutableCollection.insertAsync({
+				_id: dataCache0Id,
+				data: {
+					externalId: '',
+					name: '',
+					segments: [],
+					type: '',
+				},
+				modified: new Date(2000, 0, 1, 0, 0, 0).getTime(),
+				// this one is attached to rundown0
+				rundownId: getRandomId(),
+				type: IngestCacheType.RUNDOWN,
+			})
+			// Attached SofieIngestDataCache object 1
+			const dataCache1Id = protectString<IngestDataCacheObjId>(getRandomString())
+			await SofieIngestDataCache.mutableCollection.insertAsync({
+				_id: dataCache1Id,
+				data: {
+					externalId: '',
+					name: '',
+					segments: [],
+					type: '',
+				},
+				modified: new Date(2000, 0, 1, 0, 0, 0).getTime(),
+				// just some random ID
+				rundownId: rundownId,
+				type: IngestCacheType.RUNDOWN,
+			})
+
+			await runCronjobs()
+
+			expect(await SofieIngestDataCache.findOneAsync(dataCache1Id)).toMatchObject({
+				_id: dataCache1Id,
+			})
+			expect(await SofieIngestDataCache.findOneAsync(dataCache0Id)).toBeUndefined()
+		})
 		testInFiber('Removes old PartInstances and PieceInstances', async () => {
 			// nightlyCronjobInner()
 

diff --git a/meteor/server/api/__tests__/cleanup.test.ts b/meteor/server/api/__tests__/cleanup.test.ts
@@ -45,6 +45,7 @@ import {
 	TranslationsBundles,
 	PackageContainerStatuses,
 	TimelineDatastore,
+	SofieIngestDataCache,
 } from '../../collections'
 import { Collections } from '../../collections/lib'
 import { generateTranslationBundleOriginId } from '../translationsBundles'
@@ -307,6 +308,13 @@ async function setDefaultDatatoDB(env: DefaultEnvironment, now: number) {
 		rundownId,
 		type: '' as any,
 	})
+	await SofieIngestDataCache.mutableCollection.insertAsync({
+		_id: getRandomId(),
+		data: {} as any,
+		modified: 0,
+		rundownId,
+		type: '' as any,
+	})
 	await PackageContainerPackageStatuses.insertAsync({
 		_id: getRandomId(),
 		containerId: '',

diff --git a/meteor/server/api/cleanup.ts b/meteor/server/api/cleanup.ts
@@ -68,6 +68,7 @@ import {
 	UserActionsLog,
 	Workers,
 	WorkerThreadStatuses,
+	SofieIngestDataCache,
 } from '../collections'
 import { AsyncOnlyMongoCollection, AsyncOnlyReadOnlyMongoCollection } from '../collections/collection'
 import { getCollectionKey } from '../collections/lib'
@@ -275,6 +276,7 @@ export async function cleanupOldDataInner(actuallyCleanup = false): Promise<Coll
 		}
 		await ownedByRundownId(AdLibActions)
 		await ownedByRundownId(AdLibPieces)
+		await ownedByRundownId(SofieIngestDataCache)
 		await ownedByRundownId(NrcsIngestDataCache)
 		;(await ownedByRundownId(Parts)).forEach((id) => removedParts.add(id))
 		await ownedByRundownId(RundownBaselineAdLibActions)

diff --git a/meteor/server/collections/rundown.ts b/meteor/server/collections/rundown.ts
@@ -35,6 +35,13 @@ registerIndex(NrcsIngestDataCache, {
 	rundownId: 1,
 })
 
+export const SofieIngestDataCache = createAsyncOnlyReadOnlyMongoCollection<IngestDataCacheObj>(
+	CollectionName.SofieIngestDataCache
+)
+registerIndex(SofieIngestDataCache, {
+	rundownId: 1,
+})
+
 export const PartInstances = createAsyncOnlyReadOnlyMongoCollection<PartInstance>(CollectionName.PartInstances)
 registerIndex(PartInstances, {
 	rundownId: 1,

diff --git a/packages/corelib/src/dataModel/Collections.ts b/packages/corelib/src/dataModel/Collections.ts
@@ -13,7 +13,8 @@ export enum CollectionName {
 	ExpectedPackageWorkStatuses = 'expectedPackageWorkStatuses',
 	ExpectedPlayoutItems = 'expectedPlayoutItems',
 	ExternalMessageQueue = 'externalMessageQueue',
-	NrcsIngestDataCache = 'ingestDataCache',
+	NrcsIngestDataCache = 'ingestDataCache', // TODO - change the value of this?
+	SofieIngestDataCache = 'sofieIngestDataCache',
 	MediaObjects = 'mediaObjects',
 	MediaWorkFlows = 'mediaWorkFlows',
 	MediaWorkFlowSteps = 'mediaWorkFlowSteps',

diff --git a/packages/corelib/src/snapshots.ts b/packages/corelib/src/snapshots.ts
@@ -22,6 +22,7 @@ export interface CoreRundownPlaylistSnapshot {
 	playlist: DBRundownPlaylist
 	rundowns: Array<DBRundown>
 	ingestData: Array<IngestDataCacheObj>
+	sofieIngestData: Array<IngestDataCacheObj> | undefined // Added in 1.51
 	baselineObjs: Array<RundownBaselineObj>
 	baselineAdlibs: Array<RundownBaselineAdLibItem>
 	segments: Array<DBSegment>

diff --git a/packages/job-worker/src/__mocks__/collection.ts b/packages/job-worker/src/__mocks__/collection.ts
@@ -283,6 +283,7 @@ export function getMockCollections(): {
 			BucketAdLibPieces: new MockMongoCollection<BucketAdLib>(CollectionName.BucketAdLibPieces),
 			ExpectedMediaItems: new MockMongoCollection(CollectionName.ExpectedMediaItems),
 			ExpectedPlayoutItems: new MockMongoCollection<ExpectedPlayoutItem>(CollectionName.ExpectedPlayoutItems),
+			SofieIngestDataCache: new MockMongoCollection<IngestDataCacheObj>(CollectionName.SofieIngestDataCache),
 			NrcsIngestDataCache: new MockMongoCollection<IngestDataCacheObj>(CollectionName.NrcsIngestDataCache),
 			Parts: new MockMongoCollection<DBPart>(CollectionName.Parts),
 			PartInstances: new MockMongoCollection<DBPartInstance>(CollectionName.PartInstances),
@@ -339,6 +340,7 @@ export interface IMockCollections {
 	BucketAdLibPieces: MockMongoCollection<BucketAdLib>
 	ExpectedMediaItems: MockMongoCollection<ExpectedMediaItem>
 	ExpectedPlayoutItems: MockMongoCollection<ExpectedPlayoutItem>
+	SofieIngestDataCache: MockMongoCollection<IngestDataCacheObj>
 	NrcsIngestDataCache: MockMongoCollection<IngestDataCacheObj>
 	Parts: MockMongoCollection<DBPart>
 	PartInstances: MockMongoCollection<DBPartInstance>

diff --git a/packages/job-worker/src/db/collections.ts b/packages/job-worker/src/db/collections.ts
@@ -97,6 +97,7 @@ export interface IDirectCollections {
 	BucketAdLibPieces: ICollection<BucketAdLib>
 	ExpectedMediaItems: ICollection<ExpectedMediaItem>
 	ExpectedPlayoutItems: ICollection<ExpectedPlayoutItem>
+	SofieIngestDataCache: ICollection<IngestDataCacheObj>
 	NrcsIngestDataCache: ICollection<IngestDataCacheObj>
 	Parts: ICollection<DBPart>
 	PartInstances: ICollection<DBPartInstance>
@@ -158,6 +159,10 @@ export function getMongoCollections(
 				database.collection(CollectionName.ExpectedPlayoutItems),
 				allowWatchers
 			),
+			SofieIngestDataCache: wrapMongoCollection(
+				database.collection(CollectionName.SofieIngestDataCache),
+				allowWatchers
+			),
 			NrcsIngestDataCache: wrapMongoCollection(
 				database.collection(CollectionName.NrcsIngestDataCache),
 				allowWatchers

diff --git a/packages/job-worker/src/playout/snapshot.ts b/packages/job-worker/src/playout/snapshot.ts
@@ -56,6 +56,11 @@ export async function handleGeneratePlaylistSnapshot(
 			{ rundownId: { $in: rundownIds } },
 			{ sort: { modified: -1 } }
 		) // @todo: check sorting order
+		const sofieIngestData = await context.directCollections.SofieIngestDataCache.findFetch(
+			{ rundownId: { $in: rundownIds } },
+			{ sort: { modified: -1 } }
+		) // @todo: check sorting order
+
 		// const userActions = await context.directCollections.UserActionsLog.findFetch({
 		// 	args: {
 		// 		$regex:
@@ -120,6 +125,7 @@ export async function handleGeneratePlaylistSnapshot(
 			playlist,
 			rundowns,
 			ingestData,
+			sofieIngestData,
 			baselineObjs,
 			baselineAdlibs,
 			segments,
@@ -397,6 +403,12 @@ export async function handleRestorePlaylistSnapshot(
 			{ rundownId: { $in: rundownIds } },
 			updateItemIds(snapshot.ingestData, true)
 		),
+		saveIntoDb(
+			context,
+			context.directCollections.SofieIngestDataCache,
+			{ rundownId: { $in: rundownIds } },
+			updateItemIds(snapshot.sofieIngestData || snapshot.ingestData, true)
+		),
 		saveIntoDb(
 			context,
 			context.directCollections.RundownBaselineObjects,

diff --git a/packages/job-worker/src/rundownPlaylists.ts b/packages/job-worker/src/rundownPlaylists.ts
@@ -147,6 +147,7 @@ export async function removeRundownFromDb(context: JobContext, lock: RundownLock
 		context.directCollections.ExpectedMediaItems.remove({ rundownId: rundownId }),
 		context.directCollections.ExpectedPlayoutItems.remove({ rundownId: rundownId }),
 		context.directCollections.ExpectedPackages.remove({ rundownId: rundownId }),
+		context.directCollections.SofieIngestDataCache.remove({ rundownId: rundownId }),
 		context.directCollections.NrcsIngestDataCache.remove({ rundownId: rundownId }),
 		context.directCollections.RundownBaselineAdLibPieces.remove({ rundownId: rundownId }),
 		context.directCollections.Segments.remove({ rundownId: rundownId }),