[Feature] Removendo dependência para logs do laravel (#6)

gsousadev · gsousadev · web-flow · commit e8f463ee08f8 · 2024-01-19T00:29:14.000-03:00
* fix: Ajustando Documentação

* fix: permitindo o uso do método report

* fix: Ajustando nome de configs

---------

Co-authored-by: gsousadev &lt;guilherme.sousa@picpay.com&gt;
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Laravel Problem Detail Exceptions
 
-[![Versão](https://img.shields.io/badge/vers%C3%A3o-1.1.0-beta)](https://github.com/seu-usuario/sua-lib/releases)
+[![Versão](https://img.shields.io/badge/vers%C3%A3o-1.2.0-beta)](https://github.com/seu-usuario/sua-lib/releases)
 [![Licença](https://img.shields.io/badge/licen%C3%A7a-MIT-green)](https://opensource.org/licenses/MIT)
 
 Esse projeto tem por objetivo prover uma biblioteca Laravel que permite implementar de maneira simples e rápida um padrão de exceptions, seguindo os conceitos da [RFC de problem details](https://datatracker.ietf.org/doc/html/rfc7807)
@@ -21,6 +21,42 @@ php artisan vendor:publish --tag=problem-detail-exceptions
 
 Após a publicação do pacote deve ser criado um arquivo de configuração para o projeto no seguinte caminho: `/config/problem-detail-exceptions.php`.
 
+```php
+<?php
+
+use Gsousadev\LaravelProblemDetailExceptions\Enums\ExceptionsFieldsEnum;
+
+return [
+    'app_name' => env('PROBLEM_DETAIL_EXCEPTION_APP_NAME', 'APP'),
+    'log_throw' => env('PROBLEM_DETAIL_EXCEPTION_GENERATE_LOGS', true),
+    'available_fields_list' => [
+        ExceptionsFieldsEnum::TYPE,
+        ExceptionsFieldsEnum::TITLE,
+        ExceptionsFieldsEnum::STATUS,
+        ExceptionsFieldsEnum::DETAIL,
+        ExceptionsFieldsEnum::INTERNAL_CODE,
+        ExceptionsFieldsEnum::MESSAGE,
+        ExceptionsFieldsEnum::USER_MESSAGE,
+        ExceptionsFieldsEnum::USER_TITLE,
+        ExceptionsFieldsEnum::LOCATION,
+        ExceptionsFieldsEnum::TRACE_ID,
+        ExceptionsFieldsEnum::PREVIOUS_MESSAGE,
+        ExceptionsFieldsEnum::PREVIOUS_CODE,
+        ExceptionsFieldsEnum::PREVIOUS_TYPE,
+        ExceptionsFieldsEnum::PREVIOUS_LOCATION
+
+    ],
+    'renderable_fields_list' => [
+        ExceptionsFieldsEnum::TITLE,
+        ExceptionsFieldsEnum::STATUS,
+        ExceptionsFieldsEnum::USER_MESSAGE,
+        ExceptionsFieldsEnum::USER_TITLE,
+    ],
+
+];
+
+```
+
 ## Configurando
 
 Este pacote permite algumas configurações de customização. Para isso deve-se user o arquivo `problem-detail-exceptions.php`
@@ -29,6 +65,12 @@ Para ter dados coerentes dentro do fluxo é importante ter duas variáveis de am
 - **PROBLEM_DETAIL_EXCEPTION_APP_NAME** : Indica o nome que pode aparecer nos logs referente ao nome do projeto ou app que o pacote esta sendo usado.
 - **PROBLEM_DETAIL_EXCEPTION_GENERATE_LOGS** : Esta variável permite que sejam ligados e desligados os logs que devem ser publicados em casos de erro.
 
+Ex: 
+```dotenv
+PROBLEM_DETAIL_EXCEPTION_APP_NAME=nome_do_aplicativo
+PROBLEM_DETAIL_EXCEPTION_GENERATE_LOGS=true
+```
+
 Existe também uma configuração que pode ser feita dentro do arquivo de configuração, informando quais campos devem ser considerados para exceptions de APIs
 
 Existir duas configurações possíveis: Campos que devem ser usados em qualquer contexto chamado `fields` e campos que devem ser mostrados em chamadas HTTP como resposta em casos de erro `renderable_fields`.
@@ -56,8 +98,13 @@ enum ExceptionsFieldsEnum: string
     case USER_TITLE = 'user_title';
     case LOCATION = 'location';
     case TRACE_ID = 'trace_id';
+    case PREVIOUS_MESSAGE = 'previous_message';
+    case PREVIOUS_TYPE = 'previous_type';
+    case PREVIOUS_CODE = 'previous_code';
+    case PREVIOUS_LOCATION = 'previous_location';
 }
 
+
 ```
 
 
@@ -137,7 +184,27 @@ try {
 }
 ```
 
-## Padronizando Exceptions de maneira Automática
+### Log por Exception
+
+Tambem é possível configurar o log em cada exception usando a opção `$logThrow`. Essa opção permite que possamos 
+configurar cada excessão para gerar logs, ou não, independente da configuração geral. Caso ela seja omitida a 
+configuração geral de logs será levada em consideração.
+
+Ex: 
+
+```php
+...
+
+class ExampleException extends ProblemDetailException
+{
+    protected ?bool $logThrow = true
+
+    public function __construct(?\Throwable $previous = null)
+    
+...
+```
+
+### Padronizando Exceptions de maneira Automática
 
 Existe uma classe que pode ser usada em conjunto com o Handler de Exceptions do Laravel para permitir que todas as 
 exceptions lançadas e que passem pelo handler possam ser transformadas e normalizadas no padrão 'Problem Detail'. 
@@ -180,7 +247,7 @@ class Handler extends ExceptionHandler
 
 ## Contribuindo
 
-O projeto esta em fase de construção da ideia inicial, mas apontamentos de melhorias são muito importantes para o 
+O projeto esta em fase de construção e apontamentos de melhorias são muito importantes para o 
 crescimento. Para sugerir uma melhoria use as Issues do github.
 
 ## Licença
diff --git a/src/Enums/ExceptionsFieldsEnum.php b/src/Enums/ExceptionsFieldsEnum.php
@@ -14,4 +14,8 @@ enum ExceptionsFieldsEnum: string
     case USER_TITLE = 'user_title';
     case LOCATION = 'location';
     case TRACE_ID = 'trace_id';
+    case PREVIOUS_MESSAGE = 'previous_message';
+    case PREVIOUS_TYPE = 'previous_type';
+    case PREVIOUS_CODE = 'previous_code';
+    case PREVIOUS_LOCATION = 'previous_location';
 }
diff --git a/src/Exceptions/ProblemDetailException.php b/src/Exceptions/ProblemDetailException.php
@@ -15,6 +15,7 @@ abstract class ProblemDetailException extends Exception
     private string $logAppName;
     private array $renderableFields;
     private array $fields;
+    protected ?bool $logThrow = null;
 
     public function __construct(
         private string $title,
@@ -25,32 +26,45 @@ public function __construct(
         private string $internalCode,
         private ?\Throwable $previous = null
     ) {
-        $this->message = $this->title . ' - ' . $this->detail;
-        $this->message = $this->previous ? $this->message . ' - ' . $this->previous->getMessage() : $this->message;
+        $this->message = $this->title;
         $this->code = $this->httpStatus;
         $this->instance = get_class($this);
         $this->logAppName = strtoupper(config('problem-detail-exceptions.app_name'));
-
         $this->validateConfigFields();
         $this->renderableFields = $this->generateRenderableFieldsByConfig();
-        $this->fields = $this->generateFieldsFieldsByConfig();
+        $this->fields = $this->generateFieldsByConfig();
 
         parent::__construct($this->message, $this->code, $this->previous);
+
+        $isDefaultEnableAndLogThrowNull = (is_null($this->logThrow) &&
+            config('problem-detail-exceptions.log_throw'));
+
+        if ($isDefaultEnableAndLogThrowNull || $this->logThrow) {
+            Log::error(
+                '[' . $this->logAppName . '][' . $this->internalCode . ']',
+                $this->toArray()
+            );
+        }
     }
 
     public function toArray(): array
     {
         $allFields = [
-            ExceptionsFieldsEnum::TYPE->value          => $this->instance,
-            ExceptionsFieldsEnum::TITLE->value         => $this->title,
-            ExceptionsFieldsEnum::STATUS->value        => $this->httpStatus ?? $this->code,
-            ExceptionsFieldsEnum::DETAIL->value        => $this->detail,
-            ExceptionsFieldsEnum::INTERNAL_CODE->value => $this->internalCode,
-            ExceptionsFieldsEnum::MESSAGE->value       => $this->message,
-            ExceptionsFieldsEnum::USER_MESSAGE->value  => $this->userMessage,
-            ExceptionsFieldsEnum::USER_TITLE->value    => $this->userTitle,
-            ExceptionsFieldsEnum::LOCATION->value      => $this->file . ':' . $this->line,
-            ExceptionsFieldsEnum::TRACE_ID->value      => data_get(Log::sharedContext(), 'trace_id'),
+            ExceptionsFieldsEnum::TYPE->value              => $this->instance,
+            ExceptionsFieldsEnum::TITLE->value             => $this->title,
+            ExceptionsFieldsEnum::STATUS->value            => $this->httpStatus ?? $this->code,
+            ExceptionsFieldsEnum::DETAIL->value            => $this->detail,
+            ExceptionsFieldsEnum::INTERNAL_CODE->value     => $this->internalCode,
+            ExceptionsFieldsEnum::MESSAGE->value           => $this->message,
+            ExceptionsFieldsEnum::USER_MESSAGE->value      => $this->userMessage,
+            ExceptionsFieldsEnum::USER_TITLE->value        => $this->userTitle,
+            ExceptionsFieldsEnum::LOCATION->value          => $this->file . ':' . $this->line,
+            ExceptionsFieldsEnum::TRACE_ID->value          => data_get(Log::sharedContext(), 'trace_id'),
+            ExceptionsFieldsEnum::PREVIOUS_MESSAGE->value  => $this->previous->getMessage() ?? null,
+            ExceptionsFieldsEnum::PREVIOUS_TYPE->value     => $this->previous::class ?? null,
+            ExceptionsFieldsEnum::PREVIOUS_CODE->value     => $this->previous->getCode() ?? null,
+            ExceptionsFieldsEnum::PREVIOUS_LOCATION->value => $this->previous->file . ':' . $this->previous->line ??
+                null,
         ];
 
         return array_filter(
@@ -78,7 +92,7 @@ function ($key) {
 
     public function report(): bool
     {
-        if (config('problem-detail-exceptions.enable_log_in_exception')) {
+        if (config('problem-detail-exceptions.log_throw')) {
             Log::error(
                 '[' . $this->logAppName . '][' . $this->internalCode . ']',
                 $this->toArray()
@@ -88,6 +102,7 @@ public function report(): bool
         return true;
     }
 
+
     public function getTitle(): string
     {
         return $this->title;
@@ -164,7 +179,7 @@ function ($renderableField) {
         );
     }
 
-    private function generateFieldsFieldsByConfig()
+    private function generateFieldsByConfig()
     {
         $fields = config('problem-detail-exceptions.available_fields_list');
 
@@ -176,4 +191,3 @@ function ($field) {
         );
     }
 }
-
diff --git a/src/config/problem-detail-exceptions.php b/src/config/problem-detail-exceptions.php
@@ -4,7 +4,7 @@
 
 return [
     'app_name' => env('PROBLEM_DETAIL_EXCEPTION_APP_NAME', 'APP'),
-    'enable_log_in_exception' => env('PROBLEM_DETAIL_EXCEPTION_GENERATE_LOGS', true),
+    'log_throw' => env('PROBLEM_DETAIL_EXCEPTION_GENERATE_LOGS', true),
     'available_fields_list' => [
         ExceptionsFieldsEnum::TYPE,
         ExceptionsFieldsEnum::TITLE,
@@ -15,7 +15,12 @@
         ExceptionsFieldsEnum::USER_MESSAGE,
         ExceptionsFieldsEnum::USER_TITLE,
         ExceptionsFieldsEnum::LOCATION,
-        ExceptionsFieldsEnum::TRACE_ID
+        ExceptionsFieldsEnum::TRACE_ID,
+        ExceptionsFieldsEnum::PREVIOUS_MESSAGE,
+        ExceptionsFieldsEnum::PREVIOUS_CODE,
+        ExceptionsFieldsEnum::PREVIOUS_TYPE,
+        ExceptionsFieldsEnum::PREVIOUS_LOCATION
+
     ],
     'renderable_fields_list' => [
         ExceptionsFieldsEnum::TITLE,

Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,8 @@ enum ExceptionsFieldsEnum: string`
`14`	`14`	`case USER_TITLE = 'user_title';`
`15`	`15`	`case LOCATION = 'location';`
`16`	`16`	`case TRACE_ID = 'trace_id';`
	`17`	`+ case PREVIOUS_MESSAGE = 'previous_message';`
	`18`	`+ case PREVIOUS_TYPE = 'previous_type';`
	`19`	`+ case PREVIOUS_CODE = 'previous_code';`
	`20`	`+ case PREVIOUS_LOCATION = 'previous_location';`
`17`	`21`	`}`