wip: move Studio.settings to Studio.settingsWithOverrides

Author: Julusian

meteor/__mocks__/defaultCollectionObjects.ts

@@ -105,12 +105,12 @@ 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,
-		},
+		}),
 		_rundownVersionHash: '',
 		routeSetsWithOverrides: wrapDefaultObject({}),
 		routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),

meteor/server/api/evaluations.ts

@@ -10,6 +10,7 @@ import { sendSlackMessageToWebhook } from './integration/slack'
 import { OrganizationId, UserId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
 import { Evaluations, RundownPlaylists } from '../collections'
+import { applyAndValidateOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 
 export async function saveEvaluation(
 	credentials: {
@@ -33,8 +34,9 @@ export async function saveEvaluation(
 	deferAsync(async () => {
 		const studio = await fetchStudioLight(evaluation.studioId)
 		if (!studio) throw new Meteor.Error(500, `Studio ${evaluation.studioId} not found!`)
+		const studioSettings = applyAndValidateOverrides(studio.settingsWithOverrides).obj
 
-		const webhookUrls = _.compact((studio.settings.slackEvaluationUrls || '').split(','))
+		const webhookUrls = _.compact((studioSettings.slackEvaluationUrls || '').split(','))
 
 		if (webhookUrls.length) {
 			// Only send notes if not everything is OK

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

@@ -266,13 +266,17 @@ export async function studioFrom(apiStudio: APIStudio, existingId?: StudioId): P
 		? updateOverrides(studio.blueprintConfigWithOverrides, apiStudio.config as IBlueprintConfig)
 		: wrapDefaultObject({})
 
+	const studioSettings = studioSettingsFrom(apiStudio.settings)
+
 	return {
 		_id: existingId ?? getRandomId(),
 		name: apiStudio.name,
 		blueprintId: blueprint?._id,
 		blueprintConfigPresetId: apiStudio.blueprintConfigPresetId,
 		blueprintConfigWithOverrides: blueprintConfig,
-		settings: studioSettingsFrom(apiStudio.settings),
+		settingsWithOverrides: studio
+			? updateOverrides(studio.settingsWithOverrides, studioSettings)
+			: wrapDefaultObject(studioSettings),
 		supportedShowStyleBase: apiStudio.supportedShowStyleBase?.map((id) => protectString<ShowStyleBaseId>(id)) ?? [],
 		organizationId: null,
 		mappingsWithOverrides: wrapDefaultObject({}),
@@ -293,7 +297,7 @@ export async function studioFrom(apiStudio: APIStudio, existingId?: StudioId): P
 }
 
 export function APIStudioFrom(studio: DBStudio): APIStudio {
-	const studioSettings = APIStudioSettingsFrom(studio.settings)
+	const studioSettings = APIStudioSettingsFrom(applyAndValidateOverrides(studio.settingsWithOverrides).obj)
 
 	return {
 		name: studio.name,

meteor/server/api/studio/api.ts

@@ -45,11 +45,11 @@ export async function insertStudioInner(organizationId: OrganizationId | null, n
 			supportedShowStyleBase: [],
 			blueprintConfigWithOverrides: wrapDefaultObject({}),
 			// testToolsConfig?: ITestToolsConfig
-			settings: {
+			settingsWithOverrides: wrapDefaultObject({
 				frameRate: 25,
 				mediaPreviewsUrl: '',
 				minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
-			},
+			}),
 			_rundownVersionHash: '',
 			routeSetsWithOverrides: wrapDefaultObject({}),
 			routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),

meteor/server/migration/0_1_0.ts

@@ -29,11 +29,11 @@ export const addSteps = addMigrationSteps('0.1.0', [
 				name: 'Default studio',
 				organizationId: null,
 				supportedShowStyleBase: [],
-				settings: {
+				settingsWithOverrides: wrapDefaultObject({
 					frameRate: 25,
 					mediaPreviewsUrl: '',
 					minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
-				},
+				}),
 				mappingsWithOverrides: wrapDefaultObject({}),
 				blueprintConfigWithOverrides: wrapDefaultObject({}),
 				_rundownVersionHash: '',

meteor/server/migration/X_X_X.ts

@@ -1,11 +1,15 @@
 import { addMigrationSteps } from './databaseMigration'
 import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
 import { Studios, TriggeredActions } from '../collections'
-import { convertObjectIntoOverrides } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
+import {
+	convertObjectIntoOverrides,
+	wrapDefaultObject,
+} from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 import {
 	StudioRouteSet,
 	StudioRouteSetExclusivityGroup,
 	StudioPackageContainer,
+	IStudioSettings,
 } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { DEFAULT_CORE_TRIGGER_IDS } from './upgrades/defaultSystemActionTriggers'
 
@@ -212,4 +216,46 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 			})
 		},
 	},
+
+	{
+		id: `convert studio.settings to ObjectWithOverrides`,
+		canBeRunAutomatically: true,
+		validate: async () => {
+			const studios = await Studios.findFetchAsync({
+				settings: { $exists: true },
+				settingsWithOverrides: { $exists: false },
+			})
+
+			for (const studio of studios) {
+				//@ts-expect-error settings is not typed as ObjectWithOverrides
+				if (studio.settings) {
+					return 'settings must be converted to an ObjectWithOverrides'
+				}
+			}
+
+			return false
+		},
+		migrate: async () => {
+			const studios = await Studios.findFetchAsync({
+				settings: { $exists: true },
+				settingsWithOverrides: { $exists: false },
+			})
+
+			for (const studio of studios) {
+				//@ts-expect-error settings is typed as Record<string, StudioRouteSet>
+				const oldSettings = studio.settings
+
+				const newSettings = wrapDefaultObject<IStudioSettings>(oldSettings || {})
+
+				await Studios.updateAsync(studio._id, {
+					$set: {
+						settingsWithOverrides: newSettings,
+					},
+					$unset: {
+						// settings: 1,
+					},
+				})
+			}
+		},
+	},
 ])

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

@@ -121,11 +121,11 @@ describe('Migrations', () => {
 						name: 'Default studio',
 						organizationId: null,
 						supportedShowStyleBase: [],
-						settings: {
+						settingsWithOverrides: wrapDefaultObject({
 							mediaPreviewsUrl: '',
 							frameRate: 25,
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
-						},
+						}),
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
 						_rundownVersionHash: '',
@@ -159,11 +159,11 @@ describe('Migrations', () => {
 						name: 'Default studio',
 						organizationId: null,
 						supportedShowStyleBase: [],
-						settings: {
+						settingsWithOverrides: wrapDefaultObject({
 							mediaPreviewsUrl: '',
 							frameRate: 25,
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
-						},
+						}),
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
 						_rundownVersionHash: '',
@@ -197,11 +197,11 @@ describe('Migrations', () => {
 						name: 'Default studio',
 						organizationId: null,
 						supportedShowStyleBase: [],
-						settings: {
+						settingsWithOverrides: wrapDefaultObject({
 							mediaPreviewsUrl: '',
 							frameRate: 25,
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
-						},
+						}),
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
 						_rundownVersionHash: '',

meteor/server/publications/lib/quickLoop.ts

@@ -10,7 +10,7 @@ import { ProtectedString, unprotectString } from '@sofie-automation/corelib/dist
 import { DEFAULT_FALLBACK_PART_DURATION } from '@sofie-automation/shared-lib/dist/core/constants'
 import { getCurrentTime } from '../../lib/lib'
 import { generateTranslation } from '@sofie-automation/corelib/dist/lib'
-import { DBStudio } from '@sofie-automation/corelib/dist/dataModel/Studio'
+import { IStudioSettings } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
 import { ReadonlyObjectDeep } from 'type-fest/source/readonly-deep'
@@ -47,7 +47,7 @@ export function modifyPartForQuickLoop(
 	segmentRanks: Record<string, number>,
 	rundownRanks: Record<string, number>,
 	playlist: Pick<DBRundownPlaylist, 'quickLoop'>,
-	studio: Pick<DBStudio, 'settings'>,
+	studioSettings: IStudioSettings,
 	quickLoopStartPosition: MarkerPosition | undefined,
 	quickLoopEndPosition: MarkerPosition | undefined,
 	canSetAutoNext = () => true
@@ -60,7 +60,7 @@ export function modifyPartForQuickLoop(
 		compareMarkerPositions(quickLoopStartPosition, partPosition) >= 0 &&
 		compareMarkerPositions(partPosition, quickLoopEndPosition) >= 0
 
-	const fallbackPartDuration = studio.settings.fallbackPartDuration ?? DEFAULT_FALLBACK_PART_DURATION
+	const fallbackPartDuration = studioSettings.fallbackPartDuration ?? DEFAULT_FALLBACK_PART_DURATION
 
 	if (isLoopingOverriden && (part.expectedDuration ?? 0) < fallbackPartDuration) {
 		if (playlist.quickLoop?.forceAutoNext === ForceQuickLoopAutoNext.ENABLED_FORCING_MIN_DURATION) {
@@ -82,7 +82,7 @@ export function modifyPartInstanceForQuickLoop(
 	segmentRanks: Record<string, number>,
 	rundownRanks: Record<string, number>,
 	playlist: Pick<DBRundownPlaylist, 'quickLoop'>,
-	studio: Pick<DBStudio, 'settings'>,
+	studioSettings: IStudioSettings,
 	quickLoopStartPosition: MarkerPosition | undefined,
 	quickLoopEndPosition: MarkerPosition | undefined
 ): void {
@@ -107,7 +107,7 @@ export function modifyPartInstanceForQuickLoop(
 		segmentRanks,
 		rundownRanks,
 		playlist,
-		studio,
+		studioSettings,
 		quickLoopStartPosition,
 		quickLoopEndPosition,
 		canAutoNext // do not adjust the part instance if we have passed the time where we can still enable auto next

meteor/server/publications/partInstancesUI/publication.ts

@@ -106,7 +106,7 @@ async function setupUIPartInstancesPublicationObservers(
 				changed: () => triggerUpdate({ invalidateQuickLoop: true }),
 				removed: () => triggerUpdate({ invalidateQuickLoop: true }),
 			}),
-			cache.Studios.find({}).observeChanges({
+			cache.StudioSettings.find({}).observeChanges({
 				added: () => triggerUpdate({ invalidateQuickLoop: true }),
 				changed: () => triggerUpdate({ invalidateQuickLoop: true }),
 				removed: () => triggerUpdate({ invalidateQuickLoop: true }),
@@ -148,8 +148,8 @@ export async function manipulateUIPartInstancesPublicationData(
 	const playlist = state.contentCache.RundownPlaylists.findOne({})
 	if (!playlist) return
 
-	const studio = state.contentCache.Studios.findOne({})
-	if (!studio) return
+	const studioSettings = state.contentCache.StudioSettings.findOne({})
+	if (!studioSettings) return
 
 	const rundownRanks = stringsToIndexLookup(playlist.rundownIdsInOrder as unknown as string[])
 	const segmentRanks = extractRanks(state.contentCache.Segments.find({}).fetch())
@@ -191,7 +191,7 @@ export async function manipulateUIPartInstancesPublicationData(
 				segmentRanks,
 				rundownRanks,
 				playlist,
-				studio,
+				studioSettings.settings,
 				quickLoopStartPosition,
 				quickLoopEndPosition
 			)

meteor/server/publications/partInstancesUI/reactiveContentCache.ts

@@ -3,9 +3,10 @@ import { ReactiveCacheCollection } from '../lib/ReactiveCacheCollection'
 import { literal } from '@sofie-automation/corelib/dist/lib'
 import { MongoFieldSpecifierOnesStrict, MongoFieldSpecifierZeroes } from '@sofie-automation/corelib/dist/mongo'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
-import { DBStudio } from '@sofie-automation/corelib/dist/dataModel/Studio'
+import { DBStudio, IStudioSettings } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
+import { StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 
 export type RundownPlaylistCompact = Pick<DBRundownPlaylist, '_id' | 'activationId' | 'quickLoop' | 'rundownIdsInOrder'>
 export const rundownPlaylistFieldSpecifier = literal<MongoFieldSpecifierOnesStrict<RundownPlaylistCompact>>({
@@ -36,14 +37,19 @@ export const partInstanceFieldSpecifier = literal<MongoFieldSpecifierZeroes<DBPa
 	'part.privateData': 0,
 })
 
-export type StudioFields = '_id' | 'settings'
+export type StudioFields = '_id' | 'settingsWithOverrides'
 export const studioFieldSpecifier = literal<MongoFieldSpecifierOnesStrict<Pick<DBStudio, StudioFields>>>({
 	_id: 1,
-	settings: 1,
+	settingsWithOverrides: 1,
 })
 
+export interface StudioSettingsDoc {
+	_id: StudioId
+	settings: IStudioSettings
+}
+
 export interface ContentCache {
-	Studios: ReactiveCacheCollection<Pick<DBStudio, StudioFields>>
+	StudioSettings: ReactiveCacheCollection<StudioSettingsDoc>
 	Segments: ReactiveCacheCollection<Pick<DBSegment, SegmentFields>>
 	Parts: ReactiveCacheCollection<Pick<DBPart, PartFields>>
 	PartInstances: ReactiveCacheCollection<Omit<DBPartInstance, PartInstanceOmitedFields>>
@@ -52,7 +58,7 @@ export interface ContentCache {
 
 export function createReactiveContentCache(): ContentCache {
 	const cache: ContentCache = {
-		Studios: new ReactiveCacheCollection<Pick<DBStudio, StudioFields>>('studios'),
+		StudioSettings: new ReactiveCacheCollection<StudioSettingsDoc>('studioSettings'),
 		Segments: new ReactiveCacheCollection<Pick<DBSegment, SegmentFields>>('segments'),
 		Parts: new ReactiveCacheCollection<Pick<DBPart, PartFields>>('parts'),
 		PartInstances: new ReactiveCacheCollection<Omit<DBPartInstance, PartInstanceOmitedFields>>('partInstances'),