Skip to content

Web API feita em Node.js puro com testes End to End sem necessidade de qualquer framework ou biblioteca.

Notifications You must be signed in to change notification settings

EduardoReisUX/nodejs-native-e2e

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Testes e2e com Node (sem frameworks)

Web API feita em Node.js puro com testes End to End sem necessidade de qualquer framework ou biblioteca.

Ferramentas

  • Node@20.9.0

Como rodar

  • npm run dev: sobe o servidor.
  • npm run test ou npm t: sobe o servidor e roda os testes e2e.
  • npm run test:dev: sobe o servidor e roda os testes e2e em watch mode.

Aprendizagens

npm e node cli

  • npm init -y: inicializa um novo projeto
  • npm t: roda os testes
  • node --watch [arquivo]: roda o projeto e observa o arquivo se for modificado para atualzar.
  • node --test --watch [arquivo]: roda os testes e observa se o arquivo for modificado para atualizar.
  • "type": "module": permite utilizar ESModules (import, export, etc.) ao invés de CommonJS (module.exports, const x = import(...)).

curl

  • curl localhost:3000: faz uma requisição HTTP direto do terminal

node

  • createServer(handler): função nativa que cria um servidor com request e response. Todo o back end pode ser feito a partir do pacote http do próprio node.
  • A função fetch() pode ser usada para fazer requisições no ambiente de testes e substituir a biblioteca supertest.
  • A função node:event.once() é um listener que aguarda por um evento ser emitido. No exemplo await once(request, "data") diz o programa para esperar até que o evento "data" seja emitido pelo request. É equivalente a:
request
    .on('data', chunk => {
      body.push(chunk);
    })
    .on('end', () => {
      // ...
    });

eslint

O javascript nativamente não possui uma análise de código, então é utilizado o pacote eslint para isso:

  • npx eslint .: Faz a análise de todo o código do projeto, indicando erros e avisos (no-unused-vars, no-undef, ...).

JSDoc

JSDoc é uma ferramenta utilizada para fazer a tipagem de variáveis, objetos e funções sem precisar de TypeScript.

  • Para variáveis que possuem a tipagem vinda de pacotes, importar a tipagem desta maneira para evitar conflitos:
/** @type {import("node:http").Server} */
let _server = {};
  • Para fazer a tipagem de variáveis atribuídas via desestruturação (destructuring assignment):
/** @type {{ description: string, price: string }}  */
const { description, price } = JSON.parse(await once(request, "data"));

No exemplo acima, description e price são do tipo string.

Erros corrigidos

Tipagem de funções do tipo RequestListener

Ao fazer a tipagem de uma função (uma rota por exemplo) como ResquestListener:

import { createServer, RequestListener } from "node:http";

/** @type {RequestListener} */
async function handler(request, response) { 
    // ...
}

E subir o servidor, ocorre este erro:

import { createServer, RequestListener } from "node:http";
                         ^^^^^^^^^^^^^^^
SyntaxError: The requested module 'node:http' does not provide an export named 'RequestListener'

Para corrigi-lo, retire o RequestListener dos import:

import { createServer } from "node:http";

/** @type {import("node:http").RequestListener} */
async function handler(request, response) { 
    // ...
}

Fontes:

About

Web API feita em Node.js puro com testes End to End sem necessidade de qualquer framework ou biblioteca.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published