chore: only save scratchpad segment when rank changes

Author: Julusian

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

@@ -107,9 +107,10 @@ export class PlayoutRundownModelImpl implements PlayoutRundownModel {
 		const segment = this.#segments.find((s) => s.segment.orphaned === SegmentOrphanedReason.SCRATCHPAD)
 		if (!segment) return
 
-		segment.setScratchpadRank(calculateRankForScratchpadSegment(this.#segments))
-		this.#segments.sort((a, b) => a.segment._rank - b.segment._rank)
+		const changed = segment.setScratchpadRank(calculateRankForScratchpadSegment(this.#segments))
+		if (!changed) return
 
+		this.#segments.sort((a, b) => a.segment._rank - b.segment._rank)
 		this.#scratchPadSegmentHasChanged = true
 	}
 }

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

@@ -32,10 +32,13 @@ export class PlayoutSegmentModelImpl implements PlayoutSegmentModel {
 	 * This segment belongs to Playout, so is allowed to be modified in this way
 	 * @param rank New rank for the segment
 	 */
-	setScratchpadRank(rank: number): void {
+	setScratchpadRank(rank: number): boolean {
 		if (this.#segment.orphaned !== SegmentOrphanedReason.SCRATCHPAD)
 			throw new Error('setScratchpadRank can only be used on a SCRATCHPAD segment')
 
+		if (this.#segment._rank == rank) return false
+
 		this.#segment._rank = rank
+		return true
 	}
 }

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

@@ -323,6 +323,22 @@ describe('PlayoutRundownModelImpl', () => {
 			expect(model.ScratchPadSegmentHasChanged).toBeTruthy()
 		})
 
+		it('pre-defined: no change', async () => {
+			const rundown = createBasicDBRundown()
+
+			const segment = createBasicDBSegment('seg0', -1)
+			segment.orphaned = SegmentOrphanedReason.SCRATCHPAD
+			const segmentModel = new PlayoutSegmentModelImpl(segment, [])
+
+			const model = new PlayoutRundownModelImpl(rundown, [segmentModel], [])
+
+			model.clearScratchPadSegmentChangedFlag()
+			model.updateScratchpadSegmentRank()
+
+			expect(model.getScratchpadSegment()?.segment._rank).toBe(-1)
+			expect(model.ScratchPadSegmentHasChanged).toBeFalsy()
+		})
+
 		it('after remove', async () => {
 			const rundown = createBasicDBRundown()
 

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

@@ -91,7 +91,12 @@ describe('PlayoutSegmentModelImpl', () => {
 			const originalRank = segment._rank
 			const model = new PlayoutSegmentModelImpl(segment, [])
 
-			model.setScratchpadRank(originalRank + 1)
+			// Set should report change
+			expect(model.setScratchpadRank(originalRank + 1)).toBeTruthy()
+			expect(model.segment._rank).toBe(originalRank + 1)
+
+			// Set again should report no change
+			expect(model.setScratchpadRank(originalRank + 1)).toBeFalsy()
 			expect(model.segment._rank).toBe(originalRank + 1)
 		})