feat: document publications and remove mongo queries from parameters …

…SOFIE-1183 (#1062)
nrkno · Nov 17, 2023 · 17bb2e3 · 17bb2e3
1 parent 4f89611
commit 17bb2e3
Show file tree

Hide file tree

Showing 63 changed files with 1,248 additions and 1,055 deletions.
diff --git a/meteor/client/lib/triggers/TriggersHandler.tsx b/meteor/client/lib/triggers/TriggersHandler.tsx
@@ -73,31 +73,13 @@ function useSubscriptions(
 	showStyleBaseId: ShowStyleBaseId
 ) {
 	const allReady = [
-		useSubscription(CorelibPubSub.rundownPlaylists, {
-			_id: rundownPlaylistId,
-		}),
-		useSubscription(CorelibPubSub.rundowns, [rundownPlaylistId], null),
-
-		useSubscription(CorelibPubSub.adLibActions, {
-			rundownId: {
-				$in: rundownIds,
-			},
-		}),
-		useSubscription(CorelibPubSub.adLibPieces, {
-			rundownId: {
-				$in: rundownIds,
-			},
-		}),
-		useSubscription(CorelibPubSub.rundownBaselineAdLibActions, {
-			rundownId: {
-				$in: rundownIds,
-			},
-		}),
-		useSubscription(CorelibPubSub.rundownBaselineAdLibPieces, {
-			rundownId: {
-				$in: rundownIds,
-			},
-		}),
+		useSubscription(CorelibPubSub.rundownPlaylists, [rundownPlaylistId], null),
+		useSubscription(CorelibPubSub.rundownsInPlaylists, [rundownPlaylistId]),
+
+		useSubscription(CorelibPubSub.adLibActions, rundownIds),
+		useSubscription(CorelibPubSub.adLibPieces, rundownIds),
+		useSubscription(CorelibPubSub.rundownBaselineAdLibActions, rundownIds),
+		useSubscription(CorelibPubSub.rundownBaselineAdLibPieces, rundownIds),
 		useSubscription(MeteorPubSub.uiShowStyleBase, showStyleBaseId),
 	]
 

diff --git a/meteor/client/ui/Account/OrganizationPage.tsx b/meteor/client/ui/Account/OrganizationPage.tsx
@@ -53,7 +53,7 @@ export const OrganizationPage = translateWithTracker(() => {
 		componentDidMount(): void {
 			this.autorun(() => {
 				if (this.props.organization) {
-					this.subscribe(MeteorPubSub.usersInOrganization, { organizationId: this.props.organization._id })
+					this.subscribe(MeteorPubSub.usersInOrganization, this.props.organization._id)
 				}
 			})
 		}

diff --git a/meteor/client/ui/ActiveRundownView.tsx b/meteor/client/ui/ActiveRundownView.tsx
@@ -9,18 +9,14 @@ import { UIStudios } from './Collections'
 import { StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { RundownPlaylists } from '../collections'
 import { useTranslation } from 'react-i18next'
-import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 
 export function ActiveRundownView({ studioId }: { studioId: StudioId }): JSX.Element | null {
 	const { t } = useTranslation()
 
 	const { path } = useRouteMatch()
 
 	const studioReady = useSubscription(MeteorPubSub.uiStudio, studioId)
-	const playlistReady = useSubscription(CorelibPubSub.rundownPlaylists, {
-		activationId: { $exists: true },
-		studioId,
-	})
+	const playlistReady = useSubscription(MeteorPubSub.rundownPlaylistForStudio, studioId, true)
 
 	const subsReady = studioReady && playlistReady
 

diff --git a/meteor/client/ui/ClipTrimPanel/ClipTrimPanel.tsx b/meteor/client/ui/ClipTrimPanel/ClipTrimPanel.tsx
@@ -86,7 +86,7 @@ export function ClipTrimPanel({
 }: IProps): JSX.Element {
 	const { t } = useTranslation()
 
-	useSubscription(CorelibPubSub.pieces, { _id: pieceId, startRundownId: rundownId })
+	useSubscription(CorelibPubSub.pieces, [rundownId], null) // TODO: This should filter by pieceId, but that requires a different publication and this panel isnt used
 
 	const piece = useTracker(() => Pieces.findOne(pieceId), [pieceId])
 

diff --git a/meteor/client/ui/ClockView/CameraScreen/index.tsx b/meteor/client/ui/ClockView/CameraScreen/index.tsx
@@ -95,29 +95,17 @@ export function CameraScreen({ playlist, studioId }: IProps): JSX.Element | null
 	const rundownIds = useMemo(() => rundowns.map((rundown) => rundown._id), [rundowns])
 	const showStyleBaseIds = useMemo(() => rundowns.map((rundown) => rundown.showStyleBaseId), [rundowns])
 
-	const rundownsReady = useSubscription(CorelibPubSub.rundowns, playlistIds, null)
-	useSubscription(CorelibPubSub.segments, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
+	const rundownsReady = useSubscription(CorelibPubSub.rundownsInPlaylists, playlistIds)
+	useSubscription(CorelibPubSub.segments, rundownIds, {})
 
 	const studioReady = useSubscription(MeteorPubSub.uiStudio, studioId)
-	useSubscription(CorelibPubSub.partInstances, rundownIds, playlist?.activationId)
+	useSubscription(CorelibPubSub.partInstances, rundownIds, playlist?.activationId ?? null)
 
-	useSubscription(CorelibPubSub.parts, rundownIds)
+	useSubscription(CorelibPubSub.parts, rundownIds, null)
 
-	useSubscription(CorelibPubSub.pieceInstancesSimple, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
+	useSubscription(CorelibPubSub.pieceInstancesSimple, rundownIds, null)
 
-	const piecesReady = useSubscription(CorelibPubSub.pieces, {
-		startRundownId: {
-			$in: rundownIds,
-		},
-	})
+	const piecesReady = useSubscription(CorelibPubSub.pieces, rundownIds, null)
 
 	const [piecesReadyOnce, setPiecesReadyOnce] = useState(false)
 	useEffect(() => {

diff --git a/meteor/client/ui/ClockView/ClockView.tsx b/meteor/client/ui/ClockView/ClockView.tsx
@@ -11,13 +11,10 @@ import { OverlayScreenSaver } from './OverlayScreenSaver'
 import { RundownPlaylists } from '../../collections'
 import { StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { CameraScreen } from './CameraScreen'
-import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
+import { MeteorPubSub } from '../../../lib/api/pubsub'
 
 export function ClockView({ studioId }: { studioId: StudioId }): JSX.Element {
-	useSubscription(CorelibPubSub.rundownPlaylists, {
-		activationId: { $exists: true },
-		studioId,
-	})
+	useSubscription(MeteorPubSub.rundownPlaylistForStudio, studioId, true)
 
 	const playlist = useTracker(
 		() =>

diff --git a/meteor/client/ui/ClockView/OverlayScreenSaver.tsx b/meteor/client/ui/ClockView/OverlayScreenSaver.tsx
@@ -6,7 +6,6 @@ import { findNextPlaylist } from '../StudioScreenSaver/StudioScreenSaver'
 // @ts-expect-error No types available
 import Velocity from 'velocity-animate'
 import { StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
-import { CorelibPubSub } from '@sofie-automation/corelib/dist/pubsub'
 
 export function OverlayScreenSaver({ studioId }: { studioId: StudioId }): JSX.Element {
 	const studioNameRef = useRef<HTMLDivElement>(null)
@@ -19,7 +18,7 @@ export function OverlayScreenSaver({ studioId }: { studioId: StudioId }): JSX.El
 	})
 
 	useSubscription(MeteorPubSub.uiStudio, studioId)
-	useSubscription(CorelibPubSub.rundownPlaylists, { studioId: studioId, activationId: { $exists: false } })
+	useSubscription(MeteorPubSub.rundownPlaylistForStudio, studioId, false)
 
 	const data = useTracker(() => findNextPlaylist({ studioId }), [studioId])
 

diff --git a/meteor/client/ui/ClockView/PresenterScreen.tsx b/meteor/client/ui/ClockView/PresenterScreen.tsx
@@ -315,7 +315,7 @@ export class PresenterScreenBase extends MeteorReactComponent<
 				},
 			}) as Pick<DBRundownPlaylist, '_id' | 'activationId'> | undefined
 			if (playlist) {
-				this.subscribe(CorelibPubSub.rundowns, [playlist._id], null)
+				this.subscribe(CorelibPubSub.rundownsInPlaylists, [playlist._id])
 
 				this.autorun(() => {
 					const rundowns = RundownPlaylistCollectionUtil.getRundownsUnordered(playlist, undefined, {
@@ -329,26 +329,16 @@ export class PresenterScreenBase extends MeteorReactComponent<
 					const showStyleBaseIds = rundowns.map((r) => r.showStyleBaseId)
 					const showStyleVariantIds = rundowns.map((r) => r.showStyleVariantId)
 
-					this.subscribe(CorelibPubSub.segments, {
-						rundownId: { $in: rundownIds },
-					})
-					this.subscribe(CorelibPubSub.parts, rundownIds)
-					this.subscribe(CorelibPubSub.partInstances, rundownIds, playlist.activationId)
+					this.subscribe(CorelibPubSub.segments, rundownIds, {})
+					this.subscribe(CorelibPubSub.parts, rundownIds, null)
+					this.subscribe(CorelibPubSub.partInstances, rundownIds, playlist.activationId ?? null)
 
 					for (const rundown of rundowns) {
 						this.subscribe(MeteorPubSub.uiShowStyleBase, rundown.showStyleBaseId)
 					}
 
-					this.subscribe(CorelibPubSub.showStyleVariants, {
-						_id: {
-							$in: showStyleVariantIds,
-						},
-					})
-					this.subscribe(MeteorPubSub.rundownLayouts, {
-						showStyleBaseId: {
-							$in: showStyleBaseIds,
-						},
-					})
+					this.subscribe(CorelibPubSub.showStyleVariants, null, showStyleVariantIds)
+					this.subscribe(MeteorPubSub.rundownLayouts, showStyleBaseIds)
 
 					this.autorun(() => {
 						const playlistR = RundownPlaylists.findOne(this.props.playlistId, {
@@ -363,16 +353,15 @@ export class PresenterScreenBase extends MeteorReactComponent<
 							const { nextPartInstance, currentPartInstance } =
 								RundownPlaylistCollectionUtil.getSelectedPartInstances(playlistR)
 							if (currentPartInstance) {
-								this.subscribe(CorelibPubSub.pieceInstances, {
-									rundownId: currentPartInstance.rundownId,
-									partInstanceId: currentPartInstance._id,
-								})
+								this.subscribe(
+									CorelibPubSub.pieceInstances,
+									[currentPartInstance.rundownId],
+									[currentPartInstance._id],
+									{}
+								)
 							}
 							if (nextPartInstance) {
-								this.subscribe(CorelibPubSub.pieceInstances, {
-									rundownId: nextPartInstance.rundownId,
-									partInstanceId: nextPartInstance._id,
-								})
+								this.subscribe(CorelibPubSub.pieceInstances, [nextPartInstance.rundownId], [nextPartInstance._id], {})
 							}
 						}
 					})

diff --git a/meteor/client/ui/MediaStatus/MediaStatus.tsx b/meteor/client/ui/MediaStatus/MediaStatus.tsx
@@ -257,61 +257,23 @@ function useMediaStatusSubscriptions(
 ): boolean {
 	const readyStatus: boolean[] = []
 	let counter = 0
-	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownPlaylists, {
-		_id: {
-			$in: playlistIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.rundowns, playlistIds, null)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownPlaylists, playlistIds, null)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownsInPlaylists, playlistIds)
 	const uiShowStyleBaseSubArguments = useMemo(
 		() => showStyleBaseIds.map((showStyleBaseId) => [showStyleBaseId] as [ShowStyleBaseId]),
 		[showStyleBaseIds]
 	)
 	readyStatus[counter++] = useSubscriptions(MeteorPubSub.uiShowStyleBase, uiShowStyleBaseSubArguments)
-	readyStatus[counter++] = useSubscription(CorelibPubSub.segments, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.parts, rundownIds)
-	readyStatus[counter++] = useSubscription(CorelibPubSub.partInstancesSimple, {
-		rundownId: {
-			$in: rundownIds,
-		},
-		reset: {
-			$ne: true,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.pieceInstancesSimple, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.pieces, {
-		startRundownId: {
-			$in: rundownIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.adLibActions, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.adLibPieces, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownBaselineAdLibActions, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
-	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownBaselineAdLibPieces, {
-		rundownId: {
-			$in: rundownIds,
-		},
-	})
+	readyStatus[counter++] = useSubscription(CorelibPubSub.segments, rundownIds, {})
+	readyStatus[counter++] = useSubscription(CorelibPubSub.parts, rundownIds, null)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.partInstancesSimple, rundownIds, null)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.pieceInstancesSimple, rundownIds, null)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.pieces, rundownIds, null)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.adLibActions, rundownIds)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.adLibPieces, rundownIds)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownBaselineAdLibActions, rundownIds)
+	readyStatus[counter++] = useSubscription(CorelibPubSub.rundownBaselineAdLibPieces, rundownIds)
+
 	const uiPieceContentStatusesSubArguments = useMemo(
 		() => playlistIds.map((playlistIds) => [playlistIds] as [RundownPlaylistId]),
 		[playlistIds]

diff --git a/meteor/client/ui/PieceIcons/PieceCountdown.tsx b/meteor/client/ui/PieceIcons/PieceCountdown.tsx
@@ -42,10 +42,7 @@ export function PieceCountdownContainer(props: IPropsHeader): JSX.Element | null
 		}
 	)
 
-	useSubscription(CorelibPubSub.pieceInstancesSimple, {
-		rundownId: { $in: props.rundownIds },
-		playlistActivationId: props.playlistActivationId,
-	})
+	useSubscription(CorelibPubSub.pieceInstancesSimple, props.rundownIds, props.playlistActivationId ?? null)
 
 	useSubscription(MeteorPubSub.uiShowStyleBase, props.showStyleBaseId)
 

diff --git a/meteor/client/ui/PieceIcons/PieceIcon.tsx b/meteor/client/ui/PieceIcons/PieceIcon.tsx
@@ -130,10 +130,7 @@ export function PieceIconContainer(props: IPropsHeader): JSX.Element | null {
 		}
 	)
 
-	useSubscription(CorelibPubSub.pieceInstancesSimple, {
-		rundownId: { $in: props.rundownIds },
-		playlistActivationId: props.playlistActivationId,
-	})
+	useSubscription(CorelibPubSub.pieceInstancesSimple, props.rundownIds, props.playlistActivationId ?? null)
 
 	useSubscription(MeteorPubSub.uiShowStyleBase, props.showStyleBaseId)
 

diff --git a/meteor/client/ui/PieceIcons/PieceName.tsx b/meteor/client/ui/PieceIcons/PieceName.tsx
@@ -55,10 +55,7 @@ export function PieceNameContainer(props: INamePropsHeader): JSX.Element | null
 		}
 	)
 
-	useSubscription(CorelibPubSub.pieceInstancesSimple, {
-		rundownId: { $in: props.rundownIds },
-		playlistActivationId: props.playlistActivationId,
-	})
+	useSubscription(CorelibPubSub.pieceInstancesSimple, props.rundownIds, props.playlistActivationId ?? null)
 
 	useSubscription(MeteorPubSub.uiShowStyleBase, props.showStyleBaseId)
 

diff --git a/meteor/client/ui/Prompter/PrompterView.tsx b/meteor/client/ui/Prompter/PrompterView.tsx
@@ -206,10 +206,7 @@ export class PrompterViewInner extends MeteorReactComponent<Translated<IProps &
 		if (this.props.studioId) {
 			this.subscribe(MeteorPubSub.uiStudio, this.props.studioId)
 
-			this.subscribe(CorelibPubSub.rundownPlaylists, {
-				activationId: { $exists: true },
-				studioId: this.props.studioId,
-			})
+			this.subscribe(MeteorPubSub.rundownPlaylistForStudio, this.props.studioId, true)
 		}
 
 		this.autorun(() => {
@@ -225,7 +222,7 @@ export class PrompterViewInner extends MeteorReactComponent<Translated<IProps &
 				}
 			) as Pick<DBRundownPlaylist, '_id'> | undefined
 			if (playlist?._id) {
-				this.subscribe(CorelibPubSub.rundowns, [playlist._id], null)
+				this.subscribe(CorelibPubSub.rundownsInPlaylists, [playlist._id])
 			}
 		})
 
@@ -599,7 +596,7 @@ export const Prompter = translateWithTracker<PropsWithChildren<IPrompterProps>,
 		}
 
 		componentDidMount(): void {
-			this.subscribe(CorelibPubSub.rundowns, [this.props.rundownPlaylistId], null)
+			this.subscribe(CorelibPubSub.rundownsInPlaylists, [this.props.rundownPlaylistId])
 
 			this.autorun(() => {
 				const playlist = RundownPlaylists.findOne(this.props.rundownPlaylistId, {
@@ -610,18 +607,11 @@ export const Prompter = translateWithTracker<PropsWithChildren<IPrompterProps>,
 				}) as Pick<DBRundownPlaylist, '_id' | 'activationId'> | undefined
 				if (playlist) {
 					const rundownIDs = RundownPlaylistCollectionUtil.getRundownUnorderedIDs(playlist)
-					this.subscribe(CorelibPubSub.segments, {
-						rundownId: { $in: rundownIDs },
-					})
-					this.subscribe(CorelibPubSub.parts, rundownIDs)
-					this.subscribe(CorelibPubSub.partInstances, rundownIDs, playlist.activationId)
-					this.subscribe(CorelibPubSub.pieces, {
-						startRundownId: { $in: rundownIDs },
-					})
-					this.subscribe(CorelibPubSub.pieceInstancesSimple, {
-						rundownId: { $in: rundownIDs },
-						reset: { $ne: true },
-					})
+					this.subscribe(CorelibPubSub.segments, rundownIDs, {})
+					this.subscribe(CorelibPubSub.parts, rundownIDs, null)
+					this.subscribe(CorelibPubSub.partInstances, rundownIDs, playlist.activationId ?? null)
+					this.subscribe(CorelibPubSub.pieces, rundownIDs, null)
+					this.subscribe(CorelibPubSub.pieceInstancesSimple, rundownIDs, null)
 				}
 			})
 

diff --git a/meteor/client/ui/RundownList.tsx b/meteor/client/ui/RundownList.tsx
@@ -60,19 +60,14 @@ export function RundownList(): JSX.Element {
 	)
 
 	const baseSubsReady = [
-		useSubscription(CorelibPubSub.rundownPlaylists, {}),
+		useSubscription(CorelibPubSub.rundownPlaylists, null, null),
 		useSubscription(MeteorPubSub.uiStudio, null),
-		useSubscription(MeteorPubSub.rundownLayouts, {}),
+		useSubscription(MeteorPubSub.rundownLayouts, null),
 
-		useSubscription(CorelibPubSub.rundowns, playlistIds, null),
+		useSubscription(CorelibPubSub.rundownsInPlaylists, playlistIds),
 
-		useSubscription(CorelibPubSub.showStyleBases, {
-			_id: { $in: showStyleBaseIds },
-		}),
-
-		useSubscription(CorelibPubSub.showStyleVariants, {
-			_id: { $in: showStyleVariantIds },
-		}),
+		useSubscription(CorelibPubSub.showStyleBases, showStyleBaseIds),
+		useSubscription(CorelibPubSub.showStyleVariants, null, showStyleVariantIds),
 	].reduce((prev, current) => prev && current, true)
 
 	const [subsReady, setSubsReady] = useState(false)