serverest 2.24.4 → 2.25.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+# [2.25.0](https://github.com/ServeRest/ServeRest/compare/v2.24.4...v2.25.0) (2021-11-22)
+
+
+### Chores
+
+* criar multi-stage build para execução do projeto com nodemon ([9b8bca5](https://github.com/ServeRest/ServeRest/commit/9b8bca520a67eeaa0d08b3f1323a4cc515d38dd3))
+* **docker:** avoid using 'prepare' on prod image ([bc4a9c7](https://github.com/ServeRest/ServeRest/commit/bc4a9c710fe7a91f27bd991dcfd31a260cbad6c8))
+* **dockerfile:** incluir labels com informações do projeto ([7cbdd6c](https://github.com/ServeRest/ServeRest/commit/7cbdd6c0c60a7907941d1fd5dd2ea30a6d823f17))
+* generate package-lock with newer version of npm ([e7b28a0](https://github.com/ServeRest/ServeRest/commit/e7b28a028c6d9ac547e58c4f12774a211578655a))
+* guarantee that pipeline will break when test fail ([22a9629](https://github.com/ServeRest/ServeRest/commit/22a962982096b40fb7420beca3241161b7aa7f4c))
+* **infra-test:** containerize infra test to easier run ([ad9529d](https://github.com/ServeRest/ServeRest/commit/ad9529dfeda47eacf487b947eec6b4bec7d28fe1))
+* renomear test de api para teste de integração ([1368f38](https://github.com/ServeRest/ServeRest/commit/1368f38c186212d2307884dc0ee434c5ae8996a1))
+* set specific version of base images ([ca4c152](https://github.com/ServeRest/ServeRest/commit/ca4c152ae3174376912977ade20119047f60b8fc))
+* **sonar:** remover análise de coverage de arquivos que não necessitam ter testes ([9f5ae1f](https://github.com/ServeRest/ServeRest/commit/9f5ae1f3e28d71d860b8a58d68b4c3a030cde83b))
+* **test:** exibir cor na execução de teste de integração para facilitar leitura ([44ef82d](https://github.com/ServeRest/ServeRest/commit/44ef82d6e2ea4a1f130d767f40e0341a8489a256))
+
+
+### Continuous Integration
+
+* explicitar o nome da imagem docker ([a2eb8c2](https://github.com/ServeRest/ServeRest/commit/a2eb8c238e55acffc7de3b5149120b2627505090))
+* remover execução de teste que não está containerizado ([123eb10](https://github.com/ServeRest/ServeRest/commit/123eb106101bc56201e188c3a925182fce0dc7e1))
+
+
+### Documentation
+
+* **contributing:** detalhar a seção de testes com os pacotes utilizados e informação de coverage ([687395e](https://github.com/ServeRest/ServeRest/commit/687395e6e145384c4ac93af096b95bc01f480f2e))
+* **readme:** adicionar repositório de automação em ruby ([bd828af](https://github.com/ServeRest/ServeRest/commit/bd828af2b993e3ef4558e130ed5252a287d52c9c))
+
+
+### Features
+
+* **rate-limit:** interceptar requests de testes de carga para não enviar os dados para o moesif ([7683cd0](https://github.com/ServeRest/ServeRest/commit/7683cd0060b3312c17305496d580729f3a71a687))
+
+
+### Tests
+
+* fix infra test error ([6345210](https://github.com/ServeRest/ServeRest/commit/634521029dadc92ba3e0b52775b008c7c80bf37f))
+* **infra:** avoid test caching ([befbf6e](https://github.com/ServeRest/ServeRest/commit/befbf6e7d7318964d86f94cb4f12dcdb9b3ff407))
+* **unitario:** garantir comportamento do método getRandomFinancialContributor ([d4debd7](https://github.com/ServeRest/ServeRest/commit/d4debd7691255e307dcef61c986d7486cfc51d30))
+* utilizar multi-stage build ([ed69b62](https://github.com/ServeRest/ServeRest/commit/ed69b6269178ec13382f643a22226fc4dcfe2fe4))
+
 ## [2.24.4](https://github.com/ServeRest/ServeRest/compare/v2.24.3...v2.24.4) (2021-10-13)
 
 

package/README.md

@@ -129,8 +129,6 @@ Você pode encontrar as versões disponíveis na [lista de tags no Docker Hub](h
 
 ## Teste de carga
 
-Para utilizar o ServeRest para estudo de teste de carga, sem gerar impacto, é preciso utilizar o header `monitor: false`.
-
 Para acompanhar o comportamento do ambiente aonde o ServeRest está hospedado você pode acessar a página https://serverest.dev/status, pois contém informações como:
 
 - Uso de CPU.
@@ -138,6 +136,18 @@ Para acompanhar o comportamento do ambiente aonde o ServeRest está hospedado vo
 - Tempo de resposta.
 - RPS (Requisições por segundo).
 
+> Fez teste de carga? O que acha de compartilhar com o autor do projeto o relatório final contendo dados de RPS para auxiliar o ServeRest a entender o comportamento de sua infra?
+
+## Badge
+
+Criou repositório utilizando o ServeRest? Adicione o código abaixo no topo do README.md para ter a badge do projeto.
+
+[![Badge ServeRest](https://img.shields.io/badge/API-ServeRest-green)](https://github.com/ServeRest/ServeRest/)
+
+```markdown
+[![Badge ServeRest](https://img.shields.io/badge/API-ServeRest-green)](https://github.com/ServeRest/ServeRest/)
+```
+
 ## Exemplos de automação
 
 Os repositórios abaixo são exemplos de automação com boas práticas e que consome o ServeRest.
@@ -146,12 +156,9 @@ Os repositórios abaixo são exemplos de automação com boas práticas e que co
 - [JS > Automação com Supertest, Mocha e Chai - Paulo Gonçalves](https://github.com/PauloGoncalvesBH/sample-supertest)
 - [Python > Automação com Pytest - Leonardo Tsuda](https://github.com/ltsuda/pytest-serverest-study)
 - [Robot Framework > Automação com RequestsLibrary - Mayara Fernandes](https://github.com/mayribeirofernandes/testesrobotframework/tree/HEAD/ExemploAPI_ServeRest)
+- [Ruby > Automação com HTTParty e RSpec - Bruno Quintanilha](https://github.com/braquintanilha/serverest-httparty-rspec)
 
-## Badge [![Badge ServeRest](https://img.shields.io/badge/API-ServeRest-green)](https://github.com/ServeRest/ServeRest/)
-
-```markdown
-[![Badge ServeRest](https://img.shields.io/badge/API-ServeRest-green)](https://github.com/ServeRest/ServeRest/)
-```
+Para encontrar mais repositórios acesse https://github.com/search?q=serverest&type=Repositories
 
 ## Patrocinadores
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverest",
-  "version": "2.24.4",
+  "version": "2.25.0",
   "description": "Servidor REST local de forma rápida e simples para estudo de testes de API",
   "author": "Paulo Gonçalves <paulorochag@hotmail.com> (https://www.linkedin.com/in/paulo-goncalves/)",
   "license": "GPL-3.0",
@@ -31,11 +31,12 @@
     "prepare": "is-ci || husky install",
     "commit": "cz",
     "start": "node ./src/server.js",
-    "dev": "cross-env NODE_ENV=serverest-development nodemon -e json,js ./src/server.js --nodoc",
+    "dev": "nodemon --legacy-watch -e json,js ./src/server.js --nodoc",
     "test:mutation": "stryker run ./test/stryker.conf.js",
     "test:mutation:diff": "stryker-diff-runner --path ./test/stryker.conf.js --branch trunk",
-    "test": "nyc mocha --config test/integration/.mocharc.js",
-    "posttest": "nyc report --reporter=lcov",
+    "test:unit": "nyc --report-dir ./coverage-unit mocha --config test/unit/.mocharc.js",
+    "test:integration": "nyc --report-dir ./coverage-integration mocha --config test/integration/.mocharc.js",
+    "merge-lcov": "npx lcov-result-merger@3.1.0 'coverage-**/lcov.info' 'lcov.info'",
     "lint": "standard",
     "lint:fix": "standard --fix",
     "lint:staged": "lint-staged",
@@ -51,11 +52,13 @@
     "express-query-int": "^3.0.0",
     "express-status-monitor": "^1.3.3",
     "express-validation": "^3.0.8",
+    "is-ci": "^3.0.0",
     "jsonwebtoken": "^8.5.1",
     "moesif-nodejs": "^3.1.5",
     "morgan": "^1.10.0",
     "nedb-promises": "^5.0.0",
     "open": "^8.0.6",
+    "rate-limiter-flexible": "^2.3.1",
     "swagger-ui-express": "^4.1.4",
     "yargs": "^16.2.0"
   },
@@ -74,13 +77,12 @@
     "@stryker-mutator/core": "^5.3.0",
     "chai": "^4.3.4",
     "commitizen": "^4.2.3",
-    "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "faker": "^5.5.3",
     "husky": "^6.0.0",
-    "is-ci": "^3.0.0",
     "lint-staged": "^10.5.4",
     "mocha": "^8.3.2",
+    "nock": "^13.1.3",
     "nodemon": "^2.0.7",
     "nyc": "^15.1.0",
     "semantic-release-docker": "^2.2.0",

package/src/app.js

@@ -16,6 +16,7 @@ const errorHandler = require('./middlewares/error-handler')
 const logger = require('./utils/logger')
 const { version } = require('../package.json')
 const swaggerDocument = require('../docs/swagger.json')
+const rateLimiter = require('./middlewares/rate-limiter')
 
 const ehAmbienteDeTestes = process.env.NODE_ENV === 'serverest-test'
 
@@ -27,6 +28,7 @@ app.use(express.urlencoded({ extended: false }))
 app.use(queryParser())
 app.use(timeout())
 app.use(cors())
+app.use(rateLimiter)
 
 app.disable('etag')
 
@@ -85,7 +87,7 @@ app.use('/produtos', require('./routes/produtos-route'))
 app.use('/carrinhos', require('./routes/carrinhos-route'))
 
 app.use(errorHandler)
-app.use(async (req, res) => {
+app.use((req, res) => {
   res.status(405).send({
     message: `Não é possível realizar ${req.method} em ${req.url}. Acesse ${urlDocumentacao()} para ver as rotas disponíveis e como utilizá-las.`
   })

package/src/middlewares/rate-limiter.js

@@ -0,0 +1,18 @@
+/* istanbul ignore file */
+
+const { RateLimiterMemory } = require('rate-limiter-flexible')
+
+const rateLimiter = new RateLimiterMemory({
+  points: 150, // requests
+  duration: 1 // segundo por IP
+})
+
+// Adicionar header 'monitor: false' quando atingir o limite definido para não enviar informações para o moesif.
+module.exports = async (req, res, next) => {
+  await rateLimiter.consume(req.ip)
+    .then(() => next())
+    .catch(() => {
+      req.headers.monitor = false
+      next()
+    })
+}