chore: refactor and update findForLayer tests

Co-authored-by: Julian Waller <[email protected]>

Author: justandras

packages/job-worker/src/playout/lookahead/__tests__/findForLayer.test.ts

@@ -0,0 +1,25 @@
+import { context, findLookaheadObjectsForPartMock } from './helpers/mockSetup.js'
+import { findLookaheadForLayer } from '../../findForLayer.js'
+import { expectInstancesToMatch } from '../utils.js'
+import { findForLayerTestConstants } from './constants.js'
+
+const current = findForLayerTestConstants.current
+const nextFuture = findForLayerTestConstants.nextFuture
+const layer = findForLayerTestConstants.layer
+
+describe('findLookaheadForLayer – basic behavior', () => {
+	test('no parts', () => {
+		const res = findLookaheadForLayer(context, {}, [], 'abc', 1, 1)
+
+		expect(res.timed).toHaveLength(0)
+		expect(res.future).toHaveLength(0)
+	})
+	test('if the previous part is unset', () => {
+		findLookaheadObjectsForPartMock.mockReturnValue([])
+
+		findLookaheadForLayer(context, { previous: undefined, current, next: nextFuture }, [], layer, 1, 1)
+
+		expect(findLookaheadObjectsForPartMock).toHaveBeenCalledTimes(2)
+		expectInstancesToMatch(1, layer, current, undefined)
+	})
+})

packages/job-worker/src/playout/lookahead/__tests__/findForLayer/basicBehavior.test.ts

@@ -0,0 +1,38 @@
+import { getRandomString } from '@sofie-automation/corelib/dist/lib'
+import { PartInstanceAndPieceInstances, PartAndPieces } from '../../util.js'
+import { createFakePiece } from '../utils.js'
+
+export const findForLayerTestConstants = {
+	previous: {
+		part: { _id: 'pPrev', part: 'prev' },
+		allPieces: [createFakePiece('1'), createFakePiece('2'), createFakePiece('3')],
+		onTimeline: true,
+		nowInPart: 2000,
+	} as any as PartInstanceAndPieceInstances,
+	current: {
+		part: { _id: 'pCur', part: 'cur' },
+		allPieces: [createFakePiece('4'), createFakePiece('5'), createFakePiece('6')],
+		onTimeline: true,
+		nowInPart: 1000,
+	} as any as PartInstanceAndPieceInstances,
+	nextTimed: {
+		part: { _id: 'pNextTimed', part: 'nextT' },
+		allPieces: [createFakePiece('7'), createFakePiece('8'), createFakePiece('9')],
+		onTimeline: true,
+	} as any as PartInstanceAndPieceInstances,
+	nextFuture: {
+		part: { _id: 'pNextFuture', part: 'nextF' },
+		allPieces: [createFakePiece('10'), createFakePiece('11'), createFakePiece('12')],
+		onTimeline: false,
+	} as any as PartInstanceAndPieceInstances,
+
+	orderedParts: [{ _id: 'p1' }, { _id: 'p2', invalid: true }, { _id: 'p3' }, { _id: 'p4' }, { _id: 'p5' }].map(
+		(p) => ({
+			part: p as any,
+			usesInTransition: true,
+			pieces: [{ _id: p._id + '_p1' } as any],
+		})
+	) as PartAndPieces[],
+
+	layer: getRandomString(),
+}

packages/job-worker/src/playout/lookahead/__tests__/findForLayer/constants.ts

@@ -0,0 +1,15 @@
+import { setupDefaultJobEnvironment } from '../../../../../__mocks__/context.js'
+
+jest.mock('../../../findObjects')
+import { findLookaheadObjectsForPart } from '../../../../../playout/lookahead/findObjects.js'
+
+export type TfindLookaheadObjectsForPart = jest.MockedFunction<typeof findLookaheadObjectsForPart>
+
+export const context = setupDefaultJobEnvironment()
+
+const findLookaheadObjectsForPartMockBase = findLookaheadObjectsForPart as TfindLookaheadObjectsForPart
+export const findLookaheadObjectsForPartMock = findLookaheadObjectsForPartMockBase.mockImplementation(() => []) // Default mock
+
+beforeEach(() => {
+	findLookaheadObjectsForPartMock.mockReset()
+})

packages/job-worker/src/playout/lookahead/__tests__/findForLayer/helpers/mockSetup.ts

@@ -0,0 +1,68 @@
+import { findLookaheadForLayer } from '../../findForLayer.js'
+import { setupDefaultJobEnvironment } from '../../../../__mocks__/context.js'
+
+jest.mock('../../findObjects')
+import { findForLayerTestConstants } from './constants.js'
+import { expectPartToMatch } from '../utils.js'
+import { findLookaheadObjectsForPartMock } from './helpers/mockSetup.js'
+
+const orderedParts = findForLayerTestConstants.orderedParts
+const layer = findForLayerTestConstants.layer
+
+describe('findLookaheadForLayer - orderedParts', () => {
+	beforeEach(() => {
+		findLookaheadObjectsForPartMock.mockReset()
+	})
+
+	const context = setupDefaultJobEnvironment()
+
+	test('finds lookahead for target index 1', () => {
+		findLookaheadObjectsForPartMock
+			.mockReturnValue([])
+			.mockReturnValueOnce(['t0', 't1'] as any)
+			.mockReturnValueOnce(['t2', 't3'] as any)
+			.mockReturnValueOnce(['t4', 't5'] as any)
+			.mockReturnValueOnce(['t6', 't7'] as any)
+			.mockReturnValueOnce(['t8', 't9'] as any)
+
+		const res2 = findLookaheadForLayer(context, {}, orderedParts, layer, 1, 4, null)
+
+		expect(res2.timed).toHaveLength(0)
+		expect(res2.future).toEqual(['t0', 't1'])
+		expect(findLookaheadObjectsForPartMock).toHaveBeenCalledTimes(1)
+
+		expectPartToMatch(1, layer, orderedParts[0], undefined)
+	})
+
+	test('returns nothing when target index is 0', () => {
+		findLookaheadObjectsForPartMock.mockReturnValue([])
+
+		const res3 = findLookaheadForLayer(context, {}, orderedParts, layer, 0, 4, null)
+
+		expect(res3.timed).toHaveLength(0)
+		expect(res3.future).toHaveLength(0)
+		expect(findLookaheadObjectsForPartMock).toHaveBeenCalledTimes(0)
+	})
+
+	test('searches across maximum search distance', () => {
+		findLookaheadObjectsForPartMock
+			.mockReturnValue([])
+			.mockReturnValueOnce(['t0', 't1'] as any)
+			.mockReturnValueOnce(['t2', 't3'] as any)
+			.mockReturnValueOnce(['t4', 't5'] as any)
+			.mockReturnValueOnce(['t6', 't7'] as any)
+			.mockReturnValueOnce(['t8', 't9'] as any)
+
+		const res4 = findLookaheadForLayer(context, {}, orderedParts, layer, 100, 5, null)
+
+		expect(res4.timed).toHaveLength(0)
+		expect(res4.future).toEqual(['t0', 't1', 't2', 't3', 't4', 't5'])
+
+		// Called for parts: [0], [2], [3]
+		expect(findLookaheadObjectsForPartMock).toHaveBeenCalledTimes(3)
+
+		expectPartToMatch(1, layer, orderedParts[0], undefined)
+		expectPartToMatch(2, layer, orderedParts[2], orderedParts[0].part)
+		expectPartToMatch(3, layer, orderedParts[3], orderedParts[2].part)
+	})
+})