Plugin error logging

app/Events/PluginErrorReceivedEvent.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Events;
+
+use App\Models\PluginError\PluginError;
+
+class PluginErrorReceivedEvent
+{
+    /**
+     * @var PluginError
+     */
+    private $error;
+
+    public function __construct(PluginError $error)
+    {
+        $this->error = $error;
+    }
+
+    /**
+     * @return PluginError
+     */
+    public function getError(): PluginError
+    {
+        return $this->error;
+    }
+}

app/Exceptions/PluginErrorException.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+
+/**
+ * Class PluginErrorException
+ * Custom exception to be passed to bugsnag to record the fact a new plugin
+ * error has come in.
+ */
+class PluginErrorException extends Exception
+{
+}

app/Http/Controllers/PluginErrorController.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Events\PluginErrorReceivedEvent;
+use App\Models\PluginError\PluginError;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Event;
+
+class PluginErrorController extends BaseController
+{
+    /**
+     * Records a plugin error
+     *
+     * @return Response
+     */
+    public function recordPluginError(Request $request) : Response
+    {
+        $dataCheck = $this->checkForSuppliedData(
+            $request,
+            [
+                'user_report' => 'required|boolean',
+                'data' => 'required|array',
+            ]
+        );
+
+        if ($dataCheck) {
+            return response(null, 400);
+        }
+
+        $pluginError = PluginError::create(
+            [
+                'user_id' => Auth::user()->id,
+                'user_report' => $request->json('user_report'),
+                'data' => json_encode($request->json('data')),
+            ]
+        );
+
+        Event::fire(new PluginErrorReceivedEvent($pluginError));
+        return response('', 204);
+    }
+}

app/Listeners/PluginError/RecordPluginErrorInBugsnag.php

@@ -0,0 +1,23 @@
+<?php
+
+
+namespace App\Listeners\PluginError;
+
+use App\Events\PluginErrorReceivedEvent;
+use App\Exceptions\PluginErrorException;
+use Bugsnag\BugsnagLaravel\Facades\Bugsnag;
+
+class RecordPluginErrorInBugsnag
+{
+    /**
+     * Handle any squawk allocation event
+     *
+     * @param PluginErrorReceivedEvent $errorReceivedEvent
+     * @return bool
+     */
+    public function handle(PluginErrorReceivedEvent $errorReceivedEvent) : bool
+    {
+        Bugsnag::notifyException(new PluginErrorException('New plugin error reported'));
+        return false;
+    }
+}

app/Models/PluginError/PluginError.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Models\PluginError;
+
+use Illuminate\Database\Eloquent\Model;
+
+class PluginError extends Model
+{
+    protected $table = 'plugin_error';
+
+    public $timestamps = true;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'user_id',
+        'user_report',
+        'data',
+    ];
+}

database/migrations/2019_01_27_203429_create_plugin_errors_table.php

@@ -0,0 +1,37 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreatePluginErrorsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('plugin_error', function (Blueprint $table) {
+            $table->increments('id');
+            $table->unsignedInteger('user_id')->comment('The user who the report is attributed to');
+            $table->boolean('user_report')->comment('Whether the report was generated by the user or the plugin');
+            $table->json('data')->comment('Report data');
+            $table->timestamps();
+
+            $table->foreign('user_id')
+                ->references('id')->on('user');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('plugin_error');
+    }
+}

routes/routes.php

@@ -15,7 +15,7 @@
             'uses' => 'TeapotController@teapot',
         ]
     );
-    
+
     // Version checking
     $router->get(
         'version/{version:[A-Za-z0-9\.\-]+}/status',
@@ -26,17 +26,20 @@
             'uses' => 'VersionController@getVersionStatus'
         ]
     );
-    
+
     // Dependencies
     $router->get('dependency', 'DependencyController@getManifest');
-    
+
     // Squawks
     $router->get('squawk-assignment/{callsign:[A-Za-z0-9\-]{1,10}}', 'SquawkController@getSquawkAssignment');
     $router->put('squawk-assignment/{callsign:[A-Za-z0-9\-]{1,10}}', 'SquawkController@assignSquawk');
     $router->delete('squawk-assignment/{callsign:[A-Za-z0-9\-]{1,10}}', 'SquawkController@deleteSquawkAssignment');
-    
+
     // Regional Pressure
     $router->get('regional-pressure', 'RegionalPressureController@getRegionalPressures');
+
+    // Plugin Errors
+    $router->post('plugin-error', 'PluginErrorController@recordPluginError');
 });
 
 // Routes for user administration
@@ -111,13 +114,13 @@
 // Routes for user administration
 $router->group(['middleware' => 'scopes:' . AuthServiceProvider::SCOPE_VERSION_ADMIN], function () use ($router) {
 
-        // A test route for useradmin access
-        $router->get('versionadmin', 'TeapotController@teapot');
+    // A test route for useradmin access
+    $router->get('versionadmin', 'TeapotController@teapot');
 
-        // Routes for returning information about versions
-        $router->get('version', 'VersionController@getAllVersions');
-        $router->get('version/{version:[A-Za-z0-9\.\-]+}', 'VersionController@getVersion');
+    // Routes for returning information about versions
+    $router->get('version', 'VersionController@getAllVersions');
+    $router->get('version/{version:[A-Za-z0-9\.\-]+}', 'VersionController@getVersion');
 
-        // Route for updating and creating versions
-        $router->put('version/{version:[A-Za-z0-9\.\-]+}', 'VersionController@createOrUpdateVersion');
+    // Route for updating and creating versions
+    $router->put('version/{version:[A-Za-z0-9\.\-]+}', 'VersionController@createOrUpdateVersion');
 });

tests/app/Events/PluginErrorReceivedEventTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Events;
+
+use App\BaseUnitTestCase;
+use App\Models\PluginError\PluginError;
+
+class PluginErrorReceivedEventTest extends BaseUnitTestCase
+{
+    public function testItConstructs()
+    {
+        $this->assertInstanceOf(PluginErrorReceivedEvent::class, new PluginErrorReceivedEvent(new PluginError));
+    }
+
+    public function testItCanReturnTheError()
+    {
+        $error = new PluginError;
+        $event = new PluginErrorReceivedEvent($error);
+        $this->assertEquals($error, $event->getError());
+    }
+}

tests/app/Http/Controllers/PluginErrorControllerTest.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\BaseApiTestCase;
+use App\Models\PluginError\PluginError;
+
+class PluginErrorControllerTest extends BaseApiTestCase
+{
+    public function testItConstructs()
+    {
+        $this->assertInstanceOf(PluginErrorController::class, $this->app->make(PluginErrorController::class));
+    }
+
+    public function testItReturns400OnMissingUserReport()
+    {
+        $this->makeAuthenticatedApiRequest(
+            self::METHOD_POST,
+            'plugin-error',
+            [
+                'data' => [
+                    'foo' => 'bar'
+                ],
+            ]
+        )->seeStatusCode(400);
+    }
+
+    public function testItReturns400OnMissingData()
+    {
+        $this->makeAuthenticatedApiRequest(
+            self::METHOD_POST,
+            'plugin-error',
+            [
+                'user_report' => true,
+            ]
+        )->seeStatusCode(400);
+    }
+
+    public function testItReturnsNoContentOnSuccess()
+    {
+        $this->makeAuthenticatedApiRequest(
+            self::METHOD_POST,
+            'plugin-error',
+            [
+                'user_report' => true,
+                'data' => [
+                    'foo' => 'bar',
+                    'baz' => [
+                        'foo' => 'bar',
+                    ]
+                ],
+            ]
+        )->seeStatusCode(204);
+    }
+
+    public function testItStoresUserReports()
+    {
+        $data = [
+            'baz' => [
+                'foo' => 'bar',
+            ],
+            'foo' => 'bar',
+        ];
+
+        $this->makeAuthenticatedApiRequest(
+            self::METHOD_POST,
+            'plugin-error',
+            [
+                'user_report' => true,
+                'data' => $data
+            ]
+        );
+
+        $pluginError = PluginError::orderBy('created_at', 'desc')->first();
+        $this->assertEquals(self::ACTIVE_USER_CID, $pluginError->user_id);
+        $this->assertEquals(1, $pluginError->user_report);
+        $this->assertEquals($data, json_decode($pluginError->data, true));
+    }
+
+    public function testItStoresNonUserReports()
+    {
+        $data = [
+            'baz' => [
+                'foo' => 'bar',
+            ],
+            'foo' => 'bar',
+        ];
+
+        $this->makeAuthenticatedApiRequest(
+            self::METHOD_POST,
+            'plugin-error',
+            [
+                'user_report' => false,
+                'data' => $data
+            ]
+        );
+
+        $pluginError = PluginError::orderBy('created_at', 'desc')->first();
+        $this->assertEquals(self::ACTIVE_USER_CID, $pluginError->user_id);
+        $this->assertEquals(0, $pluginError->user_report);
+        $this->assertEquals($data, json_decode($pluginError->data, true));
+    }
+}

tests/app/Listeners/PluginError/RecordPluginErrorInBugsnagTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Listeners\PluginError;
+
+use App\BaseUnitTestCase;
+use App\Events\PluginErrorReceivedEvent;
+use App\Models\PluginError\PluginError;
+
+class RecordPluginErrorInBugsnagTest extends BaseUnitTestCase
+{
+    public function testItConstructs()
+    {
+        $listener = new RecordPluginErrorInBugsnag();
+        $this->assertInstanceOf(RecordPluginErrorInBugsnag::class, $listener);
+    }
+
+    public function testItStopsEventPropagation()
+    {
+        $listener = new RecordPluginErrorInBugsnag();
+        $this->assertFalse($listener->handle(new PluginErrorReceivedEvent(new PluginError)));
+    }
+}