feat: allow adlib-actions to remove pieces from the current partInstance

Author: Julusian

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

@@ -67,8 +67,8 @@ export interface IOnSetAsNextContext extends IShowStyleUserContext, IEventContex
 	/**
 	 * Destructive actions
 	 */
-	/** Remove piecesInstances by id. Returns ids of piecesInstances that were removed. Note: For now we only allow removing from the next, but this might change to include current if there is justification */
-	removePieceInstances(part: 'next', pieceInstanceIds: string[]): Promise<string[]>
+	/** Remove piecesInstances by id. Returns ids of piecesInstances that were removed. */
+	removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]>
 
 	/**
 	 * Move the next part through the rundown. Can move by either a number of parts, or segments in either direction.

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

@@ -68,6 +68,6 @@ export interface IPartAndPieceActionContext {
 	stopPiecesOnLayers(sourceLayerIds: string[], timeOffset?: number): Promise<string[]>
 	/** Stop piecesInstances by id. Returns ids of piecesInstances that were removed */
 	stopPieceInstances(pieceInstanceIds: string[], timeOffset?: number): Promise<string[]>
-	/** Remove piecesInstances by id. Returns ids of piecesInstances that were removed. Note: For now we only allow removing from the next, but this might change to include current if there is justification */
-	removePieceInstances(part: 'next', pieceInstanceIds: string[]): Promise<string[]>
+	/** Remove piecesInstances by id. Returns ids of piecesInstances that were removed. */
+	removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]>
 }

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

@@ -113,6 +113,10 @@ describe('Test blueprint api context', () => {
 			await context.removePieceInstances('next', ['pieceInstanceId'])
 			expect(mockActionService.removePieceInstances).toHaveBeenCalledTimes(1)
 			expect(mockActionService.removePieceInstances).toHaveBeenCalledWith('next', ['pieceInstanceId'])
+
+			await context.removePieceInstances('current', ['pieceInstanceId'])
+			expect(mockActionService.removePieceInstances).toHaveBeenCalledTimes(2)
+			expect(mockActionService.removePieceInstances).toHaveBeenCalledWith('current', ['pieceInstanceId'])
 		})
 
 		test('updatePartInstance', async () => {

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

@@ -129,6 +129,10 @@ describe('Test blueprint api context', () => {
 			await context.removePieceInstances('next', ['pieceInstanceId'])
 			expect(mockActionService.removePieceInstances).toHaveBeenCalledTimes(1)
 			expect(mockActionService.removePieceInstances).toHaveBeenCalledWith('next', ['pieceInstanceId'])
+
+			await context.removePieceInstances('current', ['pieceInstanceId'])
+			expect(mockActionService.removePieceInstances).toHaveBeenCalledTimes(2)
+			expect(mockActionService.removePieceInstances).toHaveBeenCalledWith('current', ['pieceInstanceId'])
 		})
 
 		test('updatePartInstance', async () => {

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

@@ -139,6 +139,10 @@ describe('Test blueprint api context', () => {
 			await context.removePieceInstances('next', ['pieceInstanceId'])
 			expect(mockActionService.removePieceInstances).toHaveBeenCalledTimes(1)
 			expect(mockActionService.removePieceInstances).toHaveBeenCalledWith('next', ['pieceInstanceId'])
+
+			await context.removePieceInstances('current', ['pieceInstanceId'])
+			expect(mockActionService.removePieceInstances).toHaveBeenCalledTimes(2)
+			expect(mockActionService.removePieceInstances).toHaveBeenCalledWith('current', ['pieceInstanceId'])
 		})
 
 		test('updatePartInstance', async () => {

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

@@ -117,8 +117,8 @@ export class OnSetAsNextContext
 		return this.partAndPieceInstanceService.updatePartInstance(part, props)
 	}
 
-	async removePieceInstances(_part: 'next', pieceInstanceIds: string[]): Promise<string[]> {
-		return this.partAndPieceInstanceService.removePieceInstances('next', pieceInstanceIds)
+	async removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]> {
+		return this.partAndPieceInstanceService.removePieceInstances(part, pieceInstanceIds)
 	}
 
 	async moveNextPart(partDelta: number, segmentDelta: number, ignoreQuickLoop?: boolean): Promise<boolean> {

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

@@ -117,7 +117,7 @@ export class OnTakeContext extends ShowStyleUserContext implements IOnTakeContex
 	async stopPieceInstances(pieceInstanceIds: string[], timeOffset?: number | undefined): Promise<string[]> {
 		return this.partAndPieceInstanceService.stopPieceInstances(pieceInstanceIds, timeOffset)
 	}
-	async removePieceInstances(part: 'next', pieceInstanceIds: string[]): Promise<string[]> {
+	async removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]> {
 		return this.partAndPieceInstanceService.removePieceInstances(part, pieceInstanceIds)
 	}
 

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

@@ -183,7 +183,7 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 		return this.partAndPieceInstanceService.stopPieceInstances(pieceInstanceIds, timeOffset)
 	}
 
-	async removePieceInstances(part: 'next', pieceInstanceIds: string[]): Promise<string[]> {
+	async removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]> {
 		return this.partAndPieceInstanceService.removePieceInstances(part, pieceInstanceIds)
 	}
 

packages/job-worker/src/blueprints/context/services/PartAndPieceInstanceActionService.ts

@@ -450,8 +450,8 @@ export class PartAndPieceInstanceActionService {
 		)
 	}
 
-	async removePieceInstances(_part: 'next', pieceInstanceIds: string[]): Promise<string[]> {
-		const partInstance = this._getPartInstance('next')
+	async removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]> {
+		const partInstance = this._getPartInstance(part)
 		if (!partInstance) {
 			throw new Error('Cannot remove pieceInstances when no selected partInstance')
 		}

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

@@ -1610,7 +1610,7 @@ describe('Test blueprint api context', () => {
 				})
 			})
 
-			test('good', async () => {
+			test('good - from next', async () => {
 				const { jobContext, playlistId, allPartInstances } = await setupMyDefaultRundown()
 
 				const partInstance = allPartInstances[0]
@@ -1638,6 +1638,37 @@ describe('Test blueprint api context', () => {
 					expect(service.nextPartState).toEqual(ActionPartChange.SAFE_CHANGE)
 				})
 			})
+
+			test('good - from current', async () => {
+				const { jobContext, playlistId, allPartInstances } = await setupMyDefaultRundown()
+
+				const partInstance = allPartInstances[0]
+				await setPartInstances(jobContext, playlistId, partInstance, undefined)
+
+				await wrapWithPlayoutModel(jobContext, playlistId, async (playoutModel) => {
+					const { service } = await getTestee(jobContext, playoutModel)
+
+					const beforePieceInstancesCounts = getPieceInstanceCounts(playoutModel)
+					expect(beforePieceInstancesCounts.previous).toEqual(0)
+					expect(beforePieceInstancesCounts.current).not.toEqual(0)
+					expect(beforePieceInstancesCounts.next).toEqual(0)
+					expect(beforePieceInstancesCounts.other).toEqual(0)
+
+					// Find the instance, and create its backing piece
+					const targetPieceInstance = playoutModel.currentPartInstance!.pieceInstances[0]
+					expect(targetPieceInstance).toBeTruthy()
+
+					await expect(
+						service.removePieceInstances('current', [
+							unprotectString(targetPieceInstance.pieceInstance._id),
+						])
+					).resolves.toEqual([unprotectString(targetPieceInstance.pieceInstance._id)])
+
+					// Ensure it was all removed
+					expect(playoutModel.findPieceInstance(targetPieceInstance.pieceInstance._id)).toBeFalsy()
+					expect(service.nextPartState).toEqual(ActionPartChange.SAFE_CHANGE)
+				})
+			})
 		})
 
 		describe('updatePartInstance', () => {