feat: Add getUpcomingParts to action context (#1524)

So that an action can be taken based on what items may be coming up
(further ahead than the next part instance)

Author: rjmunro

packages/blueprints-integration/src/context/partsAndPieceActionContext.ts

@@ -1,3 +1,4 @@
+import { ReadonlyDeep } from 'type-fest'
 import {
 	IBlueprintMutatablePart,
 	IBlueprintPart,
@@ -48,6 +49,13 @@ export interface IPartAndPieceActionContext {
 	/** Gets the Segment. This primarily allows for accessing metadata */
 	getSegment(segment: 'current' | 'next'): Promise<IBlueprintSegment | undefined>
 
+	/** Get a list of the upcoming Parts in the Rundown, in the order that they will be Taken
+	 *
+	 * @param limit The max number of parts returned. Default is 5.
+	 * @returns An array of Parts. If there is no next part, the array will be empty.
+	 */
+	getUpcomingParts(limit?: number): Promise<ReadonlyDeep<IBlueprintPart[]>>
+
 	/**
 	 * Creative actions
 	 */

packages/job-worker/src/blueprints/__tests__/context-OnTakeContext.test.ts

@@ -1,22 +1,26 @@
 /* eslint-disable @typescript-eslint/unbound-method */
 import { IBlueprintMutatablePart, IBlueprintPiece } from '@sofie-automation/blueprints-integration'
-import { PlayoutModel } from '../../playout/model/PlayoutModel.js'
 import { WatchedPackagesHelper } from '../context/watchedPackages.js'
 import { JobContext, ProcessedShowStyleCompound } from '../../jobs/index.js'
 import { mock } from 'jest-mock-extended'
 import { PartAndPieceInstanceActionService } from '../context/services/PartAndPieceInstanceActionService.js'
 import { OnTakeContext } from '../context/index.js'
+import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
+import { PartId, RundownId, SegmentId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { protectString } from '@sofie-automation/corelib/dist/protectedString'
+import { PlayoutModelImpl } from '../../playout/model/implementation/PlayoutModelImpl.js'
 
 describe('Test blueprint api context', () => {
 	async function getTestee() {
+		const mockPlayoutModel = mock<PlayoutModelImpl>()
 		const mockActionService = mock<PartAndPieceInstanceActionService>()
 		const context = new OnTakeContext(
 			{
 				name: 'fakeContext',
 				identifier: 'action',
 			},
 			mock<JobContext>(),
-			mock<PlayoutModel>(),
+			mockPlayoutModel,
 			mock<ProcessedShowStyleCompound>(),
 			mock<WatchedPackagesHelper>(),
 			mockActionService
@@ -25,6 +29,7 @@ describe('Test blueprint api context', () => {
 		return {
 			context,
 			mockActionService,
+			mockPlayoutModel,
 		}
 	}
 
@@ -99,6 +104,42 @@ describe('Test blueprint api context', () => {
 			expect(mockActionService.getPartForPreviousPiece).toHaveBeenCalledWith({ _id: 'pieceId' })
 		})
 
+		test('getUpcomingParts', async () => {
+			const { context, mockPlayoutModel } = await getTestee()
+
+			mockPlayoutModel.getAllOrderedParts.mockReturnValue(
+				mock([
+					{
+						_id: protectString<PartId>('part1'),
+						title: 'Part 1',
+						invalid: false,
+						floated: false,
+						_rank: 1,
+						rundownId: protectString<RundownId>('rundown1'),
+						externalId: 'ext1',
+						segmentId: protectString<SegmentId>('seg1'),
+						expectedDurationWithTransition: 1000,
+						userEditOperations: [],
+					} as DBPart,
+					{
+						_id: protectString<PartId>('part2'),
+						title: 'Part 2',
+						invalid: false,
+						floated: false,
+						_rank: 1,
+						rundownId: protectString<RundownId>('rundown1'),
+						externalId: 'ext1',
+						segmentId: protectString<SegmentId>('seg1'),
+						expectedDurationWithTransition: 1000,
+						userEditOperations: [],
+					} as unknown as DBPart,
+				])
+			)
+
+			const parts = await context.getUpcomingParts()
+			expect(parts.map((i) => i.title)).toEqual(['Part 1', 'Part 2'])
+		})
+
 		test('insertPiece', async () => {
 			const { context, mockActionService } = await getTestee()
 

packages/job-worker/src/blueprints/context/OnTakeContext.ts

@@ -25,6 +25,8 @@ import { JobContext, ProcessedShowStyleCompound } from '../../jobs/index.js'
 import { executePeripheralDeviceAction, listPlayoutDevices } from '../../peripheralDevice.js'
 import { ActionPartChange, PartAndPieceInstanceActionService } from './services/PartAndPieceInstanceActionService.js'
 import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
+import { getOrderedPartsAfterPlayhead } from '../../playout/lookahead/util.js'
+import { convertPartToBlueprints } from './lib.js'
 
 export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContext, IEventContext {
 	public isTakeAborted: boolean
@@ -52,6 +54,10 @@ export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContex
 		this.isTakeAborted = false
 	}
 
+	async getUpcomingParts(limit: number = 5): Promise<ReadonlyDeep<IBlueprintPart[]>> {
+		return getOrderedPartsAfterPlayhead(this._context, this._playoutModel, limit).map(convertPartToBlueprints)
+	}
+
 	abortTake(): void {
 		this.isTakeAborted = true
 	}

packages/job-worker/src/blueprints/context/adlibActions.ts

@@ -32,6 +32,8 @@ import { executePeripheralDeviceAction, listPlayoutDevices } from '../../periphe
 import { ActionPartChange, PartAndPieceInstanceActionService } from './services/PartAndPieceInstanceActionService.js'
 import { BlueprintQuickLookInfo } from '@sofie-automation/blueprints-integration/dist/context/quickLoopInfo'
 import { setNextPartFromPart } from '../../playout/setNext.js'
+import { getOrderedPartsAfterPlayhead } from '../../playout/lookahead/util.js'
+import { convertPartToBlueprints } from './lib.js'
 
 export class DatastoreActionExecutionContext
 	extends ShowStyleUserContext
@@ -102,6 +104,10 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 		super(contextInfo, _context, showStyle, watchedPackages)
 	}
 
+	async getUpcomingParts(limit: number = 5): Promise<ReadonlyDeep<IBlueprintPart[]>> {
+		return getOrderedPartsAfterPlayhead(this._context, this._playoutModel, limit).map(convertPartToBlueprints)
+	}
+
 	async getPartInstance(part: 'current' | 'next'): Promise<IBlueprintPartInstance | undefined> {
 		return this.partAndPieceInstanceService.getPartInstance(part)
 	}