chore: add tests for PlayoutRundownModelImpl

Author: Julusian

packages/job-worker/src/ingest/commit.ts

@@ -729,16 +729,6 @@ async function removeSegments(
 
 async function validateScratchpad(_context: JobContext, playoutModel: PlayoutModel) {
 	for (const rundown of playoutModel.rundowns) {
-		const scratchpadSegment = rundown.getScratchpadSegment()
-
-		if (scratchpadSegment) {
-			// Ensure the _rank is just before the real content
-			const otherSegmentsInRundown = rundown.segments.filter(
-				(s) => s.segment.orphaned !== SegmentOrphanedReason.SCRATCHPAD
-			)
-			const minNormalRank = Math.min(0, ...otherSegmentsInRundown.map((s) => s.segment._rank))
-
-			rundown.setScratchpadSegmentRank(minNormalRank - 1)
-		}
+		rundown.updateScratchpadSegmentRank()
 	}
 }

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

@@ -63,9 +63,7 @@ export interface PlayoutRundownModel {
 	 */
 	getScratchpadSegment(): PlayoutSegmentModel | undefined
 	/**
-	 * Set the rank of the Scratchpad Segment in this Rundown
-	 * Throws if the segment does not exists
-	 * @param rank New rank
+	 * Update the rank of the Scratchpad Segment in this Rundown, if it exists
 	 */
-	setScratchpadSegmentRank(rank: number): void
+	updateScratchpadSegmentRank(): void
 }

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

@@ -67,14 +67,12 @@ export class PlayoutRundownModelImpl implements PlayoutRundownModel {
 		const existingSegment = this.segments.find((s) => s.segment.orphaned === SegmentOrphanedReason.SCRATCHPAD)
 		if (existingSegment) throw UserError.create(UserErrorMessage.ScratchpadAlreadyActive)
 
-		const minSegmentRank = Math.min(0, ...this.segments.map((s) => s.segment._rank))
-
 		const segmentId: SegmentId = getRandomId()
 		this.#segments.unshift(
 			new PlayoutSegmentModelImpl(
 				{
 					_id: segmentId,
-					_rank: minSegmentRank - 1,
+					_rank: calculateRankForScratchpadSegment(this.#segments),
 					externalId: '__scratchpad__',
 					externalModified: getCurrentTime(),
 					rundownId: this.rundown._id,
@@ -105,13 +103,24 @@ export class PlayoutRundownModelImpl implements PlayoutRundownModel {
 		return this.#segments.find((s) => s.segment.orphaned === SegmentOrphanedReason.SCRATCHPAD)
 	}
 
-	setScratchpadSegmentRank(rank: number): void {
+	updateScratchpadSegmentRank(): void {
 		const segment = this.#segments.find((s) => s.segment.orphaned === SegmentOrphanedReason.SCRATCHPAD)
-		if (!segment) throw new Error('Scratchpad segment does not exist!')
+		if (!segment) return
 
-		segment.setScratchpadRank(rank)
+		segment.setScratchpadRank(calculateRankForScratchpadSegment(this.#segments))
 		this.#segments.sort((a, b) => a.segment._rank - b.segment._rank)
 
 		this.#scratchPadSegmentHasChanged = true
 	}
 }
+
+function calculateRankForScratchpadSegment(segments: readonly PlayoutSegmentModel[]) {
+	// Ensure the _rank is just before the real content
+
+	return (
+		Math.min(
+			0,
+			...segments.map((s) => (s.segment.orphaned === SegmentOrphanedReason.SCRATCHPAD ? 0 : s.segment._rank))
+		) - 1
+	)
+}