Merge remote-tracking branch 'nrk/release52' into bbc-release52

Author: Julusian

meteor/server/__tests__/cronjobs.test.ts

@@ -4,7 +4,13 @@ import { MeteorMock } from '../../__mocks__/meteor'
 import { logger } from '../logging'
 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 {
+	IBlueprintPieceType,
+	PieceLifespan,
+	PlaylistTimingType,
+	StatusCode,
+	TSR,
+} from '@sofie-automation/blueprints-integration'
 import {
 	PeripheralDeviceType,
 	PeripheralDeviceCategory,
@@ -27,6 +33,8 @@ import {
 	SegmentId,
 	SnapshotId,
 	UserActionsLogItemId,
+	StudioId,
+	RundownPlaylistId,
 } from '@sofie-automation/corelib/dist/dataModel/Ids'
 
 // Set up mocks for tests in this suite
@@ -53,6 +61,8 @@ import {
 	UserActionsLog,
 	Segments,
 	SofieIngestDataCache,
+	Studios,
+	RundownPlaylists,
 } from '../collections'
 import { NrcsIngestCacheType } from '@sofie-automation/corelib/dist/dataModel/NrcsIngestDataCache'
 import { JSONBlobStringify } from '@sofie-automation/shared-lib/dist/lib/JSONBlob'
@@ -64,7 +74,7 @@ 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'
+import { ObjectOverrideSetOp, ObjectWithOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 describe('cronjobs', () => {
 	let env: DefaultEnvironment
@@ -476,7 +486,10 @@ describe('cronjobs', () => {
 			expect(await Snapshots.findOneAsync(snapshot1)).toBeUndefined()
 		})
 		async function insertPlayoutDevice(
-			props: Pick<PeripheralDevice, 'subType' | 'deviceName' | 'lastSeen' | 'parentDeviceId'> &
+			props: Pick<
+				PeripheralDevice,
+				'subType' | 'deviceName' | 'lastSeen' | 'parentDeviceId' | 'studioAndConfigId'
+			> &
 				Partial<Pick<PeripheralDevice, 'token'>>
 		): Promise<PeripheralDeviceId> {
 			const deviceId = protectString<PeripheralDeviceId>(getRandomString())
@@ -504,7 +517,10 @@ describe('cronjobs', () => {
 			return deviceId
 		}
 
-		async function createMockPlayoutGatewayAndDevices(lastSeen: number): Promise<{
+		async function createMockPlayoutGatewayAndDevices(
+			lastSeen: number,
+			studioId?: StudioId
+		): Promise<{
 			deviceToken: string
 			mockPlayoutGw: PeripheralDeviceId
 			mockCasparCg: PeripheralDeviceId
@@ -516,6 +532,12 @@ describe('cronjobs', () => {
 				lastSeen: lastSeen,
 				subType: PERIPHERAL_SUBTYPE_PROCESS,
 				token: deviceToken,
+				studioAndConfigId: studioId
+					? {
+							configId: '',
+							studioId,
+					  }
+					: undefined,
 			})
 			const mockCasparCg = await insertPlayoutDevice({
 				deviceName: 'CasparCG',
@@ -540,6 +562,73 @@ describe('cronjobs', () => {
 			}
 		}
 
+		async function createMockStudioAndRundown(): Promise<{
+			studioId: StudioId
+			rundownPlaylistId: RundownPlaylistId
+		}> {
+			function newObjectWithOverrides<T extends {}>(defaults: T): ObjectWithOverrides<T> {
+				return {
+					defaults,
+					overrides: [],
+				}
+			}
+			const studioId = protectString<StudioId>(getRandomString())
+			await Studios.insertAsync({
+				_id: studioId,
+				organizationId: null,
+				name: 'Studio',
+				blueprintConfigWithOverrides: newObjectWithOverrides({}),
+				_rundownVersionHash: '',
+				lastBlueprintConfig: undefined,
+				lastBlueprintFixUpHash: undefined,
+				mappingsWithOverrides: newObjectWithOverrides({}),
+				supportedShowStyleBase: [],
+				settingsWithOverrides: newObjectWithOverrides({
+					allowHold: true,
+					allowPieceDirectPlay: true,
+					enableBuckets: true,
+					enableEvaluationForm: true,
+					frameRate: 25,
+					mediaPreviewsUrl: '',
+					minimumTakeSpan: 1000,
+				}),
+				routeSetsWithOverrides: newObjectWithOverrides({}),
+				routeSetExclusivityGroupsWithOverrides: newObjectWithOverrides({}),
+				packageContainersWithOverrides: newObjectWithOverrides({}),
+				previewContainerIds: [],
+				thumbnailContainerIds: [],
+				peripheralDeviceSettings: {
+					deviceSettings: newObjectWithOverrides({}),
+					ingestDevices: newObjectWithOverrides({}),
+					inputDevices: newObjectWithOverrides({}),
+					playoutDevices: newObjectWithOverrides({}),
+				},
+			})
+
+			const rundownPlaylistId = protectString<RundownPlaylistId>(getRandomString())
+			await RundownPlaylists.mutableCollection.insertAsync({
+				_id: rundownPlaylistId,
+				created: Date.now(),
+				currentPartInfo: null,
+				nextPartInfo: null,
+				externalId: '',
+				modified: Date.now(),
+				name: 'Rundown',
+				previousPartInfo: null,
+				rundownIdsInOrder: [],
+				studioId,
+				timing: {
+					type: PlaylistTimingType.None,
+				},
+				activationId: protectString(''),
+			})
+
+			return {
+				studioId,
+				rundownPlaylistId,
+			}
+		}
+
 		test('Attempts to restart CasparCG when job is enabled', async () => {
 			const { mockCasparCg, deviceToken } = await createMockPlayoutGatewayAndDevices(Date.now()) // Some time after the threshold
 
@@ -605,6 +694,28 @@ describe('cronjobs', () => {
 				expect(logger.info).toHaveBeenLastCalledWith('Nightly cronjob: done')
 			}, MAX_WAIT_TIME)
 		})
+		test('Skips CasparCG in Studios with active Playlists when job is enabled', async () => {
+			const { studioId } = await createMockStudioAndRundown()
+			await createMockPlayoutGatewayAndDevices(Date.now(), studioId) // Some time after the threshold
+			;(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()
+			// cronjob is checked every 5 minutes, so advance 6 minutes
+			await jest.advanceTimersByTimeAsync(6 * 60 * 1000)
+
+			await waitUntil(async () => {
+				// Run timers, so that all promises in the cronjob has a chance to resolve:
+				const pendingCommands = await PeripheralDeviceCommands.findFetchAsync({})
+				expect(pendingCommands).toHaveLength(0)
+			}, MAX_WAIT_TIME)
+
+			// make sure that the cronjob ends
+			await waitUntil(async () => {
+				// Run timers, so that all promises in the cronjob has a chance to resolve:
+				await runAllTimers()
+				expect(logger.info).toHaveBeenLastCalledWith('Nightly cronjob: done')
+			}, MAX_WAIT_TIME)
+		})
 		test('Does not attempt to restart CasparCG when job is disabled', async () => {
 			await createMockPlayoutGatewayAndDevices(Date.now()) // Some time after the threshold
 			await setCasparCGCronEnabled(false)

meteor/server/api/rest/v1/typeConversion.ts

@@ -200,6 +200,9 @@ export function sourceLayerFrom(apiSourceLayer: APISourceLayer): ISourceLayer {
 		case 'transition':
 			layerType = SourceLayerType.TRANSITION
 			break
+		case 'lights':
+			layerType = SourceLayerType.LIGHTS
+			break
 		case 'unknown':
 			layerType = SourceLayerType.UNKNOWN
 			break
@@ -209,6 +212,9 @@ export function sourceLayerFrom(apiSourceLayer: APISourceLayer): ISourceLayer {
 		case 'studio-screen':
 			layerType = SourceLayerType.STUDIO_SCREEN
 			break
+		case 'remote-speak':
+			layerType = SourceLayerType.REMOTE_SPEAK
+			break
 		default:
 			layerType = SourceLayerType.UNKNOWN
 			assertNever(apiSourceLayer.layerType)
@@ -257,6 +263,9 @@ export function APISourceLayerFrom(sourceLayer: ISourceLayer): APISourceLayer {
 		case SourceLayerType.TRANSITION:
 			layerType = 'transition'
 			break
+		case SourceLayerType.LIGHTS:
+			layerType = 'lights'
+			break
 		case SourceLayerType.UNKNOWN:
 			layerType = 'unknown'
 			break
@@ -266,6 +275,9 @@ export function APISourceLayerFrom(sourceLayer: ISourceLayer): APISourceLayer {
 		case SourceLayerType.STUDIO_SCREEN:
 			layerType = 'studio-screen'
 			break
+		case SourceLayerType.REMOTE_SPEAK:
+			layerType = 'remote-speak'
+			break
 		default:
 			layerType = 'unknown'
 			assertNever(sourceLayer.type)

meteor/server/cronjobs.ts

@@ -26,6 +26,8 @@ import {
 	translateMessage,
 } from '@sofie-automation/corelib/dist/TranslatableMessage'
 import { applyAndValidateOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
+import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
+import { StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 
 const lowPrioFcn = (fcn: () => any) => {
 	// Do it at a random time in the future:
@@ -101,9 +103,35 @@ async function restartCasparCG(systemSettings: ICoreSystemSettings | undefined,
 				subType: 1,
 				parentDeviceId: 1,
 				lastSeen: 1,
+				studioAndConfigId: 1,
 			},
 		}
-	)) as Array<Pick<PeripheralDevice, '_id' | 'subType' | 'parentDeviceId' | 'lastSeen'>>
+	)) as Array<Pick<PeripheralDevice, '_id' | 'subType' | 'parentDeviceId' | 'lastSeen' | 'studioAndConfigId'>>
+
+	const relevantStudioIds = Array.from(
+		new Set(
+			casparcgAndParentDevices
+				.map((device) => device.studioAndConfigId?.studioId)
+				.filter((id) => id !== undefined)
+		)
+	) as StudioId[]
+
+	const activePlaylists = (await RundownPlaylists.findFetchAsync(
+		{
+			activationId: {
+				$exists: true,
+			},
+			studioId: {
+				$in: relevantStudioIds,
+			},
+		},
+		{
+			projection: {
+				_id: 1,
+				studioId: 1,
+			},
+		}
+	)) as Array<Pick<DBRundownPlaylist, '_id' | 'studioId'>>
 
 	const deviceMap = normalizeArrayToMap(casparcgAndParentDevices, '_id')
 
@@ -128,6 +156,17 @@ async function restartCasparCG(systemSettings: ICoreSystemSettings | undefined,
 			continue
 		}
 
+		const activePlaylistUsingDevice = activePlaylists.find(
+			(playlist) => playlist.studioId === parentDevice.studioAndConfigId?.studioId
+		)
+		if (activePlaylistUsingDevice) {
+			logger.info(
+				`Cronjob: Skipping CasparCG device "${device._id}" with a parent device belonging to a Studio ("${activePlaylistUsingDevice.studioId}") with an active RundownPlaylist: "${activePlaylistUsingDevice._id}"`
+			)
+			// If a Rundown is active during "low season", it's proably best to just let it go until next "low season" the following day, don't retry
+			continue
+		}
+
 		if (parentDevice.lastSeen < getCurrentTime() - CASPARCG_LAST_SEEN_PERIOD_MS) {
 			logger.info(`Cronjob: Skipping CasparCG device "${device._id}" with offline parent device`)
 			shouldRetryAttempt = true

meteor/server/lib/rest/v1/showstyles.ts

@@ -249,7 +249,9 @@ export interface APISourceLayer {
 		| 'lower-third'
 		| 'live-speak'
 		| 'transition'
+		| 'lights'
 		| 'local'
 		| 'studio-screen'
+		| 'remote-speak'
 	exclusiveGroup?: string
 }

packages/blueprints-integration/src/content.ts

@@ -42,6 +42,8 @@ export type SomeContent =
 	| GraphicsContent
 	| UnknownContent
 	| EvsContent
+	| RemoteSpeakContent
+	| LightingContent
 
 export type UnknownContent = BaseContent
 
@@ -194,4 +196,8 @@ export interface TransitionContent extends BaseContent {
 
 export type SomeTransitionContent = VTContent | TransitionContent
 
+export type RemoteSpeakContent = RemoteContent
+
+export type LightingContent = UnknownContent
+
 export { SourceLayerType }

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

@@ -21,11 +21,14 @@ export enum SourceLayerType {
 	LIVE_SPEAK = 11,
 	/** Transition effects, content object can use VTContent or TransitionContent */
 	TRANSITION = 13,
-	// LIGHTS = 14,
+	/** Control of Studio Lighting, Effects, etc. */
+	LIGHTS = 14,
 	/** Uncontrolled local sources, such as PowerPoint presentation inputs, Weather systems, EVS replay machines, etc. */
 	LOCAL = 15,
 	/** Sources that are intended for a studio screen, such as weather, presentations etc. */
 	STUDIO_SCREEN = 16,
+	/** Remote source with (Local) Studio Audio */
+	REMOTE_SPEAK = 17,
 }
 
 /** A single source layer, f.g Cameras, VT, Graphics, Remotes */

packages/webui/src/client/styles/_itemTypeColors.scss

@@ -10,19 +10,39 @@ $segment-layer-background-graphics: #dc5c00;
 $segment-layer-background-graphics--second: darken($segment-layer-background-graphics, 10%);
 $segment-layer-border-live-speak: #2f74ff;
 /** Gradients need to be defined with each color separately, so that they can be applied in SVG **/
+$segment-layer-background-gradient-divider: rgba(0, 0, 0, 0.5) 1px;
 $segment-layer-background-live-speak-1: #2f74ff;
 $segment-layer-background-live-speak-2: #39762b;
 $segment-layer-background-live-speak: linear-gradient(
 	to bottom,
-	$segment-layer-background-live-speak-1 50%,
-	$segment-layer-background-live-speak-2 50%
+	$segment-layer-background-live-speak-1 70%,
+	$segment-layer-background-gradient-divider,
+	$segment-layer-background-live-speak-2 72%
 );
 $segment-layer-background-live-speak--second-1: darken(#2f74ff, 10%);
 $segment-layer-background-live-speak--second-2: darken(#39762b, 10%);
 $segment-layer-background-live-speak--second: linear-gradient(
 	to bottom,
-	$segment-layer-background-live-speak--second-1 50%,
-	$segment-layer-background-live-speak--second-2 50%
+	$segment-layer-background-live-speak--second-1 70%,
+	$segment-layer-background-gradient-divider,
+	$segment-layer-background-live-speak--second-2 72%
+);
+$segment-layer-border-remote-speak: #e80064;
+$segment-layer-background-remote-speak-1: #e80064;
+$segment-layer-background-remote-speak-2: #39762b;
+$segment-layer-background-remote-speak: linear-gradient(
+	to bottom,
+	$segment-layer-background-remote-speak-1 70%,
+	$segment-layer-background-gradient-divider,
+	$segment-layer-background-remote-speak-2 72%
+);
+$segment-layer-background-remote-speak--second-1: darken(#e80064, 10%);
+$segment-layer-background-remote-speak--second-2: darken(#39762b, 10%);
+$segment-layer-background-remote-speak--second: linear-gradient(
+	to bottom,
+	$segment-layer-background-remote-speak--second-1 70%,
+	$segment-layer-background-gradient-divider,
+	$segment-layer-background-remote-speak--second-2 72%
 );
 $segment-layer-background-remote: #e80064;
 $segment-layer-background-remote--second: darken($segment-layer-background-remote, 10%);
@@ -42,7 +62,7 @@ $segment-item-disabled-color: #c9c9c9;
 
 $layer-types-solid: 'unknown', 'camera', 'lower-third', 'graphics', 'remote', 'vt', 'local', 'script', 'mic', 'guest',
 	'studio-screen';
-$layer-types-gradient: 'live-speak'; //
+$layer-types-gradient: 'live-speak', 'remote-speak'; //
 
 $layer-types: join($layer-types-solid, $layer-types-gradient);
 
@@ -460,6 +480,12 @@ $layer-types: join($layer-types-solid, $layer-types-gradient);
 	--segment-layer-background-live-speak--second-1: #{$segment-layer-background-live-speak--second-1};
 	--segment-layer-background-live-speak--second-2: #{$segment-layer-background-live-speak--second-2};
 	--segment-layer-background-live-speak--second: #{$segment-layer-background-live-speak--second};
+	--segment-layer-background-remote-speak-1: #{$segment-layer-background-remote-speak-1};
+	--segment-layer-background-remote-speak-2: #{$segment-layer-background-remote-speak-2};
+	--segment-layer-background-remote-speak: #{$segment-layer-background-remote-speak};
+	--segment-layer-background-remote-speak--second-1: #{$segment-layer-background-remote-speak--second-1};
+	--segment-layer-background-remote-speak--second-2: #{$segment-layer-background-remote-speak--second-2};
+	--segment-layer-background-remote-speak--second: #{$segment-layer-background-remote-speak--second};
 	--segment-layer-background-remote: #{$segment-layer-background-remote};
 	--segment-layer-background-remote--second: #{$segment-layer-background-remote--second};
 	--segment-layer-background-local: #{$segment-layer-background-local};