maestro: handle config.yaml and config.yml

Author: jochen-testingbot

src/providers/maestro.ts

@@ -466,7 +466,7 @@ export default class Maestro extends BaseProvider<MaestroOptions> {
           (f) =>
             f.endsWith('.yaml') || f.endsWith('.yml'),
         ).filter(
-          (f) => !f.endsWith('config.yaml'),
+          (f) => !this.isConfigFile(f),
         ).length,
         shardSplit: this.options.shardSplit,
       });
@@ -508,15 +508,20 @@ export default class Maestro extends BaseProvider<MaestroOptions> {
     });
 
     const flowFiles: string[] = [];
-    const configPath = path.join(directory, 'config.yaml');
+    let configPath: string | null = null;
     let config: MaestroConfig | null = null;
 
-    // Check for config.yaml
-    try {
-      const configContent = await fs.promises.readFile(configPath, 'utf-8');
-      config = yaml.load(configContent) as MaestroConfig;
-    } catch {
-      // No config.yaml, that's fine
+    // Check for config.yaml or config.yml
+    for (const configName of ['config.yaml', 'config.yml']) {
+      const candidatePath = path.join(directory, configName);
+      try {
+        const configContent = await fs.promises.readFile(candidatePath, 'utf-8');
+        config = yaml.load(configContent) as MaestroConfig;
+        configPath = candidatePath;
+        break; // Use the first config file found
+      } catch {
+        // Config file doesn't exist, try next
+      }
     }
 
     // If config specifies flows, use those
@@ -532,7 +537,7 @@ export default class Maestro extends BaseProvider<MaestroOptions> {
           const ext = path.extname(entry.name).toLowerCase();
           if (
             (ext === '.yaml' || ext === '.yml') &&
-            entry.name !== 'config.yaml'
+            !this.isConfigFile(entry.name)
           ) {
             flowFiles.push(path.join(directory, entry.name));
           }
@@ -547,8 +552,8 @@ export default class Maestro extends BaseProvider<MaestroOptions> {
       dependencies.forEach((dep) => allFiles.add(dep));
     }
 
-    // Include config.yaml if it exists
-    if (config) {
+    // Include config file if it exists
+    if (configPath) {
       allFiles.add(configPath);
     }
 
@@ -597,6 +602,14 @@ export default class Maestro extends BaseProvider<MaestroOptions> {
     return dependencies;
   }
 
+  /**
+   * Check if a file path is a Maestro config file (config.yaml or config.yml)
+   */
+  private isConfigFile(filePath: string): boolean {
+    const basename = path.basename(filePath);
+    return basename === 'config.yaml' || basename === 'config.yml';
+  }
+
   /**
    * Check if a string looks like a file path (relative path with extension)
    */
@@ -1116,7 +1129,7 @@ export default class Maestro extends BaseProvider<MaestroOptions> {
     for (const filePath of relativePaths) {
       const ext = path.extname(filePath).toLowerCase();
       if (ext === '.yaml' || ext === '.yml') {
-        if (filePath === 'config.yaml' || filePath.endsWith('/config.yaml')) {
+        if (this.isConfigFile(filePath)) {
           groups['Config files'].push(filePath);
         } else {
           groups['Flow files'].push(filePath);

tests/providers/maestro.test.ts

@@ -2937,6 +2937,69 @@ flows:
         path.join(projectDir, 'web', 'flows', 'test.yaml'),
       );
     });
+
+    it('should include config.yml (alternative extension) in discovered files when it exists', async () => {
+      const configContent = `
+flows:
+  - "app/flows/**"
+`;
+      const projectDir = path.resolve(path.sep, 'project');
+      // First call (config.yaml) fails, second call (config.yml) succeeds
+      fs.promises.readFile = jest.fn()
+        .mockRejectedValueOnce(new Error('ENOENT: no such file'))
+        .mockResolvedValueOnce(configContent);
+      fs.promises.readdir = jest.fn().mockResolvedValue([]);
+      fs.promises.access = jest.fn().mockResolvedValue(undefined);
+      (glob as jest.Mock).mockResolvedValue([
+        path.join(projectDir, 'app', 'flows', 'login.yaml'),
+      ]);
+
+      const files = await maestro['discoverFlows'](projectDir);
+
+      expect(files).toContain(path.join(projectDir, 'config.yml'));
+      expect(files).not.toContain(path.join(projectDir, 'config.yaml'));
+      expect(files).toContain(
+        path.join(projectDir, 'app', 'flows', 'login.yaml'),
+      );
+    });
+
+    it('should prefer config.yaml over config.yml when both exist', async () => {
+      const configContent = `
+flows:
+  - "flows/**"
+`;
+      const projectDir = path.resolve(path.sep, 'project');
+      // First call (config.yaml) succeeds
+      fs.promises.readFile = jest.fn().mockResolvedValue(configContent);
+      fs.promises.readdir = jest.fn().mockResolvedValue([]);
+      fs.promises.access = jest.fn().mockResolvedValue(undefined);
+      (glob as jest.Mock).mockResolvedValue([
+        path.join(projectDir, 'flows', 'test.yaml'),
+      ]);
+
+      const files = await maestro['discoverFlows'](projectDir);
+
+      // Should only include config.yaml, not config.yml
+      expect(files).toContain(path.join(projectDir, 'config.yaml'));
+      expect(files).not.toContain(path.join(projectDir, 'config.yml'));
+    });
+
+    it('should exclude config.yml from flow files when no config exists', async () => {
+      const projectDir = path.resolve(path.sep, 'project');
+      // Both config.yaml and config.yml fail
+      fs.promises.readFile = jest.fn()
+        .mockRejectedValue(new Error('ENOENT: no such file'));
+      fs.promises.readdir = jest.fn().mockResolvedValue([
+        { name: 'flow1.yaml', isFile: () => true },
+        { name: 'config.yml', isFile: () => true },  // Should be excluded as a config file
+      ]);
+      fs.promises.access = jest.fn().mockResolvedValue(undefined);
+
+      const files = await maestro['discoverFlows'](projectDir);
+
+      expect(files).toContain(path.join(projectDir, 'flow1.yaml'));
+      expect(files).not.toContain(path.join(projectDir, 'config.yml'));
+    });
   });
 
   describe('Flow Status Display', () => {