wip: make settings required

Author: Julusian

meteor/__mocks__/defaultCollectionObjects.ts

@@ -110,6 +110,8 @@ export function defaultStudio(_id: StudioId): DBStudio {
 			mediaPreviewsUrl: '',
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 			fallbackPartDuration: DEFAULT_FALLBACK_PART_DURATION,
+			allowHold: false,
+			allowPieceDirectPlay: false,
 		},
 		_rundownVersionHash: '',
 		routeSetsWithOverrides: wrapDefaultObject({}),

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

@@ -10,7 +10,7 @@ import { PeripheralDevice, PeripheralDeviceType } from '@sofie-automation/coreli
 import { Blueprint } from '@sofie-automation/corelib/dist/dataModel/Blueprint'
 import { BucketId, ShowStyleBaseId, ShowStyleVariantId, StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { DBStudio, IStudioSettings } from '@sofie-automation/corelib/dist/dataModel/Studio'
-import { assertNever, getRandomId, literal } from '@sofie-automation/corelib/dist/lib'
+import { assertNever, Complete, getRandomId, literal } from '@sofie-automation/corelib/dist/lib'
 import { protectString, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
 import {
 	applyAndValidateOverrides,
@@ -292,7 +292,7 @@ export async function studioFrom(apiStudio: APIStudio, existingId?: StudioId): P
 	}
 }
 
-export function APIStudioFrom(studio: DBStudio): APIStudio {
+export function APIStudioFrom(studio: DBStudio): Complete<APIStudio> {
 	const studioSettings = APIStudioSettingsFrom(studio.settings)
 
 	return {
@@ -305,7 +305,7 @@ export function APIStudioFrom(studio: DBStudio): APIStudio {
 	}
 }
 
-export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): IStudioSettings {
+export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Complete<IStudioSettings> {
 	return {
 		frameRate: apiStudioSettings.frameRate,
 		mediaPreviewsUrl: apiStudioSettings.mediaPreviewsUrl,
@@ -321,10 +321,13 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): IStudi
 		enableQuickLoop: apiStudioSettings.enableQuickLoop,
 		forceQuickLoopAutoNext: forceQuickLoopAutoNextFrom(apiStudioSettings.forceQuickLoopAutoNext),
 		fallbackPartDuration: apiStudioSettings.fallbackPartDuration ?? DEFAULT_FALLBACK_PART_DURATION,
+		allowAdlibTestingSegment: apiStudioSettings.allowAdlibTestingSegment,
+		allowHold: apiStudioSettings.allowHold ?? true, // Backwards compatible
+		allowPieceDirectPlay: apiStudioSettings.allowPieceDirectPlay ?? true, // Backwards compatible
 	}
 }
 
-export function APIStudioSettingsFrom(settings: IStudioSettings): APIStudioSettings {
+export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APIStudioSettings> {
 	return {
 		frameRate: settings.frameRate,
 		mediaPreviewsUrl: settings.mediaPreviewsUrl,
@@ -340,6 +343,9 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): APIStudioSetti
 		enableQuickLoop: settings.enableQuickLoop,
 		forceQuickLoopAutoNext: APIForceQuickLoopAutoNextFrom(settings.forceQuickLoopAutoNext),
 		fallbackPartDuration: settings.fallbackPartDuration,
+		allowAdlibTestingSegment: settings.allowAdlibTestingSegment,
+		allowHold: settings.allowHold,
+		allowPieceDirectPlay: settings.allowPieceDirectPlay,
 	}
 }
 

meteor/server/api/studio/api.ts

@@ -49,6 +49,8 @@ export async function insertStudioInner(organizationId: OrganizationId | null, n
 				frameRate: 25,
 				mediaPreviewsUrl: '',
 				minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+				allowHold: false,
+				allowPieceDirectPlay: false,
 			},
 			_rundownVersionHash: '',
 			routeSetsWithOverrides: wrapDefaultObject({}),

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

@@ -186,4 +186,7 @@ export interface APIStudioSettings {
 	forceQuickLoopAutoNext?: 'disabled' | 'enabled_when_valid_duration' | 'enabled_forcing_min_duration'
 	minimumTakeSpan?: number
 	fallbackPartDuration?: number
+	allowAdlibTestingSegment?: boolean
+	allowHold?: boolean
+	allowPieceDirectPlay?: boolean
 }

meteor/server/migration/0_1_0.ts

@@ -441,6 +441,8 @@ export const addSteps = addMigrationSteps('0.1.0', [
 					frameRate: 25,
 					mediaPreviewsUrl: '',
 					minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+					allowHold: false,
+					allowPieceDirectPlay: false,
 				},
 				mappingsWithOverrides: wrapDefaultObject({}),
 				blueprintConfigWithOverrides: wrapDefaultObject({}),

meteor/server/migration/__tests__/migrations.test.ts

@@ -125,6 +125,8 @@ describe('Migrations', () => {
 							mediaPreviewsUrl: '',
 							frameRate: 25,
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+							allowHold: true,
+							allowPieceDirectPlay: true,
 						},
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
@@ -163,6 +165,8 @@ describe('Migrations', () => {
 							mediaPreviewsUrl: '',
 							frameRate: 25,
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+							allowHold: true,
+							allowPieceDirectPlay: true,
 						},
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
@@ -201,6 +205,8 @@ describe('Migrations', () => {
 							mediaPreviewsUrl: '',
 							frameRate: 25,
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+							allowHold: true,
+							allowPieceDirectPlay: true,
 						},
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),

meteor/server/publications/pieceContentStatusUI/__tests__/checkPieceContentStatus.test.ts

@@ -166,9 +166,7 @@ describe('lib/mediaObjects', () => {
 	test('getAcceptedFormats', () => {
 		const acceptedFormats = getAcceptedFormats({
 			supportedMediaFormats: '1920x1080i5000, 1280x720, i5000, i5000tff',
-			mediaPreviewsUrl: '',
 			frameRate: 25,
-			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 		})
 		expect(acceptedFormats).toEqual([
 			['1920', '1080', 'i', '5000', undefined],
@@ -251,6 +249,8 @@ describe('lib/mediaObjects', () => {
 			supportedAudioStreams: '4',
 			frameRate: 25,
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
+			allowHold: false,
+			allowPieceDirectPlay: false,
 		}
 
 		const mockDefaultStudio = defaultStudio(protectString('studio0'))

meteor/server/publications/pieceContentStatusUI/checkPieceContentStatus.ts

@@ -147,7 +147,9 @@ export function acceptFormat(format: string, formats: Array<Array<string>>): boo
  * 	[undefined, undefined, i, 5000, tff]
  * ]
  */
-export function getAcceptedFormats(settings: IStudioSettings | undefined): Array<Array<string>> {
+export function getAcceptedFormats(
+	settings: Pick<IStudioSettings, 'supportedMediaFormats' | 'frameRate'> | undefined
+): Array<Array<string>> {
 	const formatsConfigField = settings ? settings.supportedMediaFormats : ''
 	const formatsString: string =
 		(formatsConfigField && formatsConfigField !== '' ? formatsConfigField : '1920x1080i5000') + ''

packages/corelib/src/dataModel/Studio.ts

@@ -94,13 +94,13 @@ export interface IStudioSettings {
 	 * When disabled, any action-triggers that would normally trigger a hold operation will be silently ignored
 	 * This should only block entering hold, to ensure Sofie doesn't get stuck if it somehow gets into hold
 	 */
-	allowHold?: boolean
+	allowHold: boolean
 
 	/**
 	 * Whether to allow direct playing of a piece in the rundown
 	 * This behaviour is usally triggered by double-clicking on a piece in the GUI
 	 */
-	allowPieceDirectPlay?: boolean
+	allowPieceDirectPlay: boolean
 }
 
 export type StudioLight = Omit<DBStudio, 'mappingsWithOverrides' | 'blueprintConfigWithOverrides'>