Fix tests and implement schedule updates API

jbrooksuk · jbrooksuk · commit db103e93fa5a · 2024-11-25T20:18:08.000Z
diff --git a/database/factories/UpdateFactory.php b/database/factories/UpdateFactory.php
@@ -2,10 +2,14 @@
 
 namespace Cachet\Database\Factories;
 
+use Cachet\Enums\ComponentStatusEnum;
 use Cachet\Enums\IncidentStatusEnum;
+use Cachet\Models\Component;
 use Cachet\Models\Incident;
+use Cachet\Models\Schedule;
 use Cachet\Models\Update;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Relations\Relation;
 
 /**
  * @extends Factory<Update>
@@ -23,10 +27,28 @@ public function definition(): array
     {
         return [
             'updateable_id' => Incident::factory(),
-            'updateable_type' => 'incident',
+            'updateable_type' => Relation::getMorphAlias(Incident::class),
             'status' => IncidentStatusEnum::identified->value,
             'message' => fake()->paragraph,
             'user_id' => 1, // @todo decide how to handle storing of users... nullable?
         ];
     }
+
+    public function forIncident(?Incident $incident = null): self
+    {
+        return $this->state([
+            'updateable_id' => $component->id ?? Incident::factory(),
+            'updateable_type' => Relation::getMorphAlias(Incident::class),
+            'status' => IncidentStatusEnum::identified->value,
+        ]);
+    }
+
+    public function forSchedule(?Schedule $schedule = null): self
+    {
+        return $this->state([
+            'updateable_id' => $schedule->id ?? Schedule::factory(),
+            'updateable_type' => Relation::getMorphAlias(Schedule::class),
+            'status' => null,
+        ]);
+    }
 }
diff --git a/database/migrations/2024_10_11_150422_add_morphable_columns_to_incident_updates.php b/database/migrations/2024_10_11_150422_add_morphable_columns_to_incident_updates.php
@@ -13,6 +13,7 @@ public function up(): void
     {
         Schema::table('incident_updates', function (Blueprint $table) {
             $table->morphs('updateable');
+            $table->unsignedTinyInteger('status')->nullable()->change();
         });
     }
 };
diff --git a/routes/api.php b/routes/api.php
@@ -9,6 +9,7 @@
 use Cachet\Http\Controllers\Api\MetricController;
 use Cachet\Http\Controllers\Api\MetricPointController;
 use Cachet\Http\Controllers\Api\ScheduleController;
+use Cachet\Http\Controllers\Api\ScheduleUpdateController;
 use Cachet\Http\Controllers\Api\StatusController;
 use Illuminate\Support\Facades\Route;
 
@@ -22,8 +23,10 @@
 ]);
 
 Route::apiResource('incidents.updates', IncidentUpdateController::class)
-    ->parameter('updates', 'incidentUpdate')
-    ->scoped();
+    ->scoped(['updateable_id']);
+
+Route::apiResource('schedules.updates', ScheduleUpdateController::class)
+    ->scoped(['updateable_id']);
 
 Route::apiResource('metrics.points', MetricPointController::class)
     ->parameter('points', 'metricPoint')
diff --git a/src/Actions/Update/CreateUpdate.php b/src/Actions/Update/CreateUpdate.php
@@ -4,22 +4,23 @@
 
 use Cachet\Actions\Incident\UpdateIncident;
 use Cachet\Models\Incident;
+use Cachet\Models\Schedule;
 use Cachet\Models\Update;
 
 class CreateUpdate
 {
     /**
      * Handle the action.
      */
-    public function handle(Incident $incident, array $data): Update
+    public function handle(Incident|Schedule $resource, array $data): Update
     {
         $update = new Update(array_merge(['user_id' => auth()->id()], $data));
 
-        $incident->updates()->save($update);
+        $resource->updates()->save($update);
 
         // Update the incident with the new status.
-        if ($incident->status !== $data['status']) {
-            app(UpdateIncident::class)->handle($incident, [
+        if ($resource instanceof Incident && $resource->status !== $data['status']) {
+            app(UpdateIncident::class)->handle($resource, [
                 'status' => $data['status'],
             ]);
         }
diff --git a/src/Actions/Update/EditUpdate.php b/src/Actions/Update/EditUpdate.php
@@ -11,8 +11,8 @@ class EditUpdate
      */
     public function handle(Update $update, array $data): Update
     {
-        $update->update($data);
-
-        return $update->fresh();
+        return tap($update, function (Update $update) use ($data) {
+            $update->update($data);
+        });
     }
 }
diff --git a/src/Http/Controllers/Api/IncidentUpdateController.php b/src/Http/Controllers/Api/IncidentUpdateController.php
@@ -7,7 +7,7 @@
 use Cachet\Actions\Update\EditUpdate;
 use Cachet\Http\Requests\CreateIncidentUpdateRequest;
 use Cachet\Http\Requests\UpdateIncidentUpdateRequest;
-use Cachet\Http\Resources\Update as IncidentUpdateResource;
+use Cachet\Http\Resources\Update as UpdateResource;
 use Cachet\Models\Incident;
 use Cachet\Models\Update;
 use Illuminate\Http\Response;
@@ -40,7 +40,7 @@ public function index(Incident $incident)
             ->allowedSorts(['status', 'created_at'])
             ->simplePaginate(request('per_page', 15));
 
-        return IncidentUpdateResource::collection($updates);
+        return UpdateResource::collection($updates);
     }
 
     /**
@@ -56,7 +56,7 @@ public function store(CreateIncidentUpdateRequest $request, Incident $incident,
     {
         $update = $createUpdateAction->handle($incident, $request->validated());
 
-        return IncidentUpdateResource::make($update);
+        return UpdateResource::make($update);
     }
 
     /**
@@ -68,7 +68,7 @@ public function store(CreateIncidentUpdateRequest $request, Incident $incident,
      */
     public function show(Incident $incident, Update $update)
     {
-        return IncidentUpdateResource::make($update)
+        return UpdateResource::make($update)
             ->response()
             ->setStatusCode(Response::HTTP_OK);
     }
@@ -86,7 +86,7 @@ public function update(UpdateIncidentUpdateRequest $request, Incident $incident,
     {
         $editUpdateAction->handle($update, $request->validated());
 
-        return IncidentUpdateResource::make($update->fresh());
+        return UpdateResource::make($update->fresh());
     }
 
     /**
diff --git a/src/Http/Controllers/Api/ScheduleController.php b/src/Http/Controllers/Api/ScheduleController.php
@@ -28,13 +28,13 @@ class ScheduleController extends Controller
      * @queryParam per_page int How many items to show per page. Example: 20
      * @queryParam page int Which page to show. Example: 2
      * @queryParam sort string Field to sort by. Enum: name, id, scheduled_at, completed_at, enabled Example: name
-     * @queryParam include string Include related resources. Enum: components Example: components
+     * @queryParam include string Include related resources. Enum: components, updates Example: components
      * @queryParam filters string[] Filter the resources. Example: name=api
      */
     public function index()
     {
         $schedules = QueryBuilder::for(Schedule::class)
-            ->allowedIncludes(['components'])
+            ->allowedIncludes(['components', 'updates'])
             ->allowedFilters(['name'])
             ->allowedSorts(['name', 'id', 'scheduled_at', 'completed_at'])
             ->simplePaginate(request('per_page', 15));
diff --git a/src/Http/Controllers/Api/ScheduleUpdateController.php b/src/Http/Controllers/Api/ScheduleUpdateController.php
@@ -0,0 +1,106 @@
+<?php
+
+namespace Cachet\Http\Controllers\Api;
+
+use Cachet\Actions\Update\CreateUpdate;
+use Cachet\Actions\Update\DeleteUpdate;
+use Cachet\Actions\Update\EditUpdate;
+use Cachet\Http\Requests\CreateScheduleUpdateRequest;
+use Cachet\Http\Requests\UpdateScheduleUpdateRequest;
+use Cachet\Http\Resources\Update as UpdateResource;
+use Cachet\Models\Incident;
+use Cachet\Models\Schedule;
+use Cachet\Models\Update;
+use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Http\Response;
+use Illuminate\Routing\Controller;
+use Spatie\QueryBuilder\QueryBuilder;
+
+/**
+ * @group Schedule Updates
+ */
+class ScheduleUpdateController extends Controller
+{
+    /**
+     * List Incident Updates
+     *
+     * @apiResourceCollection \Cachet\Http\Resources\Update
+     *
+     * @apiResourceModel \Cachet\Models\Update
+     *
+     * @queryParam per_page int How many items to show per page. Example: 20
+     * @queryParam page int Which page to show. Example: 2
+     * @queryParam sort string Field to sort by. Enum: name, created_at Example: name
+     * @queryParam filters string[] Filter the resources.
+     */
+    public function index(Schedule $schedule)
+    {
+        $updates = QueryBuilder::for(Update::class)
+            ->where('updateable_id', $schedule->id)
+            ->where('updateable_type', Relation::getMorphAlias(Schedule::class))
+            ->allowedSorts(['created_at'])
+            ->simplePaginate(request('per_page', 15));
+
+        return UpdateResource::collection($updates);
+    }
+
+    /**
+     * Create Schedule Update
+     *
+     * @apiResource \Cachet\Http\Resources\Update
+     *
+     * @apiResourceModel \Cachet\Models\Update
+     *
+     * @authenticated
+     */
+    public function store(CreateScheduleUpdateRequest $request, Schedule $schedule, CreateUpdate $createUpdateAction)
+    {
+        $update = $createUpdateAction->handle($schedule, $request->validated());
+
+        return UpdateResource::make($update);
+    }
+
+    /**
+     * Get Schedule Update
+     *
+     * @apiResource \Cachet\Http\Resources\Update
+     *
+     * @apiResourceModel \Cachet\Models\Update
+     */
+    public function show(Incident $incident, Schedule $schedule)
+    {
+        return UpdateResource::make($schedule)
+            ->response()
+            ->setStatusCode(Response::HTTP_OK);
+    }
+
+    /**
+     * Update Schedule Update
+     *
+     * @apiResource \Cachet\Http\Resources\Update
+     *
+     * @apiResourceModel \Cachet\Models\Update
+     *
+     * @authenticated
+     */
+    public function update(UpdateScheduleUpdateRequest $request, Schedule $schedule, Update $update, EditUpdate $editUpdateAction)
+    {
+        $editUpdateAction->handle($update, $request->validated());
+
+        return UpdateResource::make($update->fresh());
+    }
+
+    /**
+     * Delete Schedule Update
+     *
+     * @response 204
+     *
+     * @authenticated
+     */
+    public function destroy(Schedule $schedule, Update $update, DeleteUpdate $deleteUpdateAction)
+    {
+        $deleteUpdateAction->handle($update);
+
+        return response()->noContent();
+    }
+}
diff --git a/src/Http/Requests/CreateScheduleUpdateRequest.php b/src/Http/Requests/CreateScheduleUpdateRequest.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Cachet\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class CreateScheduleUpdateRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array|string>
+     */
+    public function rules(): array
+    {
+        return [
+            'message' => ['required', 'string'],
+        ];
+    }
+}
diff --git a/src/Http/Requests/UpdateScheduleUpdateRequest.php b/src/Http/Requests/UpdateScheduleUpdateRequest.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Cachet\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class UpdateScheduleUpdateRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     */
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array|string>
+     */
+    public function rules(): array
+    {
+        return [
+            'message' => ['string'],
+        ];
+    }
+}
diff --git a/src/Http/Resources/Update.php b/src/Http/Resources/Update.php
@@ -2,20 +2,26 @@
 
 namespace Cachet\Http\Resources;
 
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Illuminate\Http\Request;
 use TiMacDonald\JsonApi\JsonApiResource;
 
+/**
+ * @mixin \Cachet\Models\Update
+ */
 class Update extends JsonApiResource
 {
     public function toAttributes(Request $request): array
     {
         return [
             'id' => $this->id,
+            'updateable_id' => $this->updateable_id,
+            'updateable_type' => $this->updateable_type,
             'message' => $this->message,
-            'status' => [
-                'human' => $this->status->getLabel(),
-                'value' => $this->status->value,
-            ],
+            'status' => $this->when($this->updateable_type === Relation::getMorphAlias(Incident::class), [
+                'human' => $this->status?->getLabel(),
+                'value' => $this->status?->value,
+            ]),
             'created' => [
                 'human' => optional($this->created_at)->diffForHumans(),
                 'string' => optional($this->created_at)->toDateTimeString(),
@@ -30,7 +36,7 @@ public function toAttributes(Request $request): array
     public function toRelationships(Request $request): array
     {
         return [
-//            'incident' => fn () => Incident::make($this->incident),
+            //            'incident' => fn () => Incident::make($this->incident),
         ];
     }
 }
diff --git a/src/Models/Update.php b/src/Models/Update.php
@@ -2,7 +2,6 @@
 
 namespace Cachet\Models;
 
-use Cachet\Database\Factories\IncidentUpdateFactory;
 use Cachet\Database\Factories\UpdateFactory;
 use Cachet\Enums\IncidentStatusEnum;
 use Illuminate\Database\Eloquent\Factories\Factory;
diff --git a/src/Status.php b/src/Status.php
diff --git a/tests/Feature/Api/IncidentUpdateTest.php b/tests/Feature/Api/IncidentUpdateTest.php
diff --git a/tests/Feature/Api/ScheduleUpdateTest.php b/tests/Feature/Api/ScheduleUpdateTest.php
diff --git a/tests/Unit/Actions/Incident/DeleteIncidentTest.php b/tests/Unit/Actions/Incident/DeleteIncidentTest.php
diff --git a/tests/Unit/Actions/IncidentUpdate/DeleteIncidentUpdateTest.php b/tests/Unit/Actions/IncidentUpdate/DeleteIncidentUpdateTest.php
diff --git a/tests/Unit/Actions/IncidentUpdate/UpdateIncidentUpdateTest.php b/tests/Unit/Actions/IncidentUpdate/UpdateIncidentUpdateTest.php

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ public function up(): void`
`13`	`13`	`{`
`14`	`14`	`Schema::table('incident_updates', function (Blueprint $table) {`
`15`	`15`	`$table->morphs('updateable');`
	`16`	`+ $table->unsignedTinyInteger('status')->nullable()->change();`
`16`	`17`	`});`
`17`	`18`	`}`
`18`	`19`	`};`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ class EditUpdate`
`11`	`11`	`*/`
`12`	`12`	`public function handle(Update $update, array $data): Update`
`13`	`13`	`{`
`14`		`- $update->update($data);`
`15`		`-`
`16`		`- return $update->fresh();`
	`14`	`+ return tap($update, function (Update $update) use ($data) {`
	`15`	`+ $update->update($data);`
	`16`	`+ });`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use Cachet\Actions\Update\EditUpdate;`
`8`	`8`	`use Cachet\Http\Requests\CreateIncidentUpdateRequest;`
`9`	`9`	`use Cachet\Http\Requests\UpdateIncidentUpdateRequest;`
`10`		`-use Cachet\Http\Resources\Update as IncidentUpdateResource;`
	`10`	`+use Cachet\Http\Resources\Update as UpdateResource;`
`11`	`11`	`use Cachet\Models\Incident;`
`12`	`12`	`use Cachet\Models\Update;`
`13`	`13`	`use Illuminate\Http\Response;`
`@@ -40,7 +40,7 @@ public function index(Incident $incident)`
`40`	`40`	`->allowedSorts(['status', 'created_at'])`
`41`	`41`	`->simplePaginate(request('per_page', 15));`
`42`	`42`
`43`		`- return IncidentUpdateResource::collection($updates);`
	`43`	`+ return UpdateResource::collection($updates);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`/**`
`@@ -56,7 +56,7 @@ public function store(CreateIncidentUpdateRequest $request, Incident $incident,`
`56`	`56`	`{`
`57`	`57`	`$update = $createUpdateAction->handle($incident, $request->validated());`
`58`	`58`
`59`		`- return IncidentUpdateResource::make($update);`
	`59`	`+ return UpdateResource::make($update);`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`/**`
`@@ -68,7 +68,7 @@ public function store(CreateIncidentUpdateRequest $request, Incident $incident,`
`68`	`68`	`*/`
`69`	`69`	`public function show(Incident $incident, Update $update)`
`70`	`70`	`{`
`71`		`- return IncidentUpdateResource::make($update)`
	`71`	`+ return UpdateResource::make($update)`
`72`	`72`	`->response()`
`73`	`73`	`->setStatusCode(Response::HTTP_OK);`
`74`	`74`	`}`
`@@ -86,7 +86,7 @@ public function update(UpdateIncidentUpdateRequest $request, Incident $incident,`
`86`	`86`	`{`
`87`	`87`	`$editUpdateAction->handle($update, $request->validated());`
`88`	`88`
`89`		`- return IncidentUpdateResource::make($update->fresh());`
	`89`	`+ return UpdateResource::make($update->fresh());`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`/**`