Better exceptions and response (#92)

* - Add exceptions FieldValidationException and MissingRequiredFieldException
- Add Handler to extend exception handling and data formatting

* Apply fixes from StyleCI

---------

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

Author: 3 people

config/asseco-custom-fields.php

@@ -27,35 +27,35 @@
      * Model bindings.
      */
     'models' => [
-        'custom_field'    => CustomField::class,
-        'form'            => Form::class,
-        'form_template'   => FormTemplate::class,
-        'plain_type'      => PlainType::class,
-        'relation'        => Relation::class,
-        'remote_type'     => RemoteType::class,
-        'selection_type'  => SelectionType::class,
+        'custom_field' => CustomField::class,
+        'form' => Form::class,
+        'form_template' => FormTemplate::class,
+        'plain_type' => PlainType::class,
+        'relation' => Relation::class,
+        'remote_type' => RemoteType::class,
+        'selection_type' => SelectionType::class,
         'selection_value' => SelectionValue::class,
-        'validation'      => Validation::class,
-        'value'           => Value::class,
+        'validation' => Validation::class,
+        'value' => Value::class,
     ],
 
     'plain_types' => [
-        'boolean'  => BooleanType::class,
+        'boolean' => BooleanType::class,
         'datetime' => DateTimeType::class,
-        'date'     => DateType::class,
-        'float'    => FloatType::class,
-        'integer'  => IntegerType::class,
-        'string'   => StringType::class,
-        'text'     => TextType::class,
-        'time'     => TimeType::class,
+        'date' => DateType::class,
+        'float' => FloatType::class,
+        'integer' => IntegerType::class,
+        'string' => StringType::class,
+        'text' => TextType::class,
+        'time' => TimeType::class,
     ],
 
-    'migrations'  => [
+    'migrations' => [
 
         /**
          * UUIDs as primary keys.
          */
-        'uuid'       => false,
+        'uuid' => false,
 
         /**
          * Timestamp types.
@@ -68,7 +68,7 @@
          * Should the package run the migrations. Set to false if you're publishing
          * and changing default migrations.
          */
-        'run'        => true,
+        'run' => true,
     ],
 
     /**
@@ -84,10 +84,10 @@
     /**
      * Namespace to Customizable trait.
      */
-    'trait_path'  => Customizable::class,
+    'trait_path' => Customizable::class,
 
     'routes' => [
-        'prefix'     => 'api',
+        'prefix' => 'api',
         'middleware' => ['api'],
     ],
 

migrations/2020_05_26_053145_create_custom_field_plain_types_table.php

@@ -49,14 +49,14 @@ protected function seedData(): void
         foreach ($types as $type) {
             if (config('asseco-custom-fields.migrations.uuid')) {
                 $plainTypes[] = [
-                    'id'         => Str::uuid(),
-                    'name'       => $type,
+                    'id' => Str::uuid(),
+                    'name' => $type,
                     'created_at' => now(),
                     'updated_at' => now(),
                 ];
             } else {
                 $plainTypes[] = [
-                    'name'       => $type,
+                    'name' => $type,
                     'created_at' => now(),
                     'updated_at' => now(),
                 ];

src/App/Exceptions/FieldValidationException.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Asseco\CustomFields\App\Exceptions;
+
+use Exception;
+use Throwable;
+
+class FieldValidationException extends Exception
+{
+    private array $data = [];
+
+    public function __construct(string $message = 'Invalid form', int $code = 400, ?Throwable $previous = null, array $data = [])
+    {
+        $this->data = $data;
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}

src/App/Exceptions/Handler.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Asseco\CustomFields\App\Exceptions;
+
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+
+class Handler extends ExceptionHandler
+{
+    /**
+     * A list of exception types with their corresponding custom log levels.
+     *
+     * @var array<class-string<\Throwable>, \Psr\Log\LogLevel::*>
+     */
+    protected $levels = [
+        //
+    ];
+
+    /**
+     * A list of the exception types that are not reported.
+     *
+     * @var array<int, class-string<\Throwable>>
+     */
+    protected $dontReport = [
+        //
+    ];
+
+    /**
+     * A list of the inputs that are never flashed to the session on validation exceptions.
+     *
+     * @var array<int, string>
+     */
+    protected $dontFlash = [
+        'current_password',
+        'password',
+        'password_confirmation',
+    ];
+
+    /**
+     * Register the exception handling callbacks for the application.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->renderable(function (MissingRequiredFieldException $e) {
+            return response()->json([
+                'message' => $e->getMessage(),
+                'errors' => $e->getData(),
+            ], $e->getCode());
+        });
+
+        $this->renderable(function (FieldValidationException $e) {
+            return response()->json([
+                'message' => $e->getMessage(),
+                'errors' => $e->getData(),
+            ], $e->getCode());
+        });
+    }
+}

src/App/Exceptions/MissingRequiredFieldException.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Asseco\CustomFields\App\Exceptions;
+
+use Exception;
+use Throwable;
+
+class MissingRequiredFieldException extends Exception
+{
+    private array $data = [];
+
+    public function __construct(string $message = 'Invalid form', int $code = 422, ?Throwable $previous = null, array $data = [])
+    {
+        $this->data = $data;
+        parent::__construct($message, $code, $previous);
+    }
+
+    public function getData(): array
+    {
+        return $this->data;
+    }
+}

src/App/Http/Controllers/PlainCustomFieldController.php

@@ -58,7 +58,7 @@ public function store(PlainCustomFieldRequest $request, string $type): JsonRespo
 
         $selectableData = [
             'selectable_type' => $typeModel,
-            'selectable_id'   => $typeModel::query()->firstOrFail('id')->id,
+            'selectable_id' => $typeModel::query()->firstOrFail('id')->id,
         ];
 
         $customField = $this->customField::query()->create(array_merge($data, $selectableData));

src/App/Http/Controllers/RemoteCustomFieldController.php

@@ -68,7 +68,7 @@ public function store(RemoteCustomFieldRequest $request): JsonResponse
 
             $selectableData = [
                 'selectable_type' => get_class($this->remoteClass),
-                'selectable_id'   => $remoteType->id,
+                'selectable_id' => $remoteType->id,
             ];
 
             $cfData = Arr::except($data, 'remote');

src/App/Http/Controllers/SelectionCustomFieldController.php

@@ -74,7 +74,7 @@ public function store(SelectionCustomFieldRequest $request, string $type): JsonR
             $selectionTypeModel = $this->selectionClass;
             $selectionType = $selectionTypeModel::query()->create([
                 'plain_type_id' => $plainTypeId,
-                'multiselect'   => $multiselect,
+                'multiselect' => $multiselect,
             ]);
 
             $selectionValues = Arr::get($data, 'values', []);
@@ -89,7 +89,7 @@ public function store(SelectionCustomFieldRequest $request, string $type): JsonR
 
             $selectableData = [
                 'selectable_type' => $this->selectionClass,
-                'selectable_id'   => $selectionType->id,
+                'selectable_id' => $selectionType->id,
             ];
 
             $cfData = Arr::except($data, ['selection', 'values']);

src/App/Http/Requests/CustomFieldCreateRequest.php

@@ -29,24 +29,24 @@ public function authorize()
     public function rules()
     {
         return [
-            'name'          => [
+            'name' => [
                 'required',
                 'string',
                 'regex:/^[^\s]*$/i',
                 Rule::unique('custom_fields')->ignore($this->custom_field)->where(function ($query) {
                     return $this->usesSoftDelete() ? $query->whereNull('deleted_at') : $query;
                 }),
             ],
-            'label'           => 'required|string|max:255',
-            'placeholder'     => 'nullable|string',
+            'label' => 'required|string|max:255',
+            'placeholder' => 'nullable|string',
             'selectable_type' => 'required',
-            'selectable_id'   => 'required',
-            'model'           => 'required|string',
-            'required'        => 'boolean',
-            'hidden'          => 'boolean',
-            'validation_id'   => 'nullable|exists:custom_field_validations,id',
-            'group'           => 'nullable|string',
-            'order'           => 'nullable|integer',
+            'selectable_id' => 'required',
+            'model' => 'required|string',
+            'required' => 'boolean',
+            'hidden' => 'boolean',
+            'validation_id' => 'nullable|exists:custom_field_validations,id',
+            'group' => 'nullable|string',
+            'order' => 'nullable|integer',
         ];
     }
 

src/App/Http/Requests/CustomFieldUpdateRequest.php

@@ -35,21 +35,21 @@ public function authorize()
     public function rules()
     {
         $rules = [
-            'name'          => [
+            'name' => [
                 'required',
                 'string',
                 'regex:/^[^\s]*$/i',
                 Rule::unique('custom_fields')->ignore($this->custom_field)->where(function ($query) {
                     return $this->usesSoftDelete() ? $query->whereNull('deleted_at') : $query;
                 }),
             ],
-            'label'         => 'sometimes|string|max:255',
-            'placeholder'   => 'nullable|string',
-            'required'      => 'boolean',
-            'hidden'        => 'boolean',
+            'label' => 'sometimes|string|max:255',
+            'placeholder' => 'nullable|string',
+            'required' => 'boolean',
+            'hidden' => 'boolean',
             'validation_id' => 'nullable|exists:custom_field_validations,id',
-            'group'         => 'nullable|string',
-            'order'         => 'nullable|integer',
+            'group' => 'nullable|string',
+            'order' => 'nullable|integer',
         ];
 
         return Arr::except($rules, self::LOCKED_FOR_EDITING);