Merge branch 'upstream/release52' into upstream/peripheral-device-set…

…tings-from-blueprints
bbc · Dec 11, 2024 · 0b5412a · 0b5412a
2 parents 878214b + dd5010a
commit 0b5412a
Show file tree

Hide file tree

Showing 132 changed files with 2,505 additions and 4,050 deletions.
diff --git a/DEVELOPER.md b/DEVELOPER.md
@@ -142,8 +142,8 @@ However, one usage by AdlibActions for their userDataManifest remains as this is
 
 ## Blueprint Migrations
 
-In R49, a replacement flow was added consisting of `validateConfig` and `applyConfig`.
-It is no longer recommended to use the old migrations flow for showstyle and studio blueprints.
+In R52, the replacement flow of `validateConfig` and `applyConfig` was extended to the system blueprint
+It is no longer recommended to use the old migrations flow for system blueprints.
 
 ### ExpectedMediaItems
 

diff --git a/meteor/__mocks__/defaultCollectionObjects.ts b/meteor/__mocks__/defaultCollectionObjects.ts
@@ -105,15 +105,15 @@ export function defaultStudio(_id: StudioId): DBStudio {
 		mappingsWithOverrides: wrapDefaultObject({}),
 		supportedShowStyleBase: [],
 		blueprintConfigWithOverrides: wrapDefaultObject({}),
-		settings: {
+		settingsWithOverrides: wrapDefaultObject({
 			frameRate: 25,
 			mediaPreviewsUrl: '',
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 			fallbackPartDuration: DEFAULT_FALLBACK_PART_DURATION,
 			allowHold: false,
 			allowPieceDirectPlay: false,
 			enableBuckets: false,
-		},
+		}),
 		_rundownVersionHash: '',
 		routeSetsWithOverrides: wrapDefaultObject({}),
 		routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),

diff --git a/meteor/__mocks__/helpers/database.ts b/meteor/__mocks__/helpers/database.ts
@@ -170,6 +170,25 @@ 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)
 	await CoreSystem.removeAsync(SYSTEM_ID)
@@ -367,7 +386,6 @@ export async function setupMockStudioBlueprint(
 				},
 
 				studioConfigSchema: '{}' as any,
-				studioMigrations: [],
 				getBaseline: () => {
 					return {
 						timelineObjects: [],
@@ -424,7 +442,6 @@ export async function setupMockShowStyleBlueprint(
 				},
 
 				showStyleConfigSchema: '{}' as any,
-				showStyleMigrations: [],
 				getShowStyleVariantId: (): string | null => {
 					return SHOW_STYLE_VARIANT_ID
 				},

diff --git a/meteor/__mocks__/webapp.ts b/meteor/__mocks__/webapp.ts
@@ -1,5 +1,5 @@
 export const WebAppMock = {
-	rawConnectHandlers: {
+	rawHandlers: {
 		use: (): void => {
 			// No web server to setup
 		},

diff --git a/meteor/server/__tests__/api/serviceMessages/serviceMessagesApi.test.ts b/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,8 @@ const fakeCoreSystem: ICoreSystem = {
 	version: '3',
 	previousVersion: null,
 	serviceMessages: {},
+	settingsWithOverrides: wrapDefaultObject({} as any),
+	lastBlueprintConfig: undefined,
 }
 
 describe('Service messages internal API', () => {

diff --git a/meteor/server/__tests__/cronjobs.test.ts b/meteor/server/__tests__/cronjobs.test.ts
@@ -2,7 +2,7 @@ import '../../__mocks__/_extendJest'
 import { runAllTimers, waitUntil } from '../../__mocks__/helpers/jest'
 import { MeteorMock } from '../../__mocks__/meteor'
 import { logger } from '../logging'
-import { getRandomId, getRandomString, protectString } from '../lib/tempLib'
+import { getRandomId, getRandomString, literal, protectString } from '../lib/tempLib'
 import { SnapshotType } from '@sofie-automation/meteor-lib/dist/collections/Snapshots'
 import { IBlueprintPieceType, PieceLifespan, StatusCode, TSR } from '@sofie-automation/blueprints-integration'
 import {
@@ -64,26 +64,36 @@ import {
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import { Settings } from '../Settings'
 import { SofieIngestCacheType } from '@sofie-automation/corelib/dist/dataModel/SofieIngestDataCache'
+import { ObjectOverrideSetOp } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 describe('cronjobs', () => {
 	let env: DefaultEnvironment
 	let rundownId: RundownId
 
-	beforeAll(async () => {
-		env = await setupDefaultStudioEnvironment()
-
-		const o = await setupDefaultRundownPlaylist(env)
-		rundownId = o.rundownId
-
+	async function setCasparCGCronEnabled(enabled: boolean) {
 		await CoreSystem.updateAsync(
 			{},
 			{
-				$set: {
-					'cron.casparCGRestart.enabled': true,
+				// This is a little bit of a hack, as it will result in duplicate ops, but it's fine for unit tests
+				$push: {
+					'settingsWithOverrides.overrides': literal<ObjectOverrideSetOp>({
+						op: 'set',
+						path: 'cron.casparCGRestart.enabled',
+						value: enabled,
+					}),
 				},
 			},
 			{ multi: true }
 		)
+	}
+
+	beforeAll(async () => {
+		env = await setupDefaultStudioEnvironment()
+
+		const o = await setupDefaultRundownPlaylist(env)
+		rundownId = o.rundownId
+
+		await setCasparCGCronEnabled(true)
 
 		jest.useFakeTimers()
 		// set time to 2020/07/19 00:00 Local Time
@@ -597,15 +607,7 @@ describe('cronjobs', () => {
 		})
 		test('Does not attempt to restart CasparCG when job is disabled', async () => {
 			await createMockPlayoutGatewayAndDevices(Date.now()) // Some time after the threshold
-			await CoreSystem.updateAsync(
-				{},
-				{
-					$set: {
-						'cron.casparCGRestart.enabled': false,
-					},
-				},
-				{ multi: true }
-			)
+			await setCasparCGCronEnabled(false)
 			;(logger.info as jest.Mock).mockClear()
 			// set time to 2020/07/{date} 04:05 Local Time, should be more than 24 hours after 2020/07/19 00:00 UTC
 			mockCurrentTime = new Date(2020, 6, date++, 4, 5, 0).getTime()

diff --git a/meteor/server/api/blueprints/__tests__/api.test.ts b/meteor/server/api/blueprints/__tests__/api.test.ts
@@ -55,8 +55,6 @@ describe('Test blueprint management api', () => {
 				showStyleConfigSchema: JSONBlobStringify({}),
 
 				databaseVersion: {
-					showStyle: {},
-					studio: {},
 					system: undefined,
 				},
 
@@ -238,7 +236,6 @@ describe('Test blueprint management api', () => {
 					TSRVersion: '0.0.0',
 
 					// studioConfigManifest: [],
-					// studioMigrations: [],
 					// getBaseline: (context: IStudioContext): TSRTimelineObjBase[] => {
 					// 	return []
 					// },

diff --git a/meteor/server/api/blueprints/__tests__/lib.ts b/meteor/server/api/blueprints/__tests__/lib.ts
@@ -17,7 +17,6 @@ export function generateFakeBlueprint(
   integrationVersion: '0.0.0',
   TSRVersion: '0.0.0',
   studioConfigManifest: [],
-  studioMigrations: [],
   getBaseline: () => {
 	return {
       timelineObjects: [],
@@ -43,8 +42,6 @@ export function generateFakeBlueprint(
 		showStyleConfigSchema: JSONBlobStringify({}),
 
 		databaseVersion: {
-			showStyle: {},
-			studio: {},
 			system: undefined,
 		},