Merge pull request #8640 from ProcessMaker/observation/FOUR-28341

FOUR-28341: Improve Error Handling for Smart Extract Subprocess

Author: sanjacornelius

ProcessMaker/Jobs/ErrorHandling.php

@@ -210,10 +210,59 @@ public function setDefaultsFromDataSourceConfig(array $config)
     public static function convertResponseToException($result)
     {
         if ($result['status'] === 'error') {
-            if (str_starts_with($result['message'], 'Command exceeded timeout of')) {
-                throw new ScriptTimeoutException($result['message']);
+            $rawMessage = $result['message'] ?? '';
+            if (str_starts_with((string) $rawMessage, 'Command exceeded timeout of')) {
+                throw new ScriptTimeoutException((string) $rawMessage);
+            }
+
+            $message = self::extractScriptErrorMessage($result);
+
+            if (empty($message)) {
+                $message = $rawMessage ?: 'Script execution failed with unknown error';
+            }
+
+            throw new ScriptException($message);
+        }
+    }
+
+    /**
+     * Extract a concise error message from the microservice response.
+     */
+    private static function extractScriptErrorMessage(array $result): string
+    {
+        $candidates = [
+            $result['output']['error'] ?? null,
+            $result['output']['exception'] ?? null,
+            $result['output']['stderr'] ?? null,
+            $result['output']['stdout'] ?? null,
+            $result['message'] ?? null,
+        ];
+
+        foreach ($candidates as $candidate) {
+            if (is_string($candidate) || is_numeric($candidate)) {
+                $short = self::shortenMessage((string) $candidate);
+                if (!empty($short)) {
+                    return $short;
+                }
             }
-            throw new ScriptException($result['message']);
         }
+
+        return '';
+    }
+
+    /**
+     * Keep only the first line of the error and limit its length to avoid noisy traces.
+     */
+    private static function shortenMessage(string $message): string
+    {
+        $firstLine = strtok($message, "\n");
+        $firstLine = $firstLine === false ? $message : $firstLine;
+        $trimmed = trim($firstLine);
+
+        if (strlen($trimmed) > 400) {
+            return substr($trimmed, 0, 400) . '…';
+        }
+
+        return $trimmed;
     }
 }

tests/unit/ErrorHandlingTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use ProcessMaker\Exception\ScriptException;
+use ProcessMaker\Exception\ScriptTimeoutException;
+use ProcessMaker\Jobs\ErrorHandling;
+
+class ErrorHandlingTest extends TestCase
+{
+    public function testUsesOutputErrorOverGenericMessage(): void
+    {
+        $result = [
+            'status' => 'error',
+            'message' => 'Generic failure',
+            'output' => [
+                'error' => 'SMART_EXTRACT_API_HOST is required but could not be resolved',
+            ],
+        ];
+
+        $this->expectException(ScriptException::class);
+        $this->expectExceptionMessage('SMART_EXTRACT_API_HOST is required but could not be resolved');
+
+        ErrorHandling::convertResponseToException($result);
+    }
+
+    public function testPrefersStderrAndKeepsOnlyFirstLine(): void
+    {
+        $result = [
+            'status' => 'error',
+            'message' => 'fallback message',
+            'output' => [
+                'stderr' => "First line of error\nstack trace line 2\nstack trace line 3",
+            ],
+        ];
+
+        $this->expectException(ScriptException::class);
+        $this->expectExceptionMessage('First line of error');
+
+        ErrorHandling::convertResponseToException($result);
+    }
+
+    public function testTimeoutErrorThrowsScriptTimeoutException(): void
+    {
+        $result = [
+            'status' => 'error',
+            'message' => 'Command exceeded timeout of 120 seconds',
+        ];
+
+        $this->expectException(ScriptTimeoutException::class);
+        $this->expectExceptionMessage('Command exceeded timeout of 120 seconds');
+
+        ErrorHandling::convertResponseToException($result);
+    }
+
+    public function testFallsBackToRawMessageWhenNoOutputPresent(): void
+    {
+        $result = [
+            'status' => 'error',
+            'message' => 'Plain failure',
+        ];
+
+        $this->expectException(ScriptException::class);
+        $this->expectExceptionMessage('Plain failure');
+
+        ErrorHandling::convertResponseToException($result);
+    }
+}