feat: implement created_by relationship & search (#65)

* feat: add created_by column

* feat: serialize created_by to admin frontend

* test: implement gambit test

* feat: implement search gambit

* Apply fixes from StyleCI

* chore: teardown

* chore

* refactor: use FK

* Apply fixes from StyleCI

* chore

* chore: reorder

* refactor: chore

---------

Co-authored-by: StyleCI Bot <[email protected]>

Author: DavideIadeluca

extend.php

@@ -19,8 +19,8 @@
 use Flarum\User\User;
 use FoF\Doorman\Api\Controllers;
 use FoF\Doorman\Content\AdminPayload;
+use FoF\Doorman\Filter\CreatedByFilterGambit;
 use FoF\Doorman\Filter\DoorkeyFilterer;
-use FoF\Doorman\Filter\NoFilter;
 use FoF\Doorman\Search\DoorkeySearcher;
 use FoF\Doorman\Search\Gambit\FulltextGambit;
 use FoF\Doorman\Validators\DoorkeyLoginValidator;
@@ -46,10 +46,11 @@
         ->get('/fof/doorkeys/{id}', 'fof.doorkeys.show', Controllers\ShowDoorkeyController::class),
 
     (new Extend\SimpleFlarumSearch(DoorkeySearcher::class))
+        ->addGambit(CreatedByFilterGambit::class)
         ->setFullTextGambit(FulltextGambit::class),
 
     (new Extend\Filter(DoorkeyFilterer::class))
-        ->addFilter(NoFilter::class),
+        ->addFilter(CreatedByFilterGambit::class),
 
     new Extend\Locales(__DIR__.'/resources/locale'),
 

js/src/admin/components/DoorkeyListPage.tsx

@@ -414,6 +414,33 @@ export default class DoorkeyListPage extends ExtensionPage {
       40
     );
 
+    columns.add(
+      'createdBy',
+      {
+        name: app.translator.trans('fof-doorman.admin.list.columns.created_by'),
+        content: (doorkey: Doorkey) => {
+          const user = doorkey.createdBy();
+
+          if (!user) return app.translator.trans('fof-doorman.admin.list.content.no_created_by');
+
+          const profileUrl = `${app.forum.attribute('baseUrl')}/u/${user.slug()}`;
+
+          return (
+            <a
+              target="_blank"
+              href={profileUrl}
+              title={extractText(
+                app.translator.trans('core.admin.users.grid.columns.username.profile_link_tooltip', { username: user.displayName() })
+              )}
+            >
+              {user.displayName()}
+            </a>
+          );
+        },
+      },
+      30
+    );
+
     return columns;
   }
 

js/src/common/models/Doorkey.ts

@@ -1,5 +1,6 @@
 import Model from 'flarum/common/Model';
 import type Group from 'flarum/common/models/Group';
+import type User from 'flarum/common/models/User';
 
 export default class Doorkey extends Model {
   key() {
@@ -26,6 +27,10 @@ export default class Doorkey extends Model {
     return Model.attribute<number>('uses').call(this);
   }
 
+  createdBy() {
+    return Model.hasOne<User>('createdBy').call(this);
+  }
+
   protected apiEndpoint() {
     return '/fof/doorkeys' + (this.exists ? `/${(this.data as any).id}` : '');
   }

migrations/2025_03_17_000000_add_created_by_to_doorkeys_table.php

@@ -0,0 +1,18 @@
+<?php
+
+/*
+ * This file is part of fof/doorman.
+ *
+ * Copyright (c) Reflar.
+ * Copyright (c) FriendsOfFlarum.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ */
+
+use Flarum\Database\Migration;
+
+return Migration::addColumns('doorkeys', [
+    'created_by' => ['integer', 'unsigned' => true, 'nullable' => true],
+]);

migrations/2025_03_17_000001_add_foreign_key_on_created_by_column.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of fof/doorman.
+ *
+ * Copyright (c) Reflar.
+ * Copyright (c) FriendsOfFlarum.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ */
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Schema\Builder;
+
+return [
+    'up' => function (Builder $schema) {
+        $schema->table('doorkeys', function (Blueprint $table) {
+            $table->foreign('created_by')->references('id')->on('users')->nullOnDelete();
+        });
+    },
+    'down' => function (Builder $schema) {
+        $schema->table('doorkeys', function (Blueprint $table) {
+            $table->dropForeign(['created_by']);
+        });
+    },
+];

resources/locale/en.yml

@@ -74,6 +74,7 @@ fof-doorman:
         activates_user: => fof-doorman.admin.ref.fields.activates_user.label
         manage: Manage
         uses: Uses
+        created_by: Created By
       content:
         invalid_column: => core.admin.users.grid.columns.invalid_column
         no_group: => core.admin.users.grid.columns.group_badges.no_badges
@@ -82,6 +83,7 @@ fof-doorman:
         uses:
           used_times: "{remaining, plural, =0 {Unlimited uses} one {{remainingUses} use left} other {{remainingUses} uses left}}"
           total_uses: "{totalUses, plural, one {Used {totalUses} time} other {Used {totalUses} times}}"
+        no_created_by: Unknown User
       pagination:
         first_page_button: => core.admin.users.pagination.first_page_button
         back_button: => core.admin.users.pagination.back_button

src/Api/Controllers/ListDoorkeysController.php

@@ -27,7 +27,7 @@ class ListDoorkeysController extends AbstractListController
 {
     public $serializer = DoorkeySerializer::class;
 
-    public $include = ['group'];
+    public $include = ['group', 'createdBy'];
 
     /**
      * @var DoorkeyFilterer

src/Api/Controllers/ShowDoorkeyController.php

@@ -25,7 +25,7 @@ class ShowDoorkeyController extends AbstractShowController
 {
     public $serializer = DoorkeySerializer::class;
 
-    public $include = ['group'];
+    public $include = ['group', 'createdBy'];
 
     /**
      * @var DoorkeyRepository

src/Api/Serializers/DoorkeySerializer.php

@@ -15,6 +15,7 @@
 
 use Flarum\Api\Serializer\AbstractSerializer;
 use Flarum\Api\Serializer\GroupSerializer;
+use Flarum\Api\Serializer\UserSerializer;
 use FoF\Doorman\Doorkey;
 use InvalidArgumentException;
 
@@ -51,4 +52,9 @@ protected function group($user)
     {
         return $this->hasOne($user, GroupSerializer::class);
     }
+
+    protected function createdBy($user)
+    {
+        return $this->hasOne($user, UserSerializer::class);
+    }
 }

src/Commands/CreateDoorkeyHandler.php

@@ -50,6 +50,7 @@ public function __construct(DoorkeyValidator $validator, Dispatcher $events)
     public function handle(CreateDoorkey $command)
     {
         $data = $command->data;
+        $actor = $command->actor;
 
         $doorkey = Doorkey::build(
             Arr::get($data, 'attributes.key'),
@@ -58,12 +59,12 @@ public function handle(CreateDoorkey $command)
             Arr::get($data, 'attributes.activates')
         );
 
+        $doorkey->created_by = $actor->id;
+
         $this->validator->assertValid($doorkey->getAttributes());
 
         $doorkey->save();
 
-        $actor = $command->actor;
-
         $doorkey->afterSave(function ($doorkey) use ($actor, $data) {
             $this->events->dispatch(
                 new DoorkeyCreated($doorkey, $actor, $data)

src/Doorkey.php

@@ -16,13 +16,15 @@
 use Flarum\Database\AbstractModel;
 use Flarum\Database\ScopeVisibilityTrait;
 use Flarum\Group\Group;
+use Flarum\User\User;
 
 /**
  * @property string $key
  * @property int    $group_id
  * @property int    $max_uses
  * @property int    $activates
  * @property int    $uses
+ * @property int    $created_by
  */
 class Doorkey extends AbstractModel
 {
@@ -48,4 +50,9 @@ public function group()
     {
         return $this->belongsTo(Group::class, 'group_id');
     }
+
+    public function createdBy()
+    {
+        return $this->belongsTo(User::class, 'created_by');
+    }
 }

src/Filter/CreatedByFilterGambit.php

@@ -0,0 +1,75 @@
+<?php
+
+/*
+ * This file is part of fof/doorman.
+ *
+ * Copyright (c) Reflar.
+ * Copyright (c) FriendsOfFlarum.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ */
+
+namespace FoF\Doorman\Filter;
+
+use Flarum\Filter\FilterInterface;
+use Flarum\Filter\FilterState;
+use Flarum\Filter\ValidateFilterTrait;
+use Flarum\Search\AbstractRegexGambit;
+use Flarum\Search\SearchState;
+use Flarum\User\UserRepository;
+use Illuminate\Database\Query\Builder;
+
+class CreatedByFilterGambit extends AbstractRegexGambit implements FilterInterface
+{
+    use ValidateFilterTrait;
+
+    /**
+     * @var \Flarum\User\UserRepository
+     */
+    protected $users;
+
+    /**
+     * @param \Flarum\User\UserRepository $users
+     */
+    public function __construct(UserRepository $users)
+    {
+        $this->users = $users;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getGambitPattern()
+    {
+        return 'created_by:(.+)';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function conditions(SearchState $search, array $matches, $negate)
+    {
+        $this->constrain($search->getQuery(), $matches[1], $negate);
+    }
+
+    public function getFilterKey(): string
+    {
+        return 'created_by';
+    }
+
+    public function filter(FilterState $filterState, $filterValue, bool $negate)
+    {
+        $this->constrain($filterState->getQuery(), $filterValue, $negate);
+    }
+
+    protected function constrain(Builder $query, $rawUsernames, $negate)
+    {
+        $usernames = $this->asStringArray($rawUsernames);
+
+        $ids = $this->users->getIdsForUsernames($usernames);
+
+        $query->whereIn('doorkeys.created_by', $ids, 'and', $negate);
+    }
+}

src/Filter/NoFilter.php

@@ -81,6 +81,7 @@ public function permitted_users_can_create_doorkey($actorId)
         $this->assertEquals('ABCDEFG1', Arr::get($response, 'data.attributes.key'));
 
         $this->assertEquals(1, Doorkey::count());
+        $this->assertEquals($actorId, Doorkey::first()->created_by);
     }
 
     /**