fix: handle permissions for ingest rundown status test tool with header auth properly

Author: Julusian

meteor/server/publications/ingestStatus/publication.ts

@@ -1,6 +1,7 @@
 import { PeripheralDeviceId, RundownId, RundownPlaylistId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { ReadonlyDeep } from 'type-fest'
 import {
+	CustomPublish,
 	CustomPublishCollection,
 	meteorCustomPublish,
 	setUpCollectionOptimizedObserver,
@@ -21,7 +22,8 @@ import { IngestRundownStatus } from '@sofie-automation/shared-lib/dist/ingest/ru
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
 import { DBRundown } from '@sofie-automation/corelib/dist/dataModel/Rundown'
 import { createIngestRundownStatus } from './createIngestRundownStatus'
-import { Settings } from '../../Settings'
+import { assertConnectionHasOneOfPermissions } from '../../security/auth'
+import { MeteorPubSub } from '@sofie-automation/meteor-lib/dist/api/pubsub'
 
 interface IngestRundownStatusArgs {
 	readonly deviceId: PeripheralDeviceId
@@ -171,29 +173,45 @@ async function manipulateIngestRundownStatusPublicationData(
 	}
 }
 
+async function startOrJoinIngestStatusPublication(
+	pub: CustomPublish<IngestRundownStatus>,
+	deviceId: PeripheralDeviceId
+) {
+	await setUpCollectionOptimizedObserver<
+		IngestRundownStatus,
+		IngestRundownStatusArgs,
+		IngestRundownStatusState,
+		IngestRundownStatusUpdateProps
+	>(
+		`pub_${PeripheralDevicePubSub.ingestDeviceRundownStatus}_${deviceId}`,
+		{ deviceId },
+		setupIngestRundownStatusPublicationObservers,
+		manipulateIngestRundownStatusPublicationData,
+		pub,
+		100
+	)
+}
+
 meteorCustomPublish(
 	PeripheralDevicePubSub.ingestDeviceRundownStatus,
 	PeripheralDevicePubSubCollectionsNames.ingestRundownStatus,
 	async function (pub, deviceId: PeripheralDeviceId, token: string | undefined) {
 		check(deviceId, String)
 
-		if (Settings.enableHeaderAuth) {
-			// This is used in a testTool, so only check when auth is enabled
-			await checkAccessAndGetPeripheralDevice(deviceId, token, this)
-		}
+		await checkAccessAndGetPeripheralDevice(deviceId, token, this)
+
+		await startOrJoinIngestStatusPublication(pub, deviceId)
+	}
+)
+
+meteorCustomPublish(
+	MeteorPubSub.ingestDeviceRundownStatusTestTool,
+	PeripheralDevicePubSubCollectionsNames.ingestRundownStatus,
+	async function (pub, deviceId: PeripheralDeviceId) {
+		check(deviceId, String)
+
+		assertConnectionHasOneOfPermissions(this.connection, 'testing')
 
-		await setUpCollectionOptimizedObserver<
-			IngestRundownStatus,
-			IngestRundownStatusArgs,
-			IngestRundownStatusState,
-			IngestRundownStatusUpdateProps
-		>(
-			`pub_${PeripheralDevicePubSub.ingestDeviceRundownStatus}_${deviceId}`,
-			{ deviceId },
-			setupIngestRundownStatusPublicationObservers,
-			manipulateIngestRundownStatusPublicationData,
-			pub,
-			100
-		)
+		await startOrJoinIngestStatusPublication(pub, deviceId)
 	}
 )

packages/meteor-lib/src/api/pubsub.ts

@@ -2,6 +2,7 @@ import {
 	BucketId,
 	OrganizationId,
 	PartId,
+	PeripheralDeviceId,
 	RundownId,
 	RundownPlaylistActivationId,
 	RundownPlaylistId,
@@ -130,6 +131,11 @@ export enum MeteorPubSub {
 	 */
 	timelineForStudio = 'timelineForStudio',
 
+	/**
+	 * Ingest status of rundowns for a PeripheralDevice
+	 */
+	ingestDeviceRundownStatusTestTool = 'ingestDeviceRundownStatusTestTool',
+
 	/**
 	 * Fetch the simplified playout UI view of the specified ShowStyleBase
 	 */
@@ -236,6 +242,11 @@ export interface MeteorPubSubTypes {
 		studioId: StudioId,
 		token?: string
 	) => PeripheralDevicePubSubCollectionsNames.studioTimeline
+
+	[MeteorPubSub.ingestDeviceRundownStatusTestTool]: (
+		peripheralDeviceId: PeripheralDeviceId
+	) => PeripheralDevicePubSubCollectionsNames.ingestRundownStatus
+
 	[MeteorPubSub.uiShowStyleBase]: (showStyleBaseId: ShowStyleBaseId) => CustomCollectionName.UIShowStyleBase
 	/** Subscribe to one or all studios */
 	[MeteorPubSub.uiStudio]: (studioId: StudioId | null) => CustomCollectionName.UIStudio

packages/webui/package.json

@@ -14,7 +14,7 @@
 	},
 	"homepage": "https://github.com/nrkno/sofie-core/blob/master/packages/webui#readme",
 	"scripts": {
-		"dev": "vite --port=3005",
+		"dev": "vite --port=3005 --force",
 		"build": "tsc -b && vite build",
 		"build:main": "tsc -p tsconfig.app.json --noEmit",
 		"check-types": "tsc -p tsconfig.app.json --noEmit",

packages/webui/src/client/ui/TestTools/IngestRundownStatus.tsx

@@ -2,14 +2,14 @@ import { useSubscription, useTracker } from '../../lib/ReactMeteorData/react-met
 import { unprotectString } from '../../lib/tempLib'
 import { makeTableOfObject } from '../../lib/utilComponents'
 import { PeripheralDeviceId } from '@sofie-automation/corelib/dist/dataModel/Ids'
-import { PeripheralDevicePubSub } from '@sofie-automation/shared-lib/dist/pubsub/peripheralDevice'
 import { useTranslation } from 'react-i18next'
 import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 import { PeripheralDevices } from '../../collections'
 import { Link } from 'react-router-dom'
 import { PeripheralDeviceCategory } from '@sofie-automation/shared-lib/dist/peripheralDevice/peripheralDeviceAPI'
 import { IngestRundownStatuses } from './collections'
 import { IngestPartStatus, IngestRundownStatus } from '@sofie-automation/shared-lib/dist/ingest/rundownStatus'
+import { MeteorPubSub } from '@sofie-automation/meteor-lib/dist/api/pubsub'
 
 interface IMappingsViewProps {
 	match?: {
@@ -39,7 +39,7 @@ interface ComponentMappingsTableProps {
 	peripheralDeviceId: PeripheralDeviceId
 }
 function ComponentMappingsTable({ peripheralDeviceId }: Readonly<ComponentMappingsTableProps>): JSX.Element {
-	useSubscription(PeripheralDevicePubSub.ingestDeviceRundownStatus, peripheralDeviceId)
+	useSubscription(MeteorPubSub.ingestDeviceRundownStatusTestTool, peripheralDeviceId)
 
 	const rundowns = useTracker(() => IngestRundownStatuses.find({}).fetch(), [], [])
 

packages/webui/vite.config.mts

@@ -65,6 +65,7 @@ export default defineConfig({
 				ws: true,
 			},
 		},
+		allowedHosts: true,
 	},
 
 	// TODO: old meteor recompile instructions?