Resolução do desafio backend junior - Kaio Felipe Nink Cardoso

[kaio-nink]

Foram realizadas as etapas necessárias para completar o desafio corretamente. Além disso, foram realizadas melhorias para garantir uma melhor estruturação do projeto e separação de responsabilidades por meio dos seguintes diretórios:

Utils:
Funções utilitárias do projeto, sendo elas:
String Util: validação de email e de string vazia
Errors: classes de erros (BadRequestError e NotFoundError), utilizados para garantir responses adequadas em casos de falhas na API.

Repositories:
Utilização do Repository Pattern para promover a comunicação com o banco de dados. No projeto consta os seguintes repositories com as respectivas funcionalidades:

• UserRepository: create (cadastra um usuário), get (busca um usuário pelo email) e getById (busca um usuário pelo email)
• PostRepository: create (cadastra um post)

Vale ressaltar que a criação do DataSource do TypeORM foi movida para o arquivo data-source.ts a fim de isolar a funcionalidade e garantir a melhor reutilização de código nos repositories.

Services:
Agregam as regras de negócio necessárias para a correta criação de usuários e posts, ao chamarem os repositories necessários no processo. O projeto possui os seguintes services com as respectivas funcionalidades:

• UserService: createUser (cria um usuário caso não possua um registro com o mesmo email)
• PostService: createPost (cria um post caso o userId informado pertença a algum usuário cadastrado no banco)

Controllers:
Preparam os dados da requisição a serem enviados para os services. Realiza também o tratamento de errors e retorna a response com status adequado para cada situação. O UserController e o PostController possuem o método store.

DTOS
Foram utilizados Data Transfer Objects a fim de preparar os dados enviados (UserDTO e PostDTO) e retornados (UserResponseDTO e PostResponseDTO). OS DTOS são gerados nos controllers, de forma que as validações de email e de campos obrigatórios são realizadas antes da criação dos objetos.

Factories:
Foram adicionadas factories para auxiliar e organizar a criação dos controllers, agrupando assim as dependências necessárias destas classes. As instâncias são geradas no arquivo index.ts e passados para os endpoints /users e /post com as respectivas chamadas do método do controller.

Config:
Apresenta o arquivo env.ts, utilizado para uma melhor chamada das variáveis de ambiente presentes no projeto ou de um valor padrão passado por parâmetro.

De modo geral, o projeto possui o seguinte fluxo de execução:

Para mais detalhes do projeto, é possível acompanhar as PR's criadas durante o desenvolvimento do projeto clicando aqui.