nodejs-typescript-federated-graphql-boilerplate

A NodeJs / TypeScript application boilerplate with Federated 2 GraphQL.

• It contains a mechanism to pull all the data from an unpaginated Open Charge Map API.
• It uses MongoDB as a persistent database layer with Mongoose as an ODM.
• The data is then queryable through GraphQL in relay-style pagination.
• It can be run with Docker and Docker-Compose containerization software.
• It has some end-to-end and unit tests written using Jest.
• It uses ESLint, Prettier, CommitLint, and Husky for maintaining code quality.
• It uses Winston for logging.
• It uses New Relic for error logging, application performance monitoring, and log monitoring.

Problem Statement

• Create an application that pulls current charging station data from Open Charge Map API and then persists the data in MongoDB.

  • The following fields are to be imported from Open Charge Map API:
    • operatorInfo
    • statusType
    • addressInfo
    • connections

• The service pulls the data and updates our own database. It shall update the database only in case of changes in the pulled data.

  Read more...

Solution

• There is one entity - Socket. It represents charging stations in our database.

• There are two graphql queries - Socket and Sockets.

  Read more...

Initial setup

1. Clone from GitHub

   git clone https://github.com/the-vishal-kumar/nodejs-typescript-federated-graphql-boilerplate.git

2. Setup Docker and Docker-Compose

   • Install docker and docker-compose on your machine
   • Copy docker-compose.sample.yml as docker-compose.yml

3. Install dependencies using npm

   cd nodejs-typescript-federated-graphql-boilerplate
   npm i

4. Set environment variables

   • Copy .env.sample to the root directory as .env.

     • Put the value of OPEN_CHARGE_MAP_API_KEY.

       • Leaving it empty won't prevent the application from starting/running, but the polling won't work.
       • The application will be able to serve queries from already polled data (which will be empty if the application is started without a key).

     • (Optional) Put the value of NEW_RELIC_LICENSE_KEY. Generate a key from here.

Development

1. Execute the command from the root directory to start the application

   npm start

Testing

1. Some end-to-end and unit tests are included in src/test directory for the socket subgraph

2. Tests are run using Jest

3. Execute the command from the root directory to run the tests

   npm test

API Documentation

1. Import Postman collection and environment variable
   • Import Collection from here.
   • Import Environment Variables from here.

Technology

• Language - NodeJs | TypeScript
• GraphQL | Federated GraphQL
• MongoDB
• Containerization Software - Docker | Docker-Compose
• Version Control - Git

Code Quality

• ESLint
• Prettier
• CommitLint

Code Review

• A feature branch is created from the dev branch, and after completion of the code, a PR is generated for the dev branch
• If changes are requested by a reviewer on Github, then the person who has made the PR makes appropriate changes. The reviewer reviews again and marks the comments as resolved
• If there are no new changes required, then PR is merged with the dev branch

Managing Credentials

• Credentials live in the .env file

Git Workflow

• A branch is created for each ticket from the dev branch

• Example of Branch Name:

  • feature/{ticket_number}
  • bugfix/{ticket_number}
  • hotfix/{ticket_number}
  • dev
  • staging
  • master

• Read the next section for more information

Error Logging

• New Relic

Application Performance Monitoring

• New Relic

Log Monitoring

• New Relic

Folder Structure

    📦nodejs-typescript-federated-graphql-boilerplate
    ┣ 📂.husky
    ┃ ┣ 📂_
    ┃ ┃ ┣ 📜.gitignore
    ┃ ┃ ┗ 📜husky.sh
    ┃ ┣ 📜commit-msg
    ┃ ┣ 📜pre-commit
    ┃ ┗ 📜pre-push
    ┣ 📂src
    ┃ ┣ 📂database-test
    ┃ ┃ ┣ 📜Dockerfile
    ┃ ┃ ┗ 📜sockets.seed.data
    ┃ ┣ 📂gateway
    ┃ ┃ ┣ 📂src
    ┃ ┃ ┃ ┣ 📂test
    ┃ ┃ ┃ ┃ ┗ 📂unit
    ┃ ┃ ┃ ┃ ┃ ┗ 📂util
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜logger.unit.test.ts
    ┃ ┃ ┃ ┣ 📂util
    ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┗ 📜logger.ts
    ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┣ 📜.nvmrc
    ┃ ┃ ┣ 📜Dockerfile
    ┃ ┃ ┣ 📜newrelic.js
    ┃ ┃ ┣ 📜package.json
    ┃ ┃ ┗ 📜tsconfig.json
    ┃ ┗ 📂subgraphs
    ┃ ┃ ┗ 📂socket
    ┃ ┃ ┃ ┣ 📂src
    ┃ ┃ ┃ ┃ ┣ 📂app
    ┃ ┃ ┃ ┃ ┃ ┣ 📂mongo-server
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📂node-server
    ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜schema.graphql
    ┃ ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┃ ┣ 📂config
    ┃ ┃ ┃ ┃ ┃ ┣ 📜countries.json
    ┃ ┃ ┃ ┃ ┃ ┣ 📜cow.txt
    ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📜mongo-config.ts
    ┃ ┃ ┃ ┃ ┣ 📂cron
    ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📜pullSocket.ts
    ┃ ┃ ┃ ┃ ┣ 📂middleware
    ┃ ┃ ┃ ┃ ┣ 📂model
    ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📜socket.ts
    ┃ ┃ ┃ ┃ ┣ 📂resolver
    ┃ ┃ ┃ ┃ ┃ ┣ 📂query
    ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜socket.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜sockets.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┃ ┣ 📂test
    ┃ ┃ ┃ ┃ ┃ ┣ 📂e2e
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂resolver
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂query
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜socket.e2e.test.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜sockets.e2e.test.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📂unit
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂util
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜array.unit.test.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜enum.unit.test.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜generateCountriesJson.unit.test.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜generateSubBoundingBoxesOfCountry.unit.test.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜logger.unit.test.ts
    ┃ ┃ ┃ ┃ ┣ 📂type
    ┃ ┃ ┃ ┃ ┃ ┣ 📂config
    ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜country.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📂model
    ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜socket.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📂resolver
    ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📂query
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜sockets.ts
    ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┃ ┣ 📂util
    ┃ ┃ ┃ ┃ ┃ ┣ 📜array.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📜enum.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📜generateCountriesJson.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📜generateSubBoundingBoxesOfCountry.ts
    ┃ ┃ ┃ ┃ ┃ ┣ 📜index.ts
    ┃ ┃ ┃ ┃ ┃ ┗ 📜logger.ts
    ┃ ┃ ┃ ┃ ┗ 📜index.ts
    ┃ ┃ ┃ ┣ 📜.nvmrc
    ┃ ┃ ┃ ┣ 📜Dockerfile
    ┃ ┃ ┃ ┣ 📜newrelic.js
    ┃ ┃ ┃ ┣ 📜package.json
    ┃ ┃ ┃ ┗ 📜tsconfig.json
    ┣ 📜.commitlintrc.json
    ┣ 📜.dockerignore
    ┣ 📜.env
    ┣ 📜.env.sample
    ┣ 📜.env.test
    ┣ 📜.eslintrc.json
    ┣ 📜.gitignore
    ┣ 📜.nvmrc
    ┣ 📜.prettierrc.json
    ┣ 📜LICENSE
    ┣ 📜PROBLEM.md
    ┣ 📜README.md
    ┣ 📜SOLUTION.md
    ┣ 📜docker-compose.sample.yml
    ┣ 📜docker-compose.test.yml
    ┣ 📜docker-compose.yml
    ┣ 📜jest.config.js
    ┣ 📜package-lock.json
    ┣ 📜package.json
    ┗ 📜tsconfig.json

External Services/API Reference

• Open Charge Map API

  • The Open Charge Map API provides access to the world's largest registry of charging locations as Open Data.

• Countries of the World

  • The solution involves conceptualizing each country as a small rectangle, encompassing all of its borders, and representing each corner of the rectangle with coordinates.

  • The data for edge coordinates was obtained from here where I reached through this stack exchange answer.

License

• AGPL-3.0-or-later

Meet The Maker

Vishal Kumar - Software Engineer 👨‍💻 and an Aspiring Entrepreneur👨‍💼