fix: refactor Rundown orphaned property SOFIE-2963 #1210 (#1217)

fix: refactor Rundown orphaned property SOFIE-2963 #1210

Author: Julusian

meteor/server/migration/X_X_X.ts

@@ -1,7 +1,7 @@
 import { addMigrationSteps } from './databaseMigration'
 import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
 import { Rundowns } from '../collections'
-import { RundownSource } from '@sofie-automation/corelib/dist/dataModel/Rundown'
+import { RundownOrphanedReason, RundownSource } from '@sofie-automation/corelib/dist/dataModel/Rundown'
 import { PeripheralDeviceId, RundownId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 
 /*
@@ -71,4 +71,33 @@ export const addSteps = addMigrationSteps(CURRENT_SYSTEM_VERSION, [
 			}
 		},
 	},
+	{
+		id: `Rundowns remove orphaned FROM_SNAPSHOT`,
+		canBeRunAutomatically: true,
+		validate: async () => {
+			const objects = await Rundowns.findFetchAsync({
+				orphaned: 'from-snapshot' as any,
+			})
+
+			if (objects.length > 0) {
+				return `object needs to be updated`
+			}
+			return false
+		},
+		migrate: async () => {
+			await Rundowns.mutableCollection.updateAsync(
+				{
+					orphaned: 'from-snapshot' as any,
+				},
+				{
+					$set: {
+						orphaned: RundownOrphanedReason.DELETED,
+					},
+				},
+				{
+					multi: true,
+				}
+			)
+		},
+	},
 ])

packages/corelib/src/dataModel/Rundown.ts

@@ -12,10 +12,8 @@ import { RundownNote } from './Notes'
 import { ReadonlyDeep } from 'type-fest'
 
 export enum RundownOrphanedReason {
-	/** Rundown is deleted from the NRCS but we still need it */
+	/** Rundown is deleted from the source but we still need it */
 	DELETED = 'deleted',
-	/** Rundown was restored from a snapshot and does not correspond with a rundown in the NRCS */
-	FROM_SNAPSHOT = 'from-snapshot',
 	/** Rundown was unsynced by the user */
 	MANUAL = 'manual',
 }
@@ -29,7 +27,6 @@ export interface RundownImportVersions {
 	core: string
 }
 
-/** This is a very uncomplete mock-up of the Rundown object */
 export interface Rundown {
 	_id: RundownId
 	/** ID of the organization that owns the rundown */
@@ -53,9 +50,10 @@ export interface Rundown {
 	/** Air-status, comes from NCS, examples: "READY" | "NOT READY" */
 	airStatus?: string
 
-	// There should be something like a Owner user here somewhere?
-
-	/** Is the rundown in an unsynced (has been unpublished from ENPS) state? */
+	/**
+	 * Is the rundown in an unsynced state?
+	 * This can be because the rundown was deleted from the source, or because the user manually unsynced it
+	 */
 	orphaned?: RundownOrphanedReason
 
 	/** Last sent storyStatus to ingestDevice (MOS) */

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

@@ -163,7 +163,7 @@ export async function handleRestorePlaylistSnapshot(
 
 	for (const rd of snapshot.rundowns) {
 		if (!rd.orphaned) {
-			rd.orphaned = RundownOrphanedReason.FROM_SNAPSHOT
+			rd.orphaned = RundownOrphanedReason.MANUAL
 		}
 
 		rd.playlistId = playlistId