feat: configure peripheral device settings from blueprints SOFIE-91

meteor/__mocks__/defaultCollectionObjects.ts

@@ -121,6 +121,7 @@ export function defaultStudio(_id: StudioId): DBStudio {
 		previewContainerIds: [],
 		thumbnailContainerIds: [],
 		peripheralDeviceSettings: {
+			deviceSettings: wrapDefaultObject({}),
 			playoutDevices: wrapDefaultObject({}),
 			ingestDevices: wrapDefaultObject({}),
 			inputDevices: wrapDefaultObject({}),

meteor/__mocks__/helpers/database.ts

@@ -127,8 +127,7 @@ export async function setupMockPeripheralDevice(
 		_id: protectString('mockDevice' + dbI++),
 		name: 'mockDevice',
 		organizationId: null,
-		studioId: studio ? studio._id : undefined,
-		settings: {},
+		studioAndConfigId: studio ? { studioId: studio._id, configId: 'test' } : undefined,
 
 		category: category,
 		type: type,

meteor/server/__tests__/cronjobs.test.ts

@@ -498,7 +498,6 @@ describe('cronjobs', () => {
 					statusCode: StatusCode.GOOD,
 				},
 				token: '',
-				settings: {},
 				...props,
 			})
 

meteor/server/api/__tests__/peripheralDevice.test.ts

@@ -11,10 +11,7 @@ import { getCurrentTime } from '../../lib/lib'
 import { waitUntil } from '../../../__mocks__/helpers/jest'
 import { setupDefaultStudioEnvironment, DefaultEnvironment } from '../../../__mocks__/helpers/database'
 import { setLogLevel } from '../../logging'
-import {
-	IngestDeviceSettings,
-	IngestDeviceSecretSettings,
-} from '@sofie-automation/corelib/dist/dataModel/PeripheralDeviceSettings/ingestDevice'
+import { IngestDeviceSecretSettings } from '@sofie-automation/corelib/dist/dataModel/PeripheralDeviceSettings/ingestDevice'
 import { MediaWorkFlow } from '@sofie-automation/shared-lib/dist/core/model/MediaWorkFlows'
 import { MediaWorkFlowStep } from '@sofie-automation/shared-lib/dist/core/model/MediaWorkFlowSteps'
 import { MediaManagerAPI } from '@sofie-automation/meteor-lib/dist/api/mediaManager'
@@ -412,7 +409,7 @@ describe('test peripheralDevice general API methods', () => {
 		expect(QueueStudioJobSpy).toHaveBeenNthCalledWith(
 			1,
 			StudioJobs.OnPlayoutPlaybackChanged,
-			device.studioId,
+			device.studioAndConfigId!.studioId,
 			literal<Parameters<StudioJobFunc[StudioJobs.OnPlayoutPlaybackChanged]>[0]>({
 				playlistId: rundownPlaylistID,
 				changes: [
@@ -474,7 +471,7 @@ describe('test peripheralDevice general API methods', () => {
 		expect(QueueStudioJobSpy).toHaveBeenNthCalledWith(
 			1,
 			StudioJobs.OnTimelineTriggerTime,
-			device.studioId,
+			device.studioAndConfigId!.studioId,
 			literal<OnTimelineTriggerTimeProps>({
 				results: timelineTriggerTimeResult,
 			})
@@ -556,7 +553,7 @@ describe('test peripheralDevice general API methods', () => {
 		expect((deviceWithSecretToken.secretSettings as IngestDeviceSecretSettings).accessToken).toBe(
 			'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 		)
-		expect((deviceWithSecretToken.settings as IngestDeviceSettings).secretAccessToken).toBe(true)
+		expect(deviceWithSecretToken.secretSettingsStatus?.accessToken).toBe(true)
 	})
 
 	test('uninitialize', async () => {
@@ -643,8 +640,10 @@ describe('test peripheralDevice general API methods', () => {
 				organizationId: null,
 				name: 'Mock Media Manager',
 				deviceName: 'Media Manager',
-				studioId: env.studio._id,
-				settings: {},
+				studioAndConfigId: {
+					studioId: env.studio._id,
+					configId: 'test',
+				},
 				category: PeripheralDeviceCategory.MEDIA_MANAGER,
 				configManifest: {
 					deviceConfigSchema: JSONBlobStringify({}),
@@ -670,7 +669,7 @@ describe('test peripheralDevice general API methods', () => {
 				deviceId: device._id,
 				priority: 1,
 				source: 'MockSource',
-				studioId: device.studioId!,
+				studioId: device.studioAndConfigId!.studioId,
 				finished: false,
 				success: false,
 			})
@@ -682,7 +681,7 @@ describe('test peripheralDevice general API methods', () => {
 				deviceId: device._id,
 				priority: 2,
 				status: MediaManagerAPI.WorkStepStatus.IDLE,
-				studioId: device.studioId!,
+				studioId: device.studioAndConfigId!.studioId,
 				workFlowId: workFlowId,
 			})
 			await MediaWorkFlowSteps.insertAsync({
@@ -693,14 +692,14 @@ describe('test peripheralDevice general API methods', () => {
 				deviceId: device._id,
 				priority: 1,
 				status: MediaManagerAPI.WorkStepStatus.IDLE,
-				studioId: device.studioId!,
+				studioId: device.studioAndConfigId!.studioId,
 				workFlowId: workFlowId,
 			})
 		})
 		test('getMediaWorkFlowRevisions', async () => {
 			const workFlows = (
 				await MediaWorkFlows.findFetchAsync({
-					studioId: device.studioId,
+					studioId: device.studioAndConfigId!.studioId,
 				})
 			).map((wf) => ({
 				_id: wf._id,
@@ -714,7 +713,7 @@ describe('test peripheralDevice general API methods', () => {
 		test('getMediaWorkFlowStepRevisions', async () => {
 			const workFlowSteps = (
 				await MediaWorkFlowSteps.findFetchAsync({
-					studioId: device.studioId,
+					studioId: device.studioAndConfigId!.studioId,
 				})
 			).map((wf) => ({
 				_id: wf._id,
@@ -799,8 +798,10 @@ describe('test peripheralDevice general API methods', () => {
 				organizationId: null,
 				name: 'Mock Media Manager',
 				deviceName: 'Media Manager',
-				studioId: env.studio._id,
-				settings: {},
+				studioAndConfigId: {
+					studioId: env.studio._id,
+					configId: 'test',
+				},
 				category: PeripheralDeviceCategory.MEDIA_MANAGER,
 				configManifest: {
 					deviceConfigSchema: JSONBlobStringify({}),
@@ -834,7 +835,7 @@ describe('test peripheralDevice general API methods', () => {
 				mediaSize: 10,
 				mediaTime: 0,
 				objId: MOCK_OBJID,
-				studioId: device.studioId!,
+				studioId: device.studioAndConfigId!.studioId,
 				thumbSize: 0,
 				thumbTime: 0,
 				tinf: '',
@@ -843,7 +844,7 @@ describe('test peripheralDevice general API methods', () => {
 		test('getMediaObjectRevisions', async () => {
 			const mobjects = (
 				await MediaObjects.findFetchAsync({
-					studioId: device.studioId,
+					studioId: device.studioAndConfigId!.studioId,
 				})
 			).map((mo) => ({
 				_id: mo._id,
@@ -864,7 +865,7 @@ describe('test peripheralDevice general API methods', () => {
 			test('update', async () => {
 				const mo = (await MediaObjects.findOneAsync({
 					collectionId: MOCK_COLLECTION,
-					studioId: device.studioId!,
+					studioId: device.studioAndConfigId!.studioId,
 				})) as MediaObject
 				expect(mo).toBeTruthy()
 
@@ -882,14 +883,14 @@ describe('test peripheralDevice general API methods', () => {
 
 				const updateMo = await MediaObjects.findOneAsync({
 					collectionId: MOCK_COLLECTION,
-					studioId: device.studioId!,
+					studioId: device.studioAndConfigId!.studioId,
 				})
 				expect(updateMo).toMatchObject(newMo)
 			})
 			test('remove', async () => {
 				const mo = (await MediaObjects.findOneAsync({
 					collectionId: MOCK_COLLECTION,
-					studioId: device.studioId!,
+					studioId: device.studioAndConfigId!.studioId,
 				})) as MediaObject
 				expect(mo).toBeTruthy()
 
@@ -903,7 +904,7 @@ describe('test peripheralDevice general API methods', () => {
 
 				const updateMo = await MediaObjects.findOneAsync({
 					collectionId: MOCK_COLLECTION,
-					studioId: device.studioId!,
+					studioId: device.studioAndConfigId!.studioId,
 				})
 				expect(updateMo).toBeFalsy()
 			})

meteor/server/api/__tests__/userActions/system.test.ts

@@ -40,7 +40,6 @@ describe('User Actions - Disable Peripheral SubDevice', () => {
 			env.studio,
 			{
 				organizationId,
-				settings: {},
 				configManifest: {
 					deviceConfigSchema: JSONBlobStringify({}), // unused
 					subdeviceManifest: {
@@ -165,7 +164,6 @@ describe('User Actions - Disable Peripheral SubDevice', () => {
 			env.studio,
 			{
 				organizationId: null,
-				settings: {},
 				configManifest: {
 					deviceConfigSchema: JSONBlobStringify({}), // unused
 					subdeviceManifest: {

meteor/server/api/deviceTriggers/observer.ts

@@ -102,7 +102,7 @@ export async function receiveInputDeviceTrigger(
 	check(deviceId, String)
 	check(triggerId, String)
 
-	const studioId = peripheralDevice.studioId
+	const studioId = peripheralDevice.studioAndConfigId?.studioId
 	if (!studioId) throw new Meteor.Error(400, `Peripheral Device "${peripheralDevice._id}" not assigned to a studio`)
 
 	logger.debug(

meteor/server/api/integration/expectedPackages.ts

@@ -32,6 +32,7 @@ import {
 	PackageInfos,
 } from '../../collections'
 import { logger } from '../../logging'
+import _ from 'underscore'
 
 export namespace PackageManagerIntegration {
 	export async function updateExpectedPackageWorkStatuses(
@@ -58,7 +59,7 @@ export namespace PackageManagerIntegration {
 		type FromPackage = Omit<ExpectedPackageStatusAPI.WorkBaseInfoFromPackage, 'id'> & { id: ExpectedPackageId }
 
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
-		if (!peripheralDevice.studioId)
+		if (!peripheralDevice.studioAndConfigId)
 			throw new Meteor.Error(400, 'Device "' + peripheralDevice._id + '" has no studio')
 
 		const bulkChanges: AnyBulkWriteOperation<ExpectedPackageWorkStatus>[] = []
@@ -150,11 +151,11 @@ export namespace PackageManagerIntegration {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
 
 		await ExpectedPackageWorkStatuses.removeAsync({
-			$or: [
+			$or: _.compact([
 				{ deviceId: peripheralDevice._id },
 				// Since we only have one PM in a studio, we can remove everything in the studio:
-				{ studioId: peripheralDevice.studioId },
-			],
+				peripheralDevice.studioAndConfigId ? { studioId: peripheralDevice.studioAndConfigId.studioId } : null,
+			]),
 		})
 	}
 
@@ -177,10 +178,10 @@ export namespace PackageManagerIntegration {
 		)[]
 	): Promise<void> {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
-		if (!peripheralDevice.studioId)
+		if (!peripheralDevice.studioAndConfigId)
 			throw new Meteor.Error(400, 'Device "' + peripheralDevice._id + '" has no studio')
 
-		const studioId = peripheralDevice.studioId
+		const studioId = peripheralDevice.studioAndConfigId.studioId
 
 		const removedIds: PackageContainerPackageId[] = []
 		const ps: Promise<unknown>[] = []
@@ -189,7 +190,7 @@ export namespace PackageManagerIntegration {
 			check(change.packageId, String)
 
 			const id = getPackageContainerPackageId(
-				peripheralDevice.studioId,
+				peripheralDevice.studioAndConfigId.studioId,
 				change.containerId,
 				protectString(change.packageId)
 			)
@@ -245,11 +246,11 @@ export namespace PackageManagerIntegration {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
 
 		await PackageContainerPackageStatuses.removeAsync({
-			$or: [
+			$or: _.compact([
 				{ deviceId: peripheralDevice._id },
 				// Since we only have one PM in a studio, we can remove everything in the studio:
-				{ studioId: peripheralDevice.studioId },
-			],
+				peripheralDevice.studioAndConfigId ? { studioId: peripheralDevice.studioAndConfigId.studioId } : null,
+			]),
 		})
 	}
 
@@ -270,17 +271,17 @@ export namespace PackageManagerIntegration {
 		)[]
 	): Promise<void> {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
-		if (!peripheralDevice.studioId)
+		if (!peripheralDevice.studioAndConfigId)
 			throw new Meteor.Error(400, 'Device "' + peripheralDevice._id + '" has no studio')
 
-		const studioId = peripheralDevice.studioId
+		const studioId = peripheralDevice.studioAndConfigId.studioId
 
 		const removedIds: PackageContainerId[] = []
 		const ps: Promise<unknown>[] = []
 		for (const change of changes) {
 			check(change.containerId, String)
 
-			const id = getPackageContainerId(peripheralDevice.studioId, change.containerId)
+			const id = getPackageContainerId(peripheralDevice.studioAndConfigId.studioId, change.containerId)
 
 			if (change.type === 'delete') {
 				removedIds.push(id)
@@ -332,11 +333,11 @@ export namespace PackageManagerIntegration {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
 
 		await PackageContainerStatuses.removeAsync({
-			$or: [
+			$or: _.compact([
 				{ deviceId: peripheralDevice._id },
 				// Since we only have one PM in a studio, we can remove everything in the studio:
-				{ studioId: peripheralDevice.studioId },
-			],
+				peripheralDevice.studioAndConfigId ? { studioId: peripheralDevice.studioAndConfigId.studioId } : null,
+			]),
 		})
 	}
 
@@ -352,7 +353,7 @@ export namespace PackageManagerIntegration {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
 		check(packageIds, [String])
 		check(type, String)
-		if (!peripheralDevice.studioId)
+		if (!peripheralDevice.studioAndConfigId)
 			throw new Meteor.Error(400, 'Device "' + peripheralDevice._id + '" has no studio')
 
 		const ids = packageIds.map((packageId) => getPackageInfoId(packageId, type))
@@ -386,7 +387,7 @@ export namespace PackageManagerIntegration {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
 		check(packageId, String)
 		check(type, String)
-		if (!peripheralDevice.studioId)
+		if (!peripheralDevice.studioAndConfigId)
 			throw new Meteor.Error(400, 'Device "' + peripheralDevice._id + '" has no studio')
 
 		const id = getPackageInfoId(packageId, type)
@@ -398,7 +399,7 @@ export namespace PackageManagerIntegration {
 			expectedContentVersionHash: expectedContentVersionHash,
 			actualContentVersionHash: actualContentVersionHash,
 
-			studioId: peripheralDevice.studioId,
+			studioId: peripheralDevice.studioAndConfigId.studioId,
 
 			deviceId: peripheralDevice._id,
 
@@ -425,7 +426,7 @@ export namespace PackageManagerIntegration {
 		const peripheralDevice = await checkAccessAndGetPeripheralDevice(deviceId, deviceToken, context)
 		check(packageId, String)
 		check(type, String)
-		if (!peripheralDevice.studioId)
+		if (!peripheralDevice.studioAndConfigId)
 			throw new Meteor.Error(400, 'Device "' + peripheralDevice._id + '" has no studio')
 
 		const id = getPackageInfoId(packageId, type)