Customer Clean Architecture (Microserviço)

Customer API é um microserviço que utiliza um padrão arquitetural Clean Architecture e modelagem de entidade utilizando conceitos de DDD e filas com o Kafka para processar casos de uso.

Considerações iniciais

Foi utilizado o mongodb como persistência de dados e o redis como estratégia de cache;
O padrão arquitetural utilizado é resultado é um compilado de técnicas utilizadas por Wesley Willians, Rodrigo Manguinhos e Diego Fernandes.

Stack

NodeJs/Express;
Typescript;
Docker (MongoDB, Redis);
Jest;

Padrão arquitetural (Clean Architecture)

A escolha do padrão Clean Architecture para um projeto de software pode trazer diversos benefícios, mas é importante ressaltar que a escolha de uma arquitetura depende muito das necessidades específicas do projeto, das características da equipe de desenvolvimento e das metas a serem alcançadas.

Principais vantagens:

Separação de responsabilidades;
Independência de frameworks e bibliotecas;
Testabilidade;
Adaptabilidade a mudanças;
Escalabilidade;
Longevidade do software;
Compreensão e colaboração.

Entidades

Customer

Campos	Tipo	Validações
id	string	N/A
document	number	propriedade document requerida propriedade document não pode ser negativa
name	string	propridade name requerida propiedade nome não pode conter mais de 20 caracteres
createdAt	Date	N/A
updatedAt	Date	N/A

Diagramas BPMN do microserviço

Descrição	Data de modificação	Versão	Link de download
Arquivo .drawio v1	11 de agosto de 2023	v1	Download
Arquivo .drawio v2	12 de agosto de 2023	v2	Download
Arquivo .drawio v3	28 de agosto de 2023	v3	Download

Descrição	Data de modificação	Versão	Link de download
Arquivo .drawio v1	12 de agosto de 2023	v1	Download
Arquivo .drawio v2	28 de agosto de 2023	v2	Download

Metodologia de desenvolvimento

Entendimento do problema, escopo e prazos;
Levantamento dos requisitos funcionais;
Definição do padrão arquitetural a ser utilizado;
Definição das atribuições e cronograma de estimativas no desenvolvimento das atividades para cumprimiento dos prazos de entrega;
Criação dos diagramas;
Desenvolvimento do código, guiado a testes (TDD);
Ajustes no código e diagramas.

Técnicas utilizadas

👉 Modelagem do domínio (DDD);
Desenvolvimento guiado a contratos;
👉 Tratamento de erros personalizados utilizando middlewares;
👉 Notification pattern para validação de entidades;
👉 Adapter pattern para o express;
Barrel pattern para agilidade na importação dos pacotes e clareza do código;
👉 Container pattern para criar a árvore de depedências (injection/invesion dependecy);
👉 Build pattern para configurar o entrypoint da aplicação;
DTO;
👉 Data Mapper pattern para realizar as conversões de dados, técnica bastante utilizada no java;
Fail first;
👉 Estratégia de resiliência de chamadas http com o axios retry;
👉 Estratégia de melhor gerencimanto do pool de conexões com o agentkeepalive;
TDD
HATEOS
Testes de unidade utilizando mocks;
Indexes nas collections do mongo;
Utilização do linter para padronizar o código;
Utilização do pacote swc para transpilação mais rápida;
Docker-compose para criação dos containers mongo e redis;
Makefile para criar aliases de command line;
Padronização de commits (conventional commits);

Kafka

Foi utilizado o Kafka para processamento de casos de uso.

O que poderia utilizar

Além da técnica de http retry, outra técnica resiliência a exemplo do RateLimit;
Swagger para documentar a aplicação;
Loggers;
Testes com Fakes em memória para deixar o código mais limpo;
Strategy pattern para o chaveamento de providers.

Cronograma

Atividade	Esforço (Fibonacci)	Finalizado?	Execução
Levantamento do escopo mediante os prazos	1	🔥	100%
Levantamento dos requisitos funcionais	1	🔥	100%
Criação da documentação no Git	1	🔥	100%
Criação dos diagramas e README.md	1	🔥	100%
Desenvolvimento do código	3	🔥	100%
Ajustes finais no código e documentação	1	🔥	100%
Implementações (swagger, ratelimit, loggers)	2	-	0%

Total: 10 pontos

Escala considerada

Esforço 1 - Representa >= 1 hora e <= 4 horas.
Esforço 2 - Representa > 4 hora e <= 10 horas.
Esforço 3 - Representa > 10 horas e <= 20 horas.
Esforço 5 - Representa > 20 horas e <= 34 horas.
Esforço 8 - Representa > 34 horas e <= 40 horas.
Esforço 13 - Representa > 40 horas e <= 80 horas.

Endpoints

Resumo de todas as rotas disponíveis na API

Endpoint	Método	Bearer Token	Descrição
http://localhost:3000/api/v1
CUSTOMERS
/customers	POST	x	Cria o customer
/customers/:id	PUT	x	Atualiza o customer
/customers/:id	GET	x	Obtém um customer

Download do projeto no Insomnia

Gateway para obtenção do token

Endpoint
https://accounts.seguros.vitta.com.br
URI	/auth/realms/careers/protocol/openid-connect/token
Method	POST
Header	Content-Type: application/x-www-form-urlencoded
Request	grant_type client_id client_secret username password scope
Response	DTO de resposta do token

DTO de resposta do token

Campos	Tipo
access_token	string
expires_in	number
refresh_expires_in	number
token_type	string
not-before-policy	number
scope	string
id_token	string

Diagrama BPMN com estratégias de obtenção de token

Descrição	Data de modificação	Versão	Link de download
Arquivo .excalidraw	12 de agosto de 2023	v1	Download
Arquivo .excalidraw	28 de agosto de 2023	v2	Download

Acima são apresentados 2 cenários:

Cenário 1: Necessidade de realizar uma transação por token, ideal para manter a transação mais segura.
Cenário 2: Necessidade da utilização de um token para multiplas transações.

No código atual, foi implementado a estratégia do cenário 1.

Diagrama de sequência de criação do customer

Endpoint para criar um customer na API

Endpoint
http://localhost:3000/api/v1
URI	/customers
Method	POST
Header	Content-Type: application/json Authorization: Bearer Token
Request body	document name
Response	HTTP 201 (Customer) HTTP 401 - não autorizado HTTP 400 - request inválida HTTP 502 - sso indisponível

Diagrama de sequência de atualização do customer

Endpoint para atualizar um customer na API

Endpoint
http://localhost:3000/api/v1
URI	/customers/:id
Method	PUT
Header	Content-Type: application/json Authorization: Bearer Token
Request params	id
Request body	document name
Response	HTTP 200 (Customer) HTTP 401 - não autorizado HTTP 400 - request inválida HTTP 204 - cliente inexistente HTTP 409 - conflito de ID HTTP 502 - sso indisponível

Observação 2: considerei em utilizar o status 204 e não o 404 quando não encontra um customer.

Diagrama de sequência de obtenção do customer

Endpoint para obter customer na API

Endpoint
http://localhost:3000/api/v1
URI	/customers/:id
Method	GET
Header	Content-Type: application/json Authorization: Bearer Token
Request params	id
Request body	N/A
Response	HTTP 200 (Customer) HTTP 401 - não autorizado HTTP 400 - request inválida HTTP 204 - cliente inexistente HTTP 502 - sso indisponível

Observação 2: considerei em utilizar o status 204 e não o 404 para quando tenta atualizar um customer.

Padronização de commits (Conventional Commits)

Flags utilizadas:

Flag	Descrição
fix	Correção de bug para o usuário.
feat	Desenvolvimento de uma nova funcionalidade.
docs	Alterações na documentação.
refactor	Refatoração de um bloco de código.
style	Formatação, falta de ponto e vírgula, etc.
perf	Uma mudança de código que melhora o desempenho.
build	Alterações que afetam o sistema de compilação ou dependências externas (escopos de exemplo: gulp e npm).
ci	Alterações em arquivos e scripts de configuração de CI (escopos de exemplo: Travis, Circle e Codeship).
test	Adicionando testes ausentes ou corrigindo testes existentes.

Como instalar e rodar o projeto

Pré-requisitos

NodeJs v18.12.1
Yarn 1.22.19
Docker version 24.0.5, build ced0996
docker-compose version 1.29.2, build 5becea4c

Passo a passo

Pacotes utilizados

yarn add agentkeepalive \
    amqplib \
    axios \
    axios-retry \
    dotenv \
    express \
    express-async-errors \
    helmet \
    ioredis \
    jsonwebtoken \
    mongoose \
    morgan \
    reflect-metadata \
    uuid \
    winston \
    winston-elasticsearch \
    yup \
    youch

# Development
yarn add @swc/cli \
    @swc/core \
    @swc/jest \
    @types/express \
    @types/jest \
    @types/amqplib \
    @types/jsonwebtoken \
    @types/morgan \
    @types/node \
    @types/uuid \
    @typescript-eslint/eslint-plugin \
    @typescript-eslint/parser \
    eslint \
    eslint-config-standard \
    eslint-plugin-import \
    eslint-plugin-n \
    eslint-plugin-promise \
    git-commit-msg-linter \
    husky \
    jest \
    lint-staged \
    npm-run-all \
    ts-jest \
    ts-node-dev \
    tsconfig-paths \
    tscpaths \
    kafkajs \
    typescript -D

Development

# Passo 1: Clona o repositório
git clone https://github.com/venzel/customer-clean-architecture.git

# Passo 2: Acessa a pasta do repositório clonado
cd customer-clean-architecture

# Passo 3: Cria o arquivo .env e edita
# Atenção 1: Não esquecer de preencher todas as variáveis no arquivo .env que será criado
cp -r .env-example .env

# Passo 4: Instala os pacotes
yarn install

# Passo 5: Sobe os containers do docker e roda o server
yarn dev

# Verifica se a api subiu corretamente no docker
docker logs customer-dev-api

Logs de inicialização da API

----------------------------------------
CUSTOMER-API
v1.0.0
----------------------------------------
Carregando variáveis de ambiente...
[ok] api.name -> customer-dev-api
[ok] api.ambient -> development
[ok] api.port -> 3000
[ok] api.tokenSecret -> ...
[ok] mongodb.host -> customer-dev-api-mongodb
[ok] mongodb.port -> 27017
[ok] mongodb.user -> customer
[ok] mongodb.password -> customer
[ok] mongodb.name -> customer
[ok] redis.host -> customer-dev-api-redis
[ok] redis.port -> 6379
[ok] redis.keyPrefix -> customer
[ok] redis.password -> customer
[ok] axios.retryQtty -> 20
[ok] axios.baseDelay -> 1000
[ok] axios.maxDelay -> 3000
[ok] agentKeepAlive.maxSockets -> 2000
[ok] agentKeepAlive.maxFreeSockets -> 20
[ok] agentKeepAlive.timeout -> 60000
[ok] agentKeepAlive.freeSocketTimeout -> 30000
[ok] vitta.baseUrl -> ...
[ok] vitta.grantType -> ...
[ok] vitta.clientId -> ...
[ok] vitta.username -> ...
[ok] vitta.password -> ...
[ok] vitta.scope -> ...
[ok] strategy.token -> nocache
----------------------------------------
Tentando conexão com o mongodb...
[ok] Banco de dados conectado na porta 27017
----------------------------------------
Carregando rotas...

CUSTOMERS
[ok] /customers (POST) (AUTH NO)
[ok] /customers:id (PUT) (AUTH NO)
[ok] /customers:id (GET) (AUTH NO)

HEALTHZ
[ok] /healthz (GET) (AUTH NO)
----------------------------------------
Escutando na porta 3000
----------------------------------------

Testes de unidade

Como rodar os testes

yarn teste

Alias do Makefile

# Cria o build
make build

# Roda os testes
make test

# Subir o ambiente de dev
make dev

# Add, Commit e Push na main
make ammend

_{Made with 💙 by Enéas Almeida}

Name		Name	Last commit message	Last commit date
Latest commit History 77 Commits
.docker/mongodb/entrypoints		.docker/mongodb/entrypoints
media		media
src		src
.dockerignore		.dockerignore
.env-example		.env-example
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.lintstagedrc.json		.lintstagedrc.json
.swcrc		.swcrc
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
docker-compose.yml		docker-compose.yml
jest.config.js		jest.config.js
package.json		package.json
tsconfig.json		tsconfig.json
yarn-error.log		yarn-error.log
yarn.lock		yarn.lock

License

venzel/customer-clean-architecture

Folders and files

Latest commit

History

Repository files navigation