Fix filter by status (#230)

Author: icecoldPHP

database/migrations/2024_10_13_214300_drop_schedule_status.php

@@ -25,7 +25,7 @@ public function up()
      */
     public function down()
     {
-        Schema::table('incidents', function (Blueprint $table) {
+        Schema::table('schedules', function (Blueprint $table) {
             $table->unsignedInteger('status')->unsigned()->default(0);
         });
     }

database/seeders/DatabaseSeeder.php

@@ -19,6 +19,7 @@
 use Cachet\Settings\AppSettings;
 use Cachet\Settings\CustomizationSettings;
 use Cachet\Settings\ThemeSettings;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Seeder;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
@@ -60,11 +61,13 @@ public function run(): void
             'completed_at' => now()->subHours(12),
         ]);
 
+        /** @phpstan-ignore-next-line  argument.type */
         tap(Schedule::create([
             'name' => 'Documentation Maintenance',
             'message' => 'We will be conducting maintenance on our documentation servers. You may experience degraded performance during this time.',
             'scheduled_at' => now()->addHours(24),
             'completed_at' => null,
+            /** @phpstan-ignore-next-line argument.type */
         ]), function (Schedule $schedule) use ($user) {
             $update = new Update([
                 'message' => <<<'EOF'

src/Actions/Schedule/CreateSchedule.php

@@ -5,6 +5,7 @@
 use Cachet\Data\Requests\Schedule\CreateScheduleRequestData;
 use Cachet\Data\Requests\Schedule\ScheduleComponentRequestData;
 use Cachet\Models\Schedule;
+use Illuminate\Database\Eloquent\Model;
 
 class CreateSchedule
 {
@@ -13,6 +14,8 @@ class CreateSchedule
      */
     public function handle(CreateScheduleRequestData $data): Schedule
     {
+
+        /** @phpstan-ignore-next-line argument.type */
         return tap(Schedule::create($data->except('components')->toArray()), function (Schedule $schedule) use ($data) {
             if (! $data->components) {
                 return;

src/Data/Requests/Incident/UpdateIncidentRequestData.php

@@ -35,6 +35,6 @@ public static function rules(ValidationContext $context): array
 
     public function toArray(): array
     {
-        return parent::toArray(); // TODO: Change the autogenerated stub
+        return parent::toArray();
     }
 }

src/Filters/ScheduleStatusFilter.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Cachet\Filters;
+
+use Cachet\Enums\ScheduleStatusEnum;
+use Cachet\QueryBuilders\ScheduleBuilder;
+use Illuminate\Database\Eloquent\Builder;
+use Spatie\QueryBuilder\Filters\Filter;
+
+class ScheduleStatusFilter implements Filter
+{
+    /**
+     * @param  ScheduleBuilder  $query
+     * @param  $value
+     * @param  string  $property
+     * @return void
+     */
+    public function __invoke(Builder $query, $value, string $property)
+    {
+        if (is_array($value)) {
+            $this->multiValueFilter($value, $query);
+            return ;
+        }
+        $enum = $this->toEnum($value);
+        if (! $enum instanceof ScheduleStatusEnum) {
+            return ;
+        }
+        $this->toQuery($enum, $query);
+    }
+
+    public function multiValueFilter(array $value, ScheduleBuilder $query)
+    {
+        $query->where(function (ScheduleBuilder $query) use ($value) {
+            foreach($value as $status) {
+                $status = $this->toEnum($status);
+                if (! $status instanceof ScheduleStatusEnum) {
+                    continue;
+                }
+
+                $query->orWhere(function (ScheduleBuilder $query) use ($status) {
+                    $this->toQuery($status, $query);
+                });
+            }
+        });
+    }
+
+
+    protected function toQuery(ScheduleStatusEnum $value, ScheduleBuilder $query)
+    {
+        match($value) {
+            ScheduleStatusEnum::complete => $query->inThePast(),
+            ScheduleStatusEnum::in_progress => $query->inProgress(),
+            ScheduleStatusEnum::upcoming => $query->inTheFuture(),
+        };
+    }
+
+    protected function toEnum($value)
+    {
+        if( ! $value instanceof ScheduleStatusEnum && is_numeric($value)) {
+            return ScheduleStatusEnum::tryFrom($value);
+        }
+        return $value;
+    }
+
+}

src/Http/Controllers/Api/ComponentController.php

@@ -77,6 +77,7 @@ public function store(CreateComponentRequestData $data, CreateComponent $createC
      */
     public function show(Component $component)
     {
+
         $componentQuery = QueryBuilder::for(Component::class)
             ->allowedIncludes(self::ALLOWED_INCLUDES)
             ->find($component->id);

src/Http/Controllers/Api/ComponentGroupController.php

@@ -58,6 +58,7 @@ public function store(CreateComponentGroupRequestData $data, CreateComponentGrou
      */
     public function show(ComponentGroup $componentGroup)
     {
+
         $componentQuery = QueryBuilder::for(ComponentGroup::class)
             ->allowedIncludes(['components'])
             ->find($componentGroup->id);

src/Http/Controllers/Api/IncidentController.php

@@ -78,6 +78,7 @@ public function store(CreateIncidentRequestData $data, CreateIncident $createInc
      */
     public function show(Incident $incident)
     {
+
         $incidentQuery = QueryBuilder::for(Incident::class)
             ->allowedIncludes(self::ALLOWED_INCLUDES)
             ->find($incident->id);

src/Http/Controllers/Api/MetricPointController.php

@@ -61,6 +61,7 @@ public function store(CreateMetricPointRequestData $data, Metric $metric, Create
      */
     public function show(Metric $metric, MetricPoint $metricPoint)
     {
+
         $metricPointQuery = QueryBuilder::for(MetricPoint::class)
             ->allowedIncludes(['metric'])
             ->find($metricPoint->id);

src/Http/Controllers/Api/ScheduleController.php

@@ -8,13 +8,13 @@
 use Cachet\Concerns\GuardsApiAbilities;
 use Cachet\Data\Requests\Schedule\CreateScheduleRequestData;
 use Cachet\Data\Requests\Schedule\UpdateScheduleRequestData;
+use Cachet\Enums\ScheduleStatusEnum;
+use Cachet\Filters\ScheduleStatusFilter;
 use Cachet\Http\Resources\Schedule as ScheduleResource;
 use Cachet\Models\Schedule;
 use Dedoc\Scramble\Attributes\Group;
 use Dedoc\Scramble\Attributes\QueryParameter;
-use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
 use Illuminate\Http\Response;
-use Illuminate\Pagination\Paginator;
 use Illuminate\Routing\Controller;
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;
@@ -30,14 +30,14 @@ class ScheduleController extends Controller
      * @response AnonymousResourceCollection<Paginator<ScheduleResource>>
      */
     #[QueryParameter('filter[name]', 'Filter the resources by name.', example: 'api')]
-    #[QueryParameter('filter[status]', 'Filter the resources by status.', example: 1)]
+    #[QueryParameter('filter[status]', 'Filter the resources by status.', type: ScheduleStatusEnum::class)]
     #[QueryParameter('per_page', 'How many items to show per page.', type: 'int', default: 15, example: 20)]
     #[QueryParameter('page', 'Which page to show.', type: 'int', example: 2)]
     public function index()
     {
         $schedules = QueryBuilder::for(Schedule::class)
             ->allowedIncludes(['components', 'updates', 'user'])
-            ->allowedFilters(['name', AllowedFilter::exact('status')])
+            ->allowedFilters(['name', AllowedFilter::custom('status', new ScheduleStatusFilter)])
             ->allowedSorts(['name', 'id', 'scheduled_at', 'completed_at'])
             ->simplePaginate(request('per_page', 15));