wip: remove old flow and add some todos to new flow

Author: Julusian

packages/corelib/src/dataModel/Rundown.ts

@@ -57,9 +57,6 @@ export interface Rundown {
 	 */
 	orphaned?: RundownOrphanedReason
 
-	/** Last sent storyStatus to ingestDevice (MOS) */
-	notifiedCurrentPlayingPartExternalId?: string
-
 	/** Holds notes (warnings / errors) thrown by the blueprints during creation */
 	notes?: Array<RundownNote>
 

packages/corelib/src/worker/events.ts

@@ -3,7 +3,6 @@ import { PartInstanceId, RundownId, RundownPlaylistId, StudioId } from '../dataM
 export enum EventsJobs {
 	PartInstanceTimings = 'partInstanceTimings',
 	RundownDataChanged = 'rundownDataChanged',
-	NotifyCurrentlyPlayingPart = 'notifyCurrentlyPlayingPart',
 }
 
 export interface PartInstanceTimingsProps {
@@ -16,20 +15,13 @@ export interface RundownDataChangedProps {
 	rundownId: RundownId
 }
 
-export interface NotifyCurrentlyPlayingPartProps {
-	rundownId: RundownId
-	isRehearsal: boolean
-	partExternalId: string | null
-}
-
 /**
  * Set of valid functions, of form:
  * `id: (data) => return`
  */
 export type EventsJobFunc = {
 	[EventsJobs.PartInstanceTimings]: (data: PartInstanceTimingsProps) => void
 	[EventsJobs.RundownDataChanged]: (data: RundownDataChangedProps) => void
-	[EventsJobs.NotifyCurrentlyPlayingPart]: (data: NotifyCurrentlyPlayingPartProps) => void
 }
 
 export function getEventsQueueName(id: StudioId): string {

packages/job-worker/src/events/handle.ts

@@ -1,8 +1,4 @@
-import {
-	NotifyCurrentlyPlayingPartProps,
-	PartInstanceTimingsProps,
-	RundownDataChangedProps,
-} from '@sofie-automation/corelib/dist/worker/events'
+import { PartInstanceTimingsProps, RundownDataChangedProps } from '@sofie-automation/corelib/dist/worker/events'
 import { getCurrentTime } from '../lib'
 import { JobContext } from '../jobs'
 import { logger } from '../logging'
@@ -17,16 +13,7 @@ import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyE
 import { ExternalMessageQueueObj } from '@sofie-automation/corelib/dist/dataModel/ExternalMessageQueue'
 import { ICollection, MongoModifier } from '../db'
 import { DBRundownPlaylist } from '@sofie-automation/corelib/dist/dataModel/RundownPlaylist'
-import { ExternalMessageQueueObjId, PeripheralDeviceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
-import { runWithRundownLock } from '../ingest/lock'
-import {
-	PeripheralDevice,
-	PeripheralDeviceCategory,
-	PeripheralDeviceType,
-} from '@sofie-automation/corelib/dist/dataModel/PeripheralDevice'
-import { MOS } from '@sofie-automation/corelib'
-import { executePeripheralDeviceFunction } from '../peripheralDevice'
-import { DEFAULT_MOS_TIMEOUT_TIME } from '@sofie-automation/shared-lib/dist/core/constants'
+import { ExternalMessageQueueObjId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 
 async function getBlueprintAndDependencies(context: JobContext, rundown: ReadonlyDeep<DBRundown>) {
 	const pShowStyle = context.getShowStyleCompound(rundown.showStyleVariantId, rundown.showStyleBaseId)
@@ -226,121 +213,3 @@ export async function handleRundownDataHasChanged(context: JobContext, data: Run
 		logger.error(`Error in showStyleBlueprint.onRundownDataChangedEvent: ${stringifyError(err)}`)
 	}
 }
-
-export async function handleNotifyCurrentlyPlayingPart(
-	context: JobContext,
-	data: NotifyCurrentlyPlayingPartProps
-): Promise<void> {
-	const rundown = await context.directCollections.Rundowns.findOne(data.rundownId)
-	if (!rundown) {
-		logger.warn(`Rundown "${data.rundownId} is missing. Skipping notifyCurrentPlayingPart`)
-		return
-	}
-
-	if (rundown.source.type !== 'nrcs') {
-		logger.warn(`Rundown "${rundown._id} has no peripheralDevice. Skipping notifyCurrentPlayingPart`)
-		return
-	}
-
-	const device = await context.directCollections.PeripheralDevices.findOne({
-		_id: rundown.source.peripheralDeviceId,
-		// Future: we really should be constraining this to the studio, but that is often only defined on the parent of this device
-		// studioId: context.studioId,
-		parentDeviceId: { $exists: true },
-	})
-	if (!device || !device.parentDeviceId) {
-		logger.warn(
-			`PeripheralDevice "${rundown.source.peripheralDeviceId}" for Rundown "${rundown._id} not found. Skipping notifyCurrentPlayingPart`
-		)
-		return
-	}
-	const parentDevice = await context.directCollections.PeripheralDevices.findOne({
-		_id: device.parentDeviceId,
-		studioId: context.studioId,
-		parentDeviceId: { $exists: false },
-	})
-	if (!parentDevice) {
-		logger.warn(
-			`PeripheralDevice "${rundown.source.peripheralDeviceId}" for Rundown "${rundown._id} not found. Skipping notifyCurrentPlayingPart`
-		)
-		return
-	}
-
-	const previousPlayingPartExternalId: string | null = rundown.notifiedCurrentPlayingPartExternalId || null
-	const currentPlayingPartExternalId: string | null = data.isRehearsal ? null : data.partExternalId
-
-	// Lock the rundown so that we are allowed to write to it
-	// This is technically a bit of a race condition, but is really low risk and low impact if it does
-	await runWithRundownLock(context, rundown._id, async (rundown0) => {
-		if (!rundown0) return
-
-		await context.directCollections.Rundowns.update(
-			rundown._id,
-			currentPlayingPartExternalId
-				? {
-						$set: {
-							notifiedCurrentPlayingPartExternalId: currentPlayingPartExternalId,
-						},
-				  }
-				: {
-						$unset: {
-							notifiedCurrentPlayingPartExternalId: 1,
-						},
-				  }
-		)
-	})
-
-	// TODO: refactor this to be non-mos centric
-	if (device.category === PeripheralDeviceCategory.INGEST && device.type === PeripheralDeviceType.MOS) {
-		// Note: rundown may not be up to date anymore
-		await notifyCurrentPlayingPartMOS(
-			context,
-			device,
-			rundown.externalId,
-			previousPlayingPartExternalId,
-			currentPlayingPartExternalId
-		)
-	}
-}
-
-async function notifyCurrentPlayingPartMOS(
-	context: JobContext,
-	peripheralDevice: PeripheralDevice,
-	rundownExternalId: string,
-	oldPlayingPartExternalId: string | null,
-	newPlayingPartExternalId: string | null
-): Promise<void> {
-	if (oldPlayingPartExternalId !== newPlayingPartExternalId) {
-		// New implementation 2022 only sends PLAY, never stop, after getting advice from AP
-		// Reason 1: NRK ENPS "sendt tid" (elapsed time) stopped working in ENPS 8/9 when doing STOP prior to PLAY
-		// Reason 2: there's a delay between the STOP (yellow line disappears) and PLAY (yellow line re-appears), which annoys the users
-		if (newPlayingPartExternalId) {
-			try {
-				await setStoryStatusMOS(
-					context,
-					peripheralDevice._id,
-					rundownExternalId,
-					newPlayingPartExternalId,
-					MOS.IMOSObjectStatus.PLAY
-				)
-			} catch (error) {
-				logger.error(`Error in setStoryStatus PLAY: ${stringifyError(error)}`)
-			}
-		}
-	}
-}
-
-async function setStoryStatusMOS(
-	context: JobContext,
-	deviceId: PeripheralDeviceId,
-	rundownExternalId: string,
-	storyId: string,
-	status: MOS.IMOSObjectStatus
-): Promise<void> {
-	logger.debug('setStoryStatus', { deviceId, externalId: rundownExternalId, storyId, status })
-	return executePeripheralDeviceFunction(context, deviceId, DEFAULT_MOS_TIMEOUT_TIME + 1000, 'setStoryStatus', [
-		rundownExternalId,
-		storyId,
-		status,
-	])
-}

packages/job-worker/src/ingest/model/implementation/IngestModelImpl.ts

@@ -462,7 +462,6 @@ export class IngestModelImpl implements IngestModel, DatabasePersistedModel {
 			// owned by elsewhere
 			airStatus: this.#rundownImpl?.airStatus,
 			status: this.#rundownImpl?.status,
-			notifiedCurrentPlayingPartExternalId: this.#rundownImpl?.notifiedCurrentPlayingPartExternalId,
 		})
 		deleteAllUndefinedProperties(newRundown)
 

packages/job-worker/src/playout/snapshot.ts

@@ -173,7 +173,6 @@ export async function handleRestorePlaylistSnapshot(
 			rundownId: rd._id,
 		}
 		rd.studioId = snapshot.playlist.studioId
-		rd.notifiedCurrentPlayingPartExternalId = undefined
 	}
 
 	// TODO: This is too naive. Ideally we should unset it if it isnt valid, as anything other than a match is likely to have issues.

packages/job-worker/src/workers/events/jobs.ts

@@ -1,10 +1,6 @@
 import { JobContext } from '../../jobs'
 import { EventsJobFunc, EventsJobs } from '@sofie-automation/corelib/dist/worker/events'
-import {
-	handleNotifyCurrentlyPlayingPart,
-	handlePartInstanceTimings,
-	handleRundownDataHasChanged,
-} from '../../events/handle'
+import { handlePartInstanceTimings, handleRundownDataHasChanged } from '../../events/handle'
 
 type ExecutableFunction<T extends keyof EventsJobFunc> = (
 	context: JobContext,
@@ -18,5 +14,4 @@ export type EventsJobHandlers = {
 export const eventJobHandlers: EventsJobHandlers = {
 	[EventsJobs.PartInstanceTimings]: handlePartInstanceTimings,
 	[EventsJobs.RundownDataChanged]: handleRundownDataHasChanged,
-	[EventsJobs.NotifyCurrentlyPlayingPart]: handleNotifyCurrentlyPlayingPart,
 }

packages/mos-gateway/src/CoreMosDeviceHandler.ts

@@ -22,7 +22,6 @@ import {
 	IMOSItem,
 	IMOSROReadyToAir,
 	IMOSROFullStory,
-	IMOSObjectStatus,
 	IMOSROAck,
 	getMosTypes,
 	MosTypes,
@@ -339,42 +338,6 @@ export class CoreMosDeviceHandler {
 		// console.log('GOT REPLY', results)
 		return this.fixMosData(ro)
 	}
-	async setROStatus(roId: string, status: IMOSObjectStatus): Promise<any> {
-		// console.log('setStoryStatus')
-		const result = await this._mosDevice.sendRunningOrderStatus({
-			ID: this.mosTypes.mosString128.create(roId),
-			Status: status,
-			Time: this.mosTypes.mosTime.create(new Date()),
-		})
-
-		// console.log('got result', result)
-		return this.fixMosData(result)
-	}
-	async setStoryStatus(roId: string, storyId: string, status: IMOSObjectStatus): Promise<any> {
-		// console.log('setStoryStatus')
-		const result = await this._mosDevice.sendStoryStatus({
-			RunningOrderId: this.mosTypes.mosString128.create(roId),
-			ID: this.mosTypes.mosString128.create(storyId),
-			Status: status,
-			Time: this.mosTypes.mosTime.create(new Date()),
-		})
-
-		// console.log('got result', result)
-		return this.fixMosData(result)
-	}
-	async setItemStatus(roId: string, storyId: string, itemId: string, status: IMOSObjectStatus): Promise<any> {
-		// console.log('setStoryStatus')
-		const result = await this._mosDevice.sendItemStatus({
-			RunningOrderId: this.mosTypes.mosString128.create(roId),
-			StoryId: this.mosTypes.mosString128.create(storyId),
-			ID: this.mosTypes.mosString128.create(itemId),
-			Status: status,
-			Time: this.mosTypes.mosTime.create(new Date()),
-		})
-
-		// console.log('got result', result)
-		return this.fixMosData(result)
-	}
 	async replaceStoryItem(
 		roID: string,
 		storyID: string,

packages/mos-gateway/src/mosHandler.ts

@@ -303,7 +303,8 @@ export class MosHandler {
 						this._logger,
 						mosDevice,
 						coreMosHandler,
-						deviceEntry.deviceOptions.statuses
+						deviceEntry.deviceOptions.statuses,
+						this.strict
 					)
 				}
 

packages/mos-gateway/src/mosStatusHandler.ts

@@ -1,4 +1,4 @@
-import { getMosTypes, IMOSObjectStatus, type IMOSDevice } from '@mos-connection/connector'
+import { getMosTypes, IMOSObjectStatus, MosTypes, type IMOSDevice } from '@mos-connection/connector'
 import type { MosDeviceStatusesConfig } from './generated/devices'
 import type { CoreMosDeviceHandler } from './CoreMosDeviceHandler'
 import {
@@ -8,19 +8,22 @@ import {
 	stringifyError,
 	SubscriptionId,
 } from '@sofie-automation/server-core-integration'
-import type { IngestPartStatus, IngestRundownStatus } from '@sofie-automation/shared-lib/dist/ingest/rundownStatus'
+import {
+	IngestPartPlaybackStatus,
+	type IngestPartStatus,
+	type IngestRundownStatus,
+} from '@sofie-automation/shared-lib/dist/ingest/rundownStatus'
 import type { RundownId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
 import type winston = require('winston')
 import { Queue } from '@sofie-automation/server-core-integration/dist/lib/queue'
 
 const MOS_STATUS_UNKNOWN = '' as IMOSObjectStatus // nocommit - check this
 
-const mosTypes = getMosTypes(false)
-
 export class MosStatusHandler {
 	readonly #logger: winston.Logger
 	readonly #mosDevice: IMOSDevice
 	readonly #coreMosHandler: CoreMosDeviceHandler
+	readonly #mosTypes: MosTypes
 
 	readonly #messageQueue = new Queue()
 
@@ -35,13 +38,15 @@ export class MosStatusHandler {
 		logger: winston.Logger,
 		mosDevice: IMOSDevice,
 		coreMosHandler: CoreMosDeviceHandler,
-		config: MosDeviceStatusesConfig
+		config: MosDeviceStatusesConfig,
+		strictMosTypes: boolean
 	) {
 		if (!config.enabled) throw new Error('MosStatusHandler is not enabled')
 
 		this.#logger = logger
 		this.#mosDevice = mosDevice
 		this.#coreMosHandler = coreMosHandler
+		this.#mosTypes = getMosTypes(strictMosTypes)
 
 		coreMosHandler.core
 			.autoSubscribe(PeripheralDevicePubSub.ingestDeviceRundownStatus, coreMosHandler.core.deviceId, undefined) // nocommit - does this need a token?
@@ -79,16 +84,16 @@ export class MosStatusHandler {
 		const statusDiff = diffStatuses(previousStatuses, newStatuses)
 		if (statusDiff.length === 0) return
 
-		const diffTime = mosTypes.mosTime.create(Date.now())
+		const diffTime = this.#mosTypes.mosTime.create(Date.now())
 
 		// nocommit - should this be done with some concurrency?
 		for (const status of statusDiff) {
 			this.#messageQueue
 				.putOnQueue(async () => {
 					// Send status
 					await this.#mosDevice.sendStoryStatus({
-						RunningOrderId: mosTypes.mosString128.create(status.rundownExternalId),
-						ID: mosTypes.mosString128.create(status.storyId),
+						RunningOrderId: this.#mosTypes.mosString128.create(status.rundownExternalId),
+						ID: this.#mosTypes.mosString128.create(status.storyId),
 						Status: status.mosStatus,
 						Time: diffTime,
 					})
@@ -127,6 +132,8 @@ function diffStatuses(
 
 	if ((!previousStatuses && !newStatuses) || !rundownExternalId) return []
 
+	// nocommit - option/always skip for rehearsal
+
 	const statuses: StoryStatusItem[] = []
 
 	const previousStories = buildStoriesMap(previousStatuses)
@@ -176,10 +183,17 @@ function buildStoriesMap(state: IngestRundownStatus | undefined): Map<string, In
 }
 
 function buildMosStatus(story: IngestPartStatus): IMOSObjectStatus {
+	// nocommit - implement this rule.
+	// nocommit - implement options to control behaviour of this
+	// New implementation 2022 only sends PLAY, never stop, after getting advice from AP
+	// Reason 1: NRK ENPS "sendt tid" (elapsed time) stopped working in ENPS 8/9 when doing STOP prior to PLAY
+	// Reason 2: there's a delay between the STOP (yellow line disappears) and PLAY (yellow line re-appears), which annoys the users
+	// nocommit TLDR: nrk only wants to send PLAY messages
+
 	switch (story.playbackStatus) {
-		case 'playing':
+		case IngestPartPlaybackStatus.PLAY:
 			return IMOSObjectStatus.PLAY
-		case 'stopped':
+		case IngestPartPlaybackStatus.STOP:
 			return IMOSObjectStatus.STOP
 		default:
 			switch (story.isReady) {

packages/shared-lib/src/ingest/rundownStatus.ts

@@ -29,6 +29,6 @@ export interface IngestPartStatus {
 
 export enum IngestPartPlaybackStatus {
 	UNKNOWN = 'unknown',
-	PLAYING = 'playing',
-	STOPPED = 'stopped',
+	PLAY = 'play',
+	STOP = 'stop',
 }