Merge pull request #1275 from nrkno/fix/sofie-3501/playoutModel-rundownsInOrder

fix: playout model rundowns not in order (SOFIE-3501)

Author: jstarpl

packages/corelib/src/playout/playlist.ts

@@ -1,3 +1,4 @@
+import { DBRundown } from '../dataModel/Rundown'
 import { DBSegment } from '../dataModel/Segment'
 import { DBPart } from '../dataModel/Part'
 import { DBPartInstance } from '../dataModel/PartInstance'
@@ -89,3 +90,22 @@ export function sortRundownIDsInPlaylist(
 
 	return [...sortedVerifiedExisting, ...missingIds]
 }
+
+export function sortRundownsWithinPlaylist(
+	sortedPossibleIds: ReadonlyDeep<RundownId[]>,
+	unsortedRundowns: DBRundown[]
+): DBRundown[] {
+	return unsortedRundowns.slice().sort((a, b) => {
+		const indexA = sortedPossibleIds.indexOf(a._id)
+		const indexB = sortedPossibleIds.indexOf(b._id)
+		if (indexA === -1 && indexB === -1) {
+			return a._id.toString().localeCompare(b._id.toString())
+		} else if (indexA === -1) {
+			return 1
+		} else if (indexB === -1) {
+			return -1
+		}
+
+		return indexA - indexB
+	})
+}

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

@@ -22,6 +22,7 @@ import { PeripheralDevice } from '@sofie-automation/corelib/dist/dataModel/Perip
 import { PlayoutModel, PlayoutModelPreInit } from '../PlayoutModel'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 import { RundownBaselineObj } from '@sofie-automation/corelib/dist/dataModel/RundownBaselineObj'
+import { sortRundownsWithinPlaylist } from '@sofie-automation/corelib/dist/playout/playlist'
 
 /**
  * Load a PlayoutModelPreInit for the given RundownPlaylist
@@ -59,7 +60,7 @@ export async function loadPlayoutModelPreInit(
 		peripheralDevices: PeripheralDevices,
 
 		playlist: Playlist,
-		rundowns: Rundowns,
+		rundowns: sortRundownsWithinPlaylist(Playlist.rundownIdsInOrder, Rundowns),
 
 		getRundown: (id: RundownId) => Rundowns.find((rd) => rd._id === id),
 	}

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

@@ -0,0 +1,97 @@
+import {
+	setupDefaultRundown,
+	setupDefaultRundownPlaylist,
+	setupMockShowStyleCompound,
+} from '../../../../__mocks__/presetCollections'
+import { MockJobContext, setupDefaultJobEnvironment } from '../../../../__mocks__/context'
+import { ProcessedShowStyleCompound } from '../../../../jobs'
+import { ReadonlyDeep } from 'type-fest'
+import { protectString } from '@sofie-automation/corelib/dist/protectedString'
+import { loadPlayoutModelPreInit } from '../LoadPlayoutModel'
+import { runWithPlaylistLock } from '../../../../playout/lock'
+
+describe('LoadPlayoutModel', () => {
+	let context: MockJobContext
+	let showStyleCompound: ReadonlyDeep<ProcessedShowStyleCompound>
+
+	beforeAll(async () => {
+		context = setupDefaultJobEnvironment()
+
+		showStyleCompound = await setupMockShowStyleCompound(context)
+	})
+
+	describe('loadPlayoutModelPreInit', () => {
+		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 playlist0 = await context.mockCollections.RundownPlaylists.findOne(playlistId0)
+			expect(playlist0).toBeTruthy()
+
+			if (!playlist0) throw new Error(`Playlist "${playlistId0}" not found!`)
+
+			const rundownIdsInOrder = [rundownId01, rundownId02, rundownId00]
+
+			await context.mockCollections.RundownPlaylists.update(playlistId0, {
+				rundownIdsInOrder,
+			})
+
+			await runWithPlaylistLock(context, playlistId0, async (lock) => {
+				const model = await loadPlayoutModelPreInit(context, lock, playlist0)
+				expect(model.rundowns.map((r) => r._id)).toMatchObject([rundownId01, rundownId02, rundownId00])
+			})
+		})
+
+		test('Rundowns not ordered in RundownPlaylist are at the end', 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 playlist0 = await context.mockCollections.RundownPlaylists.findOne(playlistId0)
+			expect(playlist0).toBeTruthy()
+
+			if (!playlist0) throw new Error(`Playlist "${playlistId0}" not found!`)
+
+			const rundownIdsInOrder = [rundownId01]
+
+			await context.mockCollections.RundownPlaylists.update(playlistId0, {
+				rundownIdsInOrder,
+			})
+
+			await runWithPlaylistLock(context, playlistId0, async (lock) => {
+				const model = await loadPlayoutModelPreInit(context, lock, playlist0)
+				expect(model.rundowns.map((r) => r._id)).toMatchObject([rundownId01, rundownId00, rundownId02])
+			})
+		})
+	})
+})