feat: remove support for input during migrations

Author: Julusian

meteor/server/api/rest/v1/system.ts

@@ -8,7 +8,6 @@ import { BlueprintId } from '@sofie-automation/corelib/dist/dataModel/Ids'
 import { Meteor } from 'meteor/meteor'
 import { ClientAPI } from '@sofie-automation/meteor-lib/dist/api/client'
 import { MeteorCall } from '../../methods'
-import { MigrationStepInputResult } from '@sofie-automation/blueprints-integration'
 
 class SystemServerAPI implements SystemRestAPI {
 	async assignSystemBlueprint(
@@ -33,36 +32,20 @@ class SystemServerAPI implements SystemRestAPI {
 		const migrationStatus = await MeteorCall.migration.getMigrationStatus()
 		if (!migrationStatus.migrationNeeded) return ClientAPI.responseSuccess({ inputs: [] })
 
-		const requiredInputs: PendingMigrations = []
-		for (const migration of migrationStatus.migration.manualInputs) {
-			if (migration.stepId && migration.attribute) {
-				requiredInputs.push({
-					stepId: migration.stepId,
-					attributeId: migration.attribute,
-				})
-			}
-		}
-
-		return ClientAPI.responseSuccess({ inputs: requiredInputs })
+		// Inputs are no longer supported, but need to be preserved for api compatibility
+		return ClientAPI.responseSuccess({ inputs: [] })
 	}
 
 	async applyPendingMigrations(
 		_connection: Meteor.Connection,
-		_event: string,
-		inputs: MigrationData
+		_event: string
 	): Promise<ClientAPI.ClientResponse<void>> {
 		const migrationStatus = await MeteorCall.migration.getMigrationStatus()
 		if (!migrationStatus.migrationNeeded) throw new Error(`Migration does not need to be applied`)
 
-		const migrationData: MigrationStepInputResult[] = inputs.map((input) => ({
-			stepId: input.stepId,
-			attribute: input.attributeId,
-			value: input.migrationValue,
-		}))
 		const result = await MeteorCall.migration.runMigration(
 			migrationStatus.migration.chunks,
-			migrationStatus.migration.hash,
-			migrationData
+			migrationStatus.migration.hash
 		)
 		if (result.migrationCompleted) return ClientAPI.responseSuccess(undefined)
 		throw new Error(`Unknown error occurred`)
@@ -95,12 +78,10 @@ export function registerRoutes(registerRoute: APIRegisterHook<SystemRestAPI>): v
 		'/system/migrations',
 		new Map([[400, [UserErrorMessage.NoMigrationsToApply]]]),
 		systemAPIFactory,
-		async (serverAPI, connection, event, _params, body) => {
-			const inputs = body.inputs
+		async (serverAPI, connection, event, _params, _body) => {
 			logger.info(`API POST: System migrations`)
 
-			check(inputs, Array)
-			return await serverAPI.applyPendingMigrations(connection, event, inputs)
+			return await serverAPI.applyPendingMigrations(connection, event)
 		}
 	)
 

meteor/server/coreSystem/index.ts

@@ -86,7 +86,7 @@ async function initializeCoreSystem() {
 			const migration = await prepareMigration(true)
 			if (migration.migrationNeeded && migration.manualStepCount === 0 && migration.chunks.length <= 1) {
 				// Since we've determined that the migration can be done automatically, and we have a fresh system, just do the migration automatically:
-				await runMigration(migration.chunks, migration.hash, [])
+				await runMigration(migration.chunks, migration.hash)
 			}
 		}
 	}

meteor/server/lib/rest/v1/system.ts

@@ -48,11 +48,7 @@ export interface SystemRestAPI {
 	 * @param event User event string
 	 * @param inputs Migration data to apply
 	 */
-	applyPendingMigrations(
-		connection: Meteor.Connection,
-		event: string,
-		inputs: MigrationData
-	): Promise<ClientAPI.ClientResponse<void>>
+	applyPendingMigrations(connection: Meteor.Connection, event: string): Promise<ClientAPI.ClientResponse<void>>
 }
 
 export interface PendingMigrationStep {

meteor/server/migration/__tests__/migrations.test.ts

@@ -4,9 +4,8 @@ import { ICoreSystem, GENESIS_SYSTEM_VERSION } from '@sofie-automation/meteor-li
 import { clearMigrationSteps, addMigrationSteps, prepareMigration, PreparedMigration } from '../databaseMigration'
 import { CURRENT_SYSTEM_VERSION } from '../currentSystemVersion'
 import { RunMigrationResult, GetMigrationStatusResult } from '@sofie-automation/meteor-lib/dist/api/migration'
-import { literal } from '@sofie-automation/corelib/dist/lib'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
-import { MigrationStepCore, MigrationStepInputResult } from '@sofie-automation/blueprints-integration'
+import { MigrationStepCore } from '@sofie-automation/blueprints-integration'
 import { DBStudio } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { MeteorCall } from '../../api/methods'
 import { wrapDefaultObject } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
@@ -36,22 +35,7 @@ describe('Migrations', () => {
 	async function getSystem() {
 		return (await getCoreSystemAsync()) as ICoreSystem
 	}
-	function userInput(
-		migrationStatus: GetMigrationStatusResult,
-		userValues?: { [key: string]: any }
-	): MigrationStepInputResult[] {
-		return _.compact(
-			_.map(migrationStatus.migration.manualInputs, (manualInput) => {
-				if (manualInput.stepId && manualInput.attribute) {
-					return literal<MigrationStepInputResult>({
-						stepId: manualInput.stepId,
-						attribute: manualInput.attribute,
-						value: userValues && userValues[manualInput.stepId],
-					})
-				}
-			})
-		)
-	}
+
 	test('System migrations, initial setup', async () => {
 		expect((await getSystem()).version).toEqual(GENESIS_SYSTEM_VERSION)
 
@@ -76,8 +60,7 @@ describe('Migrations', () => {
 
 		const migrationResult0: RunMigrationResult = await MeteorCall.migration.runMigration(
 			migrationStatus0.migration.chunks,
-			migrationStatus0.migration.hash,
-			userInput(migrationStatus0)
+			migrationStatus0.migration.hash
 		)
 
 		expect(migrationResult0).toMatchObject({

meteor/server/migration/api.ts

@@ -7,7 +7,6 @@ import {
 	BlueprintFixUpConfigMessage,
 } from '@sofie-automation/meteor-lib/dist/api/migration'
 import * as Migrations from './databaseMigration'
-import { MigrationStepInputResult } from '@sofie-automation/blueprints-integration'
 import { MethodContextAPI } from '../api/methodContext'
 import {
 	fixupConfigForShowStyleBase,
@@ -34,20 +33,14 @@ class ServerMigrationAPI extends MethodContextAPI implements NewMigrationAPI {
 		return Migrations.getMigrationStatus()
 	}
 
-	async runMigration(
-		chunks: Array<MigrationChunk>,
-		hash: string,
-		inputResults: Array<MigrationStepInputResult>,
-		isFirstOfPartialMigrations?: boolean | null
-	) {
+	async runMigration(chunks: Array<MigrationChunk>, hash: string, isFirstOfPartialMigrations?: boolean | null) {
 		check(chunks, Array)
 		check(hash, String)
-		check(inputResults, Array)
 		check(isFirstOfPartialMigrations, Match.Maybe(Boolean))
 
 		assertConnectionHasOneOfPermissions(this.connection, ...PERMISSIONS_FOR_MIGRATIONS)
 
-		return Migrations.runMigration(chunks, hash, inputResults, isFirstOfPartialMigrations || false)
+		return Migrations.runMigration(chunks, hash, isFirstOfPartialMigrations || false)
 	}
 
 	async forceMigration(chunks: Array<MigrationChunk>) {

meteor/server/migration/databaseMigration.ts

@@ -1,18 +1,13 @@
 import { Meteor } from 'meteor/meteor'
 import * as semver from 'semver'
 import {
-	InputFunctionCore,
 	MigrateFunctionCore,
 	MigrationStep,
-	MigrationStepInput,
-	MigrationStepInputFilteredResult,
-	MigrationStepInputResult,
 	ValidateFunctionCore,
 	ValidateFunction,
 	MigrateFunction,
-	InputFunction,
 	MigrationStepCore,
-} from '@sofie-automation/blueprints-integration'
+} from '@sofie-automation/meteor-lib/dist/migrations'
 import _ from 'underscore'
 import {
 	GetMigrationStatusResult,
@@ -24,7 +19,7 @@ import { logger } from '../logging'
 import { internalStoreSystemSnapshot } from '../api/snapshot'
 import { parseVersion, Version } from '../systemStatus/semverUtils'
 import { GENESIS_SYSTEM_VERSION } from '@sofie-automation/meteor-lib/dist/collections/CoreSystem'
-import { clone, getHash, omit } from '@sofie-automation/corelib/dist/lib'
+import { getHash, omit } from '@sofie-automation/corelib/dist/lib'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
 import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyError'
 import { CURRENT_SYSTEM_VERSION } from './currentSystemVersion'
@@ -57,7 +52,7 @@ export function isVersionSupported(version: Version): boolean {
 	return isSupported
 }
 
-interface MigrationStepInternal extends MigrationStep<ValidateFunction, MigrateFunction, InputFunction> {
+interface MigrationStepInternal extends MigrationStep<ValidateFunction, MigrateFunction> {
 	chunk: MigrationChunk
 	_rank: number
 	_version: Version // step version
@@ -92,7 +87,6 @@ export interface PreparedMigration {
 	automaticStepCount: number
 	manualStepCount: number
 	ignoredStepCount: number
-	manualInputs: MigrationStepInput[]
 	partialMigration: boolean
 }
 export async function prepareMigration(returnAllChunks?: boolean): Promise<PreparedMigration> {
@@ -128,7 +122,6 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 			validate: step.validate.bind(step),
 			canBeRunAutomatically: step.canBeRunAutomatically,
 			migrate: step.migrate?.bind(step),
-			input: step.input,
 			dependOnResultFrom: step.dependOnResultFrom,
 			version: step.version,
 			_version: parseVersion(step.version),
@@ -165,9 +158,6 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 	const ignoredSteps: { [id: string]: true } = {}
 	let includesCoreStep = false
 	for (const step of allMigrationSteps) {
-		if (!step.canBeRunAutomatically && (!step.input || (Array.isArray(step.input) && !step.input.length)))
-			throw new Meteor.Error(500, `MigrationStep "${step.id}" is manual, but no input is provided`)
-
 		if (step.chunk.sourceType !== MigrationStepType.CORE && includesCoreStep) {
 			// stop here as core migrations need to be run before anything else can
 			partialMigration = true
@@ -230,39 +220,12 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 	// check if there are any manual steps:
 	// (this makes an automatic migration impossible)
 
-	const manualInputs: Array<MigrationStepInput> = []
 	const stepsHash: Array<string> = []
 	for (const step of Object.values<MigrationStepInternal>(migrationSteps)) {
 		stepsHash.push(step.id)
 		step.chunk._steps.push(step.id)
 		if (!step.canBeRunAutomatically) {
 			manualStepCount++
-
-			if (step.input) {
-				let input: Array<MigrationStepInput> = []
-				if (Array.isArray(step.input)) {
-					input = clone(step.input)
-				} else if (typeof step.input === 'function') {
-					if (step.chunk.sourceType === MigrationStepType.CORE) {
-						const inputFunction = step.input as InputFunctionCore
-						input = inputFunction()
-					} else throw new Meteor.Error(500, `Unknown step.chunk.sourceType "${step.chunk.sourceType}"`)
-				}
-				if (input.length) {
-					for (const i of input) {
-						if (i.label && typeof step._validateResult === 'string') {
-							i.label = (i.label + '').replace(/\$validation/g, step._validateResult)
-						}
-						if (i.description && typeof step._validateResult === 'string') {
-							i.description = (i.description + '').replace(/\$validation/g, step._validateResult)
-						}
-						manualInputs.push({
-							...i,
-							stepId: step.id,
-						})
-					}
-				}
-			}
 		} else {
 			automaticStepCount++
 		}
@@ -288,15 +251,13 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 		automaticStepCount: automaticStepCount,
 		manualStepCount: manualStepCount,
 		ignoredStepCount: ignoredStepCount,
-		manualInputs: manualInputs,
 		partialMigration: partialMigration,
 	}
 }
 
 export async function runMigration(
 	chunks: Array<MigrationChunk>,
 	hash: string,
-	inputResults: Array<MigrationStepInputResult>,
 	isFirstOfPartialMigrations = true,
 	chunksLeft = 20
 ): Promise<RunMigrationResult> {
@@ -310,19 +271,9 @@ export async function runMigration(
 	// Verify the input:
 	const migration = await prepareMigration(true)
 
-	const manualInputsWithUserPrompt = migration.manualInputs.filter((manualInput) => {
-		return !!(manualInput.stepId && manualInput.attribute)
-	})
 	if (migration.hash !== hash)
 		throw new Meteor.Error(500, `Migration input hash differ from expected: "${hash}", "${migration.hash}"`)
 
-	if (manualInputsWithUserPrompt.length !== inputResults.length) {
-		throw new Meteor.Error(
-			500,
-			`Migration manualInput lengths differ from expected: "${inputResults.length}", "${migration.manualInputs.length}"`
-		)
-	}
-
 	// Check that chunks match:
 	let unmatchedChunk = migration.chunks.find((migrationChunk) => {
 		return !chunks.find((chunk) => {
@@ -373,26 +324,16 @@ export async function runMigration(
 		`Migration: ${migration.automaticStepCount} automatic and ${migration.manualStepCount} manual steps (${migration.ignoredStepCount} ignored).`
 	)
 
-	logger.debug(inputResults)
-
 	for (const step of migration.steps) {
 		try {
-			// Prepare input from user
-			const stepInput: MigrationStepInputFilteredResult = {}
-			for (const ir of inputResults) {
-				if (ir.stepId === step.id) {
-					stepInput[ir.attribute] = ir.value
-				}
-			}
-
 			// Run the migration script
 
 			if (step.migrate !== undefined) {
 				logger.info(`Running migration step "${step.id}"`)
 
 				if (step.chunk.sourceType === MigrationStepType.CORE) {
 					const migration = step.migrate as MigrateFunctionCore
-					await migration(stepInput)
+					await migration()
 				} else throw new Meteor.Error(500, `Unknown step.chunk.sourceType "${step.chunk.sourceType}"`)
 			}
 
@@ -431,13 +372,7 @@ export async function runMigration(
 		const s = await getMigrationStatus()
 		if (s.migration.automaticStepCount > 0 || s.migration.manualStepCount > 0) {
 			try {
-				const res = await runMigration(
-					s.migration.chunks,
-					s.migration.hash,
-					inputResults,
-					false,
-					chunksLeft - 1
-				)
+				const res = await runMigration(s.migration.chunks, s.migration.hash, false, chunksLeft - 1)
 				if (res.migrationCompleted) {
 					return res
 				}
@@ -491,7 +426,6 @@ export async function getMigrationStatus(): Promise<GetMigrationStatusResult> {
 		migration: {
 			canDoAutomaticMigration: migration.manualStepCount === 0,
 
-			manualInputs: migration.manualInputs,
 			hash: migration.hash,
 			chunks: migration.chunks,
 

meteor/server/migration/lib.ts

@@ -1,5 +1,5 @@
 import _ from 'underscore'
-import { MigrationStepCore } from '@sofie-automation/blueprints-integration'
+import { MigrationStepCore } from '@sofie-automation/meteor-lib/dist/migrations'
 import { objectPathGet } from '@sofie-automation/corelib/dist/lib'
 import { ProtectedString } from '@sofie-automation/corelib/dist/protectedString'
 import { Meteor } from 'meteor/meteor'

packages/blueprints-integration/src/api/showStyle.ts

@@ -21,7 +21,6 @@ import type {
 } from '../context/index.js'
 import type { IngestAdlib, ExtendedIngestRundown, IngestRundown } from '../ingest.js'
 import type { IBlueprintExternalMessageQueueObj } from '../message.js'
-import type {} from '../migrations.js'
 import type {
 	IBlueprintAdLibPiece,
 	IBlueprintResolvedPieceInstance,

packages/blueprints-integration/src/index.ts

@@ -9,7 +9,6 @@ export * from './ingest.js'
 export * from './ingest-types.js'
 export * from './lib.js'
 export * from './message.js'
-export * from './migrations.js'
 export * from './package.js'
 export * from './packageInfo.js'
 export * from './documents/index.js'