chore: Update for Flarum 2.0

.github/workflows/backend.yml

@@ -4,7 +4,7 @@ on: [workflow_dispatch, push, pull_request]
 
 jobs:
   run:
-    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@1.x
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@2.x
     with:
       enable_backend_testing: true
       enable_phpstan: true

.github/workflows/frontend.yml

@@ -4,7 +4,7 @@ on: [workflow_dispatch, push, pull_request]
 
 jobs:
   run:
-    uses: flarum/framework/.github/workflows/REUSABLE_frontend.yml@1.x
+    uses: flarum/framework/.github/workflows/REUSABLE_frontend.yml@2.x
     with:
       enable_bundlewatch: false
       enable_prettier: true
@@ -13,7 +13,7 @@ jobs:
       frontend_directory: ./js
       backend_directory: .
       js_package_manager: yarn
-      main_git_branch: 1.x
+      main_git_branch: 2.x
 
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

composer.json

@@ -31,13 +31,9 @@
         }
     ],
     "require": {
-        "flarum/core": "^1.7",
-        "fof/extend": "^1.0.0",
+        "flarum/core": "^2.0.0",
         "ext-json": "*"
     },
-    "replace": {
-        "reflar/gamification": "*"
-    },
     "autoload": {
         "psr-4": {
             "FoF\\Gamification\\": "src/"
@@ -53,14 +49,14 @@
                 "color": "#fff"
             }
         },
-        "flagrow": {
-            "discuss": "https://discuss.flarum.org/d/20671"
-        },
         "flarum-cli": {
             "modules": {
                 "githubActions": true,
                 "backendTesting": true
             }
+        },
+        "branch-alias": {
+            "2.x": "2.x-dev"
         }
     },
     "scripts": {
@@ -82,13 +78,16 @@
         "test:setup": "Sets up a database for use with integration tests. Execute this only once."
     },
     "require-dev": {
-        "flarum/phpstan": "*",
+        "flarum/phpstan": "^2.0.0",
         "flarum/pusher": "*",
-        "flarum/testing": "^1.0.0"
+        "flarum/testing": "^2.0.0",
+        "flarum/likes": "*"
     },
     "autoload-dev": {
         "psr-4": {
             "FoF\\Gamification\\Tests\\": "tests/"
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

extend.php

@@ -11,24 +11,22 @@
 
 namespace FoF\Gamification;
 
-use Flarum\Api\Controller;
-use Flarum\Api\Serializer;
+use Flarum\Api\Context;
+use Flarum\Api\Endpoint;
+use Flarum\Api\Resource;
+use Flarum\Api\Sort\SortColumn;
 use Flarum\Discussion\Discussion;
 use Flarum\Discussion\Event\Started;
-use Flarum\Discussion\Filter\DiscussionFilterer;
 use Flarum\Discussion\Search\DiscussionSearcher;
 use Flarum\Extend;
 use Flarum\Post\Event\Deleted;
 use Flarum\Post\Event\Posted;
-use Flarum\Post\Event\Saving;
-use Flarum\Post\Filter\PostFilterer;
+use Flarum\Post\Filter\PostSearcher;
 use Flarum\Post\Post;
+use Flarum\User\Search\UserSearcher;
 use Flarum\User\User;
-use FoF\Extend\Extend\ExtensionSettings;
 use FoF\Gamification\Api\Controllers;
-use FoF\Gamification\Api\Serializers;
 use FoF\Gamification\Notification\VoteBlueprint;
-use FoF\Gamification\Provider\GamificationSortOptionsProvider;
 
 return [
     (new Extend\Frontend('admin'))
@@ -63,131 +61,87 @@
         ->cast('votes', 'int')
         ->cast('hotness', 'float'),
 
-    (new ExtensionSettings())
-        ->setPrefix('fof-gamification.')
-        ->addKeys([
-            'iconName',
-            'pointsPlaceholder',
-            'showVotesOnDiscussionPage',
-            'rankAmt',
-            'customRankingImages',
-            'useAlternateLayout',
-            'upVotesOnly',
-            'iconNameAlt',
-            'altPostVotingUi',
-        ]),
-
     (new Extend\Routes('api'))
         ->post('/fof/gamification/convert', 'fof.gamification.convert', Controllers\ConvertLikesController::class)
-        ->post('/fof/gamification/topimage{id}', 'fof.topImage.add', Controllers\UploadTopImageController::class)
-        ->delete('/fof/gamification/topimage{id}', 'fof.topImage.delete', Controllers\DeleteTopImageController::class)
-        ->get('/ranks', 'ranks.index', Controllers\ListRanksController::class)
-        ->post('/ranks', 'ranks.create', Controllers\CreateRankController::class)
-        ->patch('/ranks/{id}', 'ranks.update', Controllers\UpdateRankController::class)
-        ->delete('/ranks/{id}', 'ranks.delete', Controllers\DeleteRankController::class)
-        ->get('/rankings', 'rankings', Controllers\OrderByPointsController::class),
+        ->post('/fof/gamification/topimage{id}', 'fof.topImage.add', Controllers\UploadTopImageController::class),
 
     (new Extend\Policy())
         ->modelPolicy(Post::class, Access\PostPolicy::class),
 
     (new Extend\Event())
-        ->listen(Saving::class, Listeners\SaveVotesToDatabase::class)
         ->listen(Posted::class, Listeners\AddVoteHandler::class)
         ->listen(Deleted::class, Listeners\RemoveVoteHandler::class)
         ->listen(Started::class, Listeners\AddDiscussionVotes::class)
         ->listen(Events\UserPointsUpdated::class, Listeners\UpdateAutoAssignedGroups::class)
         ->subscribe(Listeners\QueueJobs::class),
 
-    (new Extend\ApiSerializer(Serializer\PostSerializer::class))
-        ->hasMany('upvotes', Serializer\BasicUserSerializer::class)
-        ->hasMany('downvotes', Serializer\BasicUserSerializer::class),
-
-    (new Extend\ApiSerializer(Serializer\UserSerializer::class))
-        ->hasMany('ranks', Serializers\RankSerializer::class),
-
-    (new Extend\ApiSerializer(Serializer\ForumSerializer::class))
-        ->hasMany('ranks', Serializers\RankSerializer::class)
-        ->attributes(Api\AddForumAttributes::class),
-
-    (new Extend\ApiController(Controller\ShowForumController::class))
-        ->prepareDataForSerialization(function (Controller\ShowForumController $controller, &$data) {
-            $data['ranks'] = Rank::get();
-        }),
+    new Extend\ApiResource(Api\Resource\RankResource::class),
 
     (new Extend\Settings())
+        ->default('fof-gamification.iconName', 'thumbs')
+        ->default('fof-gamification.iconNameAlt', 'arrow')
+        ->default('fof-gamification.showVotesOnDiscussionPage', true)
+        ->default('fof-gamification.useAlternateLayout', false)
+        ->default('fof-gamification.upVotesOnly', false)
+        ->default('fof-gamification.altPostVotingUi', false)
         ->default('fof-gamification.blockedUsers', '')
         ->default('fof-gamification.rankAmt', 2)
-        ->default('fof-gamification.firstPostOnly', false)
-        ->default('fof-gamification.allowSelfVotes', true),
-
-    (new Extend\ApiSerializer(Serializer\UserSerializer::class))
-        ->attributes(AddUserAttributes::class),
-
-    (new Extend\ApiSerializer(Serializer\BasicDiscussionSerializer::class))
-        ->attributes(AddDiscussionData::class),
-
-    (new Extend\ApiSerializer(Serializer\PostSerializer::class))
-        ->attributes(AddPostData::class),
-
-    (new Extend\ApiController(Controller\ListUsersController::class))
-        ->addInclude('ranks'),
-
-    (new Extend\ApiController(Controller\ShowUserController::class))
-        ->addInclude('ranks'),
-
-    (new Extend\ApiController(Controller\CreateUserController::class))
-        ->addInclude('ranks'),
-
-    (new Extend\ApiController(Controllers\OrderByPointsController::class))
-        ->addInclude('ranks'),
-
-    (new Extend\ApiController(Controller\UpdateUserController::class))
-        ->addInclude('ranks'),
-
-    (new Extend\ApiController(Controller\ShowDiscussionController::class))
-        ->addInclude('posts.user.ranks')
-        ->loadWhere('posts.actualvotes', [LoadActorVoteRelationship::class, 'mutateRelation'])
-        ->prepareDataForSerialization([LoadActorVoteRelationship::class, 'sumRelation']),
-
-    (new Extend\ApiController(Controller\ListDiscussionsController::class))
-        ->addSortField('hotness')
-        ->addSortField('votes')
-        ->loadWhere('firstPost.actualvotes', [LoadActorVoteRelationship::class, 'mutateRelation'])
-        ->prepareDataForSerialization([LoadActorVoteRelationship::class, 'sumRelation']),
-
-    (new Extend\ApiController(Controller\ListPostsController::class))
-        ->addInclude('user.ranks')
-        ->addOptionalInclude(['upvotes', 'downvotes'])
-        ->loadWhere('actualvotes', [LoadActorVoteRelationship::class, 'mutateRelation'])
-        ->prepareDataForSerialization([LoadActorVoteRelationship::class, 'sumRelation']),
-
-    (new Extend\ApiController(Controller\ShowPostController::class))
-        ->addInclude('user.ranks')
-        ->addOptionalInclude(['upvotes', 'downvotes'])
-        ->loadWhere('actualvotes', [LoadActorVoteRelationship::class, 'mutateRelation'])
-        ->prepareDataForSerialization([LoadActorVoteRelationship::class, 'sumRelation']),
+        ->default('fof-gamification.firstPostOnly', true)
+        ->default('fof-gamification.allowSelfVotes', true)
+        ->serializeToForum('fof-gamification.showVotesOnDiscussionPage', 'fof-gamification.showVotesOnDiscussionPage', 'boolval')
+        ->serializeToForum('fof-gamification.useAlternateLayout', 'fof-gamification.useAlternateLayout', 'boolval')
+        ->serializeToForum('fof-gamification.upVotesOnly', 'fof-gamification.upVotesOnly', 'boolval')
+        ->serializeToForum('fof-gamification.altPostVotingUi', 'fof-gamification.altPostVotingUi', 'boolval')
+        ->serializeToForum('fof-gamification.iconName', 'fof-gamification.iconName')
+        ->serializeToForum('fof-gamification.iconNameAlt', 'fof-gamification.iconNameAlt')
+        ->serializeToForum('fof-gamification.rankAmt', 'fof-gamification.rankAmt', 'intval')
+        ->serializeToForum('fof-gamification.firstPostOnly', 'fof-gamification.firstPostOnly', 'boolval'),
+
+    (new Extend\ApiResource(Resource\UserResource::class))
+        ->endpoint(['show', 'update', 'create', 'index'], function (Endpoint\Show|Endpoint\Update|Endpoint\Create|Endpoint\Index $endpoint) {
+            return $endpoint->addDefaultInclude(['ranks']);
+        })
+        ->fields(Api\UserResourceFields::class)
+        ->sorts(fn () => [
+            SortColumn::make('votes')
+                ->visible(function (Context $context) {
+                    return $context->getActor()->can('fof.gamification.viewRankingPage');
+                }),
+        ]),
 
-    (new Extend\ApiController(Controller\CreatePostController::class))
-        ->addInclude('user.ranks')
-        ->addOptionalInclude(['upvotes', 'downvotes']),
+    (new Extend\ApiResource(Resource\DiscussionResource::class))
+        ->fields(Api\DiscussionResourceFields::class)
+        ->sorts(fn () => [
+            SortColumn::make('hotness')
+                ->descendingAlias('hot'),
+            SortColumn::make('votes')
+                ->descendingAlias('votes'),
+        ])
+        ->endpoint('index', function (Endpoint\Index $endpoint) {
+            return $endpoint->eagerLoadWhere('firstPost.actualvotes', function ($query, Context $context) {
+                $query->where('user_id', $context->getActor()->id);
+            });
+        }),
 
-    (new Extend\ApiController(Controller\UpdatePostController::class))
-        ->addInclude('user.ranks')
-        ->addOptionalInclude(['upvotes', 'downvotes'])
-        ->loadWhere('actualvotes', [LoadActorVoteRelationship::class, 'mutateRelation'])
-        ->prepareDataForSerialization([LoadActorVoteRelationship::class, 'sumRelation']),
+    (new Extend\ApiResource(Resource\PostResource::class))
+        ->fields(Api\PostResourceFields::class)
+        ->endpoint(['index', 'show', 'create', 'update'], function (Endpoint\Index|Endpoint\Show|Endpoint\Create|Endpoint\Update $endpoint) {
+            return $endpoint->addDefaultInclude(['user.ranks']);
+        })
+        ->endpoint(['index', 'show', 'update'], function (Endpoint\Index|Endpoint\Show|Endpoint\Update $endpoint) {
+            return $endpoint->eagerLoadWhere('actualvotes', function ($query, Context $context) {
+                $query->where('user_id', $context->getActor()->id);
+            });
+        }),
 
-    (new Extend\ApiController(Controller\ShowForumController::class))
-        ->addInclude('ranks'),
+    (new Extend\ApiResource(Resource\ForumResource::class))
+        ->fields(Api\ForumResourceFields::class)
+        ->endpoint('show', function (Endpoint\Show $endpoint) {
+            return $endpoint->addDefaultInclude(['ranks']);
+        }),
 
     (new Extend\Notification())
-        ->type(VoteBlueprint::class, Serializer\BasicPostSerializer::class, ['alert']),
-
-    (new Extend\SimpleFlarumSearch(DiscussionSearcher::class))
-        ->addGambit(Search\HotFilterGambit::class),
-
-    (new Extend\Filter(DiscussionFilterer::class))
-        ->addFilter(Search\HotFilterGambit::class),
+        ->type(VoteBlueprint::class, ['alert']),
 
     (new Extend\Console())
         ->command(Console\ResyncUserVotes::class)
@@ -197,9 +151,8 @@
     (new Extend\View())
         ->namespace('fof-gamification', __DIR__.'/resources/views'),
 
-    (new Extend\ServiceProvider())
-        ->register(GamificationSortOptionsProvider::class),
-
-    (new Extend\Filter(PostFilterer::class))
-        ->addFilter(Filter\VotedFilter::class),
+    (new Extend\SearchDriver(\Flarum\Search\Database\DatabaseSearchDriver::class))
+        ->addFilter(DiscussionSearcher::class, Search\HotFilter::class)
+        ->addFilter(PostSearcher::class, Filter\VotedFilter::class)
+        ->addFilter(UserSearcher::class, Filter\RankableFilter::class),
 ];

js/admin.ts

@@ -1,2 +1 @@
-export * from './src/common';
 export * from './src/admin';

js/forum.ts

@@ -1,2 +1 @@
-export * from './src/common';
 export * from './src/forum';

js/package.json

@@ -1,29 +1,29 @@
 {
-    "name": "@fof/gamification",
-    "private": true,
-    "prettier": "@flarum/prettier-config",
-    "dependencies": {
-        "lodash.debounce": "^4.0.8"
-    },
-    "devDependencies": {
-        "@flarum/prettier-config": "^1.0.0",
-        "flarum-tsconfig": "^1.0.3",
-        "flarum-webpack-config": "^2.0.0",
-        "prettier": "^3.0.3",
-        "typescript-coverage-report": "^0.6.1",
-        "webpack": "^5.89.0",
-        "webpack-cli": "^5.1.4"
-    },
-    "scripts": {
-        "dev": "webpack --mode development --watch",
-        "build": "webpack --mode production",
-        "analyze": "cross-env ANALYZER=true yarn run build",
-        "format": "prettier --write src",
-        "format-check": "prettier --check src",
-        "clean-typings": "npx rimraf dist-typings && mkdir dist-typings",
-        "build-typings": "yarn run clean-typings && ([ -e src/@types ] && cp -r src/@types dist-typings/@types || true) && tsc && yarn run post-build-typings",
-        "post-build-typings": "find dist-typings -type f -name '*.d.ts' -print0 | xargs -0 sed -i 's,../src/@types,@types,g'",
-        "check-typings": "tsc --noEmit --emitDeclarationOnly false",
-        "check-typings-coverage": "typescript-coverage-report"
-    }
+  "name": "@fof/gamification",
+  "private": true,
+  "prettier": "@flarum/prettier-config",
+  "dependencies": {
+    "lodash.debounce": "^4.0.8"
+  },
+  "devDependencies": {
+    "@flarum/prettier-config": "^1.0.0",
+    "flarum-tsconfig": "^2.0.0",
+    "flarum-webpack-config": "^3.0.2",
+    "prettier": "^3.0.3",
+    "typescript-coverage-report": "^0.6.1",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
+  },
+  "scripts": {
+    "dev": "webpack --mode development --watch",
+    "build": "webpack --mode production",
+    "analyze": "cross-env ANALYZER=true yarn run build",
+    "format": "prettier --write src",
+    "format-check": "prettier --check src",
+    "clean-typings": "npx rimraf dist-typings && mkdir dist-typings",
+    "build-typings": "yarn run clean-typings && ([ -e src/@types ] && cp -r src/@types dist-typings/@types || true) && tsc && yarn run post-build-typings",
+    "post-build-typings": "find dist-typings -type f -name '*.d.ts' -print0 | xargs -0 sed -i 's,../src/@types,@types,g'",
+    "check-typings": "tsc --noEmit --emitDeclarationOnly false",
+    "check-typings-coverage": "typescript-coverage-report"
+  }
 }