feat: add header caching, cleanup (#1)

* feat: add header caching, cleanup * Apply fixes from StyleCI * Add string length to validator * Update LICENSE.md * chore: cleanup handlers * Apply fixes from StyleCI * define a shared key * Apply fixes from StyleCI * refine header validation a little * Apply fixes from StyleCI * Update README --------- Co-authored-by: StyleCI Bot <bot@styleci.io>
imorland · Sep 18, 2023 · f4f2b94 · f4f2b94
1 parent b6fc869
commit f4f2b94
Show file tree

Hide file tree

Showing 26 changed files with 1,054 additions and 787 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-MIT License Copyright (c) 2021 Ian Morland
+MIT License Copyright (c) 2021 - 2023 Ian Morland
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/README.md b/README.md
@@ -2,16 +2,26 @@
 
 ![License](https://img.shields.io/badge/license-MIT-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/ianm/html-head.svg)](https://packagist.org/packages/ianm/html-head)
 
-A [Flarum](http://flarum.org) extension. Add custom items to the &lt;head&gt; items
+A [Flarum](http://flarum.org) extension that offers a seamless way to add custom items to the HTML &lt;head&gt; section of your forum.
 
-### Usage
+### Features
+
+- **Easy Integration**: With just a few clicks, forum administrators can embed additional items directly into the forum's HTML <head>. This is particularly useful for adding meta tags, styles, or any other custom scripts.
+
+- **Clean UI**: The extension provides a user-friendly interface that makes it simple to manage and view all added items.
+
+- **Cache Management**: Any changes made to the head items are automatically reflected, thanks to the efficient cache management in place. This ensures that your updates are immediately visible without any additional steps.
 
-Forum admins may add additional items into the forum's HTML `<head>`
+- **Error Handling**: In the event that an invalid header item is added, the extension intelligently logs the error, ensuring the forum's functionality isn't compromised.
 
 ![image](https://user-images.githubusercontent.com/16573496/104105231-a3bb3000-52a4-11eb-97dc-d4c097471ebd.png)
 
 ![image](https://user-images.githubusercontent.com/16573496/104105258-cc432a00-52a4-11eb-8ee6-51d75c731b51.png)
 
+### Usage
+
+To use the extension, simply navigate to the admin dashboard. Here you'll find the option to add or modify items that will be included in the forum's HTML `<head>`.
+
 ### Installation
 
 Install manually with composer:
@@ -24,8 +34,12 @@ composer require ianm/html-head:"*"
 
 ```sh
 composer update ianm/html-head
+php flarum cache:clear
 ```
 
 ### Links
 
 - [Packagist](https://packagist.org/packages/ianm/html-head)
+- [GitHub](https://github.com/imorland/html-head)
+- [Discuss](https://discuss.flarum.org/d/25907)
+
diff --git a/extend.php b/extend.php
@@ -3,41 +3,35 @@
 /*
  * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead;
 
 use Flarum\Extend;
-use Flarum\Frontend\Document;
 use IanM\HtmlHead\Api\Controllers;
-use Illuminate\Database\Eloquent\Collection;
 
 return [
-    
+
     (new Extend\Frontend('admin'))
         ->js(__DIR__.'/js/dist/admin.js')
         ->css(__DIR__.'/resources/less/admin.less'),
 
-    new Extend\Locales(__DIR__ . '/resources/locale'),
+    new Extend\Locales(__DIR__.'/resources/locale'),
 
     (new Extend\Frontend('forum'))
-        ->content(function (Document $document) {
-            /** @var Collection */
-            $headCollection = Header::where('active', 1)->get();
-
-            /** @var Header $headItem */
-            foreach ($headCollection as $headItem) {
-                $document->head[] = $headItem->header;
-            }
-        }),
+        ->content(Content\AddHeaders::class),
 
     (new Extend\Routes('api'))
         ->get('/html-headers', 'ianm.html-headers.index', Controllers\ListHeadersController::class)
         ->post('/html-headers', 'ianm.html-headers.create', Controllers\CreateHeaderItemController::class)
         ->patch('/html-headers/{id}', 'ianm.html-headers.update', Controllers\UpdateHeaderItemController::class)
         ->delete('/html-headers/{id}', 'ianm.html-headers.delete', Controllers\DeleteHeaderItemController::class),
+
+    (new Extend\Event())
+        ->subscribe(Listener\ClearCache::class),
 ];
diff --git a/js/package-lock.json b/js/package-lock.json
diff --git a/js/package.json b/js/package.json
@@ -7,11 +7,11 @@
     "@flarum/prettier-config": "^1.0.0",
     "flarum-tsconfig": "^1.0.2",
     "flarum-webpack-config": "^2.0.0",
-    "webpack": "^5.67.0",
-    "webpack-cli": "^4.9.2"
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4"
   },
   "devDependencies": {
-    "prettier": "^2.5.1"
+    "prettier": "^3.0.3"
   },
   "scripts": {
     "dev": "webpack --mode development --watch",

diff --git a/js/src/admin/components/CreateHeadItemModal.js b/js/src/admin/components/CreateHeadItemModal.js
@@ -52,8 +52,6 @@ export default class CreateHeadItemModal extends Modal {
   onsubmit(e) {
     e.preventDefault();
 
-    if (!this.header()) return;
-
     this.loading = true;
 
     const attrs = {

diff --git a/js/src/admin/components/HeadItemListItem.js b/js/src/admin/components/HeadItemListItem.js
@@ -20,7 +20,7 @@ export default class HeadItemListItem extends Component {
         </td>
         <td>
           {Switch.component({
-            state: this.item.data.attributes.active,
+            state: this.item.active(),
             onchange: (value) => {
               this.activeLoading = true;
 

diff --git a/migrations/2021_01_01_000000_create_html_headers_table.php b/migrations/2021_01_01_000000_create_html_headers_table.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
- * For the full copyright and license information, please view the LICENSE
+ * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 use Illuminate\Database\Schema\Blueprint;
@@ -18,7 +19,7 @@
             return;
         }
 
-        $schema->create('html_headers', function (Blueprint $table) use ($schema) {
+        $schema->create('html_headers', function (Blueprint $table) {
             $table->increments('id');
 
             $table->text('description', 200);
@@ -30,4 +31,4 @@
     'down' => function (Builder $schema) {
         $schema->dropIfExists('html_headers');
     },
-];
+];
diff --git a/src/Api/Controllers/CreateHeaderItemController.php b/src/Api/Controllers/CreateHeaderItemController.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead\Api\Controllers;
@@ -15,6 +16,7 @@
 use Flarum\Http\RequestUtil;
 use IanM\HtmlHead\Api\Serializers\HeaderSerializer;
 use IanM\HtmlHead\Command\CreateHeaderItem;
+use IanM\HtmlHead\Validator\HeaderItemValidator;
 use Illuminate\Contracts\Bus\Dispatcher;
 use Illuminate\Support\Arr;
 use Psr\Http\Message\ServerRequestInterface;
@@ -27,6 +29,11 @@ class CreateHeaderItemController extends AbstractCreateController
      */
     public $serializer = HeaderSerializer::class;
 
+    /**
+     * @var HeaderItemValidator
+     */
+    protected $validator;
+
     /**
      * @var Dispatcher
      */
@@ -35,8 +42,9 @@ class CreateHeaderItemController extends AbstractCreateController
     /**
      * @param Dispatcher $bus
      */
-    public function __construct(Dispatcher $bus)
+    public function __construct(HeaderItemValidator $validator, Dispatcher $bus)
     {
+        $this->validator = $validator;
         $this->bus = $bus;
     }
 
@@ -46,9 +54,12 @@ public function __construct(Dispatcher $bus)
     protected function data(ServerRequestInterface $request, Document $document)
     {
         $actor = RequestUtil::getActor($request);
+        $data = Arr::get($request->getParsedBody(), 'data', []);
+
+        $this->validator->assertValid($data);
 
         return $this->bus->dispatch(
-            new CreateHeaderItem($actor, Arr::get($request->getParsedBody(), 'data', []))
+            new CreateHeaderItem($actor, $data)
         );
     }
 }
diff --git a/src/Api/Controllers/DeleteHeaderItemController.php b/src/Api/Controllers/DeleteHeaderItemController.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead\Api\Controllers;
@@ -38,11 +39,10 @@ public function __construct(Dispatcher $bus)
      */
     protected function delete(ServerRequestInterface $request)
     {
-        /** @var \Flarum\User\User */
         $actor = RequestUtil::getActor($request);
 
         $this->bus->dispatch(
             new DeleteHeaderItem($actor, Arr::get($request->getQueryParams(), 'id'))
         );
     }
-}
+}
diff --git a/src/Api/Controllers/ListHeadersController.php b/src/Api/Controllers/ListHeadersController.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead\Api\Controllers;

diff --git a/src/Api/Controllers/UpdateHeaderItemController.php b/src/Api/Controllers/UpdateHeaderItemController.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead\Api\Controllers;
@@ -15,6 +16,7 @@
 use Flarum\Http\RequestUtil;
 use IanM\HtmlHead\Api\Serializers\HeaderSerializer;
 use IanM\HtmlHead\Command\UpdateHeaderItem;
+use IanM\HtmlHead\Validator\HeaderItemValidator;
 use Illuminate\Contracts\Bus\Dispatcher;
 use Illuminate\Support\Arr;
 use Psr\Http\Message\ServerRequestInterface;
@@ -27,6 +29,11 @@ class UpdateHeaderItemController extends AbstractShowController
      */
     public $serializer = HeaderSerializer::class;
 
+    /**
+     * @var HeaderItemValidator
+     */
+    protected $validator;
+
     /**
      * @var Dispatcher
      */
@@ -35,8 +42,9 @@ class UpdateHeaderItemController extends AbstractShowController
     /**
      * @param Dispatcher $bus
      */
-    public function __construct(Dispatcher $bus)
+    public function __construct(HeaderItemValidator $validator, Dispatcher $bus)
     {
+        $this->validator = $validator;
         $this->bus = $bus;
     }
 
@@ -49,6 +57,8 @@ protected function data(ServerRequestInterface $request, Document $document)
         $id = Arr::get($request->getQueryParams(), 'id');
         $data = $request->getParsedBody();
 
+        $this->validator->assertValid($data);
+
         return $this->bus->dispatch(
             new UpdateHeaderItem($actor, $id, $data)
         );

diff --git a/src/Api/Serializers/HeaderSerializer.php b/src/Api/Serializers/HeaderSerializer.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead\Api\Serializers;

diff --git a/src/Command/CreateHeaderItem.php b/src/Command/CreateHeaderItem.php
@@ -1,12 +1,13 @@
 <?php
 
 /*
- * This file is part of ianm/html-head.
+ * This file is part of ianm/htmlhead.
  *
- * Copyright (c) 2021 IanM.
+ * Copyright (c) IanM.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
+ *
  */
 
 namespace IanM\HtmlHead\Command;
@@ -23,14 +24,14 @@ class CreateHeaderItem
     public $actor;
 
     /**
-     * The attributes of the new draft.
+     * The attributes of the new header.
      *
      * @var array
      */
     public $data;
 
     /**
-     * CreateDraft constructor.
+     * CreateHeaderItem constructor.
      *
      * @param User  $actor
      * @param array $data