wip: coresystem settings

Author: Julusian

meteor/__mocks__/helpers/database.ts

@@ -171,6 +171,24 @@ export async function setupMockCore(doc?: Partial<ICoreSystem>): Promise<ICoreSy
 		version: '0.0.0',
 		previousVersion: '0.0.0',
 		serviceMessages: {},
+		settingsWithOverrides: wrapDefaultObject({
+			cron: {
+				casparCGRestart: {
+					enabled: true,
+				},
+				storeRundownSnapshots: {
+					enabled: false,
+				},
+			},
+			support: {
+				message: '',
+			},
+			evaluationsMessage: {
+				enabled: false,
+				heading: '',
+				message: '',
+			},
+		}),
 		lastBlueprintConfig: undefined,
 	}
 	const coreSystem = _.extend(defaultCore, doc)

meteor/server/__tests__/api/serviceMessages/serviceMessagesApi.test.ts

@@ -9,6 +9,7 @@ import {
 } from '@sofie-automation/meteor-lib/dist/collections/CoreSystem'
 import { CoreSystem } from '../../../collections'
 import { SupressLogMessages } from '../../../../__mocks__/suppressLogging'
+import { wrapDefaultObject } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 function convertExternalToServiceMessage(message: ExternalServiceMessage): ServiceMessage {
 	return {
@@ -42,6 +43,7 @@ const fakeCoreSystem: ICoreSystem = {
 	version: '3',
 	previousVersion: null,
 	serviceMessages: {},
+	settingsWithOverrides: wrapDefaultObject({} as any),
 	lastBlueprintConfig: undefined,
 }
 

meteor/server/collections/index.ts

@@ -67,15 +67,13 @@ export const CoreSystem = createAsyncOnlyMongoCollection<ICoreSystem>(Collection
 		if (!access.update) return logNotAllowed('CoreSystem', access.reason)
 
 		return allowOnlyFields(doc, fields, [
-			'support',
 			'systemInfo',
 			'name',
 			'logLevel',
 			'apm',
-			'cron',
 			'logo',
-			'evaluations',
 			'blueprintId',
+			'settingsWithOverrides',
 		])
 	},
 })

meteor/server/coreSystem/index.ts

@@ -10,13 +10,14 @@ import { getEnvLogLevel, logger, LogLevel, setLogLevel } from '../logging'
 const PackageInfo = require('../../package.json')
 import { startAgent } from '../api/profiler/apm'
 import { profiler } from '../api/profiler'
-import { TMP_TSR_VERSION } from '@sofie-automation/blueprints-integration'
+import { ICoreSystemSettings, TMP_TSR_VERSION } from '@sofie-automation/blueprints-integration'
 import { getAbsolutePath } from '../lib'
 import * as fs from 'fs/promises'
 import path from 'path'
 import { checkDatabaseVersions } from './checkDatabaseVersions'
 import PLazy from 'p-lazy'
 import { getCoreSystemAsync } from './collection'
+import { wrapDefaultObject } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 export { PackageInfo }
 
@@ -59,11 +60,24 @@ async function initializeCoreSystem() {
 				enabled: false,
 				transactionSampleRate: -1,
 			},
-			cron: {
-				casparCGRestart: {
-					enabled: true,
+			settingsWithOverrides: wrapDefaultObject<ICoreSystemSettings>({
+				cron: {
+					casparCGRestart: {
+						enabled: true,
+					},
+					storeRundownSnapshots: {
+						enabled: false,
+					},
 				},
-			},
+				support: {
+					message: '',
+				},
+				evaluationsMessage: {
+					enabled: false,
+					heading: '',
+					message: '',
+				},
+			}),
 			lastBlueprintConfig: undefined,
 		})
 

meteor/server/cronjobs.ts

@@ -18,13 +18,14 @@ import { deferAsync, normalizeArrayToMap } from '@sofie-automation/corelib/dist/
 import { getCoreSystemAsync } from './coreSystem/collection'
 import { cleanupOldDataInner } from './api/cleanup'
 import { CollectionCleanupResult } from '@sofie-automation/meteor-lib/dist/api/system'
-import { ICoreSystem } from '@sofie-automation/meteor-lib/dist/collections/CoreSystem'
+import { ICoreSystemSettings } from '@sofie-automation/shared-lib/dist/core/model/CoreSystemSettings'
 import { executePeripheralDeviceFunctionWithCustomTimeout } from './api/peripheralDevice/executeFunction'
 import {
 	interpollateTranslation,
 	isTranslatableMessage,
 	translateMessage,
 } from '@sofie-automation/corelib/dist/TranslatableMessage'
+import { applyAndValidateOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 const lowPrioFcn = (fcn: () => any) => {
 	// Do it at a random time in the future:
@@ -49,15 +50,17 @@ export async function nightlyCronjobInner(): Promise<void> {
 	logger.info('Nightly cronjob: starting...')
 	const system = await getCoreSystemAsync()
 
+	const systemSettings = system && applyAndValidateOverrides(system.settingsWithOverrides).obj
+
 	await Promise.allSettled([
 		cleanupOldDataCronjob().catch((error) => {
 			logger.error(`Cronjob: Error when cleaning up old data: ${stringifyError(error)}`)
 			logger.error(error)
 		}),
-		restartCasparCG(system, previousLastNightlyCronjob).catch((e) => {
+		restartCasparCG(systemSettings, previousLastNightlyCronjob).catch((e) => {
 			logger.error(`Cron: Restart CasparCG error: ${stringifyError(e)}`)
 		}),
-		storeSnapshots(system).catch((e) => {
+		storeSnapshots(systemSettings).catch((e) => {
 			logger.error(`Cron: Rundown Snapshots error: ${stringifyError(e)}`)
 		}),
 	])
@@ -81,8 +84,8 @@ async function cleanupOldDataCronjob() {
 
 const CASPARCG_LAST_SEEN_PERIOD_MS = 3 * 60 * 1000 // Note: this must be higher than the ping interval used by playout-gateway
 
-async function restartCasparCG(system: ICoreSystem | undefined, previousLastNightlyCronjob: number) {
-	if (!system?.cron?.casparCGRestart?.enabled) return
+async function restartCasparCG(systemSettings: ICoreSystemSettings | undefined, previousLastNightlyCronjob: number) {
+	if (!systemSettings?.cron?.casparCGRestart?.enabled) return
 
 	let shouldRetryAttempt = false
 	const ps: Array<Promise<any>> = []
@@ -176,10 +179,10 @@ async function restartCasparCG(system: ICoreSystem | undefined, previousLastNigh
 	}
 }
 
-async function storeSnapshots(system: ICoreSystem | undefined) {
-	if (system?.cron?.storeRundownSnapshots?.enabled) {
-		const filter = system.cron.storeRundownSnapshots.rundownNames?.length
-			? { name: { $in: system.cron.storeRundownSnapshots.rundownNames } }
+async function storeSnapshots(systemSettings: ICoreSystemSettings | undefined) {
+	if (systemSettings?.cron?.storeRundownSnapshots?.enabled) {
+		const filter = systemSettings.cron.storeRundownSnapshots.rundownNames?.length
+			? { name: { $in: systemSettings.cron.storeRundownSnapshots.rundownNames } }
 			: {}
 
 		const playlists = await RundownPlaylists.findFetchAsync(filter)

meteor/server/logo.ts

@@ -13,7 +13,7 @@ logoRouter.get('/', async (ctx) => {
 	const logo = core?.logo ?? SofieLogo.Default
 
 	const paths: Record<SofieLogo, string> = {
-		[SofieLogo.Default]: '/images/sofie-logo.svg',
+		[SofieLogo.Default]: '/images/sofie-logo-default.svg',
 		[SofieLogo.Pride]: '/images/sofie-logo-pride.svg',
 		[SofieLogo.Norway]: '/images/sofie-logo-norway.svg',
 		[SofieLogo.Christmas]: '/images/sofie-logo-christmas.svg',

meteor/server/migration/X_X_X.ts

@@ -1,6 +1,6 @@
 import { addMigrationSteps } from './databaseMigration'
 import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
-import { Studios, TriggeredActions } from '../collections'
+import { CoreSystem, Studios, TriggeredActions } from '../collections'
 import {
 	convertObjectIntoOverrides,
 	wrapDefaultObject,
@@ -12,6 +12,8 @@ import {
 	IStudioSettings,
 } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { DEFAULT_CORE_TRIGGER_IDS } from './upgrades/defaultSystemActionTriggers'
+import { ICoreSystem } from '@sofie-automation/meteor-lib/dist/collections/CoreSystem'
+import { ICoreSystemSettings } from '@sofie-automation/shared-lib/dist/core/model/CoreSystemSettings'
 
 /*
  * **************************************************************************************
@@ -258,4 +260,78 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 			}
 		},
 	},
+
+	{
+		id: `convert CoreSystem.settingsWithOverrides`,
+		canBeRunAutomatically: true,
+		validate: async () => {
+			const systems = await CoreSystem.findFetchAsync({
+				settingsWithOverrides: { $exists: false },
+			})
+
+			if (systems.length > 0) {
+				return 'settings must be converted to an ObjectWithOverrides'
+			}
+
+			return false
+		},
+		migrate: async () => {
+			const systems = await CoreSystem.findFetchAsync({
+				settingsWithOverrides: { $exists: false },
+			})
+
+			for (const system of systems) {
+				const oldSystem = system as ICoreSystem as PartialOldICoreSystem
+
+				const newSettings = wrapDefaultObject<ICoreSystemSettings>({
+					cron: {
+						casparCGRestart: {
+							enabled: false,
+						},
+						storeRundownSnapshots: {
+							enabled: false,
+						},
+						...oldSystem.cron,
+					},
+					support: oldSystem.support ?? { message: '' },
+					evaluationsMessage: oldSystem.evaluations ?? { enabled: false, heading: '', message: '' },
+				})
+
+				await CoreSystem.updateAsync(system._id, {
+					$set: {
+						settingsWithOverrides: newSettings,
+					},
+					$unset: {
+						cron: 1,
+						support: 1,
+						evaluations: 1,
+					},
+				})
+			}
+		},
+	},
 ])
+
+interface PartialOldICoreSystem {
+	/** Support info */
+	support?: {
+		message: string
+	}
+
+	evaluations?: {
+		enabled: boolean
+		heading: string
+		message: string
+	}
+
+	/** Cron jobs running nightly */
+	cron?: {
+		casparCGRestart?: {
+			enabled: boolean
+		}
+		storeRundownSnapshots?: {
+			enabled: boolean
+			rundownNames?: string[]
+		}
+	}
+}

meteor/server/migration/upgrades/system.ts

@@ -13,6 +13,7 @@ import { updateTriggeredActionsForShowStyleBaseId } from './lib'
 import { CoreSystemId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { DEFAULT_CORE_TRIGGERS } from './defaultSystemActionTriggers'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
+import { ICoreSystemSettings } from '@sofie-automation/shared-lib/dist/core/model/CoreSystemSettings'
 
 export async function runUpgradeForCoreSystem(coreSystemId: CoreSystemId): Promise<void> {
 	logger.info(`Running upgrade for CoreSystem`)
@@ -33,10 +34,11 @@ export async function runUpgradeForCoreSystem(coreSystemId: CoreSystemId): Promi
 		result = generateDefaultSystemConfig()
 	}
 
+	const coreSystemSettings: ICoreSystemSettings = result.settings
+
 	await CoreSystem.updateAsync(coreSystemId, {
 		$set: {
-			// 'sourceLayersWithOverrides.defaults': normalizeArray(result.sourceLayers, '_id'),
-			// 'outputLayersWithOverrides.defaults': normalizeArray(result.outputLayers, '_id'),
+			'settingsWithOverrides.defaults': coreSystemSettings,
 			lastBlueprintConfig: {
 				blueprintHash: blueprint?.blueprintHash ?? protectString('default'),
 				blueprintId: blueprint?._id ?? protectString('default'),
@@ -83,6 +85,24 @@ async function loadCoreSystemAndBlueprint(coreSystemId: CoreSystemId) {
 
 function generateDefaultSystemConfig(): BlueprintResultApplySystemConfig {
 	return {
+		settings: {
+			cron: {
+				casparCGRestart: {
+					enabled: true,
+				},
+				storeRundownSnapshots: {
+					enabled: false,
+				},
+			},
+			support: {
+				message: '',
+			},
+			evaluationsMessage: {
+				enabled: false,
+				heading: '',
+				message: '',
+			},
+		},
 		triggeredActions: Object.values<IBlueprintTriggeredActions>(DEFAULT_CORE_TRIGGERS),
 	}
 }

meteor/server/publications/system.ts

@@ -15,16 +15,14 @@ meteorPublish(MeteorPubSub.coreSystem, async function (token: string | undefined
 			fields: {
 				// Include only specific fields in the result documents:
 				_id: 1,
-				support: 1,
 				systemInfo: 1,
 				apm: 1,
 				name: 1,
 				logLevel: 1,
 				serviceMessages: 1,
 				blueprintId: 1,
-				cron: 1,
 				logo: 1,
-				evaluations: 1,
+				settingsWithOverrides: 1,
 			},
 		})
 	}

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

@@ -2,6 +2,7 @@ import type { IBlueprintTriggeredActions } from '../triggers'
 import type { MigrationStepSystem } from '../migrations'
 import type { BlueprintManifestBase, BlueprintManifestType } from './base'
 import type { ICoreSystemApplyConfigContext } from '../context/systemApplyConfigContext'
+import type { ICoreSystemSettings } from '@sofie-automation/shared-lib/dist/core/model/CoreSystemSettings'
 
 export interface SystemBlueprintManifest extends BlueprintManifestBase {
 	blueprintType: BlueprintManifestType.SYSTEM
@@ -38,8 +39,7 @@ export interface SystemBlueprintManifest extends BlueprintManifestBase {
 }
 
 export interface BlueprintResultApplySystemConfig {
-	// sourceLayers: ISourceLayer[]
-	// outputLayers: IOutputLayer[]
+	settings: ICoreSystemSettings
 
 	triggeredActions: IBlueprintTriggeredActions[]
 }