fix(LSG): expose package status as custom enum

Author: ianshade

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

@@ -30,9 +30,27 @@ $defs:
       packageName:
         description: Name of the package
         type: string
-      statusCode:
-        description: Status code
-        type: number
+      status:
+        type: string
+        enum:
+          - unknown
+          - ok
+          - source_broken
+          - source_has_issues
+          - source_missing
+          - source_not_ready
+          - source_not_set
+          - source_unknown_state
+        description: |
+          Status:
+          * `unknown` - status not determined (yet)
+          * `ok` - no faults, can be played
+          * `source_broken` - the source is present, but should not be played due to a technical malfunction (file is broken, camera robotics failed, REMOTE input is just bars, etc.)
+          * `source_has_issues` - technically it can be played, but some issues with it were detected
+          * `source_missing` - the source (file, live input) is missing and cannot be played
+          * `source_not_ready` - can't be played for a non-technical reason (e.g. a placeholder clip with no content)
+          * `source_not_set` - missing a file path
+          * `source_unknown_state` - reported, but unrecognized state
       rundownId:
         description: Id of the Rundown that a Piece (or AdLib) expecting this package belongs to
         type: string
@@ -51,11 +69,11 @@ $defs:
       previewUrl:
         description: URL where the preview can be accessed
         type: string
-    required: [statusCode, rundownId, pieceOrAdLibId]
+    required: [status, rundownId, pieceOrAdLibId]
     additionalProperties: false
     examples:
       - packageName: 'MV000123.mxf'
-        statusCode: 0
+        status: ok
         rundownId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'
         pieceOrAdLibId: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
         thumbnailUrl: 'https://package-manager.local/package/MV000123.mov_thumbnail.jpg'

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

@@ -1,6 +1,6 @@
 import { protectString, unprotectString } from '@sofie-automation/server-core-integration'
 import { makeMockHandlers, makeMockLogger, makeMockSubscriber } from './utils'
-import { PackagesTopic } from '../packagesTopic'
+import { PackageStatus, PackagesTopic } from '../packagesTopic'
 import { UIPieceContentStatus } from '@sofie-automation/corelib/dist/dataModel/PieceContentStatus'
 import { PieceStatusCode } from '@sofie-automation/corelib/dist/dataModel/Piece'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
@@ -61,7 +61,7 @@ describe('PackagesTopic', () => {
 			packages: [
 				{
 					packageName: 'Test Package',
-					statusCode: PieceStatusCode.OK,
+					status: PackageStatus.OK,
 					pieceId: 'PIECE_0',
 					rundownId: 'RUNDOWN_0',
 					partId: 'PART_0',

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

@@ -6,12 +6,13 @@ import { unprotectString } from '@sofie-automation/shared-lib/dist/lib/protected
 import { UIPieceContentStatus } from '@sofie-automation/corelib/dist/dataModel/PieceContentStatus'
 import { PieceStatusCode } from '@sofie-automation/corelib/dist/dataModel/Piece'
 import { CollectionHandlers } from '../liveStatusServer'
+import { assertNever } from '@sofie-automation/server-core-integration'
 
 const THROTTLE_PERIOD_MS = 200
 
-interface PackageStatus {
+interface Package {
 	packageName?: string
-	statusCode: PieceStatusCode
+	status: PackageStatus
 
 	rundownId: string
 	partId?: string
@@ -23,10 +24,21 @@ interface PackageStatus {
 	previewUrl?: string
 }
 
+export enum PackageStatus {
+	UNKNOWN = 'unknown',
+	OK = 'ok',
+	SOURCE_BROKEN = 'source_broken',
+	SOURCE_HAS_ISSUES = 'source_has_issues',
+	SOURCE_MISSING = 'source_missing',
+	SOURCE_NOT_READY = 'source_not_ready',
+	SOURCE_NOT_SET = 'source_not_set',
+	SOURCE_UNKNOWN_STATE = 'source_unknown_state',
+}
+
 export interface PackagesStatus {
 	event: 'packages'
 	rundownPlaylistId: string | null
-	packages: PackageStatus[]
+	packages: Package[]
 }
 
 const PLAYLIST_KEYS = ['_id', 'activationId'] as const
@@ -50,7 +62,7 @@ export class PackagesTopic extends WebSocketTopicBase implements WebSocketTopic
 			rundownPlaylistId: this._activePlaylist ? unprotectString(this._activePlaylist._id) : null,
 			packages: this._pieceContentStatuses.map((contentStatus) => ({
 				packageName: contentStatus.status.packageName ?? undefined,
-				statusCode: contentStatus.status.status,
+				status: this.toStatusString(contentStatus.status.status),
 				pieceId: unprotectString(contentStatus.pieceId),
 				rundownId: unprotectString(contentStatus.rundownId),
 				partId: unprotectString(contentStatus.partId),
@@ -65,6 +77,30 @@ export class PackagesTopic extends WebSocketTopicBase implements WebSocketTopic
 		}
 	}
 
+	private toStatusString(status: PieceStatusCode): PackageStatus {
+		switch (status) {
+			case PieceStatusCode.UNKNOWN:
+				return PackageStatus.UNKNOWN
+			case PieceStatusCode.OK:
+				return PackageStatus.OK
+			case PieceStatusCode.SOURCE_BROKEN:
+				return PackageStatus.SOURCE_BROKEN
+			case PieceStatusCode.SOURCE_HAS_ISSUES:
+				return PackageStatus.SOURCE_HAS_ISSUES
+			case PieceStatusCode.SOURCE_MISSING:
+				return PackageStatus.SOURCE_MISSING
+			case PieceStatusCode.SOURCE_NOT_READY:
+				return PackageStatus.SOURCE_NOT_READY
+			case PieceStatusCode.SOURCE_NOT_SET:
+				return PackageStatus.SOURCE_NOT_SET
+			case PieceStatusCode.SOURCE_UNKNOWN_STATE:
+				return PackageStatus.SOURCE_UNKNOWN_STATE
+			default:
+				assertNever(status)
+				return PackageStatus.UNKNOWN
+		}
+	}
+
 	private onPlaylistUpdate = (rundownPlaylist: Playlist | undefined): void => {
 		this.logUpdateReceived(
 			'playlist',