fix(LoadPlayoutModel): rundowns are unsorted in createPlayoutModelFromIngestModel

Author: jstarpl

packages/corelib/src/playout/playlist.ts

@@ -93,8 +93,8 @@ export function sortRundownIDsInPlaylist(
 
 export function sortRundownsWithinPlaylist(
 	sortedPossibleIds: ReadonlyDeep<RundownId[]>,
-	unsortedRundowns: DBRundown[]
-): DBRundown[] {
+	unsortedRundowns: ReadonlyDeep<DBRundown[]>
+): ReadonlyDeep<DBRundown[]> {
 	return unsortedRundowns.slice().sort((a, b) => {
 		const indexA = sortedPossibleIds.indexOf(a._id)
 		const indexB = sortedPossibleIds.indexOf(b._id)

packages/job-worker/src/playout/model/PlayoutModel.ts

@@ -55,7 +55,7 @@ export interface PlayoutModelPreInit {
 	 */
 	readonly playlist: ReadonlyDeep<DBRundownPlaylist>
 	/**
-	 * The unwrapped Rundowns in this RundownPlaylist
+	 * The unwrapped Rundowns in this RundownPlaylist, sorted in order specified by RundownPlaylist
 	 */
 	readonly rundowns: ReadonlyDeep<DBRundown[]>
 

packages/job-worker/src/playout/model/implementation/LoadPlayoutModel.ts

@@ -90,7 +90,7 @@ export async function createPlayoutModelFromIngestModel(
 
 	const [partInstances, rundownsWithContent, timeline] = await Promise.all([
 		loadPartInstances(context, loadedPlaylist, rundownIds),
-		loadRundowns(context, ingestModel, rundowns),
+		loadRundowns(context, ingestModel, sortRundownsWithinPlaylist(playlist.rundownIdsInOrder, rundowns)),
 		loadTimeline(context),
 	])
 

packages/job-worker/src/playout/model/implementation/__tests__/LoadPlayoutModel.spec.ts

@@ -7,8 +7,11 @@ import { MockJobContext, setupDefaultJobEnvironment } from '../../../../__mocks_
 import { ProcessedShowStyleCompound } from '../../../../jobs'
 import { ReadonlyDeep } from 'type-fest'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
-import { loadPlayoutModelPreInit } from '../LoadPlayoutModel'
+import { createPlayoutModelFromIngestModel, loadPlayoutModelPreInit } from '../LoadPlayoutModel'
 import { runWithPlaylistLock } from '../../../../playout/lock'
+import { loadIngestModelFromRundown } from '../../../../ingest/model/implementation/LoadIngestModel'
+import { runWithRundownLock } from '../../../../ingest/lock'
+import { IngestModelReadonly } from '../../../../ingest/model/IngestModel'
 
 describe('LoadPlayoutModel', () => {
 	let context: MockJobContext
@@ -94,4 +97,63 @@ describe('LoadPlayoutModel', () => {
 			})
 		})
 	})
+
+	describe('createPlayoutModelFromIngestModel', () => {
+		afterEach(async () =>
+			Promise.all([
+				context.mockCollections.RundownBaselineAdLibPieces.remove({}),
+				context.mockCollections.RundownBaselineAdLibActions.remove({}),
+				context.mockCollections.RundownBaselineObjects.remove({}),
+				context.mockCollections.AdLibActions.remove({}),
+				context.mockCollections.AdLibPieces.remove({}),
+				context.mockCollections.Pieces.remove({}),
+				context.mockCollections.Parts.remove({}),
+				context.mockCollections.Segments.remove({}),
+				context.mockCollections.Rundowns.remove({}),
+				context.mockCollections.RundownPlaylists.remove({}),
+			])
+		)
+
+		test('Rundowns are in order specified in RundownPlaylist', async () => {
+			// Set up a playlist:
+			const { rundownId: rundownId00, playlistId: playlistId0 } = await setupDefaultRundownPlaylist(
+				context,
+				showStyleCompound,
+				protectString('rundown00')
+			)
+			const rundownId01 = protectString('rundown01')
+			await setupDefaultRundown(context, showStyleCompound, playlistId0, rundownId01)
+			const rundownId02 = protectString('rundown02')
+			await setupDefaultRundown(context, showStyleCompound, playlistId0, rundownId02)
+
+			const rundownIdsInOrder = [rundownId01, rundownId02, rundownId00]
+
+			await context.mockCollections.RundownPlaylists.update(playlistId0, {
+				rundownIdsInOrder,
+			})
+
+			const playlist0 = await context.mockCollections.RundownPlaylists.findOne(playlistId0)
+			expect(playlist0).toBeTruthy()
+
+			if (!playlist0) throw new Error(`Playlist "${playlistId0}" not found!`)
+
+			let ingestModel: IngestModelReadonly | undefined
+
+			await runWithRundownLock(context, rundownId01, async (rundown, lock) => {
+				if (!rundown) throw new Error(`Rundown "${rundownId01}" not found!`)
+
+				ingestModel = await loadIngestModelFromRundown(context, lock, rundown)
+			})
+
+			await runWithPlaylistLock(context, playlistId0, async (lock) => {
+				if (!ingestModel) throw new Error('Ingest model could not be created!')
+
+				const rundowns = await context.mockCollections.Rundowns.findFetch({})
+
+				const model = await createPlayoutModelFromIngestModel(context, lock, playlist0, rundowns, ingestModel)
+
+				expect(model.rundowns.map((r) => r.rundown._id)).toMatchObject([rundownId01, rundownId02, rundownId00])
+			})
+		})
+	})
 })