Added comments to explain sections of code, removed inaccuratly described comments from prior groups

Author: mdtagg

app/components/TransferColumns.tsx

@@ -7,8 +7,6 @@ import { DataGrid } from '@material-ui/data-grid';
 import * as DashboardContext from '../context/DashboardContext';
 import lightAndDark from './Styling';
 import { Button, TextField } from '@material-ui/core';
-import SearchBar from './SearchBar/SearchBar';
-
 
 interface Params {
   service: string;

app/containers/GraphsContainer/GraphsContainer.tsx

@@ -33,7 +33,7 @@ interface Params {
 const GraphsContainer: React.FC = React.memo(() => {
   const { app, service } = useParams<keyof Params>() as Params;
   const [live, setLive] = useState<boolean>(false);
-  const { intervalID, setIntervalID, example, chart, setChart } = useContext(ApplicationContext);
+  const { intervalID, setIntervalID, chart, setChart } = useContext(ApplicationContext);
   const { getSavedMetrics } = useContext(ApplicationContext);
   const { fetchHealthData, setHealthData } = useContext(HealthContext);
   const { setDockerData, dockerData } = useContext(DockerContext);
@@ -47,7 +47,6 @@ const GraphsContainer: React.FC = React.memo(() => {
 
   useEffect(() => {
     const serviceArray = service.split(' ');
-    // You would think you should add "kubernetesmetrics" into the below for consistency's sake but it makes it  not work correctly, so it has been omitted
     const healthServiceArray = serviceArray.filter(
       (value: string) => value !== 'kafkametrics' && value !== 'kubernetesmetrics'
     );
@@ -60,23 +59,27 @@ const GraphsContainer: React.FC = React.memo(() => {
           if (service.includes('kafkametrics')) {
             fetchEventData('kafkametrics');
           }
-          // JJ-ADDITION
           if (service.includes('kubernetesmetrics')) {
             fetchEventData('kubernetesmetrics');
           }
         }, 10000)
       );
     } else {
+      //This block gets data from the metrics db, the health data from each of the services respective dbs and the communcations logs in the communications db
+      //The respective states are commsData, healthData and savedMetrics
       if (intervalID) clearInterval(intervalID);
+      // gets all the communication logs from the communications database and sets the communications data state
       fetchCommsData(app, live);
+      // gets all health data stored in each of the services databases
       fetchHealthData(healthServiceArray);
+      //kafka and kubernetes are currently not hooked up so these blocks will never fire
       if (service.includes('kafkametrics')) {
         fetchEventData('kafkametrics');
       }
-      // JJ-ADDITION
       if (service.includes('kubernetesmetrics')) {
         fetchEventData('kubernetesmetrics');
       }
+      // gets all metric data (cpu related metrics)
       getSavedMetrics();
     }
 
@@ -88,7 +91,6 @@ const GraphsContainer: React.FC = React.memo(() => {
     };
   }, [service, live]);
 
-  //random variable to hold the light or dark mode of the display?..ok....sure
   const currentMode = mode === 'light' ? lightAndDark.lightModeText : lightAndDark.darkModeText;
 
   return (

app/context/ApplicationContext.tsx

@@ -22,14 +22,12 @@ const ApplicationContextProvider: React.FC<AppContextProps> = React.memo(props =
   const children = props.children;
   const [ example,setExample ] = useState(false)
   const [chart, setChart] = useState<string>('all');
-
   const [servicesData, setServicesData] = useState([]);
   const [app, setApp] = useState<string>('');
   const [savedMetrics, setSavedMetrics] = useState({});
   const [appIndex, setAppIndex] = useState<number>(0);
   const [intervalID, setIntervalID] = useState<NodeJS.Timeout | null>(null);
 
-
   /**
    * @function fetchServicesNames - a function that will take an application name and update the state of `serviceData` based on backend response
    * 1. Take in an application name
@@ -40,16 +38,13 @@ const ApplicationContextProvider: React.FC<AppContextProps> = React.memo(props =
    */
   // v10: Invoked by connectToDB, passing in app (card title)
   const fetchServicesNames = useCallback((application: string) => {
-    // console.log('Hi, inside ApplicationConext - fetchServicesNames callback. Sending servicesRequest to ipcMain.');
-    console.log('app when fetch services name: ', application);
-    console.log(application)
+   
     ipcRenderer.send('servicesRequest');
     ipcRenderer.on('servicesResponse', (event: Electron.Event, data: any) => {
-      //data here refers to the data coming the services document of the database
+      //data here refers to the services coming the services document of the database
       let result: any;
       result = JSON.parse(data);
-      console.log('result from ipcrenderer services response is: ', result);
-      // console.log('Calling setServicesData passing in above result. Current servicesData is the following: ', servicesData);
+      // console.log({result})
       setServicesData(result);
       ipcRenderer.removeAllListeners('servicesResponse');
     });
@@ -88,8 +83,6 @@ const ApplicationContextProvider: React.FC<AppContextProps> = React.memo(props =
       data.forEach(el => {
         store[el.metric] = el;
       });
-      // console.log({store})
-      // console.log('result from getSavedMetrics is: ', store);
       setSavedMetrics(store);
     });
   }, []);

app/context/CommsContext.tsx

@@ -50,7 +50,7 @@ const CommsContextProvider: React.FC<Props> = React.memo((props) => {
       ipcRenderer.send('commsRequest');
       ipcRenderer.on('commsResponse', (event: Electron.Event, data: any) => {
         let result: any;
-        //Here we are grabbing all the data from our test database 
+        //Here we are grabbing all the data from our communications database 
         if (tryParseJSON(data)) result = JSON.parse(data);
         setCommsData(result);
       });

chronos_npm_package/controllers/mongo.js

@@ -122,7 +122,6 @@ mongo.health = async ({ microservice, interval, mode }) => {
         const HealthModel = HealthModelFunc(`${microservice}`);
         await HealthModel.insertMany(healthMetrics);
         return
-        
       })
       .then(() => {
         console.log('Health data recorded in MongoDB');

electron/routes/data.ts

@@ -115,10 +115,7 @@ ipcMain.on('servicesRequest', async (message: Electron.IpcMainEvent) => {
 ipcMain.on('commsRequest', async (message: Electron.IpcMainEvent) => {
   try {
     let result: any;
-
-    // Mongo Database
     if (currentDatabaseType === 'MongoDB') {
-      // Get all documents
       result = await CommunicationModel.find().exec();
       // console.log({result})
     }
@@ -147,9 +144,7 @@ ipcMain.on('healthRequest', async (message: Electron.IpcMainEvent, service: stri
 
   try {
     let result: any;
-    // Mongo Database
     if (currentDatabaseType === 'MongoDB') {
-      //NOT WORKING CULPRIT IS HERE
       result = await mongoFetch(service);
     }
 
@@ -211,27 +206,22 @@ ipcMain.on('dockerRequest', async (message, service) => {
   }
 });
 
-// This event allows the user to change which metrics are saved by the database, so that their database doesn't get bloated with unnecessary data that they don't actually want.
+// This event grabs the metric data from the metric database. 
+// Storing the metrics is done to allow the user to select which metrics
+// they want to see in the metrics container component
 ipcMain.on('savedMetricsRequest', async (message: Electron.IpcMainEvent) => {
   try {
     let result: any = {};
-    // Mongo Database
     if (currentDatabaseType === 'MongoDB') {
-      // Get all documents from the services collection
       result = await MetricsModel.find().lean();
     }
 
-    // SQL Database
     if (currentDatabaseType === 'SQL') {
-      // Get all rows from the metrics table
       const query = `SELECT * FROM metrics;`;
       result = await pool.query(query);
       result = result.rows;
     }
-
-    // Async event emitter - send response
     message.sender.send('savedMetricsResponse', result);
-    // eslint-disable-next-line no-shadow
   } catch (err) {
     if (err) console.log('Error in "metricsRequest" event :', err.message);
   }