lucas.mathieu/cachet-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Incident templates cleanup (#2182)

Browse Source 
Clean up Incident Templates, supply incident array to them by default
This commit is contained in:
James Brooks
2016-10-14 08:03:19 +01:00
committed by GitHub
parent c2153512d9
commit fe96a00b82
14 changed files with 124 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
app/Bus/Commands/Incident/ReportIncidentCommand.php
View File

@@ -11,6 +11,12 @@
namespace CachetHQ\Cachet\Bus\Commands\Incident;
/**
* This is the report incident command.
*
* @author Joseph Cohen <joe@alt-three.com>
* @author James Brooks <james@alt-three.com>
*/
final class ReportIncidentCommand
{
/**
@@ -121,11 +127,11 @@ final class ReportIncidentCommand
* @param bool $stickied
* @param string|null $incident_date
* @param string|null $template
* @param array|null $template_vars
* @param array $template_vars
*
* @return void
*/
public function __construct($name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $incident_date, $template, array $template_vars = null)
public function __construct($name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $incident_date, $template, array $template_vars = [])
{
$this->name = $name;
$this->status = $status;

4
app/Bus/Commands/Incident/UpdateIncidentCommand.php
View File

@@ -130,11 +130,11 @@ final class UpdateIncidentCommand
* @param bool $stickied
* @param string|null $incident_date
* @param string|null $template
* @param array|null $template_vars
* @param array $template_vars
*
* @return void
*/
public function __construct(Incident $incident, $name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $incident_date, $template, array $template_vars = null)
public function __construct(Incident $incident, $name, $status, $message, $visible, $component_id, $component_status, $notify, $stickied, $incident_date, $template, array $template_vars = [])
{
$this->incident = $incident;
$this->name = $name;

63
app/Bus/Handlers/Commands/Incident/ReportIncidentCommandHandler.php
View File

@@ -11,14 +11,15 @@
namespace CachetHQ\Cachet\Bus\Handlers\Commands\Incident;
use CachetHQ\Cachet\Bus\Commands\Component\UpdateComponentCommand;
use CachetHQ\Cachet\Bus\Commands\Incident\ReportIncidentCommand;
use CachetHQ\Cachet\Bus\Events\Incident\IncidentWasReportedEvent;
use CachetHQ\Cachet\Dates\DateFactory;
use CachetHQ\Cachet\Models\Component;
use CachetHQ\Cachet\Models\Incident;
use CachetHQ\Cachet\Models\IncidentTemplate;
use Twig_Loader_String;
use TwigBridge\Bridge;
use Twig_Environment;
use Twig_Loader_Array;
/**
* This is the report incident command handler.
@@ -34,25 +35,16 @@ class ReportIncidentCommandHandler
*/
protected $dates;
/**
* The twig bridge instance.
*
* @var \TwigBridge\Bridge
*/
protected $twig;
/**
* Create a new report incident command handler instance.
*
* @param \CachetHQ\Cachet\Dates\DateFactory $dates
* @param \TwigBridge\Bridge $twig
*
* @return void
*/
public function __construct(DateFactory $dates, Bridge $twig)
public function __construct(DateFactory $dates)
{
$this->dates = $dates;
$this->twig = $twig;
}
/**
@@ -71,8 +63,8 @@ class ReportIncidentCommandHandler
'stickied' => $command->stickied,
];
if ($command->template) {
$data['message'] = $this->parseIncidentTemplate($command->template, $command->template_vars);
if ($template = IncidentTemplate::where('slug', $command->template)->first()) {
$data['message'] = $this->parseTemplate($template, $command);
} else {
$data['message'] = $command->message;
}
@@ -94,10 +86,17 @@ class ReportIncidentCommandHandler
$incident = Incident::create($data);
// Update the component.
if ($command->component_id) {
Component::find($command->component_id)->update([
'status' => $command->component_status,
]);
if ($component = Component::find($command->component_id)) {
dispatch(new UpdateComponentCommand(
Component::find($command->component_id),
null,
null,
$command->component_status,
null,
null,
null,
null
));
}
$incident->notify = (bool) $command->notify;
@@ -110,20 +109,30 @@ class ReportIncidentCommandHandler
/**
* Compiles an incident template into an incident message.
*
* @param string $templateSlug
* @param array $vars
* @param \CachetHQ\Cachet\Models\IncidentTemplate $template
* @param \CachetHQ\Cachet\Bus\Commands\Incident\ReportIncidentCommand $command
*
* @return string
*/
protected function parseIncidentTemplate($templateSlug, $vars)
protected function parseTemplate(IncidentTemplate $template, ReportIncidentCommand $command)
{
if ($vars === null) {
$vars = [];
}
$env = new Twig_Environment(new Twig_Loader_Array([]));
$template = $env->createTemplate($template->template);
$this->twig->setLoader(new Twig_Loader_String());
$template = IncidentTemplate::forSlug($templateSlug)->first();
$vars = array_merge($command->template_vars, [
'incident' => [
'name' => $command->name,
'status' => $command->status,
'message' => $command->message,
'visible' => $command->visible,
'notify' => $command->notify,
'stickied' => $command->stickied,
'incident_date' => $command->incident_date,
'component' => Component::find($command->component_id) ?: null,
'component_status' => $command->component_status,
],
]);
return $this->twig->render($template->template, $vars);
return $template->render($vars);
}
}

61
app/Bus/Handlers/Commands/Incident/UpdateIncidentCommandHandler.php
View File

@@ -11,14 +11,15 @@
namespace CachetHQ\Cachet\Bus\Handlers\Commands\Incident;
use CachetHQ\Cachet\Bus\Commands\Component\UpdateComponentCommand;
use CachetHQ\Cachet\Bus\Commands\Incident\UpdateIncidentCommand;
use CachetHQ\Cachet\Bus\Events\Incident\IncidentWasUpdatedEvent;
use CachetHQ\Cachet\Dates\DateFactory;
use CachetHQ\Cachet\Models\Component;
use CachetHQ\Cachet\Models\Incident;
use CachetHQ\Cachet\Models\IncidentTemplate;
use Twig_Loader_String;
use TwigBridge\Bridge;
use Twig_Environment;
use Twig_Loader_Array;
/**
* This is the update incident command handler.
@@ -34,25 +35,16 @@ class UpdateIncidentCommandHandler
*/
protected $dates;
/**
* The twig bridge instance.
*
* @var \TwigBridge\Bridge
*/
protected $twig;
/**
* Create a new update incident command handler instance.
*
* @param \CachetHQ\Cachet\Dates\DateFactory $dates
* @param \TwigBridge\Bridge $twig
*
* @return void
*/
public function __construct(DateFactory $dates, Bridge $twig)
public function __construct(DateFactory $dates)
{
$this->dates = $dates;
$this->twig = $twig;
}
/**
@@ -64,8 +56,8 @@ class UpdateIncidentCommandHandler
*/
public function handle(UpdateIncidentCommand $command)
{
if ($command->template) {
$command->message = $this->parseIncidentTemplate($command->template, $command->template_vars);
if ($template = IncidentTemplate::where('slug', $command->template)->first()) {
$command->message = $this->parseTemplate($template, $command);
}
$incident = $command->incident;
@@ -82,10 +74,17 @@ class UpdateIncidentCommandHandler
}
// Update the component.
if ($command->component_id) {
Component::find($command->component_id)->update([
'status' => $command->component_status,
]);
if ($component = Component::find($command->component_id)) {
dispatch(new UpdateComponentCommand(
Component::find($command->component_id),
null,
null,
$command->component_status,
null,
null,
null,
null
));
}
event(new IncidentWasUpdatedEvent($incident));
@@ -121,16 +120,30 @@ class UpdateIncidentCommandHandler
/**
* Compiles an incident template into an incident message.
*
* @param string $templateSlug
* @param array $vars
* @param \CachetHQ\Cachet\Models\IncidentTemplate $template
* @param \CachetHQ\Cachet\Bus\Commands\Incident\UpdateIncidentCommand $command
*
* @return string
*/
protected function parseIncidentTemplate($templateSlug, $vars)
protected function parseTemplate(IncidentTemplate $template, UpdateIncidentCommand $command)
{
$this->twig->setLoader(new Twig_Loader_String());
$template = IncidentTemplate::forSlug($templateSlug)->first();
$env = new Twig_Environment(new Twig_Loader_Array([]));
$template = $env->createTemplate($template->template);
return $this->twig->render($template->template, $vars);
$vars = array_merge($command->template_vars, [
'incident' => [
'name' => $command->name,
'status' => $command->status,
'message' => $command->message,
'visible' => $command->visible,
'notify' => $command->notify,
'stickied' => $command->stickied,
'incident_date' => $command->incident_date,
'component' => Component::find($command->component_id) ?: null,
'component_status' => $command->component_status,
],
]);
return $template->render($vars);
}
}

2
app/Bus/Handlers/Commands/IncidentUpdate/ReportIncidentUpdateCommandHandler.php
View File

@@ -55,7 +55,7 @@ class ReportIncidentUpdateCommandHandler
null,
null,
null,
null
[]
));
event(new IncidentUpdateWasReportedEvent($update));

4
app/Http/Controllers/Api/IncidentController.php
View File

@@ -78,7 +78,7 @@ class IncidentController extends AbstractApiController
Binput::get('stickied', false),
Binput::get('created_at'),
Binput::get('template'),
Binput::get('vars')
Binput::get('vars', [])
));
} catch (QueryException $e) {
throw new BadRequestHttpException();
@@ -109,7 +109,7 @@ class IncidentController extends AbstractApiController
Binput::get('stickied', false),
Binput::get('created_at'),
Binput::get('template'),
Binput::get('vars')
Binput::get('vars', [])
));
} catch (QueryException $e) {
throw new BadRequestHttpException();

4
app/Http/Controllers/Dashboard/IncidentController.php
View File

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

23
app/Models/IncidentTemplate.php
View File

@@ -12,7 +12,6 @@
namespace CachetHQ\Cachet\Models;
use AltThree\Validator\ValidatingTrait;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
@@ -27,6 +26,7 @@ class IncidentTemplate extends Model
*/
protected $casts = [
'name' => 'string',
'slug' => 'string',
'template' => 'string',
];
@@ -35,7 +35,7 @@ class IncidentTemplate extends Model
*
* @var string[]
*/
protected $fillable = ['name', 'template'];
protected $fillable = ['name', 'slug', 'template'];
/**
* The validation rules.
@@ -43,8 +43,9 @@ class IncidentTemplate extends Model
* @var string[]
*/
public $rules = [
'name' => 'required',
'template' => 'required',
'name' => 'required|string',
'slug' => 'string',
'template' => 'required|string',
];
/**
@@ -55,20 +56,24 @@ class IncidentTemplate extends Model
parent::boot();
self::saving(function ($template) {
$template->slug = Str::slug($template->name);
if (!$template->slug) {
$template->slug = Str::slug($template->name);
}
});
}
/**
* Finds a template by the slug.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $slug
* @param string $slug
* @param string[] $columns
*
* @return \Illuminate\Database\Query\Builder
*/
public function scopeForSlug(Builder $query, $slug)
public static function forSlug($slug, $columns = ['*'])
{
return $query->where('slug', $slug);
$template = static::where('slug', $slug)->firstOrFail($columns);
return $template;
}
}

2
composer.json
View File

@@ -42,7 +42,7 @@
"mccool/laravel-auto-presenter": "^4.3",
"pragmarx/google2fa": "^0.7.1",
"predis/predis": "^1.1",
"rcrowe/twigbridge": "^0.9.2",
"twig/twig": "^2.0.0",
"roumen/feed": "^2.10.4"
},
"require-dev": {

93
composer.lock generated
View File

@@ -4,8 +4,8 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically"
],
"hash": "beb947157999db1d55d9af092dd81f37",
"content-hash": "89a23d2b2505160bda9ead17b9b0c0d4",
"hash": "5b4008d015b0c722e137bd32d3b04054",
"content-hash": "72e88a7089a1b4f00cb2f25dcffbdd74",
"packages": [
{
"name": "alt-three/badger",
@@ -325,16 +325,16 @@
},
{
"name": "aws/aws-sdk-php",
"version": "3.19.13",
"version": "3.19.14",
"source": {
"type": "git",
"url": "https://github.com/aws/aws-sdk-php.git",
"reference": "57b0efed8fcf5d8c854bc1c26cf4a685af9108d9"
"reference": "2d0c88883dac2f8dd21825b51ef1f04e04073f8f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/aws/aws-sdk-php/zipball/57b0efed8fcf5d8c854bc1c26cf4a685af9108d9",
"reference": "57b0efed8fcf5d8c854bc1c26cf4a685af9108d9",
"url": "https://api.github.com/repos/aws/aws-sdk-php/zipball/2d0c88883dac2f8dd21825b51ef1f04e04073f8f",
"reference": "2d0c88883dac2f8dd21825b51ef1f04e04073f8f",
"shasum": ""
},
"require": {
@@ -401,7 +401,7 @@
"s3",
"sdk"
],
"time": "2016-10-06 21:17:44"
"time": "2016-10-12 21:32:40"
},
{
"name": "backup-manager/backup-manager",
@@ -2957,70 +2957,6 @@
],
"time": "2016-03-09 05:03:14"
},
{
"name": "rcrowe/twigbridge",
"version": "v0.9.3",
"source": {
"type": "git",
"url": "https://github.com/rcrowe/TwigBridge.git",
"reference": "6226d33331bbb1cdf64593a786f7efd1670200a7"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/rcrowe/TwigBridge/zipball/6226d33331bbb1cdf64593a786f7efd1670200a7",
"reference": "6226d33331bbb1cdf64593a786f7efd1670200a7",
"shasum": ""
},
"require": {
"illuminate/support": "5.0.*|5.1.*|5.2.*|5.3.*",
"illuminate/view": "5.0.*|5.1.*|5.2.*|5.3.*",
"php": ">=5.4.0",
"twig/twig": "~1.15|~2.0"
},
"require-dev": {
"laravel/framework": "5.0.*",
"mockery/mockery": "0.9.*",
"phpunit/phpunit": "~4.0",
"satooshi/php-coveralls": "~0.6",
"squizlabs/php_codesniffer": "~1.5"
},
"suggest": {
"laravelcollective/html": "For bringing back html/form in Laravel 5.x",
"twig/extensions": "~1.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "0.10-dev"
}
},
"autoload": {
"psr-4": {
"TwigBridge\\": "src",
"TwigBridge\\Tests\\": "tests"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Barry vd. Heuvel",
"email": "barryvdh@gmail.com"
},
{
"name": "Rob Crowe",
"email": "hello@vivalacrowe.com"
}
],
"description": "Adds the power of Twig to Laravel",
"keywords": [
"laravel",
"twig"
],
"time": "2016-05-01 16:43:38"
},
{
"name": "roumen/feed",
"version": "v2.10.4",
@@ -4057,20 +3993,21 @@
},
{
"name": "twig/twig",
"version": "v1.26.1",
"version": "dev-master",
"source": {
"type": "git",
"url": "https://github.com/twigphp/Twig.git",
"reference": "a09d8ee17ac1cfea29ed60c83960ad685c6a898d"
"reference": "907366d05379156152bcb1862931a1687be71200"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/twigphp/Twig/zipball/a09d8ee17ac1cfea29ed60c83960ad685c6a898d",
"reference": "a09d8ee17ac1cfea29ed60c83960ad685c6a898d",
"url": "https://api.github.com/repos/twigphp/Twig/zipball/907366d05379156152bcb1862931a1687be71200",
"reference": "907366d05379156152bcb1862931a1687be71200",
"shasum": ""
},
"require": {
"php": ">=5.2.7"
"php": ">=5.5",
"symfony/polyfill-mbstring": "~1.0"
},
"require-dev": {
"symfony/debug": "~2.7",
@@ -4079,7 +4016,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.26-dev"
"dev-master": "2.0-dev"
}
},
"autoload": {
@@ -4114,7 +4051,7 @@
"keywords": [
"templating"
],
"time": "2016-10-05 18:57:41"
"time": "2016-10-05 18:16:59"
},
{
"name": "vlucas/phpdotenv",

1
config/app.php
View File

@@ -175,7 +175,6 @@ return [
'McCool\LaravelAutoPresenter\AutoPresenterServiceProvider',
'PragmaRX\Google2FA\Vendor\Laravel\ServiceProvider',
'Roumen\Feed\FeedServiceProvider',
'TwigBridge\ServiceProvider',
/*
* Application Service Providers...

10
tests/Api/IncidentTest.php
View File

@@ -130,20 +130,18 @@ class IncidentTest extends AbstractApiTestCase
public function testPutIncidentWithTemplate()
{
$this->beUser();
$template = factory('CachetHQ\Cachet\Models\IncidentTemplate')->create();
$template = factory('CachetHQ\Cachet\Models\IncidentTemplate')->create([
'template' => 'Hello there this is a foo in my {{ incident.name }}!',
]);
$component = factory('CachetHQ\Cachet\Models\Incident')->create();
$this->put('/api/v1/incidents/1', [
'name' => 'Foo',
'template' => $template->slug,
'vars' => [
'name' => 'Foo',
'message' => 'Hello there this is a foo!',
],
]);
$this->seeJson([
'name' => 'Foo',
'message' => "Name: Foo,\nMessage: Hello there this is a foo!",
'message' => 'Hello there this is a foo in my Foo!',
]);
$this->assertResponseOk();
}

2
tests/Bus/Commands/Incident/ReportIncidentCommandTest.php
View File

@@ -39,7 +39,7 @@ class ReportIncidentCommandTest extends AbstractTestCase
'stickied' => false,
'incident_date' => null,
'template' => null,
'template_vars' => null,
'template_vars' => [],
];
$object = new ReportIncidentCommand(

2
tests/Bus/Commands/Incident/UpdateIncidentCommandTest.php
View File

@@ -41,7 +41,7 @@ class UpdateIncidentCommandTest extends AbstractTestCase
'stickied' => false,
'incident_date' => null,
'template' => null,
'template_vars' => null,
'template_vars' => [],
];
$object = new UpdateIncidentCommand(