fix: remove manualStep count tracking

Author: Julusian

meteor/server/coreSystem/index.ts

@@ -84,7 +84,7 @@ async function initializeCoreSystem() {
 		if (!isRunningInJest()) {
 			// Check what migration has to provide:
 			const migration = await prepareMigration(true)
-			if (migration.migrationNeeded && migration.manualStepCount === 0 && migration.chunks.length <= 1) {
+			if (migration.migrationNeeded && 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)
 			}

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

@@ -5,7 +5,7 @@ import { clearMigrationSteps, addMigrationSteps, prepareMigration, PreparedMigra
 import { CURRENT_SYSTEM_VERSION } from '../currentSystemVersion'
 import { RunMigrationResult, GetMigrationStatusResult } from '@sofie-automation/meteor-lib/dist/api/migration'
 import { protectString } from '@sofie-automation/corelib/dist/protectedString'
-import { MigrationStepCore } from '@sofie-automation/blueprints-integration'
+import { MigrationStepCore } from '@sofie-automation/meteor-lib/dist/migrations'
 import { DBStudio } from '@sofie-automation/corelib/dist/dataModel/Studio'
 import { MeteorCall } from '../../api/methods'
 import { wrapDefaultObject } from '@sofie-automation/corelib/dist/settings/objectWithOverrides'
@@ -47,11 +47,8 @@ describe('Migrations', () => {
 			migrationNeeded: true,
 
 			migration: {
-				canDoAutomaticMigration: true,
-				// manualInputs: [],
 				hash: expect.stringContaining(''),
 				automaticStepCount: expect.any(Number),
-				manualStepCount: expect.any(Number),
 				ignoredStepCount: expect.any(Number),
 				partialMigration: true,
 				// chunks: expect.any(Array)
@@ -258,8 +255,7 @@ describe('Migrations', () => {
 		const migrationStatus: GetMigrationStatusResult = await MeteorCall.migration.getMigrationStatus()
 		const migrationResult: RunMigrationResult = await MeteorCall.migration.runMigration(
 			migrationStatus.migration.chunks,
-			migrationStatus.migration.hash,
-			userInput(migrationStatus)
+			migrationStatus.migration.hash
 		)
 
 		expect(migrationResult.migrationCompleted).toEqual(true)

meteor/server/migration/databaseMigration.ts

@@ -85,7 +85,6 @@ export interface PreparedMigration {
 	steps: MigrationStepInternal[]
 	migrationNeeded: boolean
 	automaticStepCount: number
-	manualStepCount: number
 	ignoredStepCount: number
 	partialMigration: boolean
 }
@@ -148,7 +147,6 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 	})
 
 	let automaticStepCount = 0
-	let manualStepCount = 0
 	let ignoredStepCount = 0
 
 	let partialMigration = false
@@ -224,11 +222,8 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 	for (const step of Object.values<MigrationStepInternal>(migrationSteps)) {
 		stepsHash.push(step.id)
 		step.chunk._steps.push(step.id)
-		if (!step.canBeRunAutomatically) {
-			manualStepCount++
-		} else {
-			automaticStepCount++
-		}
+
+		automaticStepCount++
 	}
 
 	// Only return the chunks which has steps in them:
@@ -249,7 +244,6 @@ export async function prepareMigration(returnAllChunks?: boolean): Promise<Prepa
 		steps: steps,
 		migrationNeeded: migrationNeeded,
 		automaticStepCount: automaticStepCount,
-		manualStepCount: manualStepCount,
 		ignoredStepCount: ignoredStepCount,
 		partialMigration: partialMigration,
 	}
@@ -320,9 +314,7 @@ export async function runMigration(
 		}
 	}
 
-	logger.info(
-		`Migration: ${migration.automaticStepCount} automatic and ${migration.manualStepCount} manual steps (${migration.ignoredStepCount} ignored).`
-	)
+	logger.info(`Migration: ${migration.automaticStepCount} steps (${migration.ignoredStepCount} ignored).`)
 
 	for (const step of migration.steps) {
 		try {
@@ -365,12 +357,12 @@ export async function runMigration(
 
 	let migrationCompleted = false
 
-	if (migration.manualStepCount === 0 && !warningMessages.length) {
+	if (!warningMessages.length) {
 		// continue automatically with the next batch
 		logger.info('Migration: Automatically continuing with next batch..')
 		migration.partialMigration = false
 		const s = await getMigrationStatus()
-		if (s.migration.automaticStepCount > 0 || s.migration.manualStepCount > 0) {
+		if (s.migration.automaticStepCount > 0) {
 			try {
 				const res = await runMigration(s.migration.chunks, s.migration.hash, false, chunksLeft - 1)
 				if (res.migrationCompleted) {
@@ -424,13 +416,10 @@ export async function getMigrationStatus(): Promise<GetMigrationStatusResult> {
 		migrationNeeded: migration.migrationNeeded,
 
 		migration: {
-			canDoAutomaticMigration: migration.manualStepCount === 0,
-
 			hash: migration.hash,
 			chunks: migration.chunks,
 
 			automaticStepCount: migration.automaticStepCount,
-			manualStepCount: migration.manualStepCount,
 			ignoredStepCount: migration.ignoredStepCount,
 			partialMigration: migration.partialMigration,
 		},

meteor/server/migration/steps/X_X_X/ContainerIdsToObjectWithOverridesMigrationStep.ts

@@ -1,4 +1,4 @@
-import { MigrationStepCore } from '@sofie-automation/blueprints-integration'
+import { MigrationStepCore } from '@sofie-automation/meteor-lib/dist/migrations'
 import { Studios } from '../../../collections'
 import {
 	convertObjectIntoOverrides,

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

@@ -101,10 +101,8 @@ export interface GetMigrationStatusResult {
 	migrationNeeded: boolean
 
 	migration: {
-		canDoAutomaticMigration: boolean
 		hash: string
 		automaticStepCount: number
-		manualStepCount: number
 		ignoredStepCount: number
 		partialMigration: boolean
 		chunks: Array<MigrationChunk>

packages/meteor-lib/src/migrations.ts

@@ -13,7 +13,7 @@ export interface MigrationStepBase<TValidate extends ValidateFunction, TMigrate
 	/**
 	 * The validate function determines whether the step is to be applied
 	 * (it can for example check that some value in the database is present)
-	 * The function should return falsy if step is fullfilled (ie truthy if migrate function should be applied, return value could then be a string describing why)
+	 * The function should return falsy if step is fulfilled (ie truthy if migrate function should be applied, return value could then be a string describing why)
 	 * The function is also run after the migration-script has been applied (and should therefore return false if all is good)
 	 */
 	validate: TValidate

packages/webui/src/client/ui/Settings/Migration.tsx

@@ -24,12 +24,10 @@ interface IState {
 	showAllSteps: boolean
 
 	migration?: {
-		canDoAutomaticMigration: boolean
 		hash: string
 		chunks: Array<MigrationChunk>
 		automaticStepCount: number
 		ignoredStepCount: number
-		manualStepCount: number
 		partialMigration: boolean
 	}
 	warnings: Array<string>
@@ -218,9 +216,10 @@ export const MigrationView = translateWithTracker<IProps, IState, ITrackedProps>
 								<h2 className="my-4">{t('Migrate database')}</h2>
 
 								<p>
-									{t(
-										`This migration consists of ${this.state.migration.automaticStepCount} automatic steps and  ${this.state.migration.manualStepCount} manual steps (${this.state.migration.ignoredStepCount} steps are ignored).`
-									)}
+									{t(`This migration consists of {{stepCount}} steps ({{ignoredStepCount}} steps are ignored).`, {
+										stepCount: this.state.migration.automaticStepCount,
+										ignoredStepCount: this.state.migration.ignoredStepCount,
+									})}
 								</p>
 
 								<table className="table expando migration-steps-table">
@@ -264,40 +263,17 @@ export const MigrationView = translateWithTracker<IProps, IState, ITrackedProps>
 										)}
 									</p>
 								) : null}
-								{this.state.migration.canDoAutomaticMigration ? (
-									<div>
-										<p>{t('The migration can be completed automatically.')}</p>
-										<Button
-											onClick={() => {
-												this.runMigration()
-											}}
-										>
-											<FontAwesomeIcon icon={faDatabase} className="me-2" />
-											<span>{t('Run automatic migration procedure')}</span>
-										</Button>
-									</div>
-								) : (
-									<div>
-										<p className="my-2">
-											{t('The migration procedure needs some help from you in order to complete, see below:')}
-										</p>
-										<button
-											className="btn btn-primary mt-4"
-											onClick={() => {
-												doModalDialog({
-													title: t('Double-check Values'),
-													message: t('Are you sure the values you have entered are correct?'),
-													onAccept: () => {
-														this.runMigration()
-													},
-												})
-											}}
-										>
-											<FontAwesomeIcon icon={faClipboardCheck} className="me-2" />
-											<span>{t('Run Migration Procedure')}</span>
-										</button>
-									</div>
-								)}
+								<div>
+									<p>{t('The migration can be completed automatically.')}</p>
+									<Button
+										onClick={() => {
+											this.runMigration()
+										}}
+									>
+										<FontAwesomeIcon icon={faDatabase} className="me-2" />
+										<span>{t('Run automatic migration procedure')}</span>
+									</Button>
+								</div>
 
 								{this.state.warnings.length ? (
 									<div>