cleanup dead ends from previous json api. Refactor code to use resource hooks https://laraveljsonapi.io/5.x/routing/controllers.html#resource-hooks

Author: pb

app/Http/Controllers/AssistantController.php

@@ -4,91 +4,65 @@
 
 namespace App\Http\Controllers;
 
-use App\Http\Controllers\Controller;
+use App\Events\AssistantCreated;
+use App\Events\AssistantUpdated;
 use App\JsonApi\V1\Assistants\AssistantQuery;
 use App\JsonApi\V1\Assistants\AssistantRequest;
 use App\JsonApi\V1\Assistants\AssistantSchema;
+use App\JsonApi\V1\Assistants\ReleaseAssistantRequest;
 use App\Models\Assistants\Assistant;
 use App\Services\Assistant\AssistantService;
-use App\JsonApi\V1\Assistants\ReleaseAssistantRequest;
 use App\Services\Assistant\Values\ReleaseStage;
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Http\Response;
+use Illuminate\Support\Facades\Event;
 use LaravelJsonApi\Core\Responses\DataResponse;
 use LaravelJsonApi\Laravel\Http\Controllers\Actions;
 
 class AssistantController extends Controller
 {
     use Actions\FetchMany;
     use Actions\FetchOne;
-
-    private const RELATIONS = ['language', 'category', 'tags', 'ai_tools', 'user_prompts'];
-
-    private function extractServiceDataForUpdateOrCreate(AssistantRequest $request): array
-    {
-        $validated = $request->validated();
-
-        $data = collect($validated)
-            ->except(['type', 'id', ...self::RELATIONS])
-            ->all();
-
-        if (isset($validated['language'])) {
-            $data['language_id'] = (int) $validated['language']['id'];
-        }
-        if (isset($validated['category'])) {
-            $data['category_id'] = (int) $validated['category']['id'];
-        }
-        if (isset($validated['tags'])) {
-            $data['tag_ids'] = collect($validated['tags'])->map(fn ($item) => (int) $item['id'])->all();
-        }
-        if (isset($validated['ai_tools'])) {
-            $data['ai_tool_ids'] = collect($validated['ai_tools'])->map(fn ($item) => (int) $item['id'])->all();
-        }
-        if (isset($validated['user_prompts'])) {
-            $data['user_prompt_ids'] = collect($validated['user_prompts'])->map(fn ($item) => (int) $item['id'])->all();
-        }
-
-        return $data;
-    }
+    use Actions\Store;
+    use Actions\Update;
+    use Actions\Destroy;
 
     public function __construct(
         private readonly AssistantService $assistantService,
     ) {
         $this->authorizeResource(Assistant::class, 'assistant');
     }
 
-    public function store(AssistantRequest $request, AssistantSchema $schema, AssistantQuery $query): Responsable
-    {
-        $this->authorize('create', Assistant::class);
-
-        $data = $this->extractServiceDataForUpdateOrCreate($request);
-
-        $assistant = $this->assistantService->create($data, $request->user());
-
-        return DataResponse::make($assistant)
-            ->withQueryParameters($query)
-            ->didCreate();
-    }
-
-    public function update(AssistantRequest $request, AssistantSchema $schema, AssistantQuery $query, Assistant $assistant): Responsable
+    public function created(Assistant $assistant, AssistantRequest $request, AssistantQuery $query): void
     {
-        $this->authorize('update', $assistant);
-
-        $data = $this->extractServiceDataForUpdateOrCreate($request);
-
-        $assistant = $this->assistantService->update($assistant, $data);
-
-        return DataResponse::make($assistant)
-            ->withQueryParameters($query);
+        Event::dispatch(new AssistantCreated($assistant));
     }
 
-    public function destroy(Assistant $assistant): Response
+    public function updated(Assistant $assistant, AssistantRequest $request, AssistantQuery $query): void
     {
-        $this->authorize('delete', $assistant);
+        $changedKeys = array_values(array_filter(
+            array_keys($assistant->getChanges()),
+            fn(string $key) => $key !== 'updated_at',
+        ));
 
-        $assistant->delete();
+        $validated = $request->validated();
+        if (isset($validated['tags'])) {
+            $changedKeys[] = 'tags';
+        }
+        if (isset($validated['ai_tools'])) {
+            $changedKeys[] = 'ai_tools';
+        }
+        if (isset($validated['user_prompts'])) {
+            $changedKeys[] = 'user_prompts';
+        }
 
-        return response()->noContent();
+        if ($changedKeys !== []) {
+            Event::dispatch(new AssistantUpdated(
+                $assistant,
+                $validated['version_text'] ?? null,
+                $changedKeys,
+            ));
+        }
     }
 
     public function remix(AssistantSchema $schema, AssistantQuery $query, Assistant $assistant): Responsable

app/Http/Resources/AiTool/AiToolResource.php

@@ -7,6 +7,7 @@
 use App\Services\Assistant\Values\ReleaseStage;
 use Illuminate\Validation\Rule;
 use LaravelJsonApi\Laravel\Http\Requests\ResourceRequest;
+use LaravelJsonApi\Validation\Rule as JsonApiRule;
 
 class AssistantRequest extends ResourceRequest
 {
@@ -29,22 +30,15 @@ public function rules(): array
             'allow_model_select' => ['required', 'boolean'],
             'release_stage' => ['required', Rule::enum(ReleaseStage::class)],
             'formality' => ['required', 'string'],
-            'category' => ['required', 'array:type,id'],
-            'category.type' => ['required', 'in:categories'],
-            'category.id' => ['required', 'integer', 'exists:categories,id'],
-            'language' => ['required', 'array:type,id'],
-            'language.type' => ['required', 'in:languages'],
-            'language.id' => ['required', 'integer', 'exists:languages,id'],
+            'category' => ['required', JsonApiRule::toOne()],
+            'language' => ['required', JsonApiRule::toOne()],
             'model' => ['required', 'string'],
             'model_length' => ['required', 'integer', 'min:1'],
             'model_temp' => ['required', 'numeric', 'min:0', 'max:1'],
             'model_top_p' => ['required', 'numeric', 'min:0', 'max:1'],
-            'user_prompts' => ['array'],
-            'user_prompts.*.id' => ['required', 'integer', 'exists:user_prompts,id'],
-            'ai_tools' => ['array'],
-            'ai_tools.*.id' => ['required', 'integer', 'exists:ai_tools,id'],
-            'tags' => ['array'],
-            'tags.*.id' => ['required', 'integer', 'exists:tags,id'],
+            'user_prompts' => [JsonApiRule::toMany()],
+            'ai_tools' => [JsonApiRule::toMany()],
+            'tags' => [JsonApiRule::toMany()],
         ];
 
         if ($this->isUpdating()) {
@@ -65,21 +59,17 @@ public function rules(): array
             $rules['detail_description'] = ['sometimes', 'nullable', 'string'];
             $rules['allow_remix'] = ['sometimes', 'boolean'];
             $rules['allow_model_select'] = ['sometimes', 'boolean'];
-            $rules['category'] = ['sometimes', 'array:type,id'];
-            $rules['category.type'] = ['sometimes', 'in:categories'];
-            $rules['category.id'] = ['sometimes', 'integer', 'exists:categories,id'];
-            $rules['language'] = ['sometimes', 'array:type,id'];
-            $rules['language.type'] = ['sometimes', 'in:languages'];
-            $rules['language.id'] = ['sometimes', 'integer', 'exists:languages,id'];
+            $rules['category'] = ['sometimes', JsonApiRule::toOne()];
+            $rules['language'] = ['sometimes', JsonApiRule::toOne()];
             $rules['release_stage'] = ['sometimes', Rule::enum(ReleaseStage::class)];
             $rules['formality'] = ['sometimes', 'string'];
             $rules['model'] = ['sometimes', 'string'];
             $rules['model_length'] = ['sometimes', 'integer', 'min:1'];
             $rules['model_temp'] = ['sometimes', 'numeric', 'min:0', 'max:1'];
             $rules['model_top_p'] = ['sometimes', 'numeric', 'min:0', 'max:1'];
-            $rules['user_prompts'] = ['sometimes', 'array'];
-            $rules['ai_tools'] = ['sometimes', 'array'];
-            $rules['tags'] = ['sometimes', 'array'];
+            $rules['user_prompts'] = ['sometimes', JsonApiRule::toMany()];
+            $rules['ai_tools'] = ['sometimes', JsonApiRule::toMany()];
+            $rules['tags'] = ['sometimes', JsonApiRule::toMany()];
             $rules['version_text'] = ['sometimes', 'nullable', 'string'];
         }
 

app/Http/Resources/Organization/OrganizationResource.php

@@ -80,6 +80,6 @@ public function indexQuery(?Request $request, Builder $query): Builder
             return $query;
         }
 
-        return app(AssistantRepository::class)->scopeVisible($query, $user);
+        return app(AssistantRepository::class)->filterVisibleForUser($query, $user);
     }
 }

app/Http/Resources/Tag/TagResource.php

@@ -4,6 +4,7 @@
 
 namespace App\JsonApi\V1\Assistants;
 
+use App\Services\Assistant\Repositories\AssistantRepository;
 use LaravelJsonApi\Eloquent\Contracts\Filter;
 use LaravelJsonApi\Eloquent\Filters\Concerns\DeserializesValue;
 use LaravelJsonApi\Eloquent\Filters\Concerns\IsSingular;
@@ -25,8 +26,6 @@ public function key(): string
 
     public function apply($query, $value)
     {
-        return $query->whereHas('category', function ($q) use ($value) {
-            $q->where('text', $value);
-        });
+        return app(AssistantRepository::class)->filterByCategoryText($query, $value);
     }
 }