Merge pull request ProcessMaker#7539 from ProcessMaker/feature/FOUR-1…

…9490 FOUR-19490: The store comments needs to consider populate the comments.case_number
nolanpro · Oct 15, 2024 · f007b85 · f007b85
2 parents 7dec4b0 + c4cc694
commit f007b85
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 5 deletions.
diff --git a/ProcessMaker/Http/Controllers/Api/CommentController.php b/ProcessMaker/Http/Controllers/Api/CommentController.php
@@ -155,6 +155,12 @@ public function store(Request $request)
         $this->authorizeComment($request);
 
         $data['user_id'] = Auth::user()->id;
+        // Get the case_number if was not send
+        $caseNumber = $request->input('case_number', null);
+        if (is_null($caseNumber)) {
+            $caseNumber = $this->getCaseNumber($request);
+        }
+        $data['case_number'] = $caseNumber;
         $request->merge($data);
         $request->validate(Comment::rules());
 
@@ -194,6 +200,12 @@ public function update(Comment $comment, Request $request)
             abort(403);
         }
         $data['user_id'] = Auth::user()->id;
+        // Get the case_number if was not send
+        $caseNumber = $request->input('case_number', null);
+        if (is_null($caseNumber)) {
+            $caseNumber = $this->getCaseNumber($request);
+        }
+        $data['case_number'] = $caseNumber;
         $request->merge($data);
         $request->validate(Comment::rules());
 
@@ -227,4 +239,20 @@ public function destroy(Comment $comment)
 
         return response([], 204);
     }
+
+    private function getCaseNumber(Request $request)
+    {
+        $requestId = null;
+        $commentableType = $request->input('commentable_type');
+        if ($commentableType === 'ProcessMaker\Models\ProcessRequestToken') {
+            $requestId = ProcessRequestToken::where('id', $request->input('commentable_id'))->value('process_request_id');
+        } elseif ($commentableType === 'ProcessMaker\Models\ProcessRequest') {
+            $requestId = $request->input('commentable_id');
+        }
+        if ($requestId) {
+            return ProcessRequest::where('id', $requestId)->value('case_number');
+        }
+
+        return null;
+    }
 }
diff --git a/ProcessMaker/Http/Controllers/Api/ProcessRequestController.php b/ProcessMaker/Http/Controllers/Api/ProcessRequestController.php
@@ -401,6 +401,7 @@ public function update(ProcessRequest $request, Request $httpRequest)
                 'commentable_id' => $request->id,
                 'subject' => 'Data edited',
                 'body' => $user_name . ' ' . $text,
+                'case_number' => isset($request->case_number) ? $request->case_number : null,
             ]);
         } else {
             $httpRequest->validate(ProcessRequest::rules($request));
@@ -629,6 +630,7 @@ private function completeRequest(ProcessRequest $request)
             'commentable_id' => $request->id,
             'subject' => __('Process Manually Completed'),
             'body' => $user->fullname . ' ' . __('manually completed the request from an error state'),
+            'case_number' => isset($request->case_number) ? $request->case_number : null,
         ]);
     }
 

diff --git a/ProcessMaker/Listeners/BpmnSubscriber.php b/ProcessMaker/Listeners/BpmnSubscriber.php
@@ -195,7 +195,7 @@ public function onScriptTaskActivated(ScriptTaskInterface $scriptTask, TokenInte
         try {
             WorkflowManager::runScripTask($scriptTask, $token);
         } catch (\Throwable $e) {
-            \Illuminate\Support\Facades\Log::Error('Unhandled error when running a script task:' . $e->getMessage());
+            Log::Error('Unhandled error when running a script task:' . $e->getMessage());
         }
     }
 
@@ -211,7 +211,7 @@ public function onServiceTaskActivated(ServiceTaskInterface $serviceTask, TokenI
         try {
             WorkflowManager::runServiceTask($serviceTask, $token);
         } catch (\Throwable $e) {
-            \Illuminate\Support\Facades\Log::Error('Unhandled error when running a service task:' . $e->getMessage());
+            Log::Error('Unhandled error when running a service task:' . $e->getMessage());
         }
     }
 
@@ -222,6 +222,9 @@ public function onIntermediateCatchEventActivated(IntermediateCatchEventInterfac
             TimerEventDefinitionInterface::class => 'System is waiting for the scheduled timer: ":event"',
             ConditionalEventDefinitionInterface::class => 'System is waiting for the conditional event: ":event"',
         ];
+        // Get the case_number
+        $caseNumber = ProcessRequest::where('id', $token->getInstance()->id)->value('case_number');
+
         foreach ($event->getEventDefinitions() as $eventDefinition) {
             foreach ($messages as $interface => $message) {
                 if (is_subclass_of($eventDefinition, $interface)) {
@@ -232,6 +235,7 @@ public function onIntermediateCatchEventActivated(IntermediateCatchEventInterfac
                         'subject' => __($message, ['event' => $event->getName()]),
                         'body' => __($message, ['event' => $event->getName()]),
                         'type' => 'LOG',
+                        'case_number' => $caseNumber,
                     ]);
                     $comment->save();
                     break;
@@ -279,7 +283,7 @@ public function updateDataWithFlowTransition($transition, $flow, $instance)
                 $instance->data = $data;
                 $instance->saveOrFail();
             }
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             Log::error('The expression used in the flow generated and error: ', [$e->getMessage()]);
             $instance->logError($e, $transition->getOwner());
         }

diff --git a/ProcessMaker/Listeners/CommentsSubscriber.php b/ProcessMaker/Listeners/CommentsSubscriber.php
@@ -34,6 +34,8 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
         if ($token->is_actionbyemail) {
             $message = $message . ' via email';
         }
+        // Get the case_number
+        $caseNumber = ProcessRequest::where('id', $token->process_request_id)->value('case_number');
 
         Comment::create([
             'type' => 'LOG',
@@ -42,6 +44,7 @@ public function onActivityCompleted(ActivityCompletedEvent $event)
             'commentable_id' => $token->process_request_id,
             'subject' => 'Task Complete',
             'body' => __($message, ['user' => $user_name, 'task_name' => $token->element_name]),
+            'case_number' => $caseNumber,
         ]);
     }
 
@@ -59,6 +62,8 @@ public function onActivitySkipped(ActivityInterface $activity, ProcessRequestTok
         if (!is_int($token->getInstance()->getId())) {
             return;
         }
+        // Get the case number
+        $caseNumber = ProcessRequest::where('id', $token->getInstance()->getId())->value('case_number');
 
         Comment::create([
             'type' => 'LOG',
@@ -67,6 +72,7 @@ public function onActivitySkipped(ActivityInterface $activity, ProcessRequestTok
             'commentable_id' => $token->getInstance()->getId(),
             'subject' => 'Task Skipped',
             'body' => __('The task :task_name was skipped', ['task_name' => $taskName]),
+            'case_number' => $caseNumber,
         ]);
     }
 
@@ -112,6 +118,8 @@ public function onGatewayPassed($gateway, $transition = null, $tokens = null)
             if (!is_int($token->getInstance()->getId())) {
                 return;
             }
+            // Get the case number
+            $caseNumber = ProcessRequest::where('id', $token->getInstance()->getId())->value('case_number');
 
             Comment::create([
                 'type' => 'LOG',
@@ -120,6 +128,7 @@ public function onGatewayPassed($gateway, $transition = null, $tokens = null)
                 'commentable_id' => $token->getInstance()->getId(),
                 'subject' => 'Gateway',
                 'body' => $sourceLabel . ': ' . $flowLabel,
+                'case_number' => $caseNumber,
             ]);
         }
     }

diff --git a/ProcessMaker/Models/Comment.php b/ProcessMaker/Models/Comment.php
@@ -49,7 +49,17 @@ class Comment extends ProcessMakerModel
     use SoftDeletes;
 
     protected $fillable = [
-        'user_id', 'parent_id', 'group_id', 'group_name', 'commentable_id', 'commentable_type', 'subject', 'body', 'hidden', 'type',
+        'user_id',
+        'parent_id',
+        'group_id',
+        'group_name',
+        'commentable_id',
+        'commentable_type',
+        'subject',
+        'body',
+        'hidden',
+        'type',
+        'case_number',
     ];
 
     protected $casts = [

diff --git a/ProcessMaker/RetryProcessRequest.php b/ProcessMaker/RetryProcessRequest.php
@@ -111,7 +111,7 @@ public function retry(): void
     /**
      * Clear previous ProcessRequestToken errors off of its parent ProcessRequest(s)
      *
-     * @param  \ProcessMaker\Models\ProcessRequestToken  $token
+     * @param  ProcessRequestToken  $token
      *
      * @return void
      */
@@ -153,6 +153,7 @@ public function createRequestComment(): void
             'commentable_type' => ProcessRequest::class,
             'commentable_id' => $this->processRequest->id,
             'subject' => __('Request Retried'),
+            'case_number' => isset($this->processRequest->case_number) ? $this->processRequest->case_number : null,
         ]);
 
         if ($user = $this->initializingUser()) {

diff --git a/ProcessMaker/RollbackProcessRequest.php b/ProcessMaker/RollbackProcessRequest.php
@@ -206,6 +206,7 @@ private function addComment() : void
                 'failed_task_name' => $this->currentTask->element_name,
                 'new_task_name' => $this->newTask->element_name,
             ]),
+            'case_number' => isset($this->currentTask->case_number) ? $this->currentTask->case_number : null,
         ]);
     }
 }
diff --git a/tests/Feature/Api/CommentTest.php b/tests/Feature/Api/CommentTest.php
@@ -34,6 +34,7 @@ class CommentTest extends TestCase
         'type',
         'updated_at',
         'created_at',
+        'case_number',
     ];
 
     protected function withUserSetup()