Merge pull request #1431 from bbc:upstream/fix-peripheraldevice-subdevice-page-crash

fix: PeripheralDevice.configManifest is an optional field

Author: nytamin

meteor/server/api/peripheralDevice.ts

@@ -34,7 +34,6 @@ import { PackageManagerIntegration } from './integration/expectedPackages'
 import { profiler } from './profiler'
 import { QueueStudioJob } from '../worker/worker'
 import { StudioJobs } from '@sofie-automation/corelib/dist/worker/studio'
-import { DeviceConfigManifest } from '@sofie-automation/corelib/dist/deviceConfig'
 import {
 	PlayoutChangedResults,
 	PeripheralDeviceInitOptions,
@@ -58,7 +57,7 @@ import { insertInputDeviceTriggerIntoPreview } from '../publications/deviceTrigg
 import { receiveInputDeviceTrigger } from './deviceTriggers/observer'
 import { upsertBundles, generateTranslationBundleOriginId } from './translationsBundles'
 import { isTranslatableMessage } from '@sofie-automation/corelib/dist/TranslatableMessage'
-import { JSONBlobParse, JSONBlobStringify } from '@sofie-automation/shared-lib/dist/lib/JSONBlob'
+import { JSONBlobParse } from '@sofie-automation/shared-lib/dist/lib/JSONBlob'
 import {
 	applyAndValidateOverrides,
 	SomeObjectOverrideOp,
@@ -132,7 +131,7 @@ export namespace ServerPeripheralDeviceAPI {
 						: undefined,
 
 					documentationUrl: options.documentationUrl,
-				},
+				} satisfies Partial<PeripheralDevice>,
 				$unset:
 					newVersionsStr !== oldVersionsStr
 						? {
@@ -168,10 +167,7 @@ export namespace ServerPeripheralDeviceAPI {
 							...options.configManifest,
 							translations: undefined,
 						}
-					: literal<DeviceConfigManifest>({
-							deviceConfigSchema: JSONBlobStringify({}),
-							subdeviceManifest: {},
-						}),
+					: undefined,
 
 				documentationUrl: options.documentationUrl,
 			})

packages/corelib/src/dataModel/PeripheralDevice.ts

@@ -79,7 +79,10 @@ export interface PeripheralDevice {
 	/** Ignore this device when computing status in the GUI (other status reports are unaffected) */
 	ignore?: boolean
 
-	configManifest: DeviceConfigManifest
+	/**
+	 * If this device is a parent-device, the config manifest for the device
+	 */
+	configManifest: DeviceConfigManifest | undefined
 
 	/** If this is an ingest gateway, the last tiem data was received */
 	lastDataReceived?: Time

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

@@ -196,7 +196,9 @@ export default translateWithTracker<IDeviceSettingsProps, IDeviceSettingsState,
 						</div>
 					</div>
 
-					<GenericAttahcedSubDeviceSettingsComponent device={device} subDevices={this.props.subDevices} />
+					{!device.parentDeviceId && (
+						<GenericAttahcedSubDeviceSettingsComponent device={device} subDevices={this.props.subDevices} />
+					)}
 
 					{device &&
 					device.type === PeripheralDeviceType.PACKAGE_MANAGER &&

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

@@ -51,8 +51,8 @@ export function GenericSubDevicesTable({
 				literal<PeripheralDeviceTranslated>({
 					_id: device._id,
 					name: device.name || unprotectString(device._id),
-					subdeviceConfigSchema: device.configManifest.subdeviceConfigSchema,
-					subdeviceManifest: device.configManifest.subdeviceManifest,
+					subdeviceConfigSchema: device.configManifest?.subdeviceConfigSchema,
+					subdeviceManifest: device.configManifest?.subdeviceManifest ?? {},
 				})
 			)
 		}

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

@@ -132,7 +132,7 @@ interface PeripheralDeviceTranslated {
 	_id: PeripheralDeviceId
 	name: string
 	lastSeen: number
-	deviceConfigSchema: JSONBlob<JSONSchema>
+	deviceConfigSchema: JSONBlob<JSONSchema> | undefined
 }
 
 interface ParentDevicesTableProps {
@@ -172,7 +172,7 @@ function GenericParentDevicesTable({
 					_id: device._id,
 					name: device.name || unprotectString(device._id),
 					lastSeen: device.lastSeen,
-					deviceConfigSchema: device.configManifest.deviceConfigSchema,
+					deviceConfigSchema: device.configManifest?.deviceConfigSchema,
 				})
 			)
 		}

packages/webui/src/client/ui/Settings/components/ConfigManifestOAuthFlow.tsx

@@ -125,11 +125,13 @@ export const ConfigManifestOAuthFlowComponent = withTranslation()(
 				})
 		}
 
-		render(): JSX.Element {
+		render(): JSX.Element | null {
 			const { t } = this.props
 			const secretStatus = (this.props.device.secretSettingsStatus || {}) as IngestDeviceSecretSettingsStatus
 			const device = this.props.device
 
+			if (!device.configManifest) return null
+
 			return (
 				<div>
 					{secretStatus.accessToken ? (

packages/webui/src/client/ui/Settings/components/GenericDeviceSettingsComponent.tsx

@@ -53,7 +53,7 @@ export function GenericAttahcedSubDeviceSettingsComponent({
 
 	return (
 		<>
-			{Object.keys(device.configManifest.subdeviceManifest ?? {}).length > 0 && (
+			{Object.keys(device.configManifest?.subdeviceManifest ?? {}).length > 0 && (
 				<>
 					<h2 className="mb-4">{t('Attached Subdevices')}</h2>