refactor: JSON:API (#3971)

* refactor: json:api refactor iteration 1
* chore: delete dead code
* fix: regressions
* chore: move additions/changes to package
* feat: AccessTokenResource
* feat: allow dependency injection in resources
* feat: `ApiResource` extender
* feat: improve
* feat: refactor tags extension
* feat: refactor flags extension
* fix: regressions
* fix: drop bc layer
* feat: refactor suspend extension
* feat: refactor subscriptions extension
* feat: refactor approval extension
* feat: refactor sticky extension
* feat: refactor nicknames extension
* feat: refactor mentions extension
* feat: refactor lock extension
* feat: refactor likes extension
* chore: merge conflicts
* feat: refactor extension-manager extension
* feat: context current endpoint helpers
* chore: minor
* feat: cleaner sortmap implementation
* chore: drop old package
* chore: not needed (auto scoping)
* fix: actor only fields
* refactor: simplify index endpoint
* feat: eager loading
* test: adapt
* test: phpstan
* test: adapt
* fix: typing
* fix: approving content
* tet: adapt frontend tests
* chore: typings
* chore: review
* fix: breaking change

extensions/package-manager/extend.php

@@ -10,6 +10,7 @@
 namespace Flarum\ExtensionManager;
 
 use Flarum\Extend;
+use Flarum\ExtensionManager\Api\Resource\TaskResource;
 use Flarum\Foundation\Paths;
 use Flarum\Frontend\Document;
 use Illuminate\Contracts\Queue\Queue;
@@ -25,9 +26,10 @@ return [
         ->post('/extension-manager/minor-update', 'extension-manager.minor-update', Api\Controller\MinorUpdateController::class)
         ->post('/extension-manager/major-update', 'extension-manager.major-update', Api\Controller\MajorUpdateController::class)
         ->post('/extension-manager/global-update', 'extension-manager.global-update', Api\Controller\GlobalUpdateController::class)
-        ->get('/extension-manager-tasks', 'extension-manager.tasks.index', Api\Controller\ListTasksController::class)
         ->post('/extension-manager/composer', 'extension-manager.composer', Api\Controller\ConfigureComposerController::class),
 
+    new Extend\ApiResource(TaskResource::class),
+
     (new Extend\Frontend('admin'))
         ->css(__DIR__.'/less/admin.less')
         ->js(__DIR__.'/js/dist/admin.js')

extensions/package-manager/js/src/admin/components/ConfigureJson.tsx

@@ -1,7 +1,8 @@
 import app from 'flarum/admin/app';
 import type Mithril from 'mithril';
 import Component, { type ComponentAttrs } from 'flarum/common/Component';
-import { CommonSettingsItemOptions, type SettingsComponentOptions } from '@flarum/core/src/admin/components/AdminPage';
+import { type SettingsComponentOptions } from '@flarum/core/src/admin/components/AdminPage';
+import FormGroup, { type CommonFieldOptions } from 'flarum/common/components/FormGroup';
 import AdminPage from 'flarum/admin/components/AdminPage';
 import type ItemList from 'flarum/common/utils/ItemList';
 import Stream from 'flarum/common/utils/Stream';
@@ -49,8 +50,8 @@ export default abstract class ConfigureJson<CustomAttrs extends IConfigureJson =
     ];
   }
 
-  customSettingComponents(): ItemList<(attributes: CommonSettingsItemOptions) => Mithril.Children> {
-    return AdminPage.prototype.customSettingComponents();
+  customSettingComponents(): ItemList<(attributes: CommonFieldOptions) => Mithril.Children> {
+    return FormGroup.prototype.customFieldComponents();
   }
 
   setting(key: string) {

extensions/package-manager/js/src/admin/states/QueueState.ts

@@ -22,7 +22,7 @@ export default class QueueState {
 
     return app.store.find<Task[]>('extension-manager-tasks', params || {}).then((data) => {
       this.tasks = data;
-      this.total = data.payload.meta?.total;
+      this.total = data.payload.meta?.total || 0;
 
       m.redraw();
 

extensions/package-manager/src/Api/Controller/ListTasksController.php

@@ -1,58 +0,0 @@
-<?php
-
-/*
- * This file is part of Flarum.
- *
- * For detailed copyright and license information, please view the
- * LICENSE file that was distributed with this source code.
- */
-
-namespace Flarum\ExtensionManager\Api\Controller;
-
-use Flarum\Api\Controller\AbstractListController;
-use Flarum\ExtensionManager\Api\Serializer\TaskSerializer;
-use Flarum\ExtensionManager\Task\Task;
-use Flarum\Http\RequestUtil;
-use Flarum\Http\UrlGenerator;
-use Psr\Http\Message\ServerRequestInterface;
-use Tobscure\JsonApi\Document;
-
-class ListTasksController extends AbstractListController
-{
-    public ?string $serializer = TaskSerializer::class;
-
-    public function __construct(
-        protected UrlGenerator $url
-    ) {
-    }
-
-    protected function data(ServerRequestInterface $request, Document $document): iterable
-    {
-        $actor = RequestUtil::getActor($request);
-
-        $actor->assertAdmin();
-
-        $limit = $this->extractLimit($request);
-        $offset = $this->extractOffset($request);
-
-        $results = Task::query()
-            ->latest('id')
-            ->offset($offset)
-            ->limit($limit)
-            ->get();
-
-        $total = Task::query()->count();
-
-        $document->addMeta('total', (string) $total);
-
-        $document->addPaginationLinks(
-            $this->url->to('api')->route('extension-manager.tasks.index'),
-            $request->getQueryParams(),
-            $offset,
-            $limit,
-            $total
-        );
-
-        return $results;
-    }
-}

extensions/package-manager/src/Api/Resource/TaskResource.php

@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\ExtensionManager\Api\Resource;
+
+use Flarum\Api\Endpoint;
+use Flarum\Api\Resource\AbstractDatabaseResource;
+use Flarum\Api\Schema;
+use Flarum\Api\Sort\SortColumn;
+use Flarum\ExtensionManager\Task\Task;
+
+class TaskResource extends AbstractDatabaseResource
+{
+    public function type(): string
+    {
+        return 'package-manager-tasks';
+    }
+
+    public function model(): string
+    {
+        return Task::class;
+    }
+
+    public function endpoints(): array
+    {
+        return [
+            Endpoint\Index::make()
+                ->defaultSort('-createdAt')
+                ->paginate(),
+        ];
+    }
+
+    public function fields(): array
+    {
+        return [
+            Schema\Str::make('status'),
+            Schema\Str::make('operation'),
+            Schema\Str::make('command'),
+            Schema\Str::make('package'),
+            Schema\Str::make('output'),
+            Schema\DateTime::make('createdAt'),
+            Schema\DateTime::make('startedAt'),
+            Schema\DateTime::make('finishedAt'),
+            Schema\Number::make('peakMemoryUsed'),
+        ];
+    }
+
+    public function sorts(): array
+    {
+        return [
+            SortColumn::make('createdAt'),
+        ];
+    }
+}

extensions/package-manager/src/Api/Serializer/TaskSerializer.php

@@ -1,50 +0,0 @@
-<?php
-
-/*
- * This file is part of Flarum.
- *
- * For detailed copyright and license information, please view the
- * LICENSE file that was distributed with this source code.
- */
-
-namespace Flarum\ExtensionManager\Api\Serializer;
-
-use Flarum\Api\Serializer\AbstractSerializer;
-use Flarum\ExtensionManager\Task\Task;
-use InvalidArgumentException;
-
-class TaskSerializer extends AbstractSerializer
-{
-    /**
-     * {@inheritdoc}
-     */
-    protected $type = 'extension-manager-tasks';
-
-    /**
-     * {@inheritdoc}
-     *
-     * @param Task $model
-     * @throws InvalidArgumentException
-     */
-    protected function getDefaultAttributes($model): array
-    {
-        if (! ($model instanceof Task)) {
-            throw new InvalidArgumentException(
-                get_class($this).' can only serialize instances of '.Task::class
-            );
-        }
-
-        return [
-            'status' => $model->status,
-            'operation' => $model->operation,
-            'command' => $model->command,
-            'package' => $model->package,
-            'output' => $model->output,
-            'guessedCause' => $model->guessed_cause,
-            'createdAt' => $model->created_at,
-            'startedAt' => $model->started_at,
-            'finishedAt' => $model->finished_at,
-            'peakMemoryUsed' => $model->peak_memory_used,
-        ];
-    }
-}

extensions/package-manager/src/Task/TaskRepository.php

@@ -1,34 +0,0 @@
-<?php
-
-/*
- * This file is part of Flarum.
- *
- * For detailed copyright and license information, please view the
- * LICENSE file that was distributed with this source code.
- */
-
-namespace Flarum\ExtensionManager\Task;
-
-use Flarum\User\User;
-use Illuminate\Database\Eloquent\Builder;
-
-class TaskRepository
-{
-    /**
-     * @return Builder
-     */
-    public function query()
-    {
-        return Task::query();
-    }
-
-    /**
-     * @param int $id
-     * @param User $actor
-     * @return Task
-     */
-    public function findOrFail($id, User $actor = null): Task
-    {
-        return Task::findOrFail($id);
-    }
-}