Crie um site de boletim informativo com a plataforma de dados MongoDB
Avalie esse Artigo
Please note: This article discusses Stitch. Stitch is now MongoDB Realm. All the same features and functionality, now with a new name. Learn more here. We will be updating this article in due course.
"Isto será simples", ocorreu. "Quão difícil isso pode ser?" Eu disse para mim mesmo, imprudentemente.
Registro de arranhão
Congelar quadro
Sim, desde logo. Você provavelmente está se perguntado como parei nessa situação.
Era uma vez uma pequena empresa, e essa pequena empresa tinha um boletim informativo interno para informar as pessoas sobre o que estava acontecendo. Como a empresa era pequena e todos estavam ocupados, optou-se pela abordagem mais simples e mínima, ou seja, um Google Doc que qualquer pessoa da equipe de Marketing pudesse atualizar quando houvesse notícias relevantes. Este sistema funcionou bem.
À medida que a empresa cresce, um Google Doc se tornou muitos Google Docs, e foi adicionado um e-mail automatizado que era enviado uma vez por semana para lembrar as pessoas de consultar os Docs. Agora, as coisas não eram tão simples. Talvez os Docs tenham sido atualizados, e talvez não, porque nem sempre ficou claro quem era o proprietário do que. As pessoas que receberam o e-mail apenas viam links para os Docs, sem indicação de se havia algo novo ou bom neles e, depois de um tempo, pararam de clicar, ou apenas o fizeram ocasionalmente. A pessoa que estava enviando os e-mails conseguiu um novo trabalho e pediu que alguém assumisse a administração da newsletter.
É aqui que eu entro. Sim, não consegui me esconder quando o chefe veio pedir voluntários.
Dei uma olhada no sistema existente e sabia que ele não poderia continuar como estava — então, é claro, também comecei a procurar idiotas, MEAN, voluntários. Infelizmente, não consegui encontrar ninguém que quisesse assumir a lavagem dessa cerca em particular, então comecei a tentar descobrir o quão difícil seria montar meu próprio sistema automatizado de lavagem de cercas para executar o back-end do boletim informativo.
Rapidamente eu tinha meu produto mínimo desejável, graças ao MongoDB Atlas e Stitch. E a melhor parte? A coisa toda se encaixa na camada grátis de ambos. Você pode obter sua própria instância gratuita para sempre aqui, apenas fornecendo seu endereço de e-mail. E, se você me pedir com jeito, posso até jogar alguns créditos grátis para que você experimente alguns dos recursos pagos também.
Se você ainda não configurou seu cluster gratuito no MongoDB Atlas, agora é um ótimo momento para fazer isso. Você tem todas as instruções nesta publicação no blog.
O primeiro Obstáculo deste projeto foi desaprenddo de mau hábitat de relacionamento. No mundo do relational database, um boletim informativo como esse provavelmente usaria vários JOINs:
- Uma tabela de problemas
- Contendo referências a uma tabela de notícias
- Contendo referências a outras tabelas de tópicos, autores
No mundo orientado a documentos, não fizemos dessa forma. Em vez disso, defini um formato de documento simples:
Essa estrutura deve ser bastante auto-explicativa. Cada item de notícias tem:
- Um título
- Texto descritivo
- Um link para mais informações
- Uma ou mais tags de tópico
- Além de alguns campos utilitários para fazer coisas como rastrear edições
Cada item faz parte de uma seção e pode ser publicado simplesmente na Web ou também por e-mail. Não quero enviar spam aos leitores com tudo, por isso o e-mail é selecionado; somente os itens com
email: true Go para o e-mail, enquanto todos os outros são exibidos no site, mas não nas caixas de entrada dos leitores.Um item a destacar é a array de atualizações, que está vazia neste exemplo específico. Esse campo foi adicionado posteriormente ao formato, pois percebi, quando criei a funcionalidade de edição, que seria bom rastrear quem fez as edições e quando. A flexibilidade do document model fazia com que eu pudesse simplesmente adicionar esse campo sem causar nenhuma alteração em cascata em outras partes do código, ou mesmo em documentos que já tinham sido criados no banco de dados.
Tanto para o final do banco de dados. Agora precisamos de algo para ler os documentos e fazer algo útil com eles.
Optei pelo Stitch, que junto com o banco de dados Atlas é outra parte da plataforma MongoDB Cloud. De acordo com a direção geral do projeto, o Stitch torna a minha vida superfácil ao lidar com coisas como autenticação, regras de acesso, queries do MongoDB, serviços e funções. É muito mais do que apenas um local conveniente para armazenar arquivos; usando o Stitch, deixe-me escrever o código em JavaScript, me forneceu um lugar fácil para hospedar a lógica do aplicativo e se conecta ao banco de dados MongoDB Atlas com uma única linha de código:
APP_ID é, é claro, o ID do meu aplicativo privado, que não vamos incluir aqui! Todo o código do aplicativo pode ser encontrado em meu repositório pessoal do Github; quase todas as funcionalidades (e todo o código dos exemplos abaixo) estão em um único arquivo Javascript.O boletim informativo é enviado em e-mail HTML e tem um site complementar, então meu aplicativo Stitch monta seções Dom em Javascript para exibir o boletim informativo. Não Go explicar todo o processo, mas cada etapa é mais ou menos assim:
Essa lógica mostra o benefício do modelo de objeto de documento no MongoDB.
currentNewsItem é um objeto em JavaScript que mapeia exatamente para o documento no MongoDB, e posso acessar os campos do documento simplesmente pelo nome, como em currentNewsItem.itemTitle. Não preciso criar uma representação de objeto totalmente separada em meu código e preenchê-la trabalhosamente com queries relacionais entre muitas tabelas diferentes de um banco de dados; Tenho exatamente a mesma representação de objeto no código e no banco de dados.Da mesma forma, inserir um novo item é simples porque posso criar um objeto JSON a partir de campos em um formulário da web:
E então posso escrever isso diretamente no banco de dados:
Há um pouco mais de feedback detalhado e tratamento de erros nesta parte do código do que em algumas outras partes do código, já que outras pessoas além de mim usam essa parte do aplicativo!
Tanto faz inserir notícias no banco de dados. E quando alguém quer, você sabe, ler uma edição do boletim informativo? A primeira coisa que preciso fazer é falar com o banco de dados do MongoDB Atlas e descobrir qual é o problema mais recente, onde um problema é definido como o conjunto de todas as notícias com a mesma data de publicação. O MongoDB tem um recurso chamado aggregation pipeline, que funciona um pouco como canalizar dados de um comando para outro em uma shell UNIX. Um pipeline de agregação tem vários estágios, cada um dos quais faz uma transformação nos dados de entrada e os passa para o próximo estágio. É uma ótima maneira de realizar queries mais complexas, como agrupar documentos, manipular arrays, remodelar documentos em diferentes modelos e assim por diante, mantendo cada etapa individual fácil de raciocinar e depurar.
No meu caso, usei um pipeline de agregação muito simples para recuperar as datas de publicação mais recentes no banco de dados, com três etapas. No primeiro estágio, usando $group, obtenho todas as datas de publicação. No segundo estágio, uso $match para remover quaisquer datas nulas, que correspondem a itens sem data de publicação, ou seja, itens não publicados. Finalmente, ordeno as datas, usando — você adivinhou — $sort para obter as datas mais recentes.
Desde que eu tenha uma lista de todas as datas de publicação, posso usar a próxima data mais recente para os controles de navegação que permitem que os leitores consultem as edições anteriores do boletim informativo. O uso mais importante, no entanto, é recuperar a questão atual, ou seja, a lista de todos os itens com a data de publicação mais recente. É o que o comando
find() faz e usa como argumento um documento simples:Em outras palavras, gostaria de todos os documentos publicados (não os rascunhos que estão na fila esperando para serem publicados) e em que a data de publicação seja a data mais recente que encontrou com o aggregation pipeline acima.
Essa referência a
orderSections é uma função utilitária que garante que as seções do boletim informativo saiam na ordem correta. Também posso detectar quaisquer erros que ocorram, seja no pipeline de agregação ou na própria operação de localização.Neste ponto, publicar um boletim informativo é uma questão de selecionar quais itens serão incluídos na edição e atualizar a data de publicação de todos esses itens:
- O primeiro, o filtro, especifica quais documentos atualizar, o que aqui significa todos os com um ID na array
itemsToPublish. - A segunda é a atualização real que vamos fazer, que é definir o
publishedDatepara a data de hoje e marcá-lo como publicado. - O terceiro argumento, opcional, está vazio no meu caso porque não preciso especificar nenhuma opção.
Agora eu mesmo poderia enviar e-mails do Stitch, mas já usamos um serviço especializado externo que tem uma boa REST API. Usei uma função de ponto para montar as chamadas HTTP e me comunicar com esse serviço externo. As funções do Stitch são uma maneira superfácil de executar funções JavaScript simples na plataforma sem servidor do Stitch, facilitando a implementação da lógica de aplicativos, a integração segura com serviços e microsserviços na nuvem e a criação de APIs - exatamente o meu caso de uso!
Configurei um HTTP Service simples, que posso acessar facilmente assim:
Como é comum, a REST API que deseja usar requer uma chave de API. Eu gerei a chave no site deles, mas não quero deixá-la por aí. Felizmente, o Stitch também me permite definir um segredo, então não preciso dessa chave API em texto simples:
E isso (além de 1200 mais linhas de casos especiais, funções administrativas, soluções alternativas e miscelânea) é isso. Mas eu queria um pouco mais de visibilidade sobre quais tópicos eram populares, quem estava usando o serviço e assim por diante. Como fazer isso?
Felizmente, há uma resposta lógica às minhas preces na forma de MongoDB Atlas Charts, outra parte da plataforma MongoDB cloud, que me permite criar rapidamente uma visualização da atividade no back-end.
Veja como isso é simples: Tenho meu banco de dados, imaginativamente denominado "newsletter", e a collection, denominada "atf" para Above the Fold, o nome do boletim informativo que herdei. Posso ver todos os campos do meu documento, de modo que posso usar o campo
_idpara o eixo X e, em seguida, ocreatedDate para o eixo Y, classificando por mês, para criar um gráfico em tempo real do número de notícias enviadas a cada mês.
É realmente muito fácil criar visualizações no Atlas Charts, incluindo as muito mais complicadas do que essa, usando todos os tipos de dados avançados do MongoDB. Dê uma olhada em algumas das opções mais avançadas e experimente com seus próprios dados ou com os dados de amostra em uma MongoDB Atlas gratuito.
Foi uma grande experiência de aprendizado construir essa coisa, e todo o exercício me renovou a visão do poder do MongoDB, do document model e da plataforma estendida do MongoDB Cloud - tanto o MongoDB Atlas quanto os serviços correlacionados, como Stitch e Atlas Charts. Também há espaço para expansão; uma das próximas funcionalidades que preciso construir é a de procurar, usando a funcionalidadede pesquisa de texto do MongoDB Atlas.
Como mencionei no início, uma das coisas boas desse projeto é que ele se encaixa na camada grátis do MongoDB Atlas, Stitch e Charts. Você pode se inscrever em sua própria instância gratuita para sempre e começar a criar hoje, nenhum cartão de crédito necessário e nenhuma data de expiração. Há um assistente de integração útil que orientará você no carregamento de alguns dados de exemplo e na execução de algumas tarefas básicas e, quando você estiver pronto para Go, os Docs serão de primeira, com muitos exemplos executados. Quando você entrar nele e quiser aprender mais, o melhor lugar para procurar é na MongoDB University, que lhe dá a oportunidade de aprender MongoDB no seu próprio passo. Você também pode obter a certificação no MongoDB, o que o incluirá em nossa lista pública de profissionais certificados no MongoDB.