Skip additional config files in workspace execution planner (#3150)

* fix: added files ending with config.yaml as config file

* fix: added config check in case flow parsing fail and then determine if its config

* fix: added config checks

* removed isconfig check, since we handle _config case directly in Filters now

* updated config detection

* fix: tighten config file detection to avoid false positives

- Changed topLevelKeys check from `any` to `all` so only files where
  every top-level key is a WorkspaceConfig property are excluded
- Skip files containing `---` document separator since those are flow
  files, not config files

* fix: resolve config path before filtering flow files (#3159)

fix:resolve_config_path_before_filtering_flow_files

* fix: added files ending with config.yaml as config file

* fix: added config check in case flow parsing fail and then determine if its config

* fix: added config checks

* removed isconfig check, since we handle _config case directly in Filters now

* updated config detection

* fix: tighten config file detection to avoid false positives

- Changed topLevelKeys check from `any` to `all` so only files where
  every top-level key is a WorkspaceConfig property are excluded
- Skip files containing `---` document separator since those are flow
  files, not config files

* fix: warn in case config file has field that is not supported

Author: proksh

maestro-orchestra-models/src/main/java/maestro/orchestra/WorkspaceConfig.kt

@@ -2,6 +2,7 @@ package maestro.orchestra
 
 import com.fasterxml.jackson.annotation.JsonAnySetter
 import com.fasterxml.jackson.annotation.JsonCreator
+import kotlin.reflect.full.declaredMemberProperties
 
 data class WorkspaceConfig(
     val flows: StringList? = null,
@@ -74,4 +75,10 @@ data class WorkspaceConfig(
             }
         }
     }
+
+    companion object {
+        val KNOWN_KEYS: Set<String> by lazy {
+            WorkspaceConfig::class.declaredMemberProperties.map { it.name }.toSet()
+        }
+    }
 }

maestro-orchestra/src/main/java/maestro/orchestra/workspace/Filters.kt

@@ -1,16 +1,29 @@
 package maestro.orchestra.workspace
 
+import maestro.orchestra.yaml.YamlCommandReader
 import java.nio.file.Path
 import kotlin.io.path.absolutePathString
 import kotlin.io.path.extension
 import kotlin.io.path.isRegularFile
 import kotlin.io.path.nameWithoutExtension
+import kotlin.io.path.readText
 
 fun isFlowFile(path: Path, config: Path?): Boolean {
     if (!path.isRegularFile()) return false // Not a file
     if (path.absolutePathString() == config?.absolutePathString()) return false // Config file
     val extension = path.extension
     if (extension != "yaml" && extension != "yml") return false // Not YAML
     if (path.nameWithoutExtension == "config") return false // Config file
-    return true
-}
+
+    return !isWorkspaceConfigFile(path)
+}
+
+private fun isWorkspaceConfigFile(path: Path): Boolean {
+    return try {
+        val content = path.readText()
+        if (content.contains("\n---")) return false // Flow files have a document separator
+        YamlCommandReader.findUnknownWorkspaceConfigKeys(content)?.isEmpty() ?: false
+    } catch (e: Exception) {
+        false
+    }
+}

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

@@ -21,19 +21,24 @@ package maestro.orchestra.yaml
 
 import com.fasterxml.jackson.core.JsonLocation
 import com.fasterxml.jackson.core.JsonProcessingException
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
 import maestro.orchestra.ApplyConfigurationCommand
 import maestro.orchestra.MaestroCommand
 import maestro.orchestra.MaestroConfig
 import maestro.orchestra.WorkspaceConfig
 import maestro.orchestra.error.SyntaxError
 import maestro.utils.drawTextBox
+import org.slf4j.LoggerFactory
 import java.nio.file.Path
 import java.nio.file.Paths
 import kotlin.io.path.absolutePathString
 import kotlin.io.path.readText
 
 object YamlCommandReader {
 
+    private val logger = LoggerFactory.getLogger(YamlCommandReader::class.java)
+
     // If it exists, automatically resolves the initFlow file and inlines the commands into the config
     fun readCommands(flowPath: Path): List<MaestroCommand> = mapParsingErrors(flowPath) {
         val flow = flowPath.readText()
@@ -49,12 +54,40 @@ object YamlCommandReader {
         MaestroFlowParser.parseConfigOnly(flowPath, flow)
     }
 
+    private val YAML_MAPPER by lazy { ObjectMapper(YAMLFactory()) }
+
     fun readWorkspaceConfig(configPath: Path): WorkspaceConfig = mapParsingErrors(configPath) {
         val config = configPath.readText()
         if (config.isBlank()) return@mapParsingErrors WorkspaceConfig()
+        validateWorkspaceConfigKeys(configPath, config)
         MaestroFlowParser.parseWorkspaceConfig(configPath, config)
     }
 
+    private fun validateWorkspaceConfigKeys(configPath: Path, config: String) {
+        val unknownKeys = findUnknownWorkspaceConfigKeys(config) ?: return
+        if (unknownKeys.isNotEmpty()) {
+            logger.warn(
+                "Config file '{}' contains unknown keys: {}. Valid keys are: {}",
+                configPath.absolutePathString(),
+                unknownKeys,
+                WorkspaceConfig.KNOWN_KEYS.sorted(),
+            )
+        }
+    }
+
+    /**
+     * Returns the list of top-level keys in the config that are not recognized WorkspaceConfig properties,
+     * or null if the content cannot be parsed as a YAML map.
+     */
+    internal fun findUnknownWorkspaceConfigKeys(config: String): List<Any?>? {
+        val topLevelKeys = try {
+            YAML_MAPPER.readValue(config, Map::class.java)?.keys ?: return null
+        } catch (e: Exception) {
+            return null
+        }
+        return topLevelKeys.filter { it !in WorkspaceConfig.KNOWN_KEYS }
+    }
+
     // Files to watch for changes. Includes any referenced files.
     fun getWatchFiles(flowPath: Path): List<Path> = mapParsingErrors(flowPath) {
         MaestroFlowParser.parseWatchFiles(flowPath)

maestro-orchestra/src/test/java/maestro/orchestra/workspace/WorkspaceExecutionPlannerTest.kt

@@ -359,6 +359,24 @@ internal class WorkspaceExecutionPlannerTest {
         )
     }
 
+    @Test
+    internal fun `018 - Additional config files in workspace are not treated as flows`() {
+        // When
+        val plan = WorkspaceExecutionPlanner.plan(
+            input = paths("/workspaces/018_additional_config_files"),
+            includeTags = listOf(),
+            excludeTags = listOf(),
+            config = null,
+        )
+
+        // Then - regression_config.yaml and platform_settings.yaml should be excluded, only flow files should be included
+        assertThat(plan.flowsToRun).containsExactly(
+            path("/workspaces/018_additional_config_files/flowA.yaml"),
+            path("/workspaces/018_additional_config_files/flowB.yaml"),
+        )
+    }
+
+
     private fun path(path: String): Path? {
         val clazz = WorkspaceExecutionPlannerTest::class.java
         val resource = clazz.getResource(path)?.toURI()

maestro-orchestra/src/test/java/maestro/orchestra/yaml/YamlCommandReaderTest.kt

@@ -826,6 +826,41 @@ internal class YamlCommandReaderTest {
     }
 
 
+    @Test
+    fun `findUnknownWorkspaceConfigKeys returns empty for valid keys`() {
+        val config = """
+            flows:
+              - "*"
+            includeTags:
+              - smoke
+        """.trimIndent()
+        assertThat(YamlCommandReader.findUnknownWorkspaceConfigKeys(config)).isEmpty()
+    }
+
+    @Test
+    fun `findUnknownWorkspaceConfigKeys detects unknown keys`() {
+        val config = """
+            flows:
+              - "*"
+            tapOn: some button
+            invalidKey: true
+        """.trimIndent()
+        assertThat(YamlCommandReader.findUnknownWorkspaceConfigKeys(config))
+            .containsExactly("tapOn", "invalidKey")
+    }
+
+    @Test
+    fun `findUnknownWorkspaceConfigKeys returns null for malformed yaml`() {
+        val config = "not: valid: yaml: ["
+        assertThat(YamlCommandReader.findUnknownWorkspaceConfigKeys(config)).isNull()
+    }
+
+    @Test
+    fun `findUnknownWorkspaceConfigKeys returns null for non-map yaml`() {
+        val config = "- launchApp"
+        assertThat(YamlCommandReader.findUnknownWorkspaceConfigKeys(config)).isNull()
+    }
+
     private fun commands(vararg commands: Command): List<MaestroCommand> =
         commands.map(::MaestroCommand).toList()
 }

maestro-orchestra/src/test/resources/workspaces/018_additional_config_files/config.yaml

@@ -0,0 +1,2 @@
+includeTags:
+  - included

maestro-orchestra/src/test/resources/workspaces/018_additional_config_files/flowA.yaml

@@ -0,0 +1,5 @@
+appId: com.example.app
+tags:
+  - included
+---
+- launchApp

maestro-orchestra/src/test/resources/workspaces/018_additional_config_files/flowB.yaml

@@ -0,0 +1,5 @@
+appId: com.example.app
+tags:
+  - included
+---
+- launchApp

maestro-orchestra/src/test/resources/workspaces/018_additional_config_files/platform_settings.yaml

@@ -0,0 +1,5 @@
+platform:
+  ios:
+    disableAnimations: true
+  android:
+    disableAnimations: true

maestro-orchestra/src/test/resources/workspaces/018_additional_config_files/regression_config.yaml

@@ -0,0 +1,5 @@
+platform:
+  ios:
+    disableAnimations: true
+  android:
+    disableAnimations: true