Merge branch 'master' of https://github.com/oslabs-beta/Chronos

"example folders and add modal fix"

Author: gracepark01

examples/docker-microservice/README.md

@@ -0,0 +1,54 @@
+![Chronos logo](https://raw.githubusercontent.com/Chronos2-0/Chronos/master/app/assets/logo2.png)
+## Microservices Architecture
+Microservices architecture for testing [Chronos](https://github.com/oslabs-beta/Chronos), a microservice communication and health visualizer.
+
+## Purpose and Design - with docker implemented to avoid having to run multiple services in multiple terminals
+This sample microservices architecture allows developers to explore the functionality of Chronos but with one docker compose command. This consists of four microservices, which are contained within the directories:
+- Reverse Proxy / Frontend
+- Books
+- Customers
+- Orders
+
+Each microservice has its own server, which receives requests from both the client and from other microservices. Books, Customers, and Orders also have their own databases, which they can query to respond to those requests.
+The frontend has a reverse proxy set up for proxying requests to the appropriate service in the microservice network. Bear in mind that the use of the word 'services' refers to the individual applications in the microservice network. In development they're all run separately on different ports, with said ports listening out for requests. This is for demonstration and testing purposes. Ideally, in a production environment, all the services will be up and running concurrently from the get go and that's what the docker compose file helps us achieve. It is able to chain all the services and run them together with one command. Docker also ensures that the versions that worked well on dev are bundled up and distributed and used to run the containers for the individual containers.
+
+
+Run the containerized microservice application with the following command: Because the docker-compose.yml file is located in the main directory of the application, you'll have to be in the main directory folder location for you to properly access the file and run it. That would be Chronos.
+
+`docker-compose -f docker-compose.yml up`
+
+If that doesn't work and you see an error message similar to this: `failed to build: The command '/bin/sh -c npm install' returned a non-zero code: 1` then the error is most likely from the dependency build. You'll have to manually navigate to each service and rum `npm install` for each service dependency to be installed before the image for the container can be created with docker compose.
+
+Next:
+
+**You must replace the placeholder MongoDB Atlas URIs for the databases with your own _actual_ MongoDB Atlas URIs:** Failure to do so means you won't be able to inspect your database.
+
+```
+const myURI = 'mongodb+srv://johndoe:[email protected]/';
+```
+Also, see specific files for specific information on further fuctionality
+
+## Contributing
+
+Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
+
+## People
+
+[Tim Atapagra](https://github.com/timpagra),
+[Mohtasim Chowdhury](https://github.com/mohtasim317),
+[Ousman Diallo](https://github.com/Dialloousman),
+[Michelle Herrera](https://github.com/mesherrera),
+[Duane McFarlane](https://github.com/Duane11003),
+[Ben Mizel](https://github.com/ben-mizel),
+[Jenae Pennie](https://github.com/jenaepen),
+[Chris Romano](https://github.com/robicano22),
+[Natalie Umanzor](https://github.com/nmczormick)
+
+## License
+
+  [MIT](LICENSE)
+
+[npm-image]: https://img.shields.io/npm/v/chronos-microservice-debugger3.svg
+[npm-url]: https://www.npmjs.com/package/chronos-microservice-debugger3
+[downloads-image]: https://img.shields.io/npm/dm/chronos-microservice-debugger3.svg
+[downloads-url]: https://npmjs.org/package/chronos-microservice-debugger3

examples/docker-microservice/books/BookController.js

@@ -0,0 +1,80 @@
+require('dotenv').config();
+const fetch = require('node-fetch');
+const BookModel = require('./BookModel');
+
+const BookController = {};
+
+// This controller creates a book in the book db
+BookController.createBook = (req, res, next) => {
+  const { title, author, numberOfPages, publisher } = req.body;
+  BookModel.create(
+    {
+      title,
+      author,
+      numberOfPages,
+      publisher,
+    },
+    (err, result) => {
+      if (err) {
+        console.log(`This is the error I am getting back ${err}`);
+        return res.send(404).json(err);
+      }
+
+      res.locals.createBook = result;
+      return next();
+    }
+  );
+};
+
+// This controller creates a book in the book db
+
+BookController.getBooks = (req, res, next) => {
+  BookModel.find({}, (err, result) => {
+    if (err) {
+      console.log('Book retrieval was not successful', err);
+      return res.status(404).json(err);
+    }
+    res.locals.getBooks = result;
+    console.log('Book retrieval was successful', res.locals.getBooks);
+    return next();
+  });
+};
+
+// This controller deletes books
+BookController.deleteBook = (req, res, next) => {
+  const { id } = req.query;
+  BookModel.findOneAndDelete({ _id: id }, (error, result) => {
+    if (error) {
+      console.log(`Deletion was not successful ${error}`);
+      return res.status(404).json(error);
+    }
+    res.locals.deleteBook = result;
+    return next();
+  });
+};
+
+//  This controller gets order info from the order application
+BookController.getorderinfo = (req, res, next) => {
+  console.log('req.headers (in bookController.js):', req.headers);
+  //  const { body } = req;
+  // since it's a get request, you technically don't need
+  //  all the headers but it's more declarative this way
+  // fetch(`http://orders:${process.env.ORDERS_PORT}/orders/getorders`, {
+  fetch(`http://orders:7777/orders/getorders`, {
+    method: 'GET',
+    headers: {
+      'Content-Type': 'Application/JSON',
+      Accept: 'application/json',
+    },
+  })
+    .then((response) => response.json())
+    .then((results) => {
+      //  const info = results.forEach((curr) => JSON.stringify((curr)));
+      res.locals.getorderinfo = results;
+      return next();
+    })
+    .catch((error) => {
+      console.log(`There was an error in getting orders data ${error}`);
+    });
+};
+module.exports = BookController;

examples/docker-microservice/books/BookModel.js

@@ -0,0 +1,42 @@
+const mongoose = require('mongoose');
+require('dotenv').config();
+
+//  pull schema from the mongoose object
+const { Schema } = mongoose;
+
+// DB link for books data.
+// Search dotenv documentation for details
+const book_db_URI = `${process.env.BOOKS_DB}`;
+
+// const URI = process.env.MONGO_URI || myURI;
+
+// connect the database, if error, log will be sent to the terminal
+mongoose
+  .connect(book_db_URI, { useNewUrlParser: true, useUnifiedTopology: true })
+  .then(() => console.log('Connected!!!********* Books Database is live!!!'))
+  .catch((err) => console.log('Connection Error ', err));
+
+//  Schema for the database
+const BooksSchema = new Schema({
+  title: {
+    type: String,
+    required: true,
+  },
+  author: {
+    type: String,
+    required: true,
+  },
+  numberOfPages: {
+    type: Number,
+    required: false,
+  },
+  publisher: {
+    type: String,
+    required: false,
+  },
+});
+
+// Database Model creation to be exported
+const BookModel = mongoose.model('BookModel', BooksSchema);
+
+module.exports = BookModel;

examples/docker-microservice/books/BookServer.js

@@ -0,0 +1,73 @@
+const express = require('express');
+const path = require('path');
+const cors = require('cors');
+const chronos = require('chronos-tracker');
+require('./chronos-config');
+const controller = require('./BookController.js');
+require('dotenv').config();
+
+// Places a unique header on every req in order to trace the path in the req's life cycle.
+chronos.propagate();
+
+const app = express();
+
+app.use(express.json());
+app.use('/', chronos.track());
+
+app.use(cors());
+app.use('/', express.static(path.resolve(__dirname, '../frontend')));
+
+// CHAOS FLOW - SIMPLY A TEST FOR THE EXPESS SERVER
+app.use((req, res, next) => {
+  console.log(
+    `***************************************************************************************
+    CHAOS FLOW TEST --- METHOD:${req.method},
+    PATH: ${req.url},
+    BODY: ${JSON.stringify(req.body)},
+    ID: ${req.query.id}
+    ***************************************************************************************`
+  );
+  next();
+});
+
+//  This route will create a new book!
+app.post('/books/createbook', controller.createBook, (req, res) => {
+  res.status(200).json(res.locals.createBook);
+});
+
+// This route will delete a book
+app.delete('/books/deletebook:id?', controller.deleteBook, (req, res) => {
+  res.status(200).json(res.locals.deleteBook);
+});
+
+// This route will get all the books in the database
+app.get('/books/getbooks', controller.getBooks, (req, res) => {
+  res.status(200).json(res.locals.getBooks);
+});
+
+// This route gets orders from the Orders application
+app.get('/books/getordersinfo', controller.getorderinfo, (req, res) => {
+  res.status(200).json(res.locals.getorderinfo);
+});
+
+// Global error handler
+app.use((error, req, res, next) => {
+  //  console.log(err.stack);
+  const defaultErr = {
+    log: 'Express error handler caught unknown middleware error',
+    status: 400,
+    message: { err: 'An error occurred' },
+  };
+  const errorObj = Object.assign(defaultErr, error);
+  console.log(`Here is the error object's response: ${errorObj.log}`);
+
+  res.status(errorObj.status).json(errorObj.message);
+});
+
+// app.listen(process.env.BOOKS_PORT, () => {
+//   console.log(`Book server running on port ${process.env.BOOKS_PORT} ...`);
+// });
+
+app.listen(8888, () => {
+  console.log(`Book server running on port 8888...`);
+});

examples/docker-microservice/books/Dockerfile

@@ -0,0 +1,7 @@
+FROM node:10.16
+WORKDIR /usr/src/app
+COPY package*.json ./
+COPY . .
+RUN npm install
+EXPOSE 8888
+ENTRYPOINT ["node", "BookServer.js"]

examples/docker-microservice/books/chronos-config.js

@@ -0,0 +1,13 @@
+const chronos = require('chronos-tracker');
+
+chronos.use({
+  microservice: 'books',
+  interval: 2000,
+  dockerized: true,
+  database: {
+    type: 'MongoDB',
+    URI:
+      ' < INSERT MONGODB URL HERE > ',
+  },
+  // notifications: [],
+});