feat(EAV-663): allow blueprints to specify preview and thumbnail containter ids

meteor/__mocks__/defaultCollectionObjects.ts

@@ -119,8 +119,10 @@ export function defaultStudio(_id: StudioId): DBStudio {
 		routeSetsWithOverrides: wrapDefaultObject({}),
 		routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 		packageContainersWithOverrides: wrapDefaultObject({}),
-		previewContainerIds: [],
-		thumbnailContainerIds: [],
+		packageContainerIdsWithOverrides: wrapDefaultObject({
+			previewContainerIds: [],
+			thumbnailContainerIds: [],
+		}),
 		peripheralDeviceSettings: {
 			deviceSettings: wrapDefaultObject({}),
 			playoutDevices: wrapDefaultObject({}),

meteor/server/__tests__/cronjobs.test.ts

@@ -595,8 +595,10 @@ describe('cronjobs', () => {
 				routeSetsWithOverrides: newObjectWithOverrides({}),
 				routeSetExclusivityGroupsWithOverrides: newObjectWithOverrides({}),
 				packageContainersWithOverrides: newObjectWithOverrides({}),
-				previewContainerIds: [],
-				thumbnailContainerIds: [],
+				packageContainerIdsWithOverrides: newObjectWithOverrides({
+					previewContainerIds: [],
+					thumbnailContainerIds: [],
+				}),
 				peripheralDeviceSettings: {
 					deviceSettings: newObjectWithOverrides({}),
 					ingestDevices: newObjectWithOverrides({}),

meteor/server/api/rest/v1/typeConversion.ts

@@ -332,8 +332,10 @@ export async function studioFrom(apiStudio: APIStudio, existingId?: StudioId): P
 		_rundownVersionHash: '',
 		routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 		packageContainersWithOverrides: wrapDefaultObject({}),
-		previewContainerIds: [],
-		thumbnailContainerIds: [],
+		packageContainerIdsWithOverrides: wrapDefaultObject({
+			previewContainerIds: [],
+			thumbnailContainerIds: [],
+		}),
 		peripheralDeviceSettings: {
 			deviceSettings: wrapDefaultObject({}),
 			playoutDevices: wrapDefaultObject({}),

meteor/server/api/studio/api.ts

@@ -61,8 +61,10 @@ export async function insertStudioInner(organizationId: OrganizationId | null, n
 			routeSetsWithOverrides: wrapDefaultObject({}),
 			routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 			packageContainersWithOverrides: wrapDefaultObject({}),
-			thumbnailContainerIds: [],
-			previewContainerIds: [],
+			packageContainerIdsWithOverrides: wrapDefaultObject({
+				thumbnailContainerIds: [],
+				previewContainerIds: [],
+			}),
 			peripheralDeviceSettings: {
 				deviceSettings: wrapDefaultObject({}),
 				playoutDevices: wrapDefaultObject({}),

meteor/server/migration/0_1_0.ts

@@ -44,8 +44,10 @@ export const addSteps = addMigrationSteps('0.1.0', [
 				routeSetsWithOverrides: wrapDefaultObject({}),
 				routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 				packageContainersWithOverrides: wrapDefaultObject({}),
-				thumbnailContainerIds: [],
-				previewContainerIds: [],
+				packageContainerIdsWithOverrides: wrapDefaultObject({
+					thumbnailContainerIds: [],
+					previewContainerIds: [],
+				}),
 				peripheralDeviceSettings: {
 					deviceSettings: wrapDefaultObject({}),
 					playoutDevices: wrapDefaultObject({}),

meteor/server/migration/X_X_X.ts

@@ -1,5 +1,6 @@
 import { addMigrationSteps } from './databaseMigration'
 import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
+import { ContainerIdsToObjectWithOverridesMigrationStep } from './steps/ContainerIdsToObjectWithOverridesMigrationStep'
 
 /*
  * **************************************************************************************
@@ -13,4 +14,6 @@ import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
 
 export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 	// Add your migration here
+
+	new ContainerIdsToObjectWithOverridesMigrationStep(),
 ])

meteor/server/migration/__tests__/migrations.test.ts

@@ -126,8 +126,10 @@ describe('Migrations', () => {
 						routeSetsWithOverrides: wrapDefaultObject({}),
 						routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 						packageContainersWithOverrides: wrapDefaultObject({}),
-						previewContainerIds: [],
-						thumbnailContainerIds: [],
+						packageContainerIdsWithOverrides: wrapDefaultObject({
+							previewContainerIds: [],
+							thumbnailContainerIds: [],
+						}),
 						peripheralDeviceSettings: {
 							deviceSettings: wrapDefaultObject({}),
 							playoutDevices: wrapDefaultObject({}),
@@ -169,8 +171,10 @@ describe('Migrations', () => {
 						routeSetsWithOverrides: wrapDefaultObject({}),
 						routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 						packageContainersWithOverrides: wrapDefaultObject({}),
-						previewContainerIds: [],
-						thumbnailContainerIds: [],
+						packageContainerIdsWithOverrides: wrapDefaultObject({
+							previewContainerIds: [],
+							thumbnailContainerIds: [],
+						}),
 						peripheralDeviceSettings: {
 							deviceSettings: wrapDefaultObject({}),
 							playoutDevices: wrapDefaultObject({}),
@@ -212,8 +216,10 @@ describe('Migrations', () => {
 						routeSetsWithOverrides: wrapDefaultObject({}),
 						routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 						packageContainersWithOverrides: wrapDefaultObject({}),
-						previewContainerIds: [],
-						thumbnailContainerIds: [],
+						packageContainerIdsWithOverrides: wrapDefaultObject({
+							previewContainerIds: [],
+							thumbnailContainerIds: [],
+						}),
 						peripheralDeviceSettings: {
 							deviceSettings: wrapDefaultObject({}),
 							playoutDevices: wrapDefaultObject({}),

meteor/server/migration/databaseMigration.ts

@@ -81,10 +81,8 @@ const coreMigrationSteps: Array<MigrationStepCore> = []
 export function addMigrationSteps(version: string, steps: Array<Omit<MigrationStepCore, 'version'>>) {
 	return (): void => {
 		for (const step of steps) {
-			coreMigrationSteps.push({
-				...step,
-				version: version,
-			})
+			;(step as MigrationStepCore).version = version
+			coreMigrationSteps.push(step as MigrationStepCore)
 		}
 	}
 }
@@ -134,9 +132,9 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 		allMigrationSteps.push({
 			id: step.id,
 			overrideSteps: step.overrideSteps,
-			validate: step.validate,
+			validate: step.validate.bind(step),
 			canBeRunAutomatically: step.canBeRunAutomatically,
-			migrate: step.migrate,
+			migrate: step.migrate?.bind(step),
 			input: step.input,
 			dependOnResultFrom: step.dependOnResultFrom,
 			version: step.version,
@@ -187,9 +185,9 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 							prefixIdsOnStep('blueprint_' + blueprint._id + '_system_', {
 								id: step.id,
 								overrideSteps: step.overrideSteps,
-								validate: step.validate,
+								validate: step.validate.bind(step),
 								canBeRunAutomatically: step.canBeRunAutomatically,
-								migrate: step.migrate,
+								migrate: step.migrate?.bind(step),
 								input: step.input,
 								dependOnResultFrom: step.dependOnResultFrom,
 								version: step.version,

meteor/server/migration/steps/ContainerIdsToObjectWithOverridesMigrationStep.ts

@@ -0,0 +1,55 @@
+import { MigrationStepCore } from '@sofie-automation/blueprints-integration'
+import { Studios } from '../../collections'
+import {
+	convertObjectIntoOverrides,
+	ObjectWithOverrides,
+} from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
+import { StudioPackageContainerIds } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
+
+export class ContainerIdsToObjectWithOverridesMigrationStep implements Omit<MigrationStepCore, 'version'> {
+	public readonly id = `convert previewContainerIds to ObjectWithOverrides`
+	public readonly canBeRunAutomatically = true
+
+	public async validate(): Promise<boolean | string> {
+		const studios = await this.findStudiosToMigrate()
+
+		if (studios.length) {
+			return 'previewContainerIds and thumbnailContainerIds must be converted to an ObjectWithOverrides'
+		}
+
+		return false
+	}
+
+	public async migrate(): Promise<void> {
+		const studios = await this.findStudiosToMigrate()
+
+		for (const studio of studios) {
+			// @ts-expect-error previewContainerIds is typed as string[]
+			const oldPreviewContainerIds = studio.previewContainerIds
+			// @ts-expect-error thumbnailContainerIds is typed as string[]
+			const oldThumbnailContainerIds = studio.thumbnailContainerIds
+
+			const newPackageContainers = convertObjectIntoOverrides({
+				previewContainerIds: oldPreviewContainerIds ?? [],
+				thumbnailContainerIds: oldThumbnailContainerIds ?? [],
+			} satisfies StudioPackageContainerIds) as ObjectWithOverrides<StudioPackageContainerIds>
+
+			await Studios.updateAsync(studio._id, {
+				$set: {
+					packageContainerIdsWithOverrides: newPackageContainers,
+				},
+				$unset: {
+					previewContainerIds: 1,
+					thumbnailContainerIds: 1,
+				},
+			})
+		}
+	}
+
+	private async findStudiosToMigrate() {
+		return Studios.findFetchAsync({
+			$or: [{ previewContainerIds: { $exists: true } }, { thumbnailContainerIds: { $exists: true } }],
+			packageContainerIdsWithOverrides: { $exists: false },
+		})
+	}
+}

meteor/server/publications/packageManager/expectedPackages/generate.ts

@@ -17,6 +17,7 @@ import { CustomPublishCollection } from '../../../lib/customPublication'
 import { logger } from '../../../logging'
 import { ExpectedPackagesContentCache } from './contentCache'
 import type { StudioFields } from './publication'
+import { applyAndValidateOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 /**
  * Regenerate the output for the provided ExpectedPackage `regenerateIds`, updating the data in `collection` as needed
@@ -176,10 +177,7 @@ enum Priorities {
 }
 
 function generateExpectedPackageForDevice(
-	studio: Pick<
-		StudioLight,
-		'_id' | 'packageContainersWithOverrides' | 'previewContainerIds' | 'thumbnailContainerIds'
-	>,
+	studio: Pick<StudioLight, '_id' | 'packageContainerIdsWithOverrides'>,
 	expectedPackage: PackageManagerExpectedPackageBase,
 	deviceId: PeripheralDeviceId,
 	pieceInstanceId: PieceInstanceId | null,
@@ -215,7 +213,9 @@ function generateExpectedPackageForDevice(
 	if (!combinedTargets.length) {
 		logger.warn(`Pub.expectedPackagesForDevice: No targets found for "${expectedPackage._id}"`)
 	}
-	expectedPackage.sideEffect = getSideEffect(expectedPackage, studio)
+
+	const packageContainerIds = applyAndValidateOverrides(studio.packageContainerIdsWithOverrides).obj
+	expectedPackage.sideEffect = getSideEffect(expectedPackage, packageContainerIds)
 
 	return {
 		_id: protectString(`${expectedPackage._id}_${deviceId}_${pieceInstanceId}`),

meteor/server/publications/packageManager/expectedPackages/publication.ts

@@ -58,15 +58,13 @@ export type StudioFields =
 	| 'routeSetsWithOverrides'
 	| 'mappingsWithOverrides'
 	| 'packageContainersWithOverrides'
-	| 'previewContainerIds'
-	| 'thumbnailContainerIds'
+	| 'packageContainerIdsWithOverrides'
 const studioFieldSpecifier = literal<MongoFieldSpecifierOnesStrict<Pick<DBStudio, StudioFields>>>({
 	_id: 1,
 	routeSetsWithOverrides: 1,
 	mappingsWithOverrides: 1,
 	packageContainersWithOverrides: 1,
-	previewContainerIds: 1,
-	thumbnailContainerIds: 1,
+	packageContainerIdsWithOverrides: 1,
 })
 
 async function setupExpectedPackagesPublicationObservers(

meteor/server/publications/pieceContentStatusUI/__tests__/checkPieceContentStatus.test.ts

@@ -260,8 +260,10 @@ describe('lib/mediaObjects', () => {
 		const mockStudio: Complete<PieceContentStatusStudio> = {
 			_id: mockDefaultStudio._id,
 			settings: mockStudioSettings,
-			previewContainerIds: ['previews0'],
-			thumbnailContainerIds: ['thumbnails0'],
+			packageContainerIds: {
+				previewContainerIds: ['previews0'],
+				thumbnailContainerIds: ['thumbnails0'],
+			},
 			routeSets: applyAndValidateOverrides(mockDefaultStudio.routeSetsWithOverrides).obj,
 			mappings: applyAndValidateOverrides(mockDefaultStudio.mappingsWithOverrides).obj,
 			packageContainers: applyAndValidateOverrides(mockDefaultStudio.packageContainersWithOverrides).obj,

meteor/server/publications/pieceContentStatusUI/checkPieceContentStatus.ts

@@ -48,6 +48,7 @@ import {
 import { PieceContentStatusObj } from '@sofie-automation/corelib/dist/dataModel/PieceContentStatus'
 import { PieceContentStatusMessageFactory, PieceContentStatusMessageRequiredArgs } from './messageFactory'
 import { PackageStatusMessage } from '@sofie-automation/shared-lib/dist/packageStatusMessages'
+import { StudioPackageContainerIds } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
 
 const DEFAULT_MESSAGE_FACTORY = new PieceContentStatusMessageFactory(undefined)
 
@@ -195,8 +196,7 @@ export function getMediaObjectMediaId(
 export type PieceContentStatusPiece = Pick<PieceGeneric, '_id' | 'content' | 'expectedPackages' | 'name'> & {
 	pieceInstanceId?: PieceInstanceId
 }
-export interface PieceContentStatusStudio
-	extends Pick<DBStudio, '_id' | 'previewContainerIds' | 'thumbnailContainerIds'> {
+export interface PieceContentStatusStudio extends Pick<DBStudio, '_id'> {
 	/** Mappings between the physical devices / outputs and logical ones */
 	mappings: MappingsExt
 	/** Route sets with overrides */
@@ -206,6 +206,8 @@ export interface PieceContentStatusStudio
 	 */
 	packageContainers: Record<string, StudioPackageContainer>
 
+	packageContainerIds: StudioPackageContainerIds
+
 	settings: IStudioSettings
 }
 
@@ -645,7 +647,7 @@ async function checkPieceContentExpectedPackageStatus(
 					matchedExpectedPackageId = expectedPackageId
 
 					if (!thumbnailUrl) {
-						const sideEffect = getSideEffect(expectedPackage, studio)
+						const sideEffect = getSideEffect(expectedPackage, studio.packageContainerIds)
 
 						thumbnailUrl = await getAssetUrlFromPackageContainerStatus(
 							studio.packageContainers,
@@ -657,7 +659,7 @@ async function checkPieceContentExpectedPackageStatus(
 					}
 
 					if (!previewUrl) {
-						const sideEffect = getSideEffect(expectedPackage, studio)
+						const sideEffect = getSideEffect(expectedPackage, studio.packageContainerIds)
 
 						previewUrl = await getAssetUrlFromPackageContainerStatus(
 							studio.packageContainers,

meteor/server/publications/pieceContentStatusUI/common.ts

@@ -15,16 +15,14 @@ export type StudioFields =
 	| '_id'
 	| 'settingsWithOverrides'
 	| 'packageContainersWithOverrides'
-	| 'previewContainerIds'
-	| 'thumbnailContainerIds'
+	| 'packageContainerIdsWithOverrides'
 	| 'mappingsWithOverrides'
 	| 'routeSetsWithOverrides'
 export const studioFieldSpecifier = literal<MongoFieldSpecifierOnesStrict<Pick<DBStudio, StudioFields>>>({
 	_id: 1,
 	settingsWithOverrides: 1,
 	packageContainersWithOverrides: 1,
-	previewContainerIds: 1,
-	thumbnailContainerIds: 1,
+	packageContainerIdsWithOverrides: 1,
 	mappingsWithOverrides: 1,
 	routeSetsWithOverrides: 1,
 })
@@ -113,8 +111,7 @@ export async function fetchStudio(studioId: StudioId): Promise<PieceContentStatu
 	return {
 		_id: studio._id,
 		settings: applyAndValidateOverrides(studio.settingsWithOverrides).obj,
-		previewContainerIds: studio.previewContainerIds,
-		thumbnailContainerIds: studio.thumbnailContainerIds,
+		packageContainerIds: applyAndValidateOverrides(studio.packageContainerIdsWithOverrides).obj,
 		mappings: applyAndValidateOverrides(studio.mappingsWithOverrides).obj,
 		routeSets: applyAndValidateOverrides(studio.routeSetsWithOverrides).obj,
 		packageContainers: applyAndValidateOverrides(studio.packageContainersWithOverrides).obj,

packages/blueprints-integration/src/api/studio.ts

@@ -26,7 +26,10 @@ import type {
 	StudioRouteSet,
 	StudioRouteSetExclusivityGroup,
 } from '@sofie-automation/shared-lib/dist/core/model/StudioRouteSet'
-import type { StudioPackageContainer } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
+import type {
+	StudioPackageContainer,
+	StudioPackageContainerIds,
+} from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
 import type { IStudioSettings } from '@sofie-automation/shared-lib/dist/core/model/StudioSettings'
 
 export interface StudioBlueprintManifest<TRawConfig = IBlueprintConfig, TProcessedConfig = unknown>
@@ -158,6 +161,8 @@ export interface BlueprintResultApplyStudioConfig {
 	routeSetExclusivityGroups?: Record<string, StudioRouteSetExclusivityGroup>
 	/** Package Containers */
 	packageContainers?: Record<string, StudioPackageContainer>
+	/** Which Package Containers are used for media previews/thumbnails in GUI */
+	packageContainerIds?: StudioPackageContainerIds
 
 	studioSettings?: IStudioSettings
 }

packages/corelib/src/dataModel/Studio.ts

@@ -13,7 +13,10 @@ import {
 	StudioRouteType,
 	StudioAbPlayerDisabling,
 } from '@sofie-automation/shared-lib/dist/core/model/StudioRouteSet'
-import { StudioPackageContainer } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
+import {
+	StudioPackageContainer,
+	StudioPackageContainerIds,
+} from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
 import { IStudioSettings } from '@sofie-automation/shared-lib/dist/core/model/StudioSettings'
 
 export { MappingsExt, MappingExt, MappingsHash, IStudioSettings }
@@ -76,9 +79,8 @@ export interface DBStudio {
 	 */
 	packageContainersWithOverrides: ObjectWithOverrides<Record<string, StudioPackageContainer>>
 
-	/** Which package containers is used for media previews in GUI */
-	previewContainerIds: string[]
-	thumbnailContainerIds: string[]
+	/** Which package containers are used for media previews/thumbnails in GUI */
+	packageContainerIdsWithOverrides: ObjectWithOverrides<StudioPackageContainerIds>
 
 	peripheralDeviceSettings: StudioPeripheralDeviceSettings