FEATURE: support alternative names for the prunner config file

Author: christoph-daehne

Classes/Controller/ProxyController.php

@@ -22,6 +22,12 @@ class ProxyController extends \Neos\Flow\Mvc\Controller\ActionController
      */
     protected $directory;
 
+    /**
+     * @Flow\InjectConfiguration(path="configFile")
+     * @var string
+     */
+    protected $configFile;
+
     /**
      * @Flow\InjectConfiguration(path="jwtSecret")
      * @var string
@@ -56,9 +62,8 @@ public function indexAction(string $path, string $subpath)
         } else {
             try {
                 // Try to parse prunner config to get JWT secret
-                $config = Yaml::parseFile($this->directory . '/.prunner.yml');
-                $jwtSecret = $config['jwt_secret'];
-            } catch (ParseException $e) {
+                $jwtSecret = $this->loadJwtSecretFromConfigFile();
+            } catch (\RuntimeException $e) {
                 $this->response->setContentType('application/json');
                 $this->response->setStatusCode(500);
                 return json_encode(['error' => 'Invalid prunner configuration (could not read JWT secret)']);
@@ -87,4 +92,26 @@ public function indexAction(string $path, string $subpath)
 
         return $response->getBody();
     }
+
+    /**
+     * @return string
+     */
+    private function loadJwtSecretFromConfigFile(): string
+    {
+        if ($this->configFile && file_exists($this->configFile)) {
+            $path = $this->configFile;
+        } elseif ($this->directory && file_exists($this->directory . '/.prunner.yml')) {
+            $path = $this->directory . '/.prunner.yml';
+        } else {
+            throw new \RuntimeException("Failed to locate prunner config file at " . $this->configFile . " or " . $this->directory . '/.prunner.yml');
+        }
+        try {
+            // Try to parse prunner config to get JWT secret
+            $config = Yaml::parseFile($path);
+            $jwtSecret = $config['jwt_secret'];
+        } catch (ParseException $e) {
+            throw new \RuntimeException('Invalid prunner configuration (could not read JWT secret)');
+        }
+        return $jwtSecret;
+    }
 }

Classes/PrunnerApiService.php

@@ -32,6 +32,12 @@ class PrunnerApiService
      */
     protected $directory;
 
+    /**
+     * @Flow\InjectConfiguration(path="configFile")
+     * @var string
+     */
+    protected $configFile;
+
     /**
      * @Flow\InjectConfiguration(path="jwtSecret")
      * @var string
@@ -103,13 +109,7 @@ public function apiCall(string $method, string $subpath, ?string $body): Respons
         if (!empty($this->jwtSecret)) {
             $jwtSecret = $this->jwtSecret;
         } else {
-            try {
-                // Try to parse prunner config to get JWT secret
-                $config = Yaml::parseFile($this->directory . '/.prunner.yml');
-                $jwtSecret = $config['jwt_secret'];
-            } catch (ParseException $e) {
-                throw new \RuntimeException('Invalid prunner configuration (could not read JWT secret)');
-            }
+            $jwtSecret = $this->loadJwtSecretFromConfigFile();
         }
 
         // There are usecases where we want to call prunner from the CLI. We don't have an initialized user there, thus we
@@ -122,4 +122,25 @@ public function apiCall(string $method, string $subpath, ?string $body): Respons
         return $client->request($method, $url, ['headers' => ['Authorization' => 'Bearer ' . $authToken], 'body' => $body, 'http_errors' => false]);
     }
 
+    /**
+     * @return string
+     */
+    private function loadJwtSecretFromConfigFile(): string
+    {
+        if ($this->configFile && file_exists($this->configFile)) {
+            $path = $this->configFile;
+        } elseif ($this->directory && file_exists($this->directory . '/.prunner.yml')) {
+            $path = $this->directory . '/.prunner.yml';
+        } else {
+            throw new \RuntimeException("Failed to locate prunner config file at " . $this->configFile . " or " . $this->directory . '/.prunner.yml');
+        }
+        try {
+            // Try to parse prunner config to get JWT secret
+            $config = Yaml::parseFile($path);
+            $jwtSecret = $config['jwt_secret'];
+        } catch (ParseException $e) {
+            throw new \RuntimeException('Invalid prunner configuration (could not read JWT secret)');
+        }
+        return $jwtSecret;
+    }
 }

Configuration/Settings.yaml

@@ -3,7 +3,10 @@ Flowpack:
     # Base URL to prunner API
     apiBaseUrl: 'http://localhost:9009/'
     # Working directory of prunner for loading config
+    # DEPRECATED: use configFile
     directory: '%FLOW_PATH_ROOT%'
+    # Path to the prunner config file to load the JWT secret for authentication
+    configFile: '%FLOW_PATH_ROOT%/.prunner.yml'
     # Explicitly set JWT secret if prunner config is not accessible
     jwtSecret: ~