Start refactoring for async script microservice

nolanpro · Jan 22, 2025 · Jan 22, 2025 · Jan 25, 2025 · Jan 27, 2025 · Jan 25, 2025
commit d27abb22726d09e8efa317ca509143fbdc624d14
diff --git a/ProcessMaker/Jobs/ErrorHandling.php b/ProcessMaker/Jobs/ErrorHandling.php
@@ -2,6 +2,7 @@
 
 namespace ProcessMaker\Jobs;
 
+use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Notification;
@@ -12,7 +13,10 @@
 use ProcessMaker\Models\ProcessRequestToken;
 use ProcessMaker\Models\Script;
 use ProcessMaker\Models\ScriptVersion;
+use ProcessMaker\Nayra\Contracts\Bpmn\ActivityInterface;
+use ProcessMaker\Nayra\Contracts\Bpmn\ScriptTaskInterface;
 use ProcessMaker\Notifications\ErrorExecutionNotification;
+use Throwable;
 
 class ErrorHandling
 {
@@ -35,29 +39,52 @@ class ErrorHandling
      */
     public $defaultErrorHandling = [];
 
+    public $job;
+
+    public $exception;
+
+    public $metadata;
+
     public function __construct(
-        public $element,
-        public $processRequestToken,
+        public ActivityInterface $element,
+        public ProcessRequestToken $processRequestToken,
     ) {
         $this->bpmnErrorHandling = json_decode($element->getProperty('errorHandling'), true) ?? [];
     }
 
-    public function handleRetries($job, $exception)
+    public function handleRetries(ShouldQueue $job, Throwable $exception)
+    {
+        $this->job = $job;
+        $this->exception = $exception;
+
+        return $this->handldRetryAttempts();
+    }
+
+    public function handleRetriesForScriptMicroservice(Throwable $exception, array $metadata)
+    {
+        $this->metadata = $metadata;
+        $this->exception = $exception;
+
+        return $this->handldRetryAttempts();
+    }
+
+    private function handldRetryAttempts()
     {
-        $message = $exception->getMessage();
         $finalAttempt = true;
+        $attemptNumber = $this->getAttemptNumber();
+        $message = $this->getMessage();
 
         if ($this->retryAttempts() > 0) {
-            if ($job->attemptNum <= $this->retryAttempts()) {
-                Log::info('Retry the job process. Attempt ' . $job->attemptNum . ' of ' . $this->retryAttempts() . ', Wait time: ' . $this->retryWaitTime());
-                $this->requeue($job);
+            if ($attemptNumber <= $this->retryAttempts()) {
+                Log::info('Retry the job process. Attempt ' . $attemptNumber . ' of ' . $this->retryAttempts() . ', Wait time: ' . $this->retryWaitTime());
+                $this->requeue();
 
                 $finalAttempt = false;
 
                 return [$message, $finalAttempt];
             }
 
-            $message = __('Job failed after :attempts total attempts', ['attempts' => $job->attemptNum]) . "\n" . $message;
+            $message = __('Job failed after :attempts total attempts', ['attempts' => $attemptNumber]) . "\n" . $message;
 
             $this->sendExecutionErrorNotification($message);
         } else {
@@ -67,26 +94,46 @@ public function handleRetries($job, $exception)
         return [$message, $finalAttempt];
     }
 
-    private function requeue($job)
+    private function requeue()
     {
-        $class = get_class($job);
-        if ($job instanceof RunNayraServiceTask) {
+        if ($this->job instanceof RunNayraServiceTask) {
             $newJob = new RunNayraServiceTask($this->processRequestToken);
-            $newJob->attemptNum = $job->attemptNum + 1;
+            $newJob->attemptNum = $this->attemptNumber + 1;
         } else {
-            $newJob = new $class(
-                Process::findOrFail($job->definitionsId),
-                ProcessRequest::findOrFail($job->instanceId),
-                ProcessRequestToken::findOrFail($job->tokenId),
-                $job->data,
-                $job->attemptNum + 1
+            $jobClass = $this->getJobClass();
+            $newJob = new $jobClass(
+                $this->processRequestToken->process,
+                $this->processRequestToken->processRequest,
+                $this->processRequestToken,
+                $this->getData(),
+                $this->getAttemptNumber() + 1
             );
         }
         $newJob->delay($this->retryWaitTime());
         $newJob->onQueue('bpmn');
         dispatch($newJob);
     }
 
+    private function getData()
+    {
+        return $this->job ? $this->job->data : $this->metadata['data'];
+    }
+
+    private function getAttemptNumber()
+    {
+        return $this->job ? $this->job->attemptNum : $this->metadata['attemptNum'];
+    }
+
+    private function getMessage()
+    {
+        $this->exception->getMessage();
+    }
+
+    private function getJobClass()
+    {
+        return $this->job ? get_class($this->job) : $this->metadata['job_class'];
+    }
+
     /**
      * Send execution error notification.
      */
@@ -206,14 +253,4 @@ public function setDefaultsFromDataSourceConfig(array $config)
             'retry_wait_time' => Arr::get($endpointConfig, 'retry_wait_time', 5),
         ];
     }
-
-    public static function convertResponseToException($result)
-    {
-        if ($result['status'] === 'error') {
-            if (str_starts_with($result['message'], 'Command exceeded timeout of')) {
-                throw new ScriptTimeoutException($result['message']);
-            }
-            throw new ScriptException($result['message']);
-        }
-    }
 }
diff --git a/ProcessMaker/Jobs/RunScriptTask.php b/ProcessMaker/Jobs/RunScriptTask.php
@@ -106,6 +106,7 @@ public function action(ProcessRequestToken $token = null, ScriptTaskInterface $e
                     'token_id' => $this->tokenId,
                     'data' => $data,
                     'attempts' => $this->attemptNum,
+                    'job_class' => get_class($this),
                 ],
             ];
             $response = $script->runScript($data, $configuration, $token->getId(), $errorHandling->timeout(), 1, $metadata);

diff --git a/ProcessMaker/Services/ScriptMicroserviceService.php b/ProcessMaker/Services/ScriptMicroserviceService.php
@@ -5,7 +5,11 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Log;
 use ProcessMaker\Events\ScriptResponseEvent;
+use ProcessMaker\Exception\ScriptException;
+use ProcessMaker\Exception\ScriptTimeoutException;
 use ProcessMaker\Jobs\CompleteActivity;
+use ProcessMaker\Jobs\ErrorHandling;
+use ProcessMaker\Jobs\RunScriptTask;
 use ProcessMaker\Models\Process as Definitions;
 use ProcessMaker\Models\ProcessRequest;
 use ProcessMaker\Models\ProcessRequestToken;
@@ -41,5 +45,23 @@ public function handle(Request $request)
                 CompleteActivity::dispatch($definitions, $instance, $token, $response['output'])->onQueue('bpmn');
             }
         }
+
+        try {
+            $this->convertResponseToException($response);
+        } catch (ScriptException|ScriptTimeoutException $e) {
+            $element = $definitions->getElementInstanceById($token->element_id);
+            $errorHandling = new ErrorHandling($element, $token);
+            $errorHandling->handleRetriesForScriptMicroservice($e, $response['metadata']);
+        }
+    }
+
+    public function convertResponseToException($response)
+    {
+        if ($response['status'] === 'error') {
+            if (str_starts_with($response['message'], 'Command exceeded timeout of')) {
+                throw new ScriptTimeoutException($response['message']);
+            }
+            throw new ScriptException($response['message']);
+        }
     }
 }