Fix filter by status (#230)

icecoldPHP · web-flow · commit 858e6a0c7fc9 · 2025-02-24T13:08:59.000Z
diff --git a/database/migrations/2024_10_13_214300_drop_schedule_status.php b/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);
         });
     }
diff --git a/database/seeders/DatabaseSeeder.php b/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'
diff --git a/src/Actions/Schedule/CreateSchedule.php b/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;
diff --git a/src/Data/Requests/Incident/UpdateIncidentRequestData.php b/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();
     }
 }
diff --git a/src/Filters/ScheduleStatusFilter.php b/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;
+    }
+
+}
diff --git a/src/Http/Controllers/Api/ComponentController.php b/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);
diff --git a/src/Http/Controllers/Api/ComponentGroupController.php b/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);
diff --git a/src/Http/Controllers/Api/IncidentController.php b/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);
diff --git a/src/Http/Controllers/Api/MetricPointController.php b/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);
diff --git a/src/Http/Controllers/Api/ScheduleController.php b/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));
 
diff --git a/src/Http/Resources/ScheduleComponent.php b/src/Http/Resources/ScheduleComponent.php
@@ -10,6 +10,6 @@ class ScheduleComponent extends JsonApiResource
 {
     public function toAttributes(Request $request): array
     {
-        return parent::toAttributes($request); // TODO: Change the autogenerated stub
+        return parent::toAttributes($request);
     }
 }
diff --git a/src/Http/Resources/Tag.php b/src/Http/Resources/Tag.php
@@ -9,6 +9,6 @@ class Tag extends JsonApiResource
 {
     public function toAttributes(Request $request): array
     {
-        return parent::toAttributes($request); // TODO: Change the autogenerated stub
+        return parent::toAttributes($request);
     }
 }
diff --git a/src/Models/Schedule.php b/src/Models/Schedule.php
@@ -4,6 +4,7 @@
 
 use Cachet\Database\Factories\ScheduleFactory;
 use Cachet\Enums\ScheduleStatusEnum;
+use Cachet\QueryBuilders\ScheduleBuilder;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\Factory;
@@ -29,11 +30,10 @@
  * @property Collection<int, Update> $updates
  *
  * @method static ScheduleFactory factory($count = null, $state = [])
- * @method static Builder<static>|static query()
- * @method static Builder<static>|static incomplete()
- * @method static Builder<static>|static inProgress()
- * @method static Builder<static>|static inTheFuture()
- * @method static Builder<static>|static inThePast()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder incomplete()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder inProgress()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder inTheFuture()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder inThePast()
  */
 class Schedule extends Model
 {
@@ -69,7 +69,8 @@ protected function status(): Attribute
 
                 return match (true) {
                     $this->scheduled_at->gte($now) => ScheduleStatusEnum::upcoming,
-                    $this->completed_at === null => ScheduleStatusEnum::in_progress,
+                    $this->completed_at === null,
+                    $this->completed_at->gte($now) => ScheduleStatusEnum::in_progress,
                     default => ScheduleStatusEnum::complete,
                 };
             }
@@ -108,48 +109,16 @@ public function formattedMessage(): string
     }
 
     /**
-     * Scope schedules that are incomplete.
+     * Create a new Eloquent query builder for the model.
      *
-     * @param  Builder<$this>  $query
+     * @param \Illuminate\Database\Query\Builder $query
+     * @return \Cachet\QueryBuilders\ScheduleBuilder
      */
-    public function scopeIncomplete(Builder $query): void
+    public function newEloquentBuilder($query)
     {
-        $query->whereNull('completed_at');
+        return new ScheduleBuilder($query);
     }
 
-    /**
-     * Scope schedules that are in progress.
-     *
-     * @param  Builder<$this>  $query
-     */
-    public function scopeInProgress(Builder $query): void
-    {
-        $query->whereDate('scheduled_at', '<=', Carbon::now())
-            ->where(function (Builder $query) {
-                $query->whereDate('completed_at', '>=', Carbon::now())
-                    ->orWhereNull('completed_at');
-            });
-    }
-
-    /**
-     * Scopes schedules to those in the future.
-     *
-     * @param  Builder<$this>  $query
-     */
-    public function scopeInTheFuture(Builder $query): void
-    {
-        $query->whereDate('scheduled_at', '>=', Carbon::now());
-    }
-
-    /**
-     * Scopes schedules to those scheduled in the past.
-     *
-     * @param  Builder<$this>  $query
-     */
-    public function scopeInThePast(Builder $query): void
-    {
-        $query->where('completed_at', '<=', Carbon::now());
-    }
 
     /**
      * Create a new factory instance for the model.
diff --git a/src/QueryBuilders/ScheduleBuilder.php b/src/QueryBuilders/ScheduleBuilder.php
@@ -0,0 +1,70 @@
+<?php
+
+namespace Cachet\QueryBuilders;
+
+use Cachet\Models\Schedule;
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * @inheritDoc
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder incomplete()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder inProgress()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder inTheFuture()
+ * @method static \Cachet\QueryBuilders\ScheduleBuilder inThePast()
+ * @mixin Schedule
+ */
+class ScheduleBuilder extends Builder
+{
+    /**
+     * Scope schedules that are incomplete.
+     *
+     * @return self
+     */
+    public function incomplete(): self
+    {
+        $this->where(function (ScheduleBuilder $query) {
+            $query->where('completed_at', '>=', Carbon::now())
+                ->orWhereNull('completed_at');
+        });
+        return $this;
+    }
+
+    /**
+     * Scope schedules that are in progress.
+     *
+     * @return self
+     */
+    public function inProgress(): self
+    {
+        $this->where('scheduled_at', '<=', Carbon::now())
+            ->where(function (ScheduleBuilder $query) {
+                $query->where('completed_at', '>=', Carbon::now())
+                    ->orWhereNull('completed_at');
+            });
+        return $this;
+    }
+
+    /**
+     * Scopes schedules to those in the future.
+     *
+     * @return self
+     */
+    public function inTheFuture(): self
+    {
+        $this->where('scheduled_at', '>=', Carbon::now());
+        return $this;
+    }
+
+    /**
+     * Scopes schedules to those scheduled in the past.
+     *
+     * @return self
+     */
+    public function inThePast(): self
+    {
+        $this->where('completed_at', '<=', Carbon::now())
+            ->whereNotNull('completed_at');
+        return $this;
+    }
+}
diff --git a/tests/Feature/Api/ComponentGroupTest.php b/tests/Feature/Api/ComponentGroupTest.php
@@ -48,6 +48,7 @@
 });
 
 it('can get a component group', function () {
+    ComponentGroup::factory(5)->create();
     $componentGroup = ComponentGroup::factory()->create();
 
     $response = getJson('/status/api/component-groups/'.$componentGroup->id);
@@ -59,6 +60,7 @@
 });
 
 it('can get a component group with components', function () {
+    ComponentGroup::factory(5)->hasComponents(1)->create();
     $componentGroup = ComponentGroup::factory()->hasComponents(2)->create();
 
     $response = getJson('/status/api/component-groups/'.$componentGroup->id.'?include=components');
diff --git a/tests/Feature/Api/ComponentTest.php b/tests/Feature/Api/ComponentTest.php
@@ -153,6 +153,7 @@
 });
 
 it('can get a component', function () {
+    Component::factory(5)->create();
     $component = Component::factory()->create();
 
     $response = getJson('/status/api/components/'.$component->id);
@@ -164,6 +165,7 @@
 });
 
 it('can get a component with group', function () {
+    Component::factory(5)->forGroup()->create();
     $component = Component::factory()->forGroup()->create();
 
     $response = getJson('/status/api/components/'.$component->id.'?include=group');
diff --git a/tests/Feature/Api/IncidentTemplateTest.php b/tests/Feature/Api/IncidentTemplateTest.php
diff --git a/tests/Feature/Api/IncidentTest.php b/tests/Feature/Api/IncidentTest.php
diff --git a/tests/Feature/Api/IncidentUpdateTest.php b/tests/Feature/Api/IncidentUpdateTest.php
diff --git a/tests/Feature/Api/MetricPointTest.php b/tests/Feature/Api/MetricPointTest.php
diff --git a/tests/Feature/Api/MetricTest.php b/tests/Feature/Api/MetricTest.php
diff --git a/tests/Feature/Api/ScheduleTest.php b/tests/Feature/Api/ScheduleTest.php

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public function up()`
`25`	`25`	`*/`
`26`	`26`	`public function down()`
`27`	`27`	`{`
`28`		`- Schema::table('incidents', function (Blueprint $table) {`
	`28`	`+ Schema::table('schedules', function (Blueprint $table) {`
`29`	`29`	`$table->unsignedInteger('status')->unsigned()->default(0);`
`30`	`30`	`});`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,6 @@ public static function rules(ValidationContext $context): array`
`35`	`35`
`36`	`36`	`public function toArray(): array`
`37`	`37`	`{`
`38`		`- return parent::toArray(); // TODO: Change the autogenerated stub`
	`38`	`+ return parent::toArray();`
`39`	`39`	`}`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,7 @@ public function store(CreateComponentRequestData $data, CreateComponent $createC`
`77`	`77`	`*/`
`78`	`78`	`public function show(Component $component)`
`79`	`79`	`{`
	`80`	`+`
`80`	`81`	`$componentQuery = QueryBuilder::for(Component::class)`
`81`	`82`	`->allowedIncludes(self::ALLOWED_INCLUDES)`
`82`	`83`	`->find($component->id);`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ public function store(CreateComponentGroupRequestData $data, CreateComponentGrou`
`58`	`58`	`*/`
`59`	`59`	`public function show(ComponentGroup $componentGroup)`
`60`	`60`	`{`
	`61`	`+`
`61`	`62`	`$componentQuery = QueryBuilder::for(ComponentGroup::class)`
`62`	`63`	`->allowedIncludes(['components'])`
`63`	`64`	`->find($componentGroup->id);`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,7 @@ public function store(CreateIncidentRequestData $data, CreateIncident $createInc`
`78`	`78`	`*/`
`79`	`79`	`public function show(Incident $incident)`
`80`	`80`	`{`
	`81`	`+`
`81`	`82`	`$incidentQuery = QueryBuilder::for(Incident::class)`
`82`	`83`	`->allowedIncludes(self::ALLOWED_INCLUDES)`
`83`	`84`	`->find($incident->id);`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ public function store(CreateMetricPointRequestData $data, Metric $metric, Create`
`61`	`61`	`*/`
`62`	`62`	`public function show(Metric $metric, MetricPoint $metricPoint)`
`63`	`63`	`{`
	`64`	`+`
`64`	`65`	`$metricPointQuery = QueryBuilder::for(MetricPoint::class)`
`65`	`66`	`->allowedIncludes(['metric'])`
`66`	`67`	`->find($metricPoint->id);`