Fix : correctly resolve env parameters, so they are also accessible to onStart/Complete hooks (#1263)

* execute DefineVariablesCommand before the hooks so that env variable are also accessible to the hooks commands

* fix comments

* fix the case when multiple DefineVariablesCommand are present

Author: artem888

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

@@ -98,6 +98,10 @@ class Orchestra(
 
         onFlowStart(commands)
 
+        executeDefineVariablesCommands(commands, config)
+        // filter out DefineVariablesCommand to not execute it twice
+        val filteredCommands = commands.filter { it.asCommand() !is DefineVariablesCommand }
+
         config?.onFlowStart?.commands?.let {
             executeCommands(
                 commands = it,
@@ -108,7 +112,7 @@ class Orchestra(
 
         try {
             val flowSuccess = executeCommands(
-                commands = commands,
+                commands = filteredCommands,
                 config = config,
                 shouldReinitJsEngine = false,
             ).also {
@@ -571,12 +575,16 @@ class Orchestra(
     }
 
     private fun runSubFlow(commands: List<MaestroCommand>, config: MaestroConfig?, subflowConfig: MaestroConfig?): Boolean {
+        executeDefineVariablesCommands(commands, config)
+        // filter out DefineVariablesCommand to not execute it twice
+        val filteredCommands = commands.filter { it.asCommand() !is DefineVariablesCommand }
+
         subflowConfig?.onFlowStart?.commands?.let {
             executeSubflowCommands(it, config)
         }
 
         try {
-            return executeSubflowCommands(commands, config)
+            return executeSubflowCommands(filteredCommands, config)
         } finally {
             subflowConfig?.onFlowComplete?.commands?.let {
                 executeSubflowCommands(it, config)
@@ -998,6 +1006,16 @@ class Orchestra(
         return true
     }
 
+    private fun executeDefineVariablesCommands(commands: List<MaestroCommand>, config: MaestroConfig?) {
+        commands.filter { it.asCommand() is DefineVariablesCommand }.takeIf { it.isNotEmpty() }?.let {
+            executeCommands(
+                commands = it,
+                config = config,
+                shouldReinitJsEngine = false
+            )
+        }
+    }
+
     private object CommandSkipped : Exception()
 
     data class CommandMetadata(

maestro-test/src/test/kotlin/maestro/test/IntegrationTest.kt

@@ -2881,7 +2881,7 @@ class IntegrationTest {
 
     @Test
     fun `Case 106 - execute onFlowStart and onFlowComplete when js output is set with subflows`() {
-// Given
+        // Given
         val commands = readCommands("106_on_flow_start_complete_when_js_output_set_subflows")
 
         val driver = driver {
@@ -2906,6 +2906,37 @@ class IntegrationTest {
         ).inOrder()
     }
 
+    @Test
+    fun `Case 107 - execute defineVariablesCommand before onFlowStart and onFlowComplete are executed`() {
+        // Given
+        val commands = readCommands("107_define_variables_command_before_hooks")
+
+        val driver = driver {
+        }
+        driver.addInstalledApp("com.example.app")
+        val receivedLogs = mutableListOf<String>()
+
+        // when
+        Maestro(driver).use {
+            orchestra(
+                it,
+                onCommandMetadataUpdate = { _, metadata ->
+                    receivedLogs += metadata.logMessages
+                }
+            ).runFlow(commands)
+        }
+
+        // Then
+        assertThat(receivedLogs).containsExactly(
+            "com.example.app",
+        ).inOrder()
+        driver.assertEvents(
+            listOf(
+                Event.LaunchApp("com.example.app")
+            )
+        )
+    }
+
     private fun orchestra(
         maestro: Maestro,
     ) = Orchestra(

maestro-test/src/test/resources/107_define_variables_command_before_hooks.yaml

@@ -0,0 +1,8 @@
+appId: ${MAESTRO_APP_ID}
+env:
+  MAESTRO_APP_ID: com.example.app
+onFlowStart:
+  - launchApp:
+      appId: ${MAESTRO_APP_ID}
+---
+- evalScript: ${ console.log(MAESTRO_APP_ID); }