Merge pull request #2931 from nstapelbroek/feature/2895-custom-meta-descriptions-per-incident

Custom meta descriptions per incident

app/Bus/Commands/Incident/CreateIncidentCommand.php

@@ -140,7 +140,7 @@ final class CreateIncidentCommand
      *
      * @return void
      */
-    public function __construct($name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $occurred_at, $template, array $template_vars = [], $meta = [])
+    public function __construct($name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $occurred_at, $template, array $template_vars = [], array $meta = [])
     {
         $this->name = $name;
         $this->status = $status;

app/Bus/Commands/Incident/UpdateIncidentCommand.php

@@ -106,6 +106,13 @@ final class UpdateIncidentCommand
      */
     public $template_vars;
 
+    /**
+     * Meta key/value pairs.
+     *
+     * @var array
+     */
+    public $meta = [];
+
     /**
      * The validation rules.
      *
@@ -122,6 +129,7 @@ final class UpdateIncidentCommand
         'stickied'         => 'nullable|bool',
         'occurred_at'      => 'nullable|string',
         'template'         => 'nullable|string',
+        'meta'             => 'nullable|array',
     ];
 
     /**
@@ -139,10 +147,11 @@ final class UpdateIncidentCommand
      * @param string|null                      $occurred_at
      * @param string|null                      $template
      * @param array                            $template_vars
+     * @param array                            $meta
      *
      * @return void
      */
-    public function __construct(Incident $incident, $name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $occurred_at, $template, array $template_vars = [])
+    public function __construct(Incident $incident, $name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $occurred_at, $template, array $template_vars = [], array $meta = [])
     {
         $this->incident = $incident;
         $this->name = $name;
@@ -156,5 +165,6 @@ final class UpdateIncidentCommand
         $this->occurred_at = $occurred_at;
         $this->template = $template;
         $this->template_vars = $template_vars;
+        $this->meta = $meta;
     }
 }

app/Bus/Handlers/Commands/Incident/CreateIncidentCommandHandler.php

@@ -15,6 +15,7 @@ use CachetHQ\Cachet\Bus\Commands\Component\UpdateComponentCommand;
 use CachetHQ\Cachet\Bus\Commands\Incident\CreateIncidentCommand;
 use CachetHQ\Cachet\Bus\Events\Incident\IncidentWasCreatedEvent;
 use CachetHQ\Cachet\Bus\Exceptions\Incident\InvalidIncidentTimestampException;
+use CachetHQ\Cachet\Bus\Handlers\Traits\StoresMeta;
 use CachetHQ\Cachet\Models\Component;
 use CachetHQ\Cachet\Models\Incident;
 use CachetHQ\Cachet\Models\IncidentTemplate;
@@ -32,6 +33,8 @@ use Twig\Loader\ArrayLoader as Twig_Loader_Array;
  */
 class CreateIncidentCommandHandler
 {
+    use StoresMeta;
+
     /**
      * The authentication guard instance.
      *
@@ -104,14 +107,7 @@ class CreateIncidentCommandHandler
 
         // Store any meta?
         if ($meta = $command->meta) {
-            foreach ($meta as $key => $value) {
+            $this->storeMeta($command->meta, 'incidents', $incident->id);
-                Meta::create([
-                    'key'       => $key,
-                    'value'     => $value,
-                    'meta_type' => 'incidents',
-                    'meta_id'   => $incident->id,
-                ]);
-            }
         }
 
         // Update the component.

app/Bus/Handlers/Commands/Incident/UpdateIncidentCommandHandler.php

@@ -15,6 +15,7 @@ use CachetHQ\Cachet\Bus\Commands\Component\UpdateComponentCommand;
 use CachetHQ\Cachet\Bus\Commands\Incident\UpdateIncidentCommand;
 use CachetHQ\Cachet\Bus\Events\Incident\IncidentWasUpdatedEvent;
 use CachetHQ\Cachet\Bus\Exceptions\Incident\InvalidIncidentTimestampException;
+use CachetHQ\Cachet\Bus\Handlers\Traits\StoresMeta;
 use CachetHQ\Cachet\Models\Component;
 use CachetHQ\Cachet\Models\Incident;
 use CachetHQ\Cachet\Models\IncidentTemplate;
@@ -30,6 +31,8 @@ use Twig\Loader\ArrayLoader as Twig_Loader_Array;
  */
 class UpdateIncidentCommandHandler
 {
+    use StoresMeta;
+
     /**
      * The authentication guard instance.
      *
@@ -86,6 +89,11 @@ class UpdateIncidentCommandHandler
         // Rather than making lots of updates, just fill and save.
         $incident->save();
 
+        // Store any meta?
+        if ($meta = $command->meta) {
+            $this->storeMeta($command->meta, 'incidents', $incident->id);
+        }
+
         // Update the component.
         if ($component = Component::find($command->component_id)) {
             execute(new UpdateComponentCommand(

app/Bus/Handlers/Traits/StoresMeta.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Bus\Handlers\Traits;
+
+use CachetHQ\Cachet\Models\Meta;
+
+trait StoresMeta
+{
+    /**
+     * Stores all Meta values of a model.
+     *
+     * @param array      $metaData
+     * @param string     $metaType
+     * @param string|int $metaId
+     * @param string     $metaModel
+     *
+     * @return void
+     */
+    public function storeMeta($metaData, $metaType, $metaId, $metaModel = Meta::class)
+    {
+        // Validation required instead of type hinting because it could be passed as false or NULL
+        if (!is_array($metaData)) {
+            return;
+        }
+
+        foreach ($metaData as $key => $value) {
+            $modelInstance = call_user_func(
+                [$metaModel, 'firstOrNew'],
+                [
+                    'key'       => $key,
+                    'meta_type' => $metaType,
+                    'meta_id'   => $metaId,
+                ]
+            );
+
+            $value = $this->removeEmptyValues($value);
+            if (!empty($value)) {
+                $modelInstance->setAttribute('value', $value);
+                $modelInstance->save();
+                continue;
+            }
+
+            // The value is empty, remove the row
+            if ($modelInstance->exists) {
+                $modelInstance->delete();
+            }
+        }
+    }
+
+    /**
+     * Determine if a Value is empty.
+     *
+     * @param mixed $values
+     *
+     * @return array|mixed
+     */
+    protected function removeEmptyValues($values)
+    {
+        if (!is_array($values)) {
+            return empty($values) ? null : $values;
+        }
+
+        foreach ($values as $key => $value) {
+            if (!empty($value)) {
+                continue;
+            }
+            unset($values[$key]);
+        }
+
+        return $values;
+    }
+}

app/Http/Controllers/Dashboard/IncidentController.php

@@ -128,7 +128,8 @@ class IncidentController extends Controller
                 Binput::get('stickied', false),
                 Binput::get('occurred_at'),
                 null,
-                []
+                [],
+                ['seo' => Binput::get('seo', [])]
             ));
         } catch (ValidationException $e) {
             return cachet_redirect('dashboard.incidents.create')
@@ -258,7 +259,8 @@ class IncidentController extends Controller
                 Binput::get('stickied', false),
                 Binput::get('occurred_at'),
                 null,
-                []
+                [],
+                ['seo' => Binput::get('seo', [])]
             ));
         } catch (ValidationException $e) {
             return cachet_redirect('dashboard.incidents.edit', ['id' => $incident->id])

resources/lang/en/forms.php

@@ -229,6 +229,11 @@ return [
         'timezone' => 'Select Timezone',
     ],
 
+    'seo' => [
+        'title'        => 'SEO Title',
+        'description'  => 'SEO Description',
+    ],
+
     // Buttons
     'add'            => 'Add',
     'save'           => 'Save',

resources/views/dashboard/incidents/add.blade.php

@@ -129,6 +129,14 @@
                             </label>
                         </div>
                         @endif
+                        <div class="form-group">
+                            <label>{{ trans('forms.seo.title') }}</label> <small class="text-muted">{{ trans('forms.optional') }}</small>
+                            <input type="text" name="seo[title]" class="form-control" placeholder="{{ trans('forms.optional') }}">
+                        </div>
+                        <div class="form-group">
+                            <label>{{ trans('forms.seo.description') }}</label> <small class="text-muted">{{ trans('forms.optional') }}</small>
+                            <input type="text" name="seo[description]" class="form-control" placeholder="{{ trans('forms.optional') }}">
+                        </div>
                     </fieldset>
 
                     <div class="form-group">

resources/views/dashboard/incidents/edit.blade.php

@@ -111,6 +111,14 @@
                         <label>{{ trans('forms.incidents.occurred_at') }}</label> <small class="text-muted">{{ trans('forms.optional') }}</small>
                         <input type="text" name="occurred_at" class="form-control flatpickr-time" data-date-format="Y-m-d H:i" value="{{ $incident->occurred_at_datetimepicker }}" placeholder="{{ trans('forms.optional') }}">
                     </div>
+                    <div class="form-group">
+                        <label>{{ trans('forms.seo.title') }}</label> <small class="text-muted">{{ trans('forms.optional') }}</small>
+                        <input type="text" name="seo[title]" class="form-control"  value="{{ array_get($incident->meta, 'seo.title', '')  }}">
+                    </div>
+                    <div class="form-group">
+                        <label>{{ trans('forms.seo.description') }}</label> <small class="text-muted">{{ trans('forms.optional') }}</small>
+                        <input type="text" name="seo[description]" class="form-control" value="{{ array_get($incident->meta, 'seo.description', '') }}">
+                    </div>
                 </fieldset>
 
                 <div class="form-group">

resources/views/layout/master.blade.php

@@ -15,7 +15,7 @@
     <meta name="description" content="@yield('description', trans('cachet.meta.description.overview', ['app' => $appName]))">
 
     <meta property="og:type" content="website">
-    <meta property="og:title" content="{{ $siteTitle }}">
+    <meta property="og:title" content="@yield('title', $siteTitle)">
     <meta property="og:image" content="/img/favicon.png">
     <meta property="og:description" content="@yield('description', trans('cachet.meta.description.overview', ['app' => $appName]))">
 

resources/views/single-incident.blade.php

@@ -1,8 +1,8 @@
 @extends('layout.master')
 
-@section('title', $incident->name.' | '.$siteTitle)
+@section('title', array_get($incident->meta, 'seo.title', $incident->name).' | '.$siteTitle)
 
-@section('description', trans('cachet.meta.description.incident', ['name' => $incident->name, 'date' => $incident->occurred_at_formatted]))
+@section('description', array_get($incident->meta, 'seo.description', trans('cachet.meta.description.incident', ['name' => $incident->name, 'date' => $incident->occurred_at_formatted])))
 
 @section('bodyClass', 'no-padding')
 

tests/Bus/Traits/StoresMetaTest.php

@@ -0,0 +1,133 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Bus\Traits;
+
+use CachetHQ\Cachet\Bus\Handlers\Traits\StoresMeta;
+use CachetHQ\Cachet\Models\Meta;
+use CachetHQ\Tests\Cachet\AbstractTestCase;
+use Mockery;
+use Mockery\MockInterface;
+
+class StoresMetaTest extends AbstractTestCase
+{
+    /**
+     * @var Meta|MockInterface
+     */
+    protected $metaModel;
+
+    /**
+     * Set up the testcase by mocking the Meta::class.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+
+        if (!class_exists('Mockery')) {
+            $this->markTestSkipped('This test requires Mockery');
+        }
+
+        $this->metaModel = Mockery::mock(Meta::class)->makePartial();
+        $this->app->instance(Meta::class, $this->metaModel);
+    }
+
+    /**
+     * Our Mockery expectations should count as assertions to prevent warnings from PHPUnit.
+     */
+    public function tearDown()
+    {
+        $this->addToAssertionCount(Mockery::getContainer()->mockery_getExpectationCount());
+        parent::tearDown();
+    }
+
+    /**
+     * Each array value passed to the MetaValues should result in a new model instance.
+     */
+    public function testStoresMetaWithSimpleMultipleArrays()
+    {
+        $mock = $this->getMockForTrait(StoresMeta::class);
+        $metaData = [
+            'somekey1' => 'somevalue',
+            'somekey2' => 'somevalue',
+            'somekey3' => 'somevalue',
+        ];
+
+        $this->metaModel->shouldReceive('firstOrNew')->times(3)->andReturn($this->metaModel);
+        $this->metaModel->shouldReceive('save')->times(3);
+        $this->metaModel->shouldReceive('setAttribute')->times(3)->andReturnUsing(function ($key, $value) {
+            $this->assertEquals('value', $key);
+            $this->assertEquals('somevalue', $value);
+
+            return $this->metaModel;
+        });
+
+        $mock->storeMeta($metaData, 'some_class', 1, $this->metaModel);
+    }
+
+    /**
+     * It will pass nested arrays to the value property of the Meta model.
+     */
+    public function testStoresNestedArraysAsSingleValue()
+    {
+        $mock = $this->getMockForTrait(StoresMeta::class);
+        $metaData = ['somekey1' => ['subkey' => ['second' => 'key']]];
+
+        $this->metaModel->shouldReceive('firstOrNew')->once()->andReturn($this->metaModel);
+        $this->metaModel->shouldReceive('save')->once();
+        $this->metaModel->shouldReceive('setAttribute')->once()->andReturnUsing(function ($key, $value) {
+            $this->assertEquals('value', $key);
+            $this->assertEquals(['subkey' => ['second' => 'key']], $value);
+
+            return $this->metaModel;
+        });
+
+        $mock->storeMeta($metaData, 'some_class', 1, $this->metaModel);
+    }
+
+    /**
+     * If a value is empty or null it will be removed.
+     */
+    public function testEmptyValuesWillBeDeleted()
+    {
+        $mock = $this->getMockForTrait(StoresMeta::class);
+        $metaData = ['somekey1' => ''];
+
+        $this->metaModel->exists = true;
+        $this->metaModel->shouldReceive('firstOrNew')->once()->andReturn($this->metaModel);
+        $this->metaModel->shouldReceive('delete')->once();
+        $this->metaModel->shouldReceive('setAttribute')->never();
+        $this->metaModel->shouldReceive('save')->never();
+
+        $mock->storeMeta($metaData, 'some_class', 1, $this->metaModel);
+    }
+
+    /**
+     * If a value is empty or null in a nested array it will be removed.
+     */
+    public function testEmptyNestedArrayKeysAreRemoved()
+    {
+        $mock = $this->getMockForTrait(StoresMeta::class);
+        $metaData = ['somekey1' => ['keyWithValue' => 'value123', 'keyWithoutValue' => null]];
+
+        $this->metaModel->exists = true;
+        $this->metaModel->shouldReceive('firstOrNew')->once()->andReturn($this->metaModel);
+        $this->metaModel->shouldReceive('setAttribute')->once()->andReturnUsing(function ($key, $value) {
+            $this->assertEquals('value', $key);
+            $this->assertEquals(['keyWithValue' => 'value123'], $value);
+
+            return $this->metaModel;
+        });
+        $this->metaModel->shouldReceive('save')->once();
+        $this->metaModel->shouldReceive('delete')->never();
+
+        $mock->storeMeta($metaData, 'some_class', 1, $this->metaModel);
+    }
+}

tests/Functional/Incident/MetaSeoTest.php

@@ -0,0 +1,181 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Tests\Cachet\Functional\Bus\Commands\Incident;
+
+use CachetHQ\Cachet\Bus\Commands\Incident\CreateIncidentCommand;
+use CachetHQ\Cachet\Models\Incident;
+use CachetHQ\Cachet\Presenters\IncidentPresenter;
+use CachetHQ\Cachet\Settings\Repository as SettingsRepository;
+use CachetHQ\Tests\Cachet\AbstractTestCase;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+
+/**
+ * This is the create incident command test class.
+ *
+ * @author James Brooks <james@alt-three.com>
+ * @author Graham Campbell <graham@alt-three.com>
+ */
+class MetaSeoTest extends AbstractTestCase
+{
+    use DatabaseMigrations;
+
+    /**
+     * @var \Faker\Generator
+     */
+    protected $fakerFactory;
+
+    /**
+     * @var string
+     */
+    protected $appName;
+
+    /**
+     * CreateIncidentCommandTest constructor.
+     *
+     * @param null   $name
+     * @param array  $data
+     * @param string $dataName
+     */
+    public function __construct($name = null, array $data = [], $dataName = '')
+    {
+        parent::__construct($name, $data, $dataName);
+        $this->fakerFactory = \Faker\Factory::create();
+        $this->appName = 'MetaSeoTest';
+    }
+
+    /**
+     * Setup the application.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+        $this->app->make(SettingsRepository::class)->set('app_name', $this->appName);
+        $this->app->config->set('setting.app_name', $this->appName);
+    }
+
+    /**
+     * When using a custom meta description in an incident it will be
+     * showed in two meta tags on the incident details page.
+     */
+    public function testCustomSeoDescriptionOnIncidentPage()
+    {
+        $expectedDescription = htmlspecialchars($this->fakerFactory->sentence);
+
+        $incident = $this->createIncidentWithMeta(['seo' => ['description' => $expectedDescription]]);
+        $page = $this->get(sprintf('/incidents/%d', $incident->id));
+
+        $this->assertContains(
+            sprintf('<meta property="og:description" content="%s">', $expectedDescription),
+            $page->content()
+        );
+        $this->assertContains(
+            sprintf('<meta name="description" content="%s">', $expectedDescription),
+            $page->content()
+        );
+    }
+
+    /**
+     * When using a custom meta title in an incident it will be
+     * showed in two meta tags on the incident details page.
+     */
+    public function testCustomSeoTitleOnIncidentPage()
+    {
+        $title = htmlspecialchars($this->fakerFactory->title);
+
+        $incident = $this->createIncidentWithMeta(['seo' => ['title' => $title]]);
+        $page = $this->get(sprintf('/incidents/%d', $incident->id));
+
+        $this->assertContains(
+            sprintf('<meta property="og:title" content="%s | %s">', $title, $this->appName),
+            $page->content()
+        );
+        $this->assertContains(
+            sprintf('<title>%s | %s</title>', $title, $this->appName),
+            $page->content()
+        );
+    }
+
+    /**
+     * When using no custom meta description in an incident, the application
+     * default generated description will be used on the incident details page.
+     */
+    public function testNoCustomSeoDescriptionOnIncidentPage()
+    {
+        $incident = $this->createIncidentWithMeta([]);
+        $presenter = $this->app->make(IncidentPresenter::class);
+        $presenter->setWrappedObject($incident);
+
+        $expectedDescription = sprintf(
+            'Details and updates about the %s incident that occurred on %s',
+            htmlspecialchars($incident->name),
+            $presenter->occurred_at_formatted
+        );
+
+        $page = $this->get(sprintf('/incidents/%d', $incident->id));
+
+        $this->assertContains(
+            sprintf('<meta property="og:description" content="%s">', $expectedDescription),
+            $page->content()
+        );
+        $this->assertContains(
+            sprintf('<meta name="description" content="%s">', $expectedDescription),
+            $page->content()
+        );
+    }
+
+    /**
+     * When using no custom meta description in an incident, the application
+     * default generated description will be used on the incident details page.
+     */
+    public function testNoCustomSeoTitleOnIncidentPage()
+    {
+        $incident = $this->createIncidentWithMeta([]);
+        $expectedTitle = sprintf('%s | %s', htmlspecialchars($incident->name), $this->appName);
+
+        $page = $this->get(sprintf('/incidents/%d', $incident->id));
+
+        $this->assertContains(
+            sprintf('<meta property="og:title" content="%s">', $expectedTitle),
+            $page->content()
+        );
+        $this->assertContains(sprintf('<title>%s</title>', $expectedTitle), $page->content());
+    }
+
+    /**
+     * @param array $meta
+     *
+     * @return Incident
+     */
+    protected function createIncidentWithMeta(array $meta)
+    {
+        $this->signIn();
+        $name = $this->fakerFactory->name;
+        $message = $this->fakerFactory->sentence;
+
+        dispatch(new CreateIncidentCommand(
+            $name,
+            $this->fakerFactory->numberBetween(0, 3),
+            $message,
+            $this->fakerFactory->boolean,
+            null,
+            null,
+            false,
+            $this->fakerFactory->boolean,
+            $this->fakerFactory->date('Y-m-d H:i'),
+            null,
+            [],
+            $meta
+        ));
+
+        return Incident::where('name', '=', $name)->where('message', '=', $message)->firstOrFail();
+    }
+}