SOFIE-318 | allow returning error from adlib actions in blueprints (WIP)

Author: anteeek

meteor/server/api/rest/v1/playlists.ts

@@ -201,7 +201,7 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 					)
 				)
 
-			return ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
+			const result = await ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
 				this.context.getMethodContext(connection),
 				event,
 				getCurrentTime(),
@@ -220,6 +220,19 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 					actionOptions: adLibOptions,
 				}
 			)
+			if (ClientAPI.isClientResponseError(result)) return result
+			// Check if the action rejected the request
+			if (result.result?.errorMessage) {
+				return ClientAPI.responseError(
+					UserError.from(
+						new Error(result.result.errorMessage),
+						UserErrorMessage.InternalError,
+						undefined,
+						400
+					)
+				)
+			}
+			return ClientAPI.responseSuccess(result.result ?? {})
 		} else {
 			return ClientAPI.responseError(
 				UserError.from(new Error(`No adLib with Id ${adLibId}`), UserErrorMessage.AdlibNotFound, undefined, 412)
@@ -268,7 +281,7 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 			)
 		}
 
-		return ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
+		const result = await ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
 			this.context.getMethodContext(connection),
 			event,
 			getCurrentTime(),
@@ -286,6 +299,14 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 				triggerMode: triggerMode ?? undefined,
 			}
 		)
+		if (ClientAPI.isClientResponseError(result)) return result
+		// Check if the action rejected the request
+		if (result.result?.errorMessage) {
+			return ClientAPI.responseError(
+				UserError.from(new Error(result.result.errorMessage), UserErrorMessage.InternalError, undefined, 400)
+			)
+		}
+		return ClientAPI.responseSuccess(result.result ?? {})
 	}
 	async moveNextPart(
 		connection: Meteor.Connection,
@@ -602,6 +623,7 @@ export function registerRoutes(registerRoute: APIRegisterHook<PlaylistsRestAPI>)
 		'post',
 		'/playlists/:playlistId/execute-adlib',
 		new Map([
+			[400, []],
 			[404, [UserErrorMessage.RundownPlaylistNotFound]],
 			[412, [UserErrorMessage.InactiveRundown, UserErrorMessage.NoCurrentPart, UserErrorMessage.AdlibNotFound]],
 		]),
@@ -638,6 +660,7 @@ export function registerRoutes(registerRoute: APIRegisterHook<PlaylistsRestAPI>)
 		'post',
 		'/playlists/:playlistId/execute-bucket-adlib',
 		new Map([
+			[400, []],
 			[404, [UserErrorMessage.RundownPlaylistNotFound]],
 			[
 				412,

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

@@ -43,6 +43,13 @@ export interface IActionExecutionContext
 	/** Insert a queued part to follow the taken part */
 	queuePartAfterTake(part: IBlueprintPart, pieces: IBlueprintPiece[]): void
 
+	/**
+	 * Reject the action request with an error message.
+	 * This will cause the API to return a 400 error response.
+	 * @param message Error message to return to the client
+	 */
+	rejectRequest(message: string): void
+
 	/** Misc actions */
 	// updateAction(newManifest: Pick<IBlueprintAdLibActionManifest, 'description' | 'payload'>): void // only updates itself. to allow for the next one to do something different
 	// executePeripheralDeviceAction(deviceId: string, functionName: string, args: any[]): Promise<any>

packages/corelib/src/worker/studio.ts

@@ -285,6 +285,8 @@ export interface ExecuteBucketAdLibOrActionProps extends RundownPlayoutPropsBase
 export interface ExecuteActionResult {
 	queuedPartInstanceId?: PartInstanceId
 	taken?: boolean
+	/** If set, the action was rejected - contains the error message */
+	errorMessage?: string
 }
 export interface TakeNextPartProps extends RundownPlayoutPropsBase {
 	fromPartInstanceId: PartInstanceId | null

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

@@ -82,6 +82,11 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 
 	public partToQueueAfterTake: QueueablePartAndPieces | undefined
 
+	/**
+	 * If set, the blueprint has rejected the request with an error message
+	 */
+	public requestError: string | undefined
+
 	public get quickLoopInfo(): BlueprintQuickLookInfo | null {
 		return this.partAndPieceInstanceService.quickLoopInfo
 	}
@@ -280,4 +285,8 @@ export class ActionExecutionContext extends ShowStyleUserContext implements IAct
 	getCurrentTime(): number {
 		return getCurrentTime()
 	}
+
+	rejectRequest(message: string): void {
+		this.requestError = message
+	}
 }

packages/job-worker/src/playout/__tests__/playout-executeAction.test.ts

@@ -200,5 +200,28 @@ describe('Playout API', () => {
 
 			expect(takeNextPartMock).toHaveBeenCalledTimes(0)
 		})
+
+		test('rejectRequest returns error message', async () => {
+			const errorMessage = 'This action is not allowed right now'
+
+			context.updateShowStyleBlueprint({
+				executeAction: async (context) => {
+					context.rejectRequest(errorMessage)
+				},
+			})
+
+			const actionDocId: AdLibActionId = protectString('action-id')
+			const actionId = 'some-action'
+			const userData = { blobby: true }
+			const result = await handleExecuteAdlibAction(context, {
+				playlistId,
+				actionDocId,
+				actionId,
+				userData,
+			})
+
+			expect(result.errorMessage).toBe(errorMessage)
+			expect(result.taken).toBeFalsy()
+		})
 	})
 })

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

@@ -276,6 +276,7 @@ export async function executeActionInner(
 	return {
 		queuedPartInstanceId: actionContext.queuedPartInstanceId,
 		taken: actionContext.takeAfterExecute,
+		errorMessage: actionContext.requestError,
 	}
 }