feat: support prompter-editor SOFIE-2846 (Sofie-Automation#1151)

Author: Julusian

meteor/lib/api/pubsub.ts

@@ -61,6 +61,7 @@ import {
 	PackageManagerPlayoutContext,
 } from '@sofie-automation/shared-lib/dist/package-manager/publications'
 import { logger } from '../logging'
+import { PackageInfoDB } from '@sofie-automation/corelib/dist/dataModel/PackageInfos'
 
 /**
  * Ids of possible DDP subscriptions
@@ -220,6 +221,7 @@ export interface PubSubTypes {
 		selector: MongoQuery<PackageContainerStatusDB>,
 		token?: string
 	) => PackageContainerStatusDB
+	[PubSub.packageInfos]: (deviceId: PeripheralDeviceId, token?: string) => PackageInfoDB
 
 	// For a PeripheralDevice
 	[PubSub.rundownsForDevice]: (deviceId: PeripheralDeviceId, token: string) => DBRundown

meteor/server/migration/1_50_0.ts

@@ -1,5 +1,13 @@
 import { addMigrationSteps } from './databaseMigration'
-import { PeripheralDevices, RundownPlaylists, Studios } from '../collections'
+import {
+	AdLibActions,
+	AdLibPieces,
+	ExpectedPackages,
+	PeripheralDevices,
+	Pieces,
+	RundownPlaylists,
+	Studios,
+} from '../collections'
 import { assertNever, clone, literal } from '@sofie-automation/corelib/dist/lib'
 import {
 	MappingExt,
@@ -21,6 +29,13 @@ import {
 } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
 import { JSONBlobStringify, JSONSchema, TSR } from '@sofie-automation/blueprints-integration'
 import { DEFAULT_MINIMUM_TAKE_SPAN } from '@sofie-automation/shared-lib/dist/core/constants'
+import { PartId } from '@sofie-automation/shared-lib/dist/core/model/Ids'
+import { protectString } from '@sofie-automation/shared-lib/dist/lib/protectedString'
+import { ExpectedPackageDBType } from '@sofie-automation/corelib/dist/dataModel/ExpectedPackages'
+import { AdLibActionId, PieceId, RundownBaselineAdLibActionId } from '@sofie-automation/corelib/dist/dataModel/Ids'
+import { Piece } from '@sofie-automation/corelib/dist/dataModel/Piece'
+import { AdLibPiece } from '@sofie-automation/corelib/dist/dataModel/AdLibPiece'
+import { AdLibAction } from '@sofie-automation/corelib/dist/dataModel/AdlibAction'
 
 /*
  * **************************************************************************************
@@ -145,6 +160,12 @@ const oldDeviceTypeToNewMapping = {
 	[OldDeviceType.MULTI_OSC]: TSR.DeviceType.MULTI_OSC,
 }
 
+const EXPECTED_PACKAGE_TYPES_ADDED_PART_ID = [
+	ExpectedPackageDBType.PIECE,
+	ExpectedPackageDBType.ADLIB_PIECE,
+	ExpectedPackageDBType.ADLIB_ACTION,
+]
+
 export const addSteps = addMigrationSteps('1.50.0', [
 	{
 		id: `Mos gateway fix up config`,
@@ -824,6 +845,88 @@ export const addSteps = addMigrationSteps('1.50.0', [
 			)
 		},
 	},
+
+	{
+		id: `ExpectedPackageDBFromAdLibAction and ExpectedPackageDBFromPiece add partId`,
+		canBeRunAutomatically: true,
+		validate: async () => {
+			const objectCount = await ExpectedPackages.countDocuments({
+				fromPieceType: { $in: EXPECTED_PACKAGE_TYPES_ADDED_PART_ID as any }, // Force the types, as the query does not match due to the interfaces
+				partId: { $exists: false },
+			})
+
+			if (objectCount) {
+				return `object needs to be updated`
+			}
+			return false
+		},
+		migrate: async () => {
+			const objects = await ExpectedPackages.findFetchAsync({
+				fromPieceType: { $in: EXPECTED_PACKAGE_TYPES_ADDED_PART_ID as any }, // Force the types, as the query does not match due to the interfaces
+				partId: { $exists: false },
+			})
+
+			const neededPieceIds: Array<PieceId | AdLibActionId | RundownBaselineAdLibActionId> = _.compact(
+				objects.map((obj) => obj.pieceId)
+			)
+			const [pieces, adlibPieces, adlibActions] = await Promise.all([
+				Pieces.findFetchAsync(
+					{
+						_id: { $in: neededPieceIds as PieceId[] },
+					},
+					{
+						projection: {
+							_id: 1,
+							startPartId: 1,
+						},
+					}
+				) as Promise<Pick<Piece, '_id' | 'startPartId'>[]>,
+				AdLibPieces.findFetchAsync(
+					{
+						_id: { $in: neededPieceIds as PieceId[] },
+					},
+					{
+						projection: {
+							_id: 1,
+							partId: 1,
+						},
+					}
+				) as Promise<Pick<AdLibPiece, '_id' | 'partId'>[]>,
+				AdLibActions.findFetchAsync(
+					{
+						_id: { $in: neededPieceIds as AdLibActionId[] },
+					},
+					{
+						projection: {
+							_id: 1,
+							partId: 1,
+						},
+					}
+				) as Promise<Pick<AdLibAction, '_id' | 'partId'>[]>,
+			])
+
+			const partIdLookup = new Map<PieceId | AdLibActionId | RundownBaselineAdLibActionId, PartId>()
+			for (const piece of pieces) {
+				partIdLookup.set(piece._id, piece.startPartId)
+			}
+			for (const adlib of adlibPieces) {
+				if (adlib.partId) partIdLookup.set(adlib._id, adlib.partId)
+			}
+			for (const action of adlibActions) {
+				partIdLookup.set(action._id, action.partId)
+			}
+
+			for (const expectedPackage of objects) {
+				if (!expectedPackage.pieceId) continue
+
+				await ExpectedPackages.mutableCollection.updateAsync(expectedPackage._id, {
+					$set: {
+						partId: partIdLookup.get(expectedPackage.pieceId) ?? protectString(''),
+					},
+				})
+			}
+		},
+	},
 ])
 
 function updatePlayoutDeviceTypeInOverride(op: SomeObjectOverrideOp): ObjectOverrideSetOp | undefined {

meteor/server/publications/studio.ts

@@ -26,9 +26,11 @@ import {
 	ExpectedPackageWorkStatuses,
 	ExternalMessageQueue,
 	PackageContainerStatuses,
+	PackageInfos,
 	PeripheralDevices,
 	Studios,
 } from '../collections'
+import { PackageInfoDB } from '@sofie-automation/corelib/dist/dataModel/PackageInfos'
 
 meteorPublish(PubSub.studios, async function (selector0, token) {
 	const { cred, selector } = await AutoFillSelector.organizationId<DBStudio>(this.userId, selector0, token)
@@ -88,6 +90,16 @@ meteorPublish(PubSub.packageContainerStatuses, async function (selector, token)
 	}
 	return null
 })
+meteorPublish(PubSub.packageInfos, async function (deviceId, token) {
+	if (!deviceId) throw new Meteor.Error(400, 'deviceId argument missing')
+	const modifier: FindOptions<PackageInfoDB> = {
+		fields: {},
+	}
+	if (await PeripheralDeviceReadAccess.peripheralDeviceContent(deviceId, { userId: this.userId, token })) {
+		return PackageInfos.findWithCursor({ deviceId }, modifier)
+	}
+	return null
+})
 
 meteorCustomPublish(
 	PubSub.mappingsForDevice,

packages/corelib/src/dataModel/ExpectedPackages.ts

@@ -7,6 +7,7 @@ import {
 	BucketAdLibId,
 	BucketId,
 	ExpectedPackageId,
+	PartId,
 	PieceId,
 	RundownBaselineAdLibActionId,
 	RundownId,
@@ -23,17 +24,19 @@ import {
    The Package Manager will then copy the file to the right place.
 */
 
-export type ExpectedPackageFromRundown =
-	| ExpectedPackageDBFromPiece
-	| ExpectedPackageDBFromAdLibAction
+export type ExpectedPackageFromRundown = ExpectedPackageDBFromPiece | ExpectedPackageDBFromAdLibAction
+
+export type ExpectedPackageFromRundownBaseline =
 	| ExpectedPackageDBFromBaselineAdLibAction
 	| ExpectedPackageDBFromBaselineAdLibPiece
+	| ExpectedPackageDBFromRundownBaselineObjects
+
+export type ExpectedPackageDBFromBucket = ExpectedPackageDBFromBucketAdLib | ExpectedPackageDBFromBucketAdLibAction
 
 export type ExpectedPackageDB =
 	| ExpectedPackageFromRundown
-	| ExpectedPackageDBFromBucketAdLib
-	| ExpectedPackageDBFromBucketAdLibAction
-	| ExpectedPackageDBFromRundownBaselineObjects
+	| ExpectedPackageDBFromBucket
+	| ExpectedPackageFromRundownBaseline
 	| ExpectedPackageDBFromStudioBaselineObjects
 
 export enum ExpectedPackageDBType {
@@ -67,6 +70,8 @@ export interface ExpectedPackageDBFromPiece extends ExpectedPackageDBBase {
 	fromPieceType: ExpectedPackageDBType.PIECE | ExpectedPackageDBType.ADLIB_PIECE
 	/** The Piece this package belongs to */
 	pieceId: PieceId
+	/** The Part this package belongs to */
+	partId: PartId
 	/** The Segment this package belongs to */
 	segmentId: SegmentId
 	/** The rundown of the Piece this package belongs to */
@@ -85,6 +90,8 @@ export interface ExpectedPackageDBFromAdLibAction extends ExpectedPackageDBBase
 	fromPieceType: ExpectedPackageDBType.ADLIB_ACTION
 	/** The Adlib Action this package belongs to */
 	pieceId: AdLibActionId
+	/** The Part this package belongs to */
+	partId: PartId
 	/** The Segment this package belongs to */
 	segmentId: SegmentId
 	/** The rundown of the Piece this package belongs to */

packages/job-worker/src/ingest/expectedPackages.ts

@@ -180,6 +180,7 @@ function generateExpectedPackagesForPiece(
 						...base,
 						rundownId,
 						segmentId,
+						partId,
 						pieceId: piece._id,
 						fromPieceType: type,
 					})
@@ -227,6 +228,7 @@ function generateExpectedPackagesForAdlibAction(
 						...base,
 						rundownId,
 						segmentId,
+						partId: action.partId,
 						pieceId: action._id,
 						fromPieceType: ExpectedPackageDBType.ADLIB_ACTION,
 					})