Quando o assunto é qualidade em desenvolvimento, podemos falar sobre legibilidade, performance, custos, produtividade e algumas outras coisas. Vamos falar um pouco sobre algumas ferramentas e práticas que podem ajudar muito na hora de escrever e manter códigos front-end de qualidade.

Algum tempo antes do meu último post, comecei a estudar bastante sobre testes e queria escrever algo sobre o assunto. Um outro assunto sobre o qual eu já havia lido e então comecei a brincar um pouco, foi o TypeScript. Como nos últimos meses tudo isso (e muito mais) se tornou parte da minha stack como front-end na Studio Sol, decidi escrever um post mais completo, com uma visão mais prática sobre tudo isso.

Agora vamos ao que interessa. Para melhor entendimento, vamos dividir este post em algumas partes básicas:

  • JavaScript e tipagem
  • Tipagem em React
  • Cultura de Teste

So, let’s go there!

JavaScript e tipagem

Gostaria de começar falando que, se você ainda acha que JavaScript é uma linguagem sem tipagem, tá na hora de mudar esse conceito.

JavaScript tem tipos bem definidos sim, e tem valores primitivos dos seguintes tipos:

  • Undefined
  • Null
  • Boolean
  • Number
  • String
  • Symbol

Objetos partem do escopo do tipo Object, e aqui estamos falando de Function, Date, RegExp, os wrappers de String, Number e Boolean, vários outros e qualquer um que você crie.

Okay, podemos prosseguir.

Linguagens fortemente tipadas garantem certo nível de qualidade de código, porque você tem um ambiente, de certa forma, controlado e pode prevenir vários errinhos inesperados. Linguagens fracamente tipadas e de tipagem dinâmica, como JavaScript, apesar da flexibilidade, podem trazer alguns efeitos colaterais para o controle e tratamento dos dados.

Nesse ponto, eu gostaria de ressaltar que quando você e seu time entendem bem o comportamento dos tipos e suas coerções dentro da linguagem, vocês podem manipular muita coisa a seu favor. A tipagem dinâmica não é, em si, um problema mortal. No meu caso, quando comecei a desenvolver, eu evitei linguagens fortemente tipadas, ou qualquer coisa que tornasse meu processo de aprendizado mais burocrático, por isso foquei tanto em PHP e depois em JS.

Com o passar do tempo, senti a necessidade de algumas garantias a nível de código e tive uma experiência interessante na faculdade, com Java. Pude perceber mais clareza e produtividade em alguns trechos de código que escrevia e acredito que muito por causa de tipagem.

Ah! A partir da versão 7 do PHP também temos a possibilidade de deixar o código mais estrito. ;)

A evolução do JavaScript, principalmente em 2015, favoreceu muito o desenvolvimento de software, e é perfeitamente possível escrever software robusto com JS puro, o Rocket.Chat que o diga. Mas antes disso, a Microsoft já vinha com uma iniciativa ousada de criar uma ferramenta robusta para o desenvolvimento de código, o TypeScript, que se destacava pelo seguinte ponto:

TypeScript starts from the same syntax and semantics that millions of JavaScript developers know today.

Outras linguagens tentaram fazer “o mesmo” que o TypeScript faz (compilar para JS), como por exemplo o Coffee Script, a diferença primordial é o fato da sintaxe e semântica já serem conhecidas. Com a evolução do JS, os adicionais colocados pelo TS parecem mais uma evolução natural da linguagem. Tudo isso favoreceu muito a utilização de TypeScript e claro que não podemos deixar de falar da Google utilizando a linguagem no Angular.

Sim, com TypeScript precisamos escrever um código mais verboso, mas é um custo que vale a pena durante manutenção e reusabilidade, e o resultado final é JavaScript, então é bom demais! Você pode testar um pouco no playground da linguagem.

Acho que deu pra entender como o TS se encaixa na história, né? Qualquer dúvida, comenta aí, a gente conversa mais e esclarece tudo.

Tipagem em React

Como falei, o Angular ^2 é escrito com TypeScript e, graças à era Open Source da Microsoft, também podemos usar TS em aplicações Node.js, ou com jQuery, Vue.js, React, etc. Isso acontece porque existe @types pra quase tudo!!! Faça o teste, procure por alguma biblioteca que você usa: TypeSearch.

Eu não vou ensinar instalar e configurar um projeto React pra usar TypeScript, a própria documentação do TS já tem guias pra isso e são bem explicados, dá uma olhadinha nesses links:

O que quero focar aqui, é em pequenos exemplos de como a tipagem ajuda no desenvolvimento e como um editor/IDE pode facilitar as coisas. Vamos para a prática!

Considerando a instalação e configuração manual, disponível no link React & Webpack acima, vou apenas mudar a utilização do webpack e webpack-dev-server, pra não precisar instalar nada globalmente e não precisar ficar fazendo build toda hora. Vamos fazer um componente <TodoApp />, o mesmo disponível na página do React e o código escrito para este post está disponível neste repositório.

Recomendo o uso do VS Code. Ele tem um ótimo suporte, quase que nativo, pro TypeScript, então facilita muita coisa.

Ok, o código original do componente é o seguinte:

Vamos dividir esses componentes em arquivos diferentes e ajustar os imports dos componentes, vai ficar assim:

  • src/components/TodoApp.tsx
  • src/components/TodoList.tsx:

E nosso src/index.tsx fica assim:

Você pode conferir como o código deve ficar nesta tag. Agora, vamos executar o build do webpack com o --watch e ver o que vai acontecer:

$ ./node_modules/.bin/webpack --watch

O build vai mostrar vários erros. Isso era realmente o esperado, agora vamos ajustar tudo.

<TodoList />

Em primeiro lugar, esse é um componente stateless, então vamos transformá-lo numa função, pra ficar mais enxuto e performático, assim:

Nesse ponto, os erros apontados para este arquivo já foram solucionados, isso porque o compilador estava dizendo que alguns tipos de um componente React não tinham sido especificados.

Agora imagine que você e sua equipe devam utilizar este componente em outras partes da aplicação, não apenas do <TodoApp />. Pode ser que queiram usar só para renderizar um conjunto de tarefas, ou algo do tipo. Como garantir que sempre vão receber os dados corretos para isso? Podem combinar e escrever isso em algum lugar, mas se o caso é documentar isso e deixar claro pra quem for utilizar o código, é melhor que esses tipos sejam especificados. Então vamos especificar que esse componente deve receber uma prop chamada items, que deve ser um array de elementos com uma descrição e um id.

Podemos definir esses “modelos” com type ou interface, mas acredito que interfaces são mais úteis quando definimos “modelos” (ou “contratos”, como algumas pessoas dizem) para classes/métodos, então vamos criar um tipos mesmo:

Um pouco mais verboso, né? Vale a pena, você vai ver. O export do ItemType também será útil no próximo componente.

<TodoApp />

Este componente não precisa de uma definição de props, já que não recebe nada, mas ele contém state, então é bom definir esses estados. Vamos importar tudo o que precisamos do outro componente e definir o tipo do nosso state:

Reparou no <{}, StateType>? Como não precisamos de um modelo de props, declaramos apenas o modelo dos estados, daí nosso construtor espera que props seja um objeto vazio, ou seja, não precisa declarar nenhuma prop. Podemos até definir um estado default, o que ajudaria no caso de querermos reaproveitar esses dados. Veja só:

Isso também poderia ser feito para props, e se definir um static defaultProps, o próprio compilador já entende o que deve fazer e inicializa nossas props.

Agora os únicos avisos de erro que temos são os tipos dos parâmetros do das funções de handle. Vamos ajeitar isso antes de inserir uma nova feature em nosso componente.

O que fizemos até aqui foi definir que nossos componentes devem seguir certo comportamento, mesmo que outra pessoa mexa nesse código, ou reutilize em alguma outra parte da aplicação. Temos state, props e métodos com consistência. Mesmo que o resultado final seja JavaScript puro, estamos garantindo integridade e qualidade durante o desenvolvimento.

Nova funcionalidade

Agora que tudo já está certinho, e está tudo aqui nesta tag, vamos mexer em algumas coisinhas e criar um método para dar um reset no nosso componente.

Vamos definir o método, fazer o bind no constructor e criar um <button> que irá chamá-lo. Vou cortar alguns trechos de código aqui para economizar espaço:

Viu que reutilizamos o defaultState? E que nosso novo método não precisa receber nenhum parâmetro e nem precisa especificar?

Conseguiu perceber como o código fica mais consistente? Se você estiver usando um editor/IDE bem configurado, vai conseguir ser muito mais produtivo. Faça o teste do VS Code, mas se quiser, pode configurar o Atom, ou Vim também.

Agora vamos entrar na parte que eu acho mais interessante: testes!

Cultura de testes

Aaah, testes…

Quantas vezes você tentou trabalhar com uma biblioteca e, mesmo que encontrava algo documentado, não encontrava exemplos e isso dificultava um pouco pra trabalhar com ela? Ou, quantas vezes você mexeu em alguma parte do código e demorou um tempinho até perceber que alguma outra coisa parou de funcionar? Já aconteceu de ter que testar manualmente várias telas, inputs e outputs na aplicação pra garantir que está tudo funcionando depois de uma modificação grande? Pois é, garantir a estabilidade e documentação do seu código, e aplicação de forma geral, pode se tornar mais simples pelo fato de adotar uma cultura de testes de forma automatizada.

Vamos focar em testar as partes mais básicas do teu código e as comunicações entre um módulo e outro. O assunto de testes é muito vasto, e eu particularmente gosto bastante, mas vou me conter aqui porque existem várias fontes sobre isso, aqui estão algumas:

  • Pra quem gosta de ouvir:
    • https://www.lambda3.com.br/2016/11/podcast-18-testes/
    • https://hipsters.tech/testes-automatizados-hipsters-51/
    • http://zofe.com.br/posts/voce-testa-se-o-teste-do-codigo-testado-testavel/
  • Pra quem gosta de ler:
    • https://willianjusten.com.br/entendendo-testes-de-software/
    • https://blog.umbler.com/br/qualidade-de-software-1-7-motivos-para-considerar-o-teste-de-software-indispensavel/
    • https://jcemer.com/voce-e-irresponsavel-por-nao-escrever-testes-de-front-end.html

Aqui eu vou focar mais nos testes unitários da nossa aplicação. Existem várias ferramentas diferentes para testar código JavaScript, e TypeScript no nosso caso. Eu escolhi falar sobre Jest por alguns motivos e dentre eles, porque é o que eu uso no meu dia-a-dia porque é simples de configurar. Ambientes de teste podem dar dor de cabeça para configurar, principalmente no ecossistema JS atuais (vede data da publicação). O maior complicador aqui é a configuração para testar nosso código TypeScript, mas mesmo assim é simples.

Preparando ambiente

No ponto que nossa aplicação está, precisamos configurar tudo para fazer com que nosso código TypeScript seja testado pelo Jest. Para isso, vamos seguir alguns passos:

  1. Terminar a instalação do ambiente React com webpack e Babel (no link abaixo tem outros links pro Babel e como configurar tudinho, mas na prática é pouca coisa):
    • https://reactjs.org/docs/add-react-to-an-existing-app.html
    • Devemos inserir o babel-loader na mesma rule do awesome-typescript-loader, assim:
    • use: [ { loader: "babel-loader" }, { loader: "awesome-typescript-loader" } ]
  2. Instalar o Jest e ts-jest:
    • https://facebook.github.io/jest/docs/en/tutorial-react.html#setup-without-create-react-app
    • https://github.com/kulshekhar/ts-jest#usage
  3. Instalar o Enzyme, o seu adaptador para a versão do React que estamos utilizando (v. 16) e os tipos:
    • http://airbnb.io/enzyme/docs/installation/#working-with-react-16
    • @types/enzyme e @types/enzyme-adapter-react-16
    • Como estamos trabalhando com TypeScript, crie o arquivo enzyme.adapter.tsx com o conteúdo referenciado abaixo e coloque ele no setupFiles da configuração do Jest no package.json (deve ter sido criado no passo 2):

Agora é só criar uma tarefa de testes no npm:

O resultado final dessas alterações pode ser visto neste commit.

Esclarecendo as coisas, o Jest é uma biblioteca para testar código JavaScript, já o Enzyme vai nos proporcionar toda dinâmica de renderização e manipulação de DOM que o browser faz. Agora vamos escrever nossos testes.

Começando a testar

Para escrever nossos testes e fazer com que o Jest faça seu trabalho, só precisamos seguir a definição da própria biblioteca:

Place your tests in a __tests__ folder, or name your test files with a .spec.js or .test.js extension.

No nosso caso, vamos criar um diretório __tests__, que irá seguir a mesma estrutura do nosso diretório src, então vamos criar nosso primeiro teste, o do nosso componente <TodoList />, que é stateless:

Muita informação de uma vez, mas vou explicar tudo. Seguinte:

Primeiro nós importamos as coisas necessárias para nosso teste: o React, a função render do Enzyme (vou mais sobre isso) e o nosso componente; depois criamos um mock, que é um conjunto de dados que será usado para testes; descrevemos o nosso contexto de teste e começamos especificar os casos. O primeiro caso deve renderizar a <ul> com uma <li>, daí mandamos o render() fazer o trabalho dele e então fizemos uma busca dentro do que foi renderizado para então verificar se a quantidade de itens estava certa e o texto também, com o expect(). O segundo caso é praticamente a mesma coisa, mas com mais itens, e pra não ficar repetitivo, usamos o forEach().

Como falei, utilizamos o render() do Enzyme e ele a melhor escolha para testar componentes estáticos, sem estado, como esse nosso componente do teste. Também temos as funções shallow() e mount().

O shallow faz a montagem e renderização no nível do componente e testa o componente como uma unidade, ou seja, se você tiver componentes filhos, eles não serão montados e não vão afetar o teste do componente em questão.

Já o mount vai montar toda a árvore de componentes, “da raiz até as folhas”, e toda a respectiva estrutura do DOM. Isso é muito bom pra testar integração entre componentes.

Vamos testar nosso próximo componente, o <TodoApp />. Primeiro vamos testar a renderização e depois o disparo dos métodos de handle. Aqui está:

Como falei, esses testes tem muito conteúdo, então vou citar algumas particularidades deles aqui:

  • jest.spyOn nos permite observar uma função, que no caso foi um método do prototype do componente. Poderíamos até substituir essa função por outra com o jest.spyOn(...).mockImplementation(novaFuncao);
  • Podemos simular eventos com o .simulate() do Enzyme e, dependendo do caso, precisamos passar um objeto como para definir o escopo do evento que precisamos;
  • Podemos acessar a instância do componente montado. O Enzyme nos dá um “container” de manipulação do componente, mas podemos acessar o próprio componente alocado na memória e acessar métodos, state, props, etc.

Integrando os testes

Testamos nossos componentes como unidades, os famosos testes unitários, mas também podemos fazer o que chamamos de testes de integração: montar tudo e testar o funcionamento da coisa como um todo. Podemos fazer isso com o mount do Enzyme. Aí seria mais ou menos assim:

  • Montar o componente (mount(<TodoApp />));
  • Testar o funcionamento do formulário (com o handleChange e handleSubmit);
  • E então testar se a inserção de novos itens fazem o <TodoList /> renderizar mais <li> dentro d a<ul>.

Conclusão

Trabalhar com uma linguagem tipada pode ajudar muito a garantir um bom código, pode deixá-lo mais claro, estrito e menos sujeito ao uso incorreto de alguma função.

Testar esse código ajuda muito na manutenção e para saber se tudo está funcionando em conjunto (testes de integração). Mas não se engane, como diria Leo Balter (no ZOFE #8):

Teste não diz que sua aplicação está funcionando, ou que ela está fazendo o que ela deveria fazer. Só diz que está testado.

Por isso é preciso definir bem o que será testado. Só testes unitários não resolvem tudo. Você pode até usar algumas técnicas como TDD para tentar guiar a escrita do seu código e se testar bem suas integrações, sempre terá um feedback do que não estiver funcionando corretamente após alguma alteração.

Isso dá espaço para falar de code coverage, mas isso é assunto para outro post.

Bom… isso é tudo, por agora.

Até a próxima.

(:


Referências

  • http://www.ecma-international.org/ecma-262/#sec-ecmascript-language-types
  • https://jcemer.com/types-in-javascript-what-you-should-care.html
  • https://tableless.com.br/guia-completo-react-ecossistema/
  • https://tableless.com.br/diga-ola-ao-typescript-e-adeus-ao-javascript/