feat(EAV-211): add current segment parts to LSG

Author: ianshade

packages/live-status-gateway/api/schemas/activePlaylist.yaml

@@ -124,6 +124,32 @@ $defs:
           - $ref: '#/$defs/piece/examples/0'
         publicData:
           partType: 'intro'
+  currentSegmentPart:
+    type: object
+    properties:
+      id:
+        description: Unique id of the part
+        type: string
+      name:
+        description: User-presentable name of the part
+        type: string
+      autoNext:
+        description: If this part will progress to the next automatically
+        type: boolean
+        default: false
+      timing:
+        type: object
+        properties:
+          expectedDurationMs:
+            description: Expected duration of the part
+            type: number
+    required: [id, name, timing]
+    additionalProperties: false
+    examples:
+      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+        name: 'Intro'
+        timing:
+          expectedDurationMs: 15000
   part:
     oneOf:
       - $ref: '#/$defs/partBase'
@@ -196,7 +222,11 @@ $defs:
               - part_expected_duration
               - segment_budget_duration
         required: [expectedDurationMs, projectedEndTime]
-    required: [id, timing]
+      parts:
+        type: array
+        items:
+          $ref: '#/$defs/currentSegmentPart'
+    required: [id, timing, parts]
     additionalProperties: false
     examples:
       - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
@@ -205,6 +235,8 @@ $defs:
           budgetDurationMs: 20000
           projectedEndTime: 1600000075000
           countdownType: segment_budget_duration
+        parts:
+          - $ref: '#/$defs/currentSegmentPart/examples/0'
   piece:
     type: object
     properties:

packages/live-status-gateway/src/topics/__tests__/activePlaylist.spec.ts

@@ -135,6 +135,16 @@ describe('ActivePlaylistTopic', () => {
 					expectedDurationMs: 10000,
 					projectedEndTime: 1600000070000,
 				},
+				parts: [
+					{
+						id: 'PART_1',
+						name: 'Test Part',
+						timing: {
+							expectedDurationMs: 10000,
+						},
+						autoNext: undefined,
+					},
+				],
 			},
 			rundownIds: unprotectStringArray(playlist.rundownIdsInOrder),
 			publicData: { a: 'b' },
@@ -230,6 +240,16 @@ describe('ActivePlaylistTopic', () => {
 					projectedEndTime: 1600000072300,
 					countdownType: 'segment_budget_duration',
 				},
+				parts: [
+					{
+						id: 'PART_1',
+						name: 'Test Part',
+						timing: {
+							expectedDurationMs: 10000,
+						},
+						autoNext: undefined,
+					},
+				],
 			},
 			rundownIds: unprotectStringArray(playlist.rundownIdsInOrder),
 			publicData: { a: 'b' },

packages/live-status-gateway/src/topics/activePlaylistTopic.ts

@@ -15,6 +15,7 @@ import { CurrentSegmentTiming, calculateCurrentSegmentTiming } from './helpers/s
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
 import _ = require('underscore')
 import { PartTiming, calculateCurrentPartTiming } from './helpers/partTiming'
+import { CurrentSegmentPart, getCurrentSegmentParts } from './helpers/segmentParts'
 import { SelectedPieceInstances, PieceInstanceMin } from '../collections/pieceInstancesHandler'
 import { PieceStatus, toPieceStatus } from './helpers/pieceStatus'
 import { DBSegment } from '@sofie-automation/corelib/dist/dataModel/Segment'
@@ -42,6 +43,7 @@ interface CurrentPartStatus extends PartStatus {
 interface CurrentSegmentStatus {
 	id: string
 	timing: CurrentSegmentTiming
+	parts: CurrentSegmentPart[]
 }
 
 interface ActivePlaylistQuickLoopMarker {
@@ -135,6 +137,8 @@ export class ActivePlaylistTopic extends WebSocketTopicBase implements WebSocket
 
 		const currentPart = this._currentPartInstance ? this._currentPartInstance.part : null
 		const nextPart = this._nextPartInstance ? this._nextPartInstance.part : null
+		const currentSegmentParts =
+			(currentPart && this._partsBySegmentId[unprotectString(currentPart.segmentId)]) ?? []
 
 		const message = this._activePlaylist
 			? literal<ActivePlaylistStatus>({
@@ -169,7 +173,11 @@ export class ActivePlaylistTopic extends WebSocketTopicBase implements WebSocket
 										this._currentPartInstance,
 										this._firstInstanceInSegmentPlayout,
 										this._partInstancesInCurrentSegment,
-										this._partsBySegmentId[unprotectString(currentPart.segmentId)] ?? []
+										currentSegmentParts
+									),
+									parts: getCurrentSegmentParts(
+										this._partInstancesInCurrentSegment,
+										currentSegmentParts
 									),
 							  })
 							: null,

packages/live-status-gateway/src/topics/helpers/segmentParts.ts

@@ -0,0 +1,45 @@
+import { PartInstanceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
+import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
+import { unprotectString } from '@sofie-automation/server-core-integration'
+import _ = require('underscore')
+
+export interface CurrentSegmentPart {
+	id: string
+	name: string
+	autoNext: boolean | undefined
+	timing: {
+		expectedDurationMs?: number
+	}
+}
+
+export function getCurrentSegmentParts(
+	segmentPartInstances: DBPartInstance[],
+	segmentParts: DBPart[]
+): CurrentSegmentPart[] {
+	const partInstancesByPartId: Record<string, { _id: string | PartInstanceId; part: DBPart }> = _.indexBy(
+		segmentPartInstances,
+		(partInstance) => unprotectString(partInstance.part._id)
+	)
+	segmentParts.forEach((part) => {
+		const partId = unprotectString(part._id)
+		if (partInstancesByPartId[partId]) return
+		const partInstance = {
+			_id: partId,
+			part,
+		}
+		partInstancesByPartId[partId] = partInstance
+	})
+	return Object.values<{ _id: string | PartInstanceId; part: DBPart }>(partInstancesByPartId)
+		.sort((a, b) => a.part._rank - b.part._rank)
+		.map(
+			(partInstance): CurrentSegmentPart => ({
+				id: unprotectString(partInstance.part._id),
+				name: partInstance.part.title,
+				autoNext: partInstance.part.autoNext,
+				timing: {
+					expectedDurationMs: partInstance.part.expectedDuration,
+				},
+			})
+		)
+}