Merge pull request #54 from wednesday-solutions/fix/refactor

chore: refactor database and update readme

Author: alichherawalla

README.md

@@ -117,6 +117,27 @@ Run the following command to begin seeding
 
 Once you've to the server started check out the api documentation at [/api-docs](http://localhost:9000/api-docs)
 
+## Navigating the code base
+
+-   The entry point of the application is the [server/index.js](./server/index.js)
+-   The server/app.js imports the APIs from [server/api/index.js](./server/api/index.js)
+-   All the different APIs in the [server/api](./server/api) are registered [here](./server/api/index.js)
+-   MongoDB is used to store data & mongoose is used as the ORM
+    -   [mongo](./server/database/mongo.js)
+    -   [models](./server/database/models/)
+-   The template has support for the following middlewares
+    -   [auth](./server/middlewares/auth/)
+    -   [injectRequestId](./server/middlewares/injectRequestId)
+    -   [rateLimiter](./server/middlewares/rateLimiter)
+-   The template has inbuilt support for
+    -   [redis](./server/services/redis.js)
+    -   [circuitBreakers](./server/services/circuitBreaker.js)
+    -   [slack alerts](./server/utils/slackNotify.js)
+    -   [docker](./Dockerfile)
+    -   [docker-compose](./docker-compose.yml)
+    -   [auto generated apis](./server/api/requestGenerators.js)
+    -   [sharding of collections](./setup-shards)
+
 ## Philosophy
 
 When using NoSQLs you are optimising for read performance. We're doing this by denormalising data. There are multiple copies of the same data. For example

__tests__/server/api/users/index.test.js

@@ -1,6 +1,6 @@
 import supertest from 'supertest';
 import * as requests from 'api/requestGenerators';
-import Users from 'models/users';
+import Users from 'database/models/users';
 import userValidator from 'api/users/validator';
 import app from 'server';
 import { createUser } from 'api/users';

__tests__/server/daos/order.test.js

@@ -6,7 +6,7 @@ import {
     totalAmtForDate,
     totalByDateForCategory
 } from 'daos/order';
-import { Orders } from 'models/orders';
+import { Orders } from 'database/models/orders';
 import { mockData } from 'utils/mockData';
 import moment from 'moment';
 const {

__tests__/server/middlewares/mongo.test.js renamed to __tests__/server/database/mongo.test.js

@@ -1,6 +1,6 @@
 import mongoose from 'mongoose';
 import { getMongoUri } from 'utils/mongoConstants';
-import { mongoConnector } from 'middlewares/mongo';
+import { mongoConnector } from 'database/mongo';
 
 jest.mock('mongoose', () => ({
     connection: {

__tests__/server/middlewares/auth/ownershipBasedAccessControl.test.js

@@ -1,6 +1,6 @@
 import * as httpContext from 'express-http-context';
-import { Stores } from 'models/stores';
-import { Users } from 'models/users';
+import { Stores } from 'database/models/stores';
+import { Users } from 'database/models/users';
 import message from 'utils/i18n/message';
 import { ownershipBasedAccessControl } from 'middlewares/auth/ownershipBasedAccessControl';
 

nodemon.json

@@ -1,5 +1,5 @@
 {
-    "exec": "babel-node server/app.js | bunyan -o short",
+    "exec": "babel-node server/index.js | bunyan -o short",
     "watch": ["server/*"],
     "ignore": ["**/__tests__/**", "*.test.js"],
     "events": {

package.json

@@ -111,10 +111,10 @@
         "utils": "./server/utils",
         "middlewares": "./server/middlewares",
         "server": "./server",
-        "models": "./server/models",
         "api": "./server/api",
         "config": "./config",
         "services": "./server/services",
+        "database": "./server/database",
         "daos": "./server/daos"
     }
 }

seeders/index.js

@@ -3,12 +3,12 @@ const random = require('lodash/random');
 const range = require('lodash/range');
 const moment = require('moment');
 const { runSeeders, connectToMongo, createProduct } = require('./utils');
-const { Orders } = require('models/orders');
-const { Products } = require('models/products');
-const { Stores } = require('models/stores');
-const { Suppliers } = require('models/suppliers');
-const { StoreProducts } = require('models/storeProducts');
-const { SupplierProducts } = require('models/supplierProducts');
+const { Orders } = require('database/models/orders');
+const { Products } = require('database/models/products');
+const { Stores } = require('database/models/stores');
+const { Suppliers } = require('database/models/suppliers');
+const { StoreProducts } = require('database/models/storeProducts');
+const { SupplierProducts } = require('database/models/supplierProducts');
 
 const OCT_10_1994 = 782980686236;
 

seeders/utils.js

@@ -2,13 +2,13 @@ const { default: faker } = require('@faker-js/faker');
 const mongoose = require('mongoose');
 const cluster = require('cluster');
 const os = require('os');
-const { Products } = require('models/products');
-const { ReferencedOrders } = require('models/referencedOrders');
-const { UnshardedOrders } = require('models/unshardedOrders');
+const { Products } = require('database/models/products');
+const { ReferencedOrders } = require('database/models/referencedOrders');
+const { UnshardedOrders } = require('database/models/unshardedOrders');
 const dotenv = require('dotenv');
 const {
     UnshardedReferencedOrders
-} = require('models/unshardedReferencedOrders');
+} = require('database/models/unshardedReferencedOrders');
 const { getMongoUri } = require('utils/mongoConstants');
 
 const totalCPUs = os.cpus().length;

server/api/index.js

@@ -2,7 +2,7 @@ import path from 'path';
 import express from 'express';
 import kebab from 'lodash/kebabCase';
 import { generateRequest } from 'api/requestGenerators';
-import { mongoConnector } from 'middlewares/mongo';
+import { mongoConnector } from '../database/mongo';
 import { customApisMapper, REQUEST_TYPES } from 'api/customApisMapper';
 import customRoutes from 'server/api/routes';
 import { getModelFiles, isTestEnv } from 'utils';
@@ -21,7 +21,10 @@ export default app => {
 };
 
 const autoGenerateApisFromModels = app => {
-    const modelsFolderPath = path.join(__dirname, '../../server/models/');
+    const modelsFolderPath = path.join(
+        __dirname,
+        '../../server/database/models/'
+    );
     const fileArray = getModelFiles(modelsFolderPath);
     fileArray.forEach(f => {
         const { model } = require(modelsFolderPath + f);