feat: Add support for Gateway configuration from the studio API (Sofie-Automation#1539)

Co-authored-by: Simon Rogers <[email protected]>

Author: scriptorian

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

@@ -9,7 +9,7 @@ import { Meteor } from 'meteor/meteor'
 import { ClientAPI } from '@sofie-automation/meteor-lib/dist/api/client'
 import { PeripheralDevices, RundownPlaylists, Studios } from '../../../collections'
 import { APIStudioFrom, studioFrom, validateAPIBlueprintConfigForStudio } from './typeConversion'
-import { runUpgradeForStudio, validateConfigForStudio } from '../../../migration/upgrades'
+import { runUpgradeForStudio, updateStudioBaseline, validateConfigForStudio } from '../../../migration/upgrades'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { ServerClientAPI } from '../../client'
 import { assertNever, literal } from '@sofie-automation/corelib/dist/lib'
@@ -62,6 +62,7 @@ class StudiosServerAPI implements StudiosRestAPI {
 		checkValidation(`addStudio ${newStudioId}`, validation.messages)
 
 		await runUpgradeForStudio(newStudioId)
+		await updateStudioBaseline(newStudioId)
 		return ClientAPI.responseSuccess(unprotectString(newStudioId), 200)
 	}
 
@@ -81,7 +82,7 @@ class StudiosServerAPI implements StudiosRestAPI {
 		_event: string,
 		studioId: StudioId,
 		apiStudio: APIStudio
-	): Promise<ClientAPI.ClientResponse<void>> {
+	): Promise<ClientAPI.ClientResponse<string | false>> {
 		const blueprintConfigValidation = await validateAPIBlueprintConfigForStudio(apiStudio)
 		checkValidation(`addOrUpdateStudio ${studioId}`, blueprintConfigValidation)
 
@@ -105,13 +106,15 @@ class StudiosServerAPI implements StudiosRestAPI {
 
 		await Studios.upsertAsync(studioId, newStudio)
 
-		// wait for the upsert to complete before validation and upgrade read from the studios collection
-		await new Promise<void>((resolve) => setTimeout(() => resolve(), 200))
-
 		const validation = await validateConfigForStudio(studioId)
 		checkValidation(`addOrUpdateStudio ${studioId}`, validation.messages)
 
-		return ClientAPI.responseSuccess(await runUpgradeForStudio(studioId))
+		// wait for the upsert to complete before upgrade
+		await new Promise<void>((resolve) => setTimeout(() => resolve(), 200))
+
+		await runUpgradeForStudio(studioId)
+
+		return ClientAPI.responseSuccess(await updateStudioBaseline(studioId))
 	}
 
 	async getStudioConfig(
@@ -130,7 +133,7 @@ class StudiosServerAPI implements StudiosRestAPI {
 		_event: string,
 		studioId: StudioId,
 		config: object
-	): Promise<ClientAPI.ClientResponse<void>> {
+	): Promise<ClientAPI.ClientResponse<string | false>> {
 		const existingStudio = await Studios.findOneAsync(studioId)
 		if (!existingStudio) {
 			throw new Meteor.Error(404, `Studio ${studioId} not found`)
@@ -147,13 +150,15 @@ class StudiosServerAPI implements StudiosRestAPI {
 
 		await Studios.upsertAsync(studioId, newStudio)
 
-		// wait for the upsert to complete before validation and upgrade read from the studios collection
-		await new Promise<void>((resolve) => setTimeout(() => resolve(), 200))
-
 		const validation = await validateConfigForStudio(studioId)
 		checkValidation(`updateStudioConfig ${studioId}`, validation.messages)
 
-		return ClientAPI.responseSuccess(await runUpgradeForStudio(studioId))
+		// wait for the upsert to complete before upgrade
+		await new Promise<void>((resolve) => setTimeout(() => resolve(), 200))
+
+		await runUpgradeForStudio(studioId)
+
+		return ClientAPI.responseSuccess(await updateStudioBaseline(studioId))
 	}
 
 	async deleteStudio(
@@ -413,7 +418,7 @@ export function registerRoutes(registerRoute: APIRegisterHook<StudiosRestAPI>):
 		}
 	)
 
-	registerRoute<{ studioId: string }, APIStudio, void>(
+	registerRoute<{ studioId: string }, APIStudio, string | false>(
 		'put',
 		'/studios/:studioId',
 		new Map([
@@ -444,7 +449,7 @@ export function registerRoutes(registerRoute: APIRegisterHook<StudiosRestAPI>):
 		}
 	)
 
-	registerRoute<{ studioId: string }, object, void>(
+	registerRoute<{ studioId: string }, object, string | false>(
 		'put',
 		'/studios/:studioId/config',
 		new Map([

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

@@ -119,7 +119,7 @@ export async function showStyleBaseFrom(
 		outputLayersWithOverrides: outputLayers,
 		sourceLayersWithOverrides: sourceLayers,
 		blueprintConfigWithOverrides: blueprintConfig,
-		_rundownVersionHash: '',
+		_rundownVersionHash: showStyleBase?._rundownVersionHash ?? '',
 		lastBlueprintConfig: undefined,
 		lastBlueprintFixUpHash: undefined,
 	}
@@ -339,14 +339,15 @@ export async function studioFrom(apiStudio: APIStudio, existingId?: StudioId): P
 			? updateOverrides(studio.settingsWithOverrides, studioSettings)
 			: wrapDefaultObject(studioSettings),
 		supportedShowStyleBase: apiStudio.supportedShowStyleBase?.map((id) => protectString<ShowStyleBaseId>(id)) ?? [],
-		mappingsWithOverrides: wrapDefaultObject({}),
-		routeSetsWithOverrides: wrapDefaultObject({}),
-		_rundownVersionHash: '',
+		mappingsWithOverrides: studio?.mappingsWithOverrides ?? wrapDefaultObject({}),
+		mappingsHash: studio?.mappingsHash,
+		routeSetsWithOverrides: studio?.routeSetsWithOverrides ?? wrapDefaultObject({}),
+		_rundownVersionHash: studio?._rundownVersionHash ?? '',
 		routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
 		packageContainersWithOverrides: wrapDefaultObject({}),
 		previewContainerIds: [],
 		thumbnailContainerIds: [],
-		peripheralDeviceSettings: {
+		peripheralDeviceSettings: studio?.peripheralDeviceSettings ?? {
 			deviceSettings: wrapDefaultObject({}),
 			playoutDevices: wrapDefaultObject({}),
 			ingestDevices: wrapDefaultObject({}),

meteor/server/lib/rest/v1/studios.ts

@@ -55,7 +55,7 @@ export interface StudiosRestAPI {
 		event: string,
 		studioId: StudioId,
 		studio: APIStudio
-	): Promise<ClientAPI.ClientResponse<void>>
+	): Promise<ClientAPI.ClientResponse<string | false>>
 	/**
 	 * Gets a Studio config, if it exists.
 	 *
@@ -83,7 +83,7 @@ export interface StudiosRestAPI {
 		event: string,
 		studioId: StudioId,
 		config: object
-	): Promise<ClientAPI.ClientResponse<void>>
+	): Promise<ClientAPI.ClientResponse<string | false>>
 	/**
 	 * Deletes a Studio.
 	 *

meteor/server/migration/upgrades/studio.ts

@@ -79,3 +79,19 @@ export async function runUpgradeForStudio(studioId: StudioId): Promise<void> {
 		span?.end()
 	}
 }
+
+export async function updateStudioBaseline(studioId: StudioId): Promise<string | false> {
+	logger.info(`Running baseline update for Studio "${studioId}"`)
+	await getStudio(studioId)
+
+	const queuedJob = await QueueStudioJob(StudioJobs.UpdateStudioBaseline, studioId, undefined)
+
+	const span = profiler.startSpan('queued-job')
+	try {
+		const res = await queuedJob.complete
+		// explicitly await before returning
+		return res
+	} finally {
+		span?.end()
+	}
+}

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

@@ -155,11 +155,11 @@ export interface BlueprintResultApplyStudioConfig {
 	/** Parent device settings */
 	parentDevices: Record<string, BlueprintParentDeviceSettings>
 	/** Playout-gateway subdevices */
-	playoutDevices: Record<string, { parentDeviceName?: string; options: TSR.DeviceOptionsAny }>
+	playoutDevices: Record<string, { parentConfigId?: string; options: TSR.DeviceOptionsAny }>
 	/** Ingest-gateway subdevices, the types here depend on the gateway you use */
-	ingestDevices: Record<string, { parentDeviceName?: string; options: BlueprintMosDeviceConfig | unknown }>
+	ingestDevices: Record<string, { parentConfigId?: string; options: BlueprintMosDeviceConfig | unknown }>
 	/** Input-gateway subdevices */
-	inputDevices: Record<string, { parentDeviceName?: string; options: unknown }>
+	inputDevices: Record<string, { parentConfigId?: string; options: unknown }>
 	/** Route Sets */
 	routeSets?: Record<string, StudioRouteSet>
 	/** Route Set Exclusivity Groups */

packages/job-worker/src/db/collections.ts

@@ -102,7 +102,7 @@ export interface IDirectCollections {
 	NrcsIngestDataCache: ICollection<NrcsIngestDataCacheObj>
 	Parts: ICollection<DBPart>
 	PartInstances: ICollection<DBPartInstance>
-	PeripheralDevices: IReadOnlyCollection<PeripheralDevice>
+	PeripheralDevices: ICollection<PeripheralDevice>
 	PeripheralDeviceCommands: ICollection<PeripheralDeviceCommand>
 	Pieces: ICollection<Piece>
 	PieceInstances: ICollection<PieceInstance>

packages/job-worker/src/playout/upgrade.ts

@@ -18,7 +18,7 @@ import {
 	StudioRouteSetExclusivityGroup,
 } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { Complete, clone, literal } from '@sofie-automation/corelib/dist/lib'
-import { protectString } from '@sofie-automation/corelib/dist/protectedString'
+import { protectString, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
 import { applyAndValidateOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 import { wrapTranslatableMessageFromBlueprints } from '@sofie-automation/corelib/dist/TranslatableMessage'
 import {
@@ -31,6 +31,7 @@ import { JobContext } from '../jobs/index.js'
 import { FixUpBlueprintConfigContext } from '@sofie-automation/corelib/dist/fixUpBlueprintConfig/context'
 import { DEFAULT_MINIMUM_TAKE_SPAN } from '@sofie-automation/shared-lib/dist/core/constants'
 import { PERIPHERAL_SUBTYPE_PROCESS, PeripheralDevice } from '@sofie-automation/corelib/dist/dataModel/PeripheralDevice'
+import { PeripheralDeviceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 
 /**
  * Run the Blueprint applyConfig for the studio
@@ -64,20 +65,53 @@ export async function handleBlueprintUpgradeForStudio(context: JobContext, _data
 		])
 	)
 
-	const peripheralDevices = (await context.directCollections.PeripheralDevices.findFetch(
-		{ subType: PERIPHERAL_SUBTYPE_PROCESS, 'studioAndConfigId.studioId': context.studioId },
+	const allPeripheralDevices = (await context.directCollections.PeripheralDevices.findFetch(
+		{ subType: PERIPHERAL_SUBTYPE_PROCESS },
 		{ projection: { _id: 1, studioAndConfigId: 1 } }
 	)) as Array<Pick<PeripheralDevice, '_id' | 'studioAndConfigId'>>
 
+	const configIdMap = new Map<string, PeripheralDeviceId>() // configId -> deviceId
+	for (const pd of allPeripheralDevices) {
+		if (pd.studioAndConfigId) configIdMap.set(pd.studioAndConfigId.configId, pd._id)
+	}
+
+	// Assign configId and name to peripheral devices
+	for (const configId in parentDevices) {
+		const peripheralDevice = allPeripheralDevices.find((pd) => unprotectString(pd._id).startsWith(configId))
+		if (peripheralDevice) {
+			if (configIdMap.has(configId)) {
+				// Need to ensure there is only one reference to a configId in the peripheralDevices collection
+				const existingPeripheralDeviceId = configIdMap.get(configId)
+				await context.directCollections.PeripheralDevices.update(
+					{
+						studioAndConfigId: { studioId: context.studioId, configId: configId },
+						_id: { $ne: existingPeripheralDeviceId ?? protectString('') },
+					},
+					{
+						$unset: {
+							studioAndConfigId: 1,
+						},
+					}
+				)
+				configIdMap.delete(configId)
+			}
+			await context.directCollections.PeripheralDevices.update(peripheralDevice._id, {
+				$set: {
+					studioAndConfigId: { studioId: context.studioId, configId: configId },
+				},
+			})
+			configIdMap.set(configId, peripheralDevice._id)
+		}
+	}
+
 	const playoutDevices = Object.fromEntries(
-		Object.entries<{ parentDeviceName?: string; options: TSR.DeviceOptionsAny }>(result.playoutDevices ?? {}).map(
+		Object.entries<{ parentConfigId?: string; options: TSR.DeviceOptionsAny }>(result.playoutDevices ?? {}).map(
 			(dev) => {
+				const parentConfigId = dev[1].parentConfigId
 				return [
 					dev[0],
 					literal<Complete<StudioPlayoutDevice>>({
-						peripheralDeviceId: peripheralDevices.find(
-							(p) => p.studioAndConfigId?.configId === dev[1].parentDeviceName
-						)?._id,
+						peripheralDeviceId: parentConfigId ? configIdMap.get(parentConfigId) : undefined,
 						options: dev[1].options,
 					}),
 				]
@@ -86,27 +120,25 @@ export async function handleBlueprintUpgradeForStudio(context: JobContext, _data
 	)
 
 	const ingestDevices = Object.fromEntries(
-		Object.entries<{ parentDeviceName?: string; options: unknown }>(result.ingestDevices ?? {}).map((dev) => {
+		Object.entries<{ parentConfigId?: string; options: unknown }>(result.ingestDevices ?? {}).map((dev) => {
+			const parentConfigId = dev[1].parentConfigId
 			return [
 				dev[0],
 				literal<Complete<StudioIngestDevice>>({
-					peripheralDeviceId: peripheralDevices.find(
-						(p) => p.studioAndConfigId?.configId === dev[1].parentDeviceName
-					)?._id,
+					peripheralDeviceId: parentConfigId ? configIdMap.get(parentConfigId) : undefined,
 					options: dev[1].options,
 				}),
 			]
 		})
 	)
 
 	const inputDevices = Object.fromEntries(
-		Object.entries<{ parentDeviceName?: string; options: unknown }>(result.inputDevices ?? {}).map((dev) => {
+		Object.entries<{ parentConfigId?: string; options: unknown }>(result.inputDevices ?? {}).map((dev) => {
+			const parentConfigId = dev[1].parentConfigId
 			return [
 				dev[0],
 				literal<Complete<StudioInputDevice>>({
-					peripheralDeviceId: peripheralDevices.find(
-						(p) => p.studioAndConfigId?.configId === dev[1].parentDeviceName
-					)?._id,
+					peripheralDeviceId: parentConfigId ? configIdMap.get(parentConfigId) : undefined,
 					options: dev[1].options,
 				}),
 			]

packages/mos-gateway/src/$schemas/options.json

@@ -44,10 +44,10 @@
 					"default": 10542
 				}
 			},
-			"required": ["lower", "upper", "query"],
+			"required": [],
 			"additionalProperties": false
 		}
 	},
-	"required": ["mosId"],
+	"required": ["mosId", "ports"],
 	"additionalProperties": false
 }

packages/webui/src/client/ui/Settings/SettingsMenu.tsx

@@ -530,6 +530,7 @@ function SettingsMenuPeripheralDevice({ device }: Readonly<SettingsMenuPeriphera
 				<p>
 					{device.connected ? t('Connected') : t('Disconnected')}, {t('Status')}:{' '}
 					{statusCodeString(t, device.status.statusCode)}
+					{configIdString(t, device.studioAndConfigId?.configId)}
 				</p>
 			</NavLink>
 			<hr className="vsubtle" />
@@ -558,3 +559,8 @@ function statusCodeString(t: TFunction, statusCode: StatusCode): string {
 			return t('Fatal')
 	}
 }
+
+function configIdString(t: TFunction, configId: string | undefined): string {
+	if (configId) return t(', Config ID: ') + configId
+	else return t(', Unconfigured')
+}

packages/webui/src/client/ui/Settings/Studio/Devices/GenericSubDevices.tsx

@@ -50,7 +50,7 @@ export function GenericSubDevicesTable({
 				device._id,
 				literal<PeripheralDeviceTranslated>({
 					_id: device._id,
-					name: device.name || unprotectString(device._id),
+					name: device.studioAndConfigId?.configId || device.name || unprotectString(device._id),
 					subdeviceConfigSchema: device.configManifest?.subdeviceConfigSchema,
 					subdeviceManifest: device.configManifest?.subdeviceManifest ?? {},
 				})
@@ -115,7 +115,7 @@ export function GenericSubDevicesTable({
 			<thead>
 				<tr className="hl">
 					<th key="ID">ID</th>
-					<th key="Parent">{t('Parent')}</th>
+					<th key="Parent">{t('Parent Config ID')}</th>
 					<th key="Type">{t('Type')}</th>
 					<th key="action">&nbsp;</th>
 				</tr>
@@ -282,7 +282,7 @@ function SubDeviceEditRow({
 			<td colSpan={99}>
 				<div className="properties-grid">
 					<LabelAndOverridesForDropdown
-						label={t('Peripheral Device ID')}
+						label={t('Parent Config ID')}
 						item={item}
 						overrideHelper={overrideHelper}
 						itemKey={'peripheralDeviceId'}