initFlow should be deprecated and removed

[bartekpacia]

Code in question:

maestro/maestro-orchestra/src/main/java/maestro/orchestra/Orchestra.kt

Lines 146 to 170 in d23a25f

	/**
	* Run the initFlow and return the resulting app OrchestraAppState which can be used to initialize
	* app disk state when past into Orchestra.runFlow.
	*/
	fun runInitFlow(
	initFlow: MaestroInitFlow,
	): OrchestraAppState? {
	val success = runFlow(
	initFlow.commands,
	)
	if (!success) return null
	maestro.stopApp(initFlow.appId)
	val stateFile = if (stateDir == null) {
	Files.createTempFile(null, ".state")
	} else {
	Files.createTempFile(stateDir.toPath(), null, ".state")
	}
	return OrchestraAppState(
	appId = initFlow.appId,
	file = stateFile.toFile(),
	)
	}

citing @igorsmotto on Slack:

IIRC that's legacy, and we removed from the docs so people won't use it. But we didn't remove because there might be some customer still using it, so we don't want to break for them

The use case itself is the same one after being reintroduced as onFlowStart and onFlowComplete that you can find in the docs

Plan:

• Add warning whenever initFlow is provided
• Remove related code from maestro and monorepo
• Afte some time (2 weeks? a month?) remove support completely. If someone complains, guide them to either use an older version (not recommended), or migrate to onFlowStart

[bartekpacia]

Actually, the warning is already there:

maestro/maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlConfig.kt

Lines 33 to 38 in bfec5dd

	fun toCommand(flowPath: Path): MaestroCommand {
	if (initFlow != null) {
	throw MaestroException.DeprecatedCommand("initFlow command used at: $flowPath is deprecated, please use " +
	"onFlowStart/onFlowComplete hooks instead. Have a look at the documentation here: " +
	"https://maestro.mobile.dev/advanced/onflowstart-onflowcomplete-hooks")
	}

It was added in #1318

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar problem, please file a new issue. Make sure to follow the template and provide all the information necessary to reproduce the issue.
Thank you for helping keep us our issue tracker clean!