Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better exceptions and response #92

Merged
merged 2 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions config/asseco-custom-fields.php
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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,
],

/**
Expand All @@ -84,10 +84,10 @@
/**
* Namespace to Customizable trait.
*/
'trait_path' => Customizable::class,
'trait_path' => Customizable::class,

'routes' => [
'prefix' => 'api',
'prefix' => 'api',
'middleware' => ['api'],
],

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
];
Expand Down
22 changes: 22 additions & 0 deletions src/App/Exceptions/FieldValidationException.php
Original file line number Diff line number Diff line change
@@ -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;
}
}
59 changes: 59 additions & 0 deletions src/App/Exceptions/Handler.php
Original file line number Diff line number Diff line change
@@ -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());
});
}
}
22 changes: 22 additions & 0 deletions src/App/Exceptions/MissingRequiredFieldException.php
Original file line number Diff line number Diff line change
@@ -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;
}
}
2 changes: 1 addition & 1 deletion src/App/Http/Controllers/PlainCustomFieldController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down
2 changes: 1 addition & 1 deletion src/App/Http/Controllers/RemoteCustomFieldController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down
4 changes: 2 additions & 2 deletions src/App/Http/Controllers/SelectionCustomFieldController.php
Original file line number Diff line number Diff line change
Expand Up @@ -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', []);
Expand All @@ -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']);
Expand Down
20 changes: 10 additions & 10 deletions src/App/Http/Requests/CustomFieldCreateRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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',
];
}

Expand Down
14 changes: 7 additions & 7 deletions src/App/Http/Requests/CustomFieldUpdateRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
4 changes: 2 additions & 2 deletions src/App/Http/Requests/FormRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ public function authorize()
public function rules()
{
return [
'tenant_id' => 'nullable',
'name' => 'required|string|regex:/^[^\s]*$/i|unique:forms,name' . ($this->form ? ',' . $this->form->id : null),
'tenant_id' => 'nullable',
'name' => 'required|string|regex:/^[^\s]*$/i|unique:forms,name' . ($this->form ? ',' . $this->form->id : null),
'definition' => 'required|array',
'action_url' => 'nullable|string',
];
Expand Down
16 changes: 8 additions & 8 deletions src/App/Http/Requests/PlainCustomFieldRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ 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',
'model' => 'required|string',
'required' => 'boolean',
'validation_id' => 'nullable|exists:custom_field_validations',
'group' => 'nullable|string',
'order' => 'nullable|integer',
'label' => 'required|string|max:255',
'placeholder' => 'nullable|string',
'model' => 'required|string',
'required' => 'boolean',
'validation_id' => 'nullable|exists:custom_field_validations',
'group' => 'nullable|string',
'order' => 'nullable|integer',
];
}

Expand Down
2 changes: 1 addition & 1 deletion src/App/Http/Requests/RelationRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function rules()
{
return [
'parent_id' => 'required|exists:custom_fields,id',
'child_id' => 'required|exists:custom_fields,id|different:parent_id',
'child_id' => 'required|exists:custom_fields,id|different:parent_id',
];
}

Expand Down
30 changes: 15 additions & 15 deletions src/App/Http/Requests/RemoteCustomFieldRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,28 +29,28 @@ 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',
'model' => 'required|string',
'required' => 'boolean',
'validation_id' => 'nullable|exists:custom_field_validations',
'group' => 'nullable|string',
'order' => 'nullable|integer',
'remote' => 'required|array',
'remote.url' => 'required|url',
'remote.method' => 'required|in:GET,POST,PUT',
'remote.body' => 'nullable|array',
'remote.headers' => 'nullable|array',
'remote.mappings' => 'nullable|array',
'remote.data_path' => 'nullable|string',
'label' => 'required|string|max:255',
'placeholder' => 'nullable|string',
'model' => 'required|string',
'required' => 'boolean',
'validation_id' => 'nullable|exists:custom_field_validations',
'group' => 'nullable|string',
'order' => 'nullable|integer',
'remote' => 'required|array',
'remote.url' => 'required|url',
'remote.method' => 'required|in:GET,POST,PUT',
'remote.body' => 'nullable|array',
'remote.headers' => 'nullable|array',
'remote.mappings' => 'nullable|array',
'remote.data_path' => 'nullable|string',
'remote.identifier_property' => 'nullable|string',
];
}
Expand Down
Loading
Loading