Merge branch 'dev' of https://github.com/oslabs-beta/Docketeer into dev

Author: Jaysalgado

__tests__/ProcessLogHelper.test.js

@@ -4,6 +4,8 @@ describe('dummy test', () => {
   });
 });  
 
+//Testing for Process logs needs to be implemented
+
 // /**
 //  * @jest-environment jsdom
 //  */

__tests__/ServerRoutes.test.js

@@ -57,7 +57,6 @@ describe('test test', () => {
 describe('key test ', () => {
   test('Get request', async () => {
     const res = await request(app).get('/gapi/key');
-    console.log(res.body);
     expect(typeof res.body).toBe('string');
     expect(res.status).toBe(200);
     testKey = res.body
@@ -66,7 +65,6 @@ describe('key test ', () => {
 
 describe('uid test', () => {
   test('Post request', async () => {
-    console.log('WE HERE', testKey)
     const requestBody = {
       key: testKey,
       dashboard: 'Node Exporter / Nodes',
@@ -75,7 +73,6 @@ describe('uid test', () => {
       .post('/gapi/uidkey')
       // .set('Content-Type', 'application/json')
       .send(requestBody);
-    console.log('RES BODY', res.body)
     expect(typeof res.body).toBe('string');
     expect(res.status).toBe(200);
   });

__tests__/dockerComposeReducer.test.js

@@ -4,6 +4,8 @@ describe('dummy test', () => {
   });
 });  
 
+//Docker Compose testing needs refactoring
+
 // import dockerComposeReducer from '../src/redux/reducers/dockerComposeReducer'
 // import { describe, beforeEach, expect, test, jest } from '@jest/globals'
 // import '@testing-library/jest-dom'

server/app.ts

@@ -3,7 +3,7 @@ import express, { Request, Response } from 'express';
 import { ServerError, GlobalErrorObject } from '../types';
 import cors from 'cors';
 import { exec } from 'child_process';
-import cookieParser from 'cookie-parser'; // for when cookies get implemented
+import cookieParser from 'cookie-parser';
 import * as path from 'path';
 
 const app = express();
@@ -47,24 +47,10 @@ app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 app.use(express.static('SetupApp'));
 
-// app.use(cookieParser()); // for when cookies get implemented
-
-// check for cookie
-// app.use('/', userController.checkCookie, (req: Request, res: Response): void => {
-//   console.log('cookffffffs', req.headers.cookie, req.cookies);
-//   if (res.locals.notSignedIn) res.redirect('/login');
-//   else res.redirect('/');
-// });
-
 
 // Defining routers...
 
 app.use('/k8', (req: Request, res: Response) => {
-  // const options = {
-  //   headers: {
-  //     'Content-Type': 'application/javascript'
-  //   }
-  // };
   res.status(200).sendFile(path.join(__dirname, '../SetupApp/index.html'));
 });
 

server/controllers/apiController.ts

@@ -1,7 +1,6 @@
 // !
 // !
 // ! Currently not used, is meant to send email alerts
-// currently not used, is meant to send email alerts
 
 import { Request, Response, NextFunction } from 'express';
 import nodemailer from 'nodemailer';
@@ -12,6 +11,7 @@ import { ApiController, ServerError } from '../../types';
 // Function: transporter
 // Purpose: create transporter object to make sure these values are filled out in email.js
 // ==========================================================
+
 const transporter = nodemailer.createTransport({
   host: email.host,
   port: email.port,
@@ -27,20 +27,16 @@ const transporter = nodemailer.createTransport({
  * @description | contains middleware that sends emails to user for container issues and signup information
  **/
 const apiController: ApiController = {
-  //   testing: (req, res, next) => {
-  //   console.log("HELLO WE'RE TESTING!!!")
-  //   res.locals.testingData = "HELLLOOOOO OBJECT HERE"
-  //   return next();
-  // }
   testing: (req: Request, res: Response, next: NextFunction) => {
-    console.log('HELLO WERE TESTING');
-    res.locals.testingData = 'HELLOOOO OBJECT HERE';
+    res.locals.testingData = 'test';
     return next();
   },
+  
   // ==========================================================
   // Middleware: sendEmailAlert
   // Purpose:
   // ==========================================================
+
   sendEmailAlert: (req: Request, res: Response, next: NextFunction) => {
     const { email, containerName, time, date, stopped } = req.body;
     let emailBody: string;
@@ -74,7 +70,7 @@ const apiController: ApiController = {
 
     transporter
       .sendMail(mailDetails)
-      .then((info: any) => {
+      .then(() => {
         return next();
       })
       .catch((err: ServerError) => {
@@ -115,10 +111,10 @@ const apiController: ApiController = {
     // create transporter with Nodemailer to send email.
     transporter
 
-      // .sendMail is part of nodemailer package, sends an email and returns a promise with details on the email (info)
+    // .sendMail is part of nodemailer package, sends an email and returns a promise with details on the email (info)
 
       .sendMail(mailDetails)
-      .then((info: any) => {
+      .then(() => {
         return next();
       })
       .catch((err: ServerError) => {

server/controllers/grafanaApiController.ts

@@ -5,9 +5,10 @@ import fetch from 'node-fetch';
 interface GrafanaResponse {
   key: string;
 }
+
+// use localhost version for npm run dev or testing, but host.docker.internal when running compose up
 // http://localhost:3000/api/auth/keys
 // 'http://host.docker.internal:3000/api/auth/keys'
-// http://host.docker.internal:3000/api/search?query=${encodeURIComponent(dashboard)}`
 const grafanaApiController: GrafanaApiController = {
   getApi: async (req, res, next): Promise<void> => {
     try {
@@ -42,6 +43,9 @@ const grafanaApiController: GrafanaApiController = {
     }
   },
 
+  // use localhost version for npm run dev or testing, but host.docker.internal when running compose up
+  // http://localhost:3000/api/search?query=${encodeURIComponent(dashboard)}`
+  // http://host.docker.internal:3000/api/search?query=${encodeURIComponent(dashboard)}` 
   getUid: async (req, res, next): Promise<void> => {
     const { key, dashboard }: { key: string; dashboard: string } = req.body;
     try {

server/controllers/setupController.ts

@@ -2,6 +2,11 @@ import { Request, Response, NextFunction } from 'express';
 import { exec, execSync, spawn, spawnSync } from 'child_process';
 import { SetupController } from '../../types';
 
+/**
+ * @description v12.0 implemented k8 cluster metrics! In order to set this up, run npm run dev, go to 
+ * localhost:/3000 click the three buttons in sequence, this will run the necessary shell lines on your host terminal.
+ *  Than you can compose up to see your k8 metrics. 
+ */
 
 const setupController: SetupController = {
   promInstall: (req: Request, res: Response, next: NextFunction): void => {

server/controllers/userController.ts

@@ -7,7 +7,8 @@ import { UserController, ServerError, UserInfo } from '../../types';
 // const secret = JWT_SECRET;
 
 /**
- * @description Contains middleware that creates new user in database, gets all users from database for system admin, and verifies user exists before sending back user data to login component
+ * @description Contains middleware that creates new user in database, gets all users from database verifies if user exists before sending back user data to login component
+ * v12.0 implemented cookies for user sessions and commented out all system admin implementaion since it was nonfunctional
  */
 
 const userController: UserController = {
@@ -16,14 +17,13 @@ const userController: UserController = {
     res: Response,
     next: NextFunction
   ): Promise<void> => {
-    console.log('in userController.createUser');
 
     try {
       const {
         username,
         password,
         // role_id,
-      }: { username: string; password: string;} = req.body;
+      }: { username: string; password: string; } = req.body;
       // hash password
       const hashedPassword = await bcrypt.hash(password, 10);
 
@@ -48,9 +48,6 @@ const userController: UserController = {
       // create an array, userDetails, to hold values from our createUser SQL query placeholders.
       const userDetails: string[] = [username, hashedPassword];
       const createdUser = await db.query(createUser, userDetails);
-
-      console.log('createdUser: ', createdUser.rows[0]);
-
       res.locals.user = createdUser.rows[0];
       return next();
     } catch (err: unknown) {
@@ -107,12 +104,10 @@ const userController: UserController = {
       req.body;
     // using username we create a query string to grab that user
     const getUser = 'SELECT * FROM users WHERE username=$1;';
-    //   using bcrypt we check if client's password input matches the password of that username in the db; we then add to locals accordingly
+    // using bcrypt we check if client's password input matches the password of that username in the db; we then add to locals accordingly
     db.query(getUser, [username])
       .then(async (data: any) => {
-        console.log(data.rows[0]);
         const match = await bcrypt.compare(password, data.rows[0].password);
-        console.log(match);
         if (!data.rows[0] || !match) {
           return next({
             log: 'Error in userController\'s verifyUser method',
@@ -124,9 +119,8 @@ const userController: UserController = {
         }
         const verifiedUser = data.rows[0];
         res.locals.user = verifiedUser;
-        console.log('verified user', verifiedUser);
         return next();
-    
+
         // const verifiedRole = verifiedUser.role;
         // if (verifiedRole === 'system admin') {
         //   await jwt.sign({ verifiedRole }, secret, (err, token) => {
@@ -157,11 +151,8 @@ const userController: UserController = {
       });
   },
 
-  
 
   updatePassword: (req: Request, res: Response, next: NextFunction): void => {
-    // if there is an error property on res.locals, return next(). i.e., incorrect password entered
-
     const { newHashedPassword }: { newHashedPassword: string } = res.locals as {
       newHashedPassword: string;
     };
@@ -226,29 +217,29 @@ const userController: UserController = {
       });
   },
 
+  // adding cookie  
   addCookie: (req: Request, res: Response, next: NextFunction): void => {
-    console.log('we are adding the cookie here right now');
     res.cookie('loggedIn', true);
     return next();
   },
 
+  // verify cookie on refresh
   checkCookie: (req: Request, res: Response, next: NextFunction): void => {
     if (req.cookies.loggedIn) res.locals.signedIn = true;
     else res.locals.signedIn = false;
     return next();
   },
 
+  // remove cookie on logout
   removeCookie: (req: Request, res: Response, next: NextFunction): void => {
-    console.log('abt to rmv cookie');
     res.clearCookie('loggedIn');
-    console.log('cookied rmvd');
     res.locals.loggedOut = true;
     return next();
   },
 };
 export default userController;
 
-// not currently in use.
+// not currently in use (from v12.0)
 
 // switches role of user upon designation by system admin
 // switchUserRole: (req: Request, res: Response, next: NextFunction) => {
@@ -303,7 +294,6 @@ export default userController;
 //         });
 //       }
 //       const verifiedUser = data.rows[0];
-//       console.log('verified user', verifiedUser);
 //       res.locals.verifiedUser = verifiedUser;
 //       const verifiedRole = verifiedUser.role;
 //       if (verifiedRole === 'system admin') {

server/database/cloudModel.ts

@@ -1,11 +1,5 @@
 import { Pool } from 'pg';
 import { SqlQuery } from '../../types';
-import {
-  POSTGRES_SERVICE,
-  POSTGRES_USER,
-  POSTGRES_PASS,
-  POSTGRES_NAME,
-} from '../../config.js';
 
 const pool: Pool = new Pool({
   host: 'db',

server/routes/adminRouter.ts

@@ -1,7 +1,10 @@
 /**
  * @module AdminRouter
  * @description Routes all requests to admin endpoint
+ * v12.0 depreciated all admin / system admin functionality since it was nonfunctional
  */
+
+
 // import { Router, Request, Response } from 'express';
 // import userController from '../controllers/userController';