DEV Community: Marcus Brasizza

MUDAMOS!

Marcus Brasizza — Wed, 05 Mar 2025 14:05:46 +0000

por conta de baixa entrega do medium (dependendo do tanto de coisas que você acessa precisa pagar) , mudamos para um link próprio
Ja codou hoje?

Enviando logs de exception pelo event bus (Discord e Slack)

Marcus Brasizza — Sat, 09 Sep 2023 04:14:38 +0000

Fala galera!
Depois de algum tempo sumido resolvi fazer esse post, pois passei por um desafio interessante que eu queria compartilhar.

Irei demonstrar como você pode emitir mensagem detalhada de log para o seu canal do Discord e até mesmo para uma thread do slack ou ambos! , somente passando uma exception específica para o seu sistema sem precisar se preocupar com nada!

Pois bem!
Qual será o nosso desafio:
Vamos fazer um aplicativo que rode até mesmo no Flutter Web com alguns botões, onde irá realizar uma consulta em uma API com sucesso, um outro botão com algum problema de parse no nosso json e um outro com uma falha na url para simular uma falha da sua API.

O que iremos utilizar

Vamos utilizar somente os packages:

O carinha diferente da vez é o event_bus, que eu não vejo muita gente usando. Então vou tentar dar uma breve descrição do que ele faz:

event_bus é uma biblioteca que facilita a comunicação entre diferentes partes de um aplicativo, permitindo que componentes ou classes enviem e recebam eventos (mensagens) de forma assíncrona. Ele é bem útil quando você precisa que componentes separados do seu aplicativo comuniquem-se de forma eficiente, especialmente quando eles não têm uma relação direta, no nosso caso uma exception!

Além disso, vamos usar o device_info_plus para poder mandar junto com o erro os dados do equipamento para análise de um possível problema e o get_it somente para injetar as dependências mais facilmente no nosso projeto. Vamos usar também o image_network, para mostrar as imagens na web, por conta do CORS!

Criando nosso canal do Discord para receber a mensagem

Vamos criar nosso servidor no Discord, que por si só é realmente intuitivo, e após isso vamos criar um canal

depois de criado, vamos nas configurações do canal e vamos criar um bot

Vamos copiar essa url para usar mais tarde!

Criando o projeto esqueleto

flutter create --org="com.example.eventbus" --platforms=web,android -e --project-name=event_bus_exception eventBusException

feito isso vamos já adicionar os nossos packages de uso
flutter pub add dio event_bus get_it device_info_plus image_network

Criando o caminho perfeito

Vamos iniciar o projeto criando os botões e as chamadas para as apis , deixando estourar os possíveis erros na tela para fazermos a correção posteriormente

Vamos iniciar 'de cima para baixo', iniciando a criação das chamadas das apis que vão ser consumidas pela aplicação

Teremos aqui somente 2 métodos, um com os dados corretos, e outro com um erro de parse no json para a transformação de objeto, para recebermos um erro e tratar

Sua implementação é extremamente intuitiva, já que o nosso intuito é somente mostrar como executar a exception

Temos também nosso AlbumModel que está sem nenhum problema

e temos o AlbumModelError, onde eu coloquei propositamente o i do albumId minúsculo.

Feito isso, podemos construir nossa MainController com os métodos que serão chamados na página e vamos injetar nela o nosso repository ApiCallImpl

Iremos criar a exception que queremos que o event_bus dispare para o discord, então criaremos uma exception chamada CriticalException

Por enquanto essa exception não faz absolutamente nada, mas logo isso vai mudar!

Iremos utilizar o get_it para injetar o nosso repository e a nossa controller e depois injetar a repository dentro da nossa controller para podermos fazer a chamada diretamente pela controller

Se você rodar o projeto do jeito que está agora, vai ver que ao clicar nos dois últimos botões só irá aparecer um erro no console de erro, mas SE a aplicação estiver em produção, dificilmente você irá conseguir pegar esse erro em um tempo hábil de correção. E é aí que o event_bus chega para ajudar a gente.

Como descrito acima, ele pode nos ajudar desacoplado do nosso sistema principal e ficar escutando certos eventos e executar alguma ação com esse evento, e o nosso caso vai ser disparar o erro para o Discord!

Vamos criar uma classe chamada BroadcastController que será encarregada de escutar o disparo do evento do CriticalException

Nela iremos injetar tudo que é importante para seu funcionamento, como o eventBus , a nossa classe que irá pegar os dados do device, e pra onde vamos enviar o nosso broadCast, que pode ser um ou vários!

Criando a nossa classe de informação do dispositivo

Vamos criar uma classe somente para pegar o modelo do equipamento que está acessando a aplicação, e no caso da web o user-agent:

Criando nosso primeiro channel

Vamos chamar de channel o remetente que vamos enviar nossa exception, e vamos inicialmente criar uma classe abstrata com um método chamado execute que será encarregado de enviar os dados para o channel escolhido e também um método de configure, para alguma configuração prévia no channel, como por exemplo no caso do slack, configurar para qual canal a mensagem será enviada.

Channel: DiscordBroadcastImpl

Nosso broadcast para o Discord, iremos injetar nele o Dio , para que possamos fazer o post na url que nós pegamos lá no começo do artigo. Nele não precisaremos fazer nenhuma configuração extra, pois o webhook já se encarrega de enviar para o lugar certo

Agora vamos alterar o nosso main.dart para colocar o resto das injeções das dependencias no projeto

Se você rodou o projeto até aqui vai quer que .. não aconteceu absolutamente NADA, não foi pro discord e você já deve estar achando que eu estou enganando vc!

Faltou fazermos o principal, precisamos disparar o evento propriamente dito dentro da nossa exception

então vamos colocar o comando do nosso broadcast para fazer o acionamento do nosso listen lá no BroadCastController

e quando clicamos lá no botão de erro do parse do json para o objeto .. BANG!

e quanto clicamos no botão de falha do servidor

Criando o envio pro slack!

Como fomos pessoas precavidas e criamos uma classe abstrata para o nosso broadcast a BroadcastBase, a assim será extremamente rápida a criação de mais uma classe, mas dessa vez enviando para o slack!

Precisamos criar o canal do slack, e para isso precisamos criar e ir na área de webhooks e ativar a integração por lá

Após a configuração o sistema irá te dar uma url para acessar o serviço de webhook do slack.

Vamos criar a nossa SlackBroadCastImpl implementando a BroadcastBase que nos obriga a implementar a execute e a configure
No caso do slack precisamos de uma configuração inicial, como por exemplo indicar o canal que vai ser emitida a mensagem e assim como a do Discord, também injetaremos o Dio para poder fazer a requisição na url indicada

Como alterar a emissão entre o slack e o Discord?

Precisaremos fazer algumas modificações nas nossas injeções do main.dart. O principal é que como vamos injetar duas BroadcastBase precisaremos nomear nossas instâncias para que o get_it consiga recuperá-las.
Após isso no nosso BroadcastController que já espera uma lista, ou a gente inclui o slack junto ou escolhe entre eles, no nosso caso vou colocar os dois juntos para a mensagem chegar nos dois ao mesmo tempo, ficando assim:

Assim que a exception CriticalException for acionada no sistema, será enviado tanto para o Discord quanto para o slack

Possibilidades (Ideias)

A exception pode chamar uma api sua que vai pro seu whatsapp
A exception pode emitir para o crashlytics
A exception pode emitir para o sentry
A exception pode gravar em um banco interno do seu aplicativo

e assim por diante.

Espero que tenham gostado e segue o git abaixo!

brasizza / flutter-eventbus-exception

Artigo sobre eventBus - Flutter

O que é o EventBus?

O EventBus é uma biblioteca que facilita a comunicação assíncrona entre diferentes partes de um aplicativo Flutter. Ele permite que componentes ou classes troquem mensagens (eventos) de forma eficiente, sem a necessidade de depender de herança ou referências diretas. Isso torna o código mais flexível e desacoplado, facilitando a manutenção e o desenvolvimento de aplicativos escaláveis.

Com isso, surgiu a ideia de usar o EventBus para emitir logs para servidores externos por meio de uma exception específica!

Caso você tenha vindo diretamente do GIT, segue abaixo o link do artivo

https://dev.to/brasizza/enviando-logs-de-exception-pelo-event-bus-discord-e-slack-23h4

View on GitHub

Criação de uma API em Shelf

Marcus Brasizza — Sun, 26 Feb 2023 06:15:49 +0000

Fala pessoal!

Vamos ao primeiro artigo da série que se tudo der certo sai 100%

Já aviso que o artigo é grande mas é necessário para que seja colocado exatamente o passo a passo de como fazer!

O json para testar no postman se encontra aqui:

POSTMAN

Vamos iniciar explicando como será nossa api:
Iremos conectar em um banco mysql onde terá nosso banco de dados chamado de delivery e nele terá uma tabela chamada orders, e nela estarão todos nossos pedidos por provider (ifood/rappi) e os status (Iniciado, Em andamento, Finalizado, Em Rota e Completo) onde

Iniciado: O servidor recebeu o pedido naquele momento
Em andamento: Alguém iniciou a produção desse pedido
Finalizado: A produção do pedido foi finalizado
Em rota: O pedido saiu do restaurante e está indo para o cliente
Finalizado: Pedido foi entregue

Teremos as rotas de pegar Todos os pedidos, pegar um pedido por ID, Inserir, Alterar e excluir o pedido por ID

Nossa tabela do mysql

INICIANDO O SHELF

O Dart nos traz uma facilidade absurda na criação dos nossos projetos, que são os templates. Com eles você pode já criar seu projeto de um jeito fácil e já é incluído algumas coisas automaticamente nele.

Vamos criar nosso projeto com o template do shelf mesmo assim

dart create -t server-shel api
Com isso ele já vai jogar nas depenências o shelf e o shelf_router e um arquivo teste rest no seu bin/server.dart

podemos executar ele clicando ou no debug ou no run do server.dart e abrir o link http://0.0.0.0:8080/, você vai ver que ele vai aparecer um 'Hello World!' , sinal de que está tudo funcionando

DEPENDENCIAS

Tentarei usar o mínimo de dependências possíveis no server, então iremos usar o get_it para gerenciar nossas dependências, um package de mysql que eu optei nesse projeto usar o mysql_client, pois está atualizado há pouco tempo e diz no package o suporte pro mysql8 e mariadb 10 e sabemos que o mysql1 está meio chatinho de usar então dei uma chance pra ele! e pra finalizar o dotenv, que iremos utilizar para pegar alguns dados para iniciar nosso servidor shelf, como porta e dados do mysql, mesmo sabendo que não é o local mais seguro do mundo, como estará no server-side não vejo muito problema inicialmente.
Para adicionar rapidamente no seu projeto todos esses packages faremos de uma vez só

dart pub add get_it mysql_client dotenv

ARQUIVOS UTEIS

Iremos criar um concentrador de logs que chamaremos de
developer e iremos colocar em lib/src/core/developer
iremos criar o developer.dart

Estou também fazendo uns testes de abstração de banco de dados, portanto é meramente experimental, onde teoricamente eu poderia usar qualquer banco de dados (que podemos testar depois, por exemplo o hive), existem alguns métodos nele que eu ainda não implementei, pois como foi construído para o hive, consegui adaptar muito bem para o mysql

Vamos criar uma pasta em lib/src/core/database e colocaremos nosso database.dart e o nosso mysql_database.dart

ESTRUTURA DO PROJETO

Iremos utilizar uma estrutura de

Controller
- Service
- Repository

Nesse projeto escolhi utilizar o service layer para que possamos ter mais liberdade para o repository, por exemplo quando atualizamos um pedido ou inserimos, a responsabilidade do repository é só inserir ou alterar, deixamos o service responsável por retornar o objeto novo ou alterado, assim dividimos as responsabilidades e deixamos o nosso repository somente para fazer a conexão entre o nosso banco e nada mais!

Para ficar mais fácil , fora da pasta bin, iremos criar uma pasta lib, e dentro dela a src onde iremos colocar nosso código isolado dos demais

MODEL ORDER e ORDER STATUS

Primeiramente precisamos criar nosso model, e olhando a nossa tabela temos os campos que serão representados da nossa tabela.Podemos notar que os campos estão em snake_case e por padrão o flutter 'sugere' que as propriedades sejam em camelCase, então teremos que fazer algumas traduções de campos além de para ficar mais fácil iremos criar um enum para o nosso campo de status

O enum do status que iremos criar na pasta lib/src/enum/order_status.dart

O nosso model do Order, criei com a extensão do Dart class generator , ele ajuda demais a construir rapidamente um model

Model que iremos criar na pasta lib/src/data/model/order.dart

Pontos importantes da nossa model que foram customizados, como por exemplo o orderId que no nosso banco é order_id , e os outros, que tiveram que ser traduzidos no fromMap exatamente como está na tabela

Outro ponto importante foi a criação do toDatabase e do updateMap, que no decorrer vou explicar o motivo da criação

Módulo order

Para separar nosso projeto , iremos criar uma pasta order em
lib/src/modules/order e criaremos 2 arquivos
o order_controller.dart e order_route.dart

A order_controller será nosso controlador de todas as ações que o nosso endpoint precisará fazer, e o order_route será onde iremos especificar a nossas rotas e o que efetivamente faremos nelas

Na nossa controller teremos o:

getAll , pra pegar todos os pedidos
getById, para pegar um pedido específico
save, para inserir o pedido no banco de dados
update, para atualizar um pedido específico
delete, para deletar um pedido específico

Ta, mas como faremos isso?
Como eu havia mencionado, iremos utilizar 2 camadas acima da controller: a service e a repository.

Iremos inicialmente criar a abstração da service e depois implementar. Vamos chamar de order_service e vamos colocar ela dentro da pasta lib/src/service/order_service.dart

onde:

getAll pode ou não retornar uma lista de Order,
getById, pode ou não retornar um Order passando um id,
delete, deleta da sua base de dados com base em um id e te retorna o Order deletado
save, salva os dados enviados para o endpoint , retornando o Order salvo
update , atualiza um Order com base em um id, atualizando os campos que foram preenchidos para atualização

Se olharmos no service, iremos ver que temos algumas particularidades para deixar nosso código mais limpo, como por exemplo as checagens para deletar ou atualizar um registro, além de por exemplo ele retornar um objeto Order para sua service seja com ele atualizado no caso do update ou o que foi inserido naquele momento, e no caso do delete em particular, ele te manda o registro que foi excluído!

Além disso iremos utilizar o método updateMap que, como pegamos o objeto antes de fazer o update, nós atualizamos o mesmo objeto com os dados vindos requisição, assim nós garantimos que só irão ser alterados os campos que forem enviados pela requisião de UPDATE, além de atualizar o campo de data de atualização e ai sim enviamos para o banco de dados para atualização

Também iremos criar um repository chamado order_repository na pasta
lib/src/data/repository/order_repository.dart

A grande diferença entre o repository e o service estão nos métodos de inserir, deletar e atualizar, onde o repository só precisa entregar pro service, se deu certo ou não, e só no caso do inserir que ele precisa retornar o id inserido para que o service possa tomar as providencias necessárias.

A implementação do repository para explicação

No repository fazemos a conexão com o banco de dados que por fim faz todas as ações necessárias, além de no salvar, nós utilizamos o método toDatabase que criamos que basicamente é para normalizar os nomes dos campos com os nomes das tabelas do banco de dados, assim facilita nosso trabalho de ter que normalizar (ou seja, colocar os mesmos nomes da tabela)

Com tudo isso criado, podemos finalmente criar nossa controller.

A controller também terá os seguintes métodos iniciais

getAll
getById
save
update
delete

A diferença dela para as camadas acima é que ela vai ser nossa ligação entre o shelf e o service que por sua vez se comunica com o repository

Como você deve ter notado, normalmente fazemos a inversão dependência e injetamos por exemplo o repository na service e o database no repository e por sua vez injetamos o service na controller, assim podemos fazer um código o mínimo de agregação fixa e se caso for preciso mudar a instância, mudamos somente na injeção na classe.

Uma coisa importante no nosso controller é que como estamos trabalhando com o shelf, o retorno de todos os métodos devem ser um Response, para que o shelf possa responder corretamente com 200, ou 400 ou 500 para o nosso cliente na ponta onde está acessando o endpoint específico que iremos criar logo em seguida.

O controller que tem o service injetado será nossa ponta para ligar diretamente no shelf, podemos ver que na maioria dos casos, faz uma logica simples e chama o service que faz toda a lógica juntamente com o controller retornando somente o objeto ou um nulo indicando erro, sempre respeitando o máximo possível das respostas http:

2xx para OK
4xx para dados com problemas (mas processou)
5xx erro crítico no nosso servidor ou banco de dados

Eu particularmente gosto de nomear minhas instâncias em constantes para ficar mais fácil a recuperação, então como sabemos que teremos que injetar o mysql, o nosso service do order e o repository, já vamos criar a nossa classe que ficará com os nomes das constantes.

Eu coloco nomes grandes, porque como esta na propriedade não tem problema nenhum porque vai pegar de Consts.mysqlInstance por exemplo

Até agora não colocamos um dedo no código do shelf propriamente dito e provavelmente se criou um template do shelf igual descrito acima o seu server.dart vai estar parecido com algo assim

isso quer dizer que , se for executado esse shelf do jeito que está e entrar no seu ip:8080 ele vai mostrar na tela um Hello world

A primeira coisa que vamos fazer ai é criar um arquivo .env na raiz do seu projeto para que possamos colocar os dados do seu banco de dados

Vamos usar o dotenv para carregar esse arquivo e também vamos usar o GetIt para guardar essa instância para um futuro uso. Além disso vamos no server.dart mesmo fazer a conexão como o mysql e também guardar essa instância.

void main(List<String> args) async {

final Env env = Env.i..load();
  GetIt.I.registerSingleton(env);

  final MysqlDatabase mysql = await MysqlDatabase.i.openDatabase(
    {
      'host': env['host'] ?? '',
      'port': env['port'] ?? '',
      'userName': env['userName'] ?? '',
      'password': env['password'] ?? '',
      'databaseName': env['databaseName'] ?? '',
      'secure': env['secure'] ?? '',
    },
  );
  GetIt.I.registerSingleton<Database>(mysql, instanceName: Consts.mysqlInstance);
....
}

Com isso teremos nossa conexão com o mysql sempre disponível no getIt.

Criando as rotas no shelf

Criamos um order_route.dart que ainda está vazio e vamos criar nossas rotas nesse arquivo para deixar bem separado.

Como já criamos nosso controller, o nosso service E a nossa repository iremos iniciar a instância deles somente neste ponto , para que a responsabilidade da criação das instâncias seja somente onde ela é chamada de fato!
Iremos criar um método estático chamado routes onde iremos criar nossas chamadas de rotas como descritas abaixo

podemos ver que foram criados 5 rotas bases

a /orders que é o nosso getAll
a /order/id que é a nossa rota de pegar um order por id
o /order que vai salvar o nosso objeto de order
o /order/id que vai atualizar a nossa order com base em um id
a /order/id que vai deletar o nosso registro com base na ID

Tudo isso mandando os verbos certos, get onde é requisição de informação, post e put e delete quando é envio de informação para o servidor

Feito isso iremos agora colocar essa rota no nosso server.dart
Colocaremos a porta do shelf padrão como vindo do .env, e se não encontrar ele assume a porta 8080

Iremos fazer de um jeito inicialmente que só será possível incluir as rotas do order, mas caso nós formos progredindo podemos alterar para contemplar mais rotas

e com isso terminamos nossa primeira parte do servidor shelf. Sei que é muita informação e muito texto, mas se você se perdeu em algum lugar, você inicialmente pode tentar me chamar no discord pois me ajuda demais a entender onde está o problema e ajudar a corrigir!

Ou olhar no repositório GIT

Espero que tenham gostado e iremos fazer nosso primeiro app utilizando esse backend no próximo artigo!

Criando uma api em shelf com socket + app com provider e bloc

Marcus Brasizza — Thu, 23 Feb 2023 04:48:02 +0000

Fala pessoal!
Resolvi trocar o medium pelo dev.to, simplesmente pelo fato dele ser free e não impedir a galera de ver somente alguns posts por mês!

Vamos para o post em Sí!
Farei uma série de alguns artigos que irão consistir em:

Faremos uma api simulando um sistema de delivery (rappi/ifood)
onde o endpoint vai salvar o pedido, recuperar um pedido por id, todos e deletar o pedido por id e finalmente alterar o pedido (teoricamente o status)

Criação de uma API simples Restfull (GET/POST/DELETE/PUT) , vou usar o PUT para editar também pra ficar mais fácil e testaremos tudo via POSTMAN
Criação de um aplicativo simples para consumir essa api (Tentarei fazer um drag/drop) todo estilizado com provider e cubit (Se Deus quiser!)
Modificação dessa API para integrar um servidor socket embutido emitindo cada um dos métodos pertinentes (POST/DELETE)
Modificação do nosso APP para escutar o socket e fazer as alterações em tempo real.

Então fiquem ligados aqui que logo mais teremos a saga completa separada de como criar tudo passo a passo!

E colocarei os links em ordem aqui também abaixo a medida que for desenvolvendo!

Parte 1