Giter Club home page Giter Club logo

clients-api-challenge's Introduction

Labs Challenge 🏪

Descrição 📖

Este projeto foi desenv olvido utilizando NestJS e MongoDB, seguindo a arquitetura hexagonal, conceitos de arquitetura limpa e Domain-Driven Design (DDD). Inclui uma suíte de testes completa com testes unitários, de integração e end-to-end (E2E) utilizando Vitest e Testcontainers. Além disso, há uma suíte de testes de carga em desenvolvimento com K6.

Requisitos 📋

  • Node.js
  • npm
  • Instância MongoDB (para execução sem Docker)
  • Docker (para execução com Docker)

Instalação e execução do projeto 🚀

Método Manual

  1. Clone o repositório:

    git clone <URL do seu repositório>
    cd <nome do repositório>
  2. Instale as dependências:

    npm install
  3. Configure o arquivo .env com as variáveis PRODUCTS_SERVICE_URL e MONGO_URI conforme o .env.example. A variável MONGO_URI deve conter a URL da sua instância MongoDB.

  4. Execute a aplicação em modo de desenvolvimento:

    npm run start:dev

Com Docker

  1. Clone o repositório:

    git clone <URL do seu repositório>
    cd <nome do repositório>
  2. Configure o arquivo .env com as variáveis PRODUCTS_SERVICE_URL conforme o .env.example.

  3. Execute a aplicação com Docker:

    docker-compose up

Testando as Rotas da Aplicação 🛠️

Para testar todas as rotas da aplicação, você pode utilizar o arquivo client.http incluído no projeto. Siga os passos abaixo:

  • Instale a extensão Rest Client do VS Code (humao.rest-client).
  • Abra o arquivo client.http.
  • Utilize os comandos no arquivo para testar as diferentes rotas da aplicação. O arquivo após a instalação da extensão ficará mais ou menos assim: alt text

Executando a Suíte de Testes Automatizados 🧪

Testes Unitários

Para rodar os testes unitários:

npm run test:watch

Testes End-to-End e de integração (E2E)

Para rodar os testes E2E (⚠️ Docker precisa estar em execução):

npm run test:e2e

Testes com Coverage

Para rodar toda a suíte de testes e gerar o relatório de cobertura de testes (⚠️ Docker precisa estar em execução):

npm run test:cov

Testes de carga 💪🏻

Utilizei o K6 para realizar testes de carga no sistema.

alt text

Clique aqui para ver o script que gera o teste de carga no fluxo de criação de cliente e a adição de proutos aos favoritos

Como rodar os testes de stress

⚠️ Para roda-los, primeiro, a aplicação já tem que estar rodando na porta 3000!

npm run test:load

Ultimo resultado rodando na minha máquina 📋

Nesse teste, o cenário de favoritar um produto fazia com que cada cliente cadastrado favoritasse somente 1 produto! Obtendo um p(95) de 21.92ms e 65 requisições por segundo, um resultado ok já que estou rodando tudo na minha máquina (1 instância mongodb, 1 do node)!

alt text

Deixando o teste mais realista e estressante 🔥

No mesmo cenário de favoritar produtos, fiz com que todos clientes favoritassem 100 produtos e não somente 1, isso fez com que aumentassemos a quantidade de requisições de 9164 (ultimo teste) para 76220 (541 req/seg) ! Esse aumento massivo de requisições, fez com que o p(95) aumentasse de 21.92ms para 190.53ms

alt text

Algumas melhorias 🔧

Após aplicar algumas melhorias como:

  • Adicionar fastify;
  • Clusterizar a aplicação;
  • Adicionar cache em pontos especificos que o mongodb era acessado;
  • Passa nível de log (variável LOG_LEVEL) para somente erros.

Essas melhorias causaram drastivas melhorias, onde:

  • Aplicação conseguiu aceitar 181988 requisições (1292 req/seg). Antes das melhorias, conseguia aceitar somente 76220 (541 req/seg);
  • Abaixou o p(95)de 190.53ms para 42.94ms.

alt text

clients-api-challenge's People

Contributors

guilhermeais avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.