Forem: Jilcimar Fernandes

Performance no REDIS com Pipelining

Jilcimar Fernandes — Tue, 23 May 2023 20:33:46 +0000

O que é o Redis Pipelining?

É uma técnica para melhorar o desempenho que permite enviar vários comandos de uma só vez sem esperar pela resposta de cada comando individual.

Fonte: https://redis.io/docs/manual/pipelining/

Através dessa imagem é possível ver a diferença que o pipelining faz na execução:

Fonte: https://kn100.me/redis-pipelining/

Quando ele é útil?

O Pipeline é muito útil em situações em que há muitas operações de leitura/escrita no Redis. Ao usar um pipeline, é possível reduzir significativamente o custo de latência associado ao tempo de ida e volta, além disso, ele melhora muito o número de operações que você pode executar por segundo.

Outro uso interessante para o Pipeline, é para implementar transações atômicas, garantindo que um conjunto de operações seja executado como uma única unidade. Isso é possível porque o Redis Pipeline permite que os comandos sejam agrupados em uma transação que só será executada quando todos os comandos no pipeline forem enviados e retornarem com sucesso.

Caso de uso

No trabalho, passei por uma situação a qual precisava melhorar a performance de uma Lambda (Python) que consumia de uma fila SQS e em seguida realizava várias operações de leitura e escrita no REDIS.

PROBLEMA
Devido a quantidade de operações realizadas a cada mensagem recebida, algumas acabavam não sendo processadas devido o timeout de 30 segundos configurado na lambda.

Gráfico de duração da execução (em milissegundos) da lambda antes de aplicar as técnicas de performance, chegando a picos de 27 segundos de duração:

A fila a qual a lambda consumia as mensagens, recebia cargas com até 2.500 mensagens para processar:

RESULTADOS APÓS PERFORMANCE

Após aplicar o Redis pipelining, alguns dos resultados que obtivemos na Lambda:

O maior pico de duração foi de 12,6 segundos.

Conclusão

O resultado foi bem positivo, tendo em vista que na maioria dos casos chegaram a reduzir pela metade o tempo de duração, além disto, em cenários de processamento com o mesmo número de mensagem não tivemos mais nenhum caso de timeout.

Após o uso do Redis Pipelining, também foram feitas algumas refatorações e mudanças na forma de processar a mensagem para melhorar ainda mais o tempo de execução da lambda.

Calcular Frete dos Correios usando PHP 8.1

Jilcimar Fernandes — Fri, 20 May 2022 13:01:42 +0000

Este é um exemplo de classe em PHP para que você consiga simular os valores de frete. Após precisar realizar o cálculo de frete em um Checkout de Pagamento, vi que na internet os códigos que tinham para utilizar o serviço dos Correios eram antigos e a maioria não funcionava bem.

<?php

//namespace ......;

class FreightCalculate
{
    public function __construct(
        private string $code, //41106 - PAC , 40010 - SEDEX
        private string $originZipCode,
        private string $destinationZipCode,
        private int $weight,
        private int $length,
        private int $height,
        private int $width, //Min 10
        private array $response = [],
    ) {
        $url = 'http://ws.correios.com.br/calculador/CalcPrecoPrazo.aspx';

        if ($length < 16) {
            $this->length = 16;
        }

         $params = [
            'nCdEmpresa' => '',
            'sDsSenha' => '',
            'sCepOrigem' => $this->originZipCode,
            'sCepDestino' => $this->destinationZipCode,
            'nVlPeso' => $this->weight, //kg
            'nCdFormato' => '1',  //1 para caixa / pacote e 2 para rolo/prisma.
            'nVlComprimento' => $this->length,
            'nVlAltura' => $this->height,
            'nVlLargura' => $this->width,
            'nVlDiametro' => '0',
            'sCdMaoPropria' => 'n',
            'nVlValorDeclarado' => '0',
            'sCdAvisoRecebimento' => 'n',
            'StrRetorno' => 'xml',
            'nCdServico' =>  $this->code,
        ];

        $params = http_build_query($params);

        $curl = curl_init($url . '?' . $params);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        $data = curl_exec($curl);
        $data = simplexml_load_string($data);

        foreach ($data->cServico as $service) {
            if ($service->Erro == 0) {
                $this->response['code'] = $service->Codigo ;
                $this->response['value'] = $service->Valor;
                $this->response['deadline'] = $service->PrazoEntrega ;
            }
        }
    }

    public function getValue(): float
    {
        return float $this->response['value'];
    }

    public function getDeadline(): int
    {
        return (int) $this->response['deadline'];
    }

    public function getCode(): int
    {
        return (int) $this->response['deadline'];
    }
}

Esta é a classe que você pode imnportar no seu projeto.

Como usar?

Para usar basta instanciar a classe e chamar os métodos de acordo com a sua necessidade.

$frete = new FreightCalculate('41106','59945000', '59158400', 1, 5, 5, 10);

...

 $frete->getValue();

...

$frete->getDeadline();

[TIP] - Laravel API Response Helpers

Jilcimar Fernandes — Tue, 05 Oct 2021 15:17:44 +0000

Este artigo é uma dica para quem já trabalhou com API REST no Laravel ou irá precisar trabalhar. O objetivo desse pacote é garantir respostas consistentes e padronizadas em toda sua aplicação Laravel.

Quem já trabalhou em projetos legados ou até mesmo novos se forem mal escritos, provavelmente já se deparou com uma infinidade de métodos usados para retornar um erro ou mensagem de sucesso. Além disso, não é difícil de encontrar problemas de retornar o status code errado, como por exemplo uma mensagem de erro que retorna 200, como mostra na imagem abaixo:

Sobre o pacote

O pacote você pode encontrar a sua documentação nesse repositório https://github.com/f9webltd/laravel-api-response-helpers , a proposta é de fato ser simples e garantir respostas consistentes da API no seu projeto Laravel. Para utilizar é preciso ter as seguintes especificações:

PHP ^7.4 | ^8.0
Laravel 6, 7 and 8

Instalação

composer require f9webltd/laravel-api-response-helpers

Exemplo de uso

<?php

namespace App\Http\Api\Controllers;

use F9Web\ApiResponseHelpers;
use Illuminate\Http\JsonResponse;

class OrdersController
{
    use ApiResponseHelpers;

    public function index(): JsonResponse
    {
        return $this->respondWithSuccess();
    }
}

Alguns métodos disponíveis

`respondNotFound(string|Exception $message, ?string $key = 'error')`

Retorna o código de status HTTP 404, e opcionalmente pode receber um exceção personalizada.

`respondWithSuccess(array|Arrayable|JsonSerializable|null $contents = [])`

Retorna o código de status HTTP 200

`respondUnAuthenticated(?string $message = null)`

Retorna o código de status HTTP 401

`respondForbidden(?string $message = null)`

Retorna o código de status HTTP 403

`respondError(?string $message = null)`

Retorna o código de status HTTP 400

`respondCreated(array|Arrayable|JsonSerializable|null $data = [])`

Retorna o código de status HTTP 201, e como opcional você pode passar um data que é devolvido na resposta.

Esse são alguns métodos mas você pode conferir mais explorando a documentação oficial do pacote.

E ai, curtiram a dica?

Fonte

O que é View Composer?

Jilcimar Fernandes — Tue, 03 Aug 2021 14:33:22 +0000

View Composer é uma solução elegante para um problema muito específico! Todo desenvolvedor provavelmente já se deparou com uma Exceção de variável indefinida ao chamar uma view. Isso é simples de resolver, foi você que esqueceu de buscar essa informação no seu controller para enviar.

Usando o View Composer, não há mais essa necessidade de ficar se preocupando com os dados do seu arquivo de visualização, pois esse recurso irá garantir que todas as informações estarão lá sempre que a sua view seja renderizada.

View Composer na Prática

Primeiro começo organizando o diretório de onde ficarão os arquivos que é em app/Http/View/Composers é o que recomenda a documentação do Laravel mas você pode ficar a vontade para modificar.

Classe de View Composer

Dentro dessa classe você pode usar quaquer dependência que precise. Nesse exemplo estou dizendo para o framework que a variável users irá receber o valor dessa consulta User::with('role')->withTrashed()->paginate(10) . Todas as definições de variáveis ficarão nessa função compose.

Criando um Service Provider

Para registrar os seus View Composers, iremos precisar criar um Service Providers

Esse é um exemplo do meu ViewServiceProvider. Observe que no método registereu especifico o diretório de onde os meus arquivos de visualização estão localizados. Não esqueça de registrar o seu Service Provider no array de 'providers' em config/app.php.

Veja que no registerComposers é onde defino exatamente os arquivos que aquele View Composer que acabamos de criar irá aparecer.

View::composer([
            'users.index',
            'users.create',
            'users.edit',
        ], UserViewComposer::class);

Nesse trecho estou informando que toda as variáveis definidas no UserViewComposer irão aparecer sempre que forem renderizadas as views de index,create e edit do usuário.

Vantagens

O primeiro ponto que destaco é organização, pois todas as variáveis e dados serão tratados em um arquivo específico do seu projeto.
Outro benefício é a "limpeza" que você irá causar nos seus controllers, pois não há necessidade de ficar passando dados por ele
Gatantia que sempre uma view for renderizada, todos os dados que ela precisa estarão disponíveis

Conclusão

É isso galera, espero que tenham gostado desse recurso que ajuda muito a organizar o seu projeto e também melhorar a manutenção do código. Gostou? deixa um comentário ai 😃 .

GIT-FLOW: UMA ESTRATÉGIA PARA ADAPTAR DE ACORDO COM O PROCESSO DO SEU TIME

Jilcimar Fernandes — Wed, 16 Jun 2021 18:22:40 +0000

💡 O que é o Git-Flow?

Ao trabalhar em equipe, é necessário definir convenções ou boas práticas para que todos saibam trabalhar juntos. O Git-Flow é um dos muitos chamados workflows, bastante popular por sua praticidade e aprendizado relativamente rápido. É uma forma de organizar as branches do seu repositório. Só pegar o Git-Flow e aplica-lo talvez não atenda a necessidade da sua equipe, principalmente pensando na maioria das empresas que possuem setores de Quality Assurance (QA) e esse workflow não leva em consideração.

OBS.: Não irei me atentar em ficar citando os comandos do Git-Flow, o foco neste artigo é outro e você pode consultar esses comandos acessando a Documentação.

⭐ Motivação

Usando essa estratégia, o objetivo é:

Redução de conflitos, pois o git flow irá ficar responsável por criar e fechar a branch de desenvolvimento no local correto (de forma automática)
Padronização do nome de branchs, já que o git flow coloca prefixos automáticos como “feature/nome-da-branch” ou “hotfix/nome-da-branch”
Segurança no processo de desenvolvimento
- Só sobe o que está OK pelo QA
- Possibilidade de voltar a produção com base na versão desejada
Versionamento do sistema através das tags
Todos os desenvolvedores alinhados com o processo

Organização

Se você pesquisou por "Git Flow" certamente deve ter se deparado com uma imagem parecida com essa:

Essa é a base do Git-Flow e já atende quase todo o fluxo de desenvolvimento, a única adaptação que iremos fazer é inserir o processo de Code Review e o QA que não são contemplados nesse flow.

Adaptação

Então, como já foi dito irei propor um modelo que engloba o Code Review e também os ambientes de teste (QA). A modificação no fluxo fica assim:

Veja que entrou uma nova camada entre as feature e develop. O que significa que antes de ser dado um "finish" na feature, a branch deve passar pelo processo de Code Review e em seguida ir para o QA validar. Se tudo ocorrer bem a ramificação é integrada na develop ao executar:

$ git flow feature finish nome_da_branch

Develop

Outro ponto que podemos observar é que a develop além de ser um "espelho" da "master" em alguns momentos, ela sempre irá conter as features finalizadas (foram testadas pelo QA e validadas).

Segurança

Essas camadas do Git-Flow adicionam mais segurança na subida das novas funcionalidades do seu software, já que para um desenvolvimento chegar em produção (branch master) ele precisa passar pela camada de teste (QA) e em seguida develop. A partir desse ponto é que o desenvolvimento pode ser disponibilizado caso seja criada uma release.

Como aplicar a metodologia a minha equipe ?

O processo pode ser que não se adeque totalmente a realidade do seu time, porém, pode adapta-lo para que chegue em um modelo que atende a necessidade do projeto.

Como dica eu sugiro começar por um repositório e em seguida ir aplicando nos demais (se na sua equipe trabalha em mais de um projeto).

OBS: Processo bom é aquele que resolve o problema do seu trabalho, se a sua equipe já funciona bem com uma metodologia diferente eu não vejo motivos para mudar.

É isso galera, espero ter ajudado vocês falando em uma perspectiva diferente sobre o Git-Flow, pois a maioria dos artigos que vejo são focados no uso da ferramenta (como executar os comandos) e não se atentando a estrutura e organização.

[Tips & Tricks] Laravel Clean Code

Jilcimar Fernandes — Mon, 24 May 2021 22:52:33 +0000

E ai galera, neste artigo como o próprio título já fala, pretendo reunir algumas dicas para construirmos códigos mais limpos no Laravel. Todo bom desenvolvedor sabe o quanto é essencial termos um código "enxuto" e limpo, além de facilitar o entendimento ajuda os próximos devs que venham a pegar o seu código para manutenção.

Nem todos os passos aqui contidos devem ser estritamente seguidos e menos ainda se tornarão regras absolutas. Estas são dicas e nada mais, mas são coisas que aprendi ao longo da minha experiência trabalhando em equipe e a partir do que leio pelos autores de "Código Limpo".

1- Uso de Traits

As Traits servem simplesmente para reuso de código, que pode nos auxiliar nos casos em que fatalmente precisamos cair no comportamento de “copiar e colar” determinados trechos de códigos em diferentes classes. Dessa forma, a primeira dica é criarmos traits para nossos relacionamentos, assim podemos aproveitar eles em diferentes Models.

Eu gosto de criar elas em Models/Relations:

Este é um exemplo de uma trait para o relacionamento BelongsToUser:

No exemplo, os models de Address e Point possuem o mesmo relacionamento com o model de User, é feito apenas a chamada da trait BelongsToUser no início da classe sem precisar ficar reescrevendo o código do relacionamento:

2 - View Composer

Um recurso muito bacana do framework que gosto de utilizar é o uso de View Composer, nele simplesmente centralizamos as variáveis de cada view quando ela é renderizada sem precisar ficar passando os parâmetros pelo controller. Então, independente do lugar que chame aquela view, você não precisa ficar se preocupando com as variáveis que ela precisa receber. Veja o exemplo do meu UserViewComposer

Eu tenho um ServiceProvider chamado ViewServiceProvider que é onde define em quais views aquelas variáveis (roles e users) devem aparecer quando forem renderizadas.

Veja que sempre que forem chamada as views: 'pages.users.index', 'pages.users.create' e 'pages.users.edit' essas variáveis definidas no UserViewComposer estarão disponíveis, assim não precisamos nos preocupar em ficar passando elas pelo o controller! Sem falar que ocorre das vezes acabamos esquecendo de alguma 😅

3 - Separe a regra de negócio

Crie métodos no seu model para isolar a lógica de negócio. Seus controladores devem ser simples. Eles precisam dizer coisas como "criar fatura do pedido". Eles não devem se preocupar com os detalhes de como seu banco de dados está estruturado. Deixe isso para o modelo.

❌	✅

4 - Form's Request's

Ao invés de usar o validate dentro do seu controler, escolha os Requests, porque além de isolar toda a lógica de validação do seu backend, ainda deixa o controller mais limpo. Veja um exemplo da validação com e sem o uso de Form Request.

Sem Form Request ❌

Com Form Request ✅

Bem mais limpo né? Além disso, você pode até re-aproveitar a chamada das regras de validação e também fazer um esquema de "permissão" no authorize. Se curtiu essa dica, você pode da uma olhada na documentação oficial de como utilizar o Form Request

5 - Uso de Helper Functions

Se existem trechos de códigos que estão repetidos, outro recurso que você pode utilizar são os helpers.É muito comum usarmos para formatação e conversão de texto, por exemplo.

A função "money" agora pode ser chamada em qualquer parte do projeto.

E aí, você já sabia de todas? Essas foram só algumas sugestões que se aplicarmos no nosso dia a dia podem fazer muita diferença! Espero que tenham gostado, deixem mais dicas nos comentários 😃

Criando um servidor de homologação para aplicações Laravel usando o Heroku

Jilcimar Fernandes — Mon, 01 Jun 2020 22:03:16 +0000

Muita das vezes precisamos testar nossas aplicações em um servidor antes de lançarmos em produção, mas nem todos tem familiaridade com deploy ou possuem um servidor de homologação (testes). Dessa forma, o Heroku pode se tornar uma alternativa, pois é fácil de usar (abstrai muita coisa) e o melhor de tudo, é free! 🎉

Este artigo é para mostrar o passo a passo de como podemos publicar nossos projetos em Laravel utilizando o Heroku e criar um servidor de homologação simples com deploy automatizado usando o Github. Se você não conhece o Heroku, pode saber mais sobre ele clicando aqui.

Instalando o Heroku

Para esse tutorial vou partir da premissa que você já está com o seu projeto no GitHub e com uma conta criada no Heroku (só acessar https://www.heroku.com)

Depois da conta criada, você pode instalar o Heroku CLI acessando https://devcenter.heroku.com/articles/heroku-cli .
No meu caso que uso Linux, instalei via npm rodando o seguinte comando:

npm install -g heroku

Se foi instalado com sucesso você irar conseguir ver a versão rodando o comando:

heroku -v

Configurando o Heroku

Dentro da raiz da sua aplicação Laravel, vamos criar um arquivo chamado "Procfile" (conforme a figura abaixo), nele vamos informar o "perfil" do nosso servidor, que no meu caso vai ser o apache2 (Mas você pode usar o nginx por exemplo).

No arquivo vamos escrever a seguinte linha:

web: vendor/bin/heroku-php-apache2 public/

Criando um novo app no Heroku

Agora vamos criar um app no Heroku rodando o seguinte comando:

heroku create

Você deve ter um resultado parecido com a imagem acima.

Se você acessar https://dashboard.heroku.com/apps irá ver que a aplicação que acabamos de criar está listada. 🙌

Subindo o projeto para o servidor

Antes vamos configurar um script para quando subirmos a nossa aplicação ele dar a permissão na pasta public/ , em seu composer.json na sessão de scripts adicione o seguinte trecho:

"post-install-cmd": [ "php artisan clear-compiled", "chmod -R 775 public/" ]

Se você rodar o comando

git remote -v

irá ver que foi criado um novo remote além do origin com o nome heroku, é ele que iremos utilizar para dar push em nosso código para disponibilizar no servidor com:

git push heroku master

Pela aba "Overview" em seu dashboard do Heroku, irá ver que sua aplicação já está disponível:

Configurando as variáveis do .env

Para configurar as variáveis do nosso .env, é só acessar a aba "Settings" e ir até "Config Vars". Adicione a KEY e o valor correspondente conforme a imagem:

Criando o banco de dados

Pelo dashboard só que agora na aba Resources em Add-ons pesquise por postgres (você pode escolher o banco de sua preferência) e selecione o Heroku Postgres:

Selecione o plano Hobby Dev - Free.

Agora, no terminal de sua aplicação vamos obter as credenciais do Banco de Dados que acabamos de criar executando:

heroku pg:credentials:url

Será exibida as credencias para conectar ao banco, o próximo passo é adicionar elas assim como fizemos para as demais do .env como já foi exemplificado.

Agora podemos rodar nossas migrations e seeders executando:

heroku run php artisan migrate --seed

.

Configurando o Deploy automático a partir da master

Com nossa aplicação rodando e tudo funcionando, vamos configurar para que sempre que houver alteração na branch master o Heroku faça o deploy automático.

Esse passo é bem simples, na aba de deploy vamos selecionar o Deployment method GitHub. Irá pedir para você fazer a autenticação na sua conta e em seguida selecionar o repositório. Pronto, só isso e está tudo configurado para o nosso servidor de testes atualizar sozinho quando a master sofrer alterações.

Caso queira desabilitar essa opção para fazer o deploy de forma manual como fizemos na primeira vez para subir o código, na mesma sessão em App connected to GitHub clique em disconnect.