feat(lsg): add notification support to LSG

Author: justandras

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

@@ -13,17 +13,17 @@ $defs:
         description: Active notifications in Sofie
         type: array
         items:
-          $ref: '#/$defs/DBNotificationObj'
+          $ref: '#/$defs/NotificationObj'
     required: [event, activeNotifications]
     additionalProperties: false
     examples:
       - event: notifications
         activeNotifications:
-          - $ref: '#/$defs/DBNotificationObj/examples/0'
+          - $ref: '#/$defs/NotificationObj/examples/0'
 
-  DBNotificationObj:
+  NotificationObj:
     type: object
-    title: DBNotificationObj
+    title: NotificationObj
     description: This describes a notification that should be shown to a user. These can come from various sources, and are added and removed dynamically during system usage
     required:
       - _id
@@ -41,7 +41,7 @@ $defs:
         type: string
         description: The message of the notification
       relatedTo:
-        $ref: '#/$defs/DBNotificationTarget'
+        $ref: '#/$defs/NotificationTarget'
       created:
         type: integer
         format: int64
@@ -56,7 +56,7 @@ $defs:
         severity: error
         message: 'disk.space.low'
         relatedTo:
-          $ref: '#/$defs/DBNotificationTarget/examples/0'
+          $ref: '#/$defs/NotificationTarget/examples/0'
         created: 1694784932
         modified: 1694784950
 
@@ -71,19 +71,19 @@ $defs:
     examples:
       - info
 
-  DBNotificationTarget:
-    title: DBNotificationTarget
+  NotificationTarget:
+    title: NotificationTarget
     description: Description of what the notification is related to
     oneOf:
-      - $ref: '#/$defs/DBNotificationTargetRundown'
-      - $ref: '#/$defs/DBNotificationTargetRundownPlaylist'
-      - $ref: '#/$defs/DBNotificationTargetPartInstance'
-      - $ref: '#/$defs/DBNotificationTargetPieceInstance'
+      - $ref: '#/$defs/NotificationTargetRundown'
+      - $ref: '#/$defs/NotificationTargetRundownPlaylist'
+      - $ref: '#/$defs/NotificationTargetPartInstance'
+      - $ref: '#/$defs/NotificationTargetPieceInstance'
     examples:
-      - $ref: '#/$defs/DBNotificationTargetRundown/examples/0'
-      - $ref: '#/$defs/DBNotificationTargetRundownPlaylist/examples/0'
-      - $ref: '#/$defs/DBNotificationTargetPartInstance/examples/0'
-      - $ref: '#/$defs/DBNotificationTargetPieceInstance/examples/0'
+      - $ref: '#/$defs/NotificationTargetRundown/examples/0'
+      - $ref: '#/$defs/NotificationTargetRundownPlaylist/examples/0'
+      - $ref: '#/$defs/NotificationTargetPartInstance/examples/0'
+      - $ref: '#/$defs/NotificationTargetPieceInstance/examples/0'
 
   NotificationTargetType:
     type: string
@@ -95,9 +95,9 @@ $defs:
       - partInstance
       - pieceInstance
 
-  DBNotificationTargetRundown:
+  NotificationTargetRundown:
     type: object
-    title: DBNotificationTargetRundown
+    title: NotificationTargetRundown
     required: [type, studioId, rundownId]
     properties:
       type:
@@ -113,9 +113,9 @@ $defs:
         studioId: studio01
         rundownId: rd123
 
-  DBNotificationTargetRundownPlaylist:
+  NotificationTargetRundownPlaylist:
     type: object
-    title: DBNotificationTargetRundownPlaylist
+    title: NotificationTargetRundownPlaylist
     required: [type, studioId, playlistId]
     properties:
       type:
@@ -131,9 +131,9 @@ $defs:
         studioId: studio01
         playlistId: pl456
 
-  DBNotificationTargetPartInstance:
+  NotificationTargetPartInstance:
     type: object
-    title: DBNotificationTargetPartInstance
+    title: NotificationTargetPartInstance
     required: [type, studioId, rundownId, partInstanceId]
     properties:
       type:
@@ -152,9 +152,9 @@ $defs:
         rundownId: rd123
         partInstanceId: pi789
 
-  DBNotificationTargetPieceInstance:
+  NotificationTargetPieceInstance:
     type: object
-    title: DBNotificationTargetPieceInstance
+    title: NotificationTargetPieceInstance
     required: [type, studioId, rundownId, partInstanceId, pieceInstanceId]
     properties:
       type:

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

@@ -153,6 +153,7 @@ $defs:
       - activePieces
       - segments
       - adLibs
+      - notifications
       - buckets
       - packages
   status:

packages/live-status-gateway-api/src/generated/schema.ts

@@ -63,6 +63,7 @@ enum SubscriptionName {
 	ACTIVE_PIECES = 'activePieces',
 	SEGMENTS = 'segments',
 	AD_LIBS = 'adLibs',
+	NOTIFICATIONS = 'notifications',
 	BUCKETS = 'buckets',
 	RESERVED_PACKAGES = 'packages',
 }
@@ -828,13 +829,13 @@ interface NotificationsEvent {
 	/**
 	 * Active notifications in Sofie
 	 */
-	activeNotifications: DbNotificationObj[]
+	activeNotifications: NotificationObj[]
 }
 
 /**
  * This describes a notification that should be shown to a user. These can come from various sources, and are added and removed dynamically during system usage
  */
-interface DbNotificationObj {
+interface NotificationObj {
 	/**
 	 * Unique identifier for the notification
 	 */
@@ -851,10 +852,10 @@ interface DbNotificationObj {
 	 * Description of what the notification is related to
 	 */
 	relatedTo:
-		| DbNotificationTargetRundown
-		| DbNotificationTargetRundownPlaylist
-		| DbNotificationTargetPartInstance
-		| DbNotificationTargetPieceInstance
+		| NotificationTargetRundown
+		| NotificationTargetRundownPlaylist
+		| NotificationTargetPartInstance
+		| NotificationTargetPieceInstance
 	/**
 	 * Unix timestamp of creation
 	 */
@@ -874,7 +875,7 @@ enum NotificationSeverity {
 	INFO = 'info',
 }
 
-interface DbNotificationTargetRundown {
+interface NotificationTargetRundown {
 	/**
 	 * Possible NotificationTarget types
 	 */
@@ -893,7 +894,7 @@ enum NotificationTargetType {
 	PIECE_INSTANCE = 'pieceInstance',
 }
 
-interface DbNotificationTargetRundownPlaylist {
+interface NotificationTargetRundownPlaylist {
 	/**
 	 * Possible NotificationTarget types
 	 */
@@ -902,7 +903,7 @@ interface DbNotificationTargetRundownPlaylist {
 	playlistId: string
 }
 
-interface DbNotificationTargetPartInstance {
+interface NotificationTargetPartInstance {
 	/**
 	 * Possible NotificationTarget types
 	 */
@@ -912,7 +913,7 @@ interface DbNotificationTargetPartInstance {
 	partInstanceId: string
 }
 
-interface DbNotificationTargetPieceInstance {
+interface NotificationTargetPieceInstance {
 	/**
 	 * Possible NotificationTarget types
 	 */
@@ -968,11 +969,11 @@ export {
 	BucketStatus,
 	BucketAdLibStatus,
 	NotificationsEvent,
-	DbNotificationObj,
+	NotificationObj,
 	NotificationSeverity,
-	DbNotificationTargetRundown,
+	NotificationTargetRundown,
 	NotificationTargetType,
-	DbNotificationTargetRundownPlaylist,
-	DbNotificationTargetPartInstance,
-	DbNotificationTargetPieceInstance,
+	NotificationTargetRundownPlaylist,
+	NotificationTargetPartInstance,
+	NotificationTargetPieceInstance,
 }

packages/live-status-gateway/src/collections/notifications/notificationsHandler.ts

@@ -0,0 +1,101 @@
+import { CollectionName } from '@sofie-automation/corelib/dist/dataModel/Collections'
+import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
+import { Logger } from 'winston'
+import { CoreHandler } from '../../coreHandler.js'
+import { CollectionHandlers } from '../../liveStatusServer.js'
+import { PublicationCollection } from '../../publicationCollection.js'
+import { DBNotificationObj } from '@sofie-automation/corelib/dist/dataModel/Notifications'
+import { PlaylistNotificationsHandler } from './playlistNotificationsHandler.js'
+import { RundownNotificationsHandler } from './rundownNotificationsHandler.js'
+import _ from 'underscore'
+import { unprotectString } from '@sofie-automation/server-core-integration'
+
+const THROTTLE_PERIOD_MS = 100
+
+/**
+ * NotificationsHandler
+ * Combines playlist-level and rundown-level notifications into a single collection
+ *
+ * This handler listens to the two lower-level handlers (playlist & rundown notifications)
+ * and merges their collection contents on change.
+ */
+export class NotificationsHandler extends PublicationCollection<
+	DBNotificationObj[],
+	CorelibPubSub.notificationsForRundownPlaylist | CorelibPubSub.notificationsForRundown,
+	CollectionName.Notifications
+> {
+	private throttledNotify: (data: DBNotificationObj[]) => void
+
+	private _playlistNotificationsHandler?: PlaylistNotificationsHandler
+	private _rundownNotificationsHandler?: RundownNotificationsHandler
+
+	constructor(logger: Logger, coreHandler: CoreHandler) {
+		super(CollectionName.Notifications, CorelibPubSub.notificationsForRundownPlaylist, logger, coreHandler)
+
+		this.throttledNotify = _.throttle(this.notify.bind(this), THROTTLE_PERIOD_MS, {
+			leading: false,
+			trailing: true,
+		})
+	}
+
+	init(handlers: CollectionHandlers): void {
+		super.init(handlers)
+
+		this._playlistNotificationsHandler =
+			handlers.playlistNotificationsHandler as unknown as PlaylistNotificationsHandler
+		this._rundownNotificationsHandler =
+			handlers.rundownNotificationsHandler as unknown as RundownNotificationsHandler
+
+		if (this._playlistNotificationsHandler) {
+			this._playlistNotificationsHandler.subscribe(this.onSourceUpdated)
+		}
+		if (this._rundownNotificationsHandler) {
+			this._rundownNotificationsHandler.subscribe(this.onSourceUpdated)
+		}
+	}
+
+	protected changed(): void {
+		this.updateAndNotify()
+	}
+
+	private onSourceUpdated = (): void => {
+		this.changed()
+	}
+
+	private updateCollectionData(): boolean {
+		const merged = new Map<string, DBNotificationObj>()
+
+		// Pull data from the playlist notifications handler's collection
+		if (this._playlistNotificationsHandler) {
+			const playlistDocs = this._playlistNotificationsHandler.getPublishedDocs()
+			for (const d of playlistDocs) {
+				if (d._id && !merged.has(unprotectString(d._id))) {
+					merged.set(unprotectString(d._id), d)
+				}
+			}
+		}
+
+		// Pull data from the rundown notifications handler's collection
+		if (this._rundownNotificationsHandler) {
+			const rundownDocs = this._rundownNotificationsHandler.getPublishedDocs()
+			for (const d of rundownDocs) {
+				if (d._id && !merged.has(unprotectString(d._id))) {
+					merged.set(unprotectString(d._id), d)
+				}
+			}
+		}
+
+		const newNotifications = Array.from(merged.values())
+
+		const hasAnythingChanged = !_.isEqual(this._collectionData, newNotifications)
+		if (hasAnythingChanged) {
+			this._collectionData = newNotifications
+		}
+
+		return hasAnythingChanged
+	}
+
+	private updateAndNotify() {
+		if (this.updateCollectionData()) this.throttledNotify(this._collectionData ?? [])
+	}
+}