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

Author: Julusian

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

@@ -95,7 +95,15 @@ export class PartAndPieceInstanceActionService {
 		this.showStyleCompound = showStyle
 	}
 
-	private _getPartInstance(part: 'current' | 'next'): PlayoutPartInstanceModel | null {
+	#trackStateChange(part: 'current' | 'next', change: ActionPartChange): void {
+		if (part === 'current') {
+			this.currentPartState = Math.max(this.currentPartState, change)
+		} else {
+			this.nextPartState = Math.max(this.nextPartState, change)
+		}
+	}
+
+	#getPartInstance(part: 'current' | 'next'): PlayoutPartInstanceModel | null {
 		switch (part) {
 			case 'current':
 				return this._playoutModel.currentPartInstance
@@ -109,16 +117,16 @@ export class PartAndPieceInstanceActionService {
 	}
 
 	async getPartInstance(part: 'current' | 'next'): Promise<IBlueprintPartInstance | undefined> {
-		const partInstance = this._getPartInstance(part)
+		const partInstance = this.#getPartInstance(part)
 
 		return partInstance ? convertPartInstanceToBlueprints(partInstance.partInstance) : undefined
 	}
 	async getPieceInstances(part: 'current' | 'next'): Promise<IBlueprintPieceInstance[]> {
-		const partInstance = this._getPartInstance(part)
+		const partInstance = this.#getPartInstance(part)
 		return partInstance?.pieceInstances?.map((p) => convertPieceInstanceToBlueprints(p.pieceInstance)) ?? []
 	}
 	async getResolvedPieceInstances(part: 'current' | 'next'): Promise<IBlueprintResolvedPieceInstance[]> {
-		const partInstance = this._getPartInstance(part)
+		const partInstance = this.#getPartInstance(part)
 		if (!partInstance) {
 			return []
 		}
@@ -244,7 +252,7 @@ export class PartAndPieceInstanceActionService {
 	}
 
 	async insertPiece(part: 'current' | 'next', rawPiece: IBlueprintPiece): Promise<IBlueprintPieceInstance> {
-		const partInstance = this._getPartInstance(part)
+		const partInstance = this.#getPartInstance(part)
 		if (!partInstance) {
 			throw new Error('Cannot insert piece when no active part')
 		}
@@ -270,11 +278,7 @@ export class PartAndPieceInstanceActionService {
 		// Do the work
 		const newPieceInstance = partInstance.insertAdlibbedPiece(piece, undefined)
 
-		if (part === 'current') {
-			this.currentPartState = Math.max(this.currentPartState, ActionPartChange.SAFE_CHANGE)
-		} else {
-			this.nextPartState = Math.max(this.nextPartState, ActionPartChange.SAFE_CHANGE)
-		}
+		this.#trackStateChange(part, ActionPartChange.SAFE_CHANGE)
 
 		return convertPieceInstanceToBlueprints(newPieceInstance.pieceInstance)
 	}
@@ -330,8 +334,8 @@ export class PartAndPieceInstanceActionService {
 
 		// setupPieceInstanceInfiniteProperties(pieceInstance)
 
-		this.nextPartState = Math.max(this.nextPartState, updatesNextPart)
-		this.currentPartState = Math.max(this.currentPartState, updatesCurrentPart)
+		this.#trackStateChange('next', updatesNextPart)
+		this.#trackStateChange('current', updatesCurrentPart)
 
 		return convertPieceInstanceToBlueprints(pieceInstance.pieceInstance)
 	}
@@ -340,7 +344,7 @@ export class PartAndPieceInstanceActionService {
 		part: 'current' | 'next',
 		props: Partial<IBlueprintMutatablePart>
 	): Promise<IBlueprintPartInstance> {
-		const partInstance = this._getPartInstance(part)
+		const partInstance = this.#getPartInstance(part)
 		if (!partInstance) {
 			throw new Error('PartInstance could not be found')
 		}
@@ -351,14 +355,7 @@ export class PartAndPieceInstanceActionService {
 			throw new Error('Some valid properties must be defined')
 		}
 
-		this.nextPartState = Math.max(
-			this.nextPartState,
-			part === 'next' ? ActionPartChange.SAFE_CHANGE : ActionPartChange.NONE
-		)
-		this.currentPartState = Math.max(
-			this.currentPartState,
-			part === 'current' ? ActionPartChange.SAFE_CHANGE : ActionPartChange.NONE
-		)
+		this.#trackStateChange(part, ActionPartChange.SAFE_CHANGE)
 
 		return convertPartInstanceToBlueprints(partInstance.partInstance)
 	}
@@ -451,7 +448,7 @@ export class PartAndPieceInstanceActionService {
 	}
 
 	async removePieceInstances(part: 'current' | 'next', pieceInstanceIds: string[]): Promise<string[]> {
-		const partInstance = this._getPartInstance(part)
+		const partInstance = this.#getPartInstance(part)
 		if (!partInstance) {
 			throw new Error('Cannot remove pieceInstances when no selected partInstance')
 		}
@@ -466,7 +463,7 @@ export class PartAndPieceInstanceActionService {
 			}
 		}
 
-		this.nextPartState = Math.max(this.nextPartState, ActionPartChange.SAFE_CHANGE)
+		this.#trackStateChange(part, ActionPartChange.SAFE_CHANGE)
 
 		return unprotectStringArray(removedPieceInstanceIds)
 	}
@@ -505,7 +502,7 @@ export class PartAndPieceInstanceActionService {
 		)
 
 		if (stoppedIds.length > 0) {
-			this.currentPartState = Math.max(this.currentPartState, ActionPartChange.SAFE_CHANGE)
+			this.#trackStateChange('current', ActionPartChange.SAFE_CHANGE)
 		}
 
 		return unprotectStringArray(stoppedIds)

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

@@ -1666,7 +1666,7 @@ describe('Test blueprint api context', () => {
 
 					// Ensure it was all removed
 					expect(playoutModel.findPieceInstance(targetPieceInstance.pieceInstance._id)).toBeFalsy()
-					expect(service.nextPartState).toEqual(ActionPartChange.SAFE_CHANGE)
+					expect(service.currentPartState).toEqual(ActionPartChange.SAFE_CHANGE)
 				})
 			})
 		})