wip: split out secretSettingsStatus

Author: Julusian

meteor/server/api/peripheralDevice.ts

@@ -533,7 +533,7 @@ export namespace ServerPeripheralDeviceAPI {
 			$set: {
 				accessTokenUrl: '',
 				'secretSettings.accessToken': accessToken,
-				'settings.secretAccessToken': true,
+				'secretSettingsStatus.accessToken': true,
 			},
 		})
 	}
@@ -634,7 +634,7 @@ peripheralDeviceRouter.post('/:deviceId/uploadCredentials', bodyParser(), async
 		await PeripheralDevices.updateAsync(peripheralDevice._id, {
 			$set: {
 				'secretSettings.credentials': body,
-				'settings.secretCredentials': true, // nocommit - fix me
+				'secretSettingsStatus.credentials': true,
 			},
 		})
 
@@ -705,7 +705,7 @@ peripheralDeviceRouter.post('/:deviceId/resetAuth', async (ctx) => {
 			$unset: {
 				// User credentials
 				'secretSettings.accessToken': true,
-				'settings.secretAccessToken': true, // nocommit - fix me
+				'secretSettingsStatus.accessToken': true,
 				accessTokenUrl: true,
 			},
 		})
@@ -735,10 +735,10 @@ peripheralDeviceRouter.post('/:deviceId/resetAppCredentials', async (ctx) => {
 			$unset: {
 				// App credentials
 				'secretSettings.credentials': true,
-				'settings.secretCredentials': true, // nocommit - fix me
+				'secretSettingsStatus.credentials': true,
 				// User credentials
 				'secretSettings.accessToken': true,
-				'settings.secretAccessToken': true, // nocommit - fix me
+				'secretSettingsStatus.accessToken': true,
 				accessTokenUrl: true,
 			},
 		})

meteor/server/migration/X_X_X.ts

@@ -15,6 +15,7 @@ import {
 import { StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { literal, unprotectString } from '../lib/tempLib'
 import { logger } from '../logging'
+import { IngestDeviceSecretSettingsStatus } from '@sofie-automation/corelib/src/dataModel/PeripheralDeviceSettings/ingestDevice'
 
 /*
  * **************************************************************************************
@@ -230,9 +231,53 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 	},
 
 	{
-		id: `move PeripheralDevice settings to studio`,
+		id: `PeripheralDevice populate secretSettingsStatus`,
 		canBeRunAutomatically: true,
 		dependOnResultFrom: `studios create peripheralDeviceSettings.deviceSettings`,
+		validate: async () => {
+			const devices = await PeripheralDevices.findFetchAsync({
+				secretSettings: { $exists: true },
+				settings: { $exists: true },
+				secretSettingsStatus: { $exists: false },
+			})
+
+			if (devices.length > 0) {
+				return 'settings must be moved to the studio'
+			}
+
+			return false
+		},
+		migrate: async () => {
+			const devices = await PeripheralDevices.findFetchAsync({
+				secretSettings: { $exists: true },
+				settings: { $exists: true },
+				secretSettingsStatus: { $exists: false },
+			})
+
+			for (const device of devices) {
+				// @ts-expect-error settings is typed as Record<string, any>
+				const oldSettings = device.settings as IngestDeviceSecretSettingsStatus | undefined
+
+				await PeripheralDevices.updateAsync(device._id, {
+					$set: {
+						secretSettingsStatus: {
+							secretCredentials: oldSettings?.secretCredentials,
+							secretAccessToken: oldSettings?.secretAccessToken,
+						},
+					},
+					$unset: {
+						'settings.secretCredentials': 1,
+						'settings.secretAccessToken': 1,
+					},
+				})
+			}
+		},
+	},
+
+	{
+		id: `move PeripheralDevice settings to studio`,
+		canBeRunAutomatically: true,
+		dependOnResultFrom: `PeripheralDevice populate secretSettingsStatus`,
 		validate: async () => {
 			const devices = await PeripheralDevices.findFetchAsync({
 				studioId: { $exists: true },

packages/corelib/src/dataModel/PeripheralDevice.ts

@@ -10,6 +10,7 @@ import {
 	PeripheralDeviceSubType,
 	PERIPHERAL_SUBTYPE_PROCESS,
 } from '@sofie-automation/shared-lib/dist/peripheralDevice/peripheralDeviceAPI'
+import { IngestDeviceSecretSettingsStatus } from '@sofie-automation/corelib/src/dataModel/PeripheralDeviceSettings/ingestDevice'
 
 export {
 	PeripheralDeviceStatusObject,
@@ -44,8 +45,6 @@ export interface PeripheralDevice {
 	created: number
 	status: PeripheralDeviceStatusObject
 
-	// settings: IngestDeviceSettings | GenericPeripheralDeviceSettings
-
 	/** If set, this device is owned by that organization */
 	organizationId: OrganizationId | null
 
@@ -68,6 +67,7 @@ export interface PeripheralDevice {
 	token: string
 
 	secretSettings?: IngestDeviceSecretSettings | { [key: string]: any }
+	secretSettingsStatus?: IngestDeviceSecretSettingsStatus
 
 	/** If the device is of category ingest, the name of the NRCS being used */
 	nrcsName?: string

packages/corelib/src/dataModel/PeripheralDeviceSettings/ingestDevice.ts

@@ -1,6 +1,6 @@
 export * from '@sofie-automation/shared-lib/dist/peripheralDevice/ingest'
 
 export {
-	IngestDeviceSettings,
+	IngestDeviceSecretSettingsStatus,
 	IngestDeviceSecretSettings,
 } from '@sofie-automation/shared-lib/dist/core/model/peripheralDevice'

packages/corelib/src/dataModel/Studio.ts

@@ -15,10 +15,7 @@ import {
 	StudioAbPlayerDisabling,
 } from '@sofie-automation/shared-lib/dist/core/model/StudioRouteSet'
 import { StudioPackageContainer } from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'
-import {
-	GenericPeripheralDeviceSettings,
-	IngestDeviceSettings,
-} from '@sofie-automation/shared-lib/dist/core/model/peripheralDevice'
+import { GenericPeripheralDeviceSettings } from '@sofie-automation/shared-lib/dist/core/model/peripheralDevice'
 
 export { MappingsExt, MappingExt, MappingsHash }
 
@@ -200,5 +197,5 @@ export interface StudioDeviceSettings {
 	 */
 	name: string
 
-	options: IngestDeviceSettings | GenericPeripheralDeviceSettings
+	options: GenericPeripheralDeviceSettings
 }

packages/shared-lib/src/core/model/peripheralDevice.ts

@@ -3,10 +3,10 @@ import { PeripheralDeviceId, StudioId } from './Ids'
 
 export type GenericPeripheralDeviceSettings = Record<string, never>
 
-export interface IngestDeviceSettings {
+export interface IngestDeviceSecretSettingsStatus {
 	/** OAuth: Set to true when secret value exists */
-	secretCredentials: boolean
-	secretAccessToken: boolean
+	credentials?: boolean
+	accessToken?: boolean
 }
 export interface IngestDeviceSecretSettings {
 	/** OAuth: */

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

@@ -2,7 +2,7 @@ import * as React from 'react'
 import { withTranslation } from 'react-i18next'
 import { PeripheralDevice } from '@sofie-automation/corelib/dist/dataModel/PeripheralDevice'
 import { Translated } from '../../../lib/ReactMeteorData/react-meteor-data'
-import { IngestDeviceSettings } from '@sofie-automation/corelib/dist/dataModel/PeripheralDeviceSettings/ingestDevice'
+import { IngestDeviceSecretSettingsStatus } from '@sofie-automation/corelib/dist/dataModel/PeripheralDeviceSettings/ingestDevice'
 import { NotificationCenter, Notification, NoticeLevel } from '../../../lib/notifications/notifications'
 import { fetchFrom } from '../../../lib/lib'
 
@@ -126,12 +126,12 @@ export const ConfigManifestOAuthFlowComponent = withTranslation()(
 
 		render(): JSX.Element {
 			const { t } = this.props
-			const settings = (this.props.device.settings || {}) as IngestDeviceSettings
+			const secretStatus = (this.props.device.secretSettingsStatus || {}) as IngestDeviceSecretSettingsStatus
 			const device = this.props.device
 
 			return (
 				<div>
-					{settings.secretAccessToken ? (
+					{secretStatus.accessToken ? (
 						// If this is set, we have completed the authentication procedure.
 						// A reset button is provided to begin the flow again if authorization is revoked by the user.
 						<div className="mod mvs mhs">
@@ -145,7 +145,7 @@ export const ConfigManifestOAuthFlowComponent = withTranslation()(
 						</div>
 					) : (
 						<div className="mod mvs mhs">
-							{!settings.secretCredentials ? (
+							{!secretStatus.credentials ? (
 								<label className="field">
 									<div className="mvs">{t('Application credentials')}</div>
 									<div className="mdi">