MyPoint

📜 Sobre

MyPoint é um sistema de registro de pontos de funcionários, utilizando filas com o RabbitMQ.
👉 MyPoint

Qual problema resolve?

O registro de ponto ocorre geralmente sempre aos mesmos horários por todos os funcionários de uma empresa, gerando um stress no servidor de banco de dados, com isso, a técnica de utilização de filas se enquandra como uma solução para resolver o devido problema.

👤 Autores

Foto	Nome	Ativo	Dt. inativo	Atribuições
	Enéas Almeida	🔥	-	Manager, Arquiteto, FullStack Developer

Etapas de desenvolvimento

Levantamento do problema a ser resolvido (Briefing);
Levantamento dos requisitos funcionais;
Definição da arquitetura utilizada;
Definição das tecnologias utilizadas;
Definição das atribuições e cronograma de estimativas no desenvolvimento das atividades;
Criação do diagrama de relacionamentos e testes de hipóteses;
Desenvolvimento da documentação e diagramas explicativos no Git;
Diagramação das telas (UX Design);
Configurações dos ambientes de QA e Produção;
Desenvolvimento do MVP.
10.1. Desenvolvimento da backend;
10.2. Desenvolvimento do frontend;
10.3. Integração do frontend com o backend.

⌛ Cronograma de estimativas no desenvolvimento das atividades

Atividade	Esforço (Fibonacci)	Finalizado?	Execução
Levantamento do problema a ser resolvido (Briefing)	3	🔥	100%
Levantamento dos requisitos funcionais	1	🔥	100%
Definição das tecnologias utilizadas	1	🔥	100%
Criação da documentação no Git	13	-	70%
Diagramação das telas (UX Design)	13	-	0%
Configuração do ambiente de QA e produção	5	-	0%
Desenvolvimento do backend	21	-	0%
Desenvolvimento do frontend	21	-	0%
Integração do backend com o frontend	21	-	0%

Significados dos esforços na escala Fibonacci

Esforço 1 - Representa >= 1 hora e <= 7 horas.
Esforço 3 - Representa > 21 horas e <= 35 horas.
Esforço 5 - Representa > 35 horas e <= 42 horas.
Esforço 13 - Representa > 49 horas e <= 70 horas.
Esforço 21 - Representam horas não determinadas.

👉 Mais sobre a metodologia de esforço Fibonacci

Backend

NestJs
RabbitMQ
Cognito (AWS)
Typescript / Javascript
TypeORM / Postgres / MongoDB
Testes com métricas de coverages (Jest)

👉 Link para a documentação no git do backend
👉 Link da documentação oficial do NestJs
👉 Link da documentação oficial do RabbitMQ

Persistência dos dados

Postgres
MongoDB

* Os bancos de dados são provenientes de containers do docker.

TypeORM

O TypeORM é um ORM que pode ser utilizado em plataformas como o Node, NestJs, dentre outras, e que possibilita o desenvolvimento tanto com JavaScript como com TypeScript. O TypeORM foi inspirado no Hibernate e Entity Framework, oferece suporte a Decorators e trabalha com bancos de dados como PostgreSQL, Microsoft SQL Server, e atualmente com MongoDB.

👉 Mais informações sobre o TypeORM na Medium
👉 Documentação oficial do TypeORM

Frontend

VueJs
Vuetify
Javascript

👉 Link para a documentação no git do frontend
👉 Link da documentação oficial do VueJs
👉 Link da documentação oficial do Vuetify

Backend/Frontend

Docker
Codeship (CI/CD)

👉 Link para a faq do Docker
👉 Link para a faq do Codeship

Infraestrutura

Nginx
PM2
Docker
Certbot

👉 Link para faq do Nginx
👉 Link para faq do PM2
👉 Link para faq do Docker
👉 Link para faq do Certbot

Recursos e técnicas utilizadas

Microserviços
Filas com RabbitMQ
Authorization/Authentication com o Cognito
Interceptors
Transformers
Validators
Captura de errors com o Sentry
Padronização de commits (Conventional commits)
Swagger
Upload
Padronização de código (Sonarlint)
Yarn como gerenciamento de pacotes
Makefile

Arquitetura

Descrição	Data de modificação	Versão	Link de download
Primeira versão do documento	01 de abril de 2022	v1	Download

👉 Link do arquivo no Lucidchart

Filas com o RabbitMQ

A utilização de filas permitem desacoplar vários componentes da aplicação.

Cada componente somente precisa se conectar ao broker, e pode permanecer sem necessidade de conhecer a existência, localização ou detalhes da implementação de outros componentes.

A única coisa que precisa ser compartilhada entre os componentes é o protocolo de mensagens.

👉 Documentação oficial do RabbitMQ
👉 Imagem oficial no Docker
👉 Tutorial de download do RabbitMQ

Um broker se divide em:

Broker Server: Processo do lado do servidor, responsável por gerenciar a publicação, assinatura e entrega das mensagens aos clientes.
Broker Client API: É disponibilizado em um package específico para cada linguagem (JavaScript, Java, Go, etc), fornecendo uma API para acessar o broker, a partir de aplicações clientes.

Modelo de comunicação entre Publishes/Subscribes

Modelo de comunicação entre Request/Response

Cognito (Autenticação e Autorização)

O Cognito é um serviço da Amazon fornece autenticação, autorização e gerenciamento de usuários para aplicações Web e móveis. Os usuários podem fazer login diretamente com um nome de usuário e uma senha ou por meio de terceiros, como o Facebook, a Amazon, o Google ou a Apple.

Como funciona o Cognito?

Etapa 1 - o usuário do aplicativo faz login por meio de um grupo de usuários e recebe tokens desse grupo após uma autenticação bem-sucedida;
Etapa 2 - Em seguida, a aplicação troca os tokens do grupo de usuários por credenciais da AWS por meio de um grupo de identidades;
Etapa 3 - Por fim, o usuário da aplicação pode usar essas credenciais para acessar rotas privadas da API.

👉 Mais informações sobre o Cognito

Estratégia de captura de erros com o Sentry

O Sentry é um serviço open source para logar erros da aplicação.

A aplicação é configurada para que sempre que ocorrer um erro do tipo 500, a exceção seja capturada e catalogada no Sentry, indicando exatamente a linha que ocorreu o erro, assim como dados de data e hora, tornando mais fácil a identificação de bugs, como mostra no exemplo abaixo:

👉 Mais informações sobre o Sentry
👉 Link oficial do serviço

Arquitetura do backend: Feature by Package

Feature by Package é uma arquitetura que utiliza conceitos do DDD (Domain Driven Design), com o objetivo de tornar o código mais flexível, escalável e de manutenção simples.

Vantagens da arquitetura

Manutenção: Facilita o engajamento de multiplas equipe e colaboradores em um projeto;
Escalável: Facilita refatoramento do código monolítico para uma uma estrura de microserviços;
SOLID: Facilita a aplicação de todos os princípios do SOLID;
Git: Melhora o gerenciamento dos commits, evitando conflitos e etc;
Testes: Facilita o desenvolvimento de testes de unidade e integração.

Diagrama de relacionamentos

Descrição	Data de modificação	Versão	Link de download
Segunda versão do documento	01 de abril de 2022	v2	Download

👉 Download do arquivo do Astah

DIAGRAMA DETALHADO

Descrição	Data de modificação	Versão	Link de download
Primeira versão do documento	04 de abril de 2022	v1	Download

👉 Download do arquivo do Astah

JSON

{
    "USERS": [
        {
            "id": 1,
            "name": "Vanessa"
        },
        {
            "id": 2,
            "name": "Tiago"
        }
    ],
    "POINTS": [
        {
            "id": 1,
            "user_id": 1,
            "point": "21-03-2022 13:34"
        },
        {
            "id": 2,
            "user_id": 2,
            "point": "21-03-2022 13:37"
        }
    ],
    "SCALES": [
        {
            "id": 100,
            "name": "Horário completo"
        },
        {
            "id": 200,
            "name": "Horário meio dia manhã"
        },
        {
            "id": 300,
            "name": "Horário meio dia Tarde"
        }
    ],
    "BREAKS": [
        {
            "id": 1,
            "scale_id": 100,
            "time_start": "08:00",
            "time_end": "12:00"
        },
        {
            "id": 2,
            "scale_id": 100,
            "time_start": "13:00",
            "time_end": "17:00"
        },
        {
            "id": 3,
            "scale_id": 200,
            "time_start": "08:00",
            "time_end": "12:00"
        },
        {
            "id": 4,
            "scale_id": 300,
            "time_start": "13:00",
            "time_end": "17:00"
        }
    ],
    "NOTIFICATIONS": [
        {
            "id": 1,
            "user_id": 1,
            "notification": "Vanessa efetuou uma marcação de ponto!",
            "created_at": "21-03-2022 13:34"
        },
        {
            "id": 1,
            "user_id": 2,
            "notification": "Tiago efetuou uma marcação de ponto!",
            "created_at": "21-03-2022 13:37"
        }
    ]
}

Endpoints do API Gateway (Proxy)

Path	Método	Token	Role	Descrição
USER
/account	GET		ALL	Efetua login
/account	POST		ALL	Cria um usuário
/password-recover	POST		ALL	Recupera a senha
/users	GET	🔥	ADMIN	Lista todos os usuários
/users/{id}	GET	🔥	ADMIN	Exibe um usuário
/users/{id}	DELETE	🔥	USER	Deleta um usuário
/users/{id}	PUT	🔥	USER	Edita um usuário
/user-status-toggler/{id}	PATCH	🔥	ADMIN	Altera o status do usuário
/find-user?name={name}...	GET	🔥	ADMIN	Busca por usuário
SCALE
/scales	GET	🔥	ADMIN	Lista as ecalas
/scales	POST	🔥	ADMIN	Cria uma escala
/scales/{id}	PUT	🔥	ADMIN	Altera uma escala
/scales/{id}	DELETE	🔥	ADMIN	Delete uma escala
/scales/{id}	GET	🔥	USER	Exibe uma escala
USER/SCALE
/manager-user-escale	GET	🔥	ADMIN	Lista usuários e ecalas
/manager-user-escale/{1}	UPDATE	🔥	ADMIN	Editar escalas do usuário
/manager-user-escale/{1}	DELETE	🔥	ADMIN	Deleta escala do usuário
POINT
/points	POST	🔥	USER	Cria um ponto
REPORT
/reports	GET	🔥	USER	Exibe o relatório

Endpoints da API Rest

Endponts do Frontend

Download do projeto do Insomnia

Swagger

O Swagger é um framework composto por diversas ferramentas que, independente da linguagem, auxilia a descrição, consumo e visualização de serviços de uma API REST.

👉 Link do Swagger de QA
👉 Link do Swagger de Produção
👉 Link oficial da documentação do Swagger

Diagrama de caso de uso

Descrição	Data de modificação	Versão	Link de download
Primeira versão do documento	03 de abril de 2022	v1	Download

👉 Download do arquivo do Astah

Requisitos funcionais

Usuário

O USUÁRIO/ADMIN deve poder efetuar o login/logout;
O USUÁRIO deve poder se cadastrar;
O USUÁRIO deve poder alterar seus dados (nome);
O USUÁRIO deve poder alterar sua senha;
O USUÁRIO/ADMIN deve poder recuperar sua senha;
O ADMIN deve poder visualizar os usuários do sistema;
O ADMIN deve poder deletar um usuário do sistema;
O ADMIN deve poder desabilitar/habilitar um usuário do sistema;
O ADMIN deve poder buscar por usuários de forma paginada.

Escala

O ADMIN deve poder listar as escalas;
O ADMIN deve poder cadastrar uma escala;
O ADMIN deve poder alterar uma escala;
O ADMIN deve poder deletar uma escala;
O USUÁRIO deve poder visulizar uma escala.

Usuário/Escala

O ADMIN deve poder visualizar uma listagem com usuários e escalas associadas;
O ADMIN deve poder associar uma usuário a uma escala;
O ADMIN deve poder desassociar um ou vários usuários a uma escala.

Usuário/Ponto

O USUÁRIO deve poder cadastrar um ponto.

Usuário/Relatório

O USUÁRIO deve poder gerar um relatório de pontos.

CI/CD

Gitflow

O Gitflow é um fluxo de trabalho que auxilia o desenvolvimento contínuo de software entre a equipe envolvida.

👉 Mais informações

Branchs

user - Envia commits apenas para o próprio user, exemplo: tiago-feature-21.
develop - Recebe merges dos users. (Ambiente de QA)
master 🔒 - Recebe merges da develop, no final de uma release. (Ambiente de produção)

Diretrizes

* A branch master 🔒 é bloqueada para receber commits de usuários.
* A branch master representa o software em produção.
* A branch develop representa o software em QA.
* Fica determinado que sempre que um merge request na branch develop for aprovado ou reprovado, a branch do usuário NÃO será deletada, a fim de manter o histórico de branchs.

👉 Documentação completa do gitflow - passo a passo

Padronização de commits (Conventional Commits)

Conventional Commits é uma convenção de mensagens de commits. Essa convenção descrevendo os recursos, correções e alterações importantes feitas nas mensagens.

Flags utilizadas:

Ícone	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.

Exemplos de commits utilizando a padronização

# Exemplo 1
git commit -m "🪲 fix: corrige bug da listagem de usuários."

# Exemplo 2
git commit -m "☂️ feat: cria o módulo de pontos."

👉 Mais informações

Lint com o Sonarlint

O Sonarlint é um plugin detector, em tempo real, de códigos mal escritos, que geram dificuldades de manutenção, bugs e vulnerabilidades. O SonarLint possui também as seguintes categoriazações de códigos: Minor, Major, Critical e Blocker.

👉 Mais informações

Prettier

O Prettier é um formatador de código que visa ajudar os desenvolvedores a escrever aplicações que são mais fáceis de entender e mais uniformizadas entre as diversas formas de programar que existem.

Arquivo .prettierrc na raiz do projeto.

{
    "semi": true,
    "tabWidth": 4,
    "printWidth": 90,
    "singleQuote": true,
    "trailingComma": "es5"
}

👉 Link oficial

Pipeline

O Codeship é um serviço de entrega contínua hospedado que se concentra na velocidade, confiabilidade e simplicidade. Em nossa arquitetura, o Codeship é integrado com o Github, ele identifica automaticamente quando um commit é realizado e dá sequência na entrega para os ambientes pré configurados, como demonstra na imagem abaixo:

👉 Link do arquivo no Lucidchart

Etapas

1 - Lint: Nessa etapa é verificada as regras do Sonarlint;
2 - Test: Nessa etapa é realizado os testes unitários;
3 - Build: Nessa etapa é realizado o build da aplicação.

Fontes de referências

👉 Curso na Udemy sobre NestJs, RabbitMQ e Cognito
👉 Curso na Udemy sobre VueJs e Vuetify
👉 Github privado sobre Vuetify
👉 Curso na Udemy sobre VueJs
👉 Artigo na Medium criando uma API Rest em NestJs
👉 Exemplo de uma API Rest NestJs de Autorização e Autenticação com JWT

Name		Name	Last commit message	Last commit date
Latest commit History 102 Commits
media		media
.gitignore		.gitignore
README.md		README.md

venzel/mypoint

Folders and files

Latest commit

History

Repository files navigation

MyPoint

📜 Sobre

Qual problema resolve?

👤 Autores

⚓ Links

Etapas de desenvolvimento

⌛ Cronograma de estimativas no desenvolvimento das atividades

Significados dos esforços na escala Fibonacci

Backend

Persistência dos dados

TypeORM

Frontend

Backend/Frontend

Infraestrutura

Recursos e técnicas utilizadas

Arquitetura

Filas com o RabbitMQ

Um broker se divide em:

Modelo de comunicação entre Publishes/Subscribes

Modelo de comunicação entre Request/Response

Cognito (Autenticação e Autorização)

Como funciona o Cognito?

Estratégia de captura de erros com o Sentry

Arquitetura do backend: Feature by Package

Vantagens da arquitetura

Diagrama de relacionamentos

Endpoints do API Gateway (Proxy)

Download do projeto do Insomnia

Swagger

Diagrama de caso de uso

Usuário

Escala

Usuário/Escala

Usuário/Ponto

Usuário/Relatório

CI/CD

Gitflow

Branchs

Diretrizes

Padronização de commits (Conventional Commits)

Flags utilizadas:

Exemplos de commits utilizando a padronização

Lint com o Sonarlint

Prettier

Pipeline

Etapas

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Packages