2.0 Upgrade

.github/workflows/backend.yml

@@ -4,10 +4,9 @@ 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: false
+      enable_backend_testing: true
       enable_phpstan: true
-      php_versions: '["7.4", "8.0", "8.1", "8.2"]'
 
       backend_directory: .

.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: flarum-2.x
+      main_git_branch: 2.x
 
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

.gitignore

@@ -2,3 +2,4 @@ js/dist
 js/node_modules
 vendor
 composer.lock
+tests/.phpunit.result.cache

composer.json

@@ -21,9 +21,9 @@
         }
     ],
     "require": {
-        "php": "^7.4 || ^8.0",
-        "flarum/core": "^1.7.0"
+        "flarum/core": "^2.0.0-beta"
     },
+    "minimum-stability": "dev",
     "authors": [
         {
             "name": "Christian Lopez",
@@ -51,18 +51,37 @@
         },
         "flarum-cli": {
             "modules": {
-                "githubActions": true
+                "githubActions": true,
+                "backendTesting": true
             }
         }
     },
     "require-dev": {
-        "flarum/phpstan": "*"
+        "flarum/phpstan": "^2.0.0-beta",
+        "flarum/testing": "^2.0.0-beta",
+        "flarum/tags": "^2.0.0-beta"
     },
     "scripts": {
         "analyse:phpstan": "phpstan analyse",
-        "clear-cache:phpstan": "phpstan clear-result-cache"
+        "clear-cache:phpstan": "phpstan clear-result-cache",
+        "test": [
+            "@test:unit",
+            "@test:integration"
+        ],
+        "test:unit": "phpunit -c tests/phpunit.unit.xml",
+        "test:integration": "phpunit -c tests/phpunit.integration.xml",
+        "test:setup": "@php tests/integration/setup.php"
     },
     "scripts-descriptions": {
-        "analyse:phpstan": "Run static analysis"
+        "analyse:phpstan": "Run static analysis",
+        "test": "Runs all tests.",
+        "test:unit": "Runs all unit tests.",
+        "test:integration": "Runs all integration tests.",
+        "test:setup": "Sets up a database for use with integration tests. Execute this only once."
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "FoF\\FrontPage\\Tests\\": "tests/"
+        }
     }
 }

extend.php

@@ -11,13 +11,13 @@
 
 namespace FoF\FrontPage;
 
-use Flarum\Api\Controller\ListDiscussionsController;
-use Flarum\Api\Serializer\DiscussionSerializer;
+use Flarum\Api\Resource;
+use Flarum\Api\Sort\SortColumn;
 use Flarum\Discussion\Discussion;
-use Flarum\Discussion\Event\Saving;
-use Flarum\Discussion\Filter\DiscussionFilterer;
 use Flarum\Discussion\Search\DiscussionSearcher;
 use Flarum\Extend;
+use Flarum\Search\Database\DatabaseSearchDriver;
+use FoF\FrontPage\Api\DiscussionResourceFields;
 
 return [
     (new Extend\Frontend('forum'))
@@ -28,28 +28,24 @@
         ->js(__DIR__.'/js/dist/admin.js'),
     new Extend\Locales(__DIR__.'/resources/locale'),
 
-    (new Extend\Event())
-        ->listen(Saving::class, Listeners\SaveFrontToDatabase::class),
-
-    (new Extend\SimpleFlarumSearch(DiscussionSearcher::class))
-        ->addGambit(Query\FrontFilterGambit::class),
-
-    (new Extend\Filter(DiscussionFilterer::class))
-        ->addFilter(Query\FrontFilterGambit::class),
-
     (new Extend\Model(Discussion::class))
         ->cast('frontdate', 'datetime')
         ->cast('frontpage', 'bool'),
 
-    (new Extend\ApiSerializer(DiscussionSerializer::class))
-        ->attributes(Listeners\AddApiAttributes::class),
+    (new Extend\ApiResource(Resource\DiscussionResource::class))
+        ->fields(DiscussionResourceFields::class),
 
-    (new Extend\ApiController(ListDiscussionsController::class))
-        ->addSortField('frontdate'),
+    (new Extend\ApiResource(Resource\DiscussionResource::class))
+        ->sorts(fn () => [
+            SortColumn::make('frontdate'),
+        ]),
 
     (new Extend\ServiceProvider())
         ->register(Provider\FrontpageSortmapProvider::class),
 
     (new Extend\Middleware('forum'))
         ->add(Middleware\AddFrontpageFilter::class),
+
+    (new Extend\SearchDriver(DatabaseSearchDriver::class))
+        ->addFilter(DiscussionSearcher::class, Query\FrontFilter::class),
 ];

js/package.json

@@ -4,13 +4,13 @@
   "private": true,
   "prettier": "@flarum/prettier-config",
   "devDependencies": {
-    "prettier": "^3.0.3",
     "@flarum/prettier-config": "^1.0.0",
-    "flarum-tsconfig": "^1.0.3",
-    "flarum-webpack-config": "^2.0.0",
+    "flarum-tsconfig": "^2.0.0",
+    "flarum-webpack-config": "^3.0.0",
+    "prettier": "^3.0.3",
+    "typescript-coverage-report": "^0.6.1",
     "webpack": "^5.94.0",
-    "webpack-cli": "^5.1.4",
-    "typescript-coverage-report": "^0.6.1"
+    "webpack-cli": "^5.1.4"
   },
   "scripts": {
     "dev": "webpack --mode development --watch",

js/src/admin/extend.ts

@@ -0,0 +1,16 @@
+import app from 'flarum/admin/app';
+import Extend from 'flarum/common/extenders';
+import { default as commonExtend } from '../common/extend';
+
+export default [
+  ...commonExtend,
+
+  new Extend.Admin().permission(
+    () => ({
+      icon: 'fas fa-home',
+      label: app.translator.trans('fof-frontpage.admin.permissions.can_push_to_frontpage_label'),
+      permission: 'discussion.front',
+    }),
+    'moderate'
+  ),
+];

js/src/admin/index.ts

@@ -1,12 +1,6 @@
 import app from 'flarum/admin/app';
+export { default as extend } from './extend';
 
-app.initializers.add('fof/frontpage', () => {
-  app.extensionData.for('fof-frontpage').registerPermission(
-    {
-      icon: 'fas fa-home',
-      label: app.translator.trans('core.admin.permissions.can_push_to_frontpage_label'),
-      permission: 'discussion.front',
-    },
-    'moderate'
-  );
+app.initializers.add('fof-frontpage', () => {
+  // Nothing here yet
 });

js/src/common/extend.ts

@@ -0,0 +1,4 @@
+import Extend from 'flarum/common/extenders';
+import FrontGambit from './gambits/FrontGambit';
+
+export default [new Extend.Search().gambit('discussions', FrontGambit)];

js/src/common/gambits/FrontGambit.ts

@@ -0,0 +1,12 @@
+import app from 'flarum/common/app';
+import { BooleanGambit } from 'flarum/common/query/IGambit';
+
+export default class FrontGambit extends BooleanGambit {
+  key() {
+    return app.translator.trans('fof-frontpage.lib.gambits.frontpage.key', {}, true);
+  }
+
+  filterKey() {
+    return 'frontpage';
+  }
+}

js/src/forum/extend.ts

@@ -1,8 +1,11 @@
+import { default as commonExtend } from '../common/extend';
 import Extend from 'flarum/common/extenders';
 import Discussion from 'flarum/common/models/Discussion';
 import Model from 'flarum/common/Model';
 
 export default [
+  ...commonExtend,
+
   new Extend.Model(Discussion) //
     .attribute<boolean>('frontpage')
     .attribute('frontdate', Model.transformDate)

js/src/forum/extenders/addFrontSort.ts

@@ -2,6 +2,7 @@ import { extend } from 'flarum/common/extend';
 import DiscussionListState from 'flarum/forum/states/DiscussionListState';
 
 import type { PaginatedListParams } from 'flarum/common/states/PaginatedListState';
+import type { SortMap } from 'flarum/common/states/PaginatedListState';
 
 export default function () {
   extend(DiscussionListState.prototype, 'requestParams', function (this: DiscussionListState, params: PaginatedListParams) {
@@ -14,7 +15,7 @@ export default function () {
     }
   });
 
-  extend(DiscussionListState.prototype, 'sortMap', function (map: Record<string, string>) {
+  extend(DiscussionListState.prototype, 'sortMap', function (map: SortMap) {
     map.front = '-frontdate';
   });
 }

js/src/forum/index.ts

@@ -5,7 +5,7 @@ import addStickyBadge from './extenders/addStickyBadge';
 
 export { default as extend } from './extend';
 
-app.initializers.add('fof/frontpage', () => {
+app.initializers.add('fof-frontpage', () => {
   addFrontSort();
   addFrontPage();
   addStickyBadge();