Arquitetura de micro serviços em Node.js + MongoDB: Parte 4

E chegamos à quarta parte da nossa série de artigos sobre como implementar na prática um projeto de sistema usando arquitetura de microservices usando Node.js e MongoDB.

Na primeira parte desta série eu dei uma introdução teórica sobre microservices, além de falar do propósito de usar Node e Mongo, apresentando nosso case que é ‘digno de cinema’. 😉

Na segunda parte, começamos a estruturar nosso projeto e preparamos toda a camada de dados e testes unitários do primeiro micro serviço.

Na terceira parte, finalizamos o desenvolvimento do primeiro micro serviço, o movies-service, que nos forneceu acesso a três chamadas:

  • /movies: traz todos filmes;
  • /movies/premieres: traz todos lançamentos;
  • /movies/{id}: traz um filme por id;

Nesta quarta parte, conforme o trecho abaixo do case, vamos construir o microservice cinema-catalog-service, aproveitando bastante da expertise que obtivemos com o micro serviço anterior. A ideia é que este serviço receba a requisição do front-end e providencie o restante, inclusive chamando o movies-service quando necessário.

Consulta de Lançamentos do Cinema
Consulta de Lançamentos do Cinema

Veremos nesta etapa da série:

  1. Estruturando o Micro Serviço
  2. Modelando o banco de dados
  3. Subindo o banco e conectando
  4. Iniciando o Repositório

Então mãos à obra!

Curso Node.js e MongoDB
Curso Node.js e MongoDB

#1 – Estruturando o Micro Serviço

 

Este microservice chamado cinema-catalog-service deve ser uma pasta dentro do seu projeto cinema-microservice. No seu terminal, navegue até a pasta src com ‘cd’ e depois use o comando ‘npm init’ para gerar o packages.json e adicione o script ‘start’ nele para facilitar nossas execuções depois, deixando-o como abaixo.

Na sequência, crie pastas e arquivos para ficar com a seguinte configuração abaixo:

  • cinema-microservice
    • cinema-catalog-service
      • data
      • src
        • api
          • cinema-catalog.js
          • cinema-catalog.test.js
        • config
          • mongodb.js
          • mongodb.test.js
        • repository
          • repository.js
          • repository.test.js
        • server
          • server.js
          • server.test.js
        • index.js
        • index.test.js
        • packages.json
        • .env
        • .env.example

Lembrando que na pasta data você deve apontar o seu banco de dados quando criarmos ele.

Aproveite este momento de configuração para rodar o comando abaixo no terminal (dentro da pasta src) para instalar as dependências que vamos precisar:

Alguns dos arquivos acima nós vamos conseguir aproveitar do outro micro serviço. Sim, nós copiaremos alguns arquivos na cara dura. Essa é uma atitude bem polêmica dentro da engenharia de software mas perfeitamente natural sob a ótica da arquitetura de micro serviços.

Copie os seguintes arquivos do outro microservice para este:

  • /config/mongodb.js
  • /config/mongodb.test.js
  • /server/server.js
  • /server/server.test.js
  • /.env.example

Mesmo os demais arquivos não sendo copiados na íntegra, aproveitaremos e muito a lógica deles, como você verá mais tarde.

#2 – Modelando o Banco de Dados

Vamos voltar a falar de banco de dados?

Isso porque cada microservice deve ter a sua própria base de dados, para garantir sua independência dos demais. No caso do movies-service, o banco armazena os dados dos filmes. No caso deste cinema-catalog-service, o banco armazenará os dados das salas de cinema da rede.

O domínio deste banco de dados são as seguintes informações:

  • id da cidade;
  • nome da cidade;
  • uf da cidade (sigla string);
  • código do país (duas letras, opcional, caso seja uma rede internacional);
  • cinemas da cidade;
    • id do cinema;
    • nome do cinema (geralmente nome da rede + nome do shopping);
    • salas de cinema;
      • nome da sala (numérico simples);
      • sessões;
        • data e hora (date);
        • id do filme (referente ao banco de filmes);
        • nome do filme;
        • valor (decimal);
        • assentos;
          • número do assento;
          • disponível (booleano);

Note que já deixei a modelagem desse banco meio tendenciosa com a indentação acima, mas vale alguma discussão do porquê desta estrutura. Primeiro, lembre-se que o objetivo deste banco é fornecer os dados das salas de cinema de uma cidade, fornecendo a agenda e disponibilidade das mesmas, para que o app de cinema permita essas consultas.

Segundo, temos uma série de típicas relações aqui:

  • cada país tem N estados (1-N);
  • cada estado tem N cidades (1-N);
  • cada cidade tem N cinemas (1-N);
  • cada cinema tem N salas (1-N);
  • cada sala de cinema tem N sessões (1-N);
  • cada sessão tem N assentos (1-N);
  • cada sessão tem 1 filme (1-1);

Note que em um banco relacional típico, seguindo todas as Formas Normais, teríamos 6 tabelas e 7 relacionamentos. Em MongoDB e mais ainda, em um micro serviço com foco na entrega de informações de salas de cinema, não há a necessidade de quebrarmos em tantas divisões assim. Isso porque a forma como este banco será consultado é bem específica: um usuário irá passar (de forma automática ou manual) a informação da sua cidade para saber as salas de cinema e suas sessões.

Dentro desse contexto, nossa chave com certeza é a informação da cidade e, a partir daí, desenrolamos o restante das informações na proporção de 1-N. Se a informação de cidade por si só não agrega informação ao sistema, ela tranquilamente pode estar atrelada diretamente às demais informações. Caso ela tivesse relevância, seria não apenas o caso de ser outra coleção mas sim outro microservice, focado em locais, certo?

Sendo assim, temos o seguinte schema (que facilmente pode ser modificado depois, afinal estamos falando de MongoDB):

Algumas informações são nomes, como o nome dos filmes, que vamos “repetir” aqui em relação à informação original que fica no outro micro serviço e consequentemente no outro banco de dados. Em bancos relacionais, garantimos a integridade desta informação através da segregação da mesma em uma tabela separada e chaves estrangeiras, no entanto, isso deixa a informação mais custosa de ser obtida de volta (os famosos JOINs).

Assim, em uma abordagem não-relacional deixamos a responsabilidade de garantir a integridade dos nomes para a aplicação. No caso dos nomes dos filmes disponíveis nas sessões, replicamos esta informação para que em listagens simples não seja necessário pedir ao outro microservice, assim, somente temos de ir no movies-service em caso de pegar detalhes de um filme, caso em que usaremos o id do mesmo (que deve ser igual entre todas bases que fizerem referências a filmes). Essa responsabilidade de integridade do nome dos filmes inclusive deve ser uma preocupação nos casos em que o nome tenha de ser atualizado por algum motivo, pois assim ele deverá ser atualizado em mais de um banco, o que gerará mais transtorno do que o normal, mas não é impossível (é o preço que se paga por facilidade nas consultas).

Relações 1-N de entidades simples, como assentos, podem facilmente ser substituídas por campos multivalorados (arrays) e mesmo entidades mais complexas, mas que não fazem sentido existirem de maneira independente, são arrays de subdocumentos.

Uma regra boa de decidir se um documento deve existir de maneira independente como outra coleção ou se deve ser um subdocumento de outro já existente é se lembrar dos conceitos de Agregação e Composição da Orientação à Objetos. Se o objeto seria uma agregação, ou seja, existe de mesmo que o objeto “pai” seja destruído, ele deve ser de outra coleção no MongoDB, caso contrário, faça-o ser um subdocumento do documento “pai”.

E com isso, temos o nosso banco modelado de maneira adequado à forma como ele será utilizado neste micro serviço. Obviamente existem dezenas, se não centenas, de formas diferentes de modelar este banco, mas já temos um bom começo!

Curso Node.js e MongoDB
Curso Node.js e MongoDB

#3 – Subindo o banco e conectando

 

Agora que definimos o schema com o qual iremos trabalhar, vamos subir nossa instância de banco de dados, lembrando que localmente devemos usar outra porta que não a 27017 para não dar conflito com o banco do outro microserviço. Sendo assim, suba sua instância de mongod com o comando abaixo (considerando que o seu terminal está apontando para a pasta bin do MongoDB):

Note que no Windows você apenas digita ‘mongod’ (sem o ./ no início) e que nesse SO o seu caminho até a pasta ‘data’ irá iniciar com ‘C:\’ou equivalente, preenchendo todo o caminho até chegar na pasta ‘data’ dentro de cinema-catalog-service.

Agora que temos a instância de MongoDB deste microservice funcionando, vamos nos conectar nele através do utilitário ‘mongo’ passando a porta correta:

E depois vamos nos conectar no novo banco que deve ser criado:

Para em seguida podermos adicionar uma carga de dados, como abaixo (essa carga de dados encontra-se no zip do projeto, na pasta ‘config’, que você pode baixar no final deste post). Antes de você copiar e colar o trecho abaixo no seu console, preste muita atenção aos campos ‘idFilme’, substitua o ObjectId passado ali pelo ObjectId do banco movies-service do seu outro microservice:

Agora que temos dados populados na nossa coleção ‘cinemas’, vamos configurar nosso arquivo de variáveis de ambiente, .env, para apontar a string de conexão do módulo mongodb.js para a instância de servidor correta:

Note que defini a porta do servidor de Mongo para 27018, e que já aproveitei para deixar a variável de porta do Express já definida como 3001, visto que a 3000 está ocupada com o movies-service.

Será que nosso mongodb.js já está funcionando com o novo banco? Que tal rodarmos os testes unitários que possuímos para ele?

Crie na raiz do seu projeto o arquivo index.test.js com o seguinte conteúdo dentro:

Note que já coloquei os testes do módulo server também, já que a porta dele está configurada no .env também. E em nosso package.json, ajuste o script de test para apontar para nosso índice de testes, como abaixo:

Agora no seu terminal, navegue até a pasta src do projeto e rode um ‘npm test’ para ver o resultado dos nossos testes:

MongoDB e Server OK
MongoDB e Server OK

Assim, já temos a garantia que dois dos nossos módulos básicos já estão funcionando!

#4 – Iniciando o Repositório

Agora que temos o banco de dados e o servidor, que tal programarmos o repositório? Mas que funções precisaremos ter nele?

Isso depende do poder que queremos dar aos nossos usuários no front-end. Que tal começarmos com as possibilidades abaixo?

  • pesquisar cidades em que a rede possui cinema;
  • pesquisar cinemas por id da cidade;
  • pesquisar filmes disponíveis em um cinema;
  • pesquisar filmes disponíveis em uma cidade;
  • pesquisar sessões disponíveis para um filme em uma cidade;
  • pesquisar sessões disponíveis para um filme em um cinema;

Com isso, habilitaremos uma usabilidade potencialmente boa para quem for consumir nossa API. Sendo assim abra o seu arquivo cinema-catalog-service/src/repository/repository.js e adicione as três funções mais simples de todas: getAllCities, getCinemasByCityId e disconnect, sendo que esta última é opcional, só serve para os testes unitários:

Note que não há nada demais nas funções acima que mereçam grandes explicações. Na primeira função usei um projeção, que talvez seja algo novo para você: no segundo parâmetro do find podemos passar quais campos que queremos retornar na consulta, sendo que o padrão é retornar todos (equivalente a um ‘SELECT *’).

Já na segunda função ao invés de jogar o callback diretamente no toArray eu optei por tratá-lo melhor, passando adiante apenas o array de cinemas ao invés do documento inteiro de cidade, facilitando a vida de quem for consumir esta função mais tarde.

Vamos escrever os testes unitários destas três funções?

Crie um arquivo /cinema-microservice/cinema-catalog/src/repository/repository.test.js e coloque o seguinte código de teste dentro dele:

Se você fez toda o microservice anterior à este (o movies-service), já deve estar ‘careca’ de saber como funcionam os testes unitários via Tape. Aqui não há nada de diferente do que já fizemos na outra ocasião, apenas atente ao fato de que deixei uma variável movieId sem uso neste momento, mas que precisaremos mais tarde.

Para poder rodar este teste, vamos adicioná-lo no nosso index.test.js como manda o trecho abaixo:

Isso lhe permitirá testar o que fizemos até agora do repository.js com o comando ‘npm test’.

Se tudo deu certo você deve ter recebido mensagens positivas nos testes e agora é hora de criar as funções mais avançadas do nosso repositório, que nos exigirão uma série de conceitos novos, principalmente de agregações em MongoDB.

Mas isso fica para a parte 5 da série!

Curtiu o post? Então clica no banner abaixo e dá uma conferida no meu livro sobre programação web com Node.js!

Arquitetura de micro serviços em Node.js + MongoDB: Parte 3

E chegamos à terceira parte da nossa série de artigos sobre como implementar na prática um projeto de sistema usando arquitetura de microservices usando Node.js e MongoDB.

Na primeira parte desta série eu dei uma introdução teórica sobre microservices e porque você deveria estar olhando para esta arquitetura e principalmente para as tecnologias Node e Mongo para implementá-la. Finalizei este artigo dando um case de exemplo que usaríamos para desenvolvimento ao longo dos outros artigos.

Na segunda parte, começamos a estruturar nosso projeto, definindo camadas, serviços e responsabilidades. Na sequência modelamos o nosso banco de dados, criamos o módulo de conexão e o módulo de acesso a dados (repositório), tudo isso usando configurações através de variáveis de ambiente (com dotenv-safe) e testes unitários com Tape.

Nesta terceira parte vamos finalmente finalizar o desenvolvimento do nosso primeiro microservice, o movie-service, que fornecerá acesso a consultas de filmes por ID, filmes que são lançamento e todos os filmes de maneira genérica. Lembrando que este serviço será utilizado por outro que fará a interface com a aplicação propriamente dita, como ilustrado pelo diagrama abaixo.

Consulta de Lançamentos do Cinema
Consulta de Lançamentos do Cinema

Veremos neste artigo:

  1. Programando o servidor
  2. Programando a API
  3. Programando o Index

Então mãos à obra!

Curso Node.js e MongoDB
Curso Node.js e MongoDB

#1- Programando o servidor

Agora é hora de programarmos os comportamentos da nossa API, mas antes disso precisamos construir nosso servidor.

Qualquer um que já leu alguma coisa a respeito na Internet sabe que este é o ponto forte do Node.js. É possível construir servidores web muito facilmente com Node a partir de 12 linhas de código.

Como cada micro serviço deve rodar standalone, sem depender de outros, é extremamente interessante que cada um tenha o seu próprio módulo de server.js para ser instanciado isoladamente.

O conteúdo do server.js pode ser visto abaixo:

Este servidor é genérico e simples, com uma função para iniciá-lo e outra para encerrá-lo. Ele usa o pacote morgan para logging de requisições no terminal/console e o helmet para garantir a proteção contra 11 ataques diferentes que sua API pode sofrer quando ir para produção e estar à mercê de hackers.

A função start espera a api, que vamos construir na sequência, o repositório, que já construímos e um callback que é disparado após a inicialização do servidor ser concluída. A api em si é que faz a magia de definição e tratamento das requisições em rotas específicas, tal qual já fizemos em outros tutoriais de Express aqui do blog.

Seguindo a nossa linha de ter unit tests para cada módulo do nosso projeto, vamos criar dentro da pasta cinema-microservice/movies-service/src/server um arquivo server.test.js contendo os testes abaixo:

Nestes testes nós iniciaremos o servidor usando uma API mockada (fake) e depois encerraremos este mesmo servidor. Bem simples, apenas para saber se ele está de fato subindo e sendo encerrado com sucesso.

Você pode rodar este teste isoladamente executando este arquivo com o comando ‘node server.test’ ou então adicionar uma nova linha no nosso índice de testes:

E com isso você já consegue garantir também que nosso servidor está funcionando, rodando um ‘npm test’ no console e vendo os resultados de todos os testes criados até o momento.

Testes de Servidor Ok
Testes de Servidor Ok

E agora, vamos finalmente criar a API em si?

Curso Node.js e MongoDB
Curso Node.js e MongoDB

#2 – Programando a API

 

Agora que temos o banco de dados, o repositório, o servidor e uma bateria de unit tests garantindo que tudo está funcionando como deveria, é hora de programarmos a API.

Na arquitetura desenhada até o momento, temos o arcabouço de servidor que espera que seja plugado um repositório e uma API. O repositório já temos pronto e a API vamos criar agora, dentro do que o servidor espera.

Para isso, dentro da pasta cinema-microservice/movies-service/src/api, crie um arquivo movies.js com o conteúdo abaixo:

Note que uma vez que grande parte do trabalho já foi segregado em outros módulos, coube ao módulo da API em si uma responsabilidade bem específica e ao mesmo tempo pequena, que é o tratamento das requisições.

Para garantir que esta nossa API está funcionando, vamos criar um movies.test.js na mesma pasta api para criarmos os testes abaixo:

Esse arquivo de teste ficou bem complicado, afinal, para conseguir testar nossa API temos de subir um servidor, conectar o repositório ao banco e usar uma biblioteca chamada supertest (não esqueça de rodar um NPM install) para simular as chamadas HTTP e com isso verificar se tudo está sendo retornado nos três endpoints como deveria.

Para garantir que os testes só vão rodar após o servidor ter subido, coloquei os testes dentro do callback do server.listen. Não vou entrar em detalhes do supertest aqui pois já falei dele no post de TDD em Node. Adicione mais uma linha no arquivo index.test.js e rode com um npm test para ver o resultado com seus próprio olhos.

API Ok
API Ok

Agora que temos a nossa API pronta e funcionando, vamos atar tudo no arquivo index.js do projeto movies-service.

#3 – Programando o Index

Como última etapa para fazer a nossa API de filmes funcionar, temos de orquestrar todos os módulos que compõem a API no arquivo index.js, pois é ele que será chamado para startar o nosso microsserviço quando colocarmos ele em um servidor (preferencialmente em um container Docker, mas isso é outra história).

Na verdade, uma vez que chegamos até aqui, com essa quantidade de testes e arquitetura de micro serviços bem definida, o index.js ficará tão simples quanto abaixo:

Se você duvida que é apenas isso, experimente rodar este index através de ‘node index’ ou ‘npm start’ e você vai poder testar, seja via POSTMAN ou diretamente no navegador mesmo.

Api funcionando no navegador
Api funcionando no navegador

Algumas boas práticas relacionadas a construção de APIs RESTful podem ser encontradas neste ótimo post (em inglês), mas te garanto que com esse basicão que vimos aqui você já está bem preparado para construir coisas mais poderosas e em cenários reais.

E não se preocupe, com o que lhe mostrei neste artigo conseguimos concluir apenas o primeiro microservice do nosso sistema completo. Quero que no mínimo consigamos avançar para o funcionamento do segundo microservice para fazer o fluxo básico de consultar filmes em cartaz em um cinema específico de uma cidade.

Mas isso fica para o próximo post da série!

Curtiu o post? Então clica no banner abaixo e dá uma conferida no meu livro sobre programação web com Node.js!

Arquitetura de micro serviços em Node.js + MongoDB: Parte 2

No primeiro artigo desta série eu fiz um resumão do porque escolher uma arquitetura de micro serviços para seus sistemas vale a pena, quais as vantagens do modelo e indiquei Node e Mongo como uma dupla de tecnologias a serem consideradas para este tipo de abordagem. Finalizei o artigo passado explicando a arquitetura de um case de exemplo envolvendo um sistema para uma rede de cinemas.

Neste artigo continuaremos a série, mas desta vez colocando a mão na massa: organizaremos a estrutura padrão que será usada em nossos microservices, construiremos o primeiro deles e modelaremos o seu banco de dados.

Veremos neste artigo:

  1. Organizando a arquitetura
  2. Organizando os dados
  3. Conectando o banco
  4. Consultando o banco

Então vamos lá!

Curso Node.js e MongoDB
Curso Node.js e MongoDB

#1 – Organizando a arquitetura

 

Relembrando rapidamente o primeiro cenário de uso da nossa arquitetura de microservices:

Consulta de Lançamentos do Cinema
Consulta de Lançamentos do Cinema

Neste cenário, iniciaremos nosso desenvolvimento com o microservice MOVIES e sua respectiva database. Cabe a esse serviço fornecer informações referentes ao catálogo de filmes cujos direitos de exibição foram comprados pela rede. Além do CRUD básico, espera-se deste serviço que seja possível saber quais filmes são os lançamentos da rede, basicamente os que entraram nos últimos 30 dias, que é mais ou menos a duração do status de lançamento de um filme.

Para estruturar este projeto como um todo, crie uma pasta central chamada cinema-microservice. Dentro dela colocaremos todos os microservices e dados dos mesmos, divididos em subpastas, por uma questão de organização, como mostra a hierarquia de pastas abaixo.

  • cinema-microservice
    • movies-service
      • data
      • src
    • cinema-catalog-service
      • data
      • src

Obviamente quando fizermos o deploy dos mesmos, eles serão feitos de maneira independente, mas por uma questão de organização do projeto e do repositório se você vier a versionar este projeto, faz sentido agrupá-los desta forma. Apenas lembre-se de não versionar as pastas de dados e a node_modules de cada microservice, adicionando os respectivos caminhos no seu .gitignore.

Dentro da subpasta movies-service, que é a que vamos focar neste artigo, temos as pastas data e src. Na pasta data armazenaremos os dados do nosso banco MongoDB (basta apontar o dbpath para cá na inicialização do banco) deste microservice. Já na pasta src armazenaremos os códigos-fonte do mesmo.

Dentro da pasta src teremos a seguinte estrutura de pastas e arquivos, em todos os nossos microservices a partir deste aqui:

  • movies-service
    • src
      • api
      • config
      • repository
      • server
      • index.js
      • packages.json

Os arquivos index.js e packages.json são auto-explicativos no cenário de uma webapi em Node.js. Na pasta api teremos os módulos das rotas deste microservice. Na pasta config, os módulos de configuração e de acesso básico a dados (MongoDB cru). Na pasta repository nós teremos módulos seguindo o pattern Repository, uma versão mais “NoSQL” do pattern DAO (Data Access Object, focado em SQL).

E basicamente esta é a estrutura, agora vamos aos dados!

#2 – Organizando os dados

Como estamos focando no microservice MOVIES, nossa base de dados será bem tranquila pois teremos apenas uma coleção de documentos com todos os filmes dentro. Obviamente se você não está acostumado com modelagem de dados em MongoDB (se é que modelagem é o termo correto aqui), sugiro a série de artigos MongoDB para iniciantes em NoSQL e até mesmo o meu livro de MongoDB.

Nossos filmes possuem a seguinte informação:

  • identificador único
  • título
  • duração (em minutos)
  • imagem (capa promocional)
  • sinopse
  • data de lançamento
  • categorias (ação, romance, etc)

Obviamente você deve imaginar que poderíamos ter muitas outras informações aqui como faixa etária, trailer, formato de tela, idioma, etc. Vou ficar só com essas por uma questão de simplicidade.

Em um banco relacional tradicional, como isso seria modelado? Algumas colunas da suposta tabela Filmes são bem óbvias como ID, Titulo, Duracao, Sinopse e DataLancamento. Mas e o campo imagem? Apesar dos bancos SQL suportarem BLOBs, nunca foi uma boa opção por pesar demais nos SELECTs e no crescimento do banco como um todo. No entanto, o mesmo não pode ser dito do MongoDB, onde podemos ter campos binários facilmente sem abrir mão da performance. Ainda assim entenderei se você decidir por armazenar apenas a URL da imagem em uma URL pública (AWS S3?).

Mas o que eu queria falar mesmo era das categorias. Esta é uma relação que pelas formas normais  e levando muito a sério a não-repetição dos dados deveria ser N-N com 3 tabelas: uma Filmes, outra Categorias e a terceira CategoriaFilmes apenas com chaves-estrangeiras para as duas primeiras. No entanto, esta não é a abordagem sugerida para o MongoDB. Aqui até podemos ter uma coleção de documentos Categorias, se necessária, mas a abordagem mais comum é usar um campo multivalorado no documento de filme contendo as categorias do mesmo. Simples assim.

Obviamente você deve se preocupar em garantir que as categorias sejam escritas sempre da mesma forma, a nível de aplicação, caso contrário será terrível filtrar por elas mais tarde. Enfim, nossa coleção de Filmes possuirá documentos com a seguinte estrutura:

Para subir o banco de dados do nosso microservice, apenas use uma instância do mongod apontando o dbpath para a pasta data dentro de cinema-microservice/movies-service/data. Obviamente em produção você terá uma abordagem diferente, mas ainda de um banco para cada microservice.

Curso Node.js e MongoDB
Curso Node.js e MongoDB

#3 – Conectando o banco

 

Agora que temos o modelo do nosso banco pronto e a estrutura de pastas organizada, vamos começar a programar nosso primeiro microservice.

Vamos começar acessando a pasta do nosso movie-service/src via terminal, criando um arquivo index.js na raiz desta pasta e usando o comando ‘npm init’ nela que é para criar o package.json do microservice. Depois, rode o comando abaixo pra garantir que teremos as nossas dependências mínimas garantidas.

Tem várias coisas que devemos fazer e não há necessariamente uma ordem certa para que elas funcionem. O primeiro microservice será um pouco chato e demorado de fazer, mas conforme a gente for avançando pelos demais você irá pegando o jeito. Sendo assim, vou começar por algo que acho que é mais fácil de todo mundo entender, o acesso a dados.

Dentro da pasta movie-service/src/config vamos criar um arquivo mongodb.js, com o seguinte conteúdo dentro:

Note que esse arquivo mongodb.js espera que existam duas variáveis de ambiente com a string de conexão ao banco. Essas variáveis de ambiente devem ser definidas em um arquivo sem nome com a extensão ‘.env’ na raiz do movie-service/src/, sendo que o pacote dotenv-safe que instalamos anteriormente exige a existência de um ‘.env.example’ com a definição das variáveis de ambiente existentes.

Para nos certificarmos que este módulo está funcionando, vamos escrever um teste unitário para ele? Se você nunca ouviu falar em testes unitários antes, recomendo ler este post sobre TDD.

Na mesma pasta movie-service/src/config crie um arquivo mongodb.test.js e dentro escreva o seguinte código, que nada mais faz do que usar a biblioteca tape (que foi instalada anteriormente no nosso npm install) pra testar a conexão:

Como teremos muitos arquivos de teste diferentes em nossa aplicação, cada um em sua pasta, vamos criar na raiz de movie-service/src um index.test.js que vai indexar todos nossos testes, a começar por esse primeiro, como abaixo:

Note que também carreguei o módulo do dotenv-safe pois precisamos que as variáveis de ambiente estejam carregadas para que nossos testes funcionem.

Falando em funcionar, antes de rodar este teste abra o seu packages.json que fica na raiz de movie-service/src e edite-o para que os scripts de start e de test fiquem igual abaixo:

Se você rodar agora sua aplicação com o comando abaixo, o seu unit test deve ser executado. Caso seu banco esteja online, obviamente.

MongoDB - Testes OK
MongoDB – Testes OK

#4 – Consultando o banco

Agora que sabemos que nossa conexão com o banco funciona, vamos criar nosso módulo de repositório para que possamos fornecer os dados do MongoDB da maneira que as chamadas ao nosso serviço esperam.

Não vou fazer um CRUD completo aqui pois já abordei CRUDs de Node com Mongo em outras oportunidades aqui no blog, é só procurar. Dentro do nosso case de exemplo levarei em conta que precisamos implementar apenas o R (Read) para fornecer dados de filmes específicos (por id) e dos filmes que são lançamentos nos cinemas (lançados nos últimos 30 dias).

Para criar nosso módulo de repositório (que por sua vez usará o módulo mongodb.js) entre na pasta movie-service/src/repository e crie dois arquivos, o repository.js e o repository.test.js, sendo que o primeiro deve ter o conteúdo abaixo:

Aqui temos uma função para cada um dos três métodos elementares que precisamos ter na APi e uma última para desconectar o repositório do banco de dados, função esta que será usada em certas ocasiões como em testes unitários.

E no segundo arquivo, repository.test.js, colocamos os testes do primeiro, de maneira análoga ao que fizemos com o módulo mongodb.test.js:

E por fim, adicione mais uma linha em nosso movie-service/src/index.test.js para que rode também este novo módulo de teste:

Obviamente que estes últimos testes não passarão se você rodar um ‘npm test’ no terminal, mas isso porque nosso banco de dados não possui qualquer informação de filme, o que você pode resolver abrindo uma instância do utilitário ‘mongo’ no terminal (executando um use no banco ‘movie-service’) e inserindo o comando abaixo para adicionar uma carga de filmes:

Agora sim, ao rodar o ‘npm test’, seus testes unitários devem passar com sucesso:

Repository Tests - OK
Repository Tests – OK

Com estes testes todos passando, temos a certeza de que a parte do banco de dados da nossa futura API estará 100% operacional, cabendo agora programarmos a API em si, que irá trabalhar com estes dados que viemos “brincando” até então.

No entanto, a programação da API movie-service ficou para a terceira parte desta série de artigos!

Curtiu o post? Então clica no banner abaixo e dá uma conferida no meu livro sobre programação web com Node.js!