Vamos relembrar o que temos em nosso sistema de controle de séries antes de nos aprofundar em mais conceitos de Symfony.
No navegador, vamos fazer login no sistema com nosso usuário. Na tela inicial, temos a nossa lista de séries e podemos adicionar uma nova série ao clicar no botão "Adicionar" localizado logo abaixo do título "Listagem de séries".
Na página de adição de séries, podemos informar nome, quantidade de temporadas e episódios em suas respectivas caixas de texto, além de enviar arquivos para imagem de capa.
Desafio
Em treinamentos anteriores, deixamos o desafio de implementar um novo formulário de edição. Pois, ao adicionar uma série colocamos certas informações, mas ao editar podemos querer modificar informações diferentes - o que exigiria um novo formulário.
Porém, o instrutor Vinicius não implementou esse formulário de edição. Suponhamos que o sistema foi para a produção com esse erro.
Se queremos editar a série e clicamos no botão "E" no lado direito aos nomes de séries listados na página inicial, será exibida uma mensagem de erro sobre a ocorrência de uma exceção:
LogicException - HTTP 500 Internal Server Error
The form's view data is expected to be a "App\DTO\SeriesCreationInputDTO", but it is a "App\Entity\Series". You can avoid this error by setting the "data_class" option to null or by adding a view transformer that transforms "App\Entity\Series" to an instance of "App\DTO\SeriesCreationInputDTO".
Porém, essa mensagem detalhada só aparece quando estamos em um ambiente de desenvolvimento.
Se encerramos o servidor e o colocamos em um ambiente de produção, o erro será diferente. Vamos conferir.
Como já falamos sobre configuração e variáveis de ambiente, vamos rapidamente modicar o parâmetro APP_ENV que está igual à dev no arquivo .env. Em .env.local, vamos adicioná-lo como igual à prod:
.env.local:
No terminal local, vamos interromper o servidor e executá-lo novamente.
Em seguida, atualizamos a página no navegador e fazemos o login novamente. Queremos acessar a mesma URL que leva ao formulário de edição:
http://localhost:8080/series/edit/22
Agora, a mensagem de erro exibida é diferente e não dá detalhes de segurança. É uma página que um usuário poderia ver, informando um erro no servidor.
Oops! An Error Occurred
The server returned a "500 Internal Server Error".
Something is broken. Please let us know what you were doing when this error occurred. We will fix it as soon as possible. Sorry for any incovenience caused.
Mais adiante, também vamos falar mais sobre configurações que devem ser feitas ao colocar algo em produção.
Mas, por enquanto, saiba não vamos ter tantos detalhes quando um erro acontecer em um cenário onde nosso sistema já está em produção.
Nesse cenário, podemos proceder de algumas maneiras. Primeiramente, podemos analisar nossos logs, os quais vamos nos aprofundar mais adiante nesse curso.
Mas, também é possível ter uma ferramenta de monitoramento ou usar um software como o New Relic. Assim, sempre que acontecer uma exceção que não tratamos no sistema, podemos enviar a informação ou criar um evento no sistema de monitoramento.
Eventos
O que queremos fazer nessa aula é executar um determinado código sempre que acontecer uma exceção, erro ou problema não tratado no sistema. Essa execução pode ser feita no Symfony através de eventos.
Apesar de, geralmente, não se criar muitos eventos e ouvintes de eventos, é um assunto muito importante. O que acontece é que normalmente utilizamos códigos externos que fazem uso desse componente de eventos do Symfony.
Para entender melhor esse componente, vamos começar com a criação de um código que escuta esse evento de exceção (exception).
Antes de começar, vamos voltar ao ambiente de desenvolvimento. Para isso, interrompa seu servidor, remova APP_ENV=prod do arquivo .env.local e suba seu servidor novamente.
Com isso, voltamos a ver a mensagem de erro detalhada ao atualizar a página de formulário de edição.
Além de exibir o erro, também queremos mandar essa exceção para algum sistema de monitoramento ao executar um código.
Para isso, vamos criar um event listener (ouvinte de evento). Desse modo, um código é executado assim que um certo evento configurado ocorre.
Criando um event listener
Vamos observar o tópico "creating an event listener" na parte de eventos da documentação do Symfony.
No exemplo fornecido, adiciona-se um novo código em App\EventListener. Para seguir o padrão, vamos criar uma pasta de mesmo nome em nosso projeto.
Para isso, vamos clicar com o botão direito em "src > New > PHP Class". Vamos nomear essa classe como ExceptionEventListener e colocá-la no namespace App\EventListener.
src > Event Listener > ExceptionEventListener.php:
<?php
declare(strict_types=1);
namespace App\EventListener;
class ExceptionEventListener
{
}
Em seguida, assim como está na documentação, vamos criar um método onKernelException() que recebe um ExceptionEvent.
A palavra kernel vem do inglês e significa "núcleo". Com esse método, quando acontecer uma exceção que chegou ao núcleo do framework Symfony, ou seja, não foi tratada no código, esse evento será executado.
Em nossa classe, criamos essa public funciton chamada onKernelException() que espera um evento do tipo ExceptionEvent, o qual vem do namespace Symfony\Component\HttpKernel\Event\ExceptionEvent. Assim, ExceptionEvent é nosso $event.
Dentro das chaves da função onKernelException, poderíamos executar um código para enviar a exceção para New Relic, por exemplo.
Contudo, o intuito desse treinamento não é configurar New Relic. Por isso, vamos apenas deixar como um comentário.
Para que possamos entender que entramos nesse método, vamos executar um echo para exibir na tela a mensagem 'Exceção aconteceu'.
<?php
declare(strict_types=1);
namespace App\EventListener;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
class ExceptionEventListener
{
public function onKernelException(ExceptionEvent $event)
{
// enviar minha exceção para New Relic
echo 'Exceção aconteceu';
}
}
Configurando serviço
Após criar o event listener, precisamos informar ao Symfony para utilizar a classe ExceptionEventListener e o método onKernelException como event listener. Assim, quando acontecer determinado evento, chamará o código que criamos.
Para isso, vamos configurar nosso serviço também usando a documentação de exemplo.
Em nosso arquivo services.yaml, vamos definir nossa classe como serviço do Symfony.
Vamos em "config > services.yaml" e, ao final do arquivo, vamos criar App\EventListener\ExceptionEventListener.
Lembre-se de colocar dois-pontos após o nome da classe e, na próxima linha, adicionaremos algumas configurações.
Podemos definir tags para nossos eventos. Essas tags podem ser utilizadas para buscar serviços por código ou pelo próprio Symfony.
O Symfony vai buscar todos os serviços que possuem a tag name: kernel.event_listener e configurá-los como event listener.
Com isso, dizemos que a classe ExceptionEventListener é um event listener. Mas precisamos avisar também que a classa está preparada para executar um código quando um evento ocorrer.
No nosso caso, vamos especificar que o evento é o kernel.exception.
config > services.yaml:
services:
código omitido
App\EventListener\ExceptionEventListener:
tags:
- { name: kernel.event_listener, event: kernel.exception }</code></pre>
Durante esse vídeo, o instrutor usa a documentação na versão 6.1. Pode haver uma versão mais atual.
Mas como o Symfony que vai precisar chamar o método onKernelException do ExceptionEventListener.php?
Pois, criamos um método nomeado com a seguinte convenção: on que indica quando acontecer um evento, seguido do nome do evento utilizando CamelCase.
UpperCamelCase (também conhecida como PascalCase) é uma prática onde se coloca cada palavra de uma frase iniciando em letra maiúscula e sem espaços entre si - assim como exemplifica o nome do próprio termo.
Ao seguir esse padrão, o Symfony vai encontrar o método e executar o código que faria a instrumentação para o monitoramento da nossa exceção.
Dessa forma, configuramos o event listener e o serviço. Ressaltamos a importância de ler toda a documentação para entender melhor cada conceito.
Testando event listener
Novamente, vamos interromper o servidor e voltar a executá-lo pelo terminal.
Após atualizar a página do navegador e fazer o login, a mensagem de erro original continua a ser exibida.
Porém, também temos a frase estipulada no echo do método onKernelException.
Exceção aconteceu
Ou seja, nosso código foi executado quando o evento de exceção ocorreu.
Throwable e message
Para finalizar, vamos citar alguns detalhes do objeto do tipo event.
Cada evento ouvido vai trazer como parâmetro um evento diferente. No nosso caso, como kernel.exception estipulado em services.yaml é um evento de exceção, recebemos um ExceptionEvent como parâmetro de onKernelException na classe ExceptionEventListener.php.
Nesse $event, podemos usar getThrowable() para saber qual foi a exceção ou erro lançado. Poderíamos também exibir a mensagem com getMessage().
Assim, ao invés de exibir somente a mensagem "Exceção aconteceu" dentro das chaves de onKernelException, usaremos o echo para exibir a mensagem da exceção.
src > Event Listener > ExceptionEventListener.php:
//código omitido
class ExceptionEventListener
{
public function onKernelException(ExceptionEvent $event)
{
// enviar minha exceção para New Relic
echo $event->getThrowable()->getMessage()
}
}
Ao atualizar o navegador, recebemos agora a mensagem de erro completa na página do formulário. Mas, também vemos a mensagem de erro original, logo baixo.
The form's view data is expected to be a "App\DTO\SeriesCreationInputDTO", but it is a "App\Entity\Series". You can avoid this error by setting the "data_class" option to null or by adding a view transformer that transforms "App\Entity\Series" to an instance of "App\DTO\SeriesCreationInputDTO".
Repare que dessa maneira conseguimos acessar alguns detalhes do erro.
Response e request
Além disso, quase todos os eventos vão ter um objeto do tipo response (resposta) e outro do tipo request (requisição).
Alguns eventos terão apenas um, enquanto outros possuem ambos. O evento de exceção só possui requisição. Assim, conseguimos ter acesso ao objeto de requisição com getRequest() para saber o que foi enviado. Mas, não conseguimos ter acesso ao objeto de resposta com getResponse() para modificar a resposta.
No exemplo de criação de um event listener da documentação, o Symfony pega uma mensagem baseada na exceção com getMessage() e o código com getCode(). Também define como conteúdo da resposta a mensagem, editando o conteúdo com setContent().
Também vemos que se for uma exceção do tipo HTTP, pode-se definir o statusCode. Caso contrário, define-se como "500 Internal Server Error".
No final, depois de modificar a resposta, define-se a resposta no evento com setResponse().
Vamos fazer algo semelhante à documentação.
Dentro das chaves do método onKernelException na classe ExceptionEventListener.php, vamos ter a $response igual a uma nova resposta vazia, ou seja, new Response().
Atente-se que a Response será importada de Symfony\Component\HttpFoundation.
Também vamos substituir echo por $errorMessage, na linha anterior.
Em uma nova linha, digitamos $response e object operator (->) para definir como o conteúdo da resposta a $errorMessage, usando o setContent().
Poderíamos ter passado os parâmetros para newResponse(). Porém, vamos passar em uma nova linha com os setters. Isto é, escrevemos $response seguido de object operator (->)e definimos o StatusCode como 501 - só para definir um status diferente.
Enquanto no $event, podemos definir que a nova resposta é $response, utilizando setResponse($response). Assim, modificamos a resposta.
Então, o evento possui uma resposta padrão, mas, quando definimos uma nova resposta, sabe que é a resposta modificada que o Symfony deve enviar.
src > Event Listener > ExceptionEventListener.php:
//código omitido
class ExceptionEventListener
{
public function onKernelException(ExceptionEvent $event)
{
// enviar minha exceção para New Relic
$errorMessage = $event->getThrowable()->getMessage()
$response = new Response();
$response->setContent($errorMessage);
$response->setStatusCode(501);
$event->setResponse($response);
}
}
Ao atualizar a página do formulário de edição no navegador, conseguimos ter somente a mensagem de erro que definimos:
The form's view data is expected to be a "App\DTO\SeriesCreationInputDTO", but it is a "App\Entity\Series". You can avoid this error by setting the "data_class" option to null or by adding a view transformer that transforms "App\Entity\Series" to an instance of "App\DTO\SeriesCreationInputDTO".
Vamos apertar "F12" para exibir as ferramentas de desenvolvedor. Vamos na aba "Rede", no topo da caixa, e pressionamos "Ctrl + R" para fazer a atualização da rede. Ao atualizar, podemos ver o status 501 implementado.
Dessa forma, conseguimos analisar a requisição, modificar a resposta e fazer basicamente o que quisermos quando um evento acontecer.
Os event listeners são normalmente de fácil implementação. Porém, além desse formato de ouvir eventos, existe outro formato chamado event subscribers.
No próximo vídeo, vamos entender a diferença entre event listeners e event subscribers na teoria.