fix cr observations

ProcessMaker · Sep 12, 2024 · 2fc73d7 · 2fc73d7
1 parent a1ca7a7
commit 2fc73d7
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 7 deletions.
diff --git a/ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php b/ProcessMaker/Http/Controllers/Api/V1_1/CaseController.php
@@ -4,14 +4,16 @@
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\Request;
-use Illuminate\Http\Response;
 use ProcessMaker\Http\Controllers\Controller;
 use ProcessMaker\Http\Requests\GetAllCasesRequest;
 use ProcessMaker\Http\Resources\V1_1\CaseResource;
 use ProcessMaker\Models\CaseStarted;
 
 class CaseController extends Controller
 {
+    /**
+     * Default fields used in the query select statement.
+     */
     protected $defaultFields = [
         'case_number',
         'user_id',
@@ -58,6 +60,8 @@ class CaseController extends Controller
         'updated_at',
     ];
 
+    const DEFAULT_SORT_DIRECTION = 'asc';
+
     /**
      * Get a list of all started cases.
      *
@@ -136,7 +140,7 @@ private function sortBy(Request $request, Builder $query): void
 
             $sort = explode(':', $value);
             $field = $sort[0];
-            $order = $sort[1] ?? 'asc';
+            $order = $sort[1] ?? self::DEFAULT_SORT_DIRECTION;
 
             if (in_array($field, $this->sortableFields)) {
                 $query->orderBy($field, $order);
@@ -189,7 +193,7 @@ private function search(Request $request, Builder $query): void
             $query->where(function ($q) use ($search) {
                 foreach ($this->searchableFields as $field) {
                     if ($field === 'case_number') {
-                        $q->orWhere($field, 'like', "%$search%");
+                        $q->orWhere($field, $search);
                     } else {
                         $q->orWhereFullText($field, $search . '*', ['mode' => 'boolean']);
                     }

diff --git a/ProcessMaker/Http/Requests/GetAllCasesRequest.php b/ProcessMaker/Http/Requests/GetAllCasesRequest.php
@@ -3,6 +3,7 @@
 namespace ProcessMaker\Http\Requests;
 
 use Illuminate\Foundation\Http\FormRequest;
+use ProcessMaker\Rules\SortBy;
 
 class GetAllCasesRequest extends FormRequest
 {
@@ -23,8 +24,8 @@ public function rules(): array
     {
         return [
             'userId' => 'sometimes|integer',
-            'status' => 'sometimes|in:in_progress,completed',
-            'sortBy' => 'sometimes|string',
+            'status' => 'sometimes|in:IN_PROGRESS,COMPLETED',
+            'sortBy' => ['sometimes', 'string', new SortBy],
             'filterBy' => 'sometimes|array',
             'search' => 'sometimes|string',
             'pageSize' => 'sometimes|integer|min:1',

diff --git a/ProcessMaker/Http/Resources/V1_1/CaseResource.php b/ProcessMaker/Http/Resources/V1_1/CaseResource.php
@@ -6,6 +6,9 @@
 
 class CaseResource extends ApiResource
 {
+    /**
+     * Default fields that will be included in the response.
+     */
     protected static $defaultFields = [
         'case_number',
         'user_id',

diff --git a/ProcessMaker/Rules/SortBy.php b/ProcessMaker/Rules/SortBy.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace ProcessMaker\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class SortBy implements ValidationRule
+{
+    /**
+     * Run the validation rule.
+     *
+     * @param  \Closure(string): \Illuminate\Translation\PotentiallyTranslatedString  $fail
+     */
+    public function validate(string $attribute, mixed $value, Closure $fail): void
+    {
+        $items = explode(',', $value);
+
+        foreach ($items as $item) {
+            if (!preg_match('/^[a-zA-Z_]+:(asc|desc)$/', $item)) {
+                $fail("The $attribute must be a comma-separated list of field:asc|desc.");
+            }
+        }
+    }
+}
diff --git a/database/factories/CaseStartedFactory.php b/database/factories/CaseStartedFactory.php
@@ -24,7 +24,7 @@ public function definition(): array
             'user_id' => fake()->randomElement([1, 3]),
             'case_title' => fake()->words(3, true),
             'case_title_formatted' => fake()->words(3, true),
-            'case_status' => fake()->randomElement(['in_progress', 'completed']),
+            'case_status' => fake()->randomElement(['IN_PROGRESS', 'COMPLETED']),
             'processes' => array_map(function() {
                 return [
                     'id' => fake()->randomNumber(),

diff --git a/database/migrations/2024_09_09_181717_create_cases_started_table.php b/database/migrations/2024_09_09_181717_create_cases_started_table.php
@@ -15,7 +15,7 @@ public function up(): void
             $table->unsignedInteger('case_number')->primary();
             $table->unsignedInteger('user_id');
             $table->string('case_title', 255);
-            $table->string('case_title_formatted', 255);
+            $table->text('case_title_formatted');
             $table->string('case_status', 20);
             $table->json('processes');
             $table->json('requests');