restructure backend

backend/jest.setup.js

@@ -12,8 +12,8 @@ global.console = {
   debug: jest.fn(), // Mock console.debug
 }
 
-/* Mock Redis client in all unit tests */
-jest.mock('./src/redis/redisClient', () => ({
+/* Mock Redis client in all unit tests. Needed since redis is used by express-rate-limit in top level code which is imported by App.ts when the routes are loaded */
+jest.mock('./src/database/redis/redisClient', () => ({
   getClient: jest.fn().mockImplementation(() => ({
     sendCommand: jest.fn().mockResolvedValue('OK'),
   })),

backend/src/app.ts

@@ -1,9 +1,9 @@
 /* Application setup */
 import express, { Express } from 'express';
 import mongoose from 'mongoose';
-import healthCheckRouter from './healthCheck/routes/healthCheckRoutes';
-import userRouter from './user/routes/userRoutes';
-import { ApiUrlsV1 } from './constants';
+import healthCheckRouter from './features/healthCheck/routes/healthCheckRoutes';
+import userRouter from './features/user/routes/userRoutes';
+import { ApiUrlsV1 } from './features/common/constants';
 import logger from './logging/logger';
 import Config from 'simple-app-config';
 import helmet from 'helmet';

backend/src/redis/redisClient.ts → backend/src/database/redis/redisClient.ts

@@ -1,6 +1,6 @@
 import Config from 'simple-app-config';
 import { createClient, RedisClientType } from 'redis';
-import logger from '../logging/logger';
+import logger from '../../logging/logger';
 
 /**
  * Client class used to interact with redis

backend/src/foodTracker/models/food.ts → backend/src/features/foodTracker/models/food.ts

@@ -1,5 +1,5 @@
 /* Interface that all official and custom food documents extend */
-import { BaseDocument } from '../../baseDocument';
+import { BaseDocument } from '../../common/baseDocument';
 
 /**
  * Interface for a generic food document that is trackable

backend/src/healthCheck/controllers/healthCheckController.ts → backend/src/features/healthCheck/controllers/healthCheckController.ts

@@ -1,8 +1,8 @@
 /* Business logic for application health checks */
 import { Request, Response } from 'express';
 import mongoose, { STATES } from 'mongoose';
-import logger from '../../logging/logger';
 import { HealthCheckResponses } from '../constants';
+import logger from '../../../logging/logger';
 
 /**
  * Business logic for application health checks

backend/src/healthCheck/routes/healthCheckRoutes.ts → backend/src/features/healthCheck/routes/healthCheckRoutes.ts

@@ -1,13 +1,13 @@
 /* Routes for application health checks */
 import express from 'express';
 import rateLimit, { MemoryStore } from 'express-rate-limit';
-import logger from '../../logging/logger';
 import Config from 'simple-app-config';
 import HealthCheckController from '../controllers/healthCheckController';
-import { API_URLS_V1_PREFIX, Environments, GenericResponses } from '../../constants';
+import { API_URLS_V1_PREFIX, Environments, GenericResponses } from '../../common/constants';
 import RedisStore from 'rate-limit-redis';
-import RedisClient from '../../redis/redisClient';
 import _ from 'lodash';
+import logger from '../../../logging/logger';
+import RedisClient from '../../../database/redis/redisClient';
 
 const healthCheckRouter = express.Router();
 

backend/src/user/controllers/userController.ts → backend/src/features/user/controllers/userController.ts

@@ -2,8 +2,8 @@
 import { Request, Response } from 'express';
 import { User } from '../models/user';
 import { UserResponses } from '../constants';
-import { GenericResponses } from '../../constants';
-import logger from '../../logging/logger';
+import { GenericResponses } from '../../common/constants';
+import logger from '../../../logging/logger';
 
 /**
  * Business logic for user related APIs

backend/src/user/models/user.ts → backend/src/features/user/models/user.ts

@@ -1,6 +1,6 @@
 /* Schema definition for a user */
 import mongoose, { Schema } from 'mongoose';
-import { BaseDocument } from '../../baseDocument';
+import { BaseDocument } from '../../common/baseDocument';
 
 /**
  * Interface for user document

backend/src/user/routes/userRoutes.ts → backend/src/features/user/routes/userRoutes.ts

@@ -1,13 +1,13 @@
 /* Routes for user authentication */
 import express from 'express';
 import rateLimit, { MemoryStore } from 'express-rate-limit';
-import logger from '../../logging/logger';
+import logger from '../../../logging/logger';
 import Config from 'simple-app-config';
-import { API_URLS_V1_PREFIX, Environments, GenericResponses } from '../../constants';
+import { API_URLS_V1_PREFIX, Environments, GenericResponses } from '../../common/constants';
 import UserController from '../controllers/userController';
 import RedisStore from 'rate-limit-redis';
-import RedisClient from '../../redis/redisClient';
 import _ from 'lodash';
+import RedisClient from '../../../database/redis/redisClient';
 
 export const userRouter = express.Router();
 

backend/src/index.ts

@@ -2,7 +2,7 @@
  * Import DB clients and logger before all else
  */
 import logger from './logging/logger';
-import RedisClient from './redis/redisClient';
+import RedisClient from './database/redis/redisClient';
 
 /**
  * IIFE to ensure database connections are established synchronously before anything else uses the DBs

backend/src/logging/logger.ts

@@ -1,7 +1,7 @@
 /* Setup for logger */
 import DailyRotateFile from 'winston-daily-rotate-file';
 import winston from 'winston';
-import { Environments } from '../constants';
+import { Environments } from '../features/common/constants';
 
 /* Set up file transport and rotation */
 const fileTransport = new DailyRotateFile({

backend/tests/app.test.ts

@@ -1,7 +1,7 @@
 /* Unit tests for the backend application server class */
 import mongoose from 'mongoose';
 import App from '../src/app';
-import { Environments } from '../src/constants';
+import { Environments } from '../src/features/common/constants';
 import logger from '../src/logging/logger';
 import Config, { EnvParser } from 'simple-app-config';
 import http from 'http';

backend/tests/healthCheck/controllers/healthCheckController.test.ts

@@ -1,7 +1,7 @@
 import { Request, Response } from 'express';
 import { MockRequest, MockResponse, createRequest, createResponse } from 'node-mocks-http';
-import HealthCheckController from '../../../src/healthCheck/controllers/healthCheckController';
-import { HealthCheckResponses } from '../../../src/healthCheck/constants';
+import HealthCheckController from '../../../src/features/healthCheck/controllers/healthCheckController';
+import { HealthCheckResponses } from '../../../src/features/healthCheck/constants';
 import mongoose from 'mongoose';
 
 describe('Health Check Controller Tests', () => {

backend/tests/healthCheck/routes/healthCheckRoutes.test.ts

@@ -1,12 +1,12 @@
 /* Unit tests for the health check routes */
 import request from 'supertest';
-import { ApiUrlsV1, GenericResponses } from '../../../src/constants';
+import { ApiUrlsV1, GenericResponses } from '../../../src/features/common/constants';
 import App from '../../../src/app';
 import Config from 'simple-app-config';
-import HealthCheckController from '../../../src/healthCheck/controllers/healthCheckController';
+import HealthCheckController from '../../../src/features/healthCheck/controllers/healthCheckController';
 
 /* Mock the controller functions */
-jest.mock('../../../src/healthCheck/controllers/healthCheckController', () => ({
+jest.mock('../../../src/features/healthCheck/controllers/healthCheckController', () => ({
   checkHealth: jest.fn().mockImplementation((req, res) => {
     res.sendStatus(200);
   })