Merge pull request Sofie-Automation#1480 from evs-broadcast/feat/persist-infinite-adlibs

jstarpl · web-flow · commit 6b28489db145 · 2025-07-15T11:53:39.000+02:00
diff --git a/meteor/server/api/rest/v1/typeConversion.ts b/meteor/server/api/rest/v1/typeConversion.ts
@@ -384,6 +384,7 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Comple
 		multiGatewayNowSafeLatency: apiStudioSettings.multiGatewayNowSafeLatency,
 		allowRundownResetOnAir: apiStudioSettings.allowRundownResetOnAir,
 		preserveOrphanedSegmentPositionInRundown: apiStudioSettings.preserveOrphanedSegmentPositionInRundown,
+		allowTestingAdlibsToPersist: apiStudioSettings.allowTestingAdlibsToPersist,
 		minimumTakeSpan: apiStudioSettings.minimumTakeSpan ?? DEFAULT_MINIMUM_TAKE_SPAN,
 		enableQuickLoop: apiStudioSettings.enableQuickLoop,
 		forceQuickLoopAutoNext: forceQuickLoopAutoNextFrom(apiStudioSettings.forceQuickLoopAutoNext),
@@ -416,6 +417,7 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APISt
 		fallbackPartDuration: settings.fallbackPartDuration,
 		enableUserEdits: settings.enableUserEdits,
 		allowAdlibTestingSegment: settings.allowAdlibTestingSegment,
+		allowTestingAdlibsToPersist: settings.allowTestingAdlibsToPersist,
 		allowHold: settings.allowHold,
 		allowPieceDirectPlay: settings.allowPieceDirectPlay,
 		enableBuckets: settings.enableBuckets,
diff --git a/meteor/server/lib/rest/v1/studios.ts b/meteor/server/lib/rest/v1/studios.ts
@@ -218,6 +218,7 @@ export interface APIStudioSettings {
 	fallbackPartDuration?: number
 	enableUserEdits?: boolean
 	allowAdlibTestingSegment?: boolean
+	allowTestingAdlibsToPersist?: boolean
 	allowHold?: boolean
 	allowPieceDirectPlay?: boolean
 	enableBuckets?: boolean
diff --git a/packages/corelib/src/playout/__tests__/infinites.test.ts b/packages/corelib/src/playout/__tests__/infinites.test.ts
@@ -35,6 +35,7 @@ describe('Infinites', () => {
 				segment,
 				newInstanceId,
 				true,
+				false,
 				false
 			)
 			return resolvedInstances.map((p) => ({
diff --git a/packages/corelib/src/playout/infinites.ts b/packages/corelib/src/playout/infinites.ts
@@ -103,9 +103,11 @@ export function getPlayheadTrackingInfinitesForPart(
 	intoSegment: ReadonlyDeep<Pick<DBSegment, '_id' | 'orphaned'>>,
 	newInstanceId: PartInstanceId,
 	nextPartIsAfterCurrentPart: boolean,
-	isTemporary: boolean
+	isTemporary: boolean,
+	allowTestingAdlibsToPersist: boolean
 ): PieceInstance[] {
 	if (
+		!allowTestingAdlibsToPersist &&
 		intoSegment._id !== playingSegment._id &&
 		(intoSegment.orphaned === SegmentOrphanedReason.ADLIB_TESTING ||
 			playingSegment.orphaned === SegmentOrphanedReason.ADLIB_TESTING)
@@ -210,7 +212,10 @@ export function getPlayheadTrackingInfinitesForPart(
 							isValid =
 								candidatePiece.rundownId === intoPart.rundownId &&
 								(segmentsToReceiveOnRundownEndFromSet.has(currentPartInstance.segmentId) ||
-									currentPartInstance.segmentId === intoPart.segmentId)
+									currentPartInstance.segmentId === intoPart.segmentId ||
+									// If infinites are allowed to persist, then the infinite is allowed to continue
+									(allowTestingAdlibsToPersist &&
+										intoSegment.orphaned === SegmentOrphanedReason.ADLIB_TESTING))
 							break
 						case PieceLifespan.OutOnShowStyleEnd:
 							isValid = canContinueShowStyleEndInfinites
@@ -380,7 +385,8 @@ export function getPieceInstancesForPart(
 	orderedPartIds: PartId[],
 	newInstanceId: PartInstanceId,
 	nextPartIsAfterCurrentPart: boolean,
-	isTemporary: boolean
+	isTemporary: boolean,
+	allowTestingAdlibsToPersist: boolean
 ): PieceInstance[] {
 	const doesPieceAStartBeforePieceB = (
 		pieceA: ReadonlyDeep<PieceInstancePiece>,
@@ -458,7 +464,8 @@ export function getPieceInstancesForPart(
 					segment,
 					newInstanceId,
 					nextPartIsAfterCurrentPart,
-					isTemporary
+					isTemporary,
+					allowTestingAdlibsToPersist
 				)
 			: []
 
diff --git a/packages/job-worker/src/playout/infinites.ts b/packages/job-worker/src/playout/infinites.ts
@@ -278,7 +278,8 @@ export async function syncPlayheadInfinitesForNextPartInstance(
 			nextSegment?.segment,
 			toPartInstance.partInstance._id,
 			nextPartIsAfterCurrentPart,
-			false
+			false,
+			context.studio.settings.allowTestingAdlibsToPersist ?? false
 		)
 
 		toPartInstance.replaceInfinitesFromPreviousPlayhead(infinites)
@@ -378,7 +379,8 @@ export function getPieceInstancesForPart(
 		playoutModel.getAllOrderedParts().map((p) => p._id),
 		newInstanceId,
 		nextPartIsAfterCurrentPart,
-		false
+		false,
+		context.studio.settings.allowTestingAdlibsToPersist ?? false
 	)
 	if (span) span.end()
 	return res
diff --git a/packages/openapi/api/definitions/studios.yaml b/packages/openapi/api/definitions/studios.yaml
@@ -552,6 +552,9 @@ components:
         allowAdlibTestingSegment:
           type: boolean
           description: Whether to allow adlib testing mode, before a Part is playing in a Playlist
+        allowTestingAdlibsToPersist:
+          type: boolean
+          description: Whether to allow infinite adlib from adlib testing mode to persist in the rundown
         allowHold:
           type: boolean
           description: Whether to allow hold operations for Rundowns in this Studio
diff --git a/packages/shared-lib/src/core/model/StudioSettings.ts b/packages/shared-lib/src/core/model/StudioSettings.ts
@@ -43,6 +43,9 @@ export interface IStudioSettings {
 	/** Preserve unsynced segments position in the rundown, relative to the other segments */
 	preserveOrphanedSegmentPositionInRundown?: boolean
 
+	/** Allow inifite adlibs from adlib testing mode to persist in the rundown */
+	allowTestingAdlibsToPersist?: boolean
+
 	/**
 	 * The minimum amount of time, in milliseconds, that must pass after a take before another take may be performed.
 	 * Default: 1000
diff --git a/packages/webui/src/__mocks__/helpers/database.ts b/packages/webui/src/__mocks__/helpers/database.ts
@@ -26,6 +26,7 @@ import {
 	wrapDefaultObject,
 } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 import { UIShowStyleBase } from '@sofie-automation/meteor-lib/dist/api/showStyles'
+import { UIStudio } from '@sofie-automation/meteor-lib/dist/api/studios'
 import {
 	BlueprintId,
 	OrganizationId,
@@ -561,3 +562,13 @@ export function convertToUIShowStyleBase(showStyleBase: DBShowStyleBase): UIShow
 		outputLayers: applyAndValidateOverrides(showStyleBase.outputLayersWithOverrides).obj,
 	})
 }
+export function convertToUIStudio(studio: DBStudio): UIStudio {
+	return literal<Complete<UIStudio>>({
+		_id: studio._id,
+		settings: applyAndValidateOverrides(studio.settingsWithOverrides).obj,
+		name: studio.name,
+		routeSets: applyAndValidateOverrides(studio.routeSetsWithOverrides).obj,
+		routeSetExclusivityGroups: applyAndValidateOverrides(studio.routeSetExclusivityGroupsWithOverrides).obj,
+		mappings: {},
+	})
+}
diff --git a/packages/webui/src/client/lib/RundownResolver.ts b/packages/webui/src/client/lib/RundownResolver.ts
@@ -108,6 +108,7 @@ const SIMULATION_INVALIDATION = 3000
  * @param {boolean} nextPartIsAfterCurrentPart
  * @param {(PartInstance | undefined)} currentPartInstance
  * @param {(PieceInstance[] | undefined)} currentPartInstancePieceInstances
+ * @param {boolean} allowTestingAdlibsToPersist Studio config parameter to allow infinite adlibs from adlib testing to persist in the rundown
  * @param {FindOptions<PieceInstance>} [options]
  * @param {boolean} [pieceInstanceSimulation] If there are no PieceInstances in the PartInstance, create temporary
  * 		PieceInstances based on the Pieces collection and register a reactive dependancy to recalculate the current
@@ -128,6 +129,7 @@ export function getPieceInstancesForPartInstance(
 	currentPartInstance: PartInstance | undefined,
 	currentSegment: Pick<DBSegment, '_id' | 'orphaned'> | undefined,
 	currentPartInstancePieceInstances: PieceInstance[] | undefined,
+	allowTestingAdlibsToPersist: boolean,
 	/** Map of Pieces on Parts, passed through for performance */
 	allPiecesCache?: Map<PartId, Piece[]>,
 	options?: FindOptions<PieceInstance>,
@@ -162,7 +164,8 @@ export function getPieceInstancesForPartInstance(
 			orderedAllParts,
 			partInstance._id,
 			nextPartIsAfterCurrentPart,
-			partInstance.isTemporary
+			partInstance.isTemporary,
+			allowTestingAdlibsToPersist
 		)
 	} else {
 		const results =
@@ -209,7 +212,8 @@ export function getPieceInstancesForPartInstance(
 				orderedAllParts,
 				partInstance._id,
 				nextPartIsAfterCurrentPart,
-				true
+				true,
+				allowTestingAdlibsToPersist
 			)
 		} else {
 			// otherwise, return results as they are
diff --git a/packages/webui/src/client/lib/__tests__/rundown.test.ts b/packages/webui/src/client/lib/__tests__/rundown.test.ts
@@ -3,6 +3,7 @@ import {
 	DefaultEnvironment,
 	setupDefaultRundownPlaylist,
 	convertToUIShowStyleBase,
+	convertToUIStudio,
 } from '../../../__mocks__/helpers/database.js'
 import { RundownUtils } from '../rundown.js'
 import { Piece } from '@sofie-automation/corelib/dist/dataModel/Piece'
@@ -16,6 +17,7 @@ import { PartInstances, PieceInstances, Pieces, RundownPlaylists } from '../../c
 import { MongoMock } from '../../../__mocks__/mongo.js'
 import { RundownPlaylistCollectionUtil } from '../../collections/rundownPlaylistUtil.js'
 import { RundownPlaylistClientUtil } from '../rundownPlaylistUtil.js'
+import { UIStudio } from '@sofie-automation/meteor-lib/dist/api/studios'
 
 const mockRundownPlaylistsCollection = MongoMock.getInnerMockCollection(RundownPlaylists)
 const mockPartInstancesCollection = MongoMock.getInnerMockCollection(PartInstances)
@@ -36,9 +38,11 @@ jest.mock('../../ui/Collections', () => {
 describe('client/lib/rundown', () => {
 	let env: DefaultEnvironment
 	let playlistId: RundownPlaylistId
+	let studio: UIStudio
 	beforeEach(async () => {
 		env = await setupDefaultStudioEnvironment()
 		playlistId = (await setupDefaultRundownPlaylist(env)).playlistId
+		studio = convertToUIStudio(env.studio)
 	})
 	describe('RundownUtils.getResolvedSegment', () => {
 		test('Basic Segment resolution', () => {
@@ -56,6 +60,7 @@ describe('client/lib/rundown', () => {
 
 			const resolvedSegment = RundownUtils.getResolvedSegment(
 				showStyleBase,
+				studio,
 				playlist,
 				rundown,
 				segment,
@@ -117,6 +122,7 @@ describe('client/lib/rundown', () => {
 
 			const resolvedSegment = RundownUtils.getResolvedSegment(
 				showStyleBase,
+				studio,
 				playlist,
 				rundown,
 				segment,
@@ -202,6 +208,7 @@ describe('client/lib/rundown', () => {
 
 			const resolvedSegment = RundownUtils.getResolvedSegment(
 				showStyleBase,
+				studio,
 				playlist,
 				rundown,
 				segment,
@@ -352,6 +359,7 @@ describe('client/lib/rundown', () => {
 
 			const resolvedSegment = RundownUtils.getResolvedSegment(
 				showStyleBase,
+				studio,
 				playlist,
 				rundown,
 				segment,
diff --git a/packages/webui/src/client/lib/rundown.ts b/packages/webui/src/client/lib/rundown.ts
@@ -43,6 +43,7 @@ import { PartId, PieceId, RundownId, SegmentId, ShowStyleBaseId } from '@sofie-a
 import { PieceInstances, Segments } from '../collections/index.js'
 import { PieceStatusCode } from '@sofie-automation/corelib/dist/dataModel/Piece'
 import { assertNever } from '@sofie-automation/shared-lib/dist/lib/lib'
+import { UIStudio } from '@sofie-automation/meteor-lib/dist/api/studios'
 import { MongoQuery } from '@sofie-automation/corelib/dist/mongo'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 import { RundownPlaylistClientUtil } from './rundownPlaylistUtil.js'
@@ -268,6 +269,7 @@ export namespace RundownUtils {
 	 *
 	 * @export
 	 * @param {ShowStyleBase} showStyleBase
+	 * @param {UIStudio} studio
 	 * @param {DBRundownPlaylist} playlist
 	 * @param {DBSegment} segment
 	 * @param {Set<SegmentId>} segmentsToReceiveOnRundownEndFromSet
@@ -284,6 +286,7 @@ export namespace RundownUtils {
 	 */
 	export function getResolvedSegment(
 		showStyleBase: UIShowStyleBase,
+		studio: UIStudio | undefined,
 		playlist: DBRundownPlaylist,
 		rundown: Pick<Rundown, '_id' | 'showStyleBaseId'>,
 		segment: DBSegment,
@@ -494,6 +497,7 @@ export namespace RundownUtils {
 								pieceInstanceFieldOptions
 							).fetch()
 						: undefined,
+					studio?.settings.allowTestingAdlibsToPersist ?? false,
 					undefined,
 					pieceInstanceFieldOptions,
 					pieceInstanceSimulation
diff --git a/packages/webui/src/client/ui/ClockView/DirectorScreen.tsx b/packages/webui/src/client/ui/ClockView/DirectorScreen.tsx
@@ -100,7 +100,9 @@ function getShowStyleBaseIdSegmentPartUi(
 	segment: SegmentUi | undefined
 	partInstance: PartUi | undefined
 } {
+	let studioId: StudioId | undefined = undefined
 	let showStyleBaseId: ShowStyleBaseId | undefined = undefined
+	let studio: UIStudio | undefined = undefined
 	let showStyleBase: UIShowStyleBase | undefined = undefined
 	let showStyleVariantId: ShowStyleVariantId | undefined = undefined
 	let showStyleVariant: DBShowStyleVariant | undefined = undefined
@@ -116,13 +118,15 @@ function getShowStyleBaseIdSegmentPartUi(
 			timing: 1,
 		},
 	})
+	studioId = currentRundown?.studioId
 	showStyleBaseId = currentRundown?.showStyleBaseId
 	showStyleVariantId = currentRundown?.showStyleVariantId
 
 	const segmentIndex = orderedSegmentsAndParts.segments.findIndex((s) => s._id === partInstance.segmentId)
 	if (currentRundown && segmentIndex >= 0) {
 		const rundownOrder = RundownPlaylistCollectionUtil.getRundownOrderedIDs(playlist)
 		const rundownIndex = rundownOrder.indexOf(partInstance.rundownId)
+		studio = UIStudios.findOne(studioId)
 		showStyleBase = UIShowStyleBases.findOne(showStyleBaseId)
 		showStyleVariant = ShowStyleVariants.findOne(showStyleVariantId)
 
@@ -132,6 +136,7 @@ function getShowStyleBaseIdSegmentPartUi(
 
 			const o = RundownUtils.getResolvedSegment(
 				showStyleBase,
+				studio,
 				playlist,
 				currentRundown,
 				orderedSegmentsAndParts.segments[segmentIndex],
diff --git a/packages/webui/src/client/ui/ClockView/PresenterScreen.tsx b/packages/webui/src/client/ui/ClockView/PresenterScreen.tsx
@@ -91,7 +91,8 @@ function getShowStyleBaseIdSegmentPartUi(
 	},
 	rundownsToShowstyles: Map<RundownId, ShowStyleBaseId>,
 	currentPartInstance: PartInstance | undefined,
-	nextPartInstance: PartInstance | undefined
+	nextPartInstance: PartInstance | undefined,
+	studio: UIStudio | undefined
 ): {
 	showStyleBaseId: ShowStyleBaseId | undefined
 	showStyleBase: UIShowStyleBase | undefined
@@ -132,6 +133,7 @@ function getShowStyleBaseIdSegmentPartUi(
 
 			const o = RundownUtils.getResolvedSegment(
 				showStyleBase,
+				studio,
 				playlist,
 				currentRundown,
 				orderedSegmentsAndParts.segments[segmentIndex],
@@ -238,7 +240,8 @@ export const getPresenterScreenReactive = (
 					orderedSegmentsAndParts,
 					rundownsToShowstyles,
 					currentPartInstance,
-					nextPartInstance
+					nextPartInstance,
+					studio
 				)
 				currentSegment = current.segment
 				currentPartInstanceUi = current.partInstance
@@ -255,7 +258,8 @@ export const getPresenterScreenReactive = (
 					orderedSegmentsAndParts,
 					rundownsToShowstyles,
 					currentPartInstance,
-					nextPartInstance
+					nextPartInstance,
+					studio
 				)
 				nextSegment = next.segment
 				nextPartInstanceUi = next.partInstance
diff --git a/packages/webui/src/client/ui/Prompter/PrompterView.tsx b/packages/webui/src/client/ui/Prompter/PrompterView.tsx
@@ -544,7 +544,11 @@ export class PrompterViewContent extends React.Component<Translated<IProps & ITr
 				) : this.props.rundownPlaylist ? (
 					<>
 						<RundownTimingProvider playlist={this.props.rundownPlaylist}>
-							<Prompter rundownPlaylistId={this.props.rundownPlaylist._id} config={this.configOptions}>
+							<Prompter
+								rundownPlaylistId={this.props.rundownPlaylist._id}
+								config={this.configOptions}
+								allowTestingAdlibsToPersist={this.props.studio?.settings.allowTestingAdlibsToPersist ?? false}
+							>
 								{this.configOptions.showOverUnder && (
 									<OverUnderTimer rundownPlaylist={this.props.rundownPlaylist} style={overUnderStyle} />
 								)}
@@ -633,6 +637,7 @@ export function PrompterView(props: Readonly<IProps>): JSX.Element {
 interface IPrompterProps {
 	rundownPlaylistId: RundownPlaylistId
 	config: PrompterConfig
+	allowTestingAdlibsToPersist: boolean
 }
 interface IPrompterTrackedProps {
 	prompterData: PrompterData | null
@@ -685,7 +690,7 @@ function Prompter(props: Readonly<PropsWithChildren<IPrompterProps>>): JSX.Eleme
 	)
 
 	const nextTrackedProps = useTracker(
-		() => PrompterAPI.getPrompterData(props.rundownPlaylistId),
+		() => PrompterAPI.getPrompterData(props.rundownPlaylistId, props.allowTestingAdlibsToPersist),
 		[props.rundownPlaylistId],
 		null
 	)
diff --git a/packages/webui/src/client/ui/Prompter/prompter.ts b/packages/webui/src/client/ui/Prompter/prompter.ts
@@ -61,7 +61,10 @@ export interface PrompterData {
 
 export namespace PrompterAPI {
 	// TODO: discuss: move this implementation to server-side?
-	export function getPrompterData(playlistId: RundownPlaylistId): PrompterData | null {
+	export function getPrompterData(
+		playlistId: RundownPlaylistId,
+		allowTestingAdlibsToPersist: boolean
+	): PrompterData | null {
 		if (typeof playlistId !== 'string') throw new Error('Expected `playlistId` to be a string')
 
 		const playlist = RundownPlaylists.findOne(playlistId)
@@ -232,6 +235,7 @@ export namespace PrompterAPI {
 					currentPartInstance,
 					currentSegment,
 					currentPartInstancePieceInstances,
+					allowTestingAdlibsToPersist,
 					allPiecesCache,
 					pieceInstanceFieldOptions,
 					true
diff --git a/packages/webui/src/client/ui/SegmentContainer/withResolvedSegment.ts b/packages/webui/src/client/ui/SegmentContainer/withResolvedSegment.ts
@@ -202,6 +202,7 @@ export function withResolvedSegment<T extends IResolvedSegmentProps, IState = {}
 
 			const o = RundownUtils.getResolvedSegment(
 				props.showStyleBase,
+				props.studio,
 				props.playlist,
 				props.rundown,
 				segment,
diff --git a/packages/webui/src/client/ui/Settings/Studio/Generic.tsx b/packages/webui/src/client/ui/Settings/Studio/Generic.tsx
diff --git a/packages/webui/src/client/ui/Shelf/SegmentTimingPanel.tsx b/packages/webui/src/client/ui/Shelf/SegmentTimingPanel.tsx
diff --git a/packages/webui/src/client/ui/Shelf/ShelfDashboardLayout.tsx b/packages/webui/src/client/ui/Shelf/ShelfDashboardLayout.tsx

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ describe('Infinites', () => {`
`35`	`35`	`segment,`
`36`	`36`	`newInstanceId,`
`37`	`37`	`true,`
	`38`	`+ false,`
`38`	`39`	`false`
`39`	`40`	`)`
`40`	`41`	`return resolvedInstances.map((p) => ({`