fix: users unable to access user directory (#107)

* chore: create tests for expected forum attributes * Apply fixes from StyleCI * chore: remove phpunit result cache * chore: update .gitignore to include .phpunit.results.cache * chore: enable backend testing * fix: showLink attr does not respect show link setting * all tests good * Apply fixes from StyleCI --------- Co-authored-by: StyleCI Bot <[email protected]>
FriendsOfFlarum · Oct 3, 2023 · e71baad · e71baad
1 parent 5bc2169
commit e71baad
Show file tree

Hide file tree

Showing 13 changed files with 490 additions and 18 deletions.
diff --git a/.github/workflows/backend.yml b/.github/workflows/backend.yml
@@ -0,0 +1,11 @@
+name: FoF User Directory PHP
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
+    with:
+      enable_backend_testing: true
+
+      backend_directory: .
diff --git a/.github/workflows/build.yml → .github/workflows/frontend.yml b/.github/workflows/build.yml → .github/workflows/frontend.yml
@@ -1,4 +1,4 @@
-name: Javascript
+name: FoF User Directory JS
 
 on: [workflow_dispatch, push, pull_request]
 
@@ -8,11 +8,12 @@ jobs:
     with:
       enable_bundlewatch: false
       enable_prettier: true
-      enable_typescript: false
+      enable_typescript: true
 
       frontend_directory: ./js
       backend_directory: .
       js_package_manager: npm
       main_git_branch: master
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ js/node_modules/
 vendor/
 composer.lock
 js/dist
+.phpunit.result.cache
diff --git a/composer.json b/composer.json
@@ -14,14 +14,14 @@
         "issues": "https://github.com/FriendsOfFlarum/user-directory/issues",
         "source": "https://github.com/FriendsOfFlarum/user-directory",
         "forum": "https://discuss.flarum.org/d/5682"
-      },
-      "homepage": "https://friendsofflarum.org",
-      "funding": [
+    },
+    "homepage": "https://friendsofflarum.org",
+    "funding": [
         {
-          "type": "website",
-          "url": "https://opencollective.com/fof/donate"
+            "type": "website",
+            "url": "https://opencollective.com/fof/donate"
         }
-      ],
+    ],
     "authors": [
         {
             "name": "Daniël Klabbers",
@@ -56,11 +56,40 @@
         },
         "flagrow": {
             "discuss": "https://discuss.flarum.org/d/5682"
+        },
+        "flarum-cli": {
+            "modules": {
+                "githubActions": true,
+                "backendTesting": true
+            }
         }
     },
     "autoload": {
         "psr-4": {
             "FoF\\UserDirectory\\": "src/"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "FoF\\UserDirectory\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "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": {
+        "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."
+    },
+    "require-dev": {
+        "flarum/testing": "^1.0.0"
     }
 }
diff --git a/extend.php b/extend.php
@@ -33,4 +33,14 @@
 
     (new Extend\View())
         ->namespace('fof.user-directory', __DIR__.'/resources/views'),
+
+    (new Extend\Settings())
+        ->default('fof-user-directory.admin.settings.link', false)
+        ->default('fof-user-directory.use-small-cards', false)
+        ->default('fof-user-directory.disable-global-search-source', false)
+        ->default('fof-user-directory.default-sort', 'default')
+        ->default('fof-user-directory.link-group-mentions', true)
+        ->serializeToForum('userDirectorySmallCards', 'fof-user-directory.use-small-cards', 'boolVal')
+        ->serializeToForum('userDirectoryDisableGlobalSearchSource', 'fof-user-directory.disable-global-search-source', 'boolVal')
+        ->serializeToForum('userDirectoryLinkGroupMentions', 'fof-user-directory.link-group-mentions', 'boolVal'),
 ];
diff --git a/src/Content/UserDirectory.php b/src/Content/UserDirectory.php
@@ -31,7 +31,12 @@ class UserDirectory
     /**
      * @var Factory
      */
-    private $view;
+    protected $view;
+
+    /**
+     * @var SettingsRepositoryInterface
+     */
+    protected $settings;
 
     /**
      * A map of sort query param values to their API sort param.
@@ -47,10 +52,11 @@ class UserDirectory
         'least_discussions' => 'discussionCount',
     ];
 
-    public function __construct(Client $api, Factory $view)
+    public function __construct(Client $api, Factory $view, SettingsRepositoryInterface $settings)
     {
         $this->api = $api;
         $this->view = $view;
+        $this->settings = $settings;
     }
 
     private function getDocument(User $actor, array $params, Request $request)
@@ -68,7 +74,7 @@ public function __invoke(Document $document, Request $request): Document
         $queryParams = $request->getQueryParams();
         $actor = RequestUtil::getActor($request);
 
-        $sort = Arr::pull($queryParams, 'sort') ?: resolve(SettingsRepositoryInterface::class)->get('fof-user-directory.default-sort');
+        $sort = Arr::pull($queryParams, 'sort') ?: $this->settings->get('fof-user-directory.default-sort');
         $q = Arr::pull($queryParams, 'q');
         $page = Arr::pull($queryParams, 'page', 1);
 

diff --git a/src/PermissionBasedForumSettings.php b/src/PermissionBasedForumSettings.php
@@ -26,16 +26,11 @@ public function __construct(SettingsRepositoryInterface $settings)
         $this->settings = $settings;
     }
 
-    public function __invoke(ForumSerializer $serializer): array
+    public function __invoke(ForumSerializer $serializer, $model, array $attributes): array
     {
-        $attributes = [];
-
         // The link is visible if the user can access the user directory AND the link was enabled in extension settings
-        $attributes['canSeeUserDirectoryLink'] = $serializer->getActor()->can('seeUserList');
-        $attributes['userDirectorySmallCards'] = (bool) $this->settings->get('fof-user-directory.use-small-cards');
-        $attributes['userDirectoryDisableGlobalSearchSource'] = (bool) $this->settings->get('fof-user-directory.disable-global-search-source');
+        $attributes['canSeeUserDirectoryLink'] = $serializer->getActor()->can('seeUserList') && $this->settings->get('fof-user-directory-link');
         $attributes['userDirectoryDefaultSort'] = $this->settings->get('fof-user-directory.default-sort') ?: 'default';
-        $attributes['userDirectoryLinkGroupMentions'] = (bool) $this->settings->get('fof-user-directory.link-group-mentions');
 
         // Only serialize if the actor has permission
         if ($permission = $serializer->getActor()->hasPermission('user.suspend')) {

diff --git a/tests/fixtures/.gitkeep b/tests/fixtures/.gitkeep