wip

Author: Julusian

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -5,6 +5,7 @@ import {
 	AdLibActionId,
 	BucketAdLibActionId,
 	BucketAdLibId,
+	BucketId,
 	ExpectedPackageId,
 	PartId,
 	PieceId,
@@ -71,8 +72,10 @@ export interface ExpectedPackageDBNew {
 	/** The studio of the Rundown of the Piece this package belongs to */
 	studioId: StudioId
 
-	/** The rundown this package belongs to, if any */
+	/** The rundown this package belongs to, if any. Must not be set when bucketId is set */
 	rundownId: RundownId | null
+	/** The bucket this package belongs to, if any. Must not be set when rundownId is set */
+	bucketId: BucketId | null
 
 	/** Hash that changes whenever the content or version changes. See getContentVersionHash() */
 	contentVersionHash: string
@@ -90,6 +93,21 @@ export interface ExpectedPackageDBNew {
 	// }
 }
 
+export interface ExpectedPackageIngestSourceBucketPiece {
+	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 {
+	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 {
 	fromPieceType: ExpectedPackageDBType.PIECE | ExpectedPackageDBType.ADLIB_PIECE
 	/** The Piece this package belongs to */
@@ -123,11 +141,16 @@ export interface ExpectedPackageIngestSourceBaselineObjects {
 }
 
 export interface ExpectedPackageIngestSourceStudioBaseline {
+	// 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
+	| ExpectedPackageIngestSourceBucketAdlibAction
+
 export type ExpectedPackageIngestSourceRundownBaseline =
 	| ExpectedPackageIngestSourceBaselineAdlibPiece
 	| ExpectedPackageIngestSourceBaselineAdlibAction
@@ -136,25 +159,9 @@ export type ExpectedPackageIngestSourceRundownBaseline =
 export type ExpectedPackageIngestSource =
 	| ExpectedPackageIngestSourcePart
 	| ExpectedPackageIngestSourceRundownBaseline
+	| ExpectedPackageIngestSourceBucket
 	| ExpectedPackageIngestSourceStudioBaseline
 
-// export interface ExpectedPackageDBFromBucketAdLib extends ExpectedPackageDBBase {
-// 	fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB
-// 	bucketId: BucketId
-// 	/** The Bucket adlib this package belongs to */
-// 	pieceId: BucketAdLibId
-// 	/** The `externalId` of the Bucket adlib this package belongs to */
-// 	pieceExternalId: string
-// }
-// export interface ExpectedPackageDBFromBucketAdLibAction extends ExpectedPackageDBBase {
-// 	fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB_ACTION
-// 	bucketId: BucketId
-// 	/** The Bucket adlib-action this package belongs to */
-// 	pieceId: BucketAdLibActionId
-// 	/** The `externalId` of the Bucket adlib-action this package belongs to */
-// 	pieceExternalId: string
-// }
-
 export function getContentVersionHash(expectedPackage: ReadonlyDeep<Omit<ExpectedPackage.Any, '_id'>>): string {
 	return hashObj({
 		content: expectedPackage.content,
@@ -180,28 +187,28 @@ export function getExpectedPackageId(
 	return protectString(`${ownerId}_${getHash(localExpectedPackageId)}`)
 }
 
-export function getExpectedPackageIdTmp(
-	/** Preferably a RundownId, but StudioId is allowed when not owned by a rundown */
-	parentId: RundownId | StudioId,
-	owner: ExpectedPackageIngestSource,
+export function getExpectedPackageIdFromIngestSource(
+	/** Preferably a RundownId or BucketId, but StudioId is allowed when not owned by a rundown or bucket */
+	parentId: RundownId | StudioId | BucketId,
+	source: ExpectedPackageIngestSource,
 	/** The locally unique id of the expectedPackage */
 	localExpectedPackageId: ExpectedPackage.Base['_id']
 ): ExpectedPackageId {
 	let ownerId: string
-	const ownerPieceType = owner.fromPieceType
-	switch (owner.fromPieceType) {
+	const ownerPieceType = source.fromPieceType
+	switch (source.fromPieceType) {
 		case ExpectedPackageDBType.PIECE:
 		case ExpectedPackageDBType.ADLIB_PIECE:
-			ownerId = unprotectString(owner.pieceId)
+			ownerId = unprotectString(source.pieceId)
 			break
 		case ExpectedPackageDBType.ADLIB_ACTION:
-			ownerId = unprotectString(owner.pieceId)
+			ownerId = unprotectString(source.pieceId)
 			break
 		case ExpectedPackageDBType.BASELINE_ADLIB_PIECE:
-			ownerId = unprotectString(owner.pieceId)
+			ownerId = unprotectString(source.pieceId)
 			break
 		case ExpectedPackageDBType.BASELINE_ADLIB_ACTION:
-			ownerId = unprotectString(owner.pieceId)
+			ownerId = unprotectString(source.pieceId)
 			break
 		case ExpectedPackageDBType.RUNDOWN_BASELINE_OBJECTS:
 			ownerId = 'rundownBaselineObjects'
@@ -210,7 +217,7 @@ export function getExpectedPackageIdTmp(
 			ownerId = 'studioBaseline'
 			break
 		default:
-			assertNever(owner)
+			assertNever(source)
 			throw new Error(`Unknown fromPieceType "${ownerPieceType}"`)
 	}
 	return protectString(`${parentId}_${ownerId}_${getHash(localExpectedPackageId)}`)

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

@@ -2,21 +2,12 @@ import { BucketAdLibAction } from '@sofie-automation/corelib/dist/dataModel/Buck
 import { BucketAdLib } from '@sofie-automation/corelib/dist/dataModel/BucketAdLibPiece'
 import {
 	ExpectedPackageDBType,
-	ExpectedPackageDBFromBucketAdLib,
-	ExpectedPackageDBFromBucketAdLibAction,
-	ExpectedPackageDBBase,
 	getContentVersionHash,
-	getExpectedPackageId,
+	ExpectedPackageDBNew,
+	getExpectedPackageIdFromIngestSource,
+	ExpectedPackageIngestSource,
 } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
-import {
-	RundownId,
-	AdLibActionId,
-	PieceId,
-	RundownBaselineAdLibActionId,
-	BucketAdLibActionId,
-	BucketAdLibId,
-	StudioId,
-} from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { AdLibActionId, PieceId, BucketId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { saveIntoDb } from '../db/changes'
 import { PlayoutModel } from '../playout/model/PlayoutModel'
 import { StudioPlayoutModel } from '../studio/model/StudioPlayoutModel'
@@ -47,97 +38,152 @@ export async function updateExpectedMediaAndPlayoutItemsForRundownBaseline(
 	await updateExpectedPlayoutItemsForRundownBaseline(context, ingestModel, baseline)
 }
 
-function generateExpectedPackagesForBucketAdlib(studio: ReadonlyDeep<JobStudio>, adlibs: BucketAdLib[]) {
-	const packages: ExpectedPackageDBFromBucketAdLib[] = []
-	for (const adlib of adlibs) {
-		if (adlib.expectedPackages) {
-			const bases = generateExpectedPackageBases(studio, adlib._id, adlib.expectedPackages)
-			for (const base of bases) {
-				packages.push({
-					...base,
-					bucketId: adlib.bucketId,
+function generateExpectedPackagesForBucketAdlib(studio: ReadonlyDeep<JobStudio>, adlib: BucketAdLib) {
+	const packages: ExpectedPackageDBNew[] = []
+
+	if (adlib.expectedPackages) {
+		packages.push(
+			...generateBucketExpectedPackages(
+				studio,
+				adlib.bucketId,
+				{
+					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB,
 					pieceId: adlib._id,
 					pieceExternalId: adlib.externalId,
-					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB,
-				})
-			}
-		}
+				},
+				adlib.expectedPackages
+			)
+		)
 	}
+
 	return packages
 }
-function generateExpectedPackagesForBucketAdlibAction(
-	studio: ReadonlyDeep<JobStudio>,
-	adlibActions: BucketAdLibAction[]
-) {
-	const packages: ExpectedPackageDBFromBucketAdLibAction[] = []
-	for (const action of adlibActions) {
-		if (action.expectedPackages) {
-			const bases = generateExpectedPackageBases(studio, action._id, action.expectedPackages)
-			for (const base of bases) {
-				packages.push({
-					...base,
-					bucketId: action.bucketId,
+function generateExpectedPackagesForBucketAdlibAction(studio: ReadonlyDeep<JobStudio>, action: BucketAdLibAction) {
+	const packages: ExpectedPackageDBNew[] = []
+
+	if (action.expectedPackages) {
+		packages.push(
+			...generateBucketExpectedPackages(
+				studio,
+				action.bucketId,
+				{
+					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB_ACTION,
 					pieceId: action._id,
 					pieceExternalId: action.externalId,
-					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB_ACTION,
-				})
-			}
-		}
+				},
+				action.expectedPackages
+			)
+		)
 	}
+
 	return packages
 }
-function generateExpectedPackageBases(
+function generateBucketExpectedPackages(
 	studio: ReadonlyDeep<JobStudio>,
-	ownerId:
-		| PieceId
-		| AdLibActionId
-		| RundownBaselineAdLibActionId
-		| BucketAdLibId
-		| BucketAdLibActionId
-		| RundownId
-		| StudioId,
+	bucketId: BucketId,
+	source: ExpectedPackageIngestSource,
 	expectedPackages: ReadonlyDeep<ExpectedPackage.Any[]>
-) {
-	const bases: Omit<ExpectedPackageDBBase, 'pieceId' | 'fromPieceType'>[] = []
+): ExpectedPackageDBNew[] {
+	const bases: ExpectedPackageDBNew[] = []
 
 	for (let i = 0; i < expectedPackages.length; i++) {
 		const expectedPackage = expectedPackages[i]
 		const id = expectedPackage._id || '__unnamed' + i
 
 		bases.push({
-			...clone<ExpectedPackage.Any>(expectedPackage),
-			_id: getExpectedPackageId(ownerId, id),
-			blueprintPackageId: id,
+			_id: getExpectedPackageIdFromIngestSource(bucketId, source, id),
+			package: {
+				...clone<ExpectedPackage.Any>(expectedPackage),
+				_id: id,
+			},
 			contentVersionHash: getContentVersionHash(expectedPackage),
 			studioId: studio._id,
-			created: Date.now(),
+			rundownId: null,
+			bucketId: bucketId,
+			created: Date.now(), // This will be preserved during the `saveIntoDb`
+			ingestSources: [source],
 		})
 	}
+
 	return bases
 }
 
 export async function updateExpectedPackagesForBucketAdLibPiece(
 	context: JobContext,
 	adlib: BucketAdLib
 ): Promise<void> {
-	const packages = generateExpectedPackagesForBucketAdlib(context.studio, [adlib])
+	const packages = generateExpectedPackagesForBucketAdlib(context.studio, adlib)
 
-	await saveIntoDb(context, context.directCollections.ExpectedPackages, { pieceId: adlib._id }, packages)
+	await saveIntoDb(
+		context,
+		context.directCollections.ExpectedPackages,
+		{
+			studioId: context.studioId,
+			bucketId: adlib.bucketId,
+			// Note: This assumes that there is only one ingest source for each piece
+			ingestSources: {
+				$elemMatch: {
+					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB,
+					pieceId: adlib._id,
+				},
+			},
+		},
+		packages,
+		{
+			beforeDiff: (obj, oldObj) => {
+				return {
+					...obj,
+					// Preserve old created timestamp
+					created: oldObj.created,
+				}
+			},
+		}
+	)
 }
 
 export async function updateExpectedPackagesForBucketAdLibAction(
 	context: JobContext,
 	action: BucketAdLibAction
 ): Promise<void> {
-	const packages = generateExpectedPackagesForBucketAdlibAction(context.studio, [action])
+	const packages = generateExpectedPackagesForBucketAdlibAction(context.studio, action)
 
-	await saveIntoDb(context, context.directCollections.ExpectedPackages, { pieceId: action._id }, packages)
+	await saveIntoDb(
+		context,
+		context.directCollections.ExpectedPackages,
+		{
+			studioId: context.studioId,
+			bucketId: action.bucketId,
+			// Note: This assumes that there is only one ingest source for each piece
+			ingestSources: {
+				$elemMatch: {
+					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB_ACTION,
+					pieceId: action._id,
+				},
+			},
+		},
+		packages,
+		{
+			beforeDiff: (obj, oldObj) => {
+				return {
+					...obj,
+					// Preserve old created timestamp
+					created: oldObj.created,
+				}
+			},
+		}
+	)
 }
+
 export async function cleanUpExpectedPackagesForBucketAdLibs(context: JobContext, adLibIds: PieceId[]): Promise<void> {
 	if (adLibIds.length > 0) {
 		await context.directCollections.ExpectedPackages.remove({
-			pieceId: {
-				$in: adLibIds,
+			studioId: context.studioId,
+			// Note: This assumes that there is only one ingest source for each piece
+			ingestSources: {
+				$elemMatch: {
+					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB,
+					pieceId: { $in: adLibIds },
+				},
 			},
 		})
 	}
@@ -148,8 +194,13 @@ export async function cleanUpExpectedPackagesForBucketAdLibsActions(
 ): Promise<void> {
 	if (adLibIds.length > 0) {
 		await context.directCollections.ExpectedPackages.remove({
-			pieceId: {
-				$in: adLibIds,
+			studioId: context.studioId,
+			// Note: This assumes that there is only one ingest source for each piece
+			ingestSources: {
+				$elemMatch: {
+					fromPieceType: ExpectedPackageDBType.BUCKET_ADLIB,
+					pieceId: { $in: adLibIds },
+				},
 			},
 		})
 	}

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

@@ -1,9 +1,8 @@
 import {
 	ExpectedPackageDBType,
-	ExpectedPackageIngestSourcePart,
 	ExpectedPackageIngestSourceRundownBaseline,
 	getContentVersionHash,
-	getExpectedPackageIdTmp,
+	getExpectedPackageIdFromIngestSource,
 } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
 import { BlueprintId, RundownId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { RundownNote } from '@sofie-automation/corelib/dist/dataModel/Notes'
@@ -354,7 +353,7 @@ function generateExpectedPackagesForBaseline(
 		source: ExpectedPackageIngestSourceRundownBaseline
 	): IngestExpectedPackage<ExpectedPackageIngestSourceRundownBaseline> => {
 		return {
-			_id: getExpectedPackageIdTmp(rundownId, source, expectedPackage._id),
+			_id: getExpectedPackageIdFromIngestSource(rundownId, source, expectedPackage._id),
 
 			contentVersionHash: getContentVersionHash(expectedPackage),