feat(EAV-603): add manuallySelected to OnSetAsNextContext

Author: ianshade

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

@@ -20,6 +20,9 @@ export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContex
 	/** Information about the current loop, if there is one */
 	readonly quickLoopInfo: BlueprintQuickLookInfo | null
 
+	/** Whether the part being set as next was selected as a result of user's actions */
+	readonly manuallySelected: boolean
+
 	/**
 	 * Data fetching
 	 */

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

@@ -8,7 +8,7 @@ import { PartAndPieceInstanceActionService } from '../context/services/PartAndPi
 import { OnSetAsNextContext } from '../context/index.js'
 
 describe('Test blueprint api context', () => {
-	async function getTestee() {
+	async function getTestee(setManually = false) {
 		const mockActionService = mock<PartAndPieceInstanceActionService>()
 		const context = new OnSetAsNextContext(
 			{
@@ -19,7 +19,8 @@ describe('Test blueprint api context', () => {
 			mock<PlayoutModel>(),
 			mock<ProcessedShowStyleCompound>(),
 			mock<WatchedPackagesHelper>(),
-			mockActionService
+			mockActionService,
+			setManually
 		)
 
 		return {
@@ -28,7 +29,7 @@ describe('Test blueprint api context', () => {
 		}
 	}
 
-	describe('ActionExecutionContext', () => {
+	describe('OnSetAsNextContext', () => {
 		test('getPartInstance', async () => {
 			const { context, mockActionService } = await getTestee()
 
@@ -134,5 +135,17 @@ describe('Test blueprint api context', () => {
 			expect(mockActionService.updatePartInstance).toHaveBeenCalledTimes(1)
 			expect(mockActionService.updatePartInstance).toHaveBeenCalledWith('next', { title: 'My Part' })
 		})
+
+		test('manuallySelected when false', async () => {
+			const { context } = await getTestee(false)
+
+			expect(context.manuallySelected).toBe(false)
+		})
+
+		test('manuallySelected when true', async () => {
+			const { context } = await getTestee(true)
+
+			expect(context.manuallySelected).toBe(true)
+		})
 	})
 })

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

@@ -39,7 +39,8 @@ export class OnSetAsNextContext
 		private playoutModel: PlayoutModel,
 		showStyle: ReadonlyDeep<ProcessedShowStyleCompound>,
 		watchedPackages: WatchedPackagesHelper,
-		private partAndPieceInstanceService: PartAndPieceInstanceActionService
+		private partAndPieceInstanceService: PartAndPieceInstanceActionService,
+		public readonly manuallySelected: boolean
 	) {
 		super(contextInfo, context, showStyle, watchedPackages)
 	}

packages/job-worker/src/playout/setNext.ts

@@ -177,7 +177,7 @@ async function setNextPartAndCheckForPendingMoveNextPart(
 
 		playoutModel.setPartInstanceAsNext(newPartInstance, setManually, consumesQueuedSegmentId, nextTimeOffset)
 
-		return executeOnSetAsNextCallback(playoutModel, newPartInstance, context)
+		return executeOnSetAsNextCallback(playoutModel, newPartInstance, context, setManually)
 	} else {
 		// Set to null
 
@@ -189,7 +189,8 @@ async function setNextPartAndCheckForPendingMoveNextPart(
 async function executeOnSetAsNextCallback(
 	playoutModel: PlayoutModel,
 	newPartInstance: PlayoutPartInstanceModel,
-	context: JobContext
+	context: JobContext,
+	setManually: boolean
 ) {
 	const NOTIFICATION_CATEGORY = 'onSetAsNext'
 
@@ -219,7 +220,8 @@ async function executeOnSetAsNextCallback(
 		playoutModel,
 		showStyle,
 		watchedPackagesHelper,
-		new PartAndPieceInstanceActionService(context, playoutModel, showStyle, rundownOfNextPart)
+		new PartAndPieceInstanceActionService(context, playoutModel, showStyle, rundownOfNextPart),
+		setManually
 	)
 
 	// Clear any existing notifications for this partInstance. This will clear any from the previous setAsNext