Forem: Danilo Machado

Indie Hacker, faça você mesmo #1 - Use o Github Actions pra fazer os code reviews automaticamente

Danilo Machado — Thu, 16 May 2024 00:00:12 +0000

Um indie hacker é alguém que constrói e opera negócios de forma independente, muitas vezes focando em startups de tecnologia ou empreendimentos digitais.

Eles geralmente preferem manter o controle total sobre seus projetos, evitando investimentos externos e buscando criar fontes de renda sustentáveis por conta própria.

O termo "indie" vem de "independente", enquanto "hacker" refere-se à mentalidade de solucionador de problemas e à habilidade em criar soluções técnicas. Os indie hackers frequentemente compartilham suas experiências, aprendizados e estratégias dentro da comunidade, buscando colaboração e feedback para melhorar seus empreendimentos, por isso começarei uma série de posts sobre sugestões e dicas de experiências passadas que tive que podem ser úteis para outras pessoas ou outros negócios.

E o primeiro assunto a ser abordado são automatizações que podemos fazer com o Github Actions pra facilitar nossa vida e otimizar nosso tempo que pode ser feito diretamente no repositório do seu projeto de forma personalizada.

Podemos definir diversos tipos de trabalho pra diferentes ações, a abordada no post é pra fazer o code review do código, pois é de extrema importância manter a qualidade do código e manter padrões e as melhores práticas, mesmo que trabalhando sozinho, o que a maioria dos indie hackers fazem, ou em equipes grandes.

Com o Github Actions você pode definir um fluxo de trabalho a partir de um evento, como abertura de um PR por exemplo. Os fluxos de trabalho são definidos no diretório .github/workflows do repositório, através de arquivos com a extensão .yml.

Cada fluxo de trabalho definido no arquivo .yml tem uma ação que é executada por um único executor, sendo um script shell em uma máquina virtual provisionada em diversos sistemas operacionais diferentes.

O exemplo que darei abaixo é estruturando um .yml de acordo com a documentação, usando a linguagem PHP através do phplint, porém pode ser facilmente utilizado com outras linguagens, pois o Github Actions Marketplace possuí uma loja de repositórios de ações e deploys já prontos.

Vamos seprar em duas partes, na parte da identificação do fluxo de trabalho e nos trabalhos em sí.

// Opcional - O nome do fluxo de trabalho conforme aparecerá na guia "Ações" do repositório GitHub.
name: PHP Linting

// Especifica o evento para este fluxo de trabalho. Este exemplo usa o evento push, portanto, uma execução de fluxo de trabalho é acionada sempre que alguém envia uma alteração para o repositório ou mescla uma solicitação na branch especificada ou não.
on:
  pull_request:
    branches: ["master"]

// É usado para definir quais recursos externos à ação estão sendo acessados e como esses acessos são autorizados. Por exemplo, se uma ação precisa acessar o repositório onde está sendo executada, pode precisar de permissões para ler nos arquivos do repositório. Da mesma forma, se a ação precisa interagir com serviços externos, como fazer chamadas de API para serviços de nuvem, pode precisar de permissões específicas para isso.
permissions:
  contents: read

Agora na definição dos trabalhos, temos a seguinte estrutura.

// Agrupa todos os trabalhos executados no fluxo de trabalho.
jobs:
  build:
    // Configura o trabalho para ser executado na versão mais recente de um executor Ubuntu Linux. Isso significa que o trabalho será executado em uma nova máquina virtual hospedada pelo GitHub.
    name: PHP Lint
    runs-on: ubuntu-latest

    steps:
      // A palavra-chave uses especifica que esta etapa executará a v3 da ação actions/checkout. Esta é uma ação que faz clone do seu repositório no executor, permitindo que você execute scripts ou outras ações em seu código (como ferramentas de construção e teste). Você deve usar a ação de checkout sempre que seu fluxo de trabalho usar o código do repositório.
      - name: Copying test repository
        uses: actions/checkout@v3

      // A palavra-chave uses especifica que esta etapa executará a v8 da ação do php-lint, que irá ajudar os desenvolvedores a detectar os erros sempre que o pull request receber atualizações.
      - name: Run php lint
        uses: StephaneBour/actions-php-lint@8.0

      // A palavra-chave uses especifica que esta etapa executará a v1 da ação do review dog, que irá ajudar os desenvolvedores a detectar e corrigir erros de codificação adicionando comentários no pull requests.
      - name: Run php check code with reviewdog
        uses: GeneaLabs/action-reviewdog-phpstan@1.1.2
        with:
          level: "error"
          fail_on_error: "true"
          phpstan_level: 4
          reporter: "github-pr-review"
          target_directory: "./"

O resultado do nosso fluxo de trabalho seria algo parecido com isso:

A revisão de código pode ajudar a identificar potenciais vulnerabilidades de segurança no código antes que ele seja implantado em produção. Isso é especialmente importante em ambientes onde a segurança é uma preocupação primordial.

Após o início de uma execução de fluxo de trabalho, você pode ver um gráfico de visualização do progresso da execução e visualizar a atividade de cada etapa em GitHub.

O GitHub Actions pode ajudá-lo a automatizar quase todos os aspectos dos processos de desenvolvimento da sua aplicação. Pronto para começar?

Fontes
Github Actions - Docs

Introdução aos testes unitários em Go

Danilo Machado — Fri, 13 Jan 2023 13:23:56 +0000

Os testes unitários são testes que verificam se uma parte específica do código, costumeiramente a nível de função, está funcionando corretamente. Em um ambiente orientado a objetos é usualmente a nível de classes e a mínima unidade de testes inclui construtores e destrutores.

Por qual motivo devo realizar testes unitários na minha aplicação?
Mas o verdadeiro propósito do teste unitário é fornecer-lhe feedback quase instantâneo sobre o projeto e a implementação de seu código. A criação de testes unitários, ou melhor, a facilidade ou dificuldade com que você pode criá-los lhe diz exatamente o quão testável é seu código. O quão bem você o projetou.

No nosso exemplo, vamos simular um teste unitário em uma função que faz a validação de um symbol de criptomoedas bem simples mas que foi retirado de produção.

Todo o teste unitário necessita de um planejamento prévio. Deve ser de entendimento do desenvolvedor os requisitos que aquela funcionalidade tem que cobrir, qual a sua entrada e qual a sua saída e como se processa o fluxo interno dos dados. Logo, nesse primeiro momento, podemos observar a função e notar que existem dois cenários que não podem faltar, sendo ele o cenário de sucesso e o cenário de falha. Pra isso usaremos a lib mais utilizada que é a testify.

Na documentação do testify tem alguns exemplos, seguindo os cenários de teste unitário que definimos para nossa função, o código iniciaria parecido com esse.

Para testar nosso cenário de falha, basta chamarmos nossa função passando um parâmetro inválido sem a barra e comparar se o erro vindo da função é igual ao erro que definimos para ela.

E no caso do sucesso, basta validarmos que a função não retorne erro, por passar o parâmetro adequadamente.

Digite go test -p 1 -covermode=atomic -tags=unit para rodar os testes unitários ou use os atalhos do vscode, caso utilize. Você deverá visualizar o retorno com algo parecido a isso:

=== RUN   TestValidationSymbol
=== RUN   TestValidationSymbol/Cenário_1_-_Falha
=== RUN   TestValidationSymbol/Cenário_1_-_Sucesso
--- PASS: TestValidationSymbol (0.00s)
    --- PASS: TestValidationSymbol/Cenário_1_-_Falha (0.00s)
    --- PASS: TestValidationSymbol/Cenário_1_-_Sucesso (0.00s)
PASS
ok

Claro, essa é só uma introdução, a lib testify tem diversas validações que facilitam a implementação de testes unitários no dia-a-dia, em produção usamos em coisas mais complexas como validar métodos que retornam dados do banco de dados, métodos que fazem validações, métodos responsáveis por gerenciar endpoints e até mesmo com essa lib, conseguimos fazer os testes de integração, que seria um outro assunto.

Lembre-se, sempre que alterar um método ou função, você deve também alterar o teste unitário, pra isso, temos algumas formas de facilitar a checagem dos testes para verificar se teve alguma alteração, criando um atalho no Makefile por exemplo e chamando na pipeline do repositório ou até mesmo rodando localmente antes de subir sua branch.

Para rodar o comando do exemplo, basta digitar: make run-test

É isso. Recomendo a leitura também de artigos sobre criação de mocks, pois muitas das vezes irá precisar de mocks para realizar testes unitários, um exemplo são chamadas de outros serviços, elas precisarão ser feitas via mock.

Até a próxima!

Melhorando a perfomace de projetos PHP com Memcached

Danilo Machado — Thu, 11 Aug 2022 19:26:00 +0000

O módulo Memcached fornece uma interface processual e orientada a objetos útil para o daemon de armazenamento em cache do memcached altamente eficaz, que foi especialmente projetado para diminuir a carga do banco de dados em aplicativos da Web dinâmicos.

O módulo Memcached também fornece um manipulador de sessão (memcache).

Dicas de onde usar Memcached na sua aplicação?

Dashboards
Listagens
Consultas

O principal ponto do Memcached é que, ele diminui o tempo de resposta de suas páginas web, o que, em troca, melhora a experiência geral do cliente. Um melhor tempo de resposta permite que os usuários busquem dados perfeitamente.

Você pode verificar se já está instalado no seu servidor, através do phpinfo.

<?php
phpinfo();

Caso não esteja instalado ainda, basta seguir os passos abaixo.

yum install memcached
systemctl enable memcached

OBS: O módulo Memcached 3.0.8 não funciona com o php 7 (ou superior).

Um exemplo de conexão, para verificar se o Memcached está funcionando adequadamente.

A partir do exemplo de conexão, você pode criar funções inteligentes para consumir o cache e preencher o cache com informações atualizadas. O objetivo é obter informações sem precisar consultar o banco de dados. Somente se as informações não estiverem cacheadas iremos consultar a banco de dados e após armazenar as informações em cache para as futuras consultas.

Empresas que usam o Memcached
shopify.com
apple.com
walmart.com

Com o Memcached podemos arquitetar excelentes projetos com estruturas de cache em memória RAM utilizando diversos servidores. É recomendado salvar apenas as informações mais importantes.

Fontes
php.net
memcached.org

Implementando grandes dependências no AWS Lambda através do AWS Layer

Danilo Machado — Sun, 03 Apr 2022 16:27:06 +0000

Hoje irei falar um pouco desse serviço da AWS pouco utilizado, pois eu precisava implementar em um lambda algumas libs que somavam mais de 500 MB juntas, e obviamente não conseguia fazer o deploy, devido a limitação de 250 MB da AWS e tive que pesquisar bastante para solucionar o impasse.

Então descobri esse serviço, que você pode provisionar as dependências em layers (camadas) e especificar em qual lambda quer usar, podendo ser utilizado por vários lambdas simultaneamente. O uso de camadas reduz o tamanho dos arquivos de implantação carregados e agiliza a implantação do seu código.

Imagine que você precise desenvolver um lambda para declarar imposto de rendas e nesse lambda, precisa conter três dependência do node: express, sequelize e mysql.

No meu exemplo utilizo node, mas o AWS Layer funciona em todas as linguagens em que a AWS dão suporte, continuando nosso exemplo, vamos supor que o express tem 100 MB, sequelize 100 MB e mysql 100 MB deszipados após o build da node_modules, logo o lambda não irá fazer deploy, pela limitação de 250 MB.

Para resolver esse problema, utiliza-se o AWS Layer, a solução seria criar um layer pro express, um layer pro sequelize e um layer pro mysql separadamente, como se fosse uma dependência do npm. Nas configurações do lambda, você declara o layer como dependência, como disse anteriormente, podendo ser utilizado por diversos lambdas, lembrando que cada layer também tem a limitação de 250 MB e pode ser versionado.

Esses casos de pacotes grandes são bem raros, mas quando precisei, essa foi a solução. A AWS não cobra pelos layers, somente é cobrado o valor dos lambdas por execução. Você pode criar layers usando o console do Lambda, a API do Lambda, o AWS CloudFormation ou o AWS Serverless Application Model (AWS SAM). Para obter mais informações sobre como criar os layers consulte a documentação da AWS.

Referências
Layer - AWS Docs

Guia: Trabalhando com pdfs na AWS através do Node.js

Danilo Machado — Fri, 01 Apr 2022 12:33:26 +0000

Depois de apanhar bastante tentando realizar tarefas que envolviam pdf na AWS, deixo esse guia para quem precisar realizar esse tipo de demanda.

No meu caso, eu precisava fazer em node, então todas as bibliotecas e features que usei, são em javascript.

1) Primeira pergunta a se fazer, o serviço é um AWS Lambda/Batch ou ECS?

AWS Lambda/Batch

Recomendo usar a biblioteca puppeteer na versão 8 do node, pois as versões mais atualizadas são mais pesadas e a AWS limita o tamanho do lambda em 250mbs. Outra opção seria criar um layer na AWS Layer.

O puppetter utiliza o chromium para realizar as impressões e é bem fácil utilizar.

Dá pra imprimir páginas da web e templates em html montado através do handlebars.

ECS

Já no ECS, recomendo a utilização do html-pdf na
versão ^8.0.0 do node, por ser mais leve e funcionar bem. Ele utiliza o phantomjs, que não funciona no AWS Lambda e Batch;

2) Precisa encryptar, colocar senha no pdf?

Sem dúvidas, a melhor opção pra encryptar os pdfs, atribuir senhas de user e owner é o hummus-recipe, ele precisa rodar na versão >=14.0.0 do node para funcionar.

Ele funciona muito bem em qualquer serviço da AWS.

Mas se por algum acaso não conseguir utilizar o hummus-recipe para encrypt, devido a versão do node ser inferior a 14.0.0, outro bom pacote é o qpdf. Será preciso copiar os arquivos binários do qpdf para o container através do Dockerfile para executar o qpdf.

Agora é só subir o pdf pro S3 e ser feliz!

QZ Tray: Impressão em impressoras térmicas pelo navegador com Javascript

Danilo Machado — Fri, 01 Apr 2022 02:12:38 +0000

Neste artigo irei abordar a melhor maneira de imprimir em impressoras térmicas direto pelo navegador.

A solução do QZ é utilizada pela grande maioria de softwares do ramo de cardápio digital no Brasil.

Apesar do QZ vender licenças para domínios, ele é um open sourcer. Ou seja, precisamos alterar o código fonte do QZ e compilar novamente, de acordo com o nosso domínio.

1) Você pode realizar os testes direto no demonstrativo do QZ;

2) Ao realizar os testes, você verá os pop-ups do QZ aparecendo igual na imagem abaixo, informando sobre a licença. Por isso precisaremos recompilar o QZ com seu novo certificado.

3) Recomendo realizar o download do JDK 7 ou superior, Apache Ant e Open SSL;

4) Faça o clone do repositório do QZ Tray no github;

5) Gere o certificado ssl com o Open SSL;



openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 11499 -nodes

OBS: quando perguntar o dominio, colocar o curinga, ex: *.seusite.com.br

6) Gere a private key usando o certificado ssl;



openssl pkcs12 -inkey key.pem -in cert.pem -export -out privateKey.pfx

7) Coloque o arquivo key.pem gerado anteriormente na pasta do tray-master, na raíz, que foi clonado do github;

8) Agora, precisamos compilar o QZ com o Apache Ant, mas antes, lembre-se;

8.1) Depois de baixar o Apache Ant, coloque a pasta na variável de ambiente;



- ANT_HOME=caminho
- Path=[]caminho

8.2) Rodar o comando para compilar de acordo com seu sistema operacional;



// win
ant nsis -Dauthcert.use="key.pem"

// linux
ant makeself -Dauthcert.use="key.pem"

// mac
ant pkgbuild -Dauthcert.use="key.pem"

9) Depois de compilado, abrir QZ em /tray-master/out/dist/qz-tray.jar e clicar em "+", pra gerar o certificado, será gerado o digital-certificate.txt e private-key.pem, copie os 2 e coloque no seu servidor, pro sistema poder utilizar os certificados;

10) E quando for usar o QZ no seu website, basta utilizar os certificados gerados;

11) E o seu arquivo sign-message.php pode ser montado da seguinte forma;

12) Depois disso tudo, os pop-ups do QZ irão parar de aparecer e você irá conseguir imprimir sem problemas;

13) Não esqueça de dar uma olhada na documentação do QZ, pois lá tem todas as configurações e opções de impressão;

Exemplos de uso da api do cpanel

Danilo Machado — Thu, 31 Mar 2022 23:53:19 +0000

Bom, quando trabalhei num sistema distribuído, precisávamos criar subdomínios, databases e várias outras coisas em real-time para cada cliente especificamente, então criei um shell script para automatizar as tarefas.

Deixo acima alguns endpoints da versão v2 da api do cpanel que me ajudou bastante na automatização.

Referências

cpanel api docs