SOF-1912 Update AdLib Rank with SegmentRank

src/tv2-common/actions/executeAction.ts

@@ -1908,7 +1908,8 @@ async function executeActionSelectFull<
 		partId: externalId,
 		parsedCue: cue,
 		segmentExternalId: userData.segmentExternalId,
-		adlib: { rank: 0 }
+		adlib: { rank: 0 },
+		rank: 0
 	})
 
 	const fullPiece = generator.createPiece()

src/tv2-common/evaluateCues.ts

@@ -37,6 +37,8 @@ import {
 	GraphicIsPilot
 } from './inewsConversion'
 
+const PART_RANK_FRACTION_FACTOR: number = 1000
+
 export interface Adlib {
 	rank: number
 }
@@ -59,6 +61,7 @@ export interface EvaluateCuesShowstyleOptions {
 		partId: string,
 		parsedCue: CueDefinitionGraphic<GraphicInternalOrPilot>,
 		partDefinition: PartDefinition,
+		rank: number,
 		adlib?: Adlib
 	) => EvaluateCueResult
 	EvaluateCueBackgroundLoop?: (
@@ -192,13 +195,13 @@ export async function EvaluateCuesBase(
 	partDefinition: PartDefinition,
 	options: EvaluateCuesOptions
 ) {
-	let adLibRank = 0
+	let adLibRank = 1
 	const result = new EvaluateCueResult()
 
 	for (const cue of cues) {
 		if (cue && !SkipCue(cue, options.selectedCueTypes, options.excludeAdlibs, options.adlibsOnly)) {
 			const shouldAdlib = !!(options.adlib || cue.adlib)
-			const adlib = shouldAdlib ? { rank: adLibRank } : undefined
+			const adlib = shouldAdlib ? { rank: getRankForPartDefinition(adLibRank, partDefinition) } : undefined
 
 			switch (cue.type) {
 				case CueType.Graphic:
@@ -213,7 +216,14 @@ export async function EvaluateCuesBase(
 							break
 						}
 						result.push(
-							showStyleOptions.EvaluateCueGraphic(context, partDefinition.externalId, cue, partDefinition, adlib)
+							showStyleOptions.EvaluateCueGraphic(
+								context,
+								partDefinition.externalId,
+								cue,
+								partDefinition,
+								getRankForPartDefinition(adLibRank, partDefinition),
+								adlib
+							)
 						)
 					}
 					break
@@ -227,17 +237,33 @@ export async function EvaluateCuesBase(
 								cue,
 								partDefinition,
 								shouldAdlib,
-								adLibRank
+								getRankForPartDefinition(adLibRank, partDefinition)
 							)
 						)
 					}
 					break
 				case CueType.DVE:
 					if (showStyleOptions.EvaluateCueDVE) {
-						showStyleOptions.EvaluateCueDVE(context, pieces, actions, partDefinition, cue, shouldAdlib, adLibRank)
+						showStyleOptions.EvaluateCueDVE(
+							context,
+							pieces,
+							actions,
+							partDefinition,
+							cue,
+							shouldAdlib,
+							getRankForPartDefinition(adLibRank, partDefinition)
+						)
 						// Always make an adlib for DVEs
 						if (!shouldAdlib) {
-							showStyleOptions.EvaluateCueDVE(context, pieces, actions, partDefinition, cue, true, adLibRank)
+							showStyleOptions.EvaluateCueDVE(
+								context,
+								pieces,
+								actions,
+								partDefinition,
+								cue,
+								true,
+								getRankForPartDefinition(adLibRank, partDefinition)
+							)
 						}
 					}
 					break
@@ -249,7 +275,7 @@ export async function EvaluateCuesBase(
 							mediaSubscriptions,
 							cue,
 							partDefinition,
-							adLibRank
+							getRankForPartDefinition(adLibRank, partDefinition)
 						)
 					}
 					break
@@ -262,7 +288,15 @@ export async function EvaluateCuesBase(
 					break
 				case CueType.Jingle:
 					if (showStyleOptions.EvaluateCueJingle) {
-						showStyleOptions.EvaluateCueJingle(context, pieces, actions, cue, partDefinition, shouldAdlib, adLibRank)
+						showStyleOptions.EvaluateCueJingle(
+							context,
+							pieces,
+							actions,
+							cue,
+							partDefinition,
+							shouldAdlib,
+							getRankForPartDefinition(adLibRank, partDefinition)
+						)
 					}
 					break
 				case CueType.LYD:
@@ -275,14 +309,20 @@ export async function EvaluateCuesBase(
 							cue,
 							partDefinition,
 							shouldAdlib,
-							adLibRank
+							getRankForPartDefinition(adLibRank, partDefinition)
 						)
 					}
 					break
 				case CueType.GraphicDesign:
 					if (showStyleOptions.EvaluateCueGraphicDesign) {
 						result.push(
-							showStyleOptions.EvaluateCueGraphicDesign(context, partDefinition.externalId, cue, shouldAdlib, adLibRank)
+							showStyleOptions.EvaluateCueGraphicDesign(
+								context,
+								partDefinition.externalId,
+								cue,
+								shouldAdlib,
+								getRankForPartDefinition(adLibRank, partDefinition)
+							)
 						)
 					}
 					break
@@ -312,7 +352,7 @@ export async function EvaluateCuesBase(
 								partDefinition.externalId,
 								cue,
 								shouldAdlib,
-								adLibRank
+								getRankForPartDefinition(adLibRank, partDefinition)
 							)
 						)
 					}
@@ -401,6 +441,10 @@ export async function EvaluateCuesBase(
 	})
 }
 
+function getRankForPartDefinition(rank: number, partDefinition: PartDefinition): number {
+	return partDefinition.segmentRank + rank / PART_RANK_FRACTION_FACTOR
+}
+
 export function SkipCue(
 	cue: CueDefinition,
 	selectedCueTypes?: CueType[] | undefined,

src/tv2-common/get-next-part-cue.spec.ts

@@ -27,6 +27,7 @@ const SOURCE_DEFINITION_KAM_2: SourceDefinitionKam = {
 const partDefinitionTest1: PartDefinitionKam = {
 	type: PartType.Kam,
 	externalId: 'test-part',
+	segmentRank: 1,
 	rawType: 'KAM 1',
 	sourceDefinition: SOURCE_DEFINITION_KAM_1,
 	fields: {},
@@ -169,6 +170,7 @@ const partDefinitionTest1: PartDefinitionKam = {
 const partDefinitionTest2: PartDefinitionKam = {
 	type: PartType.Kam,
 	externalId: 'test-part',
+	segmentRank: 1,
 	rawType: 'KAM 1',
 	sourceDefinition: SOURCE_DEFINITION_KAM_1,
 	fields: {},

src/tv2-common/getSegment.ts

@@ -123,6 +123,7 @@ export async function getSegmentBase<ShowStyleConfig extends TV2ShowStyleConfig>
 		config,
 		ingestSegment.externalId,
 		ingestSegment.name,
+		ingestSegment.rank,
 		iNewsStory.body,
 		iNewsStory.cues,
 		iNewsStory.fields,

src/tv2-common/helpers/graphics/caspar/__tests__/htmlPilotGraphicGenerator.spec.ts

@@ -13,7 +13,8 @@ function makeGenerator(cue: CueDefinitionGraphic<GraphicPilot>) {
 		context,
 		partId: 'part01',
 		parsedCue: cue,
-		segmentExternalId: ''
+		segmentExternalId: '',
+		rank: 0
 	})
 	return generator
 }

src/tv2-common/helpers/graphics/internal/InternalGraphic.ts

@@ -47,6 +47,7 @@ export abstract class InternalGraphic extends Graphic {
 		this.outputLayerId = IsTargetingWall(this.engine) ? SharedOutputLayer.SEC : SharedOutputLayer.OVERLAY
 		this.partId = graphicProps.partId
 		this.content = this.getContent()
+		this.rank = graphicProps.rank
 	}
 
 	public createCommentatorAdlib(): IBlueprintAdLibPiece<PieceMetaData> {
@@ -145,4 +146,5 @@ export interface InternalGraphicProps {
 	parsedCue: CueDefinitionGraphic<GraphicInternal>
 	partId?: string
 	partDefinition?: PartDefinition
+	rank: number
 }

src/tv2-common/helpers/graphics/internal/create.ts

@@ -17,7 +17,13 @@ export function CreateInternalGraphic(
 	adlib?: Adlib
 ): EvaluateCueResult {
 	const result = new EvaluateCueResult()
-	const internalGraphic = InternalGraphic.createInternalGraphicGenerator({ context, parsedCue, partId, partDefinition })
+	const internalGraphic = InternalGraphic.createInternalGraphicGenerator({
+		context,
+		parsedCue,
+		partId,
+		partDefinition,
+		rank: adlib?.rank ?? 0
+	})
 
 	if (!internalGraphic.templateName || !internalGraphic.templateName.length) {
 		context.core.notifyUserWarning(`No valid template found for ${parsedCue.graphic.template}`)

src/tv2-common/helpers/graphics/pilot/PilotGraphicGenerator.ts

@@ -45,6 +45,7 @@ export interface PilotGraphicProps {
 	partId: string
 	parsedCue: CueDefinitionGraphic<GraphicPilot>
 	adlib?: Adlib
+	rank: number
 	segmentExternalId: string
 }
 
@@ -61,6 +62,7 @@ export abstract class PilotGraphicGenerator extends Graphic {
 	protected readonly partId: string
 	protected readonly cue: CueDefinitionGraphic<GraphicPilot>
 	protected readonly adlib?: Adlib
+	protected readonly rank: number
 	protected readonly segmentExternalId: string
 
 	protected constructor(graphicProps: PilotGraphicProps) {
@@ -71,6 +73,7 @@ export abstract class PilotGraphicGenerator extends Graphic {
 		this.cue = graphicProps.parsedCue
 		this.partId = graphicProps.partId
 		this.adlib = graphicProps.adlib
+		this.rank = graphicProps.rank
 		this.segmentExternalId = graphicProps.segmentExternalId
 	}
 
@@ -88,12 +91,12 @@ export abstract class PilotGraphicGenerator extends Graphic {
 			segmentExternalId: this.segmentExternalId
 		}
 		return {
-			externalId: generateExternalId(this.core, userData),
+			externalId: `${this.segmentExternalId}_${generateExternalId(this.core, userData)}`,
 			actionId: AdlibActionType.SELECT_FULL_GRAFIK,
 			userData,
 			userDataManifest: {},
 			display: {
-				_rank: (this.adlib && this.adlib.rank) || 0,
+				_rank: (this.adlib && this.adlib.rank) || this.rank,
 				label: t(this.getTemplateName()),
 				sourceLayerId: SharedSourceLayer.PgmPilot,
 				outputLayerId: SharedOutputLayer.PGM,
@@ -142,7 +145,7 @@ export abstract class PilotGraphicGenerator extends Graphic {
 		pilotPiece.tags = [...(pilotPiece.tags ?? []), AdlibTags.ADLIB_FLOW_PRODUCER, AdlibTags.ADLIB_KOMMENTATOR]
 		return {
 			...pilotPiece,
-			_rank: rank ?? 0
+			_rank: rank ?? this.rank
 		}
 	}
 

src/tv2-common/helpers/graphics/pilot/create.ts

@@ -17,7 +17,7 @@ export function CreatePilotGraphic(pilotGraphicProps: PilotGraphicProps): Evalua
 	const generator = PilotGraphicGenerator.createPilotGraphicGenerator(pilotGraphicProps)
 
 	if (IsTargetingOVL(parsedCue.target) && adlib) {
-		result.adlibPieces.push(generator.createAdlibPiece())
+		result.adlibPieces.push(generator.createAdlibPiece(adlib.rank))
 	} else {
 		result.pieces.push(generator.createPiece())
 	}